diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/cli/index.rst | 16 | ||||
| -rw-r--r-- | doc/cli/orcus_csv.rst | 65 | ||||
| -rw-r--r-- | doc/cli/orcus_gnumeric.rst | 57 | ||||
| -rw-r--r-- | doc/cli/orcus_json.rst | 45 | ||||
| -rw-r--r-- | doc/cli/orcus_ods.rst | 57 | ||||
| -rw-r--r-- | doc/cli/orcus_parquet.rst | 57 | ||||
| -rw-r--r-- | doc/cli/orcus_xls_xml.rst | 57 | ||||
| -rw-r--r-- | doc/cli/orcus_xlsx.rst | 57 | ||||
| -rw-r--r-- | doc/cli/orcus_xml.rst | 43 | ||||
| -rw-r--r-- | doc/cli/orcus_yaml.rst | 27 |
10 files changed, 481 insertions, 0 deletions
diff --git a/doc/cli/index.rst b/doc/cli/index.rst new file mode 100644 index 0000000..ed0726d --- /dev/null +++ b/doc/cli/index.rst @@ -0,0 +1,16 @@ + +CLI +=== + +.. toctree:: + :maxdepth: 1 + + orcus_csv.rst + orcus_gnumeric.rst + orcus_json.rst + orcus_ods.rst + orcus_parquet.rst + orcus_xls_xml.rst + orcus_xlsx.rst + orcus_xml.rst + orcus_yaml.rst diff --git a/doc/cli/orcus_csv.rst b/doc/cli/orcus_csv.rst new file mode 100644 index 0000000..7809d78 --- /dev/null +++ b/doc/cli/orcus_csv.rst @@ -0,0 +1,65 @@ +orcus-csv +========= + +Usage +----- + +.. code-block:: + + orcus-csv [options] FILE + +The FILE must specify a path to an existing file. + +Options +------- + +- ``-h [ --help ]`` + + Print this help. + +- ``-d [ --debug ]`` + + Turn on a debug mode and optionally specify a debug level in order to generate run-time debug outputs. + +- ``-r [ --recalc ]`` + + Re-calculate all formula cells after the documetn is loaded. + +- ``-e [ --error-policy ] arg (=fail)`` + + Specify whether to abort immediately when the loader fails to parse the first formula cell ('fail'), or skip the offending cells and continue ('skip'). + +- ``--dump-check`` + + Dump the content to stdout in a special format used for content verification in automated tests. + +- ``-o [ --output ] arg`` + + Output directory path, or output file when --dump-check option is used. + +- ``-f [ --output-format ] arg`` + + Specify the output format. Supported format types are: + + - check - Flat format that fully encodes document content. Suitable for automated testing. + - csv - CSV format. + - debug-state - This format dumps the internal state of the document in detail, useful for debugging. + - flat - Flat text format that displays document content in grid. + - html - HTML format. + - json - JSON format. + - none - No output to be generated. Maybe useful during development. + - xml - This format is currently unsupported. + - yaml - This format is currently unsupported. + +- ``--row-size arg`` + + Specify the number of maximum rows in each sheet. + +- ``--row-header arg`` + + Specify the number of header rows to repeat if the source content gets split into multiple sheets. + +- ``--split`` + + Specify whether or not to split the data into multiple sheets in case it won't fit in a single sheet. + diff --git a/doc/cli/orcus_gnumeric.rst b/doc/cli/orcus_gnumeric.rst new file mode 100644 index 0000000..6b6ae23 --- /dev/null +++ b/doc/cli/orcus_gnumeric.rst @@ -0,0 +1,57 @@ +orcus-gnumeric +============== + +Usage +----- + +.. code-block:: + + orcus-gnumeric [options] FILE + +The FILE must specify a path to an existing file. + +Options +------- + +- ``-h [ --help ]`` + + Print this help. + +- ``-d [ --debug ]`` + + Turn on a debug mode and optionally specify a debug level in order to generate run-time debug outputs. + +- ``-r [ --recalc ]`` + + Re-calculate all formula cells after the documetn is loaded. + +- ``-e [ --error-policy ] arg (=fail)`` + + Specify whether to abort immediately when the loader fails to parse the first formula cell ('fail'), or skip the offending cells and continue ('skip'). + +- ``--dump-check`` + + Dump the content to stdout in a special format used for content verification in automated tests. + +- ``-o [ --output ] arg`` + + Output directory path, or output file when --dump-check option is used. + +- ``-f [ --output-format ] arg`` + + Specify the output format. Supported format types are: + + - check - Flat format that fully encodes document content. Suitable for automated testing. + - csv - CSV format. + - debug-state - This format dumps the internal state of the document in detail, useful for debugging. + - flat - Flat text format that displays document content in grid. + - html - HTML format. + - json - JSON format. + - none - No output to be generated. Maybe useful during development. + - xml - This format is currently unsupported. + - yaml - This format is currently unsupported. + +- ``--row-size arg`` + + Specify the number of maximum rows in each sheet. + diff --git a/doc/cli/orcus_json.rst b/doc/cli/orcus_json.rst new file mode 100644 index 0000000..be0208b --- /dev/null +++ b/doc/cli/orcus_json.rst @@ -0,0 +1,45 @@ +orcus-json +========== + +Usage +----- + +.. code-block:: + + orcus-json [options] FILE + +The FILE must specify the path to an existing file. + +Options +------- + +- ``-h [ --help ]`` + + Print this help. + +- ``--mode arg`` + + Mode of operation. Select one of the following options: convert, map, map-gen, or structure. + +- ``--resolve-refs`` + + Resolve JSON references to external files. + +- ``-o [ --output ] arg`` + + Output file path. + +- ``-f [ --output-format ] arg`` + + Specify the format of output file. Supported format types are: + + - XML (xml) + - JSON (json) + - YAML (yaml) + - flat tree dump (check) + - no output (none) + +- ``-m [ --map ] arg`` + + Path to a map file. This parameter is only used for map mode, and it is required for map mode. + diff --git a/doc/cli/orcus_ods.rst b/doc/cli/orcus_ods.rst new file mode 100644 index 0000000..fdeb2fa --- /dev/null +++ b/doc/cli/orcus_ods.rst @@ -0,0 +1,57 @@ +orcus-ods +========= + +Usage +----- + +.. code-block:: + + orcus-ods [options] FILE + +The FILE must specify a path to an existing file. + +Options +------- + +- ``-h [ --help ]`` + + Print this help. + +- ``-d [ --debug ]`` + + Turn on a debug mode and optionally specify a debug level in order to generate run-time debug outputs. + +- ``-r [ --recalc ]`` + + Re-calculate all formula cells after the documetn is loaded. + +- ``-e [ --error-policy ] arg (=fail)`` + + Specify whether to abort immediately when the loader fails to parse the first formula cell ('fail'), or skip the offending cells and continue ('skip'). + +- ``--dump-check`` + + Dump the content to stdout in a special format used for content verification in automated tests. + +- ``-o [ --output ] arg`` + + Output directory path, or output file when --dump-check option is used. + +- ``-f [ --output-format ] arg`` + + Specify the output format. Supported format types are: + + - check - Flat format that fully encodes document content. Suitable for automated testing. + - csv - CSV format. + - debug-state - This format dumps the internal state of the document in detail, useful for debugging. + - flat - Flat text format that displays document content in grid. + - html - HTML format. + - json - JSON format. + - none - No output to be generated. Maybe useful during development. + - xml - This format is currently unsupported. + - yaml - This format is currently unsupported. + +- ``--row-size arg`` + + Specify the number of maximum rows in each sheet. + diff --git a/doc/cli/orcus_parquet.rst b/doc/cli/orcus_parquet.rst new file mode 100644 index 0000000..129919e --- /dev/null +++ b/doc/cli/orcus_parquet.rst @@ -0,0 +1,57 @@ +orcus-parquet +============= + +Usage +----- + +.. code-block:: + + orcus-parquet [options] FILE + +The FILE must specify a path to an existing file. + +Options +------- + +- ``-h [ --help ]`` + + Print this help. + +- ``-d [ --debug ]`` + + Turn on a debug mode and optionally specify a debug level in order to generate run-time debug outputs. + +- ``-r [ --recalc ]`` + + Re-calculate all formula cells after the documetn is loaded. + +- ``-e [ --error-policy ] arg (=fail)`` + + Specify whether to abort immediately when the loader fails to parse the first formula cell ('fail'), or skip the offending cells and continue ('skip'). + +- ``--dump-check`` + + Dump the content to stdout in a special format used for content verification in automated tests. + +- ``-o [ --output ] arg`` + + Output directory path, or output file when --dump-check option is used. + +- ``-f [ --output-format ] arg`` + + Specify the output format. Supported format types are: + + - check - Flat format that fully encodes document content. Suitable for automated testing. + - csv - CSV format. + - debug-state - This format dumps the internal state of the document in detail, useful for debugging. + - flat - Flat text format that displays document content in grid. + - html - HTML format. + - json - JSON format. + - none - No output to be generated. Maybe useful during development. + - xml - This format is currently unsupported. + - yaml - This format is currently unsupported. + +- ``--row-size arg`` + + Specify the number of maximum rows in each sheet. + diff --git a/doc/cli/orcus_xls_xml.rst b/doc/cli/orcus_xls_xml.rst new file mode 100644 index 0000000..0081693 --- /dev/null +++ b/doc/cli/orcus_xls_xml.rst @@ -0,0 +1,57 @@ +orcus-xls-xml +============= + +Usage +----- + +.. code-block:: + + orcus-xls-xml [options] FILE + +The FILE must specify a path to an existing file. + +Options +------- + +- ``-h [ --help ]`` + + Print this help. + +- ``-d [ --debug ]`` + + Turn on a debug mode and optionally specify a debug level in order to generate run-time debug outputs. + +- ``-r [ --recalc ]`` + + Re-calculate all formula cells after the documetn is loaded. + +- ``-e [ --error-policy ] arg (=fail)`` + + Specify whether to abort immediately when the loader fails to parse the first formula cell ('fail'), or skip the offending cells and continue ('skip'). + +- ``--dump-check`` + + Dump the content to stdout in a special format used for content verification in automated tests. + +- ``-o [ --output ] arg`` + + Output directory path, or output file when --dump-check option is used. + +- ``-f [ --output-format ] arg`` + + Specify the output format. Supported format types are: + + - check - Flat format that fully encodes document content. Suitable for automated testing. + - csv - CSV format. + - debug-state - This format dumps the internal state of the document in detail, useful for debugging. + - flat - Flat text format that displays document content in grid. + - html - HTML format. + - json - JSON format. + - none - No output to be generated. Maybe useful during development. + - xml - This format is currently unsupported. + - yaml - This format is currently unsupported. + +- ``--row-size arg`` + + Specify the number of maximum rows in each sheet. + diff --git a/doc/cli/orcus_xlsx.rst b/doc/cli/orcus_xlsx.rst new file mode 100644 index 0000000..6da6d4c --- /dev/null +++ b/doc/cli/orcus_xlsx.rst @@ -0,0 +1,57 @@ +orcus-xlsx +========== + +Usage +----- + +.. code-block:: + + orcus-xlsx [options] FILE + +The FILE must specify a path to an existing file. + +Options +------- + +- ``-h [ --help ]`` + + Print this help. + +- ``-d [ --debug ]`` + + Turn on a debug mode and optionally specify a debug level in order to generate run-time debug outputs. + +- ``-r [ --recalc ]`` + + Re-calculate all formula cells after the documetn is loaded. + +- ``-e [ --error-policy ] arg (=fail)`` + + Specify whether to abort immediately when the loader fails to parse the first formula cell ('fail'), or skip the offending cells and continue ('skip'). + +- ``--dump-check`` + + Dump the content to stdout in a special format used for content verification in automated tests. + +- ``-o [ --output ] arg`` + + Output directory path, or output file when --dump-check option is used. + +- ``-f [ --output-format ] arg`` + + Specify the output format. Supported format types are: + + - check - Flat format that fully encodes document content. Suitable for automated testing. + - csv - CSV format. + - debug-state - This format dumps the internal state of the document in detail, useful for debugging. + - flat - Flat text format that displays document content in grid. + - html - HTML format. + - json - JSON format. + - none - No output to be generated. Maybe useful during development. + - xml - This format is currently unsupported. + - yaml - This format is currently unsupported. + +- ``--row-size arg`` + + Specify the number of maximum rows in each sheet. + diff --git a/doc/cli/orcus_xml.rst b/doc/cli/orcus_xml.rst new file mode 100644 index 0000000..d41865e --- /dev/null +++ b/doc/cli/orcus_xml.rst @@ -0,0 +1,43 @@ +orcus-xml +========= + +Usage +----- + +.. code-block:: + + orcus-xml [OPTIONS] FILE + +Options +------- + +- ``-h [ --help ]`` + + Print this help. + +- ``--mode arg`` + + Mode of operation. Select one of the following options: dump, map, map-gen, structure, or transform. + +- ``-m [ --map ] arg`` + + Path to the map file. A map file is required for all modes except for the structure mode. + +- ``-o [ --output ] arg`` + + Path to either an output directory, or an output file. + +- ``-f [ --output-format ] arg`` + + Specify the output format. Supported format types are: + + - check - Flat format that fully encodes document content. Suitable for automated testing. + - csv - CSV format. + - debug-state - This format dumps the internal state of the document in detail, useful for debugging. + - flat - Flat text format that displays document content in grid. + - html - HTML format. + - json - JSON format. + - none - No output to be generated. Maybe useful during development. + - xml - This format is currently unsupported. + - yaml - This format is currently unsupported. + diff --git a/doc/cli/orcus_yaml.rst b/doc/cli/orcus_yaml.rst new file mode 100644 index 0000000..e29a8ed --- /dev/null +++ b/doc/cli/orcus_yaml.rst @@ -0,0 +1,27 @@ +orcus-yaml +========== + +Usage +----- + +.. code-block:: + + orcus-yaml [options] FILE + +The FILE must specify a path to an existing file. + +Options +------- + +- ``-h [ --help ]`` + + Print this help. + +- ``-o [ --output ] arg`` + + Output file path. + +- ``-f [ --output-format ] arg`` + + Specify the format of output file. Supported format types are: 1) yaml 2) json + |