summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libcommands.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-04-22 15:19:01 (GMT)
committerFred Drake <fdrake@acm.org>1999-04-22 15:19:01 (GMT)
commit47894d2858d892b7d5253800e5bee0cdf769a25b (patch)
tree138e9e1d4e2ae431352e6a9816b6dff730575df1 /Doc/lib/libcommands.tex
parenta694e0008582989ac611b7905a09b102cb5b6459 (diff)
downloadcpython-47894d2858d892b7d5253800e5bee0cdf769a25b.zip
cpython-47894d2858d892b7d5253800e5bee0cdf769a25b.tar.gz
cpython-47894d2858d892b7d5253800e5bee0cdf769a25b.tar.bz2
Don't describe this module as being a popen() wrapper; that's a little
confusing. This is clearly Unix-specific; label it as such.
Diffstat (limited to 'Doc/lib/libcommands.tex')
-rw-r--r--Doc/lib/libcommands.tex13
1 files changed, 6 insertions, 7 deletions
diff --git a/Doc/lib/libcommands.tex b/Doc/lib/libcommands.tex
index 6b49fae..cb00b2f 100644
--- a/Doc/lib/libcommands.tex
+++ b/Doc/lib/libcommands.tex
@@ -1,19 +1,18 @@
\section{\module{commands} ---
- Wrapper functions for \function{os.popen()}.}
+ Utility functions for external commands}
+
\declaremodule{standard}{commands}
+ \platform{Unix}
+\modulesynopsis{Utility functions for running external commands.}
\sectionauthor{Sue Williams}{sbw@provis.com}
-\modulesynopsis{Wrapper functions for \function{os.popen()}.}
-
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 \module{commands} module is only usable on systems which support
-\function{os.popen()} (currently \UNIX{}). It defines the following
-functions:
+The \module{commands} module defines the following functions:
\begin{funcdesc}{getstatusoutput}{cmd}
@@ -22,7 +21,7 @@ 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
+interpreted according to the rules for the C function
\cfunction{wait()}.
\end{funcdesc}