components/libxslt/xsltproc.1
branchs11-update
changeset 2451 f54396da08ea
parent 2448 c1b40b77a1ae
child 2452 9dc4dfa4b04d
equal deleted inserted replaced
2448:c1b40b77a1ae 2451:f54396da08ea
     1 ."Generated by db2man.xsl. Don't modify this, modify the source.
       
     2 .de Sh \" Subsection
       
     3 .br
       
     4 .if t .Sp
       
     5 .ne 5
       
     6 .PP
       
     7 \fB\\$1\fR
       
     8 .PP
       
     9 ..
       
    10 .de Sp \" Vertical space (when we can't use .PP)
       
    11 .if t .sp .5v
       
    12 .if n .sp
       
    13 ..
       
    14 .de Ip \" List item
       
    15 .br
       
    16 .ie \\n(.$>=3 .ne \\$3
       
    17 .el .ne 3
       
    18 .IP "\\$1" \\$2
       
    19 ..
       
    20 .TH "xsltproc" 1 "2002 Jun 27"
       
    21 .SH NAME
       
    22 xsltproc \- command line xslt processor
       
    23 .SH "SYNOPSIS"
       
    24 \fBxsltproc\fR [\fB-V\fR | \fB-v\fR | \fB-o  \fIfile\fR \fR | \fB--timing\fR | \fB--repeat\fR | \fB--debug\fR | \fB--novalid\fR | \fB--noout\fR | \fB--maxdepth  \fIval\fR \fR | \fB--html\fR | \fB--docbook\fR | \fB--param  \fIname\fR   \fIvalue\fR \fR | \fB--stringparam  \fIname\fR   \fIvalue\fR \fR | \fB--nonet\fR | \fB--warnnet\fR | \fB--catalogs\fR | \fB--xinclude\fR | \fB--profile\fR] [\fB\fIstylesheet\fR\fR] [ \fIfile1\fR ] [ \fIfile2\fR ] [ \fI....\fR ]
       
    25 .SH "INTRODUCTION"
       
    26 
       
    27 .PP
       
    28 xsltproc is a command line tool for applying XSLT stylesheets to XML documents. It is part of libxslt, the XSLT C library for GNOME. While it was developed as part of the GNOME project, it can operate independently of the GNOME desktop.
       
    29 .PP
       
    30 xsltproc 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.
       
    31 .PP
       
    32 If a stylesheet is included in an XML document with a Stylesheet Processing Instruction, no stylesheet need be named at the command line. xsltproc will automatically detect the included stylesheet and use it.
       
    33 .PP
       
    34 By default, output is to stdout. You can specify a file for output using the \fB-o\fR option.
       
    35 
       
    36 .SH "COMMAND LINE OPTIONS"
       
    37 
       
    38 .TP
       
    39 \fB-V\fR or \fB--version\fR
       
    40 Show the version of libxml and libxslt used.
       
    41 .TP
       
    42 \fB-v\fR or \fB--verbose\fR
       
    43 Output each step taken by xsltproc in processing the stylesheet and the document.
       
    44 .TP
       
    45 \fB-o\fR or \fB--output\fR \fIfile\fR
       
    46 Direct output to the file named \fIfile\fR. For multiple outputs, also known as "chunking", \fB-o\fR \fBdirectory/\fR directs the output files to a specified directory. The directory must already exist.
       
    47 .TP
       
    48 \fB--timing\fR
       
    49 Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result. Displayed in milliseconds.
       
    50 .TP
       
    51 \fB--repeat\fR
       
    52 Run the transformation 20 times. Used for timing tests.
       
    53 .TP
       
    54 \fB--debug\fR
       
    55 Output an XML tree of the transformed document for debugging purposes.
       
    56 .TP
       
    57 \fB--novalid\fR
       
    58 Skip loading the document's DTD.
       
    59 .TP
       
    60 \fB--noout\fR
       
    61 Do not output the result.
       
    62 .TP
       
    63 \fB--maxdepth\fR \fIvalue\fR
       
    64 Adjust the maximum depth of the template stack before libxslt concludes it is in an infinite loop. The default is 500.
       
    65 .TP
       
    66 \fB--html\fR
       
    67 The input document is an HTML file.
       
    68 .TP
       
    69 \fB--docbook\fR
       
    70 The input document is DocBook SGML.
       
    71 .TP
       
    72 \fB--param\fR \fIname\fR \fIvalue\fR
       
    73 Pass a parameter of name \fIname\fR and value \fIvalue\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 rather than a node identifier, use \fB--stringparam\fR instead.
       
    74 .TP
       
    75 \fB--stringparam\fR \fIname\fR \fIvalue\fR
       
    76 Pass a paramenter of name \fIname\fR and value \fIvalue\fR where \fIvalue\fR is a string rather than a node identifier.
       
    77 .TP
       
    78 \fB--nonet\fR
       
    79 Do not use the Internet to fetch DTD's or entities.
       
    80 .TP
       
    81 \fB--warnnet\fR
       
    82 Output notification when DTD's or entities are fetched over the Internet.
       
    83 .TP
       
    84 \fB--catalogs\fR
       
    85 Use catalogs to resolve the location of external entities. This speeds DTD resolution. By having a catalog file point to a local version of the DTD, xsltproc does not have to use the Internet to fetch the DTD. xsltproc uses the catalog identified by the environmental variable \fBSGML_CATALOG_FILES\fR.
       
    86 .TP
       
    87 \fB--xinclude\fR
       
    88 Process the input document using the Xinclude specification. More details on this can be found in the Xinclude specification: http://www.w3.org/TR/xinclude/.
       
    89 .TP
       
    90 \fB--profile\fR or \fB--norman\fR
       
    91 Output profiling information detailing the amount of time spent in each part of the stylesheet. This is useful in optimizing stylesheet performance.
       
    92 
       
    93 .SH "RETURN VALUES"
       
    94 
       
    95 .PP
       
    96 xsltproc's return codes provide information that can be used when calling it from scripts.
       
    97 
       
    98 .PP
       
    99 0: normal
       
   100 .PP
       
   101 1: no argument
       
   102 .PP
       
   103 2: too many parameters
       
   104 .PP
       
   105 3: unknown option
       
   106 .PP
       
   107 4: failed to parse the stylesheet
       
   108 .PP
       
   109 5: error in the stylesheet
       
   110 .PP
       
   111 6: error in one of the documents
       
   112 .PP
       
   113 7: unsupported xsl:output method
       
   114 .PP
       
   115 8: string parameter contains both quote and double-quotes
       
   116 
       
   117 .SH "MORE INFORMATION"
       
   118 
       
   119 .PP
       
   120 libxml web page: http://www.xmlsoft.org/
       
   121 .PP
       
   122 W3C XSLT page: http://www.w3.org/TR/xslt
       
   123 
       
   124 .SH AUTHOR
       
   125 Copyright 2001 by John Fleck  <[email protected]>.
       
   126 This is release 0.2 of the xsltproc Manual.
       
   127