mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make some adjustments to the markup, and fix up some style-guide issues.

This commit is contained in:
Fred Drake 2001-07-29 03:41:23 +00:00
parent db642c66a8
commit 43211ecda2
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Doc/lib/libcmd.tex
View File

@ -19,9 +19,9 @@ interpreter class you define yourself in order to inherit
\class{Cmd}'s methods and encapsulate action methods. \class{Cmd}'s methods and encapsulate action methods.
The optional argument is the \refmodule{readline} name of a completion The optional argument is the \refmodule{readline} name of a completion
key; it defaults to \code{``tab''}. If \var{completekey} is not key; it defaults to \kbd{Tab}. If \var{completekey} is not \code{None}
\code{None} and \module{readline} is available, command completion is and \module{readline} is available, command completion is done
done automatically. automatically.
\end{classdesc} \end{classdesc}
@ -51,20 +51,20 @@ and only if it has a method \method{do_foo()}. As a special case,
a line beginning with the character \character{?} is dispatched to a line beginning with the character \character{?} is dispatched to
the method \method{do_help()}. As another special case, a line the method \method{do_help()}. As another special case, a line
beginning with the character \character{!} is dispatched to the beginning with the character \character{!} is dispatched to the
method \method{do_shell} (if such a method is defined). method \method{do_shell()} (if such a method is defined).
If completion is enabled, completing commands will be done If completion is enabled, completing commands will be done
automatically, and completing of commands args is done by calling automatically, and completing of commands args is done by calling
\method{complete_foo()} with arguments \samp{text}, \samp{line}, \method{complete_foo()} with arguments \var{text}, \var{line},
\samp{begidx}, \samp{endidx}. \samp{text} is string we are matching \var{begidx}, and \var{endidx}. \var{text} is the string prefix we
against, all returned matches must begin with it. \samp{line} is the are attempting to match: all returned matches must begin with it.
current input line (lstripped), \samp{begidx} and \samp{endidx} are \var{line} is the current input line with leading whitespace removed,
the beginning and end indexes of the text being matched, which could \var{begidx} and \var{endidx} are the beginning and ending indexes
be used to provide different completion depending upon which position of the prefix text, which could be used to provide different
the argument is in. completion depending upon which position the argument is in.
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 \method{help_*()} methods), and also lists commands with corresponding \method{help_*()} methods), and also lists
@ -90,7 +90,7 @@ error message and returns.
\begin{methoddesc}{completedefault}{text, line, begidx, endidx} \begin{methoddesc}{completedefault}{text, line, begidx, endidx}
Method called to complete an input line when no command-specific Method called to complete an input line when no command-specific
\code{complete_} method is available. By default, it returns an \method{complete_*()} method is available. By default, it returns an
empty list. empty list.
\end{methoddesc} \end{methoddesc}
@ -164,8 +164,8 @@ headers. If empty, no ruler line is drawn. It defaults to
\begin{memberdesc}{use_rawinput} \begin{memberdesc}{use_rawinput}
A flag, defaulting to true. If true, \method{cmdloop()} uses A flag, defaulting to true. If true, \method{cmdloop()} uses
\function{raw_input()} to display a prompt and read the next command; \function{raw_input()} to display a prompt and read the next command;
if false, \function{sys.stdout.write()} and if false, \method{sys.stdout.write()} and
\function{sys.stdin.readline()} are used. (This means that by \method{sys.stdin.readline()} are used. (This means that by
importing \module{readline}, on systems that support it, the importing \module{readline}, on systems that support it, the
interpreter will automatically support Emacs-like line editing interpreter will automatically support Emacs-like line editing
and command-history keystrokes.) and command-history keystrokes.)