summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorTommi Virtanen <tommi.virtanen@dreamhost.com>2011-09-09 16:25:14 -0700
committerTommi Virtanen <tommi.virtanen@dreamhost.com>2011-09-09 16:26:40 -0700
commit92fa2ff8fcdbb61cf0a052117a183a42583844ee (patch)
tree4da24bab00242f4df803aa3a8db70302600533c1 /man
parent60aea0542385208112223003b5098f8839d8ad02 (diff)
downloadceph-92fa2ff8fcdbb61cf0a052117a183a42583844ee.tar.gz
man: Generate manpages from doc/man.
Keeping the generated files in version control lets us support builds from scratch without requiring the full documentation toolchain to be installed. The files were just copied over from build-doc/output/man, after a ./admin/build-doc call. When redoing this, also take care to remove any roff output if a file was removed from doc/man, and update Makefile.am. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
Diffstat (limited to 'man')
-rw-r--r--man/cauthtool.8233
-rw-r--r--man/cclsinfo.870
-rw-r--r--man/cconf.8172
-rw-r--r--man/cdebugpack.871
-rw-r--r--man/ceph.8156
-rw-r--r--man/cephfs.8153
-rw-r--r--man/cfuse.8104
-rw-r--r--man/cmds.8124
-rw-r--r--man/cmon.898
-rw-r--r--man/cosd.8158
-rw-r--r--man/crbdnamer.867
-rw-r--r--man/crun.870
-rw-r--r--man/crushtool.8189
-rw-r--r--man/csyn.8141
-rw-r--r--man/librados-config.874
-rw-r--r--man/mkcephfs.8196
-rw-r--r--man/monmaptool.8149
-rw-r--r--man/mount.ceph.8318
-rw-r--r--man/obsync.8238
-rw-r--r--man/osdmaptool.8126
-rw-r--r--man/rados.8227
-rw-r--r--man/radosgw.8123
-rw-r--r--man/radosgw_admin.8205
-rw-r--r--man/rbd.8247
24 files changed, 2522 insertions, 1187 deletions
diff --git a/man/cauthtool.8 b/man/cauthtool.8
index a2b4c174de6..3abbba34326 100644
--- a/man/cauthtool.8
+++ b/man/cauthtool.8
@@ -1,106 +1,187 @@
-.TH CAUTHTOOL 8
+.TH "CAUTHTOOL" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
cauthtool \- ceph keyring manipulation tool
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B cauthtool
-\fIkeyringfile\fP
-[ \fB\-l\fR | \fB\-\-list\fR ]
-[ \fB\-C\fR | \fB\-\-create-keyring\fR ]
-[ \fB\-p\fR | \fB\-\-print\fR ]
-[ \fB\-n\fR | \fB\-\-name\fR \fIentityname\fP ]
-[ \fB\-\-gen-key\fR ]
-[ \fB\-a\fR | \fB\-\-add-key \fIbase64_key\fP ]
-[ \fB\-\-caps\fR \fIcapfils\fP ]
-[ \fB\-b\fR | \fB\-\-bin\fR ]
+.nf
+\fBcauthtool\fP \fIkeyringfile\fP [ \-l | \-\-list ] [ \-C | \-\-create\-keyring
+] [ \-p | \-\-print ] [ \-n | \-\-name \fIentityname\fP ] [ \-\-gen\-key ] [ \-a |
+\-\-add\-key \fIbase64_key\fP ] [ \-\-caps \fIcapfils\fP ] [ \-b | \-\-bin ]
+.fi
+.sp
.SH DESCRIPTION
-.B 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 \fI{client,mon,mds,osd}.name\fP.
+.sp
+\fBcauthtool\fP 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
+\fB{client,mon,mds,osd}.name\fP.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-l\fP, \fB\-\-list\fP
+.B \-l, \-\-list
will list all keys and capabilities present in the keyring
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-p\fP, \fB\-\-print\fP
-will print an encoded key for the specified \fIentityname\fP. This is suitable for the mount -o secret= argument
+.B \-p, \-\-print
+will print an encoded key for the specified entityname. This is
+suitable for the \fBmount \-o secret=\fP argument
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-C\fP, \fB\-\-create-keyring\fP
-will create a new keyring, overwriting any existing \fIkeyringfile\fP
+.B \-C, \-\-create\-keyring
+will create a new keyring, overwriting any existing keyringfile
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-gen\-key\fP
-will generate a new secret key for the specified \fIentityname\fP
+.B \-\-gen\-key
+will generate a new secret key for the specified entityname
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-add\-key\fP
+.B \-\-add\-key
will add an encoded key to the keyring
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-cap\fI subsystem capability \fP
+.B \-\-cap subsystem capability
will set the capability for given subsystem
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-caps\fI capsfile \fP
+.B \-\-caps capsfile
will set all of capabilities associated with a given key, for all subsystems
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-b\fP, \fB\-\-bin\fP
+.B \-b, \-\-bin
will create a binary formatted keyring
-
+.UNINDENT
.SH CAPABILITIES
+.sp
+The subsystem is the name of a Ceph subsystem: \fBmon\fP, \fBmds\fP, or
+\fBosd\fP.
+.sp
+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 \fBallow *\fP grants full
+superuser permissions for the given subsystem.
+.sp
+For example:
+.sp
+.nf
+.ft C
+# can read, write, and execute objects
+osd = "allow rwx [pool=foo[,bar]]|[uid=baz[,bay]]"
-The \fIsubsystem\fP is the name of a Ceph subsystem: mon, mds, or osd.
-.PP
-The \fIcapability\fP 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 \fIrwx\fP for read, write, and execute permission. The "allow *" grants
-full superuser permissions for the given subsystem.
-.PP
-For example,
+# can access mds server
+mds = "allow"
-.IP
-osd = "allow rwx [pool=foo[,bar]]|[uid=baz[,bay]]" # can read, write, and execute objects
-.IP
-mds = "allow" # can access mds server
-.IP
-mon = "allow rwx" # can modify cluster state (i.e., is a server daemon)
-.PP
-A librados user restricted to a single pool might look like
-.IP
+# can modify cluster state (i.e., is a server daemon)
+mon = "allow rwx"
+.ft P
+.fi
+.sp
+A librados user restricted to a single pool might look like:
+.sp
+.nf
+.ft C
osd = "allow rw pool foo"
-.PP
-A client mounting the file system with minimal permissions would need caps like
-.IP
+.ft P
+.fi
+.sp
+A client mounting the file system with minimal permissions would need caps like:
+.sp
+.nf
+.ft C
mds = "allow"
-.IP
+
osd = "allow rw pool=data"
-.IP
-mon = "allow r"
-.PP
+mon = "allow r"
+.ft P
+.fi
.SH 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).
-
+.sp
+The caps file format consists of zero or more key/value pairs, one per
+line. The key and value are separated by an \fB=\fP, and the value must
+be quoted (with \fB\(aq\fP or \fB"\fP) if it contains any whitespace. The key
+is the name of the Ceph subsystem (\fBosd\fP, \fBmds\fP, \fBmon\fP), and the
+value is the capability string (see above).
.SH EXAMPLE
-To create a new keyring containing a key for \fIclient.foo\fP:
-.IP
-cauthtool -c -n client.foo --gen-key keyring
-.PP
-To associate some capabilities with the key (namely, the ability to mount a Ceph filesystem):
-.IP
-cauthtool -n client.foo --cap mds 'allow' --cap osd 'allow rw pool=data' --cap mon 'allow r' keyring
-.PP
+.sp
+To create a new keyring containing a key for client.foo:
+.sp
+.nf
+.ft C
+cauthtool \-c \-n client.foo \-\-gen\-key keyring
+.ft P
+.fi
+.sp
+To associate some capabilities with the key (namely, the ability to
+mount a Ceph filesystem):
+.sp
+.nf
+.ft C
+cauthtool \-n client.foo \-\-cap mds \(aqallow\(aq \-\-cap osd \(aqallow rw pool=data\(aq \-\-cap mon \(aqallow r\(aq keyring
+.ft P
+.fi
+.sp
To display the contents of the keyring:
-.IP
-cauthtool -l keyring
-.PP
-When mount a Ceph file system, you can grab the appropriately encoded secret key with
-.IP
-mount -t ceph serverhost:/ mountpoint -o name=foo,secret=`cauthtool -p -n client.foo keyring`
-.PP
+.sp
+.nf
+.ft C
+cauthtool \-l keyring
+.ft P
+.fi
+.sp
+When mount a Ceph file system, you can grab the appropriately encoded secret key with:
+.sp
+.nf
+.ft C
+mount \-t ceph serverhost:/ mountpoint \-o name=foo,secret=\(gacauthtool \-p \-n client.foo keyring\(ga
+.ft P
+.fi
.SH AVAILABILITY
-.B cauthtool
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcauthtool\fP is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8)
+.sp
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/cclsinfo.8 b/man/cclsinfo.8
index 222592f2f11..204292d8282 100644
--- a/man/cclsinfo.8
+++ b/man/cclsinfo.8
@@ -1,26 +1,70 @@
-.TH CCLSINFO 8
+.TH "CCLSINFO" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
cclsinfo \- show class object information
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B cclsinfo
-[ \fIoptions\fR ] ... \fIfilename\fR
+.nf
+\fBcclsinfo\fP [ \fIoptions\fP ] ... \fIfilename\fP
+.fi
+.sp
.SH DESCRIPTION
-.B cclsinfo
-can show name, version, and architecture information about a specific class object.
+.sp
+\fBcclsinfo\fP can show name, version, and architecture information
+about a specific class object.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-n\fP, \fB\-\-name\fP
+.B \-n, \-\-name
Shows the class name
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-v\fP, \fB\-\-version\fP
+.B \-v, \-\-version
Shows the class version
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-a\fP, \fB\-\-arch\fP
+.B \-a, \-\-arch
Shows the class architecture
+.UNINDENT
.SH AVAILABILITY
-.B cclsinfo
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcclsinfo\fP is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR cclass (8)
-.BR ceph (8)
+.sp
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/cconf.8 b/man/cconf.8
index cb3d18a734c..f3e45fa3876 100644
--- a/man/cconf.8
+++ b/man/cconf.8
@@ -1,76 +1,118 @@
-.TH CCONF 8
+.TH "CCONF" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
cconf \- ceph conf file tool
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B cconf
-\fB\-c \fIconffile\fR \fB\--list-all-sections
-.br
-.B cconf
-\fB\-c \fIconffile\fR \fB\-L
-.br
-.B cconf
-\fB\-c \fIconffile\fR \fB\-l \fIprefix\fR
-.br
-.B cconf
-\fIkey\fR \fB\-s \fIsection1\fR ...
-.br
-.B cconf
-[\fB-s\fR \fIsection\fR] \fB--lookup\fR \fIkey\fR
-.br
-.B cconf
-[\fB-s\fR \fIsection\fR] \fIkey\fR
-.br
+.nf
+\fBcconf\fP \-c \fIconffile\fP \-\-list\-all\-sections
+\fBcconf\fP \-c \fIconffile\fP \-L
+\fBcconf\fP \-c \fIconffile\fP \-l \fIprefix\fP
+\fBcconf\fP \fIkey\fP \-s \fIsection1\fP ...
+\fBcconf\fP [\-s \fIsection\fP ] \-\-lookup \fIkey\fP
+\fBcconf\fP [\-s \fIsection\fP ] \fIkey\fP
+.fi
+.sp
.SH DESCRIPTION
-.B 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 \fB-c\fR flag.
-.PP
+.sp
+\fBcconf\fP 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 \fB\-c\fP flag.
.SH ACTIONS
-\fBcconf\fR will perform one of the following actions:
-.PP
-\fB--list-all-sections\fR or \fB-L\fR prints out a list of all the section
-names in the configuration file.
-.PP
-\fB--list-sections\fR or \fB-l\fR prints out a list of all the sections that
-begin with a given prefix. For example, \fB--list-sections \fImon\fR\fR would list all
-sections beginning with \fImon\fR.
-.PP
-\fB--lookup\fR 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 \fB--name\fR.
-.PP
-For example, if we specify \fB--name\fR \fIosd.0\fR, the following sections will be
-searched: \fI[osd.0], [osd], [global]\fR
-.PP
-You can specify additional sections to search with \fB--section\fR or \fB-s\fR.
-These additional sections will be searched \fIbefore\fR the sections that would
-normally be searched. As always, the first matching entry we find will be returned.
-.PP
-Note: \fB--lookup\fR is the default action. If no other actions are given on the
-command line, we will default to doing a lookup.
-.PP
+.sp
+\fBcconf\fP will perform one of the following actions:
+.sp
+\-\-list\-all\-sections or \-L prints out a list of all the section names in the configuration
+file.
+.sp
+\-\-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.
+.sp
+\-\-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.
+.sp
+For example, if we specify \-\-name osd.0, the following sections will be searched:
+[osd.0], [osd], [global]
+.sp
+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.
+.sp
+Note: \-\-lookup is the default action. If no other actions are given on the command line,
+we will default to doing a lookup.
.SH EXAMPLES
+.sp
To find out what value osd 0 will use for the "osd data" option:
-.IP
-cconf -c foo.conf --name osd.0 --lookup "osd data"
-.PP
+.sp
+.nf
+.ft C
+cconf \-c foo.conf \-\-name osd.0 \-\-lookup "osd data"
+.ft P
+.fi
+.sp
To find out what value will mds a use for the "log file" option:
-.IP
-cconf -c foo.conf --name mds.a "log file"
-.PP
-To list all sections that begin with \fIosd\fP:
-.IP
-cconf -c foo.conf -l osd
-.PP
+.sp
+.nf
+.ft C
+cconf \-c foo.conf \-\-name mds.a "log file"
+.ft P
+.fi
+.sp
+To list all sections that begin with osd:
+.sp
+.nf
+.ft C
+cconf \-c foo.conf \-l osd
+.ft P
+.fi
+.sp
To list all sections:
-.IP
-cconf -c foo.conf -L
-.PP
+.sp
+.nf
+.ft C
+cconf \-c foo.conf \-L
+.ft P
+.fi
.SH AVAILABILITY
-.B cconf
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcconf\fP is part of the Ceph distributed file system. Please refer
+to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8),
-.BR mkcephfs (8)
+.sp
+\fBceph\fP(8),
+\fBmkcephfs\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/cdebugpack.8 b/man/cdebugpack.8
index e56dc93c569..7cf3aa7f378 100644
--- a/man/cdebugpack.8
+++ b/man/cdebugpack.8
@@ -1,27 +1,68 @@
-.TH CDEBUGPACK 8
+.TH "CDEBUGPACK" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
cdebugpack \- ceph debug packer utility
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B cdebugpack
-[ \fIoptions\fR ] \fIfilename.tar.gz\fR
+.nf
+\fBcdebugpack\fP [ \fIoptions\fP ] \fIfilename.tar.gz\fP
+.fi
+.sp
.SH DESCRIPTION
-.B 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.
-.P
+.sp
+\fBcdebugpack\fP 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.
+.sp
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.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during
+startup.
+.UNINDENT
.SH AVAILABILITY
-.B cdebugpack
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcdebugpack\fP is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8)
+.sp
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/ceph.8 b/man/ceph.8
index 8c27c80c5d0..9add8c48efa 100644
--- a/man/ceph.8
+++ b/man/ceph.8
@@ -1,61 +1,127 @@
-.TH CEPH 8
+.TH "CEPH" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
ceph \- ceph file system control utility
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B ceph
-[ \fB\-m\fI monaddr\fR ]
-[ \fB\-w\fP | \fIcommand ...\fR ]
+.nf
+\fBceph\fP [ \-m \fImonaddr\fP ] [ \-w | \fIcommand\fP ... ]
+.fi
+.sp
.SH DESCRIPTION
-.B ceph
-is a control utility for communicating with the monitor cluster of a running
-Ceph distributed file system.
-.PP
+.sp
+\fBceph\fP is a control utility for communicating with the monitor
+cluster of a running Ceph distributed file system.
+.sp
There are three basic modes of operation.
-.SH INTERACTIVE MODE
-To start in interactive
-mode, no arguments are necessary. Control-d or 'quit' will exit.
-.SH WATCH MODE
-To watch cluster state changes in real time,
-starting in \fB\-w\fP (watch) mode will print updates to stdout as they occur. For example,
-to keep an eye on cluster state,
-.IP
-ceph -C ceph.conf -w
-.SH COMMAND LINE MODE
-Finally, to send a single instruction to the monitor cluster (and wait for a
-response), the command can be specified on the command line.
+.SS Interactive mode
+.sp
+To start in interactive mode, no arguments are necessary. Control\-d or
+\(aqquit\(aq will exit.
+.SS Watch mode
+.sp
+To watch cluster state changes in real time, starting in \-w (watch)
+mode will print updates to stdout as they occur. For example, to keep
+an eye on cluster state, run:
+.sp
+.nf
+.ft C
+ceph \-C ceph.conf \-w
+.ft P
+.fi
+.SS Command line mode
+.sp
+Finally, to send a single instruction to the monitor cluster (and wait
+for a response), the command can be specified on the command line.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-i \fIinfile\fP
-will specify an input file to be passed along as a payload with the \fIcommand\fP to the
-monitor cluster. This is only used for specific monitor commands.
+.B \-i infile
+will specify an input file to be passed along as a payload with the
+command to the monitor cluster. This is only used for specific
+monitor commands.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-o \fIoutfile\fP
-will write any payload returned by the monitor cluster with its reply to \fIoutfile\fP.
-Only specific monitor commands (e.g. \fIosd getmap\fP) return a payload.
+.B \-o outfile
+will write any payload returned by the monitor cluster with its
+reply to outfile. Only specific monitor commands (e.g. osd getmap)
+return a payload.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
+.B \-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.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through ceph.conf).
+.UNINDENT
.SH EXAMPLES
+.sp
To grab a copy of the current OSD map:
-.IP
-ceph -m 1.2.3.4:6789 osd getmap -o osdmap
-.PP
+.sp
+.nf
+.ft C
+ceph \-m 1.2.3.4:6789 osd getmap \-o osdmap
+.ft P
+.fi
+.sp
To get a dump of placement group (PG) state:
-.IP
-ceph pg dump -o pg.txt
+.sp
+.nf
+.ft C
+ceph pg dump \-o pg.txt
+.ft P
+.fi
.SH MONITOR COMMANDS
-A more complete summary of commands understood by the monitor cluster can be found
-in the wiki, at
-.IP
-http://ceph.newdream.net/wiki/Monitor_commands
+.sp
+A more complete summary of commands understood by the monitor cluster can be found in the
+wiki, at
+.INDENT 0.0
+.INDENT 3.5
+\fI\%http://ceph.newdream.net/wiki/Monitor_commands\fP
+.UNINDENT
+.UNINDENT
.SH AVAILABILITY
-.B ceph
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBceph\fP is part of the Ceph distributed file system. Please refer to the Ceph wiki at
+\fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
-.BR ceph (8),
-.BR mkcephfs (8)
+.sp
+\fBceph\fP(8),
+\fBmkcephfs\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/cephfs.8 b/man/cephfs.8
index 409c37bf559..a497a364b65 100644
--- a/man/cephfs.8
+++ b/man/cephfs.8
@@ -1,68 +1,119 @@
-.TH CEPHFS 8
+.TH "CEPHFS" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
cephfs \- ceph file system options utility
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B cephfs
-[ \fIpath \fIcommand \fBoptions]
+.nf
+\fBcephfs\fP [ \fIpath\fP \fIcommand\fP \fIoptions\fP ]
+.fi
+.sp
.SH DESCRIPTION
-.B cephfs
-is a control utility for accessing and manipulating file layout
-and location data in the Ceph distributed file system.
-
+.sp
+\fBcephfs\fP is a control utility for accessing and manipulating file
+layout and location data in the Ceph distributed file system.
+.sp
Choose one of the following three commands:
-.TP
-\fBshow_layout \fPView the layout information on a file or directory
-.TP
-\fBset_layout \fPSet the layout information on a file or directory.
-.TP
-\fBshow_location \fPView the location information on a file
-
+.INDENT 0.0
+.IP \(bu 2
+\fBshow_layout\fP View the layout information on a file or directory
+.IP \(bu 2
+\fBset_layout\fP Set the layout information on a file or directory
+.IP \(bu 2
+\fBshow_location\fP View the location information on a file
+.UNINDENT
.SH OPTIONS
-Your applicable options differ depending on whether you are setting
-or viewing layout/location.
+.sp
+Your applicable options differ depending on whether you are setting or viewing layout/location.
+.SS Viewing options:
+.INDENT 0.0
.TP
-\fBViewing options:
-.IP
-\fB\-l \--offset
-\fPSpecify an offset for which to retrieve location data
-
+.B \-l \-\-offset
+Specify an offset for which to retrieve location data
+.UNINDENT
+.SS Setting options:
+.INDENT 0.0
.TP
-\fBSetting options:
-.IP
-\fB\-u
-\--stripe_unit \fP
+.B \-u \-\-stripe_unit
Set the size of each stripe
-.IP
-\fB\-c
-\--stripe_count \fP
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-c \-\-stripe_count
Set the number of stripes per object
-.IP
-\fB\-s
-\--object_size \fP
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-s \-\-object_size
Set the size of the objects to stripe across
-.IP
-\fB\-p
-\--pool \fP
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-p \-\-pool
Set the pool (by numeric value, not name!) to use
-.IP
-\fB\-o
-\--osd \fP
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-o \-\-osd
Set the preferred OSD to use as the primary
-
+.UNINDENT
.SH LIMITATIONS
+.sp
When setting layout data, the specified stripe unit and stripe count
-must multiply to the size of an object. Any parameters you don't set explicitly are left at the system defaults.
-
-Obviously setting the layout of a file and a directory means different things.
-Setting the layout of a file specifies exactly how to place the individual file. This must be done before writing *any* data to it. Truncating a file does not allow you to change the layout either.
-
-Setting the layout of a directory sets the "default layout", which is used to set the file layouts on any files subsequently created in the directory (or any subdirectory). Pre-existing files do not have their layouts changed.
-
-You'll notice that the layout information allows you to specify a preferred OSD for placement. This is allowed but is not recommended since it can dramatically unbalance your storage cluster's space utilization.
-
+must multiply to the size of an object. Any parameters you don\(aqt set
+explicitly are left at the system defaults.
+.sp
+Obviously setting the layout of a file and a directory means different
+things. Setting the layout of a file specifies exactly how to place
+the individual file. This must be done before writing \fIany\fP data to
+it. Truncating a file does not allow you to change the layout either.
+.sp
+Setting the layout of a directory sets the "default layout", which is
+used to set the file layouts on any files subsequently created in the
+directory (or any subdirectory). Pre\-existing files do not have their
+layouts changed.
+.sp
+You\(aqll notice that the layout information allows you to specify a
+preferred OSD for placement. This is allowed but is not recommended
+since it can dramatically unbalance your storage cluster\(aqs space
+utilization.
.SH AVAILABILITY
-.B cephfs
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcephfs\fP is part of the Ceph distributed file system. Please refer
+to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8)
+.sp
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/cfuse.8 b/man/cfuse.8
index e51b751365a..50f0f39154d 100644
--- a/man/cfuse.8
+++ b/man/cfuse.8
@@ -1,42 +1,90 @@
-.TH CFUSE 8
+.TH "CFUSE" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
cfuse \- FUSE-based client for ceph
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B cfuse
-[ \fB\-m monaddr:port\fP ]
-\fImountpoint\fP
-[ \fIfuse options\fP ]
+.nf
+\fBcfuse\fP [ \-m \fImonaddr\fP:\fIport\fP ] \fImountpoint\fP [ \fIfuse options\fP ]
+.fi
+.sp
.SH DESCRIPTION
-.B cfuse
-is a FUSE (File system in USErspace) client for Ceph distributed
-file system. It will mount a ceph file system (specified via the
-\fB\-m\fP option for described by \fIceph.conf\fP (see below) at
-the specific mount point.
-.PP
+.sp
+\fBcfuse\fP is a FUSE (File system in USErspace) client for Ceph
+distributed file system. It will mount a ceph file system (specified
+via the \-m option for described by ceph.conf (see below) at the
+specific mount point.
+.sp
The file system can be unmounted with:
-.IP
-fusermount -u \fImountpoint\fP
-.PP
-or by sending SIGINT to the \fBcfuse\fP process.
+.sp
+.nf
+.ft C
+fusermount \-u mountpoint
+.ft P
+.fi
+.sp
+or by sending \fBSIGINT\fP to the \fBcfuse\fP process.
.SH OPTIONS
-Any options not recognized by \fBcfuse\fP will be passed on to libfuse.
+.sp
+Any options not recognized by cfuse will be passed on to libfuse.
+.INDENT 0.0
.TP
-\fB\-d\fP
+.B \-d
Detach from console and daemonize after startup.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through ceph.conf).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-r\fI root_directory\fR
+.B \-r root_directory
Use root_directory as the mounted root, rather than the full Ceph tree.
+.UNINDENT
.SH AVAILABILITY
-.B cfuse
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcfuse\fP is part of the Ceph distributed file system. Please refer to
+the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
-.BR fusermount (8),
-.BR ceph (8)
+.sp
+fusermount(8),
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/cmds.8 b/man/cmds.8
index 25822e1a3b0..efec2678b99 100644
--- a/man/cmds.8
+++ b/man/cmds.8
@@ -1,51 +1,95 @@
-.TH CMDS 8
+.TH "CMDS" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
cmds \- ceph metadata server daemon
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B cmds
-\fB\-i \fIname\fR
-[[ \fB\-\-hot-standby\fI [rank]\fR ]|[\fB\-\-journal_check\fI rank\fR]]
-
+.nf
+\fBcmds\fP \-i \fIname\fP [[ \-\-hot\-standby [\fIrank\fP] ]|[\-\-journal_check \fIrank\fP]]
+.fi
+.sp
.SH DESCRIPTION
-.B cmds
-is the metadata server daemon for the Ceph distributed file system.
-One or more instances of \fBcmds\fP collectively manage the file system
-namespace, coordinating access to the shared OSD cluster.
-.PP
-Each
-.B cmds
-daemon instance should have a unique \fIname\fP. The name is used
-to identify daemon instances in the \fIceph.conf\fP.
-.PP
-Once the daemon has started, the monitor cluster will normally assign it
-a logical rank, or put it in a standby pool to take over for another daemon
-that crashes. Some of the specified options can cause other behaviors.
-.PP
-If you specify hot-standby or journal-check, you must either specify the rank
-on the command line, or specify one of the mds_standby_for_[rank|name]
-parameters in the config. The command line specification overrides the config,
-and specifying the rank overrides specifying the name.
-
+.sp
+\fBcmds\fP is the metadata server daemon for the Ceph distributed file
+system. One or more instances of cmds collectively manage the file
+system namespace, coordinating access to the shared OSD cluster.
+.sp
+Each cmds daemon instance should have a unique name. The name is used
+to identify daemon instances in the ceph.conf.
+.sp
+Once the daemon has started, the monitor cluster will normally assign
+it a logical rank, or put it in a standby pool to take over for
+another daemon that crashes. Some of the specified options can cause
+other behaviors.
+.sp
+If you specify hot\-standby or journal\-check, you must either specify
+the rank on the command line, or specify one of the
+mds_standby_for_[rank|name] parameters in the config. The command
+line specification overrides the config, and specifying the rank
+overrides specifying the name.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-f\fP, \fB\-\-foreground\fP
-Foreground: do not daemonize after startup (run in foreground).
-Do not generate a pid file. Useful when run via crun (8).
+.B \-f, \-\-foreground
+Foreground: do not daemonize after startup (run in foreground). Do
+not generate a pid file. Useful when run via \fBcrun\fP(8).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-d\fP
-Debug mode: like -f, but also send all log output to stderr.
+.B \-d
+Debug mode: like \fB\-f\fP, but also send all log output to stderr.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during
+startup.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through
+\fBceph.conf\fP).
+.UNINDENT
.SH AVAILABILITY
-.B cmon
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcmon\fP is part of the Ceph distributed file system. Please refer to the Ceph wiki at
+\fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
-.BR ceph (8),
-.BR cmon (8),
-.BR cosd (8)
+.sp
+\fBceph\fP(8),
+\fBcmon\fP(8),
+\fBcosd\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/cmon.8 b/man/cmon.8
index a0d4db35a60..4ab94374585 100644
--- a/man/cmon.8
+++ b/man/cmon.8
@@ -1,38 +1,80 @@
-.TH CMON 8
+.TH "CMON" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
cmon \- ceph monitor daemon
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B cmon
-\fB\-i \fImonid\fR
-[ \fB\-\-mon\-data mondatapath\fR ]
+.nf
+\fBcmon\fP \-i \fImonid\fP [ \-\-mon\-data \fImondatapath\fP ]
+.fi
+.sp
.SH DESCRIPTION
-.B cmon
-is the cluster monitor daemon for the Ceph distributed file system.
-One or more instances
-of \fBcmon\fP form a Paxos part-time parliament cluster that provides
-extremely reliable and durable storage of cluster membership, configuration,
-and state.
-.PP
-The \fImondatapath\fP refers to a directory on a local file system
-storing monitor data. It is normally specified via the "mon data" option
-in the configuration file.
+.sp
+\fBcmon\fP is the cluster monitor daemon for the Ceph distributed file
+system. One or more instances of \fBcmon\fP form a Paxos part\-time
+parliament cluster that provides extremely reliable and durable
+storage of cluster membership, configuration, and state.
+.sp
+The \fImondatapath\fP refers to a directory on a local file system storing
+monitor data. It is normally specified via the \fBmon data\fP option in
+the configuration file.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-f\fP, \fB\-\-foreground\fP
-Foreground: do not daemonize after startup (run in foreground).
-Do not generate a pid file. Useful when run via crun (8).
+.B \-f, \-\-foreground
+Foreground: do not daemonize after startup (run in foreground). Do
+not generate a pid file. Useful when run via \fBcrun\fP(8).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-d\fP
-Debug mode: like -f, but also send all log output to stderr.
+.B \-d
+Debug mode: like \fB\-f\fP, but also send all log output to stderr.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during
+startup.
+.UNINDENT
.SH AVAILABILITY
-.B cmon
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcmon\fP is part of the Ceph distributed file system. Please refer to
+the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
-.BR ceph (8),
-.BR cmds (8),
-.BR cosd (8)
+.sp
+\fBceph\fP(8),
+\fBcmds\fP(8),
+\fBcosd\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/cosd.8 b/man/cosd.8
index 59f6ae2d583..79d9839bd40 100644
--- a/man/cosd.8
+++ b/man/cosd.8
@@ -1,70 +1,126 @@
-.TH COSD 8
+.TH "COSD" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
cosd \- ceph object storage daemon
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B cosd
-\fB\-i \fIosdnum\fR
-[ \fB\-\-osd\-data \fIdatapath\fR ]
-[ \fB\-\-osd\-journal \fIjournal\fR ]
-[ \fB\-\-mkfs\fR ]
-[ \fB\-\-mkjournal\fR ]
-[ \fB\-\-mkkey\fR ]
+.nf
+\fBcosd\fP \-i \fIosdnum\fP [ \-\-osd\-data \fIdatapath\fP ] [ \-\-osd\-journal
+\fIjournal\fP ] [ \-\-mkfs ] [ \-\-mkjournal ] [ \-\-mkkey ]
+.fi
+.sp
.SH DESCRIPTION
-.B cosd
-is the object storage daemon for the Ceph distributed file system.
-It is responsible for storing objects on a local file system and
-providing access to them over the network.
-.PP
-The \fIdatapath\fP argument should be a directory on a btrfs file
-system where the object data resides. The \fIjournal\fP is optional,
-and is only useful performance-wise when it resides on a different
-disk than \fIdatapath\fP with low latency (ideally, an NVRAM device).
+.sp
+\fBcosd\fP is the object storage daemon for the Ceph distributed file
+system. It is responsible for storing objects on a local file system
+and providing access to them over the network.
+.sp
+The datapath argument should be a directory on a btrfs file system
+where the object data resides. The journal is optional, and is only
+useful performance\-wise when it resides on a different disk than
+datapath with low latency (ideally, an NVRAM device).
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-f\fP, \fB\-\-foreground\fP
-Foreground: do not daemonize after startup (run in foreground).
-Do not generate a pid file. Useful when run via crun (8).
+.B \-f, \-\-foreground
+Foreground: do not daemonize after startup (run in foreground). Do
+not generate a pid file. Useful when run via \fBcrun\fP(8).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-d\fP
-Debug mode: like -f, but also send all log output to stderr.
+.B \-d
+Debug mode: like \fB\-f\fP, but also send all log output to stderr.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-osd\-data \fIosddata\fP
+.B \-\-osd\-data osddata
Use object store at \fIosddata\fP.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-osd\-journal \fIjournal\fP
+.B \-\-osd\-journal journal
Journal updates to \fIjournal\fP.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-mkfs\fP
-Create an empty object repository. Normally invoked by
-.BR mkcephfs
-(8). This also initializes the jouranl (if one is defined).
+.B \-\-mkfs
+Create an empty object repository. Normally invoked by
+\fBmkcephfs\fP(8). This also initializes the journal
+(if one is defined).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-mkkey\fP
-Generate a new secret key. This is normally used in combination with \fB\-\-mkfs\fR
-as it is more convenient than generating a key by hand with \fIcauthtool\fR.
+.B \-\-mkkey
+Generate a new secret key. This is normally used in combination
+with \fB\-\-mkfs\fP as it is more convenient than generating a key by
+hand with \fBcauthtool\fP(8).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-mkjournal\fP
-Create a new journal file to match an existing object repository. This is useful if the journal
-device or file is wiped out due to a disk or file system failure.
+.B \-\-mkjournal
+Create a new journal file to match an existing object repository.
+This is useful if the journal device or file is wiped out due to a
+disk or file system failure.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-flush-journal
-Flush the journal to permanent store. This runs in the foreground so you
-know when it's completed.
-This can be useful if you want to resize the journal or need to otherwise
-destroy it: this guarantees you won't lose data.
+.B \-\-flush\-journal
+Flush the journal to permanent store. This runs in the foreground
+so you know when it\(aqs completed. This can be useful if you want to
+resize the journal or need to otherwise destroy it: this guarantees
+you won\(aqt lose data.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-for runtime configuration options.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP for runtime configuration options.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through
+\fBceph.conf\fP).
+.UNINDENT
.SH AVAILABILITY
-.B cosd
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcosd\fP is part of the Ceph distributed file system. Please refer to
+the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
-.BR ceph (8),
-.BR cmds (8),
-.BR cmon (8),
-.BR cauthtool (8)
+.sp
+\fBceph\fP(8),
+\fBcmds\fP(8),
+\fBcmon\fP(8),
+\fBcauthtool\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/crbdnamer.8 b/man/crbdnamer.8
index fe4b16befd9..0f7d349df57 100644
--- a/man/crbdnamer.8
+++ b/man/crbdnamer.8
@@ -1,17 +1,62 @@
-.TH CRBDNAMER 8
+.TH "CRBDNAMER" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
crbdnamer \- udev helper to name RBD devices
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B crbdnamer \fInum\fR
+.nf
+\fBcrbdnamer\fP \fInum\fP
+.fi
+.sp
.SH DESCRIPTION
-.B crbdnamer
-prints the pool and image name for the given RBD devices to stdout. It is used by udev (using a rule like the one below) to set up a device symlink.
-.IP
-KERNEL=="rbd[0-9]*", PROGRAM="/usr/bin/crbdnamer %n", SYMLINK+="rbd/%c{1}/%c{2}:%n"
+.sp
+\fBcrbdnamer\fP prints the pool and image name for the given RBD devices
+to stdout. It is used by \fIudev\fP (using a rule like the one below) to
+set up a device symlink.
+.sp
+.nf
+.ft C
+KERNEL=="rbd[0\-9]*", PROGRAM="/usr/bin/crbdnamer %n", SYMLINK+="rbd/%c{1}/%c{2}:%n"
+.ft P
+.fi
.SH AVAILABILITY
-.B crbdnamer
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcrbdnamer\fP is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR rbd (8)
-.BR ceph (8)
+.sp
+\fBrbd\fP(8),
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/crun.8 b/man/crun.8
index a031d60ad5a..37975efffd9 100644
--- a/man/crun.8
+++ b/man/crun.8
@@ -1,25 +1,63 @@
-.TH CRUN 8
+.TH "CRUN" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
crun \- restart daemon on core dump
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B crun
-\fIcommand ...\fP
+.nf
+\fBcrun\fP \fIcommand\fP ...
+.fi
+.sp
.SH DESCRIPTION
-.B crun
-is a simple wrapper that will restart a daemon if it exits with
-a signal indicating it crashed and possibly core dumped (that is,
+.sp
+\fBcrun\fP is a simple wrapper that will restart a daemon if it exits
+with a signal indicating it crashed and possibly core dumped (that is,
signals 3, 4, 5, 6, 8, or 11).
-.PP
-The \fIcommand\fP should run the daemon in the foreground. For
-Ceph daemons, that means the \fB-f\fP option.
+.sp
+The command should run the daemon in the foreground. For Ceph daemons,
+that means the \fB\-f\fP option.
.SH OPTIONS
+.sp
None
.SH AVAILABILITY
-.B crun
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcrun\fP is part of the Ceph distributed file system. Please refer to
+the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
-.BR ceph (8),
-.BR cmon (8),
-.BR cmds (8),
-.BR cosd (8)
+.sp
+\fBceph\fP(8),
+\fBcmon\fP(8),
+\fBcmds\fP(8),
+\fBcosd\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/crushtool.8 b/man/crushtool.8
index a4dbd1d8b06..67e54978e6a 100644
--- a/man/crushtool.8
+++ b/man/crushtool.8
@@ -1,73 +1,148 @@
-.TH CRUSHTOOL 8
+.TH "CRUSHTOOL" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
crushtool \- CRUSH map manipulation tool
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B crushtool
-( \fB\-d\fI map\fP | \fB\-c\fI map.txt\fP | \fB\-\-build\fI numosds layer1 ...\fP )
-[ \fB\-o\fI outfile\fP [ \fB\-\-clobber\fP ]]
+.nf
+\fBcrushtool\fP ( \-d \fImap\fP | \-c \fImap.txt\fP | \-\-build \fInumosds\fP
+\fIlayer1\fP \fI...\fP ) [ \-o \fIoutfile\fP [ \-\-clobber ]]
+.fi
+.sp
.SH DESCRIPTION
-.B crushtool
-is a utility that lets you create, compile, and decompile CRUSH map files.
-.PP
-CRUSH is a pseudo-random data distribution algorithm that efficiently maps
-input values (typically data objects) across a heterogeneous, hierarchically
-structured device map. The algorithm was originally described in detail in
-the following paper (although it has evolved some since then):
-.IP
-http://www.ssrc.ucsc.edu/Papers/weil-sc06.pdf
-.PP
+.sp
+\fBcrushtool\fP is a utility that lets you create, compile, and
+decompile CRUSH map files.
+.sp
+CRUSH is a pseudo\-random data distribution algorithm that efficiently
+maps input values (typically data objects) across a heterogeneous,
+hierarchically structured device map. The algorithm was originally
+described in detail in the following paper (although it has evolved
+some since then):
+.INDENT 0.0
+.INDENT 3.5
+\fI\%http://www.ssrc.ucsc.edu/Papers/weil-sc06.pdf\fP
+.UNINDENT
+.UNINDENT
+.sp
The tool has three modes of operation.
+.INDENT 0.0
.TP
-\fB\-c\fI map.txt\fP
-will compile a plaintext \fImap.txt\fP into a binary map file.
+.B \-c map.txt
+will compile a plaintext map.txt into a binary map file.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-d\fI map\fP
-will take the compiled \fImap\fP and decompile it into a plaintext source file,
-suitable for editing.
+.B \-d map
+will take the compiled map and decompile it into a plaintext source
+file, suitable for editing.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-build\fI numosds layer1 ...\fP
-will create a relatively generic map with the given layer structure. See below for examples.
+.B \-\-build numosds layer1 ...
+will create a relatively generic map with the given layer
+structure. See below for examples.
+.UNINDENT
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-o\fI outfile\fP
+.B \-o outfile
will specify the output file.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-clobber\fP
-will allow the tool to overwrite an existing \fIoutfile\fP (it will normally refuse).
+.B \-\-clobber
+will allow the tool to overwrite an existing outfile (it will normally refuse).
+.UNINDENT
.SH BUILDING A MAP
-The build mode will generate relatively generic hierarchical maps. The first argument simply
-specifies the number of devices (leaves) in the CRUSH hierarchy. Each layer describes how the
-layer (or raw devices) preceding it should be grouped.
-.PP
-Each \fIlayer\fP consists of
-.IP
-\fIname\fP ( uniform | list | tree | straw ) \fIsize\fP
-.PP
-The first element is the \fIname\fP for the elements in the layer (e.g. "rack"). Each element's
-name will be append a number to the provided \fIname\fP.
-.PP
-The second component is the type of CRUSH bucket.
-.PP
-The third component is the maximum size of the bucket. If the size is \fI0\fP, a single bucket
-will be generated that includes everything in the preceding layer.
+.sp
+The build mode will generate relatively generic hierarchical maps. The
+first argument simply specifies the number of devices (leaves) in the
+CRUSH hierarchy. Each layer describes how the layer (or raw devices)
+preceding it should be grouped.
+.sp
+Each layer consists of:
+.sp
+.nf
+.ft C
+name ( uniform | list | tree | straw ) size
+.ft P
+.fi
+.sp
+The first element is the name for the elements in the layer
+(e.g. "rack"). Each element\(aqs name will be append a number to the
+provided name.
+.sp
+The second component is the type of CRUSH bucket.
+.sp
+The third component is the maximum size of the bucket. If the size is
+0, a single bucket will be generated that includes everything in the
+preceding layer.
.SH EXAMPLE
-Suppose we have 128 devices, each grouped into shelves with 4 devices each, and 8 shelves per
-rack. We could create a three level hierarchy with:
-.IP
-crushtool --build 128 shelf uniform 4 rack straw 8 root straw 0 -o map
-.PP
-To adjust the default (generic) mapping rules, we can
-.IP
-crushtool -d map -o map.txt # decompile
-.IP
-vi map.txt # edit
-.IP
-crushtool -c map.txt -o map # recompile
+.sp
+Suppose we have 128 devices, each grouped into shelves with 4 devices
+each, and 8 shelves per rack. We could create a three level hierarchy
+with:
+.sp
+.nf
+.ft C
+crushtool \-\-build 128 shelf uniform 4 rack straw 8 root straw 0 \-o map
+.ft P
+.fi
+.sp
+To adjust the default (generic) mapping rules, we can run:
+.sp
+.nf
+.ft C
+# decompile
+crushtool \-d map \-o map.txt
+
+# edit
+vi map.txt
+
+# recompile
+crushtool \-c map.txt \-o map
+.ft P
+.fi
.SH AVAILABILITY
-.B crushtool
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcrushtool\fP is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8),
-.BR osdmaptool (8),
-.BR mkcephfs (8)
+.sp
+\fBceph\fP(8),
+\fBosdmaptool\fP(8),
+\fBmkcephfs\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/csyn.8 b/man/csyn.8
index 9ad8aacb446..3a42473217e 100644
--- a/man/csyn.8
+++ b/man/csyn.8
@@ -1,71 +1,122 @@
-.TH CSYN 8
+.TH "CSYN" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
csyn \- ceph synthetic workload generator
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B csyn
-[ \fB\-m monaddr:port\fP ]
-\fB--syn\fI command ...\fP
+.nf
+\fBcsyn\fP [ \-m \fImonaddr\fP:\fIport\fP ] \-\-syn \fIcommand\fP \fI...\fP
+.fi
+.sp
.SH DESCRIPTION
-.B csyn
-is a simple synthetic workload generator for the Ceph distributed file system.
-It uses the userspace client library to generate simple workloads against
-a currently running file system. The file system need not be mounted via
-.BR cfuse (8)
-or the kernel client.
-.PP
-One or more \fB--syn\fI command\fR arguments specify the particular workload,
-as documented below.
+.sp
+\fBcsyn\fP is a simple synthetic workload generator for the Ceph
+distributed file system. It uses the userspace client library to
+generate simple workloads against a currently running file system. The
+file system need not be mounted via cfuse(8) or the kernel client.
+.sp
+One or more \fB\-\-syn\fP command arguments specify the particular
+workload, as documented below.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-d\fP
+.B \-d
Detach from console and daemonize after startup.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during
+startup.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through
+\fBceph.conf\fP).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-num_client\fI num\fR
-Run \fInum\fR different clients, each in a separate thread.
+.B \-\-num_client num
+Run num different clients, each in a separate thread.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-syn\fI workloadspec\fR
-Run the given workload. May be specified as many times as needed. Workloads will
-normally run sequentially.
+.B \-\-syn workloadspec
+Run the given workload. May be specified as many times as
+needed. Workloads will normally run sequentially.
+.UNINDENT
.SH WORKLOADS
-Each workload should be preceded by \fB--syn\fP on the command line. This is not a
-complete list.
+.sp
+Each workload should be preceded by \fB\-\-syn\fP on the command
+line. This is not a complete list.
+.INDENT 0.0
.TP
-\fBmknap\fI path snapname\fP
+.B \fBmknap\fP \fIpath\fP \fIsnapname\fP
Create a snapshot called \fIsnapname\fP on \fIpath\fP.
.TP
-\fBrmsnap\fI path snapname\fP
+.B \fBrmsnap\fP \fIpath\fP \fIsnapname\fP
Delete snapshot called \fIsnapname\fP on \fIpath\fP.
.TP
-\fBrmfile\fI path\fP
+.B \fBrmfile\fP \fIpath\fP
Delete/unlink \fIpath\fP.
.TP
-\fBwritefile\fI sizeinmb blocksize\fP
-Create a file, named after our client id, that is \fIsizeinmb\fP MB by writing \fIblocksize\fP chunks.
+.B \fBwritefile\fP \fIsizeinmb\fP \fIblocksize\fP
+Create a file, named after our client id, that is \fIsizeinmb\fP MB by
+writing \fIblocksize\fP chunks.
.TP
-\fBreadfile\fI sizeinmb blocksize\fP
-Read file, named after our client id, that is \fIsizeinmb\fP MB by writing \fIblocksize\fP chunks.
+.B \fBreadfile\fP \fIsizeinmb\fP \fIblocksize\fP
+Read file, named after our client id, that is \fIsizeinmb\fP MB by
+writing \fIblocksize\fP chunks.
.TP
-\fBrw\fI sizeinmb blocksize\fP
+.B \fBrw\fP \fIsizeinmb\fP \fIblocksize\fP
Write file, then read it back, as above.
.TP
-\fBmakedirs\fI numsubdirs numfiles depth\fP
-Create a hierarchy of directories that is \fIdepth\fP levels deep. Give each
-directory \fInumsubdirs\fP subdirectories and \fInumfiles\fP files.
+.B \fBmakedirs\fP \fInumsubdirs\fP \fInumfiles\fP \fIdepth\fP
+Create a hierarchy of directories that is \fIdepth\fP levels deep. Give
+each directory \fInumsubdirs\fP subdirectories and \fInumfiles\fP files.
.TP
-\fBwalk\fP
-Recursively walk the file system (like \fBfind\fP).
-
+.B \fBwalk\fP
+Recursively walk the file system (like find).
+.UNINDENT
.SH AVAILABILITY
-.B csyn
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBcsyn\fP is part of the Ceph distributed file system. Please refer to
+the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
-.BR ceph (8),
-.BR cfuse (8)
+.sp
+\fBceph\fP(8),
+\fBcfuse\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/librados-config.8 b/man/librados-config.8
index c0eeb533e57..371fc542223 100644
--- a/man/librados-config.8
+++ b/man/librados-config.8
@@ -1,24 +1,68 @@
-.TH LIBRADOS-CONFIG 8
+.TH "LIBRADOS-CONFIG" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
librados-config \- display information about librados
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B librados-config
-[ \fB\--version\fR ]
-[ \fB\--vernum\fR ]
-
+.nf
+\fBlibrados\-config\fP [ \-\-version ] [ \-\-vernum ]
+.fi
+.sp
.SH DESCRIPTION
-.B librados-config
-is a utility that displays information about the installed librados.
+.INDENT 0.0
+.TP
+.B \fBlibrados\-config\fP is a utility that displays information about the
+installed \fBlibrados\fP.
+.UNINDENT
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-\-version\fR
-Display librados version
+.B \-\-version
+Display \fBlibrados\fP version
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-vernum\fR
-Display the librados version code
+.B \-\-vernum
+Display the \fBlibrados\fP version code
+.UNINDENT
.SH AVAILABILITY
-.B librados-config
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBlibrados\-config\fP is part of the Ceph distributed file system.
+Please refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for
+more information.
.SH SEE ALSO
-.BR ceph (8), rados (8)
+.sp
+\fBceph\fP(8),
+\fBrados\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/mkcephfs.8 b/man/mkcephfs.8
index 51fed771f90..c1c1e3c531e 100644
--- a/man/mkcephfs.8
+++ b/man/mkcephfs.8
@@ -1,102 +1,158 @@
-.TH MKCEPHFS 8
+.TH "MKCEPHFS" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
mkcephfs \- create a ceph file system
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B mkcephfs
-[ \fB\-c\fP\fI ceph.conf\fP ]
-[ \fB\-\-mkbtrfs\fP ]
-[ \fB\-a\fR, \fB\-\-all-hosts\fP [ \fB\-k\fI /path/to/admin.keyring\fP ] ]
+.nf
+\fBmkcephfs\fP [ \-c \fIceph.conf\fP ] [ \-\-mkbtrfs ] [ \-a, \-\-all\-hosts [ \-k
+\fI/path/to/admin.keyring\fP ] ]
+.fi
+.sp
.SH DESCRIPTION
-.B mkcephfs
-is used to create an empty Ceph file system, possibly spanning
-multiple hosts. The \fIceph.conf\fP file describes the composition of
-the entire Ceph cluster, including which hosts are participating,
+.sp
+\fBmkcephfs\fP is used to create an empty Ceph file system, possibly
+spanning multiple hosts. The ceph.conf file describes the composition
+of the entire Ceph cluster, including which hosts are participating,
which daemons run where, and which paths are used to store file system
data or metadata.
-.P
-The
-.B mkcephfs
-tool can be used in two ways. If \fB\-a\fR is used, it will use ssh
-and scp to connect to remote hosts on your behalf and do the setup of
-the entire cluster. This is the easiest solution, but can also be
-inconvenient (if you don't have ssh to connect without prompting for
+.sp
+The mkcephfs tool can be used in two ways. If \-a is used, it will use
+ssh and scp to connect to remote hosts on your behalf and do the setup
+of the entire cluster. This is the easiest solution, but can also be
+inconvenient (if you don\(aqt have ssh to connect without prompting for
passwords) or slow (if you have a large cluster).
-.P
-Alternatively, you can run each setup phase manually. First, you need to prepare
-a monmap that will be shared by each node:
-.IP
+.sp
+Alternatively, you can run each setup phase manually. First, you need
+to prepare a monmap that will be shared by each node:
+.sp
.nf
+.ft C
# prepare
master# mkdir /tmp/foo
-master# mkcephfs -c /etc/ceph/ceph.conf \\
- --prepare-monmap -d /tmp/foo
+master# mkcephfs \-c /etc/ceph/ceph.conf \e
+ \-\-prepare\-monmap \-d /tmp/foo
+.ft P
.fi
-.P
-Share the /tmp/foo directory with other nodes in whatever way is convenient for you. On each
-OSD and MDS node,
-.IP
+.sp
+Share the \fB/tmp/foo\fP directory with other nodes in whatever way is
+convenient for you. On each OSD and MDS node:
+.sp
.nf
-osdnode# mkcephfs --init-local-daemons osd -d /tmp/foo
-mdsnode# mkcephfs --init-local-daemons mds -d /tmp/foo
+.ft C
+osdnode# mkcephfs \-\-init\-local\-daemons osd \-d /tmp/foo
+mdsnode# mkcephfs \-\-init\-local\-daemons mds \-d /tmp/foo
+.ft P
.fi
-.P
-Collect the contents of the /tmp/foo directories back onto a single node, and then
-.IP
+.sp
+Collect the contents of the /tmp/foo directories back onto a single
+node, and then:
+.sp
.nf
-master# mkcephfs --prepare-mon -d /tmp/foo
+.ft C
+master# mkcephfs \-\-prepare\-mon \-d /tmp/foo
+.ft P
.fi
-.P
-Finally, distribute /tmp/foo to all monitor nodes and, on each of those nodes,
-.IP
+.sp
+Finally, distribute \fB/tmp/foo\fP to all monitor nodes and, on each of
+those nodes:
+.sp
.nf
-monnode# mkcephfs --init-local-daemons mon -d /tmp/foo
+.ft C
+monnode# mkcephfs \-\-init\-local\-daemons mon \-d /tmp/foo
+.ft P
.fi
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-a\fR, \fB\-\-allhosts\fR
-Performs the necessary initialization steps on all hosts in the cluster,
-executing commands via SSH.
+.B \-a, \-\-allhosts
+Performs the necessary initialization steps on all hosts in the
+cluster, executing commands via SSH.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use the given conf file instead of the default \fI/etc/ceph/ceph.conf\fP.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use the given conf file instead of the default \fB/etc/ceph/ceph.conf\fP.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-k\fI /path/to/keyring\fR
-When \fB\-a\fR is used, we can specify a location to copy the
-client.admin keyring, which is used to administer the cluster. The
-default is \fI/etc/ceph/keyring\fP (or whatever is specified in the
+.B \-k /path/to/keyring
+When \fB\-a\fP is used, we can specify a location to copy the
+client.admin keyring, which is used to administer the cluster. The
+default is \fB/etc/ceph/keyring\fP (or whatever is specified in the
config file).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-mkbtrfs\fR
+.B \-\-mkbtrfs
Create and mount the any btrfs file systems specified in the
-\fBceph.conf\fP for OSD data storage using \fBmkfs.btrfs\fP. The
-"btrfs devs" and (if it differs from
-"osd data") "btrfs path" options must be defined.
-
+ceph.conf for OSD data storage using mkfs.btrfs. The "btrfs devs"
+and (if it differs from "osd data") "btrfs path" options must be
+defined.
+.UNINDENT
.SH SUBCOMMANDS
-The sub-commands performed during cluster setup can be run individually with
+.sp
+The sub\-commands performed during cluster setup can be run individually with
+.INDENT 0.0
.TP
- \fB\-\-prepare\-monmap\fR \fB\-d \fIdir\fB \fB\-c \fIceph.conf\fR
+.B \-\-prepare\-monmap \-d dir \-c ceph.conf
Create an initial monmap with a random fsid/uuid and store it and
-the \fIceph.conf\fR in \fIdir\fR.
+the ceph.conf in dir.
+.UNINDENT
+.INDENT 0.0
.TP
- \fB\-\-init\-local\-daemons\fR \fItype\fR \fB\-d \fIdir\fB
-Initialize any daemons of type \fItype\fR on the local host using the
-monmap in \fIdir\fR. For types \fIosd\fR and \fImds\fR, the resulting
-authentication keys will be placed in \fIdir\fR. For type \fImon\fR,
-the initial data files generated by \fB\-\-prepare\-mon\fR (below) are
-expected in \fIdir\fR.
+.B \-\-init\-local\-daemons type \-d dir
+Initialize any daemons of type type on the local host using the
+monmap in dir. For types osd and mds, the resulting authentication
+keys will be placed in dir. For type mon, the initial data files
+generated by \-\-prepare\-mon (below) are expected in dir.
+.UNINDENT
+.INDENT 0.0
.TP
- \fB\-\-prepare\-mon\fR \fB\-d \fIdir\fB
+.B \-\-prepare\-mon \-d dir
Prepare the initial monitor data based on the monmap, OSD, and MDS
-authentication keys collected in \fIdir\fR, and put the result in
-\fIdir\fR.
-
+authentication keys collected in dir, and put the result in dir.
+.UNINDENT
.SH AVAILABILITY
-.B mkcephfs
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBmkcephfs\fP is part of the Ceph distributed file system. Please refer
+to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8),
-.BR monmaptool (8),
-.BR osdmaptool (8),
-.BR crushmaptool (8)
+.sp
+\fBceph\fP(8),
+\fBmonmaptool\fP(8),
+\fBosdmaptool\fP(8),
+\fBcrushtool\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/monmaptool.8 b/man/monmaptool.8
index eed42974c46..baf71806a77 100644
--- a/man/monmaptool.8
+++ b/man/monmaptool.8
@@ -1,61 +1,120 @@
-.TH MONMAPTOOL 8
+.TH "MONMAPTOOL" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
monmaptool \- ceph monitor cluster map manipulation tool
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B monmaptool
-\fImapfilename\fP
-[ \fB\-\-clobber\fR ]
-[ \fB\-\-print\fR ]
-[ \fB\-\-create\fR ]
-[ \fB\-\-add \fIip:port\fP ... ]
-[ \fB\-\-rm \fIip:port\fP ... ]
+.nf
+\fBmonmaptool\fP \fImapfilename\fP [ \-\-clobber ] [ \-\-print ] [ \-\-create ]
+[ \-\-add \fIip\fP:\fIport\fP \fI...\fP ] [ \-\-rm \fIip\fP:\fIport\fP \fI...\fP ]
+.fi
+.sp
.SH DESCRIPTION
-.B monmaptool
-is a utility to create, view, and modify a monitor cluster map for the
-Ceph distributed file system. The monitor map specifies the only fixed
-addresses in the Ceph distributed system. All other daemons bind to
-arbitrary addresses and register themselves with the monitors.
-.PP
-When creating a map with \fB\-\-create\fP, a new monitor map with a
-new, random UUID will be created. It should be followed by one or
-more monitor addresses.
-.PP
-The default Ceph monitor port is \fB6789\fP.
+.sp
+\fBmonmaptool\fP is a utility to create, view, and modify a monitor
+cluster map for the Ceph distributed file system. The monitor map
+specifies the only fixed addresses in the Ceph distributed system.
+All other daemons bind to arbitrary addresses and register themselves
+with the monitors.
+.sp
+When creating a map with \-\-create, a new monitor map with a new,
+random UUID will be created. It should be followed by one or more
+monitor addresses.
+.sp
+The default Ceph monitor port is 6789.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-\-print\fP
-will print a plaintext dump of the map, after any modifications are made.
+.B \-\-print
+will print a plaintext dump of the map, after any modifications are
+made.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-clobber\fP
-will allow
-.B monmaptool
-to overwrite \fImapfilename\fP if changes are made.
+.B \-\-clobber
+will allow monmaptool to overwrite mapfilename if changes are made.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-create\fP
-will create a new monitor map with a new UUID (and with it, a new, empty Ceph file system).
+.B \-\-create
+will create a new monitor map with a new UUID (and with it, a new,
+empty Ceph file system).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-add\fI name ip:port\fP
-will add a monitor with the specified \fIip:port\fP to the map.
+.B \-\-add name ip:port
+will add a monitor with the specified ip:port to the map.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-rm\fI name\fP
-will remove the monitor with the specified \fIip:port\fP from the map.
+.B \-\-rm name
+will remove the monitor with the specified ip:port from the map.
+.UNINDENT
.SH EXAMPLE
+.sp
To create a new map with three monitors (for a fresh Ceph file system):
-.IP
-monmaptool --create --add mon.a 192.168.0.10:6789 --add mon.b 192.168.0.11:6789 --add mon.c 192.168.0.12:6789 --clobber monmap
-.PP
+.sp
+.nf
+.ft C
+monmaptool \-\-create \-\-add mon.a 192.168.0.10:6789 \-\-add mon.b 192.168.0.11:6789 \e
+ \-\-add mon.c 192.168.0.12:6789 \-\-clobber monmap
+.ft P
+.fi
+.sp
To display the contents of the map:
-.IP
-monmaptool --print onmap
-.PP
+.sp
+.nf
+.ft C
+monmaptool \-\-print onmap
+.ft P
+.fi
+.sp
To replace one monitor:
-.IP
-monmaptool --rm mon.a --add mon.a 192.168.0.9:6789 --clobber monmap
+.sp
+.nf
+.ft C
+monmaptool \-\-rm mon.a \-\-add mon.a 192.168.0.9:6789 \-\-clobber monmap
+.ft P
+.fi
.SH AVAILABILITY
-.B monmaptool
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBmonmaptool\fP is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8),
-.BR crushtool (8),
-.BR mkcephfs (8)
+.sp
+\fBceph\fP(8),
+\fBcrushtool\fP(8),
+\fBmkcephfs\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/mount.ceph.8 b/man/mount.ceph.8
index f2cdd86150b..8024e36289e 100644
--- a/man/mount.ceph.8
+++ b/man/mount.ceph.8
@@ -1,183 +1,197 @@
-.TH MOUNT.CEPH 8
+.TH "MOUNT.CEPH" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
mount.ceph \- mount a ceph file system
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B mount.ceph
-\fImonaddr1\fR[,\fImonaddr2\fR,...]:/[\fIsubdir\fR]
-\fIdir\fR
-[ \fB\-o \fIoptions\fR ]
+.nf
+\fBmount.ceph\fP \fImonaddr1\fP[,\fImonaddr2\fP,...]:/[\fIsubdir\fP] \fIdir\fP [
+\-o \fIoptions\fP ]
+.fi
+.sp
.SH DESCRIPTION
-.B mount.ceph
-is a simple helper for mounting the Ceph file system on a Linux host.
-The only real purpose it serves is to resolve monitor hostname(s) into
-IP addresses; the Linux kernel client component does most of the real
-work. In fact, it is possible to mount a Ceph file system without
-.B mount.ceph
-by specifying monitor address(es) by IP:
-.IP
-mount -t ceph 1.2.3.4:/ mountpoint
-.PP
-Each monitor address \fImonaddr\fR takes the form
-\fIhost\fR[:\fIport\fP]. If the port is not specified, the Ceph
-default of \fI6789\fP is assumed.
-.PP
-Multiple monitor addresses can be separated by commas. Only one
+.sp
+\fBmount.ceph\fP is a simple helper for mounting the Ceph file system on
+a Linux host. The only real purpose it serves is to resolve monitor
+hostname(s) into IP addresses; the Linux kernel client component does
+most of the real work. In fact, it is possible to mount a Ceph file
+system without mount.ceph by specifying monitor address(es) by IP:
+.sp
+.nf
+.ft C
+mount \-t ceph 1.2.3.4:/ mountpoint
+.ft P
+.fi
+.sp
+Each monitor address monaddr takes the form host[:port]. If the port
+is not specified, the Ceph default of 6789 is assumed.
+.sp
+Multiple monitor addresses can be separated by commas. Only one
responsible monitor is needed to successfully mount; the client will
-learn about all monitors from any responsive monitor. However, it is
-a good idea to specify more than one in case one happens to be down at
+learn about all monitors from any responsive monitor. However, it is a
+good idea to specify more than one in case one happens to be down at
the time of mount.
-.PP
-A subdirectory \fIsubdir\fP may be specified if a subset of the file system is to be
-mounted.
-
+.sp
+A subdirectory subdir may be specified if a subset of the file system
+is to be mounted.
.SH OPTIONS
-
-wsize
-.IP
-int, max write size. Default: none (writeback uses smaller of wsize and stripe unit)
-.PP
-
-rsize
-.IP
-int (bytes), max readahead, multiple of 1024, Default: 524288 (512*1024)
-.PP
-
-osdtimeout
-.IP
+.INDENT 0.0
+.TP
+.B \fBwsize\fP
+int, max write size. Default: none (writeback uses smaller of wsize
+and stripe unit)
+.TP
+.B \fBrsize\fP
+int (bytes), max readahead, multiple of 1024, Default: 524288
+(512*1024)
+.TP
+.B \fBosdtimeout\fP
int (seconds), Default: 60
-.PP
-
-osdkeepalivetimeout
-.IP
+.TP
+.B \fBosdkeepalivetimeout\fP
int, Default: 5
-.PP
-
-mount_timeout
-.IP
+.TP
+.B \fBmount_timeout\fP
int (seconds), Default: 60
-.PP
-
-osd_idle_ttl
-.IP
+.TP
+.B \fBosd_idle_ttl\fP
int (seconds), Default: 60
-.PP
-
-caps_wanted_delay_min
-.IP
+.TP
+.B \fBcaps_wanted_delay_min\fP
int, cap release delay, Default: 5
-.PP
-
-caps_wanted_delay_max
-.IP
+.TP
+.B \fBcaps_wanted_delay_max\fP
int, cap release delay, Default: 60
-.PP
-
-cap_release_safety
-.IP
+.TP
+.B \fBcap_release_safety\fP
int, Default: calculated
-.PP
-
-readdir_max_entries
-.IP
+.TP
+.B \fBreaddir_max_entries\fP
int, Default: 1024
-.PP
-
-readdir_max_bytes
-.IP
+.TP
+.B \fBreaddir_max_bytes\fP
int, Default: 524288 (512*1024)
-.PP
-
-write_congestion_kb
-.IP
-int (kb), max writeback in flight. scale with available memory. Default: calculated from available memory
-.PP
-
-snapdirname
-.IP
+.TP
+.B \fBwrite_congestion_kb\fP
+int (kb), max writeback in flight. scale with available
+memory. Default: calculated from available memory
+.TP
+.B \fBsnapdirname\fP
string, set the name of the hidden snapdir. Default: .snap
-.PP
-
-name
-.IP
+.TP
+.B \fBname\fP
string, used with authx, Default: guest
-.PP
-
-secret
-.IP
-string, used with authx
-.PP
-
-ip
-.IP
+.TP
+.B \fBsecret\fP
+string, used with authx
+.TP
+.B \fBip\fP
my ip
-.PP
-
-noshare
-.IP
-create a new client instance, instead of sharing an existing instance of a client mounting the same cluster
-.PP
-
-dirstat
-.IP
-funky `cat dirname` for stats, Default: off
-.PP
-
-nodirstat
-.IP
-no funky `cat dirname` for stats
-.PP
-
-rbytes
-.IP
-Report the recursive size of the directory contents for st_size on directories. Default: on
-.PP
-
-norbytes
-.IP
-Do not report the recursive size of the directory contents for st_size on directories.
-.PP
-
-nocrc
-.IP
+.TP
+.B \fBnoshare\fP
+create a new client instance, instead of sharing an existing
+instance of a client mounting the same cluster
+.TP
+.B \fBdirstat\fP
+funky \fIcat dirname\fP for stats, Default: off
+.TP
+.B \fBnodirstat\fP
+no funky \fIcat dirname\fP for stats
+.TP
+.B \fBrbytes\fP
+Report the recursive size of the directory contents for st_size on
+directories. Default: on
+.TP
+.B \fBnorbytes\fP
+Do not report the recursive size of the directory contents for
+st_size on directories.
+.TP
+.B \fBnocrc\fP
no data crc on writes
-.PP
-
-noasyncreaddir
-.IP
+.TP
+.B \fBnoasyncreaddir\fP
no dcache readdir
-.PP
-
-
+.UNINDENT
.SH EXAMPLES
+.sp
Mount the full file system:
-.IP
+.sp
+.nf
+.ft C
mount.ceph monhost:/ /mnt/foo
-.PP
+.ft P
+.fi
+.sp
If there are multiple monitors:
-.IP
+.sp
+.nf
+.ft C
mount.ceph monhost1,monhost2,monhost3:/ /mnt/foo
-.PP
-If
-.BR cmon (8)
-is running on a non-standard port:
-.IP
+.ft P
+.fi
+.sp
+If cmon(8) is running on a non\-standard port:
+.sp
+.nf
+.ft C
mount.ceph monhost1:7000,monhost2:7000,monhost3:7000:/ /mnt/foo
-.PP
+.ft P
+.fi
+.sp
To mount only part of the namespace:
-.IP
+.sp
+.nf
+.ft C
mount.ceph monhost1:/some/small/thing /mnt/thing
-.PP
-Assuming
-.BR mount.ceph (8)
-is installed properly, it should be automatically invoked by
-.BR mount (8)
-like so:
-.IP
-mount -t ceph monhost:/ /mnt/foo
+.ft P
+.fi
+.sp
+Assuming mount.ceph(8) is installed properly, it should be
+automatically invoked by mount(8) like so:
+.sp
+.nf
+.ft C
+mount \-t ceph monhost:/ /mnt/foo
+.ft P
+.fi
.SH AVAILABILITY
-.B mount.ceph
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBmount.ceph\fP is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR cfuse (8),
-.BR ceph (8)
+.sp
+\fBcfuse\fP(8),
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/obsync.8 b/man/obsync.8
index 8ede115d9fb..54ef6a58dad 100644
--- a/man/obsync.8
+++ b/man/obsync.8
@@ -1,122 +1,180 @@
-.TH OBSYNC 8
+.TH "OBSYNC" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
obsync \- The object synchronizer tool
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B obsync [ \fIoptions\fP ] <\fIsource-url\fP> <\fIdestination-url\fP>
-
+.nf
+\fBobsync\fP [ \fIoptions\fP ] \fIsource\-url\fP \fIdestination\-url\fP
+.fi
+.sp
.SH DESCRIPTION
-.B obsync
-is an object syncrhonizer tool designed to transfer objects between
-different object storage systems. Similar to rsync, you specify a source and a
-deestination, and it will transfer objects between them until the destination
-has all the objects in the source. Obsync will never modify the source-- only the
-destination.
-
-By default, obsync does not delete anything. However, by specifying \fB--delete-after\fP
-or \fB--delete-before\fP, you can ask it to delete objects from the destination that are
-not in the source.
-
+.sp
+\fBobsync\fP is an object syncrhonizer tool designed to transfer objects
+between different object storage systems. Similar to rsync, you
+specify a source and a destination, and it will transfer objects
+between them until the destination has all the objects in the
+source. Obsync will never modify the source \-\- only the destination.
+.sp
+By default, obsync does not delete anything. However, by specifying
+\fB\-\-delete\-after\fP or \fB\-\-delete\-before\fP, you can ask it to delete
+objects from the destination that are not in the source.
.SH TARGET TYPES
-Obsync supports \fIS3\fP via \fIlibboto\fP.
-To use the s3 target, your URL should look like this:
-s3://\fIhost-name\fP/\fIbucket-name\fP
-
-Obsync supports storing files locally via the \fIfile://\fP target.
-To use the file target, your URL should look like this:
-file://\fIdirectory-name\fP
-
-Alternately, give no prefix, like this:
-\fI\./directory-name\fP
-
-Obsync supports storing files in a \fIRados Gateway\fP backend via the \fIlibrados\fP Python bindings.
-To use the rgw target, your URL should look like this:
-rgw:\fIceph-configuration-path\fP:\fIrgw-bucket-name\fP
-
+.sp
+Obsync supports S3 via \fBlibboto\fP. To use the s3 target, your URL
+should look like this: \fBs3://host\-name/bucket\-name\fP
+.sp
+Obsync supports storing files locally via the \fBfile://\fP target. To
+use the file target, your URL should look like this:
+\fBfile://directory\-name\fP
+.sp
+Alternately, give no prefix, like this: \fB./directory\-name\fP
+.sp
+Obsync supports storing files in a RADOS Gateway backend via the
+\fBlibrados\fP Python bindings. To use the \fBrgw\(ga target, your URL
+should look like this: \(ga\(gargw:ceph\-configuration\-path:rgw\-bucket\-name\fP
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+.B \-h, \-\-help
Display a help message
-
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-n\fP | \fB\-\-dry-run\fP
+.B \-n, \-\-dry\-run
Show what would be done, but do not modify the destination.
-
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-c\fP | \fB\-\-create-dest\fP
+.B \-c, \-\-create\-dest
Create the destination if it does not exist.
-
-.TP
-\fB\-\-delete-before\fP
-Before copying any files, delete objects in the destination that are not in the source.
-
-.TP
-\fB\-L\fP | \fB\-\-follow-symlinks\fP
-Follow symlinks when dealing with \fIfile://\fP targets.
-
-.TP
-\fB\-\-no-preserve-acls\fP
-Don't preserve ACLs when copying objects.
-
-.TP
-\fB\-v\fP | \fB\-\-verbose\fP
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-delete\-before
+Before copying any files, delete objects in the destination that
+are not in the source.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-L, \-\-follow\-symlinks
+Follow symlinks when dealing with \fBfile://\fP targets.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-no\-preserve\-acls
+Don\(aqt preserve ACLs when copying objects.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-v, \-\-verbose
Be verbose.
-
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-V\fP | \fB\-\-more-verbose\fP
+.B \-V, \-\-more\-verbose
Be really, really verbose (developer mode)
-
-.TP
-\fB\-x\fP \fBSRC\fP=\fBDST\fP | \fB\-\-xuser\fP \fBSRC\fP=\fBDST\fP
-Set up a user translation. You can specify multiple user translations with
-multiple \fB--xuser\fP arguments.
-
-.TP
-\fB\-\-force\fP
-Overwrite all destination objects, even if they appear to be the same as the
-source objects.
-
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-x SRC=DST, \-\-xuser SRC=DST
+Set up a user translation. You can specify multiple user
+translations with multiple \fB\-\-xuser\fP arguments.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-force
+Overwrite all destination objects, even if they appear to be the
+same as the source objects.
+.UNINDENT
.SH ENVIRONMENT VARIABLES
+.INDENT 0.0
.TP
-\fBSRC_AKEY\fP
+.B SRC_AKEY
Access key for the source URL
-
+.UNINDENT
+.INDENT 0.0
.TP
-\fBSRC_SKEY\fP
+.B SRC_SKEY
Secret access key for the source URL
-
+.UNINDENT
+.INDENT 0.0
.TP
-\fBDST_AKEY\fP
+.B DST_AKEY
Access key for the destination URL
-
+.UNINDENT
+.INDENT 0.0
.TP
-\fBDST_SKEY\fP
+.B DST_SKEY
Secret access key for the destination URL
-
+.UNINDENT
+.INDENT 0.0
.TP
-\fBAKEY\fP
+.B AKEY
Access key for both source and dest
-
+.UNINDENT
+.INDENT 0.0
.TP
-\fBSKEY\fP
+.B SKEY
Secret access key for both source and dest
-
+.UNINDENT
+.INDENT 0.0
.TP
-\fBDST_CONSISTENCY\fP
-Set to 'eventual' if the destination is eventually consistent.
-If the destination is eventually consistent, we may have to retry certain operations
-multiple times.
-
+.B DST_CONSISTENCY
+Set to \(aqeventual\(aq if the destination is eventually consistent. If the destination
+is eventually consistent, we may have to retry certain operations multiple times.
+.UNINDENT
.SH EXAMPLES
-\fIAKEY=... SKEY=... obsync -c -d -v ./backup-directory s3://myhost1/mybucket1\fP
-
-Copy objects from backup-directory to mybucket1 on myhost1
-
-\fISRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=...
-obsync -c -d -v s3://myhost1/mybucket1 s3://myhost1/mybucket2\fP
-
+.sp
+.nf
+.ft C
+AKEY=... SKEY=... obsync \-c \-d \-v ./backup\-directory s3://myhost1/mybucket1
+.ft P
+.fi
+.sp
+Copy objects from backup\-directory to mybucket1 on myhost1:
+.sp
+.nf
+.ft C
+SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync \-c \-d \-v s3://myhost1/mybucket1 s3://myhost1/mybucket2
+.ft P
+.fi
+.sp
Copy objects from mybucket1 to mybucket2
-
.SH AVAILABILITY
-.B obsync
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBobsync\fP is part of the Ceph distributed file system. Please refer
+to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/osdmaptool.8 b/man/osdmaptool.8
index 914addb96f5..da988bd8e28 100644
--- a/man/osdmaptool.8
+++ b/man/osdmaptool.8
@@ -1,50 +1,106 @@
-.TH OSDMAPTOOL 8
+.TH "OSDMAPTOOL" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
osdmaptool \- ceph osd cluster map manipulation tool
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B osdmaptool
-\fImapfilename\fP
-[\fB\-\-print\fR]
-[\fB\-\-createsimple \fInumosd\fR [\fB\-\-pgbits \fIbitsperosd\fR]]
-[\fB\-\-clobber\fR]
+.nf
+\fBosdmaptool\fP \fImapfilename\fP [\-\-print] [\-\-createsimple \fInumosd\fP
+[\-\-pgbits \fIbitsperosd\fP ] ] [\-\-clobber]
+.fi
+.sp
.SH DESCRIPTION
-.B osdmaptool
-is a utility that lets you create, view, and manipulate OSD cluster maps from the
-Ceph distributed file system. Notably, it lets you extract the embedded CRUSH map
-or import a new CRUSH map.
+.sp
+\fBosdmaptool\fP is a utility that lets you create, view, and manipulate
+OSD cluster maps from the Ceph distributed file system. Notably, it
+lets you extract the embedded CRUSH map or import a new CRUSH map.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-\-print\fP
-will simply make the tool print a plaintext dump of the map, after any modifications are made.
+.B \-\-print
+will simply make the tool print a plaintext dump of the map, after
+any modifications are made.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-clobber\fP
-will allow
-.B osdmaptool
-to overwrite \fImapfilename\fP if changes are made.
+.B \-\-clobber
+will allow osdmaptool to overwrite mapfilename if changes are made.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-import-crush\fI mapfile\fP
-will load the CRUSH map from \fImapfile\fP and embed it in the OSD map.
+.B \-\-import\-crush mapfile
+will load the CRUSH map from mapfile and embed it in the OSD map.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-export-crush\fI mapfile\fP
-will extract the CRUSH map from the OSD map and write it to \fImapfile\fP.
+.B \-\-export\-crush mapfile
+will extract the CRUSH map from the OSD map and write it to
+mapfile.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-createsimple\fI numosd\fP [\fB\-\-pgbits \fIbitsperosd\fR]
-will create a relatively generic OSD map with the \fInumosd\fP devices. If \fB\-\-pgbits\fP
-is specified, the initial placement group counts will be set with \fIbitsperosd\fP bits per OSD.
-That is, the \fIpg_num\fP map attribute will be set to \fInumosd\fP shifted by \fIbitsperosd\fP.
+.B \-\-createsimple numosd [\-\-pgbits bitsperosd]
+will create a relatively generic OSD map with the numosd devices.
+If \-\-pgbits is specified, the initial placement group counts will
+be set with bitsperosd bits per OSD. That is, the pg_num map
+attribute will be set to numosd shifted by bitsperosd.
+.UNINDENT
.SH EXAMPLE
+.sp
To create a simple map with 16 devices:
-.IP
-osdmaptool --createsimple 16 osdmap --clobber
-.PP
+.sp
+.nf
+.ft C
+osdmaptool \-\-createsimple 16 osdmap \-\-clobber
+.ft P
+.fi
+.sp
To view the result:
-.IP
-osdmaptool --print osdmap
+.sp
+.nf
+.ft C
+osdmaptool \-\-print osdmap
+.ft P
+.fi
.SH AVAILABILITY
-.B osdmaptool
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBosdmaptool\fP is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8),
-.BR crushtool (8),
-.BR mkcephfs (8)
+.sp
+\fBceph\fP(8),
+\fBcrushtool\fP(8),
+\fBmkcephfs\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/rados.8 b/man/rados.8
index 29b55c6869c..1fe10ad3308 100644
--- a/man/rados.8
+++ b/man/rados.8
@@ -1,110 +1,185 @@
-.TH RADOS 8
+.TH "RADOS" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
rados \- rados object storage utility
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B rados
-[ \fB\-m\fI monaddr\fR ]
-[ mkpool | rmpool \fI foo]
-[ \fB\-p\fP | \fB\-\-pool\fI pool\fR ]
-[ \fB\-s\fP | \fB\-\-snap\fI snap\fR ]
-[ \fB\-i\fI infile\fR ]
-[ \fB\-o\fI outfile\fR ]
-\fIcommand ...\fR
-
+.nf
+\fBrados\fP [ \-m \fImonaddr\fP ] [ mkpool | rmpool \fIfoo\fP ] [ \-p | \-\-pool
+\fIpool\fP ] [ \-s | \-\-snap \fIsnap\fP ] [ \-i \fIinfile\fP ] [ \-o \fIoutfile\fP ]
+\fIcommand\fP ...
+.fi
+.sp
.SH DESCRIPTION
-.B rados
-is a utility for interacting with a Ceph object storage cluster (RADOS), part of the
-Ceph distributed file system.
+.sp
+\fBrados\fP is a utility for interacting with a Ceph object storage
+cluster (RADOS), part of the Ceph distributed file system.
.SH OPTIONS
-.TP
-\fB\-p\fI pool\fR, \fB\-\-pool \fIpool\fR
-Interact with the given \fIpool\fP. Required by most commands.
-.TP
-\fB\-s\fI snap\fR, \fB\-\-snap \fIsnap\fR
-Read from the given pool snapshot. Valid for all pool-specific read operations.
-.TP
-\fB\-i \fIinfile\fP
-will specify an input file to be passed along as a payload with the \fIcommand\fP to the
-monitor cluster. This is only used for specific monitor commands.
-.TP
-\fB\-o \fIoutfile\fP
-will write any payload returned by the monitor cluster with its reply to \fIoutfile\fP.
-Only specific monitor commands (e.g. \fIosd getmap\fP) return a payload.
-.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
-.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
+.INDENT 0.0
+.TP
+.B \-p pool, \-\-pool pool
+Interact with the given pool. Required by most commands.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-s snap, \-\-snap snap
+Read from the given pool snapshot. Valid for all pool\-specific read operations.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-i infile
+will specify an input file to be passed along as a payload with the
+command to the monitor cluster. This is only used for specific
+monitor commands.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-o outfile
+will write any payload returned by the monitor cluster with its
+reply to outfile. Only specific monitor commands (e.g. osd getmap)
+return a payload.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-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.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through ceph.conf).
+.UNINDENT
.SH GLOBAL COMMANDS
+.INDENT 0.0
.TP
-\fBlspools\fI
+.B \fBlspools\fP
List object pools
.TP
-\fBdf\fI
-Show utilization statistics, including disk usage (bytes) and object counts, over the entire system
-and broken down by pool.
+.B \fBdf\fP
+Show utilization statistics, including disk usage (bytes) and object
+counts, over the entire system and broken down by pool.
.TP
-\fBmkpool\fI foo
+.B \fBmkpool\fP \fIfoo\fP
Create a pool with name foo.
.TP
-\fBrmpool\fI foo
+.B \fBrmpool\fP \fIfoo\fP
Delete the pool foo (and all its data)
+.UNINDENT
.SH POOL SPECIFIC COMMANDS
+.INDENT 0.0
.TP
-\fBget \fIname\fP \fIoutfile\fP
-Read object \fIname\fP from the cluster and write it to \fIoutfile\fP.
+.B \fBget\fP \fIname\fP \fIoutfile\fP
+Read object name from the cluster and write it to outfile.
.TP
-\fBput \fIname\fP \fIinfile\fP
-Write object \fIname\fP to the cluster with contents from \fIinfile\fP.
+.B \fBput\fP \fIname\fP \fIinfile\fP
+Write object name to the cluster with contents from infile.
.TP
-\fBrm \fIname\fP
-Remove object \fIname\fP.
+.B \fBrm\fP \fIname\fP
+Remove object name.
.TP
-\fBls \fIoutfile\fP
-List objects in given pool and write to \fIoutfile\fP.
+.B \fBls\fP \fIoutfile\fP
+List objects in given pool and write to outfile.
.TP
-\fBlssnap\fP
+.B \fBlssnap\fP
List snapshots for given pool.
.TP
-\fBmksnap \fIfoo\fP
+.B \fBmksnap\fP \fIfoo\fP
Create pool snapshot named \fIfoo\fP.
.TP
-\fBrmsnap \fIfoo\fP
+.B \fBrmsnap\fP \fIfoo\fP
Remove pool snapshot names \fIfoo\fP.
.TP
-\fBbench \fIseconds\fP \fImode\fP [ \fB-b \fIobjsize\fP ] [ \fB-t threads\fP ]
-Benchmark for \fIseconds\fP. The \fImode\fP can be write or read. The default object size is 4 KB, and the
-default number of simulated threads (parallel writes) is 16.
+.B \fBbench\fP \fIseconds\fP \fImode\fP [ \-b \fIobjsize\fP ] [ \-t \fIthreads\fP ]
+Benchmark for seconds. The mode can be write or read. The default
+object size is 4 KB, and the default number of simulated threads
+(parallel writes) is 16.
+.UNINDENT
.SH EXAMPLES
+.sp
To view cluster utilization:
-.IP
+.sp
+.nf
+.ft C
rados df
-.PP
-To get a list object in pool \fIfoo\FP sent to stdout:
-.IP
-rados -p foo ls -
-.PP
+.ft P
+.fi
+.sp
+To get a list object in pool foo sent to stdout:
+.sp
+.nf
+.ft C
+rados \-p foo ls \-
+.ft P
+.fi
+.sp
To write an object:
-.IP
-rados -p foo put myobject blah.txt
-.PP
+.sp
+.nf
+.ft C
+rados \-p foo put myobject blah.txt
+.ft P
+.fi
+.sp
To create a snapshot:
-.IP
-rados -p foo mksnap mysnap
-.PP
+.sp
+.nf
+.ft C
+rados \-p foo mksnap mysnap
+.ft P
+.fi
+.sp
To delete the object:
-.IP
-rados -p foo rm myobject
-.PP
+.sp
+.nf
+.ft C
+rados \-p foo rm myobject
+.ft P
+.fi
+.sp
To read a previously snapshotted version of an object:
-.IP
-rados -p foo -s mysnap get myobject blah.txt.old
-.PP
+.sp
+.nf
+.ft C
+rados \-p foo \-s mysnap get myobject blah.txt.old
+.ft P
+.fi
.SH AVAILABILITY
-.B rados
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBrados\fP is part of the Ceph distributed file system. Please refer to
+the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
-.BR ceph (8)
+.sp
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/radosgw.8 b/man/radosgw.8
index 847a9e1bc69..9c0970f8ecf 100644
--- a/man/radosgw.8
+++ b/man/radosgw.8
@@ -1,27 +1,70 @@
-.TH RADOSGW 8
+.TH "RADOSGW" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
radosgw \- rados REST gateway
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B radosgw
+.nf
+\fBradosgw\fP
+.fi
+.sp
.SH DESCRIPTION
-.B radosgw
-is an HTTP REST gateway for the RADOS object store, a part of the Ceph
-distributed storage system. It is implemented as a FastCGI module using
-libfcgi, and can be used in conjunction with any FastCGI capable web server.
+.sp
+\fBradosgw\fP is an HTTP REST gateway for the RADOS object store, a part
+of the Ceph distributed storage system. It is implemented as a FastCGI
+module using libfcgi, and can be used in conjunction with any FastCGI
+capable web server.
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through
+\fBceph.conf\fP).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-rgw\-socket\-path=\fIpath\fR
+.B \-\-rgw\-socket\-path=path
Specify a unix domain socket path.
+.UNINDENT
.SH EXAMPLES
+.sp
An apache example configuration for using the RADOS gateway:
-.IP
+.sp
+.nf
+.ft C
<VirtualHost *:80>
ServerName rgw.example1.com
ServerAlias rgw
@@ -32,15 +75,15 @@ An apache example configuration for using the RADOS gateway:
RewriteEngine On
#following is important for RGW/rados
- RewriteRule ^/([a-zA-Z0-9\-\_\.]*)([/]?.*) /s3gw.fcgi?page=$1&params=$2&%{QUERY_STRING} [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
+ RewriteRule ^/([a\-zA\-Z0\-9\-_.]*)([/]?.*) /s3gw.fcgi?page=$1&params=$2&%{QUERY_STRING} [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
<IfModule mod_fcgid.c>
SuexecUserGroup web1 web1
<Directory /var/www/web1/web/>
Options +ExecCGI
AllowOverride All
- SetHandler fcgid-script
- FCGIWrapper /var/www/fcgi-scripts/web1/radosgw .fcgi
+ SetHandler fcgid\-script
+ FCGIWrapper /var/www/fcgi\-scripts/web1/radosgw .fcgi
Order allow,deny
Allow from all
AuthBasicAuthoritative Off
@@ -54,21 +97,41 @@ An apache example configuration for using the RADOS gateway:
ServerSignature Off
</VirtualHost>
-.PP
+.ft P
+.fi
+.sp
And the corresponding radosgw script:
-.IP
+.sp
+.nf
+.ft C
#!/bin/sh
-/usr/bin/radosgw -c /etc/ceph.conf
-.PP
-By default radosgw will run as single threaded and its execution will be controlled by the fastcgi process manager.
-An alternative way to run it would be by specifying (along the lines of) the following in the apache config:
-.IP
-FastCgiExternalServer /var/www/web1/web/s3gw.fcgi -socket /tmp/.radosgw.sock
-.PP
-and specify a unix domain socket path (either by passing a command line option, or through ceph.conf).
+exec /usr/bin/radosgw \-c /etc/ceph.conf
+.ft P
+.fi
+.sp
+By default radosgw will run as single threaded and its execution will
+be controlled by the fastcgi process manager. An alternative way to
+run it would be by specifying (along the lines of) the following in
+the apache config:
+.sp
+.nf
+.ft C
+FastCgiExternalServer /var/www/web1/web/s3gw.fcgi \-socket /tmp/.radosgw.sock
+.ft P
+.fi
+.sp
+and specify a unix domain socket path (either by passing a command
+line option, or through ceph.conf).
.SH AVAILABILITY
-.B radosgw
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBradosgw\fP is part of the Ceph distributed file system. Please refer
+to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8)
+.sp
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/radosgw_admin.8 b/man/radosgw_admin.8
index 702474a3aa2..80e90ec3247 100644
--- a/man/radosgw_admin.8
+++ b/man/radosgw_admin.8
@@ -1,85 +1,182 @@
-.TH RADOSGW_ADMIN 8
+.TH "RADOSGW_ADMIN" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
radosgw_admin \- rados REST gateway user administration utility
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B radosgw_admin <cmd> [options..]
+.nf
+\fBradosgw_admin\fP \fIcommand\fP [ \fIoptions\fP \fI...\fP ]
+.fi
+.sp
.SH DESCRIPTION
-.B radosgw_admin
-is a RADOS gateway user administration utility. It allows creating and modifying users.
+.sp
+\fBradosgw_admin\fP is a RADOS gateway user administration utility. It
+allows creating and modifying users.
.SH COMMANDS
+.sp
+\fIcommand\fP can be one of the following options:
+.INDENT 0.0
.TP
-\fBcmd\fR can be one of the following options:
-.IP
- user create Create a new user
- user modify Modify a user
- user info Display information of a user
- user rm Remove a user
- bucket list List all buckets
- bucket unlink Remove a bucket
- policy Display bucket/object policy
- log show Show the log of a bucket (with a specified date)
-.PP
+.B \fBuser create\fP
+Create a new user
+.TP
+.B \fBuser modify\fP
+Modify a user
+.TP
+.B \fBuser info\fP
+Display information of a user
+.TP
+.B \fBuser rm\fP
+Remove a user
+.TP
+.B \fBbucket list\fP
+List all buckets
+.TP
+.B \fBbucket unlink\fP
+Remove a bucket
+.TP
+.B \fBpolicy\fP
+Display bucket/object policy
+.TP
+.B \fBlog show\fP
+Show the log of a bucket (with a specified date)
+.UNINDENT
.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during
+startup.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through ceph.conf).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-uid=\fIuid\fR
+.B \-\-uid=uid
The S3 user/access key.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-secret=\fIsecret\fR
+.B \-\-secret=secret
The S3 secret.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-display\-name=\fIname\fR
+.B \-\-display\-name=name
Configure the display name of the user.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-email=\fIemail\fR
-The e-mail address of the user
+.B \-\-email=email
+The e\-mail address of the user
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-bucket=\fIbucket\fR
+.B \-\-bucket=bucket
Specify the bucket name.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-object=\fIobject\fR
+.B \-\-object=object
Specify the object name.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-date=\fIyyyy-mm-dd\fR
+.B \-\-date=yyyy\-mm\-dd
The date need for some commands
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-os\-user=\fIgroup:name\fR
+.B \-\-os\-user=group:name
The OpenStack user (only needed for use with OpenStack)
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-os\-secret=\fIkey\fR
+.B \-\-os\-secret=key
The OpenStack key
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-auth\-uid=\fIauid\fR
+.B \-\-auth\-uid=auid
The librados auid
+.UNINDENT
.SH EXAMPLES
-Generate a new user
-.IP
- $ radosgw_admin user gen --display-name="johnny rotten" --email=johnny@rotten.com
- User ID: CHBQFRTG26I8DGJDGQLW
- Secret Key: QR6cI/31N+J0VKVgHSpEGVSfEEsmf6PyXG040KCB
- Display Name: johnny rotten
-.PP
-Remove a user
-.IP
- $ radosgw_admin user rm --uid=CHBQFRTG26I8DGJDGQLW
-.PP
-Remove a bucket
-.IP
- $ radosgw_admin bucket unlink --bucket=foo
-.PP
-Thow the logs of a bucket from April 1st 2011
-.IP
- $ radosgw_admin log show --bucket=foo --date=2011=04-01
-.PP
+.sp
+Generate a new user:
+.sp
+.nf
+.ft C
+$ radosgw_admin user gen \-\-display\-name="johnny rotten" \-\-email=johnny@rotten.com
+User ID: CHBQFRTG26I8DGJDGQLW
+Secret Key: QR6cI/31N+J0VKVgHSpEGVSfEEsmf6PyXG040KCB
+Display Name: johnny rotten
+.ft P
+.fi
+.sp
+Remove a user:
+.sp
+.nf
+.ft C
+$ radosgw_admin user rm \-\-uid=CHBQFRTG26I8DGJDGQLW
+.ft P
+.fi
+.sp
+Remove a bucket:
+.sp
+.nf
+.ft C
+$ radosgw_admin bucket unlink \-\-bucket=foo
+.ft P
+.fi
+.sp
+Show the logs of a bucket from April 1st 2011:
+.sp
+.nf
+.ft C
+$ radosgw_admin log show \-\-bucket=foo \-\-date=2011=04\-01
+.ft P
+.fi
.SH AVAILABILITY
-.B radosgw_admin
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBradosgw_admin\fP is part of the Ceph distributed file system. Please
+refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
.SH SEE ALSO
-.BR ceph (8)
+.sp
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/man/rbd.8 b/man/rbd.8
index 0deee48fb5b..3a0b4bebce3 100644
--- a/man/rbd.8
+++ b/man/rbd.8
@@ -1,132 +1,221 @@
-.TH RBD 8
+.TH "RBD" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
rbd \- manage rados block device (RBD) images
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B rbd
-[ \fB\-c\fI ceph.conf\fR ]
-[ \fB\-m\fI monaddr\fR ]
-[ \fB\-p\fP | \fB\-\-pool\fI pool\fR ]
-[ \fB\-\-size\fI size\fR ]
-[ \fB\-\-order\fI bits\fR ]
-[ \fIcommand ...\fR ]
-
+.nf
+\fBrbd\fP [ \-c \fIceph.conf\fP ] [ \-m \fImonaddr\fP ] [ \-p | \-\-pool \fIpool\fP ] [
+\-\-size \fIsize\fP ] [ \-\-order \fIbits\fP ] [ \fIcommand\fP ... ]
+.fi
+.sp
.SH DESCRIPTION
-.B rbd
-is a utility for manipulating rados block device (RBD) images, used by the Linux
-rbd driver and the rbd storage driver for Qemu/KVM. RBD images are
-simple block devices that are striped over objects and stored in a RADOS object store.
-The size of the objects the image is striped over must be a power of two.
+.sp
+\fBrbd\fP is a utility for manipulating rados block device (RBD) images,
+used by the Linux rbd driver and the rbd storage driver for Qemu/KVM.
+RBD images are simple block devices that are striped over objects and
+stored in a RADOS object store. The size of the objects the image is
+striped over must be a power of two.
.SH OPTIONS
-.TP
-\fB\-c\fI ceph.conf\fR, \fB\-\-conf \fIceph.conf\fR
-Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
-to determine monitor addresses during startup.
-.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
-.TP
-\fB\-p\fI pool\fR, \fB\-\-pool \fIpool\fR
-Interact with the given \fIpool\fP. Required by most commands.
+.INDENT 0.0
+.TP
+.B \-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.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through ceph.conf).
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-p pool, \-\-pool pool
+Interact with the given pool. Required by most commands.
+.UNINDENT
.SH PARAMETERS
+.INDENT 0.0
.TP
-\fB\-\-size \fIsize-in-mb\fP
+.B \-\-size size\-in\-mb
Specifies the size (in megabytes) of the new rbd image.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-order \fIbits\fP
-Specifies the object size expressed as a number of bits, such that the object size is 1 << \fIorder\fR. The default is 22 (4 MB).
+.B \-\-order bits
+Specifies the object size expressed as a number of bits, such that
+the object size is \fB1 << order\fP. The default is 22 (4 MB).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-snap \fIsnap\fP
+.B \-\-snap snap
Specifies the snapshot name for the specific operation.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-user \fIusername\fP
+.B \-\-user username
Specifies the username to use with the map command.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-secret \fIfilename\fP
+.B \-\-secret filename
Specifies a file containing the secret to use with the map command.
+.UNINDENT
.SH COMMANDS
+.INDENT 0.0
.TP
-\fBls \fR[ \fIpool-name\fP ]
-Will list all rbd images listed in the \fIrbd_directory\fR object.
+.B \fBls\fP [\fIpool\-name\fP]
+Will list all rbd images listed in the rbd_directory object.
.TP
-\fBinfo \fR[ \fIimage-name\fP ]
+.B \fBinfo\fP [\fIimage\-name\fP]
Will dump information (such as size and order) about a specific rbd image.
.TP
-\fBcreate \fR[ \fIimage-name\fP ]
-Will create a new rbd image. You must also specify the size via \fB\-\-size\fR.
+.B \fBcreate\fP [\fIimage\-name\fP]
+Will create a new rbd image. You must also specify the size via \-\-size.
.TP
-\fBresize \fR[ \fIimage-name\fP ]
-Resizes rbd image. The size parameter also needs to be specified.
+.B \fBresize\fP [\fIimage\-name\fP]
+Resizes rbd image. The size parameter also needs to be specified.
.TP
-\fBrm \fR[ \fIimage-name\fP ]
+.B \fBrm\fP [\fIimage\-name\fP]
Deletes rbd image (including all data blocks)
.TP
-\fBexport \fR[ \fIimage-name\fP ] \fR[ \fIdest-path\fP ]
+.B \fBexport\fP [\fIimage\-name\fP] [\fIdest\-path\fP]
Exports image to dest path.
.TP
-\fBimport \fR[ \fIpath\fP ] \fR[ \fIdest-image\fP ]
+.B \fBimport\fP [\fIpath\fP] [\fIdest\-image\fP]
Creates a new image and imports its data from path.
.TP
-\fBcp \fR[ \fIsrc-image\fP ] \fR[ \fIdest-image\fP ]
-Copies the content of a src-image into the newly created dest-image.
+.B \fBcp\fP [\fIsrc\-image\fP] [\fIdest\-image\fP]
+Copies the content of a src\-image into the newly created dest\-image.
.TP
-\fBmv \fR[ \fIsrc-image\fP ] \fR[ \fIdest-image\fP ]
+.B \fBmv\fP [\fIsrc\-image\fP] [\fIdest\-image\fP]
Renames an image.
.TP
-\fBsnap ls \fR[ \fIimage-name\fP ]
+.B \fBsnap\fP ls [\fIimage\-name\fP]
Dumps the list of snapshots inside a specific image.
.TP
-\fBsnap create \fR[ \fIimage-name\fP ]
+.B \fBsnap\fP create [\fIimage\-name\fP]
Creates a new snapshot. Requires the snapshot name parameter specified.
.TP
-\fBsnap rollback \fR[ \fIimage-name\fP ]
-Rollback image content to snapshot. This will iterate through the entire blocks array and update the data head content to the snapshotted version.
+.B \fBsnap\fP rollback [\fIimage\-name\fP]
+Rollback image content to snapshot. This will iterate through the entire blocks
+array and update the data head content to the snapshotted version.
.TP
-\fBsnap rm \fR[ \fIimage-name\fP ]
+.B \fBsnap\fP rm [\fIimage\-name\fP]
Removes the specified snapshot.
.TP
-\fBmap \fR[ \fIimage-name\fP ]
+.B \fBmap\fP [\fIimage\-name\fP]
Maps the specified image to a block device via the rbd kernel module.
.TP
-\fBunmap \fR[ \fIdevice-path\fP ]
+.B \fBunmap\fP [\fIdevice\-path\fP]
Unmaps the block device that was mapped via the rbd kernel module.
+.UNINDENT
.SH IMAGE NAME
-In addition to using the \fB\-\-pool\fR and the \fB\-\-snap\fR options, the image name can include both the pool name and the snapshot name. The image name format is as follows:
-.IP
-[\fIpool\fP/]image-name[@\fIsnap\fP]
-.PP
-Thus an image name that contains a slash character ('/') requires specifying the pool name explicitly.
+.sp
+In addition to using the \-\-pool and the \-\-snap options, the image name can include both
+the pool name and the snapshot name. The image name format is as follows:
+.sp
+.nf
+.ft C
+[pool/]image\-name[@snap]
+.ft P
+.fi
+.sp
+Thus an image name that contains a slash character (\(aq/\(aq) requires specifying the pool
+name explicitly.
.SH EXAMPLES
+.sp
To create a new rbd image that is 100 GB:
-.IP
-rbd -p mypool create myimage --size 102400
-.PP
-or alternatively
-.IP
-rbd create mypool/myimage --size 102400
-.PP
-To use a non-default object size (8 MB):
-.IP
-rbd create mypool/myimage --size 102400 --order 23
-.PP
+.sp
+.nf
+.ft C
+rbd \-p mypool create myimage \-\-size 102400
+.ft P
+.fi
+.sp
+or alternatively:
+.sp
+.nf
+.ft C
+rbd create mypool/myimage \-\-size 102400
+.ft P
+.fi
+.sp
+To use a non\-default object size (8 MB):
+.sp
+.nf
+.ft C
+rbd create mypool/myimage \-\-size 102400 \-\-order 23
+.ft P
+.fi
+.sp
To delete an rbd image (be careful!):
-.IP
+.sp
+.nf
+.ft C
rbd rm mypool/myimage
-.PP
+.ft P
+.fi
+.sp
To create a new snapshot:
-.IP
+.sp
+.nf
+.ft C
rbd create mypool/myimage@mysnap
-.PP
+.ft P
+.fi
+.sp
To map an image via the kernel with cephx enabled:
-.IP
-rbd map myimage --user admin --secret secretfile
-.PP
+.sp
+.nf
+.ft C
+rbd map myimage \-\-user admin \-\-secret secretfile
+.ft P
+.fi
+.sp
To unmap an image:
-.IP
+.sp
+.nf
+.ft C
rbd unmap /dev/rbd0
-.PP
+.ft P
+.fi
.SH AVAILABILITY
-.B rbd
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBrbd\fP is part of the Ceph distributed file system. Please refer to
+the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
-.BR ceph (8), rados (8)
+.sp
+\fBceph\fP(8),
+\fBrados\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.