From: dparmar18 <dparmar@redhat.com>
Date: Mon, 18 Apr 2022 18:22:05 +0000 (+0530)
Subject: doc/man/cephfs-shell.rst: add use of exclamation mark with cmds
X-Git-Tag: v18.0.0~945^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F45935%2Fhead;p=ceph.git

doc/man/cephfs-shell.rst: add use of exclamation mark with cmds

Description: `!` -  Exclamation mark can be used to interact with local
             file system apart from Ceph File System too. This PR intends
             to document it.

Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
---

diff --git a/doc/man/8/cephfs-shell.rst b/doc/man/8/cephfs-shell.rst
index 65b344fa9126..502423d25376 100644
--- a/doc/man/8/cephfs-shell.rst
+++ b/doc/man/8/cephfs-shell.rst
@@ -62,6 +62,23 @@ Options
 Commands
 ========
 
+.. note::
+
+    Apart from Ceph File System, CephFS Shell commands can also interact
+    directly with the local file system. To achieve this, ``!`` (an
+    exclamation point) must precede the CephFS Shell command.
+
+    Usage :
+
+        !<cephfs_shell_command>
+
+    For example,
+
+    .. code:: bash
+
+        CephFS:~/>>> !ls # Lists the local file system directory contents.
+        CephFS:~/>>> ls  # Lists the Ceph File System directory contents.
+
 mkdir
 -----