From: Kefu Chai <kchai@redhat.com>
Date: Tue, 21 Apr 2015 06:57:18 +0000 (+0800)
Subject: doc: rework ceph-conf.8
X-Git-Tag: v9.0.2~183^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=a4627aabb7c31da99802b446d45b77699b2cc2dc;p=ceph.git

doc: rework ceph-conf.8

* sync it with the code
* reformat it like a proper man page

Signed-off-by: Kefu Chai <kchai@redhat.com>
---

diff --git a/doc/man/8/ceph-conf.rst b/doc/man/8/ceph-conf.rst
index 08154e4cc0c8..9782e38988ad 100644
--- a/doc/man/8/ceph-conf.rst
+++ b/doc/man/8/ceph-conf.rst
@@ -13,7 +13,7 @@ Synopsis
 | **ceph-conf** -c *conffile* -L
 | **ceph-conf** -c *conffile* -l *prefix*
 | **ceph-conf** *key* -s *section1* ...
-| **ceph-conf** [-s *section* ] --lookup *key*
+| **ceph-conf** [-s *section* ] [-r] --lookup *key*
 | **ceph-conf** [-s *section* ] *key*
 
 
@@ -28,30 +28,59 @@ Ceph configuration file to use with the ``-c`` flag.
 Actions
 =======
 
-.. TODO format this like a proper man page
+**ceph-conf** performs one of the following actions:
 
-**ceph-conf** will perform one of the following actions:
+.. option:: -L, --list-all-sections
 
---list-all-sections or -L prints out a list of all the section names in the configuration
-file.
+   list all sections in the configuration file.
 
---list-sections or -l prints out a list of all the sections that begin
-with a given prefix. For example, --list-sections mon would list all
-sections beginning with mon.
+.. option:: -l, --list-sections *prefix*
 
---lookup will search the configuration for a given value.  By default, the sections  that
-are searched are determined by the Ceph name that we are using. The Ceph name defaults to
-client.admin. It can be specified with --name.
+   list the sections with the given *prefix*. For example, ``--list-sections mon``
+   would list all sections beginning with ``mon``.
 
-For example, if we specify  --name  osd.0,  the  following  sections  will  be  searched:
-[osd.0], [osd], [global]
+.. option:: --lookup *key*
 
-You  can  specify  additional  sections to search with --section or -s.  These additional
-sections will be searched before the sections that would normally be searched. As always,
-the first matching entry we find will be returned.
+   search and print the specified configuration setting. Note:  ``--lookup`` is
+   the default action. If no other actions are given on the command line, we will
+   default to doing a lookup.
 
-Note:  --lookup is the default action. If no other actions are given on the command line,
-we will default to doing a lookup.
+.. option:: -h, --help
+
+   print a summary of usage.
+
+
+Options
+=======
+
+.. option:: -c *conffile*
+
+   the Ceph configuration file.
+
+.. option:: --filter-key *key*
+
+   filter section list to only include sections with given *key* defined.
+
+.. option:: --filter-key-value *key* ``=`` *value*
+
+   filter section list to only include sections with given *key*/*value* pair.
+
+.. option:: --name *type.id*
+
+   the Ceph name in which the sections are searched (default 'client.admin').
+   For example, if we specify ``--name osd.0``, the following sections will be
+   searched: [osd.0], [osd], [global]
+
+.. option:: -r, --resolve-search
+
+   search for the first file that exists and can be opened in the resulted
+   comma delimited search list.
+
+.. option:: -s, --section
+
+   additional sections to search.  These additional sections will be searched
+   before the sections that would normally be searched. As always, the first
+   matching entry we find will be returned.
 
 
 Examples
@@ -65,7 +94,7 @@ To find out what value will mds a use for the "log file" option::
 
         ceph-conf -c foo.conf  --name mds.a "log file"
 
-To list all sections that begin with osd::
+To list all sections that begin with "osd"::
 
         ceph-conf -c foo.conf -l osd
 
@@ -73,6 +102,18 @@ To list all sections::
 
         ceph-conf -c foo.conf -L
 
+To print the path of the "keyring" used by "client.0"::
+
+       ceph-conf --name client.0 -r -l keyring
+
+
+Files
+=====
+
+``/etc/ceph/$cluster.conf``, ``~/.ceph/$cluster.conf``, ``$cluster.conf``
+
+the Ceph configuration files to use if not specified.
+
 
 Availability
 ============