diff options
Diffstat (limited to 'docs/features/settings.rst')
| -rw-r--r-- | docs/features/settings.rst | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/docs/features/settings.rst b/docs/features/settings.rst index 5e2280cd..a8c0705f 100644 --- a/docs/features/settings.rst +++ b/docs/features/settings.rst @@ -23,25 +23,28 @@ show all settings and to modify the value of any setting. allow_style ~~~~~~~~~~~ -The ``allow_style`` setting controls the behavior of ANSI escape sequences -in output generated with any of the following methods: - -- ``poutput()`` -- ``perror()`` -- ``pwarning()`` -- ``pfeedback()`` -- ``ppaged()`` +Output generated by ``cmd2`` programs may contain ANSI escape seqences which +instruct the terminal to apply colors or text styling (i.e. bold) to the +output. The ``allow_style`` setting controls the behavior of these escape +sequences in output generated with any of the following methods: + +- :meth:`.cmd2.Cmd.poutput` +- :meth:`.cmd2.Cmd.perror` +- :meth:`.cmd2.Cmd.pwarning` +- :meth:`.cmd2.Cmd.pexcept` +- :meth:`.cmd2.Cmd.pfeedback` +- :meth:`.cmd2.Cmd.ppaged` This setting can be one of three values: -- ``Never`` - all ANSI escape sequences which instruct the terminal to colorize +- ``Never`` - all ANSI escape sequences which instruct the terminal to style output are stripped from the output. - ``Terminal`` - (the default value) pass through ANSI escape sequences when the output is being sent to the terminal, but if the output is redirected to a pipe or a file the escape sequences are stripped. -- ``Always`` - ANSI escape sequences are always passed through, regardless +- ``Always`` - ANSI escape sequences are always passed through to the output continuation_prompt |