mirror of
https://github.com/python/cpython.git
synced 2025-08-03 00:23:06 +00:00
Logical markup.
This commit is contained in:
parent
60ba44750f
commit
fdbd51db8b
2 changed files with 36 additions and 34 deletions
|
@ -2,34 +2,35 @@
|
||||||
\stmodindex{commands}
|
\stmodindex{commands}
|
||||||
\label{module-commands}
|
\label{module-commands}
|
||||||
|
|
||||||
The \code{commands} module contains wrapper functions for \code{os.popen()}
|
The \module{commands} module contains wrapper functions for
|
||||||
which take a system command as a string and return any output generated by
|
\function{os.popen()} which take a system command as a string and
|
||||||
the command and, optionally, the exit status.
|
return any output generated by the command and, optionally, the exit
|
||||||
|
status.
|
||||||
|
|
||||||
The \code{commands} module is only usable on systems which support
|
The \module{commands} module is only usable on systems which support
|
||||||
\code{popen()} (currently \UNIX{}).
|
\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}
|
\begin{funcdesc}{getstatusoutput}{cmd}
|
||||||
Execute the string \var{cmd} in a shell with \code{os.popen()} and return
|
Execute the string \var{cmd} in a shell with \function{os.popen()} and
|
||||||
a 2-tuple (status, output). \var{cmd} is actually run as
|
return a 2-tuple \code{(\var{status}, \var{output})}. \var{cmd} is
|
||||||
\code{\{ cmd ; \} 2>\&1}, so that the returned output will contain output
|
actually run as \code{\{ \var{cmd} ; \} 2>\&1}, so that the returned
|
||||||
or error messages. A trailing newline is stripped from the output.
|
output will contain output or error messages. A trailing newline is
|
||||||
The exit status for the command can be interpreted according to the
|
stripped from the output. The exit status for the command can be
|
||||||
rules for the \C{} function \code{wait()}.
|
interpreted according to the rules for the \C{} function
|
||||||
|
\cfunction{wait()}.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{getoutput}{cmd}
|
\begin{funcdesc}{getoutput}{cmd}
|
||||||
Like \code{getstatusoutput()}, except the exit status is ignored and
|
Like \function{getstatusoutput()}, except the exit status is ignored
|
||||||
the return value is a string containing the command's output.
|
and the return value is a string containing the command's output.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{getstatus}{file}
|
\begin{funcdesc}{getstatus}{file}
|
||||||
Return the output of \samp{ls -ld \var{file}} as a string. This
|
Return the output of \samp{ls -ld \var{file}} as a string. This
|
||||||
function uses the \code{getoutput()} function, and properly escapes
|
function uses the \function{getoutput()} function, and properly
|
||||||
backslashes and dollar signs in the argument.
|
escapes backslashes and dollar signs in the argument.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
|
@ -2,34 +2,35 @@
|
||||||
\stmodindex{commands}
|
\stmodindex{commands}
|
||||||
\label{module-commands}
|
\label{module-commands}
|
||||||
|
|
||||||
The \code{commands} module contains wrapper functions for \code{os.popen()}
|
The \module{commands} module contains wrapper functions for
|
||||||
which take a system command as a string and return any output generated by
|
\function{os.popen()} which take a system command as a string and
|
||||||
the command and, optionally, the exit status.
|
return any output generated by the command and, optionally, the exit
|
||||||
|
status.
|
||||||
|
|
||||||
The \code{commands} module is only usable on systems which support
|
The \module{commands} module is only usable on systems which support
|
||||||
\code{popen()} (currently \UNIX{}).
|
\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}
|
\begin{funcdesc}{getstatusoutput}{cmd}
|
||||||
Execute the string \var{cmd} in a shell with \code{os.popen()} and return
|
Execute the string \var{cmd} in a shell with \function{os.popen()} and
|
||||||
a 2-tuple (status, output). \var{cmd} is actually run as
|
return a 2-tuple \code{(\var{status}, \var{output})}. \var{cmd} is
|
||||||
\code{\{ cmd ; \} 2>\&1}, so that the returned output will contain output
|
actually run as \code{\{ \var{cmd} ; \} 2>\&1}, so that the returned
|
||||||
or error messages. A trailing newline is stripped from the output.
|
output will contain output or error messages. A trailing newline is
|
||||||
The exit status for the command can be interpreted according to the
|
stripped from the output. The exit status for the command can be
|
||||||
rules for the \C{} function \code{wait()}.
|
interpreted according to the rules for the \C{} function
|
||||||
|
\cfunction{wait()}.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{getoutput}{cmd}
|
\begin{funcdesc}{getoutput}{cmd}
|
||||||
Like \code{getstatusoutput()}, except the exit status is ignored and
|
Like \function{getstatusoutput()}, except the exit status is ignored
|
||||||
the return value is a string containing the command's output.
|
and the return value is a string containing the command's output.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{getstatus}{file}
|
\begin{funcdesc}{getstatus}{file}
|
||||||
Return the output of \samp{ls -ld \var{file}} as a string. This
|
Return the output of \samp{ls -ld \var{file}} as a string. This
|
||||||
function uses the \code{getoutput()} function, and properly escapes
|
function uses the \function{getoutput()} function, and properly
|
||||||
backslashes and dollar signs in the argument.
|
escapes backslashes and dollar signs in the argument.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue