diff options
Diffstat (limited to 'docs/settingchanges.rst')
| -rw-r--r-- | docs/settingchanges.rst | 52 |
1 files changed, 27 insertions, 25 deletions
diff --git a/docs/settingchanges.rst b/docs/settingchanges.rst index 290e4e08..d2bf2cc7 100644 --- a/docs/settingchanges.rst +++ b/docs/settingchanges.rst @@ -4,21 +4,21 @@ Features requiring only parameter changes Several aspects of a ``cmd2`` application's behavior can be controlled simply by setting attributes of ``App``. -A parameter can also be changed at runtime by the user *if* +A parameter can also be changed at runtime by the user *if* its name is included in the dictionary ``app.settable``. (To define your own user-settable parameters, see :ref:`parameters`) Case-insensitivity ================== -By default, all ``cmd2`` command names are case-insensitive; -``sing the blues`` and ``SiNg the blues`` are equivalent. To change this, +By default, all ``cmd2`` command names are case-insensitive; +``sing the blues`` and ``SiNg the blues`` are equivalent. To change this, set ``App.case_insensitive`` to False. Whether or not you set ``case_insensitive``, *please do not* define command method names with any uppercase letters. ``cmd2`` will probably do something evil if you do. - + Shortcuts ========= @@ -28,16 +28,16 @@ like ``!ls``. By default, the following shortcuts are defined: ``?`` help - - ``!`` + + ``!`` shell: run as OS-level command - + ``@`` load script file - + ``@@`` load script file; filename is relative to current script location - + To define more shortcuts, update the dict ``App.shortcuts`` with the {'shortcut': 'command_name'} (omit ``do_``):: @@ -56,7 +56,7 @@ shortcut:: (Cmd) !which python /usr/bin/python -However, if the parameter ``default_to_shell`` is +However, if the parameter ``default_to_shell`` is ``True``, then *every* command will be attempted on the operating system. Only if that attempt fails (i.e., produces a nonzero return value) will the @@ -90,9 +90,10 @@ Setting ``App.debug`` to ``True`` will produce detailed error stacks whenever the application generates an error. |settable| .. |settable| replace:: The user can ``set`` this parameter - during application execution. + during application execution. (See :ref:`parameters`) +.. _parameters: Other user-settable parameters ============================== @@ -101,18 +102,19 @@ A list of all user-settable parameters, with brief comments, is viewable from within a running application with:: - (Cmd) set --long - abbrev: True # Accept abbreviated commands - case_insensitive: True # upper- and lower-case both OK - colors: True # Colorized output (*nix only) - continuation_prompt: > # On 2nd+ line of input - debug: False # Show full error stack on error - default_file_name: command.txt # for ``save``, ``load``, etc. - echo: False # Echo command issued into output - editor: gedit # Program used by ``edit`` - feedback_to_output: False # include nonessentials in `|`, `>` results - prompt: (Cmd) # - quiet: False # Don't print nonessential feedback - timing: False # Report execution times - + (Cmd) set --long + abbrev: True # Accept abbreviated commands + autorun_on_edit: True # Automatically run files after editing + case_insensitive: True # upper- and lower-case both OK + colors: True # Colorized output (*nix only) + continuation_prompt: > # On 2nd+ line of input + debug: False # Show full error stack on error + default_file_name: command.txt # for ``save``, ``load``, etc. + echo: False # Echo command issued into output + editor: vim # Program used by ``edit`` + feedback_to_output: False # include nonessentials in `|`, `>` results + locals_in_py: True # Allow access to your application in py via self + prompt: (Cmd) # The prompt issued to solicit input + quiet: False # Don't print nonessential feedback + timing: False # Report execution times |