Updated for 2.1a3
[python/dscho.git] / Doc / mac / libmac.tex
blob7644d81da654911219212e29cf86d16c830791fc
1 \section{\module{mac} ---
2 Implementations for the \module{os} module}
4 \declaremodule{builtin}{mac}
5 \platform{Mac}
6 \modulesynopsis{Implementations for the \module{os} module.}
9 This module implements the operating system dependent functionality
10 provided by the standard module \module{os}\refstmodindex{os}. It is
11 best accessed through the \module{os} module.
13 The following functions are available in this module:
14 \function{chdir()},
15 \function{close()},
16 \function{dup()},
17 \function{fdopen()},
18 \function{getcwd()},
19 \function{lseek()},
20 \function{listdir()},
21 \function{mkdir()},
22 \function{open()},
23 \function{read()},
24 \function{rename()},
25 \function{rmdir()},
26 \function{stat()},
27 \function{sync()},
28 \function{unlink()},
29 \function{write()},
30 as well as the exception \exception{error}. Note that the times
31 returned by \function{stat()} are floating-point values, like all time
32 values in MacPython.
34 One additional function is available:
36 \begin{funcdesc}{xstat}{path}
37 This function returns the same information as \function{stat()}, but
38 with three additional values appended: the size of the resource fork
39 of the file and its 4-character creator and type.
40 \end{funcdesc}
43 \section{\module{macpath} ---
44 MacOS path manipulation functions}
46 \declaremodule{standard}{macpath}
47 % Could be labeled \platform{Mac}, but the module should work anywhere and
48 % is distributed with the standard library.
49 \modulesynopsis{MacOS path manipulation functions.}
52 This module is the Macintosh implementation of the \module{os.path}
53 module. It is most portably accessed as
54 \module{os.path}\refstmodindex{os.path}. Refer to the
55 \citetitle[../lib/lib.html]{Python Library Reference} for
56 documentation of \module{os.path}.
58 The following functions are available in this module:
59 \function{normcase()},
60 \function{normpath()},
61 \function{isabs()},
62 \function{join()},
63 \function{split()},
64 \function{isdir()},
65 \function{isfile()},
66 \function{walk()},
67 \function{exists()}.
68 For other functions available in \module{os.path} dummy counterparts
69 are available.