Skip to content

Commit

Permalink
man: refresh content from rst
Browse files Browse the repository at this point in the history
Signed-off-by: Josh Durgin <[email protected]>
  • Loading branch information
jdurgin committed Apr 29, 2013
1 parent ffc8557 commit 4abf081
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 21 deletions.
6 changes: 3 additions & 3 deletions man/crushtool.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CRUSHTOOL" "8" "September 27, 2012" "dev" "Ceph"
.TH "CRUSHTOOL" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
crushtool \- CRUSH map manipulation tool
.
Expand Down Expand Up @@ -66,7 +66,7 @@ file, suitable for editing.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-build numosds layer1 ...
.B \-\-build \-\-num_osds {num\-osds} layer1 ...
will create a relatively generic map with the given layer
structure. See below for examples.
.UNINDENT
Expand Down Expand Up @@ -150,6 +150,6 @@ information.
\fBosdmaptool\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
17 changes: 6 additions & 11 deletions man/mkcephfs.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "MKCEPHFS" "8" "September 27, 2012" "dev" "Ceph"
.TH "MKCEPHFS" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
mkcephfs \- create a ceph file system
.
Expand Down Expand Up @@ -112,15 +112,10 @@ config file).
.INDENT 0.0
.TP
.B \-\-mkfs
Create and mount any file systems specified in the
ceph.conf for OSD data storage using mkfs.*. The "devs"
and (if it differs from "osd data") "fs path" options must be
defined.
.sp
\fBNOTE\fP Btrfs is still considered experimental. This option
can ease some configuration pain, but the use of this option is not
required when \fBosd data\fP directories are mounted manually by the
adminstrator.
Create and mount the file systems specified in the ceph.conf for
OSD data storage using mkfs.$type. The \fBdevs\fP option in ceph.conf
must specify the device(s) and the \fBosd mkfs type\fP option must
specify the file system type (normally one of btrfs, xfs, or ext4).
.UNINDENT
.INDENT 0.0
.TP
Expand Down Expand Up @@ -164,6 +159,6 @@ information.
\fBosdmaptool\fP(8),
\fBcrushtool\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
6 changes: 3 additions & 3 deletions man/rados.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "RADOS" "8" "September 27, 2012" "dev" "Ceph"
.TH "RADOS" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
rados \- rados object storage utility
.
Expand Down Expand Up @@ -90,7 +90,7 @@ counts, over the entire system and broken down by pool.
.B \fBmkpool\fP \fIfoo\fP
Create a pool with name foo.
.TP
.B \fBrmpool\fP \fIfoo\fP [ \flfoo\fP \-\-yes\-i\-really\-really\-mean\-it ]
.B \fBrmpool\fP \fIfoo\fP [ \fIfoo\fP \-\-yes\-i\-really\-really\-mean\-it ]
Delete the pool foo (and all its data)
.UNINDENT
.SH POOL SPECIFIC COMMANDS
Expand Down Expand Up @@ -201,6 +201,6 @@ the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.sp
\fBceph\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
35 changes: 31 additions & 4 deletions man/rbd.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "RBD" "8" "January 02, 2013" "dev" "Ceph"
.TH "RBD" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
rbd \- manage rados block device (RBD) images
.
Expand Down Expand Up @@ -60,6 +60,12 @@ Connect to specified monitor (instead of looking through ceph.conf).
.B \-p pool, \-\-pool pool
Interact with the given pool. Required by most commands.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-progress
Do not output progress information (goes to standard error by
default for some commands).
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.TP
Expand Down Expand Up @@ -140,7 +146,7 @@ Specifies output formatting (default: plain, json, xml)
.INDENT 0.0
.TP
.B \-\-pretty\-format
Make json or xml formatted output more human-readable.
Make json or xml formatted output more human\-readable.
.UNINDENT
.SH COMMANDS
.INDENT 0.0
Expand Down Expand Up @@ -181,8 +187,9 @@ every pool, and outputs the resulting poolname/imagename.
.sp
This requires format 2.
.TP
.B \fBresize\fP [\fIimage\-name\fP]
.B \fBresize\fP [\fIimage\-name\fP] [\-\-allow\-shrink]
Resizes rbd image. The size parameter also needs to be specified.
The \-\-allow\-shrink option lets the size be reduced.
.TP
.B \fBrm\fP [\fIimage\-name\fP]
Deletes an rbd image (including all data blocks). If the image has
Expand All @@ -197,6 +204,26 @@ stdin). The import operation will try to create sparse rbd images
if possible. For import from stdin, the sparsification unit is
the data block size of the destination image (1 << order).
.TP
.B \fBexport\-diff\fP [\fIimage\-name\fP] [\fIdest\-path\fP] [\-\-from\-snap \fIsnapname\fP]
Exports an incremental diff for an image to dest path (use \- for stdout). If
an initial snapshot is specified, only changes since that snapshot are included; otherwise,
any regions of the image that contain data are included. The end snapshot is specified
using the standard \-\-snap option or @snap syntax (see below). The image diff format includes
metadata about image size changes, and the start and end snapshots. It efficiently represents
discarded or \(aqzero\(aq regions of the image.
.TP
.B \fBimport\-diff\fP [\fIsrc\-path\fP] [\fIimage\-name\fP]
Imports an incremental diff of an image and applies it to the current image. If the diff
was generated relative to a start snapshot, we verify that snapshot already exists before
continuing. If there was an end snapshot we verify it does not already exist before
applying the changes, and create the snapshot when we are done.
.TP
.B \fBdiff\fP [\fIimage\-name\fP] [\-\-from\-snap \fIsnapname\fP]
Dump a list of byte extents in the image that have changed since the specified start
snapshot, or since the image was created. Each output line includes the starting offset
(in bytes), the length of the region (in bytes), and either \(aqzero\(aq or \(aqdata\(aq to indicate
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.
Expand Down Expand Up @@ -453,6 +480,6 @@ the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
\fBceph\fP(8),
\fBrados\fP(8)
.SH COPYRIGHT
2010-2012, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.

0 comments on commit 4abf081

Please sign in to comment.