From: Vikhyat Umrao <vumrao@redhat.com>
Date: Mon, 19 Oct 2015 12:27:15 +0000 (+0530)
Subject: doc: Adding --cluster option to rbd man page.
X-Git-Tag: v10.0.1~100
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=b30d1b8d002aa4835d33644d7019ed97d3e2d34a;p=ceph.git

doc: Adding --cluster option to rbd man page.

Fixes #13457
Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
---

diff --git a/doc/man/8/rbd.rst b/doc/man/8/rbd.rst
index d7eb72d7c9d22..826120fa1f2cc 100644
--- a/doc/man/8/rbd.rst
+++ b/doc/man/8/rbd.rst
@@ -9,8 +9,8 @@
 Synopsis
 ========
 
-| **rbd** [ -c *ceph.conf* ] [ -m *monaddr* ] [ -p | --pool *pool* ] [
-  --size *size* ] [ --order *bits* ] [ *command* ... ]
+| **rbd** [ -c *ceph.conf* ] [ -m *monaddr* ] [--cluster *cluster name*]
+  [ -p | --pool *pool* ] [--size *size* ] [ --order *bits* ] [ *command* ... ] 
 
 
 Description
@@ -35,6 +35,10 @@ Options
 
    Connect to specified monitor (instead of looking through ceph.conf).
 
+.. option:: --cluster cluster name
+
+   Use different cluster name as compared to default cluster name *ceph*.
+
 .. option:: -p pool-name, --pool pool-name
 
    Interact with the given pool. Required by most commands.
@@ -478,6 +482,10 @@ To map an image via the kernel with cephx enabled::
 
        rbd map mypool/myimage --id admin --keyfile secretfile
 
+To map an image via the kernel with different cluster name other than default *ceph*.
+
+       rbd map mypool/myimage --cluster *cluster name*
+
 To unmap an image::
 
        rbd unmap /dev/rbd0