diff options
Diffstat (limited to 'docs/api/parsing.rst')
| -rw-r--r-- | docs/api/parsing.rst | 35 |
1 files changed, 30 insertions, 5 deletions
diff --git a/docs/api/parsing.rst b/docs/api/parsing.rst index 4ee6606d..c79c8f6b 100644 --- a/docs/api/parsing.rst +++ b/docs/api/parsing.rst @@ -8,11 +8,6 @@ cmd2.parsing The name of the command after shortcuts and macros have been expanded - .. attribute:: multiline_command - - If the command is a multi-line command, the name of the command will be - in this attribute. Otherwise, it will be an empty string. - .. attribute:: args The arguments to the command as a string with spaces between the words, @@ -43,6 +38,36 @@ cmd2.parsing this string, but there will be embedded newlines where the user hit return to continue the command on the next line. + .. attribute:: multiline_command + + If the command is a multi-line command, the name of the command will be + in this attribute. Otherwise, it will be an empty string. + + .. attribute:: terminator + + If the command is a multi-line command, this attribute contains the + termination character entered by the user to signal the end of input + + .. attribute:: suffix + + Any characters present between the input terminator and the output + redirection tokens. + + .. attribute:: pipe_to + + If the user piped the output to a shell command, this attribute contains + the entire shell command as a string. Otherwise it is an empty string. + + .. attribute:: output + + If output was redirected by the user, this contains the redirection + token, i.e. ``>>``. + + .. attribute:: output_to + + If output was redirected by the user, this contains the requested destination with + quotes preserved. + .. autoclass:: cmd2.parsing.StatementParser :members: |