doc: Convert manpages to doc/man/.

Includes various content cleanups: layout of synopsis, layout
of comments in examples, typos.

Signed-off-by: Tommi Virtanen <[email protected]>

doc/man/8/cauthtool.rst

@@ -0,0 +1,140 @@
+=============================================
+ cauthtool -- ceph keyring manipulation tool
+=============================================
+
+.. program:: cauthtool
+
+Synopsis
+========
+
+| **cauthtool** *keyringfile* [ -l | --list ] [ -C | --create-keyring
+  ] [ -p | --print ] [ -n | --name *entityname* ] [ --gen-key ] [ -a |
+  --add-key *base64_key* ] [ --caps *capfils* ] [ -b | --bin ]
+
+
+Description
+===========
+
+**cauthtool** is a utility to create, view, and modify a Ceph keyring
+file. A keyring file stores one or more Ceph authentication keys and
+possibly an associated capability specification. Each key is
+associated with an entity name, of the form
+``{client,mon,mds,osd}.name``.
+
+
+Options
+=======
+
+.. option:: -l, --list
+
+   will list all keys and capabilities present in the keyring
+
+.. option:: -p, --print
+
+   will print an encoded key for the specified entityname. This is
+   suitable for the ``mount -o secret=`` argument
+
+.. option:: -C, --create-keyring
+
+   will create a new keyring, overwriting any existing keyringfile
+
+.. option:: --gen-key
+
+   will generate a new secret key for the specified entityname
+
+.. option:: --add-key
+
+   will add an encoded key to the keyring
+
+.. option:: --cap subsystem capability
+
+   will set the capability for given subsystem
+
+.. option:: --caps capsfile
+
+   will set all of capabilities associated with a given key, for all subsystems
+
+.. option:: -b, --bin
+
+   will create a binary formatted keyring
+
+
+Capabilities
+============
+
+The subsystem is the name of a Ceph subsystem: ``mon``, ``mds``, or
+``osd``.
+
+The capability is a string describing what the given user is allowed
+to do. This takes the form of a comma separated list of allow, deny
+clauses with a permission specifier containing one or more of rwx for
+read, write, and execute permission. The ``allow *`` grants full
+superuser permissions for the given subsystem.
+
+For example::
+
+	# can read, write, and execute objects
+        osd = "allow rwx [pool=foo[,bar]]|[uid=baz[,bay]]"
+
+	# can access mds server
+        mds = "allow"
+
+        # can modify cluster state (i.e., is a server daemon)
+	mon = "allow rwx"
+
+A librados user restricted to a single pool might look like::
+
+        osd = "allow rw pool foo"
+
+A client mounting the file system with minimal permissions would need caps like::
+
+        mds = "allow"
+
+        osd = "allow rw pool=data"
+
+        mon = "allow r"
+
+
+Caps file format
+================
+
+The caps file format consists of zero or more key/value pairs, one per
+line. The key and value are separated by an ``=``, and the value must
+be quoted (with ``'`` or ``"``) if it contains any whitespace. The key
+is the name of the Ceph subsystem (``osd``, ``mds``, ``mon``), and the
+value is the capability string (see above).
+
+
+Example
+=======
+
+To create a new keyring containing a key for client.foo::
+
+        cauthtool -c -n client.foo --gen-key keyring
+
+To associate some capabilities with the key (namely, the ability to
+mount a Ceph filesystem)::
+
+        cauthtool -n client.foo --cap mds 'allow' --cap osd 'allow rw pool=data' --cap mon 'allow r' keyring
+
+To display the contents of the keyring::
+
+        cauthtool -l keyring
+
+When mount a Ceph file system, you can grab the appropriately encoded secret key with::
+
+        mount -t ceph serverhost:/ mountpoint -o name=foo,secret=`cauthtool -p -n client.foo keyring`
+
+
+Availability
+============
+
+**cauthtool** is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at http://ceph.newdream.net/wiki for more
+information.
+
+
+See also
+========
+
+:doc:`ceph <ceph>`\(8)

doc/man/8/cclsinfo.rst

@@ -0,0 +1,47 @@
+===========================================
+ cclsinfo -- show class object information
+===========================================
+
+.. program:: cclsinfo
+
+Synopsis
+========
+
+| **cclsinfo** [ *options* ] ... *filename*
+
+
+Description
+===========
+
+**cclsinfo** can show name, version, and architecture information
+about a specific class object.
+
+
+Options
+=======
+
+.. option:: -n, --name
+
+   Shows the class name
+
+.. option:: -v, --version
+
+   Shows the class version
+
+.. option:: -a, --arch
+
+   Shows the class architecture
+
+
+Availability
+============
+
+**cclsinfo** is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at http://ceph.newdream.net/wiki for more
+information.
+
+
+See also
+========
+
+:doc:`ceph <ceph>`\(8)

doc/man/8/cconf.rst

@@ -0,0 +1,87 @@
+==============================
+ cconf -- ceph conf file tool
+==============================
+
+.. program:: cconf
+
+Synopsis
+========
+
+| **cconf** -c *conffile* --list-all-sections
+| **cconf** -c *conffile* -L
+| **cconf** -c *conffile* -l *prefix*
+| **cconf** *key* -s *section1* ...
+| **cconf** [-s *section* ] --lookup *key*
+| **cconf** [-s *section* ] *key*
+
+
+Description
+===========
+
+**cconf** is a utility for getting information about a ceph
+configuration file. As with most Ceph programs, you can specify which
+Ceph configuration file to use with the ``-c`` flag.
+
+
+Actions
+=======
+
+.. TODO format this like a proper man page
+
+**cconf** will perform one of the following actions:
+
+--list-all-sections or -L prints out a list of all the section names 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.
+
+--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.
+
+For example, if we specify  --name  osd.0,  the  following  sections  will  be  searched:
+[osd.0], [osd], [global]
+
+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.
+
+Note:  --lookup is the default action. If no other actions are given on the command line,
+we will default to doing a lookup.
+
+
+Examples
+========
+
+To find out what value osd 0 will use for the "osd data" option::
+
+        cconf -c foo.conf  --name osd.0 --lookup "osd data"
+
+To find out what value will mds a use for the "log file" option::
+
+        cconf -c foo.conf  --name mds.a "log file"
+
+To list all sections that begin with osd::
+
+        cconf -c foo.conf -l osd
+
+To list all sections::
+
+        cconf -c foo.conf -L
+
+
+Availability
+============
+
+**cconf** is part of the Ceph distributed file system.  Please refer
+to the Ceph wiki at http://ceph.newdream.net/wiki for more
+information.
+
+
+See also
+========
+
+:doc:`ceph <ceph>`\(8),
+:doc:`mkcephfs <mkcephfs>`\(8)

doc/man/8/cdebugpack.rst

@@ -0,0 +1,47 @@
+=========================================
+ cdebugpack -- ceph debug packer utility
+=========================================
+
+.. program:: cdebugpack
+
+Synopsis
+========
+
+| **cdebugpack** [ *options* ] *filename.tar.gz*
+
+
+Description
+===========
+
+**cdebugpack** will build a tarball containing various items that are
+useful for debugging crashes. The resulting tarball can be shared with
+Ceph developers when debugging a problem.
+
+The tarball will include the binaries for cmds, cosd, and cmon, any
+log files, the ceph.conf configuration file, any core files we can
+find, and (if the system is running) dumps of the current osd, mds,
+and pg maps from the monitor.
+
+
+Options
+=======
+
+.. option:: -c ceph.conf, --conf=ceph.conf
+
+   Use *ceph.conf* configuration file instead of the default
+   ``/etc/ceph/ceph.conf`` to determine monitor addresses during
+   startup.
+
+
+Availability
+============
+
+**cdebugpack** is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at http://ceph.newdream.net/wiki for more
+information.
+
+
+See also
+========
+
+:doc:`ceph <ceph>`\(8)