Don't describe this module as being a popen() wrapper; that's a little
confusing. This is clearly Unix-specific; label it as such.
This commit is contained in:
parent
a694e00085
commit
47894d2858
|
@ -1,9 +1,10 @@
|
||||||
\section{\module{commands} ---
|
\section{\module{commands} ---
|
||||||
Wrapper functions for \function{os.popen()}.}
|
Utility functions for external commands}
|
||||||
\declaremodule{standard}{commands}
|
|
||||||
\sectionauthor{Sue Williams}{sbw@provis.com}
|
|
||||||
|
|
||||||
\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
|
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
|
return any output generated by the command and, optionally, the exit
|
||||||
status.
|
status.
|
||||||
|
|
||||||
The \module{commands} module is only usable on systems which support
|
The \module{commands} module defines the following functions:
|
||||||
\function{os.popen()} (currently \UNIX{}). It defines the following
|
|
||||||
functions:
|
|
||||||
|
|
||||||
|
|
||||||
\begin{funcdesc}{getstatusoutput}{cmd}
|
\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
|
actually run as \code{\{ \var{cmd} ; \} 2>\&1}, so that the returned
|
||||||
output will contain output or error messages. A trailing newline is
|
output will contain output or error messages. A trailing newline is
|
||||||
stripped from the output. The exit status for the command can be
|
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()}.
|
\cfunction{wait()}.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue