Running XSLT from the Command Line

-a[:(on|off)]

Use the xml-stylesheet processing instruction in the source document to identify the stylesheet to be used. The stylesheet argument must not be present on the command line. For more details see Using the -a option.

-catalog:filenames

filenames is either a file name or a list of file names separated by semicolons; the files are OASIS XML catalogs used to define how public identifiers and system identifiers (URIs) used in a source document, stylesheet, or schema are to be redirected, typically to resources available locally. For more details see Using XML Catalogs.

-config:filename

Indicates that configuration information should be taken from the supplied configuration file. Any options supplied on the command line override options specified in the configuration file.

-cr:classname

Use the specified CollectionURIResolver to process collection URIs passed to the collection() function. The CollectionURIResolver is a user-defined class that implements the net.sf.saxon.lib.CollectionURIResolver interface.

-dtd:(on|off|recover)

Setting -dtd:on requests DTD-based validation of the source file and of any files read using the document() function. Requires an XML parser that supports validation. The setting -dtd:off (which is the default) suppresses DTD validation. The setting -dtd:recover performs DTD validation but treats the error as non-fatal if it fails. Note that any external DTD is likely to be read even if not used for validation, because DTDs can contain definitions of entities.

-ea:(on|off)

Setting -ea:on enables assertions both at compile time and at run time. Assertions (defined using the XSLT 3.0 xsl:assert instruction) are disabled by default at compile time, and enabled by default at run-time provided they were enabled at compile time.

-expand:(on|off)

Normally, if validation using a DTD or schema is requested, any fixed or default values defined in the DTD or schema will be expanded. Specifying -expand:off suppresses this. (In the case of DTD-defined defaults, this might not work with all XML parsers. It does work with the Xerces parser (default for Java) and the Microsoft parser (default for .NET).)

-explain[:filename]

Display an execution plan and other diagnostic information for the stylesheet. This is a representation of the expression tree after rewriting by the optimizer. It combines the XSLT instructions and the XPath expressions into a single tree. If no file name is specified the output is sent to the standard error stream. The output is in XML format.

-export:filename

Export the compiled stylesheet, in a form suitable for subsequent execution. For more details, see Compiling a Stylesheet.

-ext:(on|off)

If ext:off is specified, suppress calls on dynamically-loaded external Java functions. This does not affect calls on integrated extension functions, including Saxon and EXSLT extension functions. This option is useful when loading an untrusted stylesheet, perhaps from a remote site using an http:// URL; it ensures that the stylesheet cannot call arbitrary Java methods and thereby gain privileged access to resources on your machine.

-im:modename

Selects the initial mode for the transformation. If this is namespaced, it can be written as {uri}localname.

-init:initializer

The value is the name of a user-supplied class that implements the interface Initializer; this initializer will be called during the initialization process, and may be used to set any options required on the Configuration programmatically.

-it[:template-name]

Selects the initial named template to be executed. If this is namespaced, it can be written as {uri}localname. If the template name is omitted, the default is xsl:initial-template. When this option is used, you do not need to supply a source file, but if you do, you must supply it using the -s option.

-l[:(on|off)]

If -l or -l:on is specified, causes line and column numbers to be maintained for source documents. These are accessible using the extension functions saxon:line-number() and saxon:column-number(). Line numbers are useful when the purpose of the stylesheet is to find errors or anomalies in the source XML file. Without this option, line numbers are available while source documents are being parsed and validated, but they are not retained in the tree representation of the document.

-lib:filenames

A list of filenames containing library packages. The filenames are separated by ";" on Windows systems, or ":" on Linux and Mac. Each filename must identify either (a) a top-level module in a source XSLT package, or (b) a SEF file containing an exported library package. There is no constraint on the order of the packages.

-license:(on|off)

Relevant only when Saxon-PE or Saxon-EE software is loaded. By default, Saxon will look for a license and report a warning if none is found, which escalates to a fatal error if licenseable features (such as schema-awareness) are used. If -license:off is specified, Saxon will not look for a license unless it is needed, and will fall back silently if none is found (this means that the transformation might succeed, but without taking advantage of Saxon-EE optimizations). The option -license:off is useful to suppress warnings in the case where it is known that a compiled stylesheet containing an embedded license key is being executed.

-m:classname

Use the specified Receiver to process the output from xsl:message. The class must implement the net.sf.saxon.event.Receiver class. This interface is similar to a SAX ContentHandler, it takes a stream of events to generate output. In general the content of a message is an XML fragment. By default the standard XML emitter is used, configured to write to the standard error stream, and to include no XML declaration. Each message is output as a new document. The sequence of calls to this Receiver is as follows: there is a single open() call at the start of the transformation, and a single close() call at the end; and each evaluation of an xsl:message instruction starts with a startDocument() call and ends with endDocument(). The startDocument() event has a properties argument indicating whether terminate="yes" was specified, and the locationId on calls such as startElement() and characters() can be used to identify the location in the stylesheet where the message data originated (this is achieved by passing the supplied locationId in a call to getPipelineConfiguration().getLocator().getSystemId(locationId), or to getLineNumber() on the same object). Select the class net.sf.saxon.event.MessageWarner to have xsl:message output notified to the JAXP ErrorListener, as described in the JAXP documentation.

-nogo

If set, the stylesheet is analysed for errors, and any requested -explain or -export output is generated, but the stylesheet is not executed.

-now:yyyy-mm-ddThh:mm:ss+hh:mm

Sets the value of current-dateTime() (and implicit-timezone()) for the transformation. This is designed for testing, to enable repeatable results to be obtained for comparison with reference results, or to test that stylesheets can handle significant dates and times such as end-of-year processing.

-o:filename

Send output to named file.

If the source (-s) argument identifies a directory, this option is mandatory and must also identify a directory; on completion it will contain one output file for each file in the source directory.

In other cases, this option has two effects: it defines the file where the principal output of the transformation will be written, and it defines the base URI used for resolving the value of the xsl:result-document/@href attribute when secondary result documents are written.

In the absence of this option, (a) the principal output is written to the standard output stream, and (b) secondary output file locations are resolved relative to the current working directory.

Output files are created if they do not already exist; any necessary directories will also be created. If a file does already exist, it is generally overwritten, though this will not necessarily happen if the transformation fails.

-opt:[-]flags

Allows individual optimizations to be enabled or disabled selectively. There is a set of single-letter flags identifying particular optimizations:

• c: generate bytecode
• d: detect void path expressions
• e: cache regular expressions
• f: inline functions
• g: extract global variables
• j: just-in-time compilation of template rules
• k: create keys
• l: loop lifting
• m: miscellaneous
• r: template rule-sets
• s: extract common subexpressions
• t: tail call optimization
• v: inline variables
• w: create switch statements
• x: index predicates

A value such as opt:gs runs with only the selected optimizations; opt:-gs runs with the selected optimizations disabled and all others enabled. The value opt:0 suppresses all optimizations. The default is full optimization; this feature allows optimization to be suppressed in cases where reducing compile time is important, or where optimization gets in the way of debugging, or causes extension functions with side-effects to behave unpredictably. (Note however, that even with no optimization, lazy evaluation may still cause the evaluation order to be not as expected.)

-or:classname

Use the specified OutputURIResolver to process output URIs appearing in the href attribute of xsl:result-document. The OutputURIResolver is a user-defined class that implements the net.sf.saxon.lib.OutputURIResolver interface.

-outval:(recover|fatal)

Normally, if validation of result documents is requested, a validation error is fatal. Setting the option -outval:recover causes such validation failures to be treated as warnings. The validation message is written both to the standard error stream, and (where possible) as a comment in the result document itself.

This option does not by itself cause result documents to be validated; that happens only as a consequence of the type or validation attribute on an xsl:result-document instruction. The only effect of the option is to determine what happens when validation fails.

Validating result documents can be very useful while debugging a stylesheet, because it provides instant feedback when the output is incorrect. However, it can sometimes be frustrating during development when you know that parts of the code have not yet been written. The option outval:recover is designed to give you the best of both worlds: it tells you that the output is wrong, but still enables you to see the complete result document that your code is producing.

-p[:(on|off)]

Use the PTreeURIResolver. This option is available in Saxon-PE and Saxon-EE only. It cannot be used in conjunction with the -r option, and it automatically switches on the -u and -sa options. The effect is twofold. Firstly, Saxon-specific file extensions are recognized in URIs (including the URI of the source document on the command line). Currently the only Saxon-specific file extension is .ptree, which indicates that the source document is supplied in the form of a Saxon PTree. This is a binary representation of an XML document, designed for speed of loading. Secondly, Saxon-specific query parameters are recognized in a URI. Currently the only query parameter that is recognized is val. This may take the values strict, lax, or strip. For example, source.xml?val=strict loads a document with strict schema validation.

-quit:(on|off)

With the default setting, on, the command will quit the Java VM and return an exit code if a failure occurs. This is useful when running from an operating system shell. With the setting quit:off the command instead throws a RunTimeException, which is more useful when the command is invoked from another Java application such as Ant.

-r:classname

Use the specified URIResolver to process all URIs. The URIResolver is a user-defined class, that extends the net.sf.saxon.URIResolver class, whose function is to take a URI supplied as a string, and return a SAX InputSource. It is invoked to process URIs used in the document() function, in the xsl:include and xsl:import elements, and (if -u is also specified) to process the URIs of the source file and stylesheet file provided on the command line.

-relocate:(on|off)

Used with -export to produce an export package which can be deployed to a different location, with a different base URI. If on, then static-base-uri() represents the deployed location of the package, rather than its compile time location. The default is off.

The practical effect of this is that if relocate:off (the default) is specified, then the generated SEF file will contain references to the stylesheet's original location as its static base URI, and run-time operations that are relative to this base URI (for example, calling doc() with a relative URI) will retrieve resources exactly as if the stylesheet had not been exported. By contrast, if relocate:on is specified, the SEF file will contain no reference to the original location of the source stylesheet, and operations such as doc() will be relative to the location from which the SEF file was loaded.

-repeat:integer

Performs the transformation N times, where N is the specified integer. This option is useful for performance measurement, since timings for the first transformation are often dominated by Java warm-up time.

-s:filename

Identifies the source file or directory. Mandatory unless the -it option is used. The source file is parsed to create a tree, and the document node of this tree acts as the initial context item for the transformation. If the name identifies a directory, all the files in the directory will be processed individually. In this case the -o option is mandatory, and must also identify a directory, to contain the corresponding output files. A directory must be specified as a filename, not as a URL. The source-document can be specified as "-" to take the source from standard input, in which case the base URI is taken from that of the current directory. For backwards compatibility the source filename can also be specified immediately before the stylesheet filename, without the -s flag, provided that the -it option is not present.

-sa

Invoke a schema-aware transformation. Requires Saxon-EE to be installed. This option is not needed if either (a) another option implying schema-awareness is present (for example -val:strict) or (b) the stylesheet contains an xsl:import-schema declaration.

-scmin:filename

Loads a precompiled schema component model from the given file. The file should be generated in a previous run of com.saxonica.Validate using the -export option. When this option is used, the -xsd option should not be present. Schemas loaded from an SCM file are assumed to be valid, without checking.

This option is retained for compatibility. From Saxon 9.7, SCM files can also be supplied in the -xsd option.

-strip:(all|none|ignorable)

Specifies what whitespace is to be stripped from source documents (applies both to the principal source document and to any documents loaded for example using the document() function). The default is ignorable: all ignorable whitespace is stripped. Whitespace text nodes are ignorable if they appear in elements defined in the DTD or schema as having element-only content. Specifying all strips all whitespace text nodes from source documents before any further processing, regardless of any xsl:strip-space declarations in the stylesheet, or any xml:space attributes in the source document. Specifying ignorable strips all ignorable whitespace text nodes from source documents before any further processing, regardless of any xsl:strip-space declarations in the stylesheet, or any xml:space attributes in the source document. Specifying none suppresses all whitespace stripping unless requested elsewhere, for example using xsl:strip-space.

-t

Display version and timing information to the standard error output. The output also traces the files that are read and written, and extension modules that are loaded.

-T[:classname]

Display stylesheet tracing information. This traces execution of each instruction in the stylesheet, so the output can be quite voluminous. Also switches line numbering on for the source document. If a classname is specified, it is a user-defined class, which must implement TraceListener. If the classname is omitted, a system-supplied trace listener is used. For performance profiling, set classname to net.sf.saxon.trace.TimingTraceListener. This creates an output file giving timings for each instruction executed. This output file can subsequently be analyzed to give an execution time profile for the stylesheet. See Performance Analysis.

-target:(EE|PE|HE|JS|JS2)

Relevant only when -export is specified, identifies the target platform on which the exported stylesheet is to run. When exporting for Saxon-JS, the value "JS" or "JS2" must be specified, because this adds information to the SEF file that is required by Saxon-JS. Specifying "JS" means the SEF is produced in XML format, for use with Saxon-JS 1.x; while "JS2" means the SEF is in JSON format for use with Saxon-JS 2.x. In principle, specifying "HE" or "PE" will inhibit optimizations that generate code which Saxon-HE/Saxon-PE cannot execute; however, this is not fully tested.

-TB:filename

Monitors generation of hot-spot bytecode and produces an XML report on the given filename giving, for each expression that was a candidate for bytecode generation and that was actually executed, data about the number of times and speed of execution in the interpreter, the number of times and speed of execution in compiled form, and the cost of compilation. Note that if an expression A contains an expression B and both are candidates for bytecode generation, then the statistics for B relate only to the time before A was compiled in its own right.

-threads:N

Used only when the -s option specifies a directory. Controls the number of threads used to process the files in the directory. Each transformation runs in a single thread.

-TJ

Switches on tracing of the binding of calls to external Java methods. This is useful when analyzing why Saxon fails to find a Java method to match an extension function call in the stylesheet, or why it chooses one method over another when several are available.

-Tlevel:none|low|normal|high

Controls the level of detail of the tracing produced by the -T option. The values are:

• none effectively switches tracing off.
• low traces function and template calls.
• normal traces execution of instructions.
• high traces execution of finer-grained expressions.

-TP:filename

This is equivalent to setting -T:net.sf.saxon.trace.TimedTraceListener and -traceout:filename; that is, it causes trace profile information to be set to the specified file. This output file can subsequently be analyzed to give an execution time profile for the stylesheet. See Performance Analysis.

-traceout:filename

Indicates that the output of the trace() function should be directed to a specified file. Alternatively, specify #out to direct the output to System.out, #err to send it to System.err (the default), or #null to have it discarded. This option is ignored when a trace listener is in use: in that case, trace() output goes to the registered trace listener.

-tree:(linked|tiny|tinyc)

Selects the implementation of the internal tree model: tiny selects the "tiny tree" model (the default), linked selects the linked tree model, tinyc selects the "condensed tiny tree" model. See Choosing a tree model.

-u

Indicates that the names of the source document and the stylesheet document are URLs; otherwise they are taken as filenames, unless they start with http:, https:, file: or classpath:, in which case they are taken as URLs.

-val[:(strict|lax)]

Requests schema-based validation of the source file and of any files read using the document() or similar functions. Validation is available only with Saxon-EE, and this flag automatically switches on the -sa option. Specify -val or -val:strict to request strict validation, or -val:lax for lax validation.

-warnings:(silent|recover|fatal)

Indicates the policy for handling recoverable errors in the stylesheet: silent means recover silently, recover means recover after writing a warning message to the system error output, fatal means signal the error and do not attempt recovery. (Note, this does not currently apply to all errors that the XSLT recommendation describes as recoverable). The default is recover.

-x:classname

Use the specified SAX parser for the source file and any files loaded using the document() function. The parser must be the fully-qualified class name of a Java class that implements the org.xml.sax.XMLReader or javax.xml.parsers.SAXParserFactory interface, and it must be instantiable using a zero-argument public constructor. One use of this option is to select an HTML parser such as John Cowan's TagSoup rather than an XML parser. In this case, the TagSoup JAR file must be on the classpath, and the class name to use is org.ccil.cowan.tagsoup.Parser. Another common use is to specify org.apache.xml.resolver.tools.ResolvingXMLReader. This parser is provided by the Apache commons project, and it customizes the default parser by using an EntityResolver that resolves external entity references (note the reference to an external DTD in a DOCTYPE declaration) by reference to an OASIS catalog file. This can be used to avoid repeated calls to external web servers (such as the W3C server) for commonly used DTDs such as the XHTML DTD. The option to supply a SAXParserFactory was introduced in 9.6 for the benefit of the Aalto parser, whose XMLReader implementation cannot be directly instantiated; this parser can therefore be requested by nominating its factory class, com.fasterxml.aalto.sax.SAXParserImpl.

-xi:(on|off)

Apply XInclude processing to all source XML documents (but not to schema and stylesheet modules). This currently only works when documents are parsed using the Xerces parser, which is the default on the Java platform (but not on .NET).

-xmlversion:(1.0|1.1)

If -xmlversion:1.1 is specified, allows XML 1.1 and XML Namespaces 1.1 constructs. This option must be set if source documents using XML 1.1 are to be read, or if result documents are to be serialized as XML 1.1. This option also enables use of XML 1.1 constructs within the stylesheet itself.

-xsd:file1;file2;file3...

Loads additional schema documents. The declarations in these schema documents are available when validating source documents (or for use by the validate{} expression). This option may also be used to supply the locations of schema documents that are imported into the stylesheet, in the case where the xsl:import-schema declaration gives the target namespace of the schema but not its location.

-xsdversion:(1.0|1.1)

If -xsdversion:1.1 is specified (the default), allows schema documents using XML Schema 1.1 to be read, and XML Schema 1.1 constructs such as assertions.

-xsiloc:(on|off)

If set to on (the default) the schema processor attempts to load any schema documents referenced in xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes in the instance document, unless a schema for the specified namespace (or non-namespace) is already available. If set to off, these attributes are ignored.

-xsl:filename

Specifies the file containing the principal stylesheet module. Mandatory unless the -a option is used. The value "-" identifies the standard input stream, in which case the static base URI is taken from that of the current directory. If the -u option is specified then the value must be a URI rather than a filename.

The selected file can contain either XSLT source code, or a compiled version of the stylesheet (a SEF file) as produced using the -export option.

-y:classname

Use the specified SAX parser for stylesheet files, including any loaded using xsl:include or xsl:import. The supplied classname must be the fully-qualified class name of a Java class that implements the org.xml.sax.XMLReader or javax.xml.parsers.SAXParserFactory interface, and it must be instantiable using a zero-argument public constructor.

--feature:value

Set a feature defined in the Configuration interface. The names of features are defined in the Javadoc for class Feature (alternatively see Configuration Features): the value used here is the part of the name after the last "/", for example --allow-external-functions:off. Only features accepting a string or boolean may be set; for booleans the values true/false, on/off, yes/no, and 1/0 are recognized.

-?

Display command syntax.