lib/libxslt
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/libxslt synced 2025-08-07 10:42:55 +03:00
Code Activity

Recreate xsltproc man page with old Docbook stylesheet URL

Browse Source 
Fixes #31.
This commit is contained in:
Nick Wellnhofer
2020-09-20 16:59:23 +02:00
parent 9d0318519a
commit f165525fe7
2 changed files with 161 additions and 468 deletions
Download Patch File Download Diff File Expand all files Collapse all files

627
doc/xsltproc.1
View File

@@ -1,7 +1,7 @@
'\" t '\" t
.\" Title: xsltproc .\" Title: xsltproc
.\" Author: John Fleck <jfleck@inkstain.net> .\" Author: John Fleck <jfleck@inkstain.net>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: $Date$ .\" Date: $Date$
.\" Manual: xsltproc Manual .\" Manual: xsltproc Manual
.\" Source: libxslt .\" Source: libxslt
@@ -27,72 +27,13 @@
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE * .\" * MAIN CONTENT STARTS HERE *
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.SH "NAME" .SH "NAME"
xsltproc \- command line XSLT processor xsltproc \- command line XSLT processor
.SH "SYNOPSIS" .SH "SYNOPSIS"
.HP \w'\fBxsltproc\fR\ 'u
.HP \w'\fBxsltproc\fR\ 'u \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\-\-maxvars\ \fR\fB\fIVALUE\fR\fR | \fB\-\-maxparserdepth\ \fR\fB\fIVALUE\fR\fR | \fB\-\-huge\fR | \fB\-\-seed\-rand\ \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\-\-xincludestyle\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... | \-}
\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...
| \-
}
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP
.PP
\fBxsltproc\fR \fBxsltproc\fR
is a command line tool for applying is a command line tool for applying
XSLT XSLT
@@ -100,46 +41,32 @@ stylesheets to
XML XML
documents\&. It is part of documents\&. It is part of
\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\&. \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\&.
.PP
.PP
\fBxsltproc\fR \fBxsltproc\fR
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 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
\fB\-\fR \fB\-\fR
\&. \&.
.PP
.PP
If a stylesheet is included in an If a stylesheet is included in an
XML XML
document with a Stylesheet Processing Instruction, no stylesheet need to be named at the command line\&. document with a Stylesheet Processing Instruction, no stylesheet need to be named at the command line\&.
\fBxsltproc\fR \fBxsltproc\fR
will automatically detect the included stylesheet and use it\&. will automatically detect the included stylesheet and use it\&.
.PP
.PP
By default, output is to By default, output is to
stdout\&. You can specify a file for output using the stdout\&. You can specify a file for output using the
\fB\-o\fR \fB\-o\fR
or or
\fB\-\-output\fR \fB\-\-output\fR
option\&. option\&.
.SH "OPTIONS" .SH "OPTIONS"
.PP
.PP
\fBxsltproc\fR \fBxsltproc\fR
accepts the following options (in alphabetical order): accepts the following options (in alphabetical order):
.PP
.PP
\fB\-\-catalogs\fR \fB\-\-catalogs\fR
.RS 4 .RS 4
Use the
Use the
SGML SGML
catalog specified in catalog specified in
\fBSGML_CATALOG_FILES\fR \fBSGML_CATALOG_FILES\fR
@@ -148,154 +75,101 @@ to resolve the location of external entities\&. By default,
looks for the catalog specified in looks for the catalog specified in
\fBXML_CATALOG_FILES\fR\&. If that is not specified, it uses \fBXML_CATALOG_FILES\fR\&. If that is not specified, it uses
/etc/xml/catalog\&. /etc/xml/catalog\&.
.RE
.PP
.RE
.PP
\fB\-\-debug\fR \fB\-\-debug\fR
.RS 4 .RS 4
Output an
Output an
XML XML
tree of the transformed document for debugging purposes\&. tree of the transformed document for debugging purposes\&.
.RE
.PP
.RE
.PP
\fB\-\-dumpextensions\fR \fB\-\-dumpextensions\fR
.RS 4 .RS 4
Dumps the list of all registered extensions on
Dumps the list of all registered extensions on
stdout\&. stdout\&.
.RE
.PP
.RE
.PP
\fB\-\-html\fR \fB\-\-html\fR
.RS 4 .RS 4
The input document is an
The input document is an
HTML HTML
file\&. file\&.
.RE
.PP
.RE
.PP
\fB\-\-load\-trace\fR \fB\-\-load\-trace\fR
.RS 4 .RS 4
Display all the documents loaded during the processing to
Display all the documents loaded during the processing to
stderr\&. stderr\&.
.RE
.PP
.RE
.PP
\fB\-\-maxdepth \fR\fB\fIVALUE\fR\fR \fB\-\-maxdepth \fR\fB\fIVALUE\fR\fR
.RS 4 .RS 4
Adjust the maximum depth of the template stack before
Adjust the maximum depth of the template stack before
\fBlibxslt\fR(3) \fBlibxslt\fR(3)
concludes it is in an infinite loop\&. The default is 3000\&. concludes it is in an infinite loop\&. The default is 3000\&.
.RE
.PP
.RE \fB\-\-maxvars \fR\fB\fIVALUE\fR\fR
.RS 4
.PP Maximum number of variables\&. The default is 15000\&.
.RE
.PP
\fB\-\-maxparserdepth \fR\fB\fIVALUE\fR\fR
.RS 4
Maximum element nesting level of parsed XML documents\&. The default is 256\&.
.RE
.PP
\fB\-\-huge\fR
.RS 4
Relax hardcoded limits of the XML parser by setting the XML_PARSE_HUGE parser option\&.
.RE
.PP
\fB\-\-seed\-rand \fR\fB\fIVALUE\fR\fR
.RS 4
Initialize pseudo random number generator with specific seed\&.
.RE
.PP
\fB\-\-nodtdattr\fR \fB\-\-nodtdattr\fR
.RS 4 .RS 4
Do not apply default attributes from the document\*(Aqs
Do not apply default attributes from the document\*(Aqs
DTD\&. DTD\&.
.RE
.PP
.RE
.PP
\fB\-\-nomkdir\fR \fB\-\-nomkdir\fR
.RS 4 .RS 4
Refuses to create directories\&.
.RE
.PP
Refuses to create directories\&.
.RE
.PP
\fB\-\-nonet\fR \fB\-\-nonet\fR
.RS 4 .RS 4
Do not use the Internet to fetch
Do not use the Internet to fetch
DTDs, entities or documents\&. DTDs, entities or documents\&.
.RE
.PP
.RE
.PP
\fB\-\-noout\fR \fB\-\-noout\fR
.RS 4 .RS 4
Do not output the result\&.
.RE
.PP
Do not output the result\&.
.RE
.PP
\fB\-\-novalid\fR \fB\-\-novalid\fR
.RS 4 .RS 4
Skip loading the document\*(Aqs
Skip loading the document\*(Aqs
DTD\&. DTD\&.
.RE
.PP
.RE
.PP
\fB\-\-nowrite\fR \fB\-\-nowrite\fR
.RS 4 .RS 4
Refuses to write to any file or resource\&.
.RE
.PP
Refuses to write to any file or resource\&.
.RE
.PP
\fB\-o\fR or \fB\-\-output\fR \fIFILE\fR | \fIDIRECTORY\fR \fB\-o\fR or \fB\-\-output\fR \fIFILE\fR | \fIDIRECTORY\fR
.RS 4 .RS 4
Direct output to the given
Direct output to the given
\fIFILE\fR\&. Using the option with a \fIFILE\fR\&. Using the option with a
\fIDIRECTORY\fR \fIDIRECTORY\fR
directs the output files to the specified directory\&. This can be useful for multiple outputs (also known as "chunking") or manpage processing\&. directs the output files to the specified directory\&. This can be useful for multiple outputs (also known as "chunking") or manpage processing\&.
.if n \{\
.if n \{\
.sp .sp
.\} .\}
.RS 4 .RS 4
@@ -307,14 +181,12 @@ directs the output files to the specified directory\&. This can be useful for mu
\fBImportant\fR \fBImportant\fR
.ps -1 .ps -1
.br .br
The given directory
The given directory
\fBmust\fR \fBmust\fR
already exist\&. already exist\&.
.sp .5v
.sp .5v
.RE .RE
.if n \{\ .if n \{\
.sp .sp
.\} .\}
.RS 4 .RS 4
@@ -326,8 +198,7 @@ already exist\&.
\fBNote\fR \fBNote\fR
.ps -1 .ps -1
.br .br
Make sure that
Make sure that
\fIFILE\fR \fIFILE\fR
and and
\fIDIRECTORY\fR \fIDIRECTORY\fR
@@ -338,82 +209,47 @@ as described in RFC 2396 and laters\&. This means, that e\&.g\&.
will maybe not work, but will maybe not work, but
\fB\-o directory/\fR \fB\-o directory/\fR
will\&. will\&.
.sp .5v
.sp .5v
.RE .RE
.RE
.RE .PP
.PP
\fB\-\-encoding \fR\fB\fIENCODING\fR\fR \fB\-\-encoding \fR\fB\fIENCODING\fR\fR
.RS 4 .RS 4
Allow to specify the encoding for the input\&.
.RE
.PP
Allow to specify the encoding for the input\&.
.RE
.PP
\fB\-\-param \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR \fB\-\-param \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
.RS 4 .RS 4
Pass a parameter of name
Pass a parameter of name
\fIPARAMNAME\fR \fIPARAMNAME\fR
and value and value
\fIPARAMVALUE\fR \fIPARAMVALUE\fR
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 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
\fB\-\-stringparam\fR \fB\-\-stringparam\fR
instead, to avoid additional quote characters that appear in string expressions\&. Note: the XPath expression must be UTF\-8 encoded\&. instead, to avoid additional quote characters that appear in string expressions\&. Note: the XPath expression must be UTF\-8 encoded\&.
.RE
.PP
.RE
.PP
\fB\-\-path "\fR\fB\fIPATH(S)\fR\fR\fB"\fR \fB\-\-path "\fR\fB\fIPATH(S)\fR\fR\fB"\fR
.RS 4 .RS 4
Use the (space\- or colon\-separated) list of filesystem paths specified by
Use the (space\- or colon\-separated) list of filesystem paths specified by
\fIPATHS\fR \fIPATHS\fR
to load to load
DTDs, entities or documents\&. Enclose space\-separated lists by quotation marks\&. DTDs, entities or documents\&. Enclose space\-separated lists by quotation marks\&.
.RE
.PP
.RE
.PP
\fB\-\-profile\fR or \fB\-\-norman\fR \fB\-\-profile\fR or \fB\-\-norman\fR
.RS 4 .RS 4
Output profiling information detailing the amount of time spent in each part of the stylesheet\&. This is useful in optimizing stylesheet performance\&.
.RE
.PP
Output profiling information detailing the amount of time spent in each part of the stylesheet\&. This is useful in optimizing stylesheet performance\&.
.RE
.PP
\fB\-\-repeat\fR \fB\-\-repeat\fR
.RS 4 .RS 4
Run the transformation 20 times\&. Used for timing tests\&.
.RE
.PP
Run the transformation 20 times\&. Used for timing tests\&.
.RE
.PP
\fB\-\-stringparam \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR \fB\-\-stringparam \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
.RS 4 .RS 4
Pass a parameter of name
Pass a parameter of name
\fIPARAMNAME\fR \fIPARAMNAME\fR
and value and value
\fIPARAMVALUE\fR \fIPARAMVALUE\fR
@@ -422,268 +258,136 @@ where
is a string rather than a node identifier\&. is a string rather than a node identifier\&.
\fBNote:\fR \fBNote:\fR
The string must be UTF\-8 encoded\&. The string must be UTF\-8 encoded\&.
.RE
.PP
.RE
.PP
\fB\-\-timing\fR \fB\-\-timing\fR
.RS 4 .RS 4
Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result\&. Displayed in milliseconds\&.
.RE
.PP
Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result\&. Displayed in milliseconds\&.
.RE
.PP
\fB\-v\fR or \fB\-\-verbose\fR \fB\-v\fR or \fB\-\-verbose\fR
.RS 4 .RS 4
Output each step taken by
Output each step taken by
\fBxsltproc\fR \fBxsltproc\fR
in processing the stylesheet and the document\&. in processing the stylesheet and the document\&.
.RE
.PP
.RE
.PP
\fB\-V\fR or \fB\-\-version\fR \fB\-V\fR or \fB\-\-version\fR
.RS 4 .RS 4
Show the version of
Show the version of
\fBlibxml\fR(3) \fBlibxml\fR(3)
and and
\fBlibxslt\fR(3) \fBlibxslt\fR(3)
used\&. used\&.
.RE
.PP
.RE
.PP
\fB\-\-writesubtree \fR\fB\fIPATH\fR\fR \fB\-\-writesubtree \fR\fB\fIPATH\fR\fR
.RS 4 .RS 4
Allow file write only within the
Allow file write only within the
\fIPATH\fR \fIPATH\fR
subtree\&. subtree\&.
.RE
.PP
.RE
.PP
\fB\-\-xinclude\fR \fB\-\-xinclude\fR
.RS 4 .RS 4
Process the input document using the XInclude specification\&. More details on this can be found in the XInclude specification:
Process the input document using the XInclude specification\&. More details on this can be found in the XInclude specification:
\m[blue]\fB\%http://www.w3.org/TR/xinclude/\fR\m[] \m[blue]\fB\%http://www.w3.org/TR/xinclude/\fR\m[]
.RE
.PP
.RE \fB\-\-xincludestyle\fR
.RS 4
Process the stylesheet with XInclude\&.
.RE
.SH "ENVIRONMENT" .SH "ENVIRONMENT"
.PP
.PP
\fBSGML_CATALOG_FILES\fR \fBSGML_CATALOG_FILES\fR
.RS 4 .RS 4
SGML
SGML
catalog behavior can be changed by redirecting queries to the user\*(Aqs own set of catalogs\&. This can be done by setting the catalog behavior can be changed by redirecting queries to the user\*(Aqs own set of catalogs\&. This can be done by setting the
\fBSGML_CATALOG_FILES\fR \fBSGML_CATALOG_FILES\fR
environment variable to a list of catalogs\&. An empty one should deactivate loading the default environment variable to a list of catalogs\&. An empty one should deactivate loading the default
/etc/sgml/catalog /etc/sgml/catalog
catalog\&. catalog\&.
.RE
.PP
.RE
.PP
\fBXML_CATALOG_FILES\fR \fBXML_CATALOG_FILES\fR
.RS 4 .RS 4
XML
XML
catalog behavior can be changed by redirecting queries to the user\*(Aqs own set of catalogs\&. This can be done by setting the catalog behavior can be changed by redirecting queries to the user\*(Aqs own set of catalogs\&. This can be done by setting the
\fBXML_CATALOG_FILES\fR \fBXML_CATALOG_FILES\fR
environment variable to a list of catalogs\&. An empty one should deactivate loading the default environment variable to a list of catalogs\&. An empty one should deactivate loading the default
/etc/xml/catalog /etc/xml/catalog
catalog\&. catalog\&.
.RE
.RE
.SH "DIAGNOSTICS" .SH "DIAGNOSTICS"
.PP
.PP
\fBxsltproc\fR \fBxsltproc\fR
return codes provide information that can be used when calling it from scripts\&. return codes provide information that can be used when calling it from scripts\&.
.PP
.PP
\fB0\fR \fB0\fR
.RS 4 .RS 4
No error (normal operation)
.RE
.PP
No error (normal operation)
.RE
.PP
\fB1\fR \fB1\fR
.RS 4 .RS 4
No argument
.RE
.PP
No argument
.RE
.PP
\fB2\fR \fB2\fR
.RS 4 .RS 4
Too many parameters
.RE
.PP
Too many parameters
.RE
.PP
\fB3\fR \fB3\fR
.RS 4 .RS 4
Unknown option
.RE
.PP
Unknown option
.RE
.PP
\fB4\fR \fB4\fR
.RS 4 .RS 4
Failed to parse the stylesheet
.RE
.PP
Failed to parse the stylesheet
.RE
.PP
\fB5\fR \fB5\fR
.RS 4 .RS 4
Error in the stylesheet
.RE
.PP
Error in the stylesheet
.RE
.PP
\fB6\fR \fB6\fR
.RS 4 .RS 4
Error in one of the documents
.RE
.PP
Error in one of the documents
.RE
.PP
\fB7\fR \fB7\fR
.RS 4 .RS 4
Unsupported xsl:output method
.RE
.PP
Unsupported xsl:output method
.RE
.PP
\fB8\fR \fB8\fR
.RS 4 .RS 4
String parameter contains both quote and double\-quotes
.RE
.PP
String parameter contains both quote and double\-quotes
.RE
.PP
\fB9\fR \fB9\fR
.RS 4 .RS 4
Internal processing error
.RE
.PP
Internal processing error
.RE
.PP
\fB10\fR \fB10\fR
.RS 4 .RS 4
Processing was stopped by a terminating message
.RE
.PP
Processing was stopped by a terminating message
.RE
.PP
\fB11\fR \fB11\fR
.RS 4 .RS 4
Could not write the result to the output file
.RE
Could not write the result to the output file
.RE
.SH "SEE ALSO" .SH "SEE ALSO"
.PP
.PP
\fBlibxml\fR(3), \fBlibxml\fR(3),
\fBlibxslt\fR(3) \fBlibxslt\fR(3)
.PP
.PP
More information can be found at More information can be found at
.sp .sp
.RS 4 .RS 4
@@ -694,12 +398,10 @@ More information can be found at
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
\fBlibxml\fR(3)
\fBlibxml\fR(3)
web page web page
\m[blue]\fB\%http://www.xmlsoft.org/\fR\m[] \m[blue]\fB\%http://www.xmlsoft.org/\fR\m[]
.RE
.RE
.sp .sp
.RS 4 .RS 4
.ie n \{\ .ie n \{\
@@ -709,24 +411,15 @@ web page
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
W3C
W3C
XSLT XSLT
page page
\m[blue]\fB\%http://www.w3.org/TR/xslt\fR\m[] \m[blue]\fB\%http://www.w3.org/TR/xslt\fR\m[]
.RE
.RE
.sp .sp
.SH "AUTHOR" .SH "AUTHOR"
.PP .PP
\fBJohn Fleck\fR <\&jfleck@inkstain\&.net\&> \fBJohn Fleck\fR <\&jfleck@inkstain\&.net\&>
.br
.RS 4 .RS 4
Author. Author.
.RE .RE

2
doc/xsltproc.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" <?xml-stylesheet type="text/xsl"
href="http://cdn.docbook.org/release/xsl/current//manpages/docbook.xsl"?> href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [