Commit 579d3664 authored by Fred Drake's avatar Fred Drake

Normalize the markup.

parent 3f6034dc
...@@ -3,17 +3,17 @@ ...@@ -3,17 +3,17 @@
\stmodindex{cmd} \stmodindex{cmd}
\label{module-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 line-oriented command interpreters. These are often useful for
test harnesses, administrative tools, and prototypes that will test harnesses, administrative tools, and prototypes that will
later be wrapped in a more sophisticated interface. later be wrapped in a more sophisticated interface.
\begin{classdesc}{Cmd}{} \begin{classdesc}{Cmd}{}
A \class{Cmd} instance or subclass instance is a line-oriented A \class{Cmd} instance or subclass instance is a line-oriented
interpreter framework. There is no good reason to instantiate Cmd interpreter framework. There is no good reason to instantiate
itself; rather, it's useful as a superclass of an interpreter class \class{Cmd} itself; rather, it's useful as a superclass of an
you define yourself in order to inherit Cmd's methods and encapsulate interpreter class you define yourself in order to inherit
action functions. \class{Cmd}'s methods and encapsulate action methods.
\end{classdesc} \end{classdesc}
\subsection{Cmd Objects} \subsection{Cmd Objects}
...@@ -21,7 +21,7 @@ action functions. ...@@ -21,7 +21,7 @@ action functions.
A \class{Cmd} instance has the following methods: 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 Repeatedly issue a prompt, accept input, parse an initial prefix off
the received input, and dispatch to action methods, passing them the the received input, and dispatch to action methods, passing them the
remainder of the line as argument. remainder of the line as argument.
...@@ -30,26 +30,26 @@ The optional argument is a banner or intro string to be issued before the ...@@ -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). first prompt (this overrides the \member{intro} class member).
If the \module{readline} module is loaded, input will automatically If the \module{readline} module is loaded, input will automatically
inherit Emacs-like history-list editing (e.g. Ctrl-P scrolls back to inherit \program{bash}-like history-list editing (e.g. \kbd{Ctrl-P}
the last command, Ctrl-N forward to the next one, Ctrl-F moves the scrolls back to the last command, \kbd{Ctrl-N} forward to the next
cursor to the right non-destructively, Ctrl-B moves the cursor to the one, \kbd{Ctrl-F} moves the cursor to the right non-destructively,
left non-destructively, etc.). \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 An interpreter instance will recognize a command name \samp{foo} if
and only if it has a method named \method{do_foo}. As a special case, and only if it has a method \method{do_foo()}. As a special case,
a line containing only the character `?' is dispatched to the method a line containing only the character \character{?} is dispatched to
\method{do_help}. As another special case, a line containing only the the method \method{do_help()}. As another special case, a line
character `!' is dispatched to the method \method{do_shell} (if such a method containing only the character \character{!} is dispatched to the
is defined). method \method{do_shell} (if such a method is defined).
All subclasses of \class{Cmd} inherit a predefined \method{do_help}. All subclasses of \class{Cmd} inherit a predefined \method{do_help}.
This method, called with an argument \code{bar}, invokes the This method, called with an argument \code{bar}, invokes the
corresponding method \method{help_bar}. With no argument, corresponding method \method{help_bar()}. With no argument,
\method{do_help} lists all available help topics (that is, all \method{do_help()} lists all available help topics (that is, all
commands with corresponding \code{help_} methods), and also lists any commands with corresponding \method{help_*()} methods), and also lists
undocumented commands. any undocumented commands.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{onecmd}{str} \begin{methoddesc}{onecmd}{str}
...@@ -69,25 +69,27 @@ recognized. If this method is not overridden, it prints an ...@@ -69,25 +69,27 @@ recognized. If this method is not overridden, it prints an
error message and returns. error message and returns.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{precmd} \begin{methoddesc}{precmd}{}
Hook method executed just before the input prompt is issued. This method is Hook method executed just before the input prompt is issued. This
a stub in \class{Cmd}; it exists to be overridden by subclasses. method is a stub in \class{Cmd}; it exists to be overridden by
subclasses.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{postcmd} \begin{methoddesc}{postcmd}{}
Hook method executed just after a command dispatch is finished. This Hook method executed just after a command dispatch is finished. This
method is a stub in \class{Cmd}; it exists to be overridden by method is a stub in \class{Cmd}; it exists to be overridden by
subclasses. subclasses.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{preloop} \begin{methoddesc}{preloop}{}
Hook method executed once when \method{cmdloop()} is called. This method is Hook method executed once when \method{cmdloop()} is called. This
a stub in \class{Cmd}; it exists to be overridden by subclasses. method is a stub in \class{Cmd}; it exists to be overridden by
subclasses.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{postloop} \begin{methoddesc}{postloop}{}
Hook method executed once when \method{cmdloop()} is about to return. This Hook method executed once when \method{cmdloop()} is about to return.
method is a stub in \class{Cmd}; it exists to be overridden by This method is a stub in \class{Cmd}; it exists to be overridden by
subclasses. subclasses.
\end{methoddesc} \end{methoddesc}
...@@ -111,24 +113,26 @@ the \method{cmdloop()} method an argument. ...@@ -111,24 +113,26 @@ the \method{cmdloop()} method an argument.
\end{memberdesc} \end{memberdesc}
\begin{memberdesc}{doc_header} \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} \end{memberdesc}
\begin{memberdesc}{misc_header} \begin{memberdesc}{misc_header}
The header to issue if the help output has a section for miscellaneous The header to issue if the help output has a section for miscellaneous
help topics (that is, there are \code{help_} methods withoud corresponding help topics (that is, there are \method{help_*()} methods without
\code{do_} functions). corresponding \method{do_*()} methods).
\end{memberdesc} \end{memberdesc}
\begin{memberdesc}{undoc_header} \begin{memberdesc}{undoc_header}
The header to issue if the help output has a section for undocumented The header to issue if the help output has a section for undocumented
commands (that is, there are \code{do_} methods withoud corresponding commands (that is, there are \method{do_*()} methods without
\code{help_} functions). corresponding \method{help_*()} methods).
\end{memberdesc} \end{memberdesc}
\begin{memberdesc}{ruler} \begin{memberdesc}{ruler}
The character used to draw separator lines under the help-message 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} \end{memberdesc}
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment