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 <kchai@redhat.com>

diff --git a/doc/cephfs/cephfs-shell.rst b/doc/cephfs/cephfs-shell.rst
index 244d78bda12a54e1bff2d470e8df42fb110a3fa9..62ebf60f20509947eb102c4cbea217946653d66b 100644 (file)
--- 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``