View | Details | Raw Unified | Return to bug 243345 | Differences between
and this patch

Collapse All | Expand All

(-)files/patch-man-xsltproc (+684 lines)
Line 0 Link Here
1
--- doc/xsltproc.1	2020-01-14 05:57:49 UTC
2
+++ doc/xsltproc.1
3
@@ -37,62 +37,13 @@ xsltproc \- command line XSLT processor
4
 
5
 .SH "SYNOPSIS"
6
 
7
-	.HP \w'\fBxsltproc\fR\ 'u
8
+.HP \w'\fBxsltproc\fR\ 'u
9
+\fBxsltproc\fR [[\fB\-V\fR | \fB\-\-version\fR] [\fB\-v\fR | \fB\-\-verbose\fR] [{\fB\-o\fR | \fB\-\-output\fR} {\fIFILE\fR | \fIDIRECTORY\fR}] | \fB\-\-timing\fR | \fB\-\-repeat\fR | \fB\-\-debug\fR | \fB\-\-novalid\fR | \fB\-\-noout\fR | \fB\-\-maxdepth\ \fR\fB\fIVALUE\fR\fR | \fB\-\-html\fR | \fB\-\-encoding\ \fR\fB\fIENCODING\fR\fR\fB\ \fR | \fB\-\-param\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR | \fB\-\-stringparam\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR | \fB\-\-nonet\fR | \fB\-\-path\ "\fR\fB\fIPATH(S)\fR\fR\fB"\fR | \fB\-\-load\-trace\fR | \fB\-\-catalogs\fR | \fB\-\-xinclude\fR | [\fB\-\-profile\fR\ |\ \fB\-\-norman\fR] | \fB\-\-dumpextensions\fR | \fB\-\-nowrite\fR | \fB\-\-nomkdir\fR | \fB\-\-writesubtree\ \fR\fB\fIPATH\fR\fR | \fB\-\-nodtdattr\fR] [\fISTYLESHEET\fR] {\fIXML\-FILE\fR | \-}
10
 
11
-		\fBxsltproc\fR
12
-		 [
13
-			 [
14
-				 | \fB\-V\fR
15
-				 | \fB\-\-version\fR
16
-			]
17
-			 [
18
-				 | \fB\-v\fR
19
-				 | \fB\-\-verbose\fR
20
-			]
21
-			 [
22
-				 {
23
-					 | \fB\-o\fR
24
-					 | \fB\-\-output\fR
25
-				}
26
-				 {
27
-					 | \fIFILE\fR
28
-					 | \fIDIRECTORY\fR
29
-				}
30
-			]
31
-			 | \fB\-\-timing\fR
32
-			 | \fB\-\-repeat\fR
33
-			 | \fB\-\-debug\fR
34
-			 | \fB\-\-novalid\fR
35
-			 | \fB\-\-noout\fR
36
-			 | \fB\-\-maxdepth\ \fR\fB\fIVALUE\fR\fR
37
-			 | \fB\-\-html\fR
38
-			 | \fB\-\-encoding\ \fR\fB\fIENCODING\fR\fR\fB\ \fR
39
-			 | \fB\-\-param\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR
40
-			 | \fB\-\-stringparam\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR
41
-			 | \fB\-\-nonet\fR
42
-			 | \fB\-\-path\ "\fR\fB\fIPATH(S)\fR\fR\fB"\fR
43
-			 | \fB\-\-load\-trace\fR
44
-			 | \fB\-\-catalogs\fR
45
-			 | \fB\-\-xinclude\fR
46
-			 | [\ |\ \fB\-\-profile\fR\ |\ \fB\-\-norman\fR\ ]
47
-			 | \fB\-\-dumpextensions\fR
48
-			 | \fB\-\-nowrite\fR
49
-			 | \fB\-\-nomkdir\fR
50
-			 | \fB\-\-writesubtree\ \fR\fB\fIPATH\fR\fR
51
-			 | \fB\-\-nodtdattr\fR
52
-		]
53
-		 [\fISTYLESHEET\fR]
54
-		 {
55
-			 | \fIXML\-FILE\fR...
56
-			 | \-
57
-		}
58
-	
59
 
60
-
61
 .SH "DESCRIPTION"
62
+.PP
63
 
64
-	
65
-	.PP
66
 \fBxsltproc\fR
67
 is a command line tool for applying
68
 XSLT
69
@@ -100,21 +51,21 @@ stylesheets to
70
 XML
71
 documents\&. It is part of
72
 \fBlibxslt\fR(3), the XSLT C library for GNOME\&. While it was developed as part of the GNOME project, it can operate independently of the GNOME desktop\&.
73
+.PP
74
 
75
-	.PP
76
 \fBxsltproc\fR
77
 is invoked from the command line with the name of the stylesheet to be used followed by the name of the file or files to which the stylesheet is to be applied\&. It will use the standard input if a filename provided is
78
 \fB\-\fR
79
 \&.
80
+.PP
81
 
82
-	.PP
83
 If a stylesheet is included in an
84
 XML
85
 document with a Stylesheet Processing Instruction, no stylesheet need to be named at the command line\&.
86
 \fBxsltproc\fR
87
 will automatically detect the included stylesheet and use it\&.
88
+.PP
89
 
90
-	.PP
91
 By default, output is to
92
 stdout\&. You can specify a file for output using the
93
 \fB\-o\fR
94
@@ -124,16 +75,12 @@ option\&.
95
 
96
 
97
 .SH "OPTIONS"
98
+.PP
99
 
100
-	
101
-	.PP
102
 \fBxsltproc\fR
103
 accepts the following options (in alphabetical order):
104
+.PP
105
 
106
-	
107
-
108
-
109
-		.PP
110
 \fB\-\-catalogs\fR
111
 .RS 4
112
 
113
@@ -148,11 +95,9 @@ to resolve the location of external entities\&. By def
114
 looks for the catalog specified in
115
 \fBXML_CATALOG_FILES\fR\&. If that is not specified, it uses
116
 /etc/xml/catalog\&.
117
+.RE
118
+.PP
119
 
120
-	
121
-		.RE
122
-
123
-		.PP
124
 \fB\-\-debug\fR
125
 .RS 4
126
 
127
@@ -161,11 +106,9 @@ looks for the catalog specified in
128
 		Output an
129
 XML
130
 tree of the transformed document for debugging purposes\&.
131
+.RE
132
+.PP
133
 
134
-	
135
-		.RE
136
-
137
-		.PP
138
 \fB\-\-dumpextensions\fR
139
 .RS 4
140
 
141
@@ -173,11 +116,9 @@ tree of the transformed document for debugging purpose
142
 	
143
 		Dumps the list of all registered extensions on
144
 stdout\&.
145
+.RE
146
+.PP
147
 
148
-	
149
-		.RE
150
-
151
-		.PP
152
 \fB\-\-html\fR
153
 .RS 4
154
 
155
@@ -186,11 +127,9 @@ stdout\&.
156
 		The input document is an
157
 HTML
158
 file\&.
159
+.RE
160
+.PP
161
 
162
-	
163
-		.RE
164
-
165
-		.PP
166
 \fB\-\-load\-trace\fR
167
 .RS 4
168
 
169
@@ -198,11 +137,9 @@ file\&.
170
 	
171
 		Display all the documents loaded during the processing to
172
 stderr\&.
173
+.RE
174
+.PP
175
 
176
-	
177
-		.RE
178
-
179
-		.PP
180
 \fB\-\-maxdepth \fR\fB\fIVALUE\fR\fR
181
 .RS 4
182
 
183
@@ -211,11 +148,9 @@ stderr\&.
184
 		Adjust the maximum depth of the template stack before
185
 \fBlibxslt\fR(3)
186
 concludes it is in an infinite loop\&. The default is 3000\&.
187
+.RE
188
+.PP
189
 
190
-	
191
-		.RE
192
-
193
-		.PP
194
 \fB\-\-nodtdattr\fR
195
 .RS 4
196
 
197
@@ -223,22 +158,18 @@ concludes it is in an infinite loop\&. The default is 
198
 	
199
 		Do not apply default attributes from the document\*(Aqs
200
 DTD\&.
201
+.RE
202
+.PP
203
 
204
-	
205
-		.RE
206
-
207
-		.PP
208
 \fB\-\-nomkdir\fR
209
 .RS 4
210
 
211
 	
212
 	
213
 		Refuses to create directories\&.
214
+.RE
215
+.PP
216
 
217
-	
218
-		.RE
219
-
220
-		.PP
221
 \fB\-\-nonet\fR
222
 .RS 4
223
 
224
@@ -246,22 +177,18 @@ DTD\&.
225
 	
226
 		Do not use the Internet to fetch
227
 DTDs, entities or documents\&.
228
+.RE
229
+.PP
230
 
231
-	
232
-		.RE
233
-
234
-		.PP
235
 \fB\-\-noout\fR
236
 .RS 4
237
 
238
 	
239
 	
240
 		Do not output the result\&.
241
+.RE
242
+.PP
243
 
244
-	
245
-		.RE
246
-
247
-		.PP
248
 \fB\-\-novalid\fR
249
 .RS 4
250
 
251
@@ -269,22 +196,18 @@ DTDs, entities or documents\&.
252
 	
253
 		Skip loading the document\*(Aqs
254
 DTD\&.
255
+.RE
256
+.PP
257
 
258
-	
259
-		.RE
260
-
261
-		.PP
262
 \fB\-\-nowrite\fR
263
 .RS 4
264
 
265
 	
266
 	
267
 		Refuses to write to any file or resource\&.
268
+.RE
269
+.PP
270
 
271
-	
272
-		.RE
273
-
274
-		.PP
275
 \fB\-o\fR or \fB\-\-output\fR \fIFILE\fR | \fIDIRECTORY\fR
276
 .RS 4
277
 
278
@@ -311,10 +234,9 @@ directs the output files to the specified directory\&.
279
 			The given directory
280
 \fBmust\fR
281
 already exist\&.
282
-
283
-		.sp .5v
284
+.sp .5v
285
 .RE
286
-		.if n \{\
287
+.if n \{\
288
 .sp
289
 .\}
290
 .RS 4
291
@@ -341,20 +263,18 @@ will\&.
292
 
293
 		.sp .5v
294
 .RE
295
-	
296
-		.RE
297
+.RE
298
+.PP
299
 
300
-		.PP
301
 \fB\-\-encoding \fR\fB\fIENCODING\fR\fR
302
 .RS 4
303
 
304
 	
305
 	
306
 		Allow to specify the encoding for the input\&.
307
+.RE
308
+.PP
309
 
310
-	
311
-		.RE
312
-		.PP
313
 \fB\-\-param \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
314
 .RS 4
315
 
316
@@ -367,11 +287,9 @@ and value
317
 to the stylesheet\&. You may pass multiple name/value pairs up to a maximum of 32\&. If the value being passed is a string, you can use
318
 \fB\-\-stringparam\fR
319
 instead, to avoid additional quote characters that appear in string expressions\&. Note: the XPath expression must be UTF\-8 encoded\&.
320
+.RE
321
+.PP
322
 
323
-	
324
-		.RE
325
-
326
-		.PP
327
 \fB\-\-path "\fR\fB\fIPATH(S)\fR\fR\fB"\fR
328
 .RS 4
329
 
330
@@ -381,33 +299,27 @@ instead, to avoid additional quote characters that app
331
 \fIPATHS\fR
332
 to load
333
 DTDs, entities or documents\&. Enclose space\-separated lists by quotation marks\&.
334
+.RE
335
+.PP
336
 
337
-	
338
-		.RE
339
-
340
-		.PP
341
 \fB\-\-profile\fR or \fB\-\-norman\fR
342
 .RS 4
343
 
344
 	
345
 	
346
 		Output profiling information detailing the amount of time spent in each part of the stylesheet\&. This is useful in optimizing stylesheet performance\&.
347
+.RE
348
+.PP
349
 
350
-	
351
-		.RE
352
-
353
-		.PP
354
 \fB\-\-repeat\fR
355
 .RS 4
356
 
357
 	
358
 	
359
 		Run the transformation 20 times\&. Used for timing tests\&.
360
+.RE
361
+.PP
362
 
363
-	
364
-		.RE
365
-
366
-		.PP
367
 \fB\-\-stringparam \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
368
 .RS 4
369
 
370
@@ -422,22 +334,18 @@ where
371
 is a string rather than a node identifier\&.
372
 \fBNote:\fR
373
 The string must be UTF\-8 encoded\&.
374
+.RE
375
+.PP
376
 
377
-	
378
-		.RE
379
-
380
-		.PP
381
 \fB\-\-timing\fR
382
 .RS 4
383
 
384
 	
385
 	
386
 		Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result\&. Displayed in milliseconds\&.
387
+.RE
388
+.PP
389
 
390
-	
391
-		.RE
392
-
393
-		.PP
394
 \fB\-v\fR or \fB\-\-verbose\fR
395
 .RS 4
396
 
397
@@ -446,11 +354,9 @@ The string must be UTF\-8 encoded\&.
398
 		Output each step taken by
399
 \fBxsltproc\fR
400
 in processing the stylesheet and the document\&.
401
+.RE
402
+.PP
403
 
404
-	
405
-		.RE
406
-
407
-		.PP
408
 \fB\-V\fR or \fB\-\-version\fR
409
 .RS 4
410
 
411
@@ -461,11 +367,9 @@ in processing the stylesheet and the document\&.
412
 and
413
 \fBlibxslt\fR(3)
414
 used\&.
415
+.RE
416
+.PP
417
 
418
-	
419
-		.RE
420
-
421
-		.PP
422
 \fB\-\-writesubtree \fR\fB\fIPATH\fR\fR
423
 .RS 4
424
 
425
@@ -474,11 +378,9 @@ used\&.
426
 		Allow file write only within the
427
 \fIPATH\fR
428
 subtree\&.
429
+.RE
430
+.PP
431
 
432
-	
433
-		.RE
434
-
435
-		.PP
436
 \fB\-\-xinclude\fR
437
 .RS 4
438
 
439
@@ -486,19 +388,14 @@ subtree\&.
440
 	
441
 		Process the input document using the XInclude specification\&. More details on this can be found in the XInclude specification:
442
 \m[blue]\fB\%http://www.w3.org/TR/xinclude/\fR\m[]
443
+.RE
444
 
445
 	
446
-		.RE
447
 
448
-	
449
-
450
 .SH "ENVIRONMENT"
451
+.PP
452
 
453
-	
454
-	
455
 
456
-
457
-		.PP
458
 \fBSGML_CATALOG_FILES\fR
459
 .RS 4
460
 
461
@@ -510,11 +407,9 @@ catalog behavior can be changed by redirecting queries
462
 environment variable to a list of catalogs\&. An empty one should deactivate loading the default
463
 /etc/sgml/catalog
464
 catalog\&.
465
+.RE
466
+.PP
467
 
468
-	
469
-		.RE
470
-
471
-		.PP
472
 \fBXML_CATALOG_FILES\fR
473
 .RS 4
474
 
475
@@ -526,160 +421,132 @@ catalog behavior can be changed by redirecting queries
476
 environment variable to a list of catalogs\&. An empty one should deactivate loading the default
477
 /etc/xml/catalog
478
 catalog\&.
479
+.RE
480
 
481
 	
482
-		.RE
483
 
484
-	
485
-
486
 .SH "DIAGNOSTICS"
487
+.PP
488
 
489
-	
490
-	.PP
491
+
492
 \fBxsltproc\fR
493
 return codes provide information that can be used when calling it from scripts\&.
494
+.PP
495
 
496
-	
497
 
498
-
499
-		.PP
500
 \fB0\fR
501
 .RS 4
502
 
503
 	
504
 	
505
 		No error (normal operation)
506
+.RE
507
+.PP
508
 
509
-	
510
-		.RE
511
-
512
-		.PP
513
 \fB1\fR
514
 .RS 4
515
 
516
 	
517
 	
518
 		No argument
519
+.RE
520
+.PP
521
 
522
-	
523
-		.RE
524
 
525
-		.PP
526
 \fB2\fR
527
 .RS 4
528
 
529
 	
530
 	
531
 		Too many parameters
532
+.RE
533
+.PP
534
 
535
-	
536
-		.RE
537
-
538
-		.PP
539
 \fB3\fR
540
 .RS 4
541
 
542
 	
543
 	
544
 		Unknown option
545
+.RE
546
+.PP
547
 
548
-	
549
-		.RE
550
-
551
-		.PP
552
 \fB4\fR
553
 .RS 4
554
 
555
 	
556
 	
557
 		Failed to parse the stylesheet
558
+.RE
559
+.PP
560
 
561
-	
562
-		.RE
563
-
564
-		.PP
565
 \fB5\fR
566
 .RS 4
567
 
568
 	
569
 	
570
 		Error in the stylesheet
571
+.RE
572
+.PP
573
 
574
-	
575
-		.RE
576
-
577
-		.PP
578
 \fB6\fR
579
 .RS 4
580
 
581
 	
582
 	
583
 		Error in one of the documents
584
+.RE
585
+.PP
586
 
587
-	
588
-		.RE
589
-
590
-		.PP
591
 \fB7\fR
592
 .RS 4
593
 
594
 	
595
 	
596
 		Unsupported xsl:output method
597
+.RE
598
+.PP
599
 
600
-	
601
-		.RE
602
-
603
-		.PP
604
 \fB8\fR
605
 .RS 4
606
 
607
 	
608
 	
609
 		String parameter contains both quote and double\-quotes
610
+.RE
611
+.PP
612
 
613
-	
614
-		.RE
615
-
616
-		.PP
617
 \fB9\fR
618
 .RS 4
619
 
620
 	
621
 	
622
 		Internal processing error
623
+.RE
624
+.PP
625
 
626
-	
627
-		.RE
628
-
629
-		.PP
630
 \fB10\fR
631
 .RS 4
632
 
633
 	
634
 	
635
 		Processing was stopped by a terminating message
636
+.RE
637
+.PP
638
 
639
-	
640
-		.RE
641
-
642
-		.PP
643
 \fB11\fR
644
 .RS 4
645
 
646
 	
647
 	
648
 		Could not write the result to the output file
649
+.RE
650
 
651
-	
652
-		.RE
653
 
654
-	
655
-
656
 .SH "SEE ALSO"
657
+.PP
658
 
659
-	
660
-	.PP
661
+
662
 \fBlibxml\fR(3),
663
 \fBlibxslt\fR(3)
664
 
665
@@ -698,8 +565,8 @@ More information can be found at
666
 				\fBlibxml\fR(3)
667
 web page
668
 \m[blue]\fB\%http://www.xmlsoft.org/\fR\m[]
669
+.RE
670
 
671
-			.RE
672
 .sp
673
 .RS 4
674
 .ie n \{\
675
@@ -714,8 +581,8 @@ web page
676
 XSLT
677
 page
678
 \m[blue]\fB\%http://www.w3.org/TR/xslt\fR\m[]
679
+.RE
680
 
681
-			.RE
682
 .sp
683
 
684
 

Return to bug 243345