summaryrefslogtreecommitdiffstats
path: root/doc/cli/orcus_yaml.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/cli/orcus_yaml.rst')
-rw-r--r--doc/cli/orcus_yaml.rst27
1 files changed, 27 insertions, 0 deletions
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
+