diff docs/freefeatures.rst @ 314:0687bb650118

begin new docs
author catherine@dellzilla
date Wed, 10 Feb 2010 14:07:01 -0500
parents
children a08c50b7d3d3
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/freefeatures.rst	Wed Feb 10 14:07:01 2010 -0500
@@ -0,0 +1,22 @@
+===================================
+Features requiring no modifications
+===================================
+
+These features are provided "for free" to a cmd_-based application
+simply by replacing ``import cmd`` with ``import cmd2 as cmd``.
+
+Searchable command history
+==========================
+
+All cmd_-based applications have access to previous commands with 
+the up- and down- cursor keys.
+
+All cmd_-based applications on systems with the ``readline`` module
+also provide `bash-like history list editing`_.
+
+.. _`bash-like history list editing`: http://www.talug.org/events/20030709/cmdline_history.html
+
+``cmd2`` makes a third type of history access available, consisting of these commands:
+
+.. automethod:: cmd2.Cmd.do_history
+