summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libcmd.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-07-02 19:35:12 (GMT)
committerFred Drake <fdrake@acm.org>1998-07-02 19:35:12 (GMT)
commit579d36645824572fb375d8ae90c8ad526cb14554 (patch)
tree5760a44465d84e03b35c4d56d6b2588fac230ea7 /Doc/lib/libcmd.tex
parent3f6034dcce9a8f7f5cb246dcf402725e94438e09 (diff)
downloadcpython-579d36645824572fb375d8ae90c8ad526cb14554.zip
cpython-579d36645824572fb375d8ae90c8ad526cb14554.tar.gz
cpython-579d36645824572fb375d8ae90c8ad526cb14554.tar.bz2
Normalize the markup.
Diffstat (limited to 'Doc/lib/libcmd.tex')
-rw-r--r--Doc/lib/libcmd.tex80
1 files changed, 42 insertions, 38 deletions
diff --git a/Doc/lib/libcmd.tex b/Doc/lib/libcmd.tex
index 7c4dd4a..53935d5 100644
--- a/Doc/lib/libcmd.tex
+++ b/Doc/lib/libcmd.tex
@@ -3,17 +3,17 @@
\stmodindex{cmd}
\label{module-cmd}
-The \code{Cmd} class provides a simple framework for writing
+The \class{Cmd} class provides a simple framework for writing
line-oriented command interpreters. These are often useful for
test harnesses, administrative tools, and prototypes that will
later be wrapped in a more sophisticated interface.
\begin{classdesc}{Cmd}{}
A \class{Cmd} instance or subclass instance is a line-oriented
-interpreter framework. There is no good reason to instantiate Cmd
-itself; rather, it's useful as a superclass of an interpreter class
-you define yourself in order to inherit Cmd's methods and encapsulate
-action functions.
+interpreter framework. There is no good reason to instantiate
+\class{Cmd} itself; rather, it's useful as a superclass of an
+interpreter class you define yourself in order to inherit
+\class{Cmd}'s methods and encapsulate action methods.
\end{classdesc}
\subsection{Cmd Objects}
@@ -21,7 +21,7 @@ action functions.
A \class{Cmd} instance has the following methods:
-\begin{methoddesc}{cmdloop}{intro}
+\begin{methoddesc}{cmdloop}{\optional{intro}}
Repeatedly issue a prompt, accept input, parse an initial prefix off
the received input, and dispatch to action methods, passing them the
remainder of the line as argument.
@@ -30,26 +30,26 @@ The optional argument is a banner or intro string to be issued before the
first prompt (this overrides the \member{intro} class member).
If the \module{readline} module is loaded, input will automatically
-inherit Emacs-like history-list editing (e.g. Ctrl-P scrolls back to
-the last command, Ctrl-N forward to the next one, Ctrl-F moves the
-cursor to the right non-destructively, Ctrl-B moves the cursor to the
-left non-destructively, etc.).
+inherit \program{bash}-like history-list editing (e.g. \kbd{Ctrl-P}
+scrolls back to the last command, \kbd{Ctrl-N} forward to the next
+one, \kbd{Ctrl-F} moves the cursor to the right non-destructively,
+\kbd{Ctrl-B} moves the cursor to the left non-destructively, etc.).
-An end-of-file on input is passed back as the string "EOF".
+An end-of-file on input is passed back as the string \code{'EOF'}.
-An interpreter instance will recognize a command name \code{foo} if
-and only if it has a method named \method{do_foo}. As a special case,
-a line containing only the character `?' is dispatched to the method
-\method{do_help}. As another special case, a line containing only the
-character `!' is dispatched to the method \method{do_shell} (if such a method
-is defined).
+An interpreter instance will recognize a command name \samp{foo} if
+and only if it has a method \method{do_foo()}. As a special case,
+a line containing only the character \character{?} is dispatched to
+the method \method{do_help()}. As another special case, a line
+containing only the character \character{!} is dispatched to the
+method \method{do_shell} (if such a method is defined).
All subclasses of \class{Cmd} inherit a predefined \method{do_help}.
This method, called with an argument \code{bar}, invokes the
-corresponding method \method{help_bar}. With no argument,
-\method{do_help} lists all available help topics (that is, all
-commands with corresponding \code{help_} methods), and also lists any
-undocumented commands.
+corresponding method \method{help_bar()}. With no argument,
+\method{do_help()} lists all available help topics (that is, all
+commands with corresponding \method{help_*()} methods), and also lists
+any undocumented commands.
\end{methoddesc}
\begin{methoddesc}{onecmd}{str}
@@ -69,25 +69,27 @@ recognized. If this method is not overridden, it prints an
error message and returns.
\end{methoddesc}
-\begin{methoddesc}{precmd}
-Hook method executed just before the input prompt is issued. This method is
-a stub in \class{Cmd}; it exists to be overridden by subclasses.
+\begin{methoddesc}{precmd}{}
+Hook method executed just before the input prompt is issued. This
+method is a stub in \class{Cmd}; it exists to be overridden by
+subclasses.
\end{methoddesc}
-\begin{methoddesc}{postcmd}
+\begin{methoddesc}{postcmd}{}
Hook method executed just after a command dispatch is finished. This
method is a stub in \class{Cmd}; it exists to be overridden by
subclasses.
\end{methoddesc}
-\begin{methoddesc}{preloop}
-Hook method executed once when \method{cmdloop()} is called. This method is
-a stub in \class{Cmd}; it exists to be overridden by subclasses.
+\begin{methoddesc}{preloop}{}
+Hook method executed once when \method{cmdloop()} is called. This
+method is a stub in \class{Cmd}; it exists to be overridden by
+subclasses.
\end{methoddesc}
-\begin{methoddesc}{postloop}
-Hook method executed once when \method{cmdloop()} is about to return. This
-method is a stub in \class{Cmd}; it exists to be overridden by
+\begin{methoddesc}{postloop}{}
+Hook method executed once when \method{cmdloop()} is about to return.
+This method is a stub in \class{Cmd}; it exists to be overridden by
subclasses.
\end{methoddesc}
@@ -111,24 +113,26 @@ the \method{cmdloop()} method an argument.
\end{memberdesc}
\begin{memberdesc}{doc_header}
-The header to issue if the help output has a section for documented commands.
+The header to issue if the help output has a section for documented
+commands.
\end{memberdesc}
\begin{memberdesc}{misc_header}
-The header to issue if the help output has a section for miscellaneous
-help topics (that is, there are \code{help_} methods withoud corresponding
-\code{do_} functions).
+The header to issue if the help output has a section for miscellaneous
+help topics (that is, there are \method{help_*()} methods without
+corresponding \method{do_*()} methods).
\end{memberdesc}
\begin{memberdesc}{undoc_header}
The header to issue if the help output has a section for undocumented
-commands (that is, there are \code{do_} methods withoud corresponding
-\code{help_} functions).
+commands (that is, there are \method{do_*()} methods without
+corresponding \method{help_*()} methods).
\end{memberdesc}
\begin{memberdesc}{ruler}
The character used to draw separator lines under the help-message
-headers. If empty, no ruler line is drawn. It defaults to "=".
+headers. If empty, no ruler line is drawn. It defaults to
+\character{=}.
\end{memberdesc}