From 7ac2821147f0eae7250374c9359f446b84b1414c Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Wed, 27 Dec 2017 17:07:11 +0100 Subject: [PATCH] docs: small usage section mentioning CLI --- docs/index.rst | 1 + docs/usage.rst | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 docs/usage.rst diff --git a/docs/index.rst b/docs/index.rst index af23299..1d3e218 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -82,6 +82,7 @@ Table of Contents tutorial installation configuration + usage implementation changelog GitHub Repository & Issue Tracker diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..dfc8648 --- /dev/null +++ b/docs/usage.rst @@ -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` +