man: regenerate man pages

Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>

diff --git a/man/ceph-mon.8 b/man/ceph-mon.8
index f1812b5aa2232a37a23bb7b298e2c00394d7a0d7..6a4dd9c688b3ee422913ed40cd4d94316b17a5ae 100644 (file)
--- a/man/ceph-mon.8
+++ b/man/ceph-mon.8
@@ -1,4 +1,4 @@
-.TH "CEPH-MON" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-MON" "8" "February 17, 2012" "dev" "Ceph"
 .SH NAME
 ceph-mon \- ceph monitor daemon
 .
@@ -64,6 +64,36 @@ 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
+.B \-\-mkfs
+Initialize the \fBmon data\fP directory with seed information to form
+and initial ceph file system or to join an existing monitor
+cluster.  Three pieces of information must be provided:
+.INDENT 7.0
+.IP \(bu 2
+The cluster fsid.  This can come from a monmap (\fB\-\-monmap <path>\fP) or
+explicitly via \fB\-\-fsid <uuid>\fP.
+.IP \(bu 2
+A list of monitors and their addresses.  This list of monitors
+can come from a monmap (\fB\-\-monmap <path>\fP), the \fBmon host\fP
+configuration value (in \fIceph.conf\fP or via \fB\-m
+host1,host2,...\(ga), or \(ga\(gamon addr\fP lines in \fIceph.conf\fP.  If this
+monitor is to be part of the initial monitor quorum for a new
+Ceph cluster, then it must be included in the initial list,
+matching either the name or address of a monitor in the list.
+When matching by address, either the \fBpublic addr\fP or \fBpublic
+subnet\fP options may be used.
+.IP \(bu 2
+The monitor secret key \fBmon.\fP.  This must be included in the
+keyring provided via \fB\-\-keyring <path>\fP.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-keyring
+Specify a keyring for use with \fB\-\-mkfs\fP.
+.UNINDENT
 .SH AVAILABILITY
 .sp
 \fBceph\-mon\fP is part of the Ceph distributed file system. Please refer

diff --git a/man/ceph-osd.8 b/man/ceph-osd.8
index bcc9c7f500b941a670ad0a644c7630aeb35d96e8..153cc92576144bd2196253a431d2cfde6b459e61 100644 (file)
--- a/man/ceph-osd.8
+++ b/man/ceph-osd.8
@@ -1,4 +1,4 @@
-.TH "CEPH-OSD" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-OSD" "8" "February 17, 2012" "dev" "Ceph"
 .SH NAME
 ceph-osd \- ceph object storage daemon
 .
@@ -99,6 +99,24 @@ you won\(aqt lose data.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-\-get\-cluster\-fsid
+Print the cluster fsid (uuid) and exit.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-get\-osd\-fsid
+Print the OSD\(aqs fsid and exit.  The OSD\(aqs uuid is generated at
+\-\-mkfs time and is thus unique to a particular instantiation of
+this OSD.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-get\-journal\-fsid
+Print the journal\(aqs uuid.  The journal fsid is set to match the OSD
+fsid at \-\-mkfs time.
+.UNINDENT
+.INDENT 0.0
+.TP
 .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.

diff --git a/man/ceph.8 b/man/ceph.8
index ba41bb0c5a3a9aff613f18e5449b4da170dd1060..94210b2ebcb9b4ca39e4be487a45ed78f3c813d6 100644 (file)
--- a/man/ceph.8
+++ b/man/ceph.8
@@ -1,4 +1,4 @@
-.TH "CEPH" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH" "8" "February 17, 2012" "dev" "Ceph"
 .SH NAME
 ceph \- ceph file system control utility
 .
@@ -47,13 +47,11 @@ 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:
+Watch mode shows cluster state changes as they occur. For example:
 .sp
 .nf
 .ft C
-ceph \-C ceph.conf \-w
+ceph \-w
 .ft P
 .fi
 .SS Command line mode

diff --git a/man/monmaptool.8 b/man/monmaptool.8
index f4f5a2b009bc0f98d0b282523a9bf2f2b2560b7d..5e465fe874720e02444ac3cb61b2f1af04e901df 100644 (file)
--- a/man/monmaptool.8
+++ b/man/monmaptool.8
@@ -1,4 +1,4 @@
-.TH "MONMAPTOOL" "8" "September 22, 2011" "dev" "Ceph"
+.TH "MONMAPTOOL" "8" "February 17, 2012" "dev" "Ceph"
 .SH NAME
 monmaptool \- ceph monitor cluster map manipulation tool
 .
@@ -77,6 +77,11 @@ will add a monitor with the specified ip:port to the map.
 .B \-\-rm name
 will remove the monitor with the specified ip:port from the map.
 .UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-fsid uuid
+will set the fsid to the given uuid.  If not specified with \-\-create, a random fsid will be generated.
+.UNINDENT
 .SH EXAMPLE
 .sp
 To create a new map with three monitors (for a fresh Ceph file system):

diff --git a/man/mount.ceph.8 b/man/mount.ceph.8
index 90177945026f081c10424c4c2a5414bdeb0ccb1c..160b8447748c5a036f4eed329a17aa12d43cc182 100644 (file)
--- a/man/mount.ceph.8
+++ b/man/mount.ceph.8
@@ -1,4 +1,4 @@
-.TH "MOUNT.CEPH" "8" "September 22, 2011" "dev" "Ceph"
+.TH "MOUNT.CEPH" "8" "February 17, 2012" "dev" "Ceph"
 .SH NAME
 mount.ceph \- mount a ceph file system
 .
@@ -107,10 +107,14 @@ memory. Default: calculated from available memory
 string, set the name of the hidden snapdir. Default: .snap
 .TP
 .B \fBname\fP
-string, used with cephx, Default: guest
+RADOS user to authenticate as when using cephx. Default: guest
 .TP
 .B \fBsecret\fP
-string, used with cephx
+secret key for use with cephx. This option is insecure because it exposes
+the secret on the command line. To avoid this, use the secretfile option.
+.TP
+.B \fBsecretfile\fP
+path to file containing the secret key to use with cephx
 .TP
 .B \fBip\fP
 my ip

diff --git a/man/radosgw-admin.8 b/man/radosgw-admin.8
index 3c2c09858ffe80551acbdaf6f94dd978e1fd6336..782d35689b232efc31f2b9fc54524217b49d6587 100644 (file)
--- a/man/radosgw-admin.8
+++ b/man/radosgw-admin.8
@@ -1,4 +1,4 @@
-.TH "RADOSGW-ADMIN" "8" "September 22, 2011" "dev" "Ceph"
+.TH "RADOSGW-ADMIN" "8" "February 17, 2012" "dev" "Ceph"
 .SH NAME
 radosgw-admin \- rados REST gateway user administration utility
 .
@@ -32,12 +32,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .SH SYNOPSIS
 .nf
-\fBradosgw-admin\fP \fIcommand\fP [ \fIoptions\fP \fI...\fP ]
+\fBradosgw\-admin\fP \fIcommand\fP [ \fIoptions\fP \fI...\fP ]
 .fi
 .sp
 .SH DESCRIPTION
 .sp
-\fBradosgw-admin\fP is a RADOS gateway user administration utility. It
+\fBradosgw\-admin\fP is a RADOS gateway user administration utility. It
 allows creating and modifying users.
 .SH COMMANDS
 .sp
@@ -137,7 +137,7 @@ Generate a new user:
 .sp
 .nf
 .ft C
-$ radosgw-admin user gen \-\-display\-name="johnny rotten" \-\-email=johnny@rotten.com
+$ radosgw\-admin user gen \-\-display\-name="johnny rotten" \-\-email=johnny@rotten.com
 User ID: CHBQFRTG26I8DGJDGQLW
 Secret Key: QR6cI/31N+J0VKVgHSpEGVSfEEsmf6PyXG040KCB
 Display Name: johnny rotten
@@ -148,7 +148,7 @@ Remove a user:
 .sp
 .nf
 .ft C
-$ radosgw-admin user rm \-\-uid=CHBQFRTG26I8DGJDGQLW
+$ radosgw\-admin user rm \-\-uid=CHBQFRTG26I8DGJDGQLW
 .ft P
 .fi
 .sp
@@ -156,7 +156,7 @@ Remove a bucket:
 .sp
 .nf
 .ft C
-$ radosgw-admin bucket unlink \-\-bucket=foo
+$ radosgw\-admin bucket unlink \-\-bucket=foo
 .ft P
 .fi
 .sp
@@ -164,12 +164,12 @@ Show the logs of a bucket from April 1st 2011:
 .sp
 .nf
 .ft C
-$ radosgw-admin log show \-\-bucket=foo \-\-date=2011=04\-01
+$ radosgw\-admin log show \-\-bucket=foo \-\-date=2011=04\-01
 .ft P
 .fi
 .SH AVAILABILITY
 .sp
-\fBradosgw-admin\fP is part of the Ceph distributed file system.  Please
+\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

diff --git a/man/radosgw.8 b/man/radosgw.8
index 3119c57cea92d7b5cddeb70953677bc77cce2a82..fe09c860a38ee5034a02c8d0ae7c452b25dd331e 100644 (file)
--- a/man/radosgw.8
+++ b/man/radosgw.8
@@ -1,4 +1,4 @@
-.TH "RADOSGW" "8" "September 22, 2011" "dev" "Ceph"
+.TH "RADOSGW" "8" "February 17, 2012" "dev" "Ceph"
 .SH NAME
 radosgw \- rados REST gateway
 .
@@ -61,11 +61,11 @@ Specify a unix domain socket path.
 .UNINDENT
 .SH CONFIGURATION
 .sp
-Currently it's the easiest to use the RADOS Gateway with Apache and mod_fastcgi
+Currently it\(aqs the easiest to use the RADOS Gateway with Apache and mod_fastcgi:
 .sp
 .nf
 .ft C
-FastCgiExternalServer /var/www/s3gw.fcgi -socket /tmp/radosgw.sock
+FastCgiExternalServer /var/www/s3gw.fcgi \-socket /tmp/radosgw.sock
 
 <VirtualHost *:80>
   ServerName rgw.example1.com
@@ -93,17 +93,18 @@ FastCgiExternalServer /var/www/s3gw.fcgi -socket /tmp/radosgw.sock
 .ft P
 .fi
 .sp
-And the corresponding radosgw script (/var/www/s3gw.fgci):
+And the corresponding radosgw script (/var/www/s3gw.fcgi):
 .sp
 .nf
 .ft C
 #!/bin/sh
-exec /usr/bin/radosgw -c /etc/ceph/ceph.conf -n client.radosgw.gateway
+exec /usr/bin/radosgw \-c /etc/ceph/ceph.conf \-n client.radosgw.gateway
 .ft P
 .fi
 .sp
-The radosgw daemon is a standalone process which needs a configuration section in the ceph.conf
-The section name should start with 'client.radosgw.' as specified in /etc/init.d/radosgw
+The radosgw daemon is a standalone process which needs a configuration
+section in the ceph.conf The section name should start with
+\(aqclient.radosgw.\(aq as specified in /etc/init.d/radosgw:
 .sp
 .nf
 .ft C
@@ -114,24 +115,25 @@ The section name should start with 'client.radosgw.' as specified in /etc/init.d
 .ft P
 .fi
 .sp
-You will also have to generate a key for the radosgw to use for authentication with the cluster
+You will also have to generate a key for the radosgw to use for
+authentication with the cluster:
 .sp
 .nf
 .ft C
-ceph-authtool -C -n client.radosgw.gateway --gen-key /etc/ceph/keyring.radosgw.gateway
-ceph-authtool -n client.radosgw.gateway --cap mon 'allow r' --cap osd 'allow rwx' --cap mds 'allow' /etc/ceph/keyring.radosgw.gateway
+ceph\-authtool \-C \-n client.radosgw.gateway \-\-gen\-key /etc/ceph/keyring.radosgw.gateway
+ceph\-authtool \-n client.radosgw.gateway \-\-cap mon \(aqallow r\(aq \-\-cap osd \(aqallow rwx\(aq \-\-cap mds \(aqallow\(aq /etc/ceph/keyring.radosgw.gateway
 .ft P
 .fi
 .sp
-And add the key to the auth entries
+And add the key to the auth entries:
 .sp
 .nf
 .ft C
-ceph auth add client.radosgw.gateway --in-file=keyring.radosgw.gateway
+ceph auth add client.radosgw.gateway \-\-in\-file=keyring.radosgw.gateway
 .ft P
 .fi
 .sp
-Now you can start Apache and the radosgw daemon
+Now you can start Apache and the radosgw daemon:
 .sp
 .nf
 .ft C

diff --git a/man/rbd.8 b/man/rbd.8
index 0278137d8578cc69cbb9313ec4d189c81bcfe326..ff20f034ff5f0ed78faa1b6591b036790c5f7d43 100644 (file)
--- a/man/rbd.8
+++ b/man/rbd.8
@@ -1,4 +1,4 @@
-.TH "RBD" "8" "September 22, 2011" "dev" "Ceph"
+.TH "RBD" "8" "February 17, 2012" "dev" "Ceph"
 .SH NAME
 rbd \- manage rados block device (RBD) images
 .
@@ -194,7 +194,15 @@ To create a new snapshot:
 .sp
 .nf
 .ft C
-rbd create mypool/myimage@mysnap
+rbd snap create mypool/myimage@mysnap
+.ft P
+.fi
+.sp
+To delete a snapshot:
+.sp
+.nf
+.ft C
+rbd snap rm mypool/myimage@mysnap
 .ft P
 .fi
 .sp