summaryrefslogtreecommitdiffstats
path: root/doc/cli/orcus_json.rst
blob: be0208b386699224207fee844583ffc27f4cdb7f (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
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.