Versions Compared

Old Version 43

changes.mady.by.user Steve Lawrence

Saved on

compared with

New Version 44

changes.mady.by.user Steve Lawrence

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

               [-V [mode]] [-c <file>] [-I <infoset_type>] [infile]

Options

 

The validation mode. 'on', 'limited' or 'off'. If 'mode' is not provided, defaults to 'on'. If --validate is not provided, defaults to 'off'. Mode cannot be 'on' when cXML file containing configuration items, such as external variables or Daffodil tunables. See  Configuration File for details on the file format
LongShortArgumentsDescription
--schemaconfig-sc
<schema>
The annotated DFDL schema to use to create the parser. This option cannot be used with the --parser option.
--root
<file>XML file containing configuration items, such as external variables or Daffodil tunables. See  Configuration File for details on the file format.
 
-D-r
[{<namespace>}]<root>
The root element of the DFDL schema to use. This must be one of the top-level elements of the schema defined with --schema. This requires the --schema option to be defined. If not supplied, the first element of the schema defined with --schema is used. A namespace may be specified by prefixing it with {namespace}.
--path
-p
<path>
The path to the node from the root element to create the parser from.
<variable>=<value>

Variables to be used when parsing. The variable can be prefixed with {namespace} to define which namespace the variable belongs in, for example:

-D{http://example.com}var1=val

--infoset-type-I<infoset_type>

Infoset type to output. Must be one of 'xml', 'scala-xml', 'json', 'jdom', or 'null'. Defaults to 'xml' if not provided.

--output
-o
<output>
Write output to a given file. If the option is not given or is -, output is written to standard out.
--parser
-P
<parser>
Use a 
--parser
-P
<parser>
Use a previously saved parser, created using the save-parser subcommand. This option cannot be used with the --schema option or with the --validate option set to 'on'.
 
--path
-D
[{<namespace>}]<variable>=<value>

Variables to be used when parsing. The variable can be prefixed with {namespace} to define which namespace the variable belongs in, for example:

-D{http://example.com}var1=val

 
-T
<tunable>=<value>

Modify Daffodil configuration options to change parsing behavior. See Configuration File#Tunable Parameters for the list of tunable parameters.

--output
-o
<output>
Write output to a given file. If the option is not given or is -, output is written to standard out.
p
<path>
The path to the node from the root element to create the parser from.
--root
-r
[{<namespace>}]<root>
The root element of the DFDL schema to use. This must be one of the top-level elements of the schema defined with --schema. This requires the --schema option to be defined. If not supplied, the first element of the schema defined with --schema is used. A namespace may be specified by prefixing it with {namespace}.
--schema
-s
<schema>
The annotated DFDL schema to use to create the parser. This option cannot be 
--validate
-V
[mode]
 used with the --parser option.--config
 
-
T
<file>
<tunable>=<value>

Modify Daffodil configuration options to change parsing behavior. See Configuration File#Tunable Parameters for the list of tunable parameters.

--
infoset-type
validate
-
I		<infoset_type>
V
[mode]
The validation mode. 'on', 'limited' or 'off'. If 'mode' is not provided, defaults to 'on'. If --validate is not provided, defaults to 'off'. Mode cannot be 'on' when used with the --parser optionInfoset type to output. Must be one of 'xml', 'scala-xml', 'json', 'jdom', or 'null'. Defaults to 'xml' if not provided.
  
[infile]

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.

--versionhelp
  Display the version of Daffodil.
--help
  Display help message.
help message.

Example

daffodil parse -s csv.dfdl.xsd test_file.csv

...

outputo
LongShortArgumentsDescription
--schemaconfig-sc
<schema>
The annotated DFDL schema to use to create the parser. This option cannot be used with the --parser option.
--root
-r
<file>XML file containing configuration items, such as external variables or Daffodil tunables. See Configuration File for details on the file format.
 
-D
[{<namespace>}]<root>
The root element of the DFDL schema to use. This must be one of the top-level elements of the schema defined with --schema. This requires the --schema option to be defined. If not supplied, the first element of the schema defined with --schema is used. A namespace may be specified by prefixing it with {namespace}.
<variable>=<value>
Variables to be used when unparsing. The variable can be prefixed with {namespace} to define which namespace the variable belongs in, for example:

-D{http://example.com}var1=val

--infoset-type-I<infoset_type>

Infoset type to unparse. Must be one of 'xml', 'scala-xml', 'json', or 'jdom'. Defaults to 'xml' if not provided.

--output
-o
<output>
Write output to a give file. If the option is not given or is -, output is written to standard out
--path
-p
<path>
The path to the node from the root element to create the parser from.
--parser
-P
<parser>
Use a previously saved parser, created using the save-parser subcommand. This option cannot be used with the --schema option or with the --validate option set to 'on'.
--path
-p
<path>
The path to the node from the root element to create the parser from.
--root
-r
 
-D
[{<namespace>}]<variable>=<value>
Variables to be used when unparsing. The variable can be prefixed with {namespace} to define which namespace the variable belongs in, for example:

-D{http://example.com}var1=val

<root>
The root element of the DFDL schema to use. This must be one of the top-level elements of the schema defined with --schema. This requires the --schema option to be defined. If not supplied, the first element of the schema defined with --schema is used. A namespace may be specified by prefixing it with {namespace}.
--schema
-s
<schema>
The annotated DFDL schema to use to create the parser. This option cannot be used with the --parser option.
 
-T
<tunable>=<value>

Modify

 
-T
<tunable>=<value>

Modify Daffodil configuration options to change parsing behavior. See  Configuration File#Tunable Parameters for the list of tunable parameters.

--
validate
-
V
<output>
Write output to a give file. If the option is not given or is -, output is written to standard out.
[mode]
The validation mode. 'on', '
--validate
-V
[mode]
The validation mode. 'on', 'limited' or 'off'. If 'mode' is not given, defaults to 'on'. If --validate is not present, defaults to 'off'. Mode cannot be 'on' when used with the --parser option.
--config-c<file>XML file containing configuration items, such as external variables or Daffodil tunables. See Configuration File for details on the file format.
--infoset-type-I<infoset_type>

Infoset type to unparse. Must be one of 'xml', 'scala-xml', 'json', or 'jdom'. Defaults to 'xml' if not provided.

  
[infile]
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.
--version
  Display the version of Daffodil.
--help
  Display help message.

Example

daffodil unparse -s csv.dfdl.xsd test_file.infoset

Save Parser Subcommand

Create a save a parser that can be reused for parsing and unparsing.

Usage

daffodil save-parser -s <schema> [-r [{namespace}]<root>] [-p <path>] [-o <output>] [outfile]

Options

  
[infile]
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.
--help
  Display help message.

Example

daffodil unparse -s csv.dfdl.xsd test_file.infoset

Save Parser Subcommand

Create a save a parser that can be reused for parsing and unparsing.

Usage

daffodil save-parser -s <schema> [-r [{namespace}]<root>] [-p <path>] [-o <output>] [outfile]

Options

LongShortArgumentsDescription
--config-c<file>XML file containing configuration items, such as external variables or Daffodil tunables. See Configuration File for details on the file format.
 
-D
[{<namespace>}]<variable>=<value>

Variables to be used when parsing. The variable can be prefixed with {namespace} to define which namespace the variable belongs in, for example:

-D{http://example.com}var1=val

--path
-p
<path>
The path to the node from the root element to create the parser from.
--root
-r
[
LongShortArgumentsDescription
--schema
-s
<schema>
The annotated DFDL schema to use to create the parser. This option must be supplied.
--root
-r
[{<namespace>}]<root>
The root element of the DFDL schema to use. This must be one of the top-level elements of the schema defined with --schema. This requires the --schema option to be defined. If not supplied, the first element of the schema defined with --schema is used. A namespace may be specified by prefixing it with {namespace}.
--pathschema
-ps
<path><schema>
The path to the node from the root element annotated DFDL schema to use to create the parser from. This option must be supplied.
--validate
-V
[mode]

The validation mode. 'limited' or 'off'. Mode is required. If --validate is not present, defaults to 'off'. Mode cannot be set to 'on' as possible in other commands.

--config-c<file>XML file containing configuration items, such as external variables or Daffodil tunables. See Configuration File for details on the file format.
 
-D
[{<namespace>}]<variable>=<value>

Variables to be used when parsing. The variable can be prefixed with {namespace} to define which namespace the variable belongs in, for example:

-D{http://example.com}var1=val

 
 
[outfile]
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.
--version
  Display the version of Daffodil.
--help
  Display help message.

Example

daffodil save-parser -s csv.dfdl.xsd csv_parser.xml

Test Subcommand

List or execute tests in a TDML file.

Usage

daffodil test [-l] [-r] [-i] <tdmlfile> [testname...]

Options

...

--info

...

-i

...

 

...

Increment test result information output level, one level for each occurrence of -i.

...

--list

...

-l

...

 

...

--regex

...

-r

...

 

...

 

...

 

...

<tdmlfile>

...

 

...

 

...

[testname...]

...

--version

...

--help

...

 
 
[outfile]
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.
--help
  Display help message.

Example

daffodil save-parser -s csv.dfdl.xsd csv_parser.xml

Test Subcommand

List or execute tests in a TDML file.

Usage

daffodil test [-l] [-r] [-i] <tdmlfile> [testname...]

Options

LongShortArgumentsDescription
--info
-i
 

Increment test result information output level, one level for each occurrence of -i.

--list
-l
 
Show names and descriptions in a TDML file instead of running them.
--regex
-r
 
Read <testnames> as regular expressions.
 
 
<tdmlfile>
Test Data Markup Language (TDML) file.
 
 
[testname...]
Name of one or more test case in the tdml file. If not given, all tests in <tdmlfile> are run.
--help
  Display help message.

Example

daffodil test csv.tdml

Performance Subcommand

Run a performance test (parse or unparse), using either a DFDL schema or a saved parser

Info

The unparse option of the performance subcommand was implemented as of version 1.1.0.

Usage

daffodil performance (-s <schema> [-r [{namespace}]<root>] [-p <path>] |  -P <parser)

Example

daffodil test csv.tdml

Performance Subcommand

Run a performance test (parse or unparse), using either a DFDL schema or a saved parser

Info

The unparse option of the performance subcommand was implemented as of version 1.1.0.

Usage

daffodil performance (-s <schema> [-r [{namespace}]<root>] [-p <path>] |  -P <parser)
                     [-U] [-V[mode]] [-N <number>] [-t <threads>]
                     [-D[{namespace}]<variable>=<value>] [-I     [-D[{namespace<infoset_type>] <infile>

Options

LongShortArgumentsDescription
--config-c<file>XML file containing configuration items, such as external variables or Daffodil tunables. See  Configuration File for details on the file format.
 
-D
[{<namespace>}]<variable>=<value>

...

Variables to be used when parsing. The variable can be prefixed with {namespace} to define which namespace the variable belongs in, for example:
-D{http://example.com}var1=val
--infoset-type-I<infoset_type>
Infoset type to parse/unparse. Must be one of 'xml', 'scala-xml', 'json', 'jdom', or 'null'. Defaults to 'xml' if not provided. Note that 'null' is not valid if the --unparse option is provided.
--number
-N
<number>
Total number of files to process. Defaults to 1
Options
 
Display the version of Daffodil.
LongShortArgumentsDescription
--schema
-s
<schema>
The annotated DFDL schema to use to create the parser. This option cannot be used with the --parser option.
--root
-r
[{<namespace>}]<root>
The root element of the DFDL schema to use. This must be one of the top-level elements of the schema defined with --schema. This requires the --schema option to be defined. If not supplied, the first element of the schema defined with --schema is used. A namespace may be specified by prefixing it with {namespace}.
--path
-p
<path>
The path to the node from the root element to create the parser from.
--parser
-P
<parser>
Use a previously saved parser, created using the save-parser subcommand. This option cannot be used with the --schema option or with the --validate option set to 'on'.
 
-D
[{<namespace>}]<variable>=<value>
Variables to be used when parsing. The variable can be prefixed with {namespace} to define which namespace the variable belongs in, for example:
-D{http://example.com}var1=val
 
-T
<tunable>=<value>
Modify Daffodil configuration options to change processing behavior. See Configuration File#Tunable Parameters for the list of tunable parameters.
--unparse
-u
 
Perform unparse instead of parse for performance.
--validate
-V
[mode]
The validation mode. 'on', 'limited' or 'off'. If 'mode' is not provided, defaults to 'on'. If --validate is not provided, defaults to 'off'. Mode cannot be 'on' when used with the --parser option.
option or with the --validate option set to 'on'.
--path
-p
<path>
The path to the node from the root element to create the parser from.
--root
-r
[{<namespace>}]<root>
The root element of the DFDL schema to use. This must be one of the top-level elements of the schema defined with --schema. This requires the --schema option to be defined. If not supplied, the first element of the schema defined with --schema is used. A namespace may be specified by prefixing it with {namespace}.
--schema
-s
<schema>
The annotated DFDL schema to use to create the parser. This option cannot be used with the --parser option.
--number
-N
<number>
Total number of files to process. Defaults to 1.
--threads
-t
<threads>
The number of threads to use. Defaults to 1.
--config 
-
c
T
<file>XML file containing configuration items, such as external variables or Daffodil tunables. See  Configuration File for details on the file format.
<tunable>=<value>
Modify Daffodil configuration options to change processing behavior. See Configuration File#Tunable Parameters for the list of tunable parameters.
--unparse
-u
 
Perform unparse instead of parse for performance.
--validate
-V
[mode]
The validation mode. 'on', 'limited' or 'off'. If 'mode' is not provided, defaults to 'on'. If --validate is not provided, defaults to 'off'. Mode cannot be 'on' when used with the --parser option--infoset-type-I<infoset_type>Infoset type to parse/unparse. Must be one of 'xml', 'scala-xml', 'json', 'jdom', or 'null'. Defaults to 'xml' if not provided. Note that 'null' is not valid if the --unparse option is provided.
  
[infile]
Input file or directory containing files to process
--version
  
--help
  Display help message.
...