cpython/Doc
Fred Drake 4bf1296e05 (libtypes.tex): Correct reversal of two words in description of
formatting strings.
1996-10-11 16:33:48 +00:00
..
ext Remove mention of HAVE_CONFIG_H 1996-08-19 22:59:46 +00:00
info New version/date 1996-08-23 15:45:37 +00:00
lib (libtypes.tex): Correct reversal of two words in description of 1996-10-11 16:33:48 +00:00
mac Added SetFolder 1996-07-30 18:22:31 +00:00
ref Mention warning for exception in __del__. 1996-08-20 18:03:48 +00:00
templates Fixed typo. 1995-10-10 11:57:49 +00:00
texinputs New version/date 1996-08-23 15:45:37 +00:00
tools (partparse.py): Small fix to do_datadesc(): in some odd cases the name of 1996-10-10 20:09:56 +00:00
tut A first stab at describing what's new in 1.4. Still many XXX'es left. 1996-10-08 17:29:56 +00:00
.cvsignore Ignore latex intermediate products. 1996-06-26 19:30:01 +00:00
Makefile (Makefile): Push texi2html.py options into a make variable. 1996-10-09 19:33:17 +00:00
README adapted to modern times; added section of HTML 1995-03-20 13:00:53 +00:00
boilerplate.tex New version/date 1996-08-23 15:45:37 +00:00
copyright.tex use {} instead of \ after \copyright 1995-03-28 13:31:51 +00:00
ext.tex Remove mention of HAVE_CONFIG_H 1996-08-19 22:59:46 +00:00
extref.tex Protect '&' signs with '\' in description of PyNumber_Coerce. 1996-09-27 17:28:03 +00:00
fix.el Merge alpha100 branch back to main trunk 1994-08-01 12:22:53 +00:00
fix_hack Merge alpha100 branch back to main trunk 1994-08-01 12:22:53 +00:00
keywords.py libsocket.tex: send[to] returns nbytes. 1994-08-01 12:18:36 +00:00
lib.tex (lib.tex, libwww.tex): Include the sgmlib chapter before the htmllib 1996-10-09 14:36:54 +00:00
libaifc.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libal.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
liballos.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libamoeba.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libarray.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libaudio.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libaudioop.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libbastion.tex Added bastion and (dummy) rexec docs 1996-09-10 17:37:05 +00:00
libbinascii.tex Added base64 codec docs 1995-10-10 14:41:03 +00:00
libbltin.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libcd.tex restructured docs for callback types 1995-03-30 11:47:50 +00:00
libcgi.tex Document the *new* cgi.py 1996-07-30 18:22:07 +00:00
libcopy.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libcrypt.tex Added lost docs for crypt module. 1996-04-10 16:18:20 +00:00
libcrypto.tex Updated pointers to Andrew Kuchlings fine software. 1996-07-23 18:16:56 +00:00
libctb.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libdbm.tex documented default flag, mode; changed gdbm into a pointer to dbm 1995-07-07 22:55:57 +00:00
liberrno.tex Get rid of parrot dropping (spurious 'E') 1996-08-09 21:23:14 +00:00
libexcs.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libfcntl.tex Add flock; warn about lockdata system dependency when using fcntl. 1996-06-26 19:20:33 +00:00
libfl.tex added nodename macro calls for new very long section names 1995-03-20 12:59:56 +00:00
libfm.tex Lots of small corrections by Andrew Kuchling (plus all new rotor docs) 1994-08-08 12:30:22 +00:00
libformatter.tex (libhtmllib.tex, libsgmllib.tex, libformatter.tex): 1996-10-09 16:13:22 +00:00
libftplib.tex typos only 1995-08-10 14:21:11 +00:00
libfuncs.tex Typos detected by Sjoerd 1996-10-11 15:57:17 +00:00
libgdbm.tex documented default flag, mode; changed gdbm into a pointer to dbm 1995-07-07 22:55:57 +00:00
libgetopt.tex Added long getopt docs; by Fred 1996-09-11 21:26:29 +00:00
libgl.tex added nodename macro calls for new very long section names 1995-03-20 12:59:56 +00:00
libgopherlib.tex some new material 1995-03-22 15:48:46 +00:00
libgrp.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libhtmllib.tex (libhtmllib.tex, libsgmllib.tex, libformatter.tex): 1996-10-09 16:13:22 +00:00
libhttplib.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libimageop.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libimgfile.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libimghdr.tex Added imghdr,xdrlib; reformatted Makefile somewhat 1996-08-19 22:58:03 +00:00
libimp.tex Slight update; file args are no longer optional. 1996-06-26 19:21:24 +00:00
libintro.tex minor things 1995-04-04 12:29:37 +00:00
libjpeg.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libmac.tex changes by Jack to Mac docs 1996-07-21 02:20:58 +00:00
libmacconsole.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libmacdnr.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libmacfs.tex Added SetFolder 1996-07-30 18:22:31 +00:00
libmacos.tex changes by Jack to Mac docs 1996-07-21 02:20:58 +00:00
libmacostools.tex Documented MACFS, macostools, EasyDialogs and FrameWork modules. 1995-10-10 14:43:20 +00:00
libmacspeech.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libmactcp.tex changes by Jack to Mac docs 1996-07-21 02:20:58 +00:00
libmacui.tex changes by Jack to Mac docs 1996-07-21 02:20:58 +00:00
libmain.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libmarshal.tex Add docs for planned improved handling of the marshalling of 1996-06-26 20:20:57 +00:00
libmath.tex hypot is now always supported 1996-02-12 23:14:36 +00:00
libmd5.tex Give correct length of string. 1996-06-26 19:21:58 +00:00
libmimetools.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libmisc.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libmm.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libmods.tex Lots of small corrections by Andrew Kuchling (plus all new rotor docs) 1994-08-08 12:30:22 +00:00
libmpz.tex clarify optional status 1995-08-10 14:21:49 +00:00
libnntplib.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libobjs.tex minor things 1995-04-04 12:29:37 +00:00
libos.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libpanel.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libparser.tex (libparser.tex): Revised parser module documentation; improved logical 1996-09-11 21:57:40 +00:00
libpdb.tex more complete examples 1995-04-04 12:28:53 +00:00
libpickle.tex Suggest using default values for __init__ arguments to make classes 1996-08-09 21:23:47 +00:00
libposix.tex added plock 1996-07-21 02:21:49 +00:00
libposixfile.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libppath.tex Document actual behavior of splitext(). 1996-08-19 23:00:50 +00:00
libprofile.tex change jars email 1996-02-12 23:17:40 +00:00
libpwd.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libpython.tex added parser module to overview 1996-07-21 02:22:12 +00:00
librand.tex small changes by Soren Larsen 1995-03-13 10:03:32 +00:00
libregex.tex Added Andrew Kuchling's explanation of regexp's. 1996-06-26 19:43:22 +00:00
libregsub.tex Added capwords, splitx, and optional 3rd argument to split/splitx. 1996-08-09 21:43:21 +00:00
librexec.tex Added bastion and (dummy) rexec docs 1996-09-10 17:37:05 +00:00
librfc822.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
librgbimg.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
librotor.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libselect.tex minor things 1995-04-04 12:29:37 +00:00
libsgi.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libsgmllib.tex (libhtmllib.tex, libsgmllib.tex, libformatter.tex): 1996-10-09 16:13:22 +00:00
libshelve.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libsignal.tex document non-BSD SIGCHLD behaviour 1996-02-12 23:18:51 +00:00
libsocket.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libsomeos.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libstd.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libstdwin.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libstring.tex Added capitalize, capwords, lstrip, rstrip, and optional 3rd argument 1996-08-09 21:44:51 +00:00
libstrings.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libstruct.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libsun.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libsys.tex correct typo; document sys.platform 1995-07-07 23:00:35 +00:00
libsyslog.tex syslog docs by steve clift 1995-10-09 20:49:57 +00:00
libtempfile.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libtemplate.tex Fixed typo. 1995-10-10 11:57:49 +00:00
libtermios.tex documented termios + TERMIOS 1995-03-31 12:26:24 +00:00
libthread.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libtime.tex Moved description of mktime 9-tuple to top. 1996-07-30 18:32:04 +00:00
libtraceback.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libtypes.tex (libtypes.tex): Correct reversal of two words in description of 1996-10-11 16:33:48 +00:00
libtypes2.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libunix.tex Added lost docs for crypt module. 1996-04-10 16:18:20 +00:00
liburllib.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
liburlparse.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libwhrandom.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libwww.tex (lib.tex, libwww.tex): Include the sgmlib chapter before the htmllib 1996-10-09 14:36:54 +00:00
libxdrlib.tex Nits corrected by Fred 1996-09-27 17:11:24 +00:00
myformat.perl * Doc/libfuncs.tex: don't use $math$ in description of pow(x,y,z); 1994-08-12 13:13:50 +00:00
myformat.sty Fixed for Latex2e by Dave Ascher. 1996-06-26 19:03:20 +00:00
partparse.py (partparse.py): Small fix to do_datadesc(): in some odd cases the name of 1996-10-10 20:09:56 +00:00
qua.tex change of address and date 1995-03-15 12:53:31 +00:00
quabib.bib Initial revision 1992-02-11 15:52:24 +00:00
ref.tex update list of supported os-es 1995-04-04 11:57:22 +00:00
ref1.tex replace ASCII by macro call 1995-03-15 11:25:32 +00:00
ref2.tex Erase all memory of the access statement 1996-08-20 17:35:48 +00:00
ref3.tex Mention warning for exception in __del__. 1996-08-20 18:03:48 +00:00
ref4.tex Documented class exceptions. 1996-08-19 23:00:03 +00:00
ref5.tex expr_list -> expression_list 1996-06-26 19:26:55 +00:00
ref6.tex Erase all memory of the access statement 1996-08-20 17:35:48 +00:00
ref7.tex added '**kw' to parameter list syntax 1996-06-26 19:26:20 +00:00
ref8.tex added index entries for __*__ identifiers 1995-03-21 14:41:57 +00:00
texi2html.py (texi2html.py): Tightened the generated HTML slightly. Added -p option to 1996-10-09 19:05:12 +00:00
texipost.dat Incorporated Jan-Hein's changes and texinfo conversion. 1992-12-08 14:37:55 +00:00
texipre.dat New version/date 1996-08-23 15:45:37 +00:00
text2latex.py * text2latex.py: call main() instead of always processing ext.tex. 1993-11-19 13:13:22 +00:00
tut.tex A first stab at describing what's new in 1.4. Still many XXX'es left. 1996-10-08 17:29:56 +00:00
whichlibs At release 1.0.1. Scripts, Makefile, README: cosmetic changes and 1994-02-15 15:59:23 +00:00

README

Python main documentation -- in LaTeX
-------------------------------------

This directory contains the LaTeX sources to the Python documentation
and a published article about Python.

If you don't have LaTeX, you can ftp a tar file containing PostScript
of the 4 main documents.  It should be in the same place where you
fetched the main Python distribution, in a file named
"pythondoc-ps<version>.tar.gz".  (See "../Misc/FAQ" for more
information about ftp-ing Python files.)

The following are the LaTeX source files:

	tut.tex				The tutorial
	lib.tex, lib*.tex		The library reference
	ref.tex, ref[1-8].tex		The reference manual
	ext.tex				How to extend Python
	qua.tex, quabib.bib		Article published in CWI Quarterly

All except qua.tex (which isn't built by the default target) use the
style option file "myformat.sty".  This contains some macro
definitions and sets some style parameters.

The style parameters are set up for European paper size (21 x 29.7 cm,
a.k.a. A4, or roughly 8.27 x 11.7 inch) by default.  To use US paper,
comment out the line saying \input{a4wide.sty} in myformat.sty (you
may want to fiddle with lay-out parameters like \textwidth and
\textheight, since the default format uses rather wide margins).

You need the makeindex utility to produce the index for ref.tex
lib.tex; you need bibtex to produce the references list for qua.tex.

There's a Makefile to call LaTeX and the other utilities in the right
order and the right number of times.  This will produce DVI files for
each document made; to preview them, use xdvi.  PostScript is produced
by the same Makefile target that produces the DVI files.  This uses
the dvips tool.  Printing depends on local conventions; at my site, I
use lpr.  For example:

	make ref			# creates ref.dvi and ref.ps
	xdvi ref			# preview it ref.dvi
	lpr -Ppsc ref.ps		# print it on printer "psc".


Making HTML files
-----------------

The Reference, Tutorial and Extensions manual can all be converted to
HTML using Nikos Drakos' LaTeX2HTML converter.  See the Makefile;
after some twiddling, "make l2h" should do the trick.

The Library manual doesn't work well with LaTeX2HTML; instead, there's
a Python script texi2html.py in this directory that can be run on the
texinfo generated as an intermediate step for generating the INFO
files as described in the next section.  The command "make libwww"
should do this.


Making the INFO version of the Library Reference
------------------------------------------------

The Library Reference can also be read in hypertext form using the
Emacs INFO system.  This uses Texinfo format as an intermediate step.
It requires texinfo version 2 (we have used 2.14).

To build the info files (python-lib.info*), say "make lib.info".  This
takes a while, even on a machine with a 100 MHz clock and 64 Mbytes of
RAM :-).  Please ignore the output, which appears like error messages
but really is debugging output only.

You may have to change a site dependency in fix.el: if texinfo 2.xx
isn't installed by default at your site, you'll have to install it
(use archie to locate a version and ftp to fetch it).  If you can't
install it in the standard Emacs load path, uncomment the line
containing a "(setq load-path ...)" statement, and fill in the path
where you put it.

The files used by the conversion process are:

partparse.py            Python script that converts LaTeX sources to
			texi files.

texi{pre,post}.dat      Files placed before and after the result.

fix.el                  Elisp file executed by Emacs. Two calls to
                        'texinfo-all-menus-update are necessary in
			some cases.

fix_hack		Shell script to fix the results of the
                        "underscore hack". {\ptt \char'137} is
                        back-translated to a simple underscore.  This
                        is needed for the texindex program.

whichlibs		Shell script to print a list of lib*.tex files
			to be processed.

A Million thanks for Jan-Hein B\"uhrman for writing and debugging the
convertor and related scripts, and for fixing the LaTeX sources and
writing new macros for myformat.sty!