summaryrefslogtreecommitdiff
path: root/docs/features/multiline_commands.rst
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2019-07-06 20:31:00 -0400
committerKevin Van Brunt <kmvanbrunt@gmail.com>2019-07-06 20:31:00 -0400
commit3470b8861298b7e2e04f8f49befe98598c5a3b2a (patch)
tree81d63f9ac6e89d4ccc61d9afc6cf3d1054f878f6 /docs/features/multiline_commands.rst
parent901aa9ed176507071198e84978891c69cc6e9d3b (diff)
parent34975b52e769514b44ee8c13147a22961e68e7a7 (diff)
downloadcmd2-git-3470b8861298b7e2e04f8f49befe98598c5a3b2a.tar.gz
Merge branch 'master' into auto_completer_refactor
Diffstat (limited to 'docs/features/multiline_commands.rst')
-rw-r--r--docs/features/multiline_commands.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/features/multiline_commands.rst b/docs/features/multiline_commands.rst
new file mode 100644
index 00000000..d6502058
--- /dev/null
+++ b/docs/features/multiline_commands.rst
@@ -0,0 +1,12 @@
+Multiline Commands
+==================
+
+Command input may span multiple lines for the commands whose names are listed
+in the ``multiline_commands`` argument to ``cmd2.Cmd.__init__()``. These
+commands will be executed only after the user has entered a *terminator*. By
+default, the command terminator is ``;``; specifying the ``terminators``
+optional argument to ``cmd2.Cmd.__init__()`` allows different terminators. A
+blank line is *always* considered a command terminator (cannot be overridden).
+
+In multiline commands, output redirection characters like ``>`` and ``|`` are
+part of the command arguments unless they appear after the terminator.