summaryrefslogtreecommitdiff
path: root/docs/features/builtin_commands.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/features/builtin_commands.rst')
-rw-r--r--docs/features/builtin_commands.rst26
1 files changed, 16 insertions, 10 deletions
diff --git a/docs/features/builtin_commands.rst b/docs/features/builtin_commands.rst
index 14f340c2..97b160b5 100644
--- a/docs/features/builtin_commands.rst
+++ b/docs/features/builtin_commands.rst
@@ -102,16 +102,22 @@ within a running application:
.. code-block:: text
- (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
+ (Cmd) set
+ Name Value Description
+ ==================================================================================================================
+ 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: