summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcat <cat@eee>2010-02-12 15:55:38 -0500
committercat <cat@eee>2010-02-12 15:55:38 -0500
commit6042e62e285f57a73d5db42d9c4b2a66a30d265a (patch)
tree4df00d1999f780fdb46eaf1c867e1b22f17b9925
parent8bf4d19b2bb25aa128d5bdb519fd9a77fd3ab6c6 (diff)
downloadcmd2-hg-6042e62e285f57a73d5db42d9c4b2a66a30d265a.tar.gz
free function docs
-rwxr-xr-xcmd2.py6
-rw-r--r--docs/freefeatures.rst11
2 files changed, 15 insertions, 2 deletions
diff --git a/cmd2.py b/cmd2.py
index 27f481c..735f161 100755
--- a/cmd2.py
+++ b/cmd2.py
@@ -1129,9 +1129,11 @@ class Cmd(cmd.Cmd):
pyparsing.stringEnd)
def do_save(self, arg):
"""`save [N] [filename.ext]`
+
Saves command from history to file.
- N => Number of command (from history), or `*`;
- most recent command if omitted"""
+
+ | N => Number of command (from history), or `*`;
+ | most recent command if omitted"""
try:
args = self.saveparser.parseString(arg)
diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst
index bac6117..0e633dc 100644
--- a/docs/freefeatures.rst
+++ b/docs/freefeatures.rst
@@ -102,5 +102,16 @@ also provide `bash-like history list editing`_.
.. automethod:: cmd2.Cmd.do_history
+.. automethod:: cmd2.Cmd.do_list
+
+.. automethod:: cmd2.Cmd.do_run
+
+Quitting the application
+========================
+
+``cmd2`` pre-defines a ``quit`` command for you (with
+synonyms ``exit`` and simply ``q``).
+It's trivial, but it's one less thing for you to remember.
+
Transcript-based testing
========================