annotate docs/freefeatures.rst @ 315:a08c50b7d3d3

doc skeleton
author cat@eee
date Wed, 10 Feb 2010 18:02:55 -0500
parents 0687bb650118
children 21584174d865
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
315
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
8 Script files
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
9 ============
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
10
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
11 Commands can be loaded from, run from, and saved to text files.
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
12
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
13 .. automethod:: cmd2.Cmd.do_load
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
14
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
15 Output redirection
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
16 ==================
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
17
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
18 Commands at start
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
19 =================
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
20
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
21 Python
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
22 ======
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
23
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
24 Searchable command history
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
25 ==========================
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
26
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
27 All cmd_-based applications have access to previous commands with
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
28 the up- and down- cursor keys.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
29
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
30 All cmd_-based applications on systems with the ``readline`` module
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
31 also provide `bash-like history list editing`_.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
32
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
33 .. _`bash-like history list editing`: http://www.talug.org/events/20030709/cmdline_history.html
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
34
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
35 ``cmd2`` makes a third type of history access available, consisting of these commands:
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
36
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
37 .. automethod:: cmd2.Cmd.do_history
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
38
315
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
39 Transcript-based testing
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
40 ========================