diff options
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..58feacc --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,72 @@ +.. cmd2 documentation master file, created by + sphinx-quickstart on Wed Feb 10 12:05:28 2010. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +cmd2 +==== + +A python package for building powerful command-line interpreter (CLI) +programs. Extends the Python Standard Library's cmd_ package. + + +.. _`cmd2 project page`: http://www.assembla.com/wiki/show/python-cmd2 +.. _`project bug tracker`: http://trac-hg.assembla.com/python-cmd2/report/1 + +.. _cmd: http://docs.python.org/library/cmd.html#module-cmd + +The basic use of ``cmd2`` is identical to that of cmd_. + +1. Create a subclass of ``cmd2.Cmd``. Define attributes and + ``do_*`` methods to control its behavior. Throughout this documentation, + we will assume that you are naming your subclass ``App``:: + + from cmd2 import Cmd + class App(Cmd): + # customized attributes and methods here + +2. Instantiate ``App`` and start the command loop:: + + app = App() + app.cmdloop() + +Resources +--------- + +* cmd_ +* `project bug tracker`_ +* `cmd2 project page`_ +* `PyCon 2010 presentation <http://us.pycon.org/2010/conference/talks/#proposal_link_153>`_, + *Easy Command-Line Applications with cmd and cmd2*: + :doc:`slides <pycon2010/pycon2010>`, + `video <http://python.mirocommunity.com/video/1533/easy-command-line-applications>`_ + +These docs will refer to ``App`` as your ``cmd2.Cmd`` +subclass, and ``app`` as an instance of ``App``. Of +course, in your program, you may name them whatever +you want. + +Contents: + +.. toctree:: + :maxdepth: 2 + + overview + example + freefeatures + settingchanges + unfreefeatures + alternatives + +Compatibility +============= + +Tested and working with Python 2.5, 2.6, 2.7, 3.1; Jython 2.5 + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |