From 574cb61efe9fb98c0f01d347b06b4868c37aacd7 Mon Sep 17 00:00:00 2001 From: Josh Durgin Date: Mon, 18 Nov 2013 18:05:18 -0800 Subject: [PATCH] man: re-generate changed man pages Signed-off-by: Josh Durgin --- man/ceph-authtool.8 | 25 ++++--------------------- man/ceph-conf.8 | 3 +-- man/ceph-debugpack.8 | 3 ++- man/ceph-osd.8 | 5 ++--- man/ceph-post-file.8 | 41 +++-------------------------------------- man/ceph.8 | 3 +-- man/crushtool.8 | 36 ++++++++++++++++-------------------- man/monmaptool.8 | 5 ++--- man/osdmaptool.8 | 3 +-- man/rados.8 | 7 +++++-- man/radosgw.8 | 4 ++-- man/rbd.8 | 22 +++++++++++----------- 12 files changed, 50 insertions(+), 107 deletions(-) diff --git a/man/ceph-authtool.8 b/man/ceph-authtool.8 index e64cac95f0a59..7ae5b986055a3 100644 --- a/man/ceph-authtool.8 +++ b/man/ceph-authtool.8 @@ -1,4 +1,4 @@ -.TH "CEPH-AUTHTOOL" "8" "April 29, 2013" "dev" "Ceph" +.TH "CEPH-AUTHTOOL" "8" "November 18, 2013" "dev" "Ceph" .SH NAME ceph-authtool \- ceph keyring manipulation tool . @@ -34,7 +34,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .nf \fBceph\-authtool\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 ] +\-\-add\-key \fIbase64_key\fP ] [ \-\-caps \fIcapfile\fP ] .fi .sp .SH DESCRIPTION @@ -69,33 +69,16 @@ will create a new keyring, overwriting any existing keyringfile .UNINDENT .INDENT 0.0 .TP -.B \-g, \-\-gen\-key +.B \-\-gen\-key will generate a new secret key for the specified entityname .UNINDENT .INDENT 0.0 .TP -.B \-a, \-\-add\-key +.B \-\-add\-key will add an encoded key to the keyring .UNINDENT .INDENT 0.0 .TP -.B \-u, \-\-set\-uid -sets the auid (authenticated user id) for the specified entityname -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gen\-print\-key -will generate and print a new secret key without adding it to the keyringfile - -NOTE: will work without a given keyringfile -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-import\-keyring -will import the content of a given keyring into the keyringfile -.UNINDENT -.INDENT 0.0 -.TP .B \-\-cap subsystem capability will set the capability for given subsystem .UNINDENT diff --git a/man/ceph-conf.8 b/man/ceph-conf.8 index bfec81535da45..18d028d0e768f 100644 --- a/man/ceph-conf.8 +++ b/man/ceph-conf.8 @@ -1,4 +1,4 @@ -.TH "CEPH-CONF" "8" "April 29, 2013" "dev" "Ceph" +.TH "CEPH-CONF" "8" "November 18, 2013" "dev" "Ceph" .SH NAME ceph-conf \- ceph conf file tool . @@ -110,7 +110,6 @@ information. .SH SEE ALSO .sp \fBceph\fP(8), -\fBmkcephfs\fP(8) .SH COPYRIGHT 2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA .\" Generated by docutils manpage writer. diff --git a/man/ceph-debugpack.8 b/man/ceph-debugpack.8 index 69db7c3682e2d..e6ab02c1b9b67 100644 --- a/man/ceph-debugpack.8 +++ b/man/ceph-debugpack.8 @@ -1,4 +1,4 @@ -.TH "CEPH-DEBUGPACK" "8" "April 29, 2013" "dev" "Ceph" +.TH "CEPH-DEBUGPACK" "8" "November 18, 2013" "dev" "Ceph" .SH NAME ceph-debugpack \- ceph debug packer utility . @@ -61,6 +61,7 @@ information. .SH SEE ALSO .sp \fBceph\fP(8) +\fBceph\-post\-file\fP(8) .SH COPYRIGHT 2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA .\" Generated by docutils manpage writer. diff --git a/man/ceph-osd.8 b/man/ceph-osd.8 index f60ce183d8f2a..2131624efac42 100644 --- a/man/ceph-osd.8 +++ b/man/ceph-osd.8 @@ -1,4 +1,4 @@ -.TH "CEPH-OSD" "8" "April 29, 2013" "dev" "Ceph" +.TH "CEPH-OSD" "8" "November 18, 2013" "dev" "Ceph" .SH NAME ceph-osd \- ceph object storage daemon . @@ -71,8 +71,7 @@ Journal updates to \fIjournal\fP. .INDENT 0.0 .TP .B \-\-mkfs -Create an empty object repository. Normally invoked by -\fBmkcephfs\fP(8). This also initializes the journal +Create an empty object repository. This also initializes the journal (if one is defined). .UNINDENT .INDENT 0.0 diff --git a/man/ceph-post-file.8 b/man/ceph-post-file.8 index 110f3c223b817..bd8adf54bec4e 100644 --- a/man/ceph-post-file.8 +++ b/man/ceph-post-file.8 @@ -1,6 +1,4 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-POST-FILE" "8" "August 14, 2013" "dev" "Ceph" +.TH "CEPH-POST-FILE" "8" "November 18, 2013" "dev" "Ceph" .SH NAME ceph-post-file \- post files for ceph developers . @@ -30,33 +28,8 @@ 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 reStructuredText. . -.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 -.. .SH SYNOPSIS .nf \fBceph\-post\-file\fP [\-d \fIdescription] [\-u *user\fP] \fIfile or dir\fP ... @@ -89,33 +62,25 @@ to reference a bug number. There is no default value. .INDENT 0.0 .TP .B \-u *user* -Set the user metadata for the upload. This defaults to \fIwhoami\(ga@\(gahostname \-f\fP\&. +Set the user metadata for the upload. This defaults to \fIwhoami\(ga@\(gahostname \-f\fP. .UNINDENT .SH EXAMPLES .sp To upload a single log: -.INDENT 0.0 -.INDENT 3.5 .sp .nf .ft C ceph\-post\-file /var/log/ceph/ceph\-mon.\(gahostname\(ga.log .ft P .fi -.UNINDENT -.UNINDENT .sp To upload several directories: -.INDENT 0.0 -.INDENT 3.5 .sp .nf .ft C ceph\-post\-file \-d \(aqmon data directories\(aq /var/log/ceph/mon/* .ft P .fi -.UNINDENT -.UNINDENT .SH AVAILABILITY .sp \fBceph\-post\-file\fP is part of the Ceph distributed file system. Please refer to diff --git a/man/ceph.8 b/man/ceph.8 index 4f2caf3e8ca06..ac45349537dd9 100644 --- a/man/ceph.8 +++ b/man/ceph.8 @@ -1,4 +1,4 @@ -.TH "CEPH" "8" "April 29, 2013" "dev" "Ceph" +.TH "CEPH" "8" "November 18, 2013" "dev" "Ceph" .SH NAME ceph \- ceph file system control utility . @@ -117,7 +117,6 @@ online documentation, at .SH SEE ALSO .sp \fBceph\fP(8), -\fBmkcephfs\fP(8) .SH COPYRIGHT 2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA .\" Generated by docutils manpage writer. diff --git a/man/crushtool.8 b/man/crushtool.8 index 26b21a3aee2ee..90332016741f4 100644 --- a/man/crushtool.8 +++ b/man/crushtool.8 @@ -1,4 +1,4 @@ -.TH "CRUSHTOOL" "8" "April 29, 2013" "dev" "Ceph" +.TH "CRUSHTOOL" "8" "November 18, 2013" "dev" "Ceph" .SH NAME crushtool \- CRUSH map manipulation tool . @@ -32,8 +32,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .SH SYNOPSIS .nf -\fBcrushtool\fP ( \-d \fImap\fP | \-c \fImap.txt\fP | \-\-build \fInumosds\fP -\fIlayer1\fP \fI...\fP ) [ \-o \fIoutfile\fP [ \-\-clobber ]] +\fBcrushtool\fP ( \-d \fImap\fP | \-c \fImap.txt\fP | \-\-build \-\-num_osds \fInumosds\fP +\fIlayer1\fP \fI...\fP ) [ \-o \fIoutfile\fP ] .fi .sp .SH DESCRIPTION @@ -72,11 +72,9 @@ 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. +.B \-\-test +will perform a dry run of a CRUSH mapping for a range of input object +names, see crushtool \-\-help for more information. .UNINDENT .SH OPTIONS .INDENT 0.0 @@ -84,11 +82,6 @@ structure. See below for examples. .B \-o outfile will specify the output file. .UNINDENT -.INDENT 0.0 -.TP -.B \-\-clobber -will allow the tool to overwrite an existing outfile (it will normally refuse). -.UNINDENT .SH BUILDING A MAP .sp The build mode will generate relatively generic hierarchical maps. The @@ -115,13 +108,17 @@ The third component is the maximum size of the bucket. If the size is preceding layer. .SH EXAMPLE .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: +Suppose we have two rows with two racks each and 20 nodes per rack. Suppose +each node contains 4 storage devices for Ceph OSD Daemons. This configuration +allows us to deploy 320 Ceph OSD Daemons. Lets assume a 42U rack with 2U nodes, +leaving an extra 2U for a rack switch. +.sp +To reflect our hierarchy of devices, nodes, racks and rows, we would execute +the following: .sp .nf .ft C -crushtool \-\-build 128 shelf uniform 4 rack straw 8 root straw 0 \-o map +crushtool \-o crushmap \-\-build \-\-num_osds 320 node straw 4 rack straw 20 row straw 2 .ft P .fi .sp @@ -130,13 +127,13 @@ To adjust the default (generic) mapping rules, we can run: .nf .ft C # decompile -crushtool \-d map \-o map.txt +crushtool \-d crushmap \-o map.txt # edit vi map.txt # recompile -crushtool \-c map.txt \-o map +crushtool \-c map.txt \-o crushmap .ft P .fi .SH AVAILABILITY @@ -148,7 +145,6 @@ information. .sp \fBceph\fP(8), \fBosdmaptool\fP(8), -\fBmkcephfs\fP(8) .SH COPYRIGHT 2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA .\" Generated by docutils manpage writer. diff --git a/man/monmaptool.8 b/man/monmaptool.8 index 76308545d5bd6..bb6d976629be2 100644 --- a/man/monmaptool.8 +++ b/man/monmaptool.8 @@ -1,4 +1,4 @@ -.TH "MONMAPTOOL" "8" "April 29, 2013" "dev" "Ceph" +.TH "MONMAPTOOL" "8" "November 18, 2013" "dev" "Ceph" .SH NAME monmaptool \- ceph monitor cluster map manipulation tool . @@ -123,7 +123,7 @@ To display the contents of the map: .sp .nf .ft C -monmaptool \-\-print onmap +monmaptool \-\-print monmap .ft P .fi .sp @@ -143,7 +143,6 @@ information. .sp \fBceph\fP(8), \fBcrushtool\fP(8), -\fBmkcephfs\fP(8) .SH COPYRIGHT 2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA .\" Generated by docutils manpage writer. diff --git a/man/osdmaptool.8 b/man/osdmaptool.8 index edc6dc2042f61..1c024dc96d288 100644 --- a/man/osdmaptool.8 +++ b/man/osdmaptool.8 @@ -1,4 +1,4 @@ -.TH "OSDMAPTOOL" "8" "April 29, 2013" "dev" "Ceph" +.TH "OSDMAPTOOL" "8" "November 18, 2013" "dev" "Ceph" .SH NAME osdmaptool \- ceph osd cluster map manipulation tool . @@ -98,7 +98,6 @@ information. .sp \fBceph\fP(8), \fBcrushtool\fP(8), -\fBmkcephfs\fP(8) .SH COPYRIGHT 2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA .\" Generated by docutils manpage writer. diff --git a/man/rados.8 b/man/rados.8 index ff067a35b3e02..a10408386a008 100644 --- a/man/rados.8 +++ b/man/rados.8 @@ -1,4 +1,4 @@ -.TH "RADOS" "8" "April 29, 2013" "dev" "Ceph" +.TH "RADOS" "8" "November 18, 2013" "dev" "Ceph" .SH NAME rados \- rados object storage utility . @@ -111,11 +111,14 @@ List objects in given pool and write to outfile. .B \fBlssnap\fP List snapshots for given pool. .TP +.B \fBclonedata\fP \fIsrcname\fP \fIdstname\fP \-\-object\-locator \fIkey\fP +Clone object byte data from \fIsrcname\fP to \fIdstname\fP. Both objects must be stored with the locator key \fIkey\fP (usually either \fIsrcname\fP or \fIdstname\fP). Object attributes and omap keys are not copied or cloned. +.TP .B \fBmksnap\fP \fIfoo\fP Create pool snapshot named \fIfoo\fP. .TP .B \fBrmsnap\fP \fIfoo\fP -Remove pool snapshot names \fIfoo\fP. +Remove pool snapshot named \fIfoo\fP. .TP .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 diff --git a/man/radosgw.8 b/man/radosgw.8 index 44f86078a4824..9a7e71855c47c 100644 --- a/man/radosgw.8 +++ b/man/radosgw.8 @@ -1,4 +1,4 @@ -.TH "RADOSGW" "8" "April 29, 2013" "dev" "Ceph" +.TH "RADOSGW" "8" "November 18, 2013" "dev" "Ceph" .SH NAME radosgw \- rados REST gateway . @@ -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 /etc/ceph/keyring.radosgw.gateway +ceph\-authtool \-n client.radosgw.gateway \-\-cap mon \(aqallow rw\(aq \-\-cap osd \(aqallow rwx\(aq /etc/ceph/keyring.radosgw.gateway .ft P .fi .sp diff --git a/man/rbd.8 b/man/rbd.8 index 88048674614e3..627196be4bcc0 100644 --- a/man/rbd.8 +++ b/man/rbd.8 @@ -1,4 +1,4 @@ -.TH "RBD" "8" "April 29, 2013" "dev" "Ceph" +.TH "RBD" "8" "November 18, 2013" "dev" "Ceph" .SH NAME rbd \- manage rados block device (RBD) images . @@ -176,7 +176,7 @@ Object order will be identical to that of the parent image unless specified. Size will be the same as the parent snapshot. .sp The parent snapshot must be protected (see \fIrbd snap protect\fP). -This requires format 2. +This requires image format 2. .TP .B \fBflatten\fP [\fIimage\-name\fP] If image is a clone, copy all shared blocks from the parent snapshot and @@ -184,13 +184,13 @@ make the child independent of the parent, severing the link between parent snap and child. The parent snapshot can be unprotected and deleted if it has no further dependent clones. .sp -This requires format 2. +This requires image format 2. .TP .B \fBchildren\fP [\fIimage\-name\fP] List the clones of the image at the given snapshot. This checks every pool, and outputs the resulting poolname/imagename. .sp -This requires format 2. +This requires image format 2. .TP .B \fBresize\fP [\fIimage\-name\fP] [\-\-allow\-shrink] Resizes rbd image. The size parameter also needs to be specified. @@ -231,7 +231,7 @@ whether the region is known to be zeros or may contain other data. .TP .B \fBcp\fP [\fIsrc\-image\fP] [\fIdest\-image\fP] Copies the content of a src\-image into the newly created dest\-image. -dest\-image will have the same size, order, and format as src\-image. +dest\-image will have the same size, order, and image format as src\-image. .TP .B \fBmv\fP [\fIsrc\-image\fP] [\fIdest\-image\fP] Renames an image. Note: rename across pools is not supported. @@ -259,14 +259,14 @@ protection implies that there exist dependent cloned children that refer to this snapshot. \fIrbd clone\fP will fail on a nonprotected snapshot. .sp -This requires format 2. +This requires image format 2. .TP .B \fBsnap\fP unprotect [\fIimage\-name\fP] Unprotect a snapshot from deletion (undo \fIsnap protect\fP). If cloned children remain, \fIsnap unprotect\fP fails. (Note that clones may exist in different pools than the parent snapshot.) .sp -This requires format 2. +This requires image format 2. .TP .B \fBmap\fP [\fIimage\-name\fP] Maps the specified image to a block device via the rbd kernel module. @@ -436,7 +436,7 @@ To create an image and a clone from it: .sp .nf .ft C -rbd import \-\-format 2 image mypool/parent +rbd import \-\-image\-format 2 image mypool/parent rbd snap create \-\-snap snapname mypool/parent rbd snap protect mypool/parent@snap rbd clone mypool/parent@snap otherpool/child @@ -451,13 +451,13 @@ rbd \-p mypool create myimage \-\-size 102400 \-\-stripe\-unit 65536 \-\-stripe\ .ft P .fi .sp -To change an image from one format to another, export it and then -import it as the desired format: +To change an image from one image format to another, export it and then +import it as the desired image format: .sp .nf .ft C rbd export mypool/myimage@snap /tmp/img -rbd import \-\-format 2 /tmp/img mypool/myimage2 +rbd import \-\-image\-format 2 /tmp/img mypool/myimage2 .ft P .fi .sp