summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2020-09-09 01:09:42 -0400
committerKevin Van Brunt <kmvanbrunt@gmail.com>2020-09-09 01:09:42 -0400
commitd25534abb4c1dac20defe52959040c43ba525d2f (patch)
tree3d8b1ece74d885c16570a94173826650deae0a4e /docs
parent631ed8a5c4f3a6884b5b3398b14998db48b73d40 (diff)
downloadcmd2-git-d25534abb4c1dac20defe52959040c43ba525d2f.tar.gz
Updated documentation about set command
Diffstat (limited to 'docs')
-rw-r--r--docs/features/builtin_commands.rst19
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/features/builtin_commands.rst b/docs/features/builtin_commands.rst
index d5112458..14f340c2 100644
--- a/docs/features/builtin_commands.rst
+++ b/docs/features/builtin_commands.rst
@@ -102,15 +102,16 @@ within a running application:
.. code-block:: text
- (Cmd) set --long
- allow_style: Terminal # Allow ANSI text style sequences in output (valid values: Terminal, Always, Never)
- debug: False # Show full traceback on exception
- echo: False # Echo command issued into output
- editor: vim # Program used by 'edit'
- feedback_to_output: False # include nonessentials in '|', '>' results
- max_completion_items: 50 # Maximum number of CompletionItems to display during tab completion
- quiet: False # Don't print nonessential feedback
- timing: False # Report execution times
+ (Cmd) set --verbose
+ allow_style: 'Terminal' # Allow ANSI text style sequences in output (valid values: Terminal, Always, Never)
+ always_show_hint: False # Display tab completion hint even when completion suggestions print
+ debug: True # Show full traceback on exception
+ echo: False # Echo command issued into output
+ editor: 'vi' # Program used by 'edit'
+ feedback_to_output: False # Include nonessentials in '|', '>' results
+ max_completion_items: 50 # Maximum number of CompletionItems to display during tab completion
+ quiet: False # Don't print nonessential feedback
+ timing: False # Report execution times
Any of these user-settable parameters can be set while running your app with
the ``set`` command like so: