annotate docs/freefeatures.rst @ 314:0687bb650118

begin new docs
author catherine@dellzilla
date Wed, 10 Feb 2010 14:07:01 -0500
parents
children a08c50b7d3d3
rev   line source
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
1 ===================================
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
2 Features requiring no modifications
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
3 ===================================
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
4
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
5 These features are provided "for free" to a cmd_-based application
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
6 simply by replacing ``import cmd`` with ``import cmd2 as cmd``.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
7
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
8 Searchable command history
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
9 ==========================
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
10
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
11 All cmd_-based applications have access to previous commands with
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
12 the up- and down- cursor keys.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
13
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
14 All cmd_-based applications on systems with the ``readline`` module
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
15 also provide `bash-like history list editing`_.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
16
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
17 .. _`bash-like history list editing`: http://www.talug.org/events/20030709/cmdline_history.html
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
18
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
19 ``cmd2`` makes a third type of history access available, consisting of these commands:
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
20
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
21 .. automethod:: cmd2.Cmd.do_history
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
22