annotate docs/overview.rst @ 413:f16f444a4d10
added arg_desc to @options, thanks Renzo Crispiatico
| author |
Catherine Devlin <catherine.devlin@gmail.com> |
| date |
Fri, 12 Nov 2010 20:03:21 -0500 |
| parents |
0687bb650118 |
| children |
|
| rev |
line source |
|
314
|
1
|
|
|
2 ========
|
|
|
3 Overview
|
|
|
4 ========
|
|
|
5
|
|
|
6 ``cmd2`` is an extension of cmd_, the Python Standard Library's module for
|
|
|
7 creating simple interactive command-line applications.
|
|
|
8
|
|
|
9 ``cmd2`` can be used as a drop-in replacement for cmd_. Simply importing ``cmd2``
|
|
|
10 in place of cmd_ will add many features to an application without any further
|
|
|
11 modifications.
|
|
|
12
|
|
|
13 Understanding the use of cmd_ is the first step in learning the use of ``cmd2``.
|
|
|
14 Once you have read the cmd_ docs, return here to learn the ways that ``cmd2``
|
|
|
15 differs from cmd_.
|
|
|
16
|
|
|
17 .. _cmd: http://docs.python.org/library/cmd.html |
