summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichal Minar <miminar@redhat.com>2014-02-26 13:10:44 +0100
committerMichal Minar <miminar@redhat.com>2014-02-26 13:10:44 +0100
commitddfcd3d15f43c2930b8459aa53a1bf510d4865b6 (patch)
tree36c1b0ef8450e8fe84af5a83850224b38235b72c /doc
parenta1eaebac55259cf7e733a4c98a4f22fbd1d897bd (diff)
downloadopenlmi-scripts-ddfcd3d15f43c2930b8459aa53a1bf510d4865b6.tar.gz
openlmi-scripts-ddfcd3d15f43c2930b8459aa53a1bf510d4865b6.tar.xz
openlmi-scripts-ddfcd3d15f43c2930b8459aa53a1bf510d4865b6.zip
documented :cd and :.. built-in commands
Diffstat (limited to 'doc')
-rw-r--r--doc/usage.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/usage.rst b/doc/usage.rst
index 58c5a5d..70e19ca 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -104,4 +104,30 @@ Static commands
| | argument. |
+------+------------------------------------------------------------------+
+Changing command namespaces
+---------------------------
+Changing or nesting to some command namespace can be achieved with built-in
+commands ``:cd`` and ``:..``. The latter is just a shortcut for ``:cd ..`` that
+changes to parent namespace. ``:cd`` accepts a path to command. Whole command
+path begins with ``/lmi`` prefix which denotes top-level command. Path
+beginning with a ``'/'`` is an absolute path, which means it contains all
+command names on a path from top-level command to target one. Other paths are
+relative to current command.
+
+Here is a an example of changing command namespaces: ::
+
+ lmi> :pwd
+ /lmi
+ lmi> :cd storage
+ >storage> :pwd
+ /lmi/storage
+ >storage> :cd lv
+ >>lv> :pwd
+ /lmi/storage/lv
+ >>lv> :cd ../raid
+ >>raid> :cd ../../sw/repo
+ >>repo> :..
+ >sw> :cd /storage # /lmi prefix is optional for absolute paths
+ >storage :cd /
+ lmi>