diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-12-19 16:04:06 -0500 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-12-19 16:04:06 -0500 |
| commit | 801bab847341fb9a35d10f1d0b4a629a4fc8f14c (patch) | |
| tree | 889c2d21f0922e68b0c880a6c0c9b3e83c307cd1 /docs | |
| parent | e13fc34e6f7d9e67422595411b62ff12b8bf769b (diff) | |
| download | cmd2-git-801bab847341fb9a35d10f1d0b4a629a4fc8f14c.tar.gz | |
Changed allow_ansi to allow_style for accuracy in what types of ANSI escape sequences are handled
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/features/generating_output.rst | 12 | ||||
| -rw-r--r-- | docs/features/settings.rst | 4 |
2 files changed, 8 insertions, 8 deletions
diff --git a/docs/features/generating_output.rst b/docs/features/generating_output.rst index 2ee820f1..e83b5fdf 100644 --- a/docs/features/generating_output.rst +++ b/docs/features/generating_output.rst @@ -45,23 +45,23 @@ changing the value of the ``quiet`` setting. Colored Output -------------- -The output methods in the previous section all honor the ``allow_ansi`` +The output methods in the previous section all honor the ``allow_style`` setting, which has three possible values: Never - poutput(), pfeedback(), and ppaged() strip all ANSI escape sequences + poutput(), pfeedback(), and ppaged() strip all ANSI style sequences which instruct the terminal to colorize output Terminal (the default value) poutput(), pfeedback(), and ppaged() do not strip any - ANSI escape sequences when the output is a terminal, but if the output is a - pipe or a file the escape sequences are stripped. If you want colorized - output you must add ANSI escape sequences using either cmd2's internal ansi + ANSI style sequences when the output is a terminal, but if the output is a + pipe or a file the style sequences are stripped. If you want colorized + output you must add ANSI style sequences using either cmd2's internal ansi module or another color library such as `plumbum.colors`, `colorama`, or `colored`. Always - poutput(), pfeedback(), and ppaged() never strip ANSI escape sequences, + poutput(), pfeedback(), and ppaged() never strip ANSI style sequences, regardless of the output destination Colored and otherwise styled output can be generated using the `ansi.style()` diff --git a/docs/features/settings.rst b/docs/features/settings.rst index b0575468..7cc0d727 100644 --- a/docs/features/settings.rst +++ b/docs/features/settings.rst @@ -46,7 +46,7 @@ comments, is viewable from within a running application with:: (Cmd) set --long - allow_ansi: Terminal # Allow ANSI escape sequences in output (valid values: Terminal, Always, Never) + allow_style: Terminal # Allow ANSI style sequences in output (valid values: Terminal, Always, Never) continuation_prompt: > # On 2nd+ line of input debug: False # Show full error stack on error echo: False # Echo command issued into output @@ -61,7 +61,7 @@ with:: Any of these user-settable parameters can be set while running your app with the ``set`` command like so:: - set allow_ansi Never + set allow_style Never |