From: Venky Shankar <vshankar@redhat.com>
Date: Fri, 11 Dec 2020 06:48:54 +0000 (-0500)
Subject: doc, man: man page for `cephfs-mirror` tool
X-Git-Tag: v17.0.0~83^2~1
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=42233bb5df647e0f2f493ee2f4ae8ceb947a1697;p=ceph.git

doc, man: man page for `cephfs-mirror` tool

Signed-off-by: Venky Shankar <vshankar@redhat.com>
---

diff --git a/ceph.spec.in b/ceph.spec.in
index 2d0b647c285bf..0808888834728 100644
--- a/ceph.spec.in
+++ b/ceph.spec.in
@@ -1810,6 +1810,7 @@ fi
 
 %files -n cephfs-mirror
 %{_bindir}/cephfs-mirror
+%{_mandir}/man8/cephfs-mirror.8*
 
 %files -n rbd-fuse
 %{_bindir}/rbd-fuse
diff --git a/doc/man/8/CMakeLists.txt b/doc/man/8/CMakeLists.txt
index 5edd16b177fb8..8e1b9373fc83a 100644
--- a/doc/man/8/CMakeLists.txt
+++ b/doc/man/8/CMakeLists.txt
@@ -40,7 +40,8 @@ list(APPEND man_srcs
   ceph-mds.rst
   cephfs-top.rst
   librados-config.rst
-  cephadm.rst)
+  cephadm.rst
+  cephfs-mirror.rst)
 
 if(HAVE_LIBFUSE)
   list(APPEND man_srcs
diff --git a/doc/man/8/cephfs-mirror.rst b/doc/man/8/cephfs-mirror.rst
new file mode 100644
index 0000000000000..3448dd047928d
--- /dev/null
+++ b/doc/man/8/cephfs-mirror.rst
@@ -0,0 +1,66 @@
+:orphan:
+
+============================================================
+ cephfs-mirror -- Ceph daemon for mirroring CephFS snapshots
+============================================================
+
+.. program:: cephfs-mirror
+
+Synopsis
+========
+
+| **cephfs-mirror**
+
+
+Description
+===========
+
+:program:`cephfs-mirror` is a daemon for asynchronous mirroring of Ceph
+Filesystem snapshots among Ceph clusters.
+
+It connects to remote clusters via libcephfs, relying on default search
+paths to find ceph.conf files, i.e. ``/etc/ceph/$cluster.conf`` where
+``$cluster`` is the human-friendly name of the cluster.
+
+
+Options
+=======
+
+.. option:: -c ceph.conf, --conf=ceph.conf
+
+   Use ``ceph.conf`` configuration file instead of the default
+   ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
+
+.. option:: -i ID, --id ID
+
+   Set the ID portion of name for cephfs-mirror
+
+.. option:: -n TYPE.ID, --name TYPE.ID
+
+   Set the rados user name (eg. client.mirror)
+
+.. option:: --cluster NAME
+
+   Set the cluster name (default: ceph)
+
+.. option:: -d
+
+   Run in foreground, log to stderr
+
+.. option:: -f
+
+   Run in foreground, log to usual location
+
+
+Availability
+============
+
+:program:`cephfs-mirror` 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:`ceph <ceph>`\(8)
diff --git a/doc/man_index.rst b/doc/man_index.rst
index 61afac738c0be..30ab1c3eba7a4 100644
--- a/doc/man_index.rst
+++ b/doc/man_index.rst
@@ -24,6 +24,7 @@
    man/8/ceph
    man/8/cephadm
    man/8/cephfs-top
+   man/8/cephfs-mirror
    man/8/crushtool
    man/8/librados-config
    man/8/monmaptool