diff options
Diffstat (limited to 'docs/features/generating_output.rst')
| -rw-r--r-- | docs/features/generating_output.rst | 12 |
1 files changed, 6 insertions, 6 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()` |