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 f9468f1 Publishing from 9e5964b5d6ff930cac582b01f8989dec6b6d3cf4
f9468f1 is described below
commit f9468f1ea306a40f49547fc075c71584d2ffa5d6
Author: Apache Daffodil Site Autobuild <[email protected]>
AuthorDate: Tue Nov 12 20:48:39 2024 +0000
Publishing from 9e5964b5d6ff930cac582b01f8989dec6b6d3cf4
---
content/cli/index.html | 93 +++++++++++++++++++++++++++++++-------------------
1 file changed, 58 insertions(+), 35 deletions(-)
diff --git a/content/cli/index.html b/content/cli/index.html
index 4008105..2fa6824 100644
--- a/content/cli/index.html
+++ b/content/cli/index.html
@@ -132,6 +132,10 @@
<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">DAFFODIL_TDML_API_INFOSETS</code></dt>
+ <dd>
+ <p>If you need to specify which API (legacy or both (SAX and legacy))
should be called when running TDML files with the <code
class="language-plaintext highlighter-rouge">test</code> subcommand, you can
set the <code class="language-plaintext
highlighter-rouge">DAFFODIL_TDML_API_INFOSETS</code> environment variable to
either <code class="language-plaintext highlighter-rouge">scala</code> or <code
class="language-plaintext highlighter-rouge">all</code>. If that environment
variable is [...]
+ </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 codegen-c 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</co [...]
@@ -141,20 +145,6 @@
<h3 id="global-options">Global Options</h3>
<dl>
- <dt><code class="language-plaintext highlighter-rouge">-d, --debug
[FILE]</code></dt>
- <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 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>
- <dt><code class="language-plaintext highlighter-rouge">-t,
--trace</code></dt>
- <dd>
- <p>Enable a trace mode. This mode prints out helpful information during
every stage of parsing.</p>
-
- <p>This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--debug</code> option.</p>
- </dd>
<dt><code class="language-plaintext highlighter-rouge">-v,
--verbose</code></dt>
<dd>
<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>
@@ -176,12 +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 <root>] |
-P <parser>)
- [-c <file>] [-D<variable>=<value>...] [-I
<infoset_type>]
- [-o <output>] [--stream]
[-T<tunable>=<value>...] [-V <mode>]
- [infile]
+ [PARSE_OPTS] [infile]
</code></pre></div></div>
-<h4 id="options">Options</h4>
+<h4 id="parse-options">Parse Options</h4>
<dl>
<dt><code class="language-plaintext highlighter-rouge">-c, --config
FILE</code></dt>
@@ -194,6 +182,14 @@
<p><code class="language-plaintext
highlighter-rouge">-D{http://example.com}var1=var</code></p>
</dd>
+ <dt><code class="language-plaintext highlighter-rouge">-d, --debug
[FILE]</code></dt>
+ <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 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>
<dt><code class="language-plaintext highlighter-rouge">-I, --infoset-type
TYPE</code></dt>
<dd>
<p>Infoset type to output. <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">null</ [...]
@@ -226,6 +222,12 @@
<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">-t,
--trace</code></dt>
+ <dd>
+ <p>Enable a trace mode. This mode prints out helpful information during
every stage of parsing.</p>
+
+ <p>This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--debug</code> option.</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 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
[...]
@@ -252,12 +254,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 <root>] |
-P <parser>)
- [-c <file>] [-D<variable>=<value>...] [-I
<infoset_type>]
- [-o <output>] [--stream]
[-T<tunable>=<value>...] [-V <mode>]
- [infile]
+ [UNPARSE_OPTS] [infile]
</code></pre></div></div>
-<h4 id="options-1">Options</h4>
+<h4 id="unparse-options">Unparse Options</h4>
<dl>
<dt><code class="language-plaintext highlighter-rouge">-c, --config
FILE</code></dt>
@@ -270,6 +270,14 @@
<p><code class="language-plaintext
highlighter-rouge">-D{http://example.com}var1=var</code></p>
</dd>
+ <dt><code class="language-plaintext highlighter-rouge">-d, --debug
[FILE]</code></dt>
+ <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 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>
<dt><code class="language-plaintext highlighter-rouge">-I, --infoset-type
TYPE</code></dt>
<dd>
<p>Infoset type to 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>, or <code class="language-plaintext
highlighter-rouge">sax</code>. Defaults to <code class="language-plaintext
highlighter- [...]
@@ -302,6 +310,12 @@
<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">-t,
--trace</code></dt>
+ <dd>
+ <p>Enable a trace mode. This mode prints out helpful information during
every stage of parsing.</p>
+
+ <p>This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--debug</code> option.</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 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
[...]
@@ -328,11 +342,10 @@
<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 <root>]
- [-c <file>] [-D<variable>=<value>...]
[-T<tunable>=<value>...]
- [outfile]
+ [SAVE_PARSER_OPTS] [outfile]
</code></pre></div></div>
-<h4 id="options-2">Options</h4>
+<h4 id="save-parser-options">Save Parser Options</h4>
<dl>
<dt><code class="language-plaintext highlighter-rouge">-c, --config
FILE</code></dt>
@@ -378,12 +391,20 @@
<h4 id="usage-3">Usage</h4>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil test [-I <implementation>] [-l] [-r]
[-i] <tdmlfile> [testnames...]
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>daffodil test [TEST_OPTS] <tdmlfile>
[testnames...]
</code></pre></div></div>
-<h4 id="options-3">Options</h4>
+<h4 id="test-options">Test Options</h4>
<dl>
+ <dt><code class="language-plaintext highlighter-rouge">-d, --debug
[FILE]</code></dt>
+ <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 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>
<dt><code class="language-plaintext highlighter-rouge">-I, --implementation
<implementation></code></dt>
<dd>
<p>Implementation to run TDML tests. Choose daffodil or
@@ -401,6 +422,12 @@ daffodilC. Defaults to daffodil.</p>
<dd>
<p>Treat <code class="language-plaintext
highlighter-rouge">TESTNAMES...</code> as regular expressions.</p>
</dd>
+ <dt><code class="language-plaintext highlighter-rouge">-t,
--trace</code></dt>
+ <dd>
+ <p>Enable a trace mode. This mode prints out helpful information during
every stage of parsing.</p>
+
+ <p>This option cannot be used with the <code class="language-plaintext
highlighter-rouge">--debug</code> option.</p>
+ </dd>
<dt><code class="language-plaintext highlighter-rouge">TDMLFILE</code></dt>
<dd>
<p>Test Data Markup Language (TDML) file.</p>
@@ -427,13 +454,10 @@ daffodilC. Defaults to daffodil.</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
<root>] | -P <parser>)
- [-c <file>] [-D<variable>=<value>...]
[-I <infoset_type>]
- [-N <number>] [-t <threads>]
[-T<tunable>=<value>...]
- [-u] [-V <mode>]
- <infile>
+ [PERFORMANCE_OPTS] <infile>
</code></pre></div></div>
-<h4 id="options-4">Options</h4>
+<h4 id="performance-options">Performance Options</h4>
<dl>
<dt><code class="language-plaintext highlighter-rouge">-c, --config
FILE</code></dt>
@@ -508,11 +532,10 @@ daffodilC. Defaults to daffodil.</p>
--- there is only one choice for <language> at this time ---
daffodil generate c -s <schema> [-r <root>]
- [-c <file>] [-T<tunable>=<value>...]
- [outdir]
+ [GENERATE_OPTIONS] [outdir]
</code></pre></div></div>
-<h4 id="options-5">Options</h4>
+<h4 id="generate-options">Generate Options</h4>
<dl>
<dt><code class="language-plaintext highlighter-rouge">-c, --config
FILE</code></dt>
