summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorDan Mick <dan.mick@inktank.com>2012-09-27 14:23:42 -0700
committerDan Mick <dan.mick@inktank.com>2012-09-27 14:33:04 -0700
commit1d231f9364a66d173cdc3d4701259c16ba2ba433 (patch)
treed3f0f5a12fcdf94c297536457979f5dde3e21deb /man
parent3c1e2e19286f62cf792129aaab929bf0468ab60d (diff)
downloadceph-1d231f9364a66d173cdc3d4701259c16ba2ba433.tar.gz
Refresh manpages from .rst sources
Signed-off-by: Dan Mick <dan.mick@inktank.com>
Diffstat (limited to 'man')
-rw-r--r--man/ceph-authtool.82
-rw-r--r--man/ceph-clsinfo.89
-rw-r--r--man/ceph-conf.89
-rw-r--r--man/ceph-debugpack.89
-rw-r--r--man/ceph-dencoder.89
-rw-r--r--man/ceph-fuse.89
-rw-r--r--man/ceph-mds.811
-rw-r--r--man/ceph-mon.89
-rw-r--r--man/ceph-osd.89
-rw-r--r--man/ceph-rbdnamer.89
-rw-r--r--man/ceph-run.89
-rw-r--r--man/ceph-syn.89
-rw-r--r--man/ceph.813
-rw-r--r--man/cephfs.89
-rw-r--r--man/crushtool.819
-rw-r--r--man/librados-config.89
-rw-r--r--man/mkcephfs.811
-rw-r--r--man/monmaptool.835
-rw-r--r--man/mount.ceph.822
-rw-r--r--man/osdmaptool.89
-rw-r--r--man/rados.831
-rw-r--r--man/radosgw-admin.8132
-rw-r--r--man/radosgw.843
-rw-r--r--man/rbd.82
24 files changed, 301 insertions, 137 deletions
diff --git a/man/ceph-authtool.8 b/man/ceph-authtool.8
index 46b150b4203..281db9a7c93 100644
--- a/man/ceph-authtool.8
+++ b/man/ceph-authtool.8
@@ -1,4 +1,4 @@
-.TH "CEPH-AUTHTOOL" "8" "September 26, 2012" "dev" "Ceph"
+.TH "CEPH-AUTHTOOL" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-authtool \- ceph keyring manipulation tool
.
diff --git a/man/ceph-clsinfo.8 b/man/ceph-clsinfo.8
index b5edc57156b..8ef7ade7b2a 100644
--- a/man/ceph-clsinfo.8
+++ b/man/ceph-clsinfo.8
@@ -1,4 +1,4 @@
-.TH "CEPH-CLSINFO" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-CLSINFO" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-clsinfo \- show class object information
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -58,13 +58,12 @@ Shows the class architecture
.SH AVAILABILITY
.sp
\fBceph\-clsinfo\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
+refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-conf.8 b/man/ceph-conf.8
index 0cbea4b88ee..80de2cfc7c6 100644
--- a/man/ceph-conf.8
+++ b/man/ceph-conf.8
@@ -1,4 +1,4 @@
-.TH "CEPH-CONF" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-CONF" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-conf \- ceph conf file tool
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -105,14 +105,13 @@ ceph\-conf \-c foo.conf \-L
.SH AVAILABILITY
.sp
\fBceph\-conf\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
+to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-debugpack.8 b/man/ceph-debugpack.8
index 08d6ed01839..85641ddb274 100644
--- a/man/ceph-debugpack.8
+++ b/man/ceph-debugpack.8
@@ -1,4 +1,4 @@
-.TH "CEPH-DEBUGPACK" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-DEBUGPACK" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-debugpack \- ceph debug packer utility
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -56,13 +56,12 @@ startup.
.SH AVAILABILITY
.sp
\fBceph\-debugpack\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
+refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-dencoder.8 b/man/ceph-dencoder.8
index 3752bc6752d..6b6972a7b28 100644
--- a/man/ceph-dencoder.8
+++ b/man/ceph-dencoder.8
@@ -1,4 +1,4 @@
-.TH "CEPH-DENCODER" "8" "February 21, 2012" "dev" "Ceph"
+.TH "CEPH-DENCODER" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-dencoder \- ceph encoder/decoder utility
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -151,13 +151,12 @@ $ ceph\-dencoder type object_info_t import /tmp/a decode dump_json
.SH AVAILABILITY
.sp
\fBceph\-dencoder\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
+refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-fuse.8 b/man/ceph-fuse.8
index 965eed5ad12..93d4c3f8939 100644
--- a/man/ceph-fuse.8
+++ b/man/ceph-fuse.8
@@ -1,4 +1,4 @@
-.TH "CEPH-FUSE" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-FUSE" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-fuse \- FUSE-based client for ceph
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -78,13 +78,12 @@ Use root_directory as the mounted root, rather than the full Ceph tree.
.SH AVAILABILITY
.sp
\fBceph\-fuse\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.
+the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
fusermount(8),
\fBceph\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-mds.8 b/man/ceph-mds.8
index 6a5a9e8a560..170c38bfa82 100644
--- a/man/ceph-mds.8
+++ b/man/ceph-mds.8
@@ -1,4 +1,4 @@
-.TH "CEPH-MDS" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-MDS" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-mds \- ceph metadata server daemon
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -81,15 +81,14 @@ Connect to specified monitor (instead of looking through
.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\-mon\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.
+\fBceph\-mon\fP is part of the Ceph distributed file system. Please refer to the Ceph documentation at
+\fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBceph\-mon\fP(8),
\fBceph\-osd\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-mon.8 b/man/ceph-mon.8
index 605100c521b..86596ed0f48 100644
--- a/man/ceph-mon.8
+++ b/man/ceph-mon.8
@@ -1,4 +1,4 @@
-.TH "CEPH-MON" "8" "March 30, 2012" "dev" "Ceph"
+.TH "CEPH-MON" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-mon \- ceph monitor daemon
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -97,7 +97,7 @@ Specify a keyring for use with \fB\-\-mkfs\fP.
.SH AVAILABILITY
.sp
\fBceph\-mon\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
+to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
@@ -105,7 +105,6 @@ information.
\fBceph\-mds\fP(8),
\fBceph\-osd\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-osd.8 b/man/ceph-osd.8
index 153cc925761..d26c8126c7f 100644
--- a/man/ceph-osd.8
+++ b/man/ceph-osd.8
@@ -1,4 +1,4 @@
-.TH "CEPH-OSD" "8" "February 17, 2012" "dev" "Ceph"
+.TH "CEPH-OSD" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-osd \- ceph object storage daemon
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -130,7 +130,7 @@ Connect to specified monitor (instead of looking through
.SH AVAILABILITY
.sp
\fBceph\-osd\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.
+the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
@@ -138,7 +138,6 @@ the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
\fBceph\-mon\fP(8),
\fBceph\-authtool\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-rbdnamer.8 b/man/ceph-rbdnamer.8
index d5d7b8b55a4..5e364936d9d 100644
--- a/man/ceph-rbdnamer.8
+++ b/man/ceph-rbdnamer.8
@@ -1,4 +1,4 @@
-.TH "CEPH-RBDNAMER" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-RBDNAMER" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-rbdnamer \- udev helper to name RBD devices
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -49,14 +49,13 @@ KERNEL=="rbd[0\-9]*", PROGRAM="/usr/bin/ceph\-rbdnamer %n", SYMLINK+="rbd/%c{1}/
.SH AVAILABILITY
.sp
\fBceph\-rbdnamer\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
+refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBrbd\fP(8),
\fBceph\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-run.8 b/man/ceph-run.8
index f7a5e9efc48..6d408b08613 100644
--- a/man/ceph-run.8
+++ b/man/ceph-run.8
@@ -1,4 +1,4 @@
-.TH "CEPH-RUN" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-RUN" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-run \- restart daemon on core dump
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -49,7 +49,7 @@ None
.SH AVAILABILITY
.sp
\fBceph\-run\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.
+the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
@@ -57,7 +57,6 @@ the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
\fBceph\-mds\fP(8),
\fBceph\-osd\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph-syn.8 b/man/ceph-syn.8
index a51feaa5ca8..fa9933a042c 100644
--- a/man/ceph-syn.8
+++ b/man/ceph-syn.8
@@ -1,4 +1,4 @@
-.TH "CEPH-SYN" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPH-SYN" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph-syn \- ceph synthetic workload generator
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -110,13 +110,12 @@ Recursively walk the file system (like find).
.SH AVAILABILITY
.sp
\fBceph\-syn\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.
+the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBceph\-fuse\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/ceph.8 b/man/ceph.8
index 94210b2ebcb..b1b2017f08a 100644
--- a/man/ceph.8
+++ b/man/ceph.8
@@ -1,4 +1,4 @@
-.TH "CEPH" "8" "February 17, 2012" "dev" "Ceph"
+.TH "CEPH" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
ceph \- ceph file system control utility
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -107,19 +107,18 @@ A more complete summary of commands understood by the monitor cluster can be fou
wiki, at
.INDENT 0.0
.INDENT 3.5
-\fI\%http://ceph.newdream.net/wiki/Monitor_commands\fP
+\fI\%http://ceph.com/docs/control\fP
.UNINDENT
.UNINDENT
.SH AVAILABILITY
.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.
+\fBceph\fP is part of the Ceph distributed file system. Please refer to the Ceph documentation at
+\fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/cephfs.8 b/man/cephfs.8
index ce64faaca91..9bea58e4c7d 100644
--- a/man/cephfs.8
+++ b/man/cephfs.8
@@ -1,4 +1,4 @@
-.TH "CEPHFS" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CEPHFS" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
cephfs \- ceph file system options utility
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -107,13 +107,12 @@ utilization.
.SH AVAILABILITY
.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
+to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/crushtool.8 b/man/crushtool.8
index 07191baeeb5..aa5be507a01 100644
--- a/man/crushtool.8
+++ b/man/crushtool.8
@@ -1,4 +1,4 @@
-.TH "CRUSHTOOL" "8" "September 22, 2011" "dev" "Ceph"
+.TH "CRUSHTOOL" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
crushtool \- CRUSH map manipulation tool
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -52,7 +52,7 @@ some since then):
.UNINDENT
.UNINDENT
.sp
-The tool has three modes of operation.
+The tool has four modes of operation.
.INDENT 0.0
.TP
.B \-c map.txt
@@ -70,6 +70,14 @@ file, suitable for editing.
will create a relatively generic map with the given layer
structure. See below for examples.
.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-test ...
+.TP
+.B will perform a dry run of a CRUSH mapping for a range of input object
+.TP
+.B \-\-help for more information.
+.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
@@ -134,7 +142,7 @@ crushtool \-c map.txt \-o map
.SH AVAILABILITY
.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
+refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
@@ -142,7 +150,6 @@ information.
\fBosdmaptool\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/librados-config.8 b/man/librados-config.8
index 8329c9c12fa..63d036b601b 100644
--- a/man/librados-config.8
+++ b/man/librados-config.8
@@ -1,4 +1,4 @@
-.TH "LIBRADOS-CONFIG" "8" "September 22, 2011" "dev" "Ceph"
+.TH "LIBRADOS-CONFIG" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
librados-config \- display information about librados
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -55,14 +55,13 @@ Display the \fBlibrados\fP version code
.SH AVAILABILITY
.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
+Please refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for
more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBrados\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/mkcephfs.8 b/man/mkcephfs.8
index 8544a01d0ce..f0ab80d2ccc 100644
--- a/man/mkcephfs.8
+++ b/man/mkcephfs.8
@@ -1,4 +1,4 @@
-.TH "MKCEPHFS" "8" "April 11, 2012" "dev" "Ceph"
+.TH "MKCEPHFS" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
mkcephfs \- create a ceph file system
.
@@ -28,11 +28,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
-\fBmkcephfs\fP [ \-c \fIceph.conf\fP ] [ \-\-mkbtrfs ] [ \-a, \-\-all\-hosts [ \-k
+\fBmkcephfs\fP \-c \fIceph.conf\fP [ \-\-mkbtrfs ] [ \-a, \-\-all\-hosts [ \-k
\fI/path/to/admin.keyring\fP ] ]
.fi
.sp
@@ -158,7 +158,7 @@ authentication keys collected in dir, and put the result in dir.
.SH AVAILABILITY
.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
+to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
@@ -167,7 +167,6 @@ information.
\fBosdmaptool\fP(8),
\fBcrushtool\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/monmaptool.8 b/man/monmaptool.8
index 5e465fe8747..cada2c5ac3f 100644
--- a/man/monmaptool.8
+++ b/man/monmaptool.8
@@ -1,4 +1,4 @@
-.TH "MONMAPTOOL" "8" "February 17, 2012" "dev" "Ceph"
+.TH "MONMAPTOOL" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
monmaptool \- ceph monitor cluster map manipulation tool
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -69,6 +69,32 @@ empty Ceph file system).
.UNINDENT
.INDENT 0.0
.TP
+.B \-\-generate
+generate a new monmap based on the values on the command line or specified
+in the ceph configuration. This is, in order of preference,
+.INDENT 7.0
+.INDENT 3.5
+.INDENT 0.0
+.IP 1. 3
+\fB\-\-monmap filename\fP to specify a monmap to load
+.IP 2. 3
+\fB\-\-mon\-host \(aqhost1,ip2\(aq\fP to specify a list of hosts or ip addresses
+.IP 3. 3
+\fB[mon.foo]\fP sections containing \fBmon addr\fP settings in the config
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-filter\-initial\-members
+filter the initial monmap by applying the \fBmon initial members\fP
+setting. Monitors not present in that list will be removed, and
+initial members not present in the map will be added with dummy
+addresses.
+.UNINDENT
+.INDENT 0.0
+.TP
.B \-\-add name ip:port
will add a monitor with the specified ip:port to the map.
.UNINDENT
@@ -111,7 +137,7 @@ monmaptool \-\-rm mon.a \-\-add mon.a 192.168.0.9:6789 \-\-clobber monmap
.SH AVAILABILITY
.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
+refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
@@ -119,7 +145,6 @@ information.
\fBcrushtool\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/mount.ceph.8 b/man/mount.ceph.8
index 160b8447748..fb28e0390c6 100644
--- a/man/mount.ceph.8
+++ b/man/mount.ceph.8
@@ -1,4 +1,4 @@
-.TH "MOUNT.CEPH" "8" "February 17, 2012" "dev" "Ceph"
+.TH "MOUNT.CEPH" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
mount.ceph \- mount a ceph file system
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -39,10 +39,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.SH DESCRIPTION
.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:
+a Linux host. It serves to resolve monitor hostname(s) into IP
+addresses and read authentication keys from disk; the Linux kernel
+client component does most of the real work. In fact, it is possible
+to mount a non\-authenticated Ceph file system without mount.ceph by
+specifying monitor address(es) by IP:
.sp
.nf
.ft C
@@ -61,6 +62,10 @@ the time of mount.
.sp
A subdirectory subdir may be specified if a subset of the file system
is to be mounted.
+.sp
+Mount helper application conventions dictate that the first two
+options are device to be mounted and destination path. Options must be
+passed only after these fixed arguments.
.SH OPTIONS
.INDENT 0.0
.TP
@@ -189,14 +194,13 @@ mount \-t ceph monhost:/ /mnt/foo
.SH AVAILABILITY
.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
+refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\-fuse\fP(8),
\fBceph\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/osdmaptool.8 b/man/osdmaptool.8
index 4cc6853a562..d94478dfd1d 100644
--- a/man/osdmaptool.8
+++ b/man/osdmaptool.8
@@ -1,4 +1,4 @@
-.TH "OSDMAPTOOL" "8" "September 22, 2011" "dev" "Ceph"
+.TH "OSDMAPTOOL" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
osdmaptool \- ceph osd cluster map manipulation tool
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -92,7 +92,7 @@ osdmaptool \-\-print osdmap
.SH AVAILABILITY
.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
+refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
@@ -100,7 +100,6 @@ information.
\fBcrushtool\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/rados.8 b/man/rados.8
index 75c6280701c..046ffbf433d 100644
--- a/man/rados.8
+++ b/man/rados.8
@@ -1,4 +1,4 @@
-.TH "RADOS" "8" "September 22, 2011" "dev" "Ceph"
+.TH "RADOS" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
rados \- rados object storage utility
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -121,6 +121,28 @@ Remove pool snapshot names \fIfoo\fP.
Benchmark for seconds. The mode can be write or read. The default
object size is 4 MB, and the default number of simulated threads
(parallel writes) is 16.
+.TP
+.B \fBlistomapkeys\fP \fIname\fP
+List all the keys stored in the object map of object name.
+.TP
+.B \fBlistomapvals\fP \fIname\fP
+List all key/value pairs stored in the object map of object name.
+The values are dumped in hexadecimal.
+.TP
+.B \fBgetomapval\fP \fIname\fP \fIkey\fP
+Dump the hexadecimal value of key in the object map of object name.
+.TP
+.B \fBsetomapval\fP \fIname\fP \fIkey\fP \fIvalue\fP
+Set the value of key in the object map of object name.
+.TP
+.B \fBrmomapkey\fP \fIname\fP \fIkey\fP
+Remove key from the object map of object name.
+.TP
+.B \fBgetomapheader\fP \fIname\fP
+Dump the hexadecimal value of the object map header of object name.
+.TP
+.B \fBsetomapheader\fP \fIname\fP \fIvalue\fP
+Set the value of the object map header of object name.
.UNINDENT
.SH EXAMPLES
.sp
@@ -174,12 +196,11 @@ rados \-p foo \-s mysnap get myobject blah.txt.old
.SH AVAILABILITY
.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.
+the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/radosgw-admin.8 b/man/radosgw-admin.8
index 782d35689b2..24f22bcf75b 100644
--- a/man/radosgw-admin.8
+++ b/man/radosgw-admin.8
@@ -1,4 +1,4 @@
-.TH "RADOSGW-ADMIN" "8" "February 17, 2012" "dev" "Ceph"
+.TH "RADOSGW-ADMIN" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
radosgw-admin \- rados REST gateway user administration utility
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -51,22 +51,59 @@ Create a new user
Modify a user
.TP
.B \fBuser info\fP
-Display information of a user
+Display information of a user, and any potentially available
+subusers and keys
.TP
.B \fBuser rm\fP
Remove a user
.TP
+.B \fBsubuser create\fP
+Create a new subuser (primarily useful for clients using the Swift API)
+.TP
+.B \fBsubuser modify\fP
+Modify a subuser
+.TP
+.B \fBsubuser rm\fP
+Remove a subuser
+.TP
.B \fBbucket list\fP
List all buckets
.TP
.B \fBbucket unlink\fP
Remove a bucket
.TP
+.B :command:\(aqbucket rm\(aq
+Remove a bucket
+.TP
+.B :command:\(aqobject rm\(aq
+Remove an object
+.TP
+.B \fBkey create\fP
+Create an access key
+.TP
+.B \fBkey rm\fP
+Remove an access key
+.TP
+.B :command:\(aqpool add\(aq
+Add an existing pool for data placement
+.TP
+.B \fBpool rm\fP
+Remove an existing pool from data placement set
+.TP
+.B \fBpools list\fP
+List placement active set
+.TP
.B \fBpolicy\fP
Display bucket/object policy
.TP
.B \fBlog show\fP
Show the log of a bucket (with a specified date)
+.TP
+.B \fBusage show\fP
+Show the usage information (with optional user and date range)
+.TP
+.B \fBusage trim\fP
+Trim usage information (with optional user and date range)
.UNINDENT
.SH OPTIONS
.INDENT 0.0
@@ -84,12 +121,12 @@ Connect to specified monitor (instead of looking through ceph.conf).
.INDENT 0.0
.TP
.B \-\-uid=uid
-The S3 user/access key.
+The radosgw user ID.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-secret=secret
-The S3 secret.
+The secret associated with a given key.
.UNINDENT
.INDENT 0.0
.TP
@@ -114,33 +151,56 @@ Specify the object name.
.INDENT 0.0
.TP
.B \-\-date=yyyy\-mm\-dd
-The date need for some commands
+The date needed for some commands
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-os\-user=group:name
-The OpenStack user (only needed for use with OpenStack)
+.B \-\-start\-date=yyyy\-mm\-dd
+The start date needed for some commands
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-os\-secret=key
-The OpenStack key
+.B \-\-end\-date=yyyy\-mm\-dd
+The end date needed for some commands
.UNINDENT
.INDENT 0.0
.TP
.B \-\-auth\-uid=auid
The librados auid
.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-purge\-data
+Remove user data before user removal
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-purge\-objects
+Remove all objects before bucket removal
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-lazy\-remove
+Defer removal of object tail
+.UNINDENT
.SH EXAMPLES
.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
+$ radosgw\-admin user create \-\-display\-name="johnny rotten" \-\-uid=johnny
+{ "user_id": "johnny",
+ "rados_uid": 0,
+ "display_name": "johnny rotten",
+ "email": "",
+ "suspended": 0,
+ "subusers": [],
+ "keys": [
+ { "user": "johnny",
+ "access_key": "TCICW53D9BQ2VGC46I44",
+ "secret_key": "tfm9aHMI8X76L3UdgE+ZQaJag1vJQmE6HDb5Lbrz"}],
+ "swift_keys": []}
.ft P
.fi
.sp
@@ -148,7 +208,15 @@ Remove a user:
.sp
.nf
.ft C
-$ radosgw\-admin user rm \-\-uid=CHBQFRTG26I8DGJDGQLW
+$ radosgw\-admin user rm \-\-uid=johnny
+.ft P
+.fi
+.sp
+Remove a user and all associated buckets with their contents:
+.sp
+.nf
+.ft C
+$ radosgw\-admin user rm \-\-uid=johnny \-\-purge\-data
.ft P
.fi
.sp
@@ -160,23 +228,47 @@ $ radosgw\-admin bucket unlink \-\-bucket=foo
.ft P
.fi
.sp
-Show the logs of a bucket from April 1st 2011:
+Show the logs of a bucket from April 1st, 2012:
+.sp
+.nf
+.ft C
+$ radosgw\-admin log show \-\-bucket=foo \-\-date=2012=04\-01
+.ft P
+.fi
+.sp
+Show usage information for user from March 1st to (but not including) April 1st, 2012:
+.sp
+.nf
+.ft C
+$ radosgw\-admin usage show \-\-uid=johnny \e
+ \-\-start\-date=2012\-03\-01 \-\-end\-date=2012\-04\-01
+.ft P
+.fi
+.sp
+Show only summary of usage information for all users:
+.sp
+.nf
+.ft C
+$ radosgw\-admin usage show \-\-show\-log\-entries=false
+.ft P
+.fi
+.sp
+Trim usage information for user until March 1st, 2012:
.sp
.nf
.ft C
-$ radosgw\-admin log show \-\-bucket=foo \-\-date=2011=04\-01
+$ radosgw\-admin usage trim \-\-uid=johnny \-\-end\-date=2012\-04\-01
.ft P
.fi
.SH AVAILABILITY
.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
+refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/radosgw.8 b/man/radosgw.8
index fe09c860a38..6156f972904 100644
--- a/man/radosgw.8
+++ b/man/radosgw.8
@@ -1,4 +1,4 @@
-.TH "RADOSGW" "8" "February 17, 2012" "dev" "Ceph"
+.TH "RADOSGW" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
radosgw \- rados REST gateway
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
@@ -121,7 +121,7 @@ authentication with the cluster:
.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 \(aqallow r\(aq \-\-cap osd \(aqallow rwx\(aq \-\-cap mds \(aqallow\(aq /etc/ceph/keyring.radosgw.gateway
+ceph\-authtool \-n client.radosgw.gateway \-\-cap mon \(aqallow r\(aq \-\-cap osd \(aqallow rwx\(aq /etc/ceph/keyring.radosgw.gateway
.ft P
.fi
.sp
@@ -141,16 +141,47 @@ Now you can start Apache and the radosgw daemon:
/etc/init.d/radosgw start
.ft P
.fi
+.SH USAGE LOGGING
+.sp
+The \fBradosgw\fP maintains an asynchronous usage log. It accumulates
+statistics about user operations and flushes it periodically. The
+logs can be accessed and managed through \fBradosgw\-admin\fP.
+.sp
+The information that is being logged contains total data transfer,
+total operations, and total successful operations. The data is being
+accounted in an hourly resolution under the bucket owner, unless the
+operation was done on the service (e.g., when listing a bucket) in
+which case it is accounted under the operating user.
+.sp
+Following is an example configuration:
+.sp
+.nf
+.ft C
+[client.radosgw.gateway]
+ rgw enable usage log = true
+ rgw usage log tick interval = 30
+ rgw usage log flush threshold = 1024
+ rgw usage max shards = 32
+ rgw usage max user shards = 1
+.ft P
+.fi
+.sp
+The total number of shards determines how many total objects hold the
+usage log information. The per\-user number of shards specify how many
+objects hold usage information for a single user. The tick interval
+configures the number of seconds between log flushes, and the flush
+threshold specify how many entries can be kept before resorting to
+synchronous flush.
.SH AVAILABILITY
.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
+to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\fP(8)
+\fBradosgw\-admin\fP(8)
.SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/man/rbd.8 b/man/rbd.8
index 995fa3f4ff3..7a316214260 100644
--- a/man/rbd.8
+++ b/man/rbd.8
@@ -1,4 +1,4 @@
-.TH "RBD" "8" "September 07, 2012" "dev" "Ceph"
+.TH "RBD" "8" "September 27, 2012" "dev" "Ceph"
.SH NAME
rbd \- manage rados block device (RBD) images
.