Mercurial > cpython-lru_cache-weakref

annotate Doc/mac/libmac.tex @ 21467:4e35fa5d5708 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.
author Fred Drake <fdrake@acm.org>
date Tue, 18 Dec 2001 16:31:08 +0000
parents 38c795afb3b8
children 676db0300f06
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8915
552c6b3aba3d New style section headers.
Fred Drake <fdrake@acm.org>
parents: 8715
diff changeset
1 \section{\module{mac} ---
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
2 Implementations for the \module{os} module}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 10062
diff changeset
3
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 8088
diff changeset
4 \declaremodule{builtin}{mac}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 10062
diff changeset
5 \platform{Mac}
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
6 \modulesynopsis{Implementations for the \module{os} module.}
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 8088
diff changeset
7
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
8
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
9 This module implements the operating system dependent functionality
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
10 provided by the standard module \module{os}\refstmodindex{os}. It is
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
11 best accessed through the \module{os} module.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
12
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 The following functions are available in this module:
7358
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
14 \function{chdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
15 \function{close()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
16 \function{dup()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
17 \function{fdopen()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
18 \function{getcwd()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
19 \function{lseek()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
20 \function{listdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
21 \function{mkdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
22 \function{open()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
23 \function{read()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
24 \function{rename()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
25 \function{rmdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
26 \function{stat()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
27 \function{sync()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
28 \function{unlink()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
29 \function{write()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
30 as well as the exception \exception{error}. Note that the times
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
31 returned by \function{stat()} are floating-point values, like all time
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
32 values in MacPython.
4410
4cef23e1dcca Patches for Mac module docs by Jack
Guido van Rossum <guido@python.org>
parents: 3758
diff changeset
33
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
34 One additional function is available:
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
35
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
36 \begin{funcdesc}{xstat}{path}
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
37 This function returns the same information as \function{stat()}, but
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
38 with three additional values appended: the size of the resource fork
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
39 of the file and its 4-character creator and type.
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
40 \end{funcdesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
41
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 8088
diff changeset
42
8915
552c6b3aba3d New style section headers.
Fred Drake <fdrake@acm.org>
parents: 8715
diff changeset
43 \section{\module{macpath} ---
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
44 MacOS path manipulation functions}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 10062
diff changeset
45
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 8088
diff changeset
46 \declaremodule{standard}{macpath}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 10062
diff changeset
47 % Could be labeled \platform{Mac}, but the module should work anywhere and
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 10062
diff changeset
48 % is distributed with the standard library.
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 8088
diff changeset
49 \modulesynopsis{MacOS path manipulation functions.}
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 8088
diff changeset
50
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
51
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
52 This module is the Macintosh implementation of the \module{os.path}
10768
c6a4e46f1b09 Point to the library reference manual for os.path documentation (in
Fred Drake <fdrake@acm.org>
parents: 10334
diff changeset
53 module. It is most portably accessed as
11462
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10768
diff changeset
54 \module{os.path}\refstmodindex{os.path}. Refer to the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10768
diff changeset
55 \citetitle[../lib/lib.html]{Python Library Reference} for
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10768
diff changeset
56 documentation of \module{os.path}.
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 The following functions are available in this module:
7358
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
59 \function{normcase()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
60 \function{normpath()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
61 \function{isabs()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
62 \function{join()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
63 \function{split()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
64 \function{isdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
65 \function{isfile()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
66 \function{walk()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
67 \function{exists()}.
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
68 For other functions available in \module{os.path} dummy counterparts
3758
b916d614e363 changes by Jack to Mac docs
Guido van Rossum <guido@python.org>
parents: 2609
diff changeset
69 are available.