Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libposix.tex @ 4566:6403c94de50d legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added safeguard against failure in __del__.
author Guido van Rossum <guido@python.org>
date Wed, 27 Nov 1996 19:39:58 +0000
parents bf8c230df5e8
children b218f294b726
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 \section{Built-in Module \sectcode{posix}}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 \bimodindex{posix}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
3
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 This module provides access to operating system functionality that is
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2137
diff changeset
5 standardized by the C Standard and the POSIX standard (a thinly disguised
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 \UNIX{} interface).
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
7
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
8 \strong{Do not import this module directly.} Instead, import the
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
9 module \code{os}, which provides a \emph{portable} version of this
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
10 interface. On \UNIX{}, the \code{os} module provides a superset of
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
11 the \code{posix} interface. On non-\UNIX{} operating systems the
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
12 \code{posix} module is not available, but a subset is always available
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
13 through the \code{os} interface. Once \code{os} is imported, there is
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
14 \emph{no} performance penalty in using it instead of
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
15 \code{posix}.
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
16 \stmodindex{os}
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
17
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 The descriptions below are very terse; refer to the
2647
9b7e6d9a528d typos, layout and other small things
Guido van Rossum <guido@python.org>
parents: 2620
diff changeset
19 corresponding \UNIX{} manual entry for more information. Arguments
9b7e6d9a528d typos, layout and other small things
Guido van Rossum <guido@python.org>
parents: 2620
diff changeset
20 called \var{path} refer to a pathname given as a string.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
21
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 Errors are reported as exceptions; the usual exceptions are given
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 for type errors, while errors reported by the system calls raise
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 \code{posix.error}, described below.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
25
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 Module \code{posix} defines the following data items:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
27
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 \renewcommand{\indexsubitem}{(data in module posix)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 \begin{datadesc}{environ}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 A dictionary representing the string environment at the time
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 the interpreter was started.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
32 For example,
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 \code{posix.environ['HOME']}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 is the pathname of your home directory, equivalent to
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 \code{getenv("HOME")}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
36 in C.
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
37 Modifying this dictionary does not affect the string environment
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
38 passed on by \code{execv()}, \code{popen()} or \code{system()}; if you
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
39 need to change the environment, pass \code{environ} to \code{execve()}
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
40 or add variable assignments and export statements to the command
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
41 string for \code{system()} or \code{popen()}.%
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
42 \footnote{The problem with automatically passing on \code{environ} is
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
43 that there is no portable way of changing the environment.}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
44 \end{datadesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
45
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
46 \renewcommand{\indexsubitem}{(exception in module posix)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
47 \begin{excdesc}{error}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2137
diff changeset
48 This exception is raised when a POSIX function returns a
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
49 POSIX-related error (e.g., not for illegal argument types). Its
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
50 string value is \code{'posix.error'}. The accompanying value is a
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
51 pair containing the numeric error code from \code{errno} and the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
52 corresponding string, as would be printed by the C function
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
53 \code{perror()}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
54 \end{excdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
55
2620
bd05dcea7b09 added WNOHANG
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
56 It defines the following functions and constants:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
57
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
58 \renewcommand{\indexsubitem}{(in module posix)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
59 \begin{funcdesc}{chdir}{path}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
60 Change the current working directory to \var{path}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
61 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
62
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
63 \begin{funcdesc}{chmod}{path\, mode}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
64 Change the mode of \var{path} to the numeric \var{mode}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
65 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
66
2064
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1550
diff changeset
67 \begin{funcdesc}{chown}{path\, uid, gid}
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1550
diff changeset
68 Change the owner and group id of \var{path} to the numeric \var{uid}
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1550
diff changeset
69 and \var{gid}.
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1550
diff changeset
70 (Not on MS-DOS.)
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1550
diff changeset
71 \end{funcdesc}
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1550
diff changeset
72
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
73 \begin{funcdesc}{close}{fd}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
74 Close file descriptor \var{fd}.
2137
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
75
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
76 Note: this function is intended for low-level I/O and must be applied
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
77 to a file descriptor as returned by \code{posix.open()} or
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
78 \code{posix.pipe()}. To close a ``file object'' returned by the
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
79 built-in function \code{open} or by \code{posix.popen} or
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
80 \code{posix.fdopen}, use its \code{close()} method.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
81 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
82
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
83 \begin{funcdesc}{dup}{fd}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
84 Return a duplicate of file descriptor \var{fd}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
85 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
86
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
87 \begin{funcdesc}{dup2}{fd\, fd2}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
88 Duplicate file descriptor \var{fd} to \var{fd2}, closing the latter
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
89 first if necessary. Return \code{None}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
90 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
91
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
92 \begin{funcdesc}{execv}{path\, args}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
93 Execute the executable \var{path} with argument list \var{args},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
94 replacing the current process (i.e., the Python interpreter).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
95 The argument list may be a tuple or list of strings.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
96 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
97 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
98
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
99 \begin{funcdesc}{execve}{path\, args\, env}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
100 Execute the executable \var{path} with argument list \var{args},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
101 and environment \var{env},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
102 replacing the current process (i.e., the Python interpreter).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
103 The argument list may be a tuple or list of strings.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
104 The environment must be a dictionary mapping strings to strings.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
105 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
106 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
107
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
108 \begin{funcdesc}{_exit}{n}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
109 Exit to the system with status \var{n}, without calling cleanup
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
110 handlers, flushing stdio buffers, etc.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
111 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
112
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
113 Note: the standard way to exit is \code{sys.exit(\var{n})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
114 \code{posix._exit()} should normally only be used in the child process
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
115 after a \code{fork()}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
116 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
117
2137
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
118 \begin{funcdesc}{fdopen}{fd\optional{\, mode\optional{\, bufsize}}}
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
119 Return an open file object connected to the file descriptor \var{fd}.
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
120 The \var{mode} and \var{bufsize} arguments have the same meaning as
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
121 the corresponding arguments to the built-in \code{open()} function.
1550
980626ecad61 At release 1.0.1. Scripts, Makefile, README: cosmetic changes and
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
122 \end{funcdesc}
980626ecad61 At release 1.0.1. Scripts, Makefile, README: cosmetic changes and
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
123
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
124 \begin{funcdesc}{fork}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
125 Fork a child process. Return 0 in the child, the child's process id
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
126 in the parent.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
127 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
128 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
129
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
130 \begin{funcdesc}{fstat}{fd}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
131 Return status for file descriptor \var{fd}, like \code{stat()}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
132 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
133
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
134 \begin{funcdesc}{getcwd}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
135 Return a string representing the current working directory.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
136 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
137
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
138 \begin{funcdesc}{getegid}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
139 Return the current process's effective group id.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
140 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
141 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
142
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
143 \begin{funcdesc}{geteuid}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
144 Return the current process's effective user id.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
145 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
146 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
147
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
148 \begin{funcdesc}{getgid}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
149 Return the current process's group id.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
150 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
151 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
152
3711
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
153 \begin{funcdesc}{getpgrp}{}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
154 Return the current process group id.
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
155 (Not on MS-DOS.)
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
156 \end{funcdesc}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
157
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
158 \begin{funcdesc}{getpid}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
159 Return the current process id.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
160 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
161 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
162
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
163 \begin{funcdesc}{getppid}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
164 Return the parent's process id.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
165 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
166 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
167
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
168 \begin{funcdesc}{getuid}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
169 Return the current process's user id.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
170 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
171 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
172
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
173 \begin{funcdesc}{kill}{pid\, sig}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
174 Kill the process \var{pid} with signal \var{sig}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
175 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
176 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
177
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
178 \begin{funcdesc}{link}{src\, dst}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
179 Create a hard link pointing to \var{src} named \var{dst}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
180 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
181 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
182
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
183 \begin{funcdesc}{listdir}{path}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
184 Return a list containing the names of the entries in the directory.
3376
e0862f05e185 listdir no longer returns . or ..; added remove==unlink
Guido van Rossum <guido@python.org>
parents: 3083
diff changeset
185 The list is in arbitrary order. It does not include the special
e0862f05e185 listdir no longer returns . or ..; added remove==unlink
Guido van Rossum <guido@python.org>
parents: 3083
diff changeset
186 entries \code{'.'} and \code{'..'} even if they are present in the
e0862f05e185 listdir no longer returns . or ..; added remove==unlink
Guido van Rossum <guido@python.org>
parents: 3083
diff changeset
187 directory.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
188 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
189
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
190 \begin{funcdesc}{lseek}{fd\, pos\, how}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
191 Set the current position of file descriptor \var{fd} to position
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
192 \var{pos}, modified by \var{how}: 0 to set the position relative to
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
193 the beginning of the file; 1 to set it relative to the current
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
194 position; 2 to set it relative to the end of the file.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
195 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
196
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
197 \begin{funcdesc}{lstat}{path}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
198 Like \code{stat()}, but do not follow symbolic links. (On systems
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
199 without symbolic links, this is identical to \code{posix.stat}.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
200 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
201
3711
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
202 \begin{funcdesc}{mkfifo}{path\optional{\, mode}}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
203 Create a FIFO (a POSIX named pipe) named \var{path} with numeric mode
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
204 \var{mode}. The default \var{mode} is 0666 (octal). The current
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
205 umask value is first masked out from the mode.
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
206 (Not on MS-DOS.)
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
207
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
208 FIFOs are pipes that can be accessed like regular files. FIFOs exist
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
209 until they are deleted (for example with \code{os.unlink}).
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
210 Generally, FIFOs are used as rendez-vous between ``client'' and
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
211 ``server'' type processes: the server opens the FIFO for reading, and
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
212 the client opens it for writing. Note that \code{mkfifo()} doesn't
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
213 open the FIFO -- it just creates the rendez-vous point.
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
214 \end{funcdesc}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
215
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
216 \begin{funcdesc}{mkdir}{path\optional{\, mode}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
217 Create a directory named \var{path} with numeric mode \var{mode}.
3711
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
218 The default \var{mode} is 0777 (octal). On some systems, \var{mode}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
219 is ignored. Where it is used, the current umask value is first
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
220 masked out.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
221 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
222
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
223 \begin{funcdesc}{nice}{increment}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
224 Add \var{incr} to the process' ``niceness''. Return the new niceness.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
225 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
226 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
227
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
228 \begin{funcdesc}{open}{file\, flags\, mode}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
229 Open the file \var{file} and set various flags according to
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
230 \var{flags} and possibly its mode according to \var{mode}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
231 Return the file descriptor for the newly opened file.
2137
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
232
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
233 Note: this function is intended for low-level I/O. For normal usage,
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
234 use the built-in function \code{open}, which returns a ``file object''
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
235 with \code{read()} and \code{write()} methods (and many more).
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
236 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
237
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
238 \begin{funcdesc}{pipe}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
239 Create a pipe. Return a pair of file descriptors \code{(r, w)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
240 usable for reading and writing, respectively.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
241 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
242 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
243
3760
bf8c230df5e8 added plock
Guido van Rossum <guido@python.org>
parents: 3711
diff changeset
244 \begin{funcdesc}{plock}{op}
bf8c230df5e8 added plock
Guido van Rossum <guido@python.org>
parents: 3711
diff changeset
245 Lock program segments into memory. The value of \var{op}
bf8c230df5e8 added plock
Guido van Rossum <guido@python.org>
parents: 3711
diff changeset
246 (defined in \code{<sys/lock.h>}) determines which segments are locked.
bf8c230df5e8 added plock
Guido van Rossum <guido@python.org>
parents: 3711
diff changeset
247 (Not on MS-DOS.)
bf8c230df5e8 added plock
Guido van Rossum <guido@python.org>
parents: 3711
diff changeset
248 \end{funcdesc}
bf8c230df5e8 added plock
Guido van Rossum <guido@python.org>
parents: 3711
diff changeset
249
2137
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
250 \begin{funcdesc}{popen}{command\optional{\, mode\optional{\, bufsize}}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
251 Open a pipe to or from \var{command}. The return value is an open
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
252 file object connected to the pipe, which can be read or written
2137
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
253 depending on whether \var{mode} is \code{'r'} (default) or \code{'w'}.
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
254 The \var{bufsize} argument has the same meaning as the corresponding
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
255 argument to the built-in \code{open()} function.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
256 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
257 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
258
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
259 \begin{funcdesc}{read}{fd\, n}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
260 Read at most \var{n} bytes from file descriptor \var{fd}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
261 Return a string containing the bytes read.
2137
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
262
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
263 Note: this function is intended for low-level I/O and must be applied
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
264 to a file descriptor as returned by \code{posix.open()} or
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
265 \code{posix.pipe()}. To read a ``file object'' returned by the
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
266 built-in function \code{open} or by \code{posix.popen} or
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
267 \code{posix.fdopen}, or \code{sys.stdin}, use its
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
268 \code{read()} or \code{readline()} methods.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
269 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
270
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
271 \begin{funcdesc}{readlink}{path}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
272 Return a string representing the path to which the symbolic link
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
273 points. (On systems without symbolic links, this always raises
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
274 \code{posix.error}.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
275 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
276
3376
e0862f05e185 listdir no longer returns . or ..; added remove==unlink
Guido van Rossum <guido@python.org>
parents: 3083
diff changeset
277 \begin{funcdesc}{remove}{path}
e0862f05e185 listdir no longer returns . or ..; added remove==unlink
Guido van Rossum <guido@python.org>
parents: 3083
diff changeset
278 Remove the file \var{path}. See \code{rmdir} below to remove a directory.
e0862f05e185 listdir no longer returns . or ..; added remove==unlink
Guido van Rossum <guido@python.org>
parents: 3083
diff changeset
279 \end{funcdesc}
e0862f05e185 listdir no longer returns . or ..; added remove==unlink
Guido van Rossum <guido@python.org>
parents: 3083
diff changeset
280
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
281 \begin{funcdesc}{rename}{src\, dst}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
282 Rename the file or directory \var{src} to \var{dst}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
283 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
284
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
285 \begin{funcdesc}{rmdir}{path}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
286 Remove the directory \var{path}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
287 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
288
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
289 \begin{funcdesc}{setgid}{gid}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
290 Set the current process's group id.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
291 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
292 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
293
3711
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
294 \begin{funcdesc}{setpgrp}{}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
295 Calls the system call \code{setpgrp()} or \code{setpgrp(0, 0)}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
296 depending on which version is implemented (if any). See the {\UNIX}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
297 manual for the semantics.
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
298 (Not on MS-DOS.)
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
299 \end{funcdesc}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
300
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
301 \begin{funcdesc}{setpgid}{pid\, pgrp}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
302 Calls the system call \code{setpgid()}. See the {\UNIX} manual for
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
303 the semantics.
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
304 (Not on MS-DOS.)
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
305 \end{funcdesc}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
306
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
307 \begin{funcdesc}{setsid}{}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
308 Calls the system call \code{setsid()}. See the {\UNIX} manual for the
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
309 semantics.
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
310 (Not on MS-DOS.)
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
311 \end{funcdesc}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
312
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
313 \begin{funcdesc}{setuid}{uid}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
314 Set the current process's user id.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
315 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
316 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
317
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
318 \begin{funcdesc}{stat}{path}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
319 Perform a {\em stat} system call on the given path. The return value
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
320 is a tuple of at least 10 integers giving the most important (and
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
321 portable) members of the {\em stat} structure, in the order
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
322 \code{st_mode},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
323 \code{st_ino},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
324 \code{st_dev},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
325 \code{st_nlink},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
326 \code{st_uid},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
327 \code{st_gid},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
328 \code{st_size},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
329 \code{st_atime},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
330 \code{st_mtime},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
331 \code{st_ctime}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
332 More items may be added at the end by some implementations.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
333 (On MS-DOS, some items are filled with dummy values.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
334
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
335 Note: The standard module \code{stat} defines functions and constants
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
336 that are useful for extracting information from a stat structure.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
337 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
338
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
339 \begin{funcdesc}{symlink}{src\, dst}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
340 Create a symbolic link pointing to \var{src} named \var{dst}. (On
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
341 systems without symbolic links, this always raises
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
342 \code{posix.error}.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
343 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
344
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
345 \begin{funcdesc}{system}{command}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
346 Execute the command (a string) in a subshell. This is implemented by
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
347 calling the Standard C function \code{system()}, and has the same
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2137
diff changeset
348 limitations. Changes to \code{posix.environ}, \code{sys.stdin} etc.\ are
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
349 not reflected in the environment of the executed command. The return
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
350 value is the exit status of the process as returned by Standard C
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
351 \code{system()}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
352 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
353
3711
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
354 \begin{funcdesc}{tcgetpgrp}{fd}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
355 Return the process group associated with the terminal given by
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
356 \var{fd} (an open file descriptor as returned by \code{posix.open()}).
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
357 (Not on MS-DOS.)
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
358 \end{funcdesc}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
359
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
360 \begin{funcdesc}{tcsetpgrp}{fd\, pg}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
361 Set the process group associated with the terminal given by
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
362 \var{fd} (an open file descriptor as returned by \code{posix.open()})
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
363 to \var{pg}.
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
364 (Not on MS-DOS.)
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
365 \end{funcdesc}
c04531fc2709 Document some process group stuff; mkdir mode arg optional; mkfifo.
Guido van Rossum <guido@python.org>
parents: 3376
diff changeset
366
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
367 \begin{funcdesc}{times}{}
3083
07cb50141d07 add realtime as 5th item to os.times() return value
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
368 Return a 5-tuple of floating point numbers indicating accumulated (CPU
07cb50141d07 add realtime as 5th item to os.times() return value
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
369 or other)
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
370 times, in seconds. The items are: user time, system time, children's
3083
07cb50141d07 add realtime as 5th item to os.times() return value
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
371 user time, children's system time, and elapsed real time since a fixed
07cb50141d07 add realtime as 5th item to os.times() return value
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
372 point in the past, in that order. See the \UNIX{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
373 manual page {\it times}(2). (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
374 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
375
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
376 \begin{funcdesc}{umask}{mask}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
377 Set the current numeric umask and returns the previous umask.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
378 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
379 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
380
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
381 \begin{funcdesc}{uname}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
382 Return a 5-tuple containing information identifying the current
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
383 operating system. The tuple contains 5 strings:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
384 \code{(\var{sysname}, \var{nodename}, \var{release}, \var{version}, \var{machine})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
385 Some systems truncate the nodename to 8
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2137
diff changeset
386 characters or to the leading component; a better way to get the
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
387 hostname is \code{socket.gethostname()}. (Not on MS-DOS, nor on older
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
388 \UNIX{} systems.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
389 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
390
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
391 \begin{funcdesc}{unlink}{path}
3376
e0862f05e185 listdir no longer returns . or ..; added remove==unlink
Guido van Rossum <guido@python.org>
parents: 3083
diff changeset
392 Remove the file \var{path}. This is the same function as \code{remove};
e0862f05e185 listdir no longer returns . or ..; added remove==unlink
Guido van Rossum <guido@python.org>
parents: 3083
diff changeset
393 the \code{unlink} name is its traditional \UNIX{} name.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
394 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
395
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
396 \begin{funcdesc}{utime}{path\, \(atime\, mtime\)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
397 Set the access and modified time of the file to the given values.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
398 (The second argument is a tuple of two items.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
399 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
400
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
401 \begin{funcdesc}{wait}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
402 Wait for completion of a child process, and return a tuple containing
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
403 its pid and exit status indication (encoded as by \UNIX{}).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
404 (Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
405 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
406
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
407 \begin{funcdesc}{waitpid}{pid\, options}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
408 Wait for completion of a child process given by proces id, and return
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
409 a tuple containing its pid and exit status indication (encoded as by
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
410 \UNIX{}). The semantics of the call are affected by the value of
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
411 the integer options, which should be 0 for normal operation. (If the
2647
9b7e6d9a528d typos, layout and other small things
Guido van Rossum <guido@python.org>
parents: 2620
diff changeset
412 system does not support \code{waitpid()}, this always raises
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
413 \code{posix.error}. Not on MS-DOS.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
414 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
415
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
416 \begin{funcdesc}{write}{fd\, str}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
417 Write the string \var{str} to file descriptor \var{fd}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
418 Return the number of bytes actually written.
2137
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
419
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
420 Note: this function is intended for low-level I/O and must be applied
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
421 to a file descriptor as returned by \code{posix.open()} or
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
422 \code{posix.pipe()}. To write a ``file object'' returned by the
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
423 built-in function \code{open} or by \code{posix.popen} or
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
424 \code{posix.fdopen}, or \code{sys.stdout} or \code{sys.stderr}, use
c9085f1e977f optional bufsize arg for popen and fdopen
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
425 its \code{write()} method.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
426 \end{funcdesc}
2620
bd05dcea7b09 added WNOHANG
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
427
bd05dcea7b09 added WNOHANG
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
428 \begin{datadesc}{WNOHANG}
bd05dcea7b09 added WNOHANG
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
429 The option for \code{waitpid()} to avoid hanging if no child process
bd05dcea7b09 added WNOHANG
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
430 status is available immediately.
bd05dcea7b09 added WNOHANG
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
431 \end{datadesc}