view 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
line wrap: on
line source


========
Overview
========

``cmd2`` is an extension of cmd_, the Python Standard Library's module for
creating simple interactive command-line applications.  

``cmd2`` can be used as a drop-in replacement for cmd_.  Simply importing ``cmd2``
in place of cmd_ will add many features to an application without any further
modifications.

Understanding the use of cmd_ is the first step in learning the use of ``cmd2``.
Once you have read the cmd_ docs, return here to learn the ways that ``cmd2``
differs from cmd_.

.. _cmd: http://docs.python.org/library/cmd.html