1USAGE:(1)                        User Commands                       USAGE:(1)
2
3
4

NAME

6       Usage: - convert an XML file
7

SYNOPSIS

9       orcus-xml [OPTIONS] FILE
10

OPTIONS

12       -h [ --help ]
13              Print this help.
14
15       --mode arg
16              Mode  of  operation.  Select one of the following options: dump,
17              map, map-gen, structure, or transform.
18
19       -m [ --map ] arg
20              Path to the map file. A map file is required for all  modes  ex‐
21              cept for the structure mode.
22
23       -o [ --output ] arg
24              Path to either an output directory, or an output file.
25
26       -f [ --output-format ] arg Specify the output format.
27              Supported format types are:
28
29       * check - Flat format that fully encodes document
30              content. Suitable for automated testing.  * csv - CSV format.  *
31              debug-state - This format dumps the internal state of the  docu‐
32              ment in detail, useful for debugging.  * flat - Flat text format
33              that displays document content in grid.  * html -  HTML  format.
34              * json - JSON format.  * none - No output to be generated. Maybe
35              useful during development.  * xml - This format is currently un‐
36              supported.  * yaml - This format is currently unsupported.
37
38       -h [ --help ]
39              Print this help.
40
41       --mode arg
42              Mode  of  operation.  Select one of the following options: dump,
43              map, map-gen, structure, or transform.
44
45       -m [ --map ] arg
46              Path to the map file. A map file is required for all  modes  ex‐
47              cept for the structure mode.
48
49       -o [ --output ] arg
50              Path to either an output directory, or an output file.
51
52       -f [ --output-format ] arg Specify the output format.
53              Supported format types are:
54
55       * check - Flat format that fully encodes document
56              content. Suitable for automated testing.  * csv - CSV format.  *
57              debug-state - This format dumps the internal state of the  docu‐
58              ment in detail, useful for debugging.  * flat - Flat text format
59              that displays document content in grid.  * html -  HTML  format.
60              * json - JSON format.  * none - No output to be generated. Maybe
61              useful during development.  * xml - This format is currently un‐
62              supported.  * yaml - This format is currently unsupported.
63
64
65
66liborcus 0.18.1                   August 2023                        USAGE:(1)
Impressum