From 47894d2858d892b7d5253800e5bee0cdf769a25b Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Thu, 22 Apr 1999 15:19:01 +0000 Subject: [PATCH] Don't describe this module as being a popen() wrapper; that's a little confusing. This is clearly Unix-specific; label it as such. --- Doc/lib/libcommands.tex | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/Doc/lib/libcommands.tex b/Doc/lib/libcommands.tex index 6b49faed081..cb00b2fcba4 100644 --- a/Doc/lib/libcommands.tex +++ b/Doc/lib/libcommands.tex @@ -1,9 +1,10 @@ \section{\module{commands} --- - Wrapper functions for \function{os.popen()}.} -\declaremodule{standard}{commands} -\sectionauthor{Sue Williams}{sbw@provis.com} + Utility functions for external commands} -\modulesynopsis{Wrapper functions for \function{os.popen()}.} +\declaremodule{standard}{commands} + \platform{Unix} +\modulesynopsis{Utility functions for running external commands.} +\sectionauthor{Sue Williams}{sbw@provis.com} The \module{commands} module contains wrapper functions for @@ -11,9 +12,7 @@ The \module{commands} module contains wrapper functions for 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}