docs: small usage section mentioning CLI

2017-12-27 17:07:11 +01:00
parent e6554b77c0
commit 7ac2821147
2 changed files with 29 additions and 0 deletions
@@ -0,0 +1,28 @@
+*****
+Usage
+*****
+
+============
+CLI Overview
+============
+
+.. NOTE::
+
+    To avoid duplication, the zrepl binary is self-documenting:
+    invoke any subcommand at any level with the ``--help`` flag to get information on the subcommand, available flags, etc.
+
+.. list-table::
+    :widths: 30 70
+    :header-rows: 1
+
+    * - Subcommand
+      - Description
+    * - ``zrepl daemon``
+      - run the daemon, required for all zrepl functionality
+    * - ``zrepl control``
+      - control / query the daemon
+    * - ``zrepl control status``
+      - show job activity / monitoring (``--format raw``)
+    * - ``zrepl stdinserver``
+      - see :ref:`transport-ssh+stdinserver`
+