diff options
author | kotfu <kotfu@kotfu.net> | 2019-07-05 15:05:51 -0600 |
---|---|---|
committer | kotfu <kotfu@kotfu.net> | 2019-07-05 15:05:51 -0600 |
commit | 9e64f600b65d99ea5a83051372372512be698b1b (patch) | |
tree | 7409d3646ff4a0fa349b8e71daa5959cbde342bf /docs/features/multiline_commands.rst | |
parent | 4c97ab03825151fd85a875617fde7d0534c9cb72 (diff) | |
download | cmd2-git-9e64f600b65d99ea5a83051372372512be698b1b.tar.gz |
Added a walkthrough of constructing a simple application to the overview
For #709
Diffstat (limited to 'docs/features/multiline_commands.rst')
-rw-r--r-- | docs/features/multiline_commands.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/features/multiline_commands.rst b/docs/features/multiline_commands.rst new file mode 100644 index 00000000..85a92bb2 --- /dev/null +++ b/docs/features/multiline_commands.rst @@ -0,0 +1,17 @@ +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. |