annotate Doc/lib.tex @ 2602:bee2aed416d6 legacy-trunk

New documentation on the CD module.
author Sjoerd Mullender <sjoerd@acm.org>
date Tue, 28 Mar 1995 11:56:52 +0000
parents 31777622ae93
children 7ef72873e4d6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
808
0cff36b110fe Moved a4wide option to myformat.sty
Guido van Rossum <guido@python.org>
parents: 781
diff changeset
1 \documentstyle[twoside,11pt,myformat]{report}
435
2de34b9602e0 Renamed mod to lib; and split in 5 instead of 3 parts.
Guido van Rossum <guido@python.org>
parents: 271
diff changeset
2
2453
cdd3a721b40e a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents: 2449
diff changeset
3 % NOTE: this file controls which chapters/sections of the library
cdd3a721b40e a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents: 2449
diff changeset
4 % manual are actually printed. It is easy to customize your manual
cdd3a721b40e a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents: 2449
diff changeset
5 % by commenting out sections that you're not interested in.
cdd3a721b40e a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents: 2449
diff changeset
6
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
7 \title{Python Library Reference}
122
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
8
1934
f3ae7c17ac08 Moved author and date to boilerplate.tex.
Guido van Rossum <guido@python.org>
parents: 1920
diff changeset
9 \input{boilerplate}
1412
00f1e8864dcc * {lib,ref,ext,tut}.tex: added explicit \date{<date> \\ <release>}.
Guido van Rossum <guido@python.org>
parents: 1402
diff changeset
10
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
11 \makeindex % tell \index to actually write the .idx file
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
12
561
4434393b4ede Changes needed for indexing.
Guido van Rossum <guido@python.org>
parents: 452
diff changeset
13
122
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 \begin{document}
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
15
122
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 \pagenumbering{roman}
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
17
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 \maketitle
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
19
1934
f3ae7c17ac08 Moved author and date to boilerplate.tex.
Guido van Rossum <guido@python.org>
parents: 1920
diff changeset
20 \input{copyright}
f3ae7c17ac08 Moved author and date to boilerplate.tex.
Guido van Rossum <guido@python.org>
parents: 1920
diff changeset
21
122
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 \begin{abstract}
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
23
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 \noindent
452
ae1a555e65fa The Reference Manual is now official.
Guido van Rossum <guido@python.org>
parents: 435
diff changeset
25 This document describes the built-in types, exceptions and functions
ae1a555e65fa The Reference Manual is now official.
Guido van Rossum <guido@python.org>
parents: 435
diff changeset
26 and the standard modules that come with the Python system. It assumes
ae1a555e65fa The Reference Manual is now official.
Guido van Rossum <guido@python.org>
parents: 435
diff changeset
27 basic knowledge about the Python language. For an informal
ae1a555e65fa The Reference Manual is now official.
Guido van Rossum <guido@python.org>
parents: 435
diff changeset
28 introduction to the language, see the {\em Python Tutorial}. The {\em
ae1a555e65fa The Reference Manual is now official.
Guido van Rossum <guido@python.org>
parents: 435
diff changeset
29 Python Reference Manual} gives a more formal definition of the
ae1a555e65fa The Reference Manual is now official.
Guido van Rossum <guido@python.org>
parents: 435
diff changeset
30 language.
122
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
31
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
32 \end{abstract}
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
33
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 \pagebreak
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
35
655
e7293b5b570d Excitem now has only one argument.
Guido van Rossum <guido@python.org>
parents: 602
diff changeset
36 {
e7293b5b570d Excitem now has only one argument.
Guido van Rossum <guido@python.org>
parents: 602
diff changeset
37 \parskip = 0mm
122
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 \tableofcontents
655
e7293b5b570d Excitem now has only one argument.
Guido van Rossum <guido@python.org>
parents: 602
diff changeset
39 }
122
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
40
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
41 \pagebreak
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
42
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
43 \pagenumbering{arabic}
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
44
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
45 % Chapter title:
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
46
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
47 \input{libintro} % Introduction
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
48
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
49 \input{libobjs} % Built-in Types, Exceptions and Functions
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
50 \input{libtypes}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
51 \input{libexcs}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
52 \input{libfuncs}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
53
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
54 \input{libmods} % Built-in modules
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
55 \input{libsys}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
56 \input{libbltin} % really __builtin__
2064
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1934
diff changeset
57 \input{libimp}
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
58 \input{libmain} % really __main__
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
59 \input{libarray}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
60 \input{libmath}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
61 \input{libtime}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
62 \input{libregex}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
63 \input{libmarshal}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
64 \input{libstruct}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
65
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
66 \input{libstd} % Standard Modules
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
67 \input{libgetopt}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
68 \input{libos}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
69 \input{librand}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
70 \input{libregsub}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
71 \input{libstring}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
72 \input{libwhrandom}
1920
5f33ca521452 Added documentation on the aifc module.
Sjoerd Mullender <sjoerd@acm.org>
parents: 1767
diff changeset
73 \input{libaifc}
2347
d05685993476 added docs for pickle, shelve and copy
Guido van Rossum <guido@python.org>
parents: 2290
diff changeset
74 \input{libpickle}
d05685993476 added docs for pickle, shelve and copy
Guido van Rossum <guido@python.org>
parents: 2290
diff changeset
75 \input{libshelve}
d05685993476 added docs for pickle, shelve and copy
Guido van Rossum <guido@python.org>
parents: 2290
diff changeset
76 \input{libcopy}
2449
8eeecd233d56 added WWW sections
Guido van Rossum <guido@python.org>
parents: 2351
diff changeset
77 \input{libtypes2} % types is already taken :-(
2462
e9e86ae5f5a4 small nits and new files
Guido van Rossum <guido@python.org>
parents: 2453
diff changeset
78 \input{libtempfile}
e9e86ae5f5a4 small nits and new files
Guido van Rossum <guido@python.org>
parents: 2453
diff changeset
79 \input{libtraceback}
2465
1f4141aafe36 converted docs for Jim Roskind's profiler
Guido van Rossum <guido@python.org>
parents: 2462
diff changeset
80
1f4141aafe36 converted docs for Jim Roskind's profiler
Guido van Rossum <guido@python.org>
parents: 2462
diff changeset
81 \input{libpdb} % The Python Debugger
1f4141aafe36 converted docs for Jim Roskind's profiler
Guido van Rossum <guido@python.org>
parents: 2462
diff changeset
82
1f4141aafe36 converted docs for Jim Roskind's profiler
Guido van Rossum <guido@python.org>
parents: 2462
diff changeset
83 \input{libprofile} % The Python Profiler
715
93e215dc1d6e Use \include instead of \input.
Guido van Rossum <guido@python.org>
parents: 699
diff changeset
84
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
85 \input{libunix} % UNIX ONLY
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
86 \input{libdbm}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
87 \input{libfcntl}
1765
a04689f9983e Added gdbm docs
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
88 \input{libgdbm}
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
89 \input{libgrp}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
90 \input{libposix}
2064
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1934
diff changeset
91 \input{libposixfile}
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
92 \input{libppath} % really posixpath
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
93 \input{libpwd}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
94 \input{libselect}
2290
f5a6e6ee529c added libsignal.tex
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
95 \input{libsignal}
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
96 \input{libsocket}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
97 \input{libthread}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
98
2351
85fa02b85d7d added www chapters
Guido van Rossum <guido@python.org>
parents: 2347
diff changeset
99 \input{libwww} % WWW EXTENSIONS
2449
8eeecd233d56 added WWW sections
Guido van Rossum <guido@python.org>
parents: 2351
diff changeset
100 \input{libcgi}
2596
31777622ae93 some new material
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
101 \input{liburllib}
31777622ae93 some new material
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
102 \input{libhttplib}
2351
85fa02b85d7d added www chapters
Guido van Rossum <guido@python.org>
parents: 2347
diff changeset
103 \input{libftplib}
85fa02b85d7d added www chapters
Guido van Rossum <guido@python.org>
parents: 2347
diff changeset
104 \input{libgopherlib}
2596
31777622ae93 some new material
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
105 \input{libnntplib}
31777622ae93 some new material
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
106 \input{liburlparse}
2351
85fa02b85d7d added www chapters
Guido van Rossum <guido@python.org>
parents: 2347
diff changeset
107 \input{libhtmllib}
2596
31777622ae93 some new material
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
108 \input{libsgmllib}
31777622ae93 some new material
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
109 \input{librfc822}
2351
85fa02b85d7d added www chapters
Guido van Rossum <guido@python.org>
parents: 2347
diff changeset
110 \input{libmimetools}
85fa02b85d7d added www chapters
Guido van Rossum <guido@python.org>
parents: 2347
diff changeset
111
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
112 \input{libmm} % MULTIMEDIA EXTENSIONS
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
113 \input{libaudioop}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
114 \input{libimageop}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
115 \input{libjpeg}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
116 \input{librgbimg}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
117
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
118 \input{libcrypto} % CRYPTOGRAPHIC EXTENSIONS
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
119 \input{libmd5}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
120 \input{libmpz}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
121 \input{librotor}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
122
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
123 %\input{libamoeba} % AMOEBA ONLY
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
124
2453
cdd3a721b40e a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents: 2449
diff changeset
125 \input{libmac} % MACINTOSH ONLY
2462
e9e86ae5f5a4 small nits and new files
Guido van Rossum <guido@python.org>
parents: 2453
diff changeset
126 \input{libctb}
e9e86ae5f5a4 small nits and new files
Guido van Rossum <guido@python.org>
parents: 2453
diff changeset
127 \input{libmacconsole}
2489
cd64a32ab803 added macdnr
Guido van Rossum <guido@python.org>
parents: 2465
diff changeset
128 \input{libmacdnr}
2462
e9e86ae5f5a4 small nits and new files
Guido van Rossum <guido@python.org>
parents: 2453
diff changeset
129 \input{libmacfs}
e9e86ae5f5a4 small nits and new files
Guido van Rossum <guido@python.org>
parents: 2453
diff changeset
130 \input{libmactcp}
e9e86ae5f5a4 small nits and new files
Guido van Rossum <guido@python.org>
parents: 2453
diff changeset
131 \input{libmacspeech}
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
132
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
133 \input{libstdwin} % STDWIN ONLY
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
134
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
135 \input{libsgi} % SGI IRIX ONLY
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
136 \input{libal}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
137 %\input{libaudio}
2602
bee2aed416d6 New documentation on the CD module.
Sjoerd Mullender <sjoerd@acm.org>
parents: 2596
diff changeset
138 \input{libcd}
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
139 \input{libfl}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
140 \input{libfm}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
141 \input{libgl}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
142 \input{libimgfile}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
143 %\input{libpanel}
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
144
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
145 \input{libsun} % SUNOS ONLY
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
146
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1412
diff changeset
147 \input{lib.ind} % Index
122
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
148
b3803fd3cb2c Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
149 \end{document}