summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2019-11-03 14:58:11 -0500
committerTodd Leonhardt <todd.leonhardt@gmail.com>2019-11-03 14:58:11 -0500
commit601b457af97e26c8e228a7ffbc42eb7be8117f8b (patch)
tree355609004729e46fa37bc8095d1a5b4463bbbf8b /docs
parentf626c98934000e3afc6e2e99f61396e56b23dc0c (diff)
downloadcmd2-git-601b457af97e26c8e228a7ffbc42eb7be8117f8b.tar.gz
Improved alias documentationf
Diffstat (limited to 'docs')
-rw-r--r--docs/features/shortcuts_aliases_macros.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/features/shortcuts_aliases_macros.rst b/docs/features/shortcuts_aliases_macros.rst
index b84403c8..2a2bf654 100644
--- a/docs/features/shortcuts_aliases_macros.rst
+++ b/docs/features/shortcuts_aliases_macros.rst
@@ -51,6 +51,14 @@ The syntax to create an alias is: ``alias create name command [args]``.
Ex: ``alias create ls !ls -lF``
+Redirectors and pipes should be quoted in alias definition to prevent the
+``alias create`` command from being redirected::
+
+ alias create save_results print_results ">" out.txt
+
+Tab completion recognizes an alias, and completes as if its actual value
+was on the command line.
+
For more details run: ``help alias create``
Use ``alias list`` to see all or some of your aliases. The output of this