summaryrefslogtreecommitdiffstats
path: root/doc/cli/orcus_csv.rst
blob: 7809d78b068fe28ca2ba4d55d0245ad5c3a9532d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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.