summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libcommands.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-03-11 06:24:46 (GMT)
committerFred Drake <fdrake@acm.org>1998-03-11 06:24:46 (GMT)
commitfdbd51db8b5fe2dde254837b5f39fb9aae7483ed (patch)
tree6e7742b83ac96e5d1c93d6d813f177a626c11baa /Doc/lib/libcommands.tex
parent60ba44750fd75a6883fdee3817ee6ca5a0a5580f (diff)
downloadcpython-fdbd51db8b5fe2dde254837b5f39fb9aae7483ed.zip
cpython-fdbd51db8b5fe2dde254837b5f39fb9aae7483ed.tar.gz
cpython-fdbd51db8b5fe2dde254837b5f39fb9aae7483ed.tar.bz2
Logical markup.
Diffstat (limited to 'Doc/lib/libcommands.tex')
-rw-r--r--Doc/lib/libcommands.tex35
1 files changed, 18 insertions, 17 deletions
diff --git a/Doc/lib/libcommands.tex b/Doc/lib/libcommands.tex
index e65e954..5a51ac4 100644
--- a/Doc/lib/libcommands.tex
+++ b/Doc/lib/libcommands.tex
@@ -2,34 +2,35 @@
\stmodindex{commands}
\label{module-commands}
-The \code{commands} module contains wrapper functions for \code{os.popen()}
-which take a system command as a string and return any output generated by
-the command and, optionally, the exit status.
+The \module{commands} module contains wrapper functions for
+\function{os.popen()} which take a system command as a string and
+return any output generated by the command and, optionally, the exit
+status.
-The \code{commands} module is only usable on systems which support
-\code{popen()} (currently \UNIX{}).
+The \module{commands} module is only usable on systems which support
+\function{os.popen()} (currently \UNIX{}). It defines the following
+functions:
-The \code{commands} module defines the following functions:
-\setindexsubitem{(in module commands)}
\begin{funcdesc}{getstatusoutput}{cmd}
-Execute the string \var{cmd} in a shell with \code{os.popen()} and return
-a 2-tuple (status, output). \var{cmd} is actually run as
-\code{\{ cmd ; \} 2>\&1}, so that the returned output will contain output
-or error messages. A trailing newline is stripped from the output.
-The exit status for the command can be interpreted according to the
-rules for the \C{} function \code{wait()}.
+Execute the string \var{cmd} in a shell with \function{os.popen()} and
+return a 2-tuple \code{(\var{status}, \var{output})}. \var{cmd} is
+actually run as \code{\{ \var{cmd} ; \} 2>\&1}, so that the returned
+output will contain output or error messages. A trailing newline is
+stripped from the output. The exit status for the command can be
+interpreted according to the rules for the \C{} function
+\cfunction{wait()}.
\end{funcdesc}
\begin{funcdesc}{getoutput}{cmd}
-Like \code{getstatusoutput()}, except the exit status is ignored and
-the return value is a string containing the command's output.
+Like \function{getstatusoutput()}, except the exit status is ignored
+and the return value is a string containing the command's output.
\end{funcdesc}
\begin{funcdesc}{getstatus}{file}
Return the output of \samp{ls -ld \var{file}} as a string. This
-function uses the \code{getoutput()} function, and properly escapes
-backslashes and dollar signs in the argument.
+function uses the \function{getoutput()} function, and properly
+escapes backslashes and dollar signs in the argument.
\end{funcdesc}
Example: