Skip to content

Commit

Permalink
man: re-generate changed man pages
Browse files Browse the repository at this point in the history
Signed-off-by: Josh Durgin <[email protected]>
  • Loading branch information
jdurgin committed Nov 19, 2013
1 parent 0de0efa commit 574cb61
Show file tree
Hide file tree
Showing 12 changed files with 50 additions and 107 deletions.
25 changes: 4 additions & 21 deletions man/ceph-authtool.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions man/ceph-conf.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion man/ceph-debugpack.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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.
Expand Down
5 changes: 2 additions & 3 deletions man/ceph-osd.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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
Expand Down
41 changes: 3 additions & 38 deletions man/ceph-post-file.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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 ...
Expand Down Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions man/ceph.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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.
Expand Down
36 changes: 16 additions & 20 deletions man/crushtool.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -72,23 +72,16 @@ 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
.TP
.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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand Down
5 changes: 2 additions & 3 deletions man/monmaptool.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions man/osdmaptool.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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.
Expand Down
7 changes: 5 additions & 2 deletions man/rados.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions man/radosgw.8
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit 574cb61

Please sign in to comment.