rbd: update manpage for clone command

Signed-off-by: Dan Mick <dan.mick@inktank.com>

diff --git a/doc/man/8/rbd.rst b/doc/man/8/rbd.rst
index 306b430b8e61ef0935a2b3107dc022f71257dc8e..2dd12eccb21f072964f192a183cf3f336f108af7 100644 (file)
--- a/doc/man/8/rbd.rst
+++ b/doc/man/8/rbd.rst
@@ -77,6 +77,10 @@ Commands
 :command:`create` [*image-name*]
   Will create a new rbd image. You must also specify the size via --size.
 
+:command:`clone` [*parent-snapname*] [*image-name*]
+  Will create a clone (copy-on-write child) of the parent snapshot.
+  Size and object order will be identical to parent image unless specified.
+
 :command:`resize` [*image-name*]
   Resizes rbd image. The size parameter also needs to be specified.
 
@@ -156,6 +160,10 @@ To create a new snapshot::
 
        rbd snap create mypool/myimage@mysnap
 
+To create a copy-on-write clone of a snapshot::
+
+       rbd clone myimage@mysnap cloneimage
+
 To delete a snapshot::
 
        rbd snap rm mypool/myimage@mysnap

diff --git a/man/rbd.8 b/man/rbd.8
index 7599896596aee3f7604982f7ee083a599e31dc86..53ac2c9266fc1f39305c95e67938b0098b75cae7 100644 (file)
--- a/man/rbd.8
+++ b/man/rbd.8
@@ -1,4 +1,4 @@
-.TH "RBD" "8" "May 02, 2012" "dev" "Ceph"
+.TH "RBD" "8" "July 10, 2012" "dev" "Ceph"
 .SH NAME
 rbd \- manage rados block device (RBD) images
 .
@@ -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
@@ -99,6 +99,10 @@ Will dump information (such as size and order) about a specific rbd image.
 .B \fBcreate\fP [\fIimage\-name\fP]
 Will create a new rbd image. You must also specify the size via \-\-size.
 .TP
+.B \fBclone\fP [\fIparent\-snapname\fP] [\fIimage\-name\fP]
+Will create a clone (copy\-on\-write child) of the parent snapshot.
+Size and object order will be identical to parent image unless specified.
+.TP
 .B \fBresize\fP [\fIimage\-name\fP]
 Resizes rbd image. The size parameter also needs to be specified.
 .TP
@@ -198,6 +202,14 @@ rbd snap create mypool/myimage@mysnap
 .ft P
 .fi
 .sp
+To create a copy\-on\-write clone of a snapshot:
+.sp
+.nf
+.ft C
+rbd clone myimage@mysnap cloneimage
+.ft P
+.fi
+.sp
 To delete a snapshot:
 .sp
 .nf
@@ -224,13 +236,12 @@ rbd unmap /dev/rbd0
 .SH AVAILABILITY
 .sp
 \fBrbd\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),
 \fBrados\fP(8)
 .SH COPYRIGHT
-2011, New Dream Network
+2012, Inktank Storage, Inc.
 .\" Generated by docutils manpage writer.
-.\" 
 .