doc: updates --dump and --dumpfs

Fixes: https://tracker.ceph.com/issues/57014
Signed-off-by: Jos Collin <jcollin@redhat.com>
(cherry picked from commit 247f81e5b41fea9b1de2151e7318392c03e44c0b)

diff --git a/doc/cephfs/cephfs-top.rst b/doc/cephfs/cephfs-top.rst
index 857a509489d31a036a0b44ddb1f72fbeab7173e9..d6fc33bc13d2e69dcd16b8327a7993c0453db7e0 100644 (file)
--- a/doc/cephfs/cephfs-top.rst
+++ b/doc/cephfs/cephfs-top.rst
@@ -80,6 +80,14 @@ By default, `cephfs-top` connects to cluster name `ceph`. To use a non-default c
 
 Interval should be greater or equal to 0.5 second. Fractional seconds are honoured.
 
+To dump the metrics to stdout without creating a curses display use::
+
+  $ cephfs-top --dump
+
+To dump the metrics of the given filesystem to stdout without creating a curses display use::
+
+  $ cephfs-top --dumpfs <fs_name>
+
 Interactive Commands
 --------------------
 

diff --git a/doc/man/8/cephfs-top.rst b/doc/man/8/cephfs-top.rst
index e20579564d26915d9f10b88b998df66068a06165..fd18ada77ae06bb5a01bda3849179a04b6c8f33d 100644 (file)
--- a/doc/man/8/cephfs-top.rst
+++ b/doc/man/8/cephfs-top.rst
@@ -44,6 +44,14 @@ Options
 
    Refresh interval in seconds (default: 1)
 
+.. option:: --dump
+
+   Dump the metrics to stdout
+
+.. option:: --dumpfs <fs_name>
+
+   Dump the metrics of the given filesystem to stdout
+
 Descriptions of fields
 ======================