diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/cmd.rst | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst index 34c0dcf7..3fcd3352 100644 --- a/docs/api/cmd.rst +++ b/docs/api/cmd.rst @@ -24,8 +24,19 @@ cmd2.Cmd .. attribute:: prompt - The prompt issued to solicit input. - Default: ``(Cmd)``. + The prompt issued to solicit input. The default value is ``(Cmd)``. + See :ref:`features/prompt:Prompt` for more information. + + .. attribute:: continuation_prompt + + The prompt issued to solicit input for the 2nd and subsequent lines + of a :ref:`multiline command <features/multiline_commands:Multiline Commands>` + + .. attribute:: echo + + If ``True``, output the prompt and user input before executing the command. + When redirecting a series of commands to an output file, this allows you to + see the command in the output. .. attribute:: settable @@ -47,3 +58,8 @@ cmd2.Cmd An instance of :class:`cmd2.parsing.StatementParser` initialized and configured appropriately for parsing user input. + + .. attribute:: intro + + Set an introduction message which is displayed to the user before + the :ref:`features/hooks:Command Processing Loop` begins. |