diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2018-09-25 17:57:52 -0400 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2018-09-25 17:57:52 -0400 |
| commit | ecbaf000ca0384b5caafb0d79725a127e65bb2d5 (patch) | |
| tree | 13ee319941e842602ee3f058ac8be79a2e459961 /docs | |
| parent | 854bd1af2d29c5f2a596ab6ddd6bf8e005ae9d2b (diff) | |
| download | cmd2-git-ecbaf000ca0384b5caafb0d79725a127e65bb2d5.tar.gz | |
Added more examples and documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/unfreefeatures.rst | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst index 1b8adb8d..60630258 100644 --- a/docs/unfreefeatures.rst +++ b/docs/unfreefeatures.rst @@ -191,11 +191,11 @@ what exit code is sent to the shell when your application exits from ``cmdloop()``. -Asynchronous printing +Asynchronous Feedback ===================== ``cmd2`` provides two functions to provide asynchronous feedback to the user without interfering with the command line. This means the feedback is provided to the user when they are still entering text at -the prompt. To use this functionality, the application must be running in any terminal that supports +the prompt. To use this functionality, the application must be running in a terminal that supports VT100 control characters and readline. Linux, Mac, and Windows 10 and greater all support these. async_alert() @@ -208,6 +208,13 @@ async_update_prompt() changes dynamically in between commands. For instance you could alter the color of the prompt to indicate a system status or increase a counter to report an event. +``cmd2`` also provides a function to change the title of the terminal window. This feature requires the +application be running in a terminal that support VT100 control characters. Linux, Mac, and Windows 10 and +greater all support these. + +set_window_title() + Sets the terminal window title + The easiest way to understand these function is to see the AsyncPrinting_ example for a demonstration. |