packaging: rbdmap manpage

Signed-off-by: Nathan Cutler <ncutler@suse.com>

diff --git a/ceph.spec.in b/ceph.spec.in
index a82a7e18254329e5bc94a6147f8472a76eb09a8f..f15202e97ba55b174205f7ff6c5faef7d4340042 100644 (file)
--- a/ceph.spec.in
+++ b/ceph.spec.in
@@ -995,6 +995,7 @@ rm -rf $RPM_BUILD_ROOT
 %{_mandir}/man8/ceph.8*
 %{_mandir}/man8/rados.8*
 %{_mandir}/man8/rbd.8*
+%{_mandir}/man8/rbdmap.8*
 %{_mandir}/man8/rbd-replay.8*
 %{_mandir}/man8/rbd-replay-many.8*
 %{_mandir}/man8/rbd-replay-prep.8*

diff --git a/debian/ceph-common.install b/debian/ceph-common.install
index 7edd8906ee7fb61d4051ab2a8e16675b58a21b63..465ba89dc99086c9ef3a2a8c4fe9b2df4c5cbbbd 100644 (file)
--- a/debian/ceph-common.install
+++ b/debian/ceph-common.install
@@ -25,6 +25,7 @@ usr/share/man/man8/ceph-post-file.8
 usr/share/man/man8/ceph.8
 usr/share/man/man8/rados.8
 usr/share/man/man8/rbd.8
+usr/share/man/man8/rbdmap.8
 usr/share/man/man8/rbd-replay*.8
 usr/share/ceph/known_hosts_drop.ceph.com
 usr/share/ceph/id_dsa_drop.ceph.com

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 75c0ce7b5231456b16a312ac87692725dcc7ee4d..c4bcfc7c6f10d9341ff04791cea96e0d39fc0058 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -33,4 +33,5 @@ EXTRA_DIST = \
        man/8/rbd-replay-many.rst       \
        man/8/rbd-replay-prep.rst       \
        man/8/rbd-replay.rst    \
-       man/8/rbd.rst
+       man/8/rbd.rst           \
+       man/8/rbdmap.rst

diff --git a/doc/man/8/rbdmap.rst b/doc/man/8/rbdmap.rst
index 6a5471510653ef4d5fd7e665a9afaca12489aa06..145a1e2cbfccd9069d434416f82fff798c38e34e 100644 (file)
--- a/doc/man/8/rbdmap.rst
+++ b/doc/man/8/rbdmap.rst
@@ -9,18 +9,23 @@
 Synopsis
 ========
 
-| **rbdmap**
+| **rbdmap map**
+| **rbdmap unmap**
 
 
 Description
 ===========
 
-**rbdmap** is a shell script that is intended to be run at boot time
-by the init system (sysvinit, upstart, systemd). It looks for an
-environment variable ``RBDMAPFILE``, which defaults to
-``/etc/ceph/rbdmap``. This file is expected to contain a list of RBD
-devices to be mapped (via the ``rbd map`` command) and mounted at boot
-time.
+**rbdmap** is a shell script that can be run manually by the system
+administrator at any time, or automatically at boot time by the init system
+(sysvinit, upstart, systemd). The script looks for an environment variable
+``RBDMAPFILE``, which defaults to ``/etc/ceph/rbdmap``. This file is
+expected to contain a list of RBD images and, possibly, parameters to be
+passed to the underlying ``rbd`` command. The syntax of
+``/etc/ceph/rbdmap`` is described in the comments at the top of that file.
+
+The script mounts devices after mapping, and unmounts them before
+unmapping.
 
 
 Options