]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/man/cephfs-shell.rst: add use of exclamation mark with cmds 45935/head
authordparmar18 <dparmar@redhat.com>
Mon, 18 Apr 2022 18:22:05 +0000 (23:52 +0530)
committerdparmar18 <dparmar@redhat.com>
Tue, 26 Apr 2022 19:09:23 +0000 (00:39 +0530)
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>
doc/man/8/cephfs-shell.rst

index 65b344fa9126ccc06b6cbd403f807012f452f9b9..502423d253764a74c7533d20f0385856d7bb41ac 100644 (file)
@@ -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
 -----