]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
man: refresh content from rst
authorJosh Durgin <josh.durgin@inktank.com>
Mon, 29 Apr 2013 23:01:03 +0000 (16:01 -0700)
committerJosh Durgin <josh.durgin@inktank.com>
Mon, 29 Apr 2013 23:01:03 +0000 (16:01 -0700)
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
man/crushtool.8
man/mkcephfs.8
man/rados.8
man/rbd.8

index aa5be507a0132716abf2d259441af4ccfaee2b4c..26b21a3aee2ee14d471657c04d2b4dc86851677f 100644 (file)
@@ -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
 .
@@ -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
@@ -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.
 .
index 26276b76030a7ec80f4ff88714e12277a4c952fb..0341f495214ffa32d44f26f98cff618555d917fd 100644 (file)
@@ -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
 .
@@ -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
@@ -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.
 .
index ef65f651e9808fa4ab3ad83b4a09a88b30cf00f0..ff067a35b3e02fa99548e71529f18a80249278bb 100644 (file)
@@ -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
 .
@@ -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
@@ -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.
 .
index ee3bff7b5fb10715378a4097f880ec1cdf0490d5..27a74aaa19ae79c9f1ca7cca17c249632dd44a53 100644 (file)
--- a/man/rbd.8
+++ b/man/rbd.8
@@ -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
 .
@@ -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
@@ -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
@@ -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
@@ -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.
@@ -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.
 .