From 0fa568b54aad58b8f81e4f9702e83dbdbe2cc893 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Tue, 4 May 2021 11:08:15 +0800 Subject: [PATCH] doc/man/8/cephfs-shell: reformat options * format global options using option directive * fix the header, so man/conf.py is able to parse the description * define "Synopsis" section to be consistent with other manpages. * drop reference to glossary using "term" as manapge does not have reference to glossary entries. Signed-off-by: Kefu Chai --- doc/cephfs/cephfs-shell.rst | 47 +++++++++++++++++++++++++++---------- 1 file changed, 35 insertions(+), 12 deletions(-) diff --git a/doc/cephfs/cephfs-shell.rst b/doc/cephfs/cephfs-shell.rst index 244d78bda12a5..62ebf60f20509 100644 --- a/doc/cephfs/cephfs-shell.rst +++ b/doc/cephfs/cephfs-shell.rst @@ -1,10 +1,22 @@ +:orphan: -============= -CephFS Shell -============= +=================================================== +cephfs-shell -- Shell-like tool talking with CephFS +=================================================== + +.. program:: cephfs-shell + +Synopsis +======== + +| **cephfs-shell** [options] [command] +| **cephfs-shell** [options] -- [command, command,...] + +Description +=========== CephFS Shell provides shell-like commands that directly interact with the -:term:`Ceph File System`. +Ceph File System. This tool can be used in interactive mode as well as in non-interactive mode. In former mode, cephfs-shell opens a shell session and after the given command @@ -17,16 +29,20 @@ return value. Behaviour of CephFS Shell can be tweaked using ``cephfs-shell.conf``. Refer to `CephFS Shell Configuration File`_ for details. -Usage : +Options +======= - cephfs-shell [options] [command] - cephfs-shell [options] -- [command, command,...] +.. option:: -c, --config FILE -Options : - -c, --config FILE Path to cephfs-shell.conf - -b, --batch FILE Path to batch file. - -t, --test FILE Path to transcript(s) in FILE for testing + Path to cephfs-shell.conf +.. option:: -b, --batch FILE + + Path to batch file. + +.. option:: -t, --test FILE + + Path to transcript(s) in FILE for testing .. note:: @@ -516,7 +532,9 @@ Right now, CephFS Shell inherits all its options from its dependency ``cmd2``. Therefore, these options might vary with the version of ``cmd2`` installed on your system. Refer to ``cmd2`` docs for a description of these options. -Following is a sample ``cephfs-shell.conf``:: +Following is a sample ``cephfs-shell.conf`` + +.. code-block:: ini [cephfs-shell] prompt = CephFS:~/>>> @@ -586,3 +604,8 @@ Following exit codes are returned by cephfs shell +-----------------------------------------------+-----------+ | Interrupted function call | 22 | +-----------------------------------------------+-----------+ + +Files +===== + +``~/.cephfs-shell.conf`` -- 2.39.5