summaryrefslogtreecommitdiffstats
path: root/doc/cli/orcus_json.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:48:59 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:48:59 +0000
commitc484829272cd13a738e35412498e12f2c9a194ac (patch)
treea1f5ec09629ee895bd3963fa8820b45f2f4c574b /doc/cli/orcus_json.rst
parentInitial commit. (diff)
downloadliborcus-upstream.tar.xz
liborcus-upstream.zip
Adding upstream version 0.19.2.upstream/0.19.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/cli/orcus_json.rst')
-rw-r--r--doc/cli/orcus_json.rst45
1 files changed, 45 insertions, 0 deletions
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.
+