diff options
| author | Ethan McCreadie <ethan.mccreadie@gopuff.com> | 2018-11-01 10:41:28 -0400 |
|---|---|---|
| committer | Ethan McCreadie <ethan.mccreadie@gopuff.com> | 2018-11-01 10:41:28 -0400 |
| commit | ce269173279e2f0560ca50b9e57ff4a089eb7fca (patch) | |
| tree | 97e9578f7f6bcb6d450e0ee52f3f345d45e97f32 /docs | |
| parent | 607106cee4f4b59d2f875e532adbfb154cdd31c5 (diff) | |
| download | cmd2-git-ce269173279e2f0560ca50b9e57ff4a089eb7fca.tar.gz | |
Update docs with smart ANSI handling for ppaged
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/unfreefeatures.rst | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst index 61c0601c..2cdc17ba 100644 --- a/docs/unfreefeatures.rst +++ b/docs/unfreefeatures.rst @@ -146,19 +146,20 @@ The output methods in the previous section all honor the ``colors`` setting, which has three possible values: Never - poutput() and pfeedback() strip all ANSI escape sequences + poutput(), pfeedback(), and ppaged() strip all ANSI escape sequences which instruct the terminal to colorize output Terminal - (the default value) poutput() and pfeedback() 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, preferably using some python color library - like `plumbum.colors`, `colorama`, `blessings`, or `termcolor`. + (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, preferably using some python + color library like `plumbum.colors`, `colorama`, `blessings`, or + `termcolor`. Always - poutput() and pfeedback() never strip ANSI escape sequences, regardless of - the output destination + poutput(), pfeedback(), and ppaged() never strip ANSI escape sequences, + regardless of the output destination .. _quiet: |