diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-02-11 23:23:51 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-02-11 23:23:51 -0500 |
| commit | 4a765e16e64d0b8479921f2e36b4cb8b97db92b1 (patch) | |
| tree | d5177fbf8ea7a732ae21febbf7e1c006e059ce2e /docs | |
| parent | 4895d5d8db4e57e2ef9a062473a8536f4f07f213 (diff) | |
| parent | f3c6b1b32d614076dc17d2736ae1860d37a36cd5 (diff) | |
| download | cmd2-git-4a765e16e64d0b8479921f2e36b4cb8b97db92b1.tar.gz | |
Merge pull request #270 from python-cmd2/persistent_history
Added optional persistent readline history feature
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/freefeatures.rst | 15 | ||||
| -rw-r--r-- | docs/requirements.txt | 1 |
3 files changed, 11 insertions, 7 deletions
diff --git a/docs/conf.py b/docs/conf.py index d4ef14bf..09d68b9c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,7 +62,7 @@ author = 'Catherine Devlin and Todd Leonhardt' # The short X.Y version. version = '0.8' # The full version, including alpha/beta/rc tags. -release = '0.8.0' +release = '0.8.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst index ea40c87c..a439db56 100644 --- a/docs/freefeatures.rst +++ b/docs/freefeatures.rst @@ -13,7 +13,7 @@ Script files ============ Text files can serve as scripts for your ``cmd2``-based -application, with the ``load``, ``_relative_load``, ``edit`` and ``history`` commands. +application, with the ``load``, ``_relative_load``, and ``edit`` commands. Both ASCII and UTF-8 encoded unicode text files are supported. @@ -25,8 +25,6 @@ Simply include one command per line, typed exactly as you would inside a ``cmd2` .. automethod:: cmd2.Cmd.do_edit -.. automethod:: cmd2.Cmd.do_history - Comments ======== @@ -250,17 +248,22 @@ Searchable command history ========================== All cmd_-based applications have access to previous commands with -the up- and down- cursor keys. +the up- and down- arrow keys. All cmd_-based applications on systems with the ``readline`` module -also provide `bash-like history list editing`_. +also provide `Readline Emacs editing mode`_. With this you can, for example, use **Ctrl-r** to search backward through +the readline history. -.. _`bash-like history list editing`: http://www.talug.org/events/20030709/cmdline_history.html +``cmd2`` adds the option of making this readline history persistent via optional arguments to ``cmd2.Cmd.__init__()``: + +.. automethod:: cmd2.Cmd.__init__ ``cmd2`` makes a third type of history access available with the **history** command: .. automethod:: cmd2.Cmd.do_history +.. _`Readline Emacs editing mode`: http://readline.kablamo.org/emacs.html + Quitting the application ======================== diff --git a/docs/requirements.txt b/docs/requirements.txt index fa4e3570..b50df7d1 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ pyparsing six pyperclip +contextlib2 |