annotate Doc/mac/libmac.tex @ 27998:e27f58a50737 legacy-trunk

SF bug #690377: Dud footnote reference in distutils docs
author Raymond Hettinger <python@rcn.com>
date Fri, 21 Feb 2003 02:47:09 +0000
parents 523efd773261
children 7e7e86f45255
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
27833
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 21952
diff changeset
9 This module implements the Mac OS 9 operating system dependent functionality
10062
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
27833
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 21952
diff changeset
11 best accessed through the \module{os} module. This module is only available in
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 21952
diff changeset
12 MacPython-OS9, on MacPython-OSX \module{posix} is used.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
13
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 The following functions are available in this module:
7358
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
15 \function{chdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
16 \function{close()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
17 \function{dup()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
18 \function{fdopen()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
19 \function{getcwd()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
20 \function{lseek()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
21 \function{listdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
22 \function{mkdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
23 \function{open()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
24 \function{read()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
25 \function{rename()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
26 \function{rmdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
27 \function{stat()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
28 \function{sync()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
29 \function{unlink()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
30 \function{write()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
31 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
32 returned by \function{stat()} are floating-point values, like all time
27833
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 21952
diff changeset
33 values in MacPython-OS9.
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 8088
diff changeset
34
8915
552c6b3aba3d New style section headers.
Fred Drake <fdrake@acm.org>
parents: 8715
diff changeset
35 \section{\module{macpath} ---
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
36 MacOS path manipulation functions}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 10062
diff changeset
37
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 8088
diff changeset
38 \declaremodule{standard}{macpath}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 10062
diff changeset
39 % 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
40 % 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
41 \modulesynopsis{MacOS path manipulation functions.}
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 8088
diff changeset
42
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
43
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
44 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
45 module. It is most portably accessed as
11462
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10768
diff changeset
46 \module{os.path}\refstmodindex{os.path}. Refer to the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10768
diff changeset
47 \citetitle[../lib/lib.html]{Python Library Reference} for
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10768
diff changeset
48 documentation of \module{os.path}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
49
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
50 The following functions are available in this module:
7358
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
51 \function{normcase()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
52 \function{normpath()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
53 \function{isabs()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
54 \function{join()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
55 \function{split()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
56 \function{isdir()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
57 \function{isfile()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
58 \function{walk()},
1421aceae346 Added \label{} for logical addressing.
Fred Drake <fdrake@acm.org>
parents: 6860
diff changeset
59 \function{exists()}.
10062
d5e64a616320 Remove all references to posixpath; only refer to os.path.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
60 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
61 are available.