This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/daffodil-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 4cc76fd Publishing from 8e9fb6a1faa804d992b2c543fce3c09c293c48d5
4cc76fd is described below
commit 4cc76fdaaefa9cfc5190d09210076c51e7416b13
Author: Steve Lawrence <[email protected]>
AuthorDate: Wed May 19 12:03:26 2021 +0000
Publishing from 8e9fb6a1faa804d992b2c543fce3c09c293c48d5
---
content/cli/index.html | 264 ++++++++++++++++++++++++++++++-------------------
1 file changed, 162 insertions(+), 102 deletions(-)
diff --git a/content/cli/index.html b/content/cli/index.html
index c697ded..8accff2 100644
--- a/content/cli/index.html
+++ b/content/cli/index.html
@@ -86,32 +86,47 @@
<!--
-->
+<!-- markdownlint-disable line-length -->
+<!-- markdownlint-disable no-duplicate-heading -->
-<p>The binary Daffodil <a href="/releases">releases</a> contain a <code
class="language-plaintext highlighter-rouge">/bin</code> directory that
contains two scripts: <code class="language-plaintext
highlighter-rouge">daffodil.bat</code> for Windows and <code
class="language-plaintext highlighter-rouge">daffodil</code> for Linux. These
files must be executed on the command line. The general usage is:</p>
+<p>The binary Daffodil <a href="/releases">releases</a> contain a <code
class="language-plaintext highlighter-rouge">/bin</code> directory with two
scripts: <code class="language-plaintext highlighter-rouge">daffodil.bat</code>
for Windows and <code class="language-plaintext
highlighter-rouge">daffodil</code> for Linux. These files must be executed on
the command line. The general usage is:</p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil [GLOBAL_OPTIONS] <subcommand>
[SUBCOMMAND_OPTIONS]
</code></pre></div></div>
-<p>The available subcommands are: <a href="#parse-subcommand">parse</a>, <a
href="#unparse-subcommand">unparse</a>, <a
href="#save-parser-subcommand">save-parser</a>, <a
href="#test-subcommand">test</a>, and <a
href="#performance-subcommand">performance</a>.</p>
+<p>The available subcommands are:</p>
+
+<ul>
+ <li><a href="#parse-subcommand">parse</a></li>
+ <li><a href="#unparse-subcommand">unparse</a></li>
+ <li><a href="#save-parser-subcommand">save-parser</a></li>
+ <li><a href="#test-subcommand">test</a></li>
+ <li><a href="#performance-subcommand">performance</a></li>
+ <li><a href="#generate-subcommand">generate</a></li>
+</ul>
<h3 id="environment-variables">Environment Variables</h3>
-<p>Setting environment variables may be necessary to allow for
importing/includes to work and when running TDML files.</p>
+<p>Setting environment variables may be necessary to allow imports, includes,
and running TDML files to work.</p>
<dl>
<dt><code class="language-plaintext
highlighter-rouge">DAFFODIL_CLASSPATH</code></dt>
<dd>
- <p>The Daffodil CLI will look on the classpath for includes and imports,
jars containing schemas, and some TDML files. To define additional directories
specific to Daffodil to look for files, set the <code class="language-plaintext
highlighter-rouge">DAFFODIL_CLASSPATH</code> environment variable, for
example:</p>
+ <p>Daffodil will search its classpath for includes and imports, jars
containing schemas, and some TDML files. To tell Daffodil to look for files in
additional directories, set the <code class="language-plaintext
highlighter-rouge">DAFFODIL_CLASSPATH</code> environment variable, for
example:</p>
- <div class="language-plaintext highlighter-rouge"><div
class="highlight"><pre class="highlight"><code>$ export
DAFFODIL_CLASSPATH="/path/to/imports/:/path/to/includes/"
+ <div class="language-plaintext highlighter-rouge"><div
class="highlight"><pre class="highlight"><code>export
DAFFODIL_CLASSPATH="/path/to/imports/:/path/to/includes/"
</code></pre></div> </div>
- <p>In addition to defining directories to search for imports and includes,
you can add a CatalogManager.properties file to the <code
class="language-plaintext highlighter-rouge">DAFFODIL_CLASSPATH</code> to
direct Daffodil to a relative path location of a user XML Catalog.</p>
+ <p>In addition to defining directories to search for imports and includes,
you can add a CatalogManager.properties file to <code class="language-plaintext
highlighter-rouge">DAFFODIL_CLASSPATH</code> to direct Daffodil to a relative
path location of a user XML Catalog.</p>
</dd>
<dt><code class="language-plaintext
highlighter-rouge">DAFFODIL_JAVA_OPTS</code></dt>
<dd>
<p>If you need to specify java options specific to Daffodil, you can set
the <code class="language-plaintext
highlighter-rouge">DAFFODIL_JAVA_OPTS</code> environment variable. If not
specified, the <code class="language-plaintext
highlighter-rouge">JAVA_OPTS</code> environment variable will be used. If that
is not specified, reasonable defaults for Daffodil will be used.</p>
</dd>
+ <dt><code class="language-plaintext highlighter-rouge">CC</code></dt>
+ <dd>
+ <p>If you need to specify which C compiler should be called when running
TDML files with the <code class="language-plaintext
highlighter-rouge">test</code> subcommand using Daffodil's runtime2 backend,
you can set the <code class="language-plaintext highlighter-rouge">CC</code>
environment variable. If that environment variable is not specified, then
Daffodil will call the first C compiler driver command it finds within the
<code class="language-plaintext highlighter-rouge">PATH</cod [...]
+ </dd>
</dl>
<h3 id="global-options">Global Options</h3>
@@ -121,7 +136,7 @@
<dd>
<p>Enable the interactive debugger. See the <a
href="/debugger">Interactive Debugger</a> documentation for more
information.</p>
- <p>The optional <code class="language-plaintext
highlighter-rouge">FILE</code> argument contains a list of debugger commands
that are provided to the debugger as they were typed by the user.</p>
+ <p>The optional <code class="language-plaintext
highlighter-rouge">FILE</code> argument contains a list of debugger commands
that are provided to the debugger as if they were typed by the user.</p>
<p>This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--trace</code> option.</p>
</dd>
@@ -133,15 +148,15 @@
</dd>
<dt><code class="language-plaintext highlighter-rouge">-v,
--verbose</code></dt>
<dd>
- <p>Enable verbose mode and increment verbosity level. Each additional v
provides a new level of information.</p>
+ <p>Enable verbose mode and increment verbosity level. Each additional
<code class="language-plaintext highlighter-rouge">-v</code> provides a new
level of information.</p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">--version</code></dt>
<dd>
- <p>Display the version of Daffodil.</p>
+ <p>Display Daffodil's version.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">--help</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-h, --help</code></dt>
<dd>
- <p>Display help message.</p>
+ <p>Display a help message.</p>
</dd>
</dl>
@@ -151,9 +166,10 @@
<h4 id="usage">Usage</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil parse (-s <schema> [-r
[{<namespace>}]<root>] [-p <path>] | -P <parser>)
- [-D[{namespace}]<variable>=<value>...]
[-T<tunable>=<value>] [-o <output>]
- [-V [mode]] [-c <file>] [-I <infoset_type>] [infile]
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil parse (-s <schema> [-r <root>] |
-P <parser>)
+ [-c <file>] [-D<variable>=<value>...] [-I
<infoset_type>]
+ [-o <output>] [--stream]
[-T<tunable>=<value>...] [-V <mode>]
+ [infile]
</code></pre></div></div>
<h4 id="options">Options</h4>
@@ -163,9 +179,9 @@
<dd>
<p>XML file containing configuration items, such as external variables or
Daffodil tunables. See <a href="/configuration">Configuration</a> for details
on the file format.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-D
[{NAMESPACE}]VARIABLE=VALUE</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-D
VARIABLE=VALUE</code></dt>
<dd>
- <p>Variables to be used when parsing. <code class="language-plaintext
highlighter-rouge">VARIABLE</code> can be prefixed with <code
class="language-plaintext highlighter-rouge">{NAMESPACE}</code> to define which
namespace the variable belongs in, for example:</p>
+ <p>Variables to be used when parsing. A namespace may be specified by
prefixing <code class="language-plaintext highlighter-rouge">VARIABLE</code>
with <code class="language-plaintext highlighter-rouge">{NAMESPACE}</code>, for
example:</p>
<p><code class="language-plaintext
highlighter-rouge">-D{http://example.com}var1=var</code></p>
</dd>
@@ -175,19 +191,15 @@
</dd>
<dt><code class="language-plaintext highlighter-rouge">-o, --output
FILE</code></dt>
<dd>
- <p>Write output to a given <code class="language-plaintext
highlighter-rouge">FILE</code>. If the option is not given or <code
class="language-plaintext highlighter-rouge">FILE</code> is -, output is
written to standard out.</p>
+ <p>Output file to write the infoset to. If the option is not given or
<code class="language-plaintext highlighter-rouge">FILE</code> is -, the
infoset is written to standard output.</p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">-P, --parser
FILE</code></dt>
<dd>
- <p>Use a previously saved parser, created using the save-parser
subcommand. This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--schema</code> option or with the <code
class="language-plaintext highlighter-rouge">--validate</code> option set to
<code class="language-plaintext highlighter-rouge">on</code>.</p>
+ <p>Use a previously saved parser inside <code class="language-plaintext
highlighter-rouge">FILE</code>, created using the <code
class="language-plaintext highlighter-rouge">save-parser</code> subcommand.
This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--schema</code> option or with the <code
class="language-plaintext highlighter-rouge">--validate</code> option set to
<code class="language-plaintext highlighter-rouge">on</code>.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-p, --path
PATH</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-r, --root
ROOT</code></dt>
<dd>
- <p>The path to the node from the root element to create the parser
from.</p>
- </dd>
- <dt><code class="language-plaintext highlighter-rouge">-r, --root
[{NAMESPACE}]ROOT</code></dt>
- <dd>
- <p>The root element of the DFDL schema to use. This must be one of the
top-level elements of the schema defined with <code class="language-plaintext
highlighter-rouge">--schema</code>. This requires the <code
class="language-plaintext highlighter-rouge">--schema</code> option to be
defined. If not supplied, the first element of the schema defined with <code
class="language-plaintext highlighter-rouge">--schema</code> is used. A
namespace may be specified by prefixing <code class="lan [...]
+ <p>The root element to use. This must be one of the top-level elements of
the DFDL schema defined with <code class="language-plaintext
highlighter-rouge">--schema</code>. This requires the <code
class="language-plaintext highlighter-rouge">--schema</code> option to be
defined. Defaults to the schema's first top-level element if not provided. A
namespace may be specified by prefixing <code class="language-plaintext
highlighter-rouge">ROOT</code> with <code class="language-plaintext hi [...]
</dd>
<dt><code class="language-plaintext highlighter-rouge">-s, --schema
FILE</code></dt>
<dd>
@@ -197,27 +209,31 @@
<dd>
<p>Rather than throwing an error when left over data exists after a parse,
repeat the parse with the remaining data. Parsing repeats until end of data is
reached, an error occurs, or no data is consumed. Output infosets are separated
by a NUL character.</p>
</dd>
+ <dt><code class="language-plaintext highlighter-rouge">--nostream</code></dt>
+ <dd>
+ <p>Stop after the first parse, throwing an error if left over data exists.
This is the default behavior.</p>
+ </dd>
<dt><code class="language-plaintext highlighter-rouge">-T
TUNABLE=VALUE</code></dt>
<dd>
- <p>Modify Daffodil configuration options to change parsing behavior. See
<a href="/configuration">Configuration</a> for the list of tunable
parameters.</p>
+ <p>Tunable configuration options to change Daffodil's behavior. See <a
href="/configuration">Configuration</a> for the list of tunable parameters.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-V, --validate
[MODE]</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-V, --validate
MODE</code></dt>
<dd>
- <p>The validation mode. <code class="language-plaintext
highlighter-rouge">MODE</code> must be one of <code class="language-plaintext
highlighter-rouge">on</code>, <code class="language-plaintext
highlighter-rouge">limited</code> or <code class="language-plaintext
highlighter-rouge">off</code>. If <code class="language-plaintext
highlighter-rouge">MODE</code> is not provided, defaults to <code
class="language-plaintext highlighter-rouge">on</code>. If <code
class="language-plaintext [...]
+ <p>The validation mode. <code class="language-plaintext
highlighter-rouge">MODE</code> must be one of <code class="language-plaintext
highlighter-rouge">on</code>, <code class="language-plaintext
highlighter-rouge">limited</code>, <code class="language-plaintext
highlighter-rouge">off</code>, or a validator plugin name. Defaults to <code
class="language-plaintext highlighter-rouge">off</code> if not provided.
Validator plugins are provided by SPI and are referenced here using the <co
[...]
</dd>
<dt><code class="language-plaintext highlighter-rouge">[INFILE]</code></dt>
<dd>
- <p>Input file to parse. If not specified, or is a value of -, reads from
standard in. If supplied, this must be the last option on the command line.</p>
+ <p>Input file to parse. If not specified, or is a value of -, reads from
standard input. If supplied, the input file must be the last option on the
command line.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">--help</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-h, --help</code></dt>
<dd>
- <p>Display help message.</p>
+ <p>Display a help message.</p>
</dd>
</dl>
<h4 id="example">Example</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>$ daffodil parse -s csv.dfdl.xsd test_file.csv
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil parse -s csv.dfdl.xsd test_file.csv
</code></pre></div></div>
<h3 id="unparse-subcommand">Unparse Subcommand</h3>
@@ -226,9 +242,10 @@
<h4 id="usage-1">Usage</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil unparse (-s <schema> [-r
[{<namespace>}]<root>] [-p <path>] | -P <parser>)
- [-D[{<namespace>}]<variable>=<value>...]
[-T<tunable>=<value>] [-o <output>]
- [-V [mode]] [-c <file>] [-I <infoset_type>]
[infile]
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil unparse (-s <schema> [-r <root>] |
-P <parser>)
+ [-c <file>] [-D<variable>=<value>...] [-I
<infoset_type>]
+ [-o <output>] [--stream]
[-T<tunable>=<value>...] [-V <mode>]
+ [infile]
</code></pre></div></div>
<h4 id="options-1">Options</h4>
@@ -238,9 +255,9 @@
<dd>
<p>XML file containing configuration items, such as external variables or
Daffodil tunables. See <a href="/configuration">Configuration</a> for details
on the file format.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-D
[{NAMESPACE}]VARIABLE=VALUE</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-D
VARIABLE=VALUE</code></dt>
<dd>
- <p>Variables to be used when unparsing. <code class="language-plaintext
highlighter-rouge">VARIABLE</code> can be prefixed with <code
class="language-plaintext highlighter-rouge">{NAMESPACE}</code> to define which
namespace the variable belongs in, for example:</p>
+ <p>Variables to be used when unparsing. A namespace may be specified by
prefixing <code class="language-plaintext highlighter-rouge">VARIABLE</code>
with <code class="language-plaintext highlighter-rouge">{NAMESPACE}</code>, for
example:</p>
<p><code class="language-plaintext
highlighter-rouge">-D{http://example.com}var1=var</code></p>
</dd>
@@ -250,19 +267,15 @@
</dd>
<dt><code class="language-plaintext highlighter-rouge">-o, --output
FILE</code></dt>
<dd>
- <p>Write output to a give <code class="language-plaintext
highlighter-rouge">FILE</code>. If the option is not given or <code
class="language-plaintext highlighter-rouge">FILE</code> is -, output is
written to standard out.</p>
+ <p>Output file to write the data to. If the option is not given or <code
class="language-plaintext highlighter-rouge">FILE</code> is -, the data is
written to standard output.</p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">-P, --parser
FILE</code></dt>
<dd>
- <p>Use a previously saved parser, created using the save-parser
subcommand. This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--schema</code> option or with the <code
class="language-plaintext highlighter-rouge">--validate</code> option set to
<code class="language-plaintext highlighter-rouge">on</code>.</p>
- </dd>
- <dt><code class="language-plaintext highlighter-rouge">-p, --path
PATH</code></dt>
- <dd>
- <p>The path to the node from the root element to create the parser
from.</p>
+ <p>Use a previously saved parser inside <code class="language-plaintext
highlighter-rouge">FILE</code>, created using the <code
class="language-plaintext highlighter-rouge">save-parser</code> subcommand.
This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--schema</code> option or with the <code
class="language-plaintext highlighter-rouge">--validate</code> option set to
<code class="language-plaintext highlighter-rouge">on</code>.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-r, --root
[{NAMESPACE}]ROOT</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-r, --root
ROOT</code></dt>
<dd>
- <p>The root element of the DFDL schema to use. This must be one of the
top-level elements of the schema defined with <code class="language-plaintext
highlighter-rouge">--schema</code>. This requires the <code
class="language-plaintext highlighter-rouge">--schema</code> option to be
defined. If not supplied, the first element of the schema defined with <code
class="language-plaintext highlighter-rouge">--schema</code> is used. A
namespace may be specified by prefixing the <code class= [...]
+ <p>The root element to use. This must be one of the top-level elements of
the DFDL schema defined with <code class="language-plaintext
highlighter-rouge">--schema</code>. This requires the <code
class="language-plaintext highlighter-rouge">--schema</code> option to be
defined. Defaults to the schema's first top-level element if not provided. A
namespace may be specified by prefixing <code class="language-plaintext
highlighter-rouge">ROOT</code> with <code class="language-plaintext hi [...]
</dd>
<dt><code class="language-plaintext highlighter-rouge">-s, --schema
FILE</code></dt>
<dd>
@@ -272,25 +285,31 @@
<dd>
<p>Split the input data at NUL characters and unparse each chunk
separately to the same output file.</p>
</dd>
+ <dt><code class="language-plaintext highlighter-rouge">--nostream</code></dt>
+ <dd>
+ <p>Treat the entire input data as one infoset. This is the default
behavior.</p>
+ </dd>
<dt><code class="language-plaintext highlighter-rouge">-T
TUNABLE=VALUE</code></dt>
<dd>
- <p>Modify Daffodil configuration options to change parsing behavior. See
<a href="/configuration">Configuration</a> for the list of tunable
parameters.</p>
+ <p>Tunable configuration options to change Daffodil's behavior. See <a
href="/configuration">Configuration</a> for the list of tunable parameters.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-V, --validate
[MODE]</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-V, --validate
MODE</code></dt>
<dd>
- <p>The validation mode. <code class="language-plaintext
highlighter-rouge">MODE</code> must be one of <code class="language-plaintext
highlighter-rouge">on</code>, <code class="language-plaintext
highlighter-rouge">limited</code> or <code class="language-plaintext
highlighter-rouge">off</code>. If <code class="language-plaintext
highlighter-rouge">MODE</code> is not provided, defaults to <code
class="language-plaintext highlighter-rouge">on</code>. If <code
class="language-plaintext [...]
+ <p>The validation mode. <code class="language-plaintext
highlighter-rouge">MODE</code> must be one of <code class="language-plaintext
highlighter-rouge">on</code>, <code class="language-plaintext
highlighter-rouge">limited</code>, <code class="language-plaintext
highlighter-rouge">off</code>, or a validator plugin name. Defaults to <code
class="language-plaintext highlighter-rouge">off</code> if not provided.
Validator plugins are provided by SPI and are referenced here using the <co
[...]
</dd>
<dt><code class="language-plaintext highlighter-rouge">[INFILE]</code></dt>
<dd>
- <p>Input file to unparse. If not specified, or is a value of -, reads from
standard in. If supplied, this must be the last option on the command line.</p>
+ <p>Input file to unparse. If not specified, or is a value of -, reads from
standard input. If supplied, the input file must be the last option on the
command line.</p>
+ </dd>
+ <dt><code class="language-plaintext highlighter-rouge">-h, --help</code></dt>
+ <dd>
+ <p>Display a help message.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">--help</code></dt>
- <dd>Display help message.</dd>
</dl>
<h4 id="example-1">Example</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>$ daffodil unparse -s csv.dfdl.xsd test_file.infoset
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil unparse -s csv.dfdl.xsd test_file.infoset
</code></pre></div></div>
<h3 id="save-parser-subcommand">Save Parser Subcommand</h3>
@@ -299,7 +318,9 @@
<h4 id="usage-2">Usage</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil save-parser -s <schema> [-r
[{namespace}]<root>] [-p <path>] [outfile]
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil save-parser -s <schema> [-r <root>]
+ [-c <file>] [-D<variable>=<value>...]
[-T<tunable>=<value>...]
+ [outfile]
</code></pre></div></div>
<h4 id="options-2">Options</h4>
@@ -309,19 +330,15 @@
<dd>
<p>XML file containing configuration items, such as external variables or
Daffodil tunables. See <a href="/configuration">Configuration</a> for details
on the file format.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-D
[{NAMESPACE}]VARIABLE=VALUE</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-D
VARIABLE=VALUE</code></dt>
<dd>
- <p>Variables to be used when parsing. <code class="language-plaintext
highlighter-rouge">VARIABLE</code> can be prefixed with <code
class="language-plaintext highlighter-rouge">{NAMESPACE}</code> to define which
namespace the variable belongs in, for example:</p>
+ <p>Variables to be used when parsing or unparsing. A namespace may be
specified by prefixing <code class="language-plaintext
highlighter-rouge">VARIABLE</code> with <code class="language-plaintext
highlighter-rouge">{NAMESPACE}</code>, for example:</p>
<p><code class="language-plaintext
highlighter-rouge">-D{http://example.com}var1=var</code></p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-p, --path
PATH</code></dt>
- <dd>
- <p>The path to the node from the root element to create the parser
from.</p>
- </dd>
- <dt><code class="language-plaintext highlighter-rouge">-r, --root
[{NAMESPACE}]ROOT</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-r, --root
ROOT</code></dt>
<dd>
- <p>The root element of the DFDL schema to use. This must be one of the
top-level elements of the schema defined with <code class="language-plaintext
highlighter-rouge">--schema</code>. This requires the <code
class="language-plaintext highlighter-rouge">--schema</code> option to be
defined. If not supplied, the first element of the schema defined with <code
class="language-plaintext highlighter-rouge">--schema</code> is used. A
namespace may be specified by prefixing <code class="lan [...]
+ <p>The root element to use. This must be one of the top-level elements of
the DFDL schema defined with <code class="language-plaintext
highlighter-rouge">--schema</code>. This requires the <code
class="language-plaintext highlighter-rouge">--schema</code> option to be
defined. Defaults to the schema's first top-level element if not provided. A
namespace may be specified by prefixing <code class="language-plaintext
highlighter-rouge">ROOT</code> with <code class="language-plaintext hi [...]
</dd>
<dt><code class="language-plaintext highlighter-rouge">-s, --schema
FILE</code></dt>
<dd>
@@ -329,25 +346,21 @@
</dd>
<dt><code class="language-plaintext highlighter-rouge">-T
TUNABLE=VALUE</code></dt>
<dd>
- <p>Modify Daffodil configuration options to change parsing behavior. See
<a href="/configuration">Configuration</a> for the list of tunable
parameters.</p>
- </dd>
- <dt><code class="language-plaintext highlighter-rouge">-V, --validate
MODE</code></dt>
- <dd>
- <p>The validation mode. <code class="language-plaintext
highlighter-rouge">MODE</code> must be either <code class="language-plaintext
highlighter-rouge">limited</code> or <code class="language-plaintext
highlighter-rouge">off</code>. <code class="language-plaintext
highlighter-rouge">MODE</code> is required. If <code class="language-plaintext
highlighter-rouge">--validate</code> is not present, defaults to <code
class="language-plaintext highlighter-rouge">off</code>. <code class="la [...]
+ <p>Tunable configuration options to change Daffodil's behavior. See <a
href="/configuration">Configuration</a> for the list of tunable parameters.</p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">[OUTFILE]</code></dt>
<dd>
- <p>Write the parser to a give file. If the option is not given or is -,
output is written to standard out. If supplied, this must be the last option on
the command line.</p>
+ <p>Output file to save the parser to. If the option is not given or is -,
the parser is saved to standard output. If supplied, the output file must be
the last option on the command line.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">--help</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-h, --help</code></dt>
<dd>
- <p>Display help message.</p>
+ <p>Display a help message.</p>
</dd>
</dl>
<h4 id="example-2">Example</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>$ daffodil save-parser -s csv.dfdl.xsd csv_parser.xml
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil save-parser -s csv.dfdl.xsd csv_parser.xml
</code></pre></div></div>
<h3 id="test-subcommand">Test Subcommand</h3>
@@ -356,7 +369,7 @@
<h4 id="usage-3">Usage</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil test [-l] [-r] [-i] <tdmlfile>
[testname...]
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil test [-l] [-r] [-i] <tdmlfile>
[testnames...]
</code></pre></div></div>
<h4 id="options-3">Options</h4>
@@ -364,44 +377,46 @@
<dl>
<dt><code class="language-plaintext highlighter-rouge">-i, --info</code></dt>
<dd>
- <p>Increment test result information output level, one level for each
occurrence of -i.</p>
+ <p>Increment test result information output level, one level for each
-i.</p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">-l, --list</code></dt>
<dd>
- <p>Show names and descriptions in a TDML file instead of running them.</p>
+ <p>Show names and descriptions of test cases in a TDML file instead of
running them.</p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">-r,
--regex</code></dt>
<dd>
- <p>Treat <code class="language-plaintext
highlighter-rouge">TESTNAME</code>s as regular expressions.</p>
+ <p>Treat <code class="language-plaintext
highlighter-rouge">TESTNAMES...</code> as regular expressions.</p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">TDMLFILE</code></dt>
<dd>
<p>Test Data Markup Language (TDML) file.</p>
</dd>
- <dt><code class="language-plaintext
highlighter-rouge">[TESTNAME...]</code></dt>
+ <dt><code class="language-plaintext
highlighter-rouge">[TESTNAMES...]</code></dt>
<dd>
- <p>Name of one or more test case in the TDML file. If not given, all tests
in <code class="language-plaintext highlighter-rouge">TDMLFILE</code> are
run.</p>
+ <p>Name(s) of test cases in the TDML file. If not given, all tests in
<code class="language-plaintext highlighter-rouge">TDMLFILE</code> are run.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">--help</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-h, --help</code></dt>
<dd>
- <p>Display help message.</p>
+ <p>Display a help message.</p>
</dd>
</dl>
<h4 id="example-3">Example</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>$ daffodil test csv.tdml
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil test csv.tdml
</code></pre></div></div>
<h3 id="performance-subcommand">Performance Subcommand</h3>
-<p>Run a performance test (parse or unparse), using either a DFDL schema or a
saved parser</p>
+<p>Run a performance test (parse or unparse), using either a DFDL schema or a
saved parser.</p>
<h4 id="usage-4">Usage</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil performance (-s <schema> [-r
[{namespace}]<root>] [-p <path>] | -P <parser)
- [-u] [-V[mode]] [-N <number>] [-t <threads>]
- [-D[{namespace}]<variable>=<value>] [-I
<infoset_type>] <infile>
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil performance (-s <schema> [-r
<root>] | -P <parser>)
+ [-c <file>] [-D<variable>=<value>...]
[-I <infoset_type>]
+ [-N <number>] [-t <threads>]
[-T<tunable>=<value>...]
+ [-u] [-V <mode>]
+ <infile>
</code></pre></div></div>
<h4 id="options-4">Options</h4>
@@ -411,31 +426,27 @@
<dd>
<p>XML file containing configuration items, such as external variables or
Daffodil tunables. See <a href="/configuration">Configuration</a> for details
on the file format.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-D
[{NAMESPACE}]VARIABLE=VALUE</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-D
VARIABLE=VALUE</code></dt>
<dd>
- <p>Variables to be used when parsing. <code class="language-plaintext
highlighter-rouge">VARIABLE</code> can be prefixed with <code
class="language-plaintext highlighter-rouge">{NAMESPACE}</code> to define which
namespace the variable belongs in, for example:</p>
+ <p>Variables to be used when parsing or unparsing. <code
class="language-plaintext highlighter-rouge">VARIABLE</code> can be prefixed
with <code class="language-plaintext highlighter-rouge">{NAMESPACE}</code> to
define which namespace the variable belongs in, for example:</p>
<p><code class="language-plaintext
highlighter-rouge">-D{http://example.com}var1=var</code></p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">-I, --infoset-type
TYPE</code></dt>
<dd>
- <p>Infoset type to parse/unparse. <code class="language-plaintext
highlighter-rouge">TYPE</code> must be one of <code class="language-plaintext
highlighter-rouge">xml</code>, <code class="language-plaintext
highlighter-rouge">scala-xml</code>, <code class="language-plaintext
highlighter-rouge">json</code>, <code class="language-plaintext
highlighter-rouge">jdom</code>, <code class="language-plaintext
highlighter-rouge">sax</code>, or <code class="language-plaintext
highlighter-rouge" [...]
+ <p>Infoset type to output or unparse. <code class="language-plaintext
highlighter-rouge">TYPE</code> must be one of <code class="language-plaintext
highlighter-rouge">xml</code>, <code class="language-plaintext
highlighter-rouge">scala-xml</code>, <code class="language-plaintext
highlighter-rouge">json</code>, <code class="language-plaintext
highlighter-rouge">jdom</code>, <code class="language-plaintext
highlighter-rouge">sax</code>, or <code class="language-plaintext
highlighter-ro [...]
</dd>
<dt><code class="language-plaintext highlighter-rouge">-N, --number
NUMBER</code></dt>
<dd>
- <p>Total number of files to process. Defaults to 1.</p>
+ <p>The total number of files to process. Defaults to 1.</p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">-P, --parser
FILE</code></dt>
<dd>
- <p>Use a previously saved parser, created using the save-parser
subcommand. This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--schema</code> option or with the <code
class="language-plaintext highlighter-rouge">--validate</code> option set to
<code class="language-plaintext highlighter-rouge">on</code>.</p>
+ <p>Use a previously saved parser inside <code class="language-plaintext
highlighter-rouge">FILE</code>, created using the <code
class="language-plaintext highlighter-rouge">save-parser</code> subcommand.
This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--schema</code> option or with the <code
class="language-plaintext highlighter-rouge">--validate</code> option set to
<code class="language-plaintext highlighter-rouge">on</code>.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-p, --path
PATH</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-r, --root
ROOT</code></dt>
<dd>
- <p>The path to the node from the root element to create the parser
from.</p>
- </dd>
- <dt><code class="language-plaintext highlighter-rouge">-r, --root
[{NAMESPACE}]ROOT</code></dt>
- <dd>
- <p>The root element of the DFDL schema to use. This must be one of the
top-level elements of the schema defined with <code class="language-plaintext
highlighter-rouge">--schema</code>. This requires the <code
class="language-plaintext highlighter-rouge">--schema</code> option to be
defined. If not supplied, the first element of the schema defined with <code
class="language-plaintext highlighter-rouge">--schema</code> is used. A
namespace may be specified by prefixing <code class="lan [...]
+ <p>The root element to use. This must be one of the top-level elements of
the DFDL schema defined with <code class="language-plaintext
highlighter-rouge">--schema</code>. This requires the <code
class="language-plaintext highlighter-rouge">--schema</code> option to be
defined. Defaults to the schema's first top-level element if not provided. A
namespace may be specified by prefixing <code class="language-plaintext
highlighter-rouge">ROOT</code> with <code class="language-plaintext hi [...]
</dd>
<dt><code class="language-plaintext highlighter-rouge">-s, --schema
FILE</code></dt>
<dd>
@@ -447,29 +458,78 @@
</dd>
<dt><code class="language-plaintext highlighter-rouge">-T
TUNABLE=VALUE</code></dt>
<dd>
- <p>Modify Daffodil configuration options to change processing behavior.
See <a href="/configuration">Configuration</a> for the list of tunable
parameters.</p>
+ <p>Tunable configuration options to change Daffodil's behavior. See <a
href="/configuration">Configuration</a> for the list of tunable parameters.</p>
</dd>
<dt><code class="language-plaintext highlighter-rouge">-u,
--unparse</code></dt>
<dd>
- <p>Perform unparse instead of parse for performance.</p>
+ <p>Perform unparse instead of parse for performance test.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">-V, --validate
[MODE]</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-V, --validate
MODE</code></dt>
<dd>
- <p>The validation mode. <code class="language-plaintext
highlighter-rouge">on</code>, <code class="language-plaintext
highlighter-rouge">limited</code> or <code class="language-plaintext
highlighter-rouge">off</code>. If <code class="language-plaintext
highlighter-rouge">MODE</code> is not provided, defaults to <code
class="language-plaintext highlighter-rouge">on</code>. If <code
class="language-plaintext highlighter-rouge">--validate</code> is not provided,
defaults to <code class= [...]
+ <p>The validation mode. <code class="language-plaintext
highlighter-rouge">MODE</code> must be one of <code class="language-plaintext
highlighter-rouge">on</code>, <code class="language-plaintext
highlighter-rouge">limited</code>, <code class="language-plaintext
highlighter-rouge">off</code>, or a validator plugin name. Defaults to <code
class="language-plaintext highlighter-rouge">off</code> if not provided.
Validator plugins are provided by SPI and are referenced here using the <co
[...]
</dd>
- <dt><code class="language-plaintext highlighter-rouge">[INFILE]</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">INFILE</code></dt>
<dd>
- <p>Input file or directory containing files to process</p>
+ <p>Input file or directory containing input files to parse or unparse.
Required argument.</p>
</dd>
- <dt><code class="language-plaintext highlighter-rouge">--help</code></dt>
+ <dt><code class="language-plaintext highlighter-rouge">-h, --help</code></dt>
<dd>
- <p>Display help message.</p>
+ <p>Display a help message.</p>
</dd>
</dl>
<h4 id="example-4">Example</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>$ daffodil performance -s csv.dfdl.xsd -N 1000 -t 5
test_file.csv
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil performance -s csv.dfdl.xsd -N 1000 -t 5
test_file.csv
+</code></pre></div></div>
+
+<h3 id="generate-subcommand">Generate Subcommand</h3>
+
+<p>Generate C code from a DFDL schema to parse or unparse data.</p>
+
+<h4 id="usage-5">Usage</h4>
+
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil generate <language> [SUBCOMMAND_OPTS]
+
+--- there is only one choice for <language> at this time ---
+
+daffodil generate c -s <schema> [-r <root>]
+ [-c <file>] [-T<tunable>=<value>...]
+ [outdir]
+</code></pre></div></div>
+
+<h4 id="options-5">Options</h4>
+
+<dl>
+ <dt><code class="language-plaintext highlighter-rouge">-c, --config
FILE</code></dt>
+ <dd>
+ <p>XML file containing configuration items, such as external variables or
Daffodil tunables. See <a href="/configuration">Configuration</a> for details
on the file format.</p>
+ </dd>
+ <dt><code class="language-plaintext highlighter-rouge">-r, --root
ROOT</code></dt>
+ <dd>
+ <p>The root element to use. This must be one of the top-level elements of
the DFDL schema defined with <code class="language-plaintext
highlighter-rouge">--schema</code>. This requires the <code
class="language-plaintext highlighter-rouge">--schema</code> option to be
defined. Defaults to the schema's first top-level element if not provided. A
namespace may be specified by prefixing <code class="language-plaintext
highlighter-rouge">ROOT</code> with <code class="language-plaintext hi [...]
+ </dd>
+ <dt><code class="language-plaintext highlighter-rouge">-s, --schema
FILE</code></dt>
+ <dd>
+ <p>The annotated DFDL schema to use to generate C code. This option must
be supplied.</p>
+ </dd>
+ <dt><code class="language-plaintext highlighter-rouge">-T
TUNABLE=VALUE</code></dt>
+ <dd>
+ <p>Tunable configuration options to change Daffodil's behavior. See <a
href="/configuration">Configuration</a> for the list of tunable parameters.</p>
+ </dd>
+ <dt><code class="language-plaintext highlighter-rouge">[OUTDIR]</code></dt>
+ <dd>
+ <p>The output directory in which to create or replace a <code
class="language-plaintext highlighter-rouge">c</code> subdirectory containing
the generated C code. If the option is not given, a <code
class="language-plaintext highlighter-rouge">c</code> subdirectory within the
current directory will be created/replaced. If supplied, the output directory
must be the last option on the command line.</p>
+ </dd>
+ <dt><code class="language-plaintext highlighter-rouge">-h, --help</code></dt>
+ <dd>
+ <p>Display a help message.</p>
+ </dd>
+</dl>
+
+<h4 id="example-5">Example</h4>
+
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil generate c -s csv.dfdl.xsd
</code></pre></div></div>
</div>
