add rbd-nbd doc

Signed-off-by: Yunchuan Wen <yunchuan.wen@kylin-cloud.com>

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 344bd8948431f7ce88ad253eb5a3934e54245a64..4b15b9d227596f4f8bd7d88ab26fed2a7c702dd3 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -27,6 +27,7 @@ EXTRA_DIST = \
        man/8/radosgw.rst       \
        man/8/rados.rst \
        man/8/rbd-fuse.rst      \
+       man/8/rbd-nbd.rst       \
        man/8/rbd-replay-many.rst       \
        man/8/rbd-replay-prep.rst       \
        man/8/rbd-replay.rst    \

diff --git a/doc/man/8/rbd-nbd.rst b/doc/man/8/rbd-nbd.rst
new file mode 100644 (file)
index 0000000..635b343
--- /dev/null
+++ b/doc/man/8/rbd-nbd.rst
@@ -0,0 +1,55 @@
+:orphan:
+
+=========================================
+ rbd-nbd -- map rbd images to nbd device
+=========================================
+
+.. program:: rbd-nbd
+
+Synopsis
+========
+
+| **rbd-nbd** [-c conf] [--nbds_max *limit*] [--read-only] [--device *nbd device*] map *image-spec* | *snap-spec*
+| **rbd-nbd** unmap *nbd device*
+| **rbd-nbd** list-mapped
+
+Description
+===========
+
+**rbd-nbd** is a client for RADOS block device (rbd) images like rbd kernel module.
+It will map a rbd image to a nbd (Network Block Device) device, allowing access it
+as regular local block device.
+
+Options
+=======
+
+.. option:: -c ceph.conf
+
+   Use *ceph.conf* configuration file instead of the default
+   ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
+
+.. option:: --nbds_max *limit*
+
+   Override the parameter of NBD kernel module when modprobe, used to
+   limit the count of nbd device.
+
+Image and snap specs
+====================
+
+| *image-spec* is [*pool-name*]/*image-name*
+| *snap-spec*  is [*pool-name*]/*image-name*\ @\ *snap-name*
+
+The default for *pool-name* is "rbd".  If an image name contains a slash
+character ('/'), *pool-name* is required.
+
+Availability
+============
+
+**rbd-nbd** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
+the Ceph documentation at http://ceph.com/docs for more information.
+
+
+See also
+========
+
+:doc:`rbd <rbd>`\(8)

diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt
index ea0ef47609c94936b4913f4524146f13ad4badb9..a56bdb9a1cda918eb8b27fbddc7cb726ab84902e 100644 (file)
--- a/man/CMakeLists.txt
+++ b/man/CMakeLists.txt
@@ -26,6 +26,7 @@ install(FILES
        ceph-rbdnamer.8
        ceph-post-file.8
        rbd-fuse.8
+       rbd-nbd.8
        rbd-replay.8
        rbd-replay-prep.8
   DESTINATION ${CEPH_MAN_DIR}/man8)

diff --git a/man/Makefile-client.am b/man/Makefile-client.am
index 14200f5a8ce227e67a94ede58df3176dbdeaf605..f5e90638d5d8b0ae1d757f9c9db62a72a76e1879 100644 (file)
--- a/man/Makefile-client.am
+++ b/man/Makefile-client.am
@@ -16,6 +16,7 @@ endif
 if WITH_RBD
 dist_man_MANS += \
        ceph-rbdnamer.8 \
+       rbd-nbd.8 \
        rbd-replay.8 \
        rbd-replay-many.8 \
        rbd-replay-prep.8