cpython/Doc
Guido van Rossum 5bbf0f7c93 Some updates (AMK at work, added resource.c). 1997-04-30 19:41:48 +00:00
..
ext Correct typo in PyArg_ParseTuple example. 1997-02-10 16:51:52 +00:00
info Added disclaimer. 1996-10-25 15:40:20 +00:00
lib Some updates (AMK at work, added resource.c). 1997-04-30 19:41:48 +00:00
mac Patches for Mac module docs by Jack 1996-10-15 14:37:31 +00:00
ref Added some more turd files we can't avoid: .MIF, .ps, .auto. 1996-11-27 19:52:04 +00:00
templates (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
texinputs Added disclaimer. 1996-10-25 15:40:20 +00:00
tools (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
tut (tut.tex): Normalized all uses of "UNIX" and "{\UNIX}" to use "\UNIX{}", 1996-12-13 21:56:03 +00:00
.cvsignore Added .ilg (makeindex logfile) 1996-11-27 19:54:40 +00:00
.latex2html-init (.latex2html-init): Restore one setting to the default (no real need to 1996-12-06 14:50:58 +00:00
Makefile Add zlib 1997-04-30 19:40:10 +00:00
README Added pointer to framereader distribution. 1996-12-18 19:55:49 +00:00
boilerplate.tex New date and version number. 1996-10-22 19:00:46 +00:00
copyright.tex Added disclaimer. 1996-10-25 15:40:20 +00:00
ext.tex Correct typo in PyArg_ParseTuple example. 1997-02-10 16:51:52 +00:00
extref.tex Fix name of PyObject_GetAttrString 1997-03-03 16:02:10 +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
fix_libaux.sed (fix_libaux.sed): Hackish little sed script to modify lib.aux to get section 1996-11-11 20:49:27 +00:00
keywords.py libsocket.tex: send[to] returns nbytes. 1994-08-01 12:18:36 +00:00
lib.tex Add zlib 1997-04-30 19:40:10 +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 Added fnmatch, base64 and quopri, received from Andrew Kuchling. 1997-04-27 21:25:52 +00:00
libamoeba.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libanydbm.tex New stuff by AMK. 1997-04-03 22:41:49 +00:00
libarray.tex Added unsigned data formats (B, H, I, L). 1997-01-03 19:20:52 +00:00
libaudio.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libaudioop.tex Correct two typos 1997-03-03 16:02:32 +00:00
libbase64.tex Added fnmatch, base64 and quopri, received from Andrew Kuchling. 1997-04-27 21:25:52 +00:00
libbastion.tex Added bastion and (dummy) rexec docs 1996-09-10 17:37:05 +00:00
libbinascii.tex Note that passing a filename to uu.{en,de}code() is deprecated. 1997-04-27 21:29:51 +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 Fix up indentation of examples to use 4 spaces instead of tabs. 1997-02-28 16:37:49 +00:00
libcopy.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
libcrypt.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libcrypto.tex Changed URL for PCT again. 1996-10-22 02:25:24 +00:00
libctb.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libdbm.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +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 Added embryonic description of fcntl.lockf(). Added pointer to that 1996-10-11 17:43:34 +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
libfnmatch.tex Added fnmatch, base64 and quopri, received from Andrew Kuchling. 1997-04-27 21:25:52 +00:00
libformatter.tex (libformatter.tex): Document the flush() method on the writer. 1996-12-31 20:51:42 +00:00
libftplib.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libfuncs.tex Add complex(). 1997-04-02 06:04:02 +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 Horrible hack to split up code '--' to prevent 1997-04-02 06:05:07 +00:00
libgl.tex added nodename macro calls for new very long section names 1995-03-20 12:59:56 +00:00
libglob.tex Added docs for glob 1997-03-25 22:07:53 +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 Patches for Mac module docs by Jack 1996-10-15 14:37:31 +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 Patches for Mac module docs by Jack 1996-10-15 14:37:31 +00:00
libmacos.tex Patches for Mac module docs by Jack 1996-10-15 14:37:31 +00:00
libmacostools.tex Patches for Mac module docs by Jack 1996-10-15 14:37:31 +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 Patches for Mac module docs by Jack 1996-10-15 14:37:31 +00:00
libmailcap.tex Added docs for mailcap 1997-03-25 22:01:35 +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 (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libmisc.tex New stuff by AMK. 1997-04-03 22:41:49 +00:00
libmm.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +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 (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libobjs.tex minor things 1995-04-04 12:29:37 +00:00
liboperator.tex Added section for operator module (compiled Skip Montanaro). 1996-12-06 21:22:41 +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): Fix typo found by Mark Hammond. 1997-01-22 14:25:21 +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 Describe open(2) exported constants 1996-12-19 23:50:34 +00:00
libposixfile.tex Added embryonic description of fcntl.lockf(). Added pointer to that 1996-10-11 17:43:34 +00:00
libppath.tex Remove untrue statement about . and .. being included in list of names 1997-03-25 15:25:54 +00:00
libprofile.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libpwd.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libpython.tex Added site 1997-04-03 22:43:02 +00:00
libquopri.tex Added fnmatch, base64 and quopri, received from Andrew Kuchling. 1997-04-27 21:25:52 +00:00
librand.tex New stuff by AMK. 1997-04-03 22:41:49 +00:00
librandom.tex New stuff by AMK. 1997-04-03 22:41:49 +00:00
libregex.tex Hint about [\] trick to avoid quad backslashes. 1997-03-14 04:10:13 +00:00
libregsub.tex Added a paragraph to describe clear_cache(), and why it's necessary. 1997-02-18 18:59:37 +00:00
libresource.tex Added docs for Jeremy's resource module. 1996-12-18 18:37:05 +00:00
librestricted.tex Done with this for 1.4. 1996-10-24 22:14:06 +00:00
librexec.tex Done with this for 1.4. 1996-10-24 22:14:06 +00:00
librfc822.tex Added descriptions of parsedate(), parsedate_tz(), getdate_tz() 1996-12-06 21:23:53 +00:00
librgbimg.tex mass changes; fix titles; add examples; correct typos; clarifications; 1995-03-17 16:07:09 +00:00
librotor.tex setkey method's argument is no longer optional (it used to be a no-op 1997-01-02 19:48:00 +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
libsite.tex New stuff by AMK. 1997-04-03 22:41:49 +00:00
libsocket.tex Added warning that gethostname() doesn't always return fqdn, and show 1997-01-11 17:04:56 +00:00
libsomeos.tex Add zlib 1997-04-30 19:40:10 +00:00
libsoundex.tex Added soundex (sigh) 1996-12-12 17:02:21 +00:00
libstat.tex Docs for stat.py -- docs by Skip Montanaro. 1996-12-19 22:39:22 +00:00
libstd.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libstdwin.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libstring.tex Add cross-refs for int() to atoi() etc. 1997-04-02 05:56:16 +00:00
libstrings.tex Added ref to StringIO docs. 1997-03-03 16:03:05 +00:00
libstrio.tex Small grammatical touchups: 1997-04-02 14:51:56 +00:00
libstruct.tex 'I' and 'L' now always return a Python long. 1997-01-03 19:21:53 +00:00
libsun.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libsys.tex Document that sys.builtin_module_names is now a tuple. 1997-01-06 23:01:02 +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 (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libtermios.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libthread.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libtime.tex (libtime.tex): Merged in changes from Tamito Kajiyama. 1996-12-13 22:09:52 +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
libundoc.tex Some updates (AMK at work, added resource.c). 1997-04-30 19:41:48 +00:00
libunix.tex Spell Unix, not UNIX. 1997-04-02 06:06:03 +00:00
liburllib.tex Added quote_plus() and unquote_plus(), to do space/plus substitutions 1996-12-13 14:48:47 +00:00
liburlparse.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libuserdict.tex Added docs for UserDict,UserList 1997-03-27 14:56:18 +00:00
libwhichdb.tex New stuff by AMK. 1997-04-03 22:41:49 +00:00
libwhrandom.tex New stuff by AMK. 1997-04-03 22:41:49 +00:00
libwww.tex Added fnmatch, base64 and quopri, received from Andrew Kuchling. 1997-04-27 21:25:52 +00:00
libxdrlib.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libzlib.tex Updated web ref and version#. Folded some long lines. 1997-04-30 19:39:21 +00:00
myformat.perl (myformat.perl): Don't italicize the '[]' characters around optional 1996-12-06 15:09:14 +00:00
myformat.sty (myformat.sty): Added a note about using \command{} v. {\command} wrt. 1996-12-13 21:53:07 +00:00
partparse.py (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +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
texi2html.py (texi2html.py): Minor improvement to HTML 3.0 output for code examples. 1996-10-25 22:13:59 +00:00
texipost.dat Incorporated Jan-Hein's changes and texinfo conversion. 1992-12-08 14:37:55 +00:00
texipre.dat Added disclaimer. 1996-10-25 15:40:20 +00:00
text2latex.py * text2latex.py: call main() instead of always processing ext.tex. 1993-11-19 13:13:22 +00:00
tut.tex (tut.tex): Normalized all uses of "UNIX" and "{\UNIX}" to use "\UNIX{}", 1996-12-13 21:56:03 +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.

The Python Reference Manual is no longer maintained in LaTeX.  It is
now a FrameMaker document.  The FrameMaker 5.0 files (ref.book,
ref*.doc) as well as PostScript generated (ref.ps) from it are in the
subdirectory ref/.  (See ftp://ftp.adobe.com/pub/adobe/framereader for
a free reader for FrameMaker documents, for some platforms.)

If you don't have LaTeX, you can ftp a tar file containing PostScript
of the 3 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
	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.

You need the makeindex utility to produce the index for 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 lp.  For example:

	make lib			# create lib.dvi and lib.ps
	xdvi lib			# preview lib.dvi
	lp lib.ps			# print on default printer


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

The Tutorial and Extensions manual can 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.

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!  More thanks to Dave Ascher for adapting
myformat.sty to the new LaTeX release, to Fred Drake for revamping the
partparse.py and texi2html.py scripts, to the many anonymous authors
of library manual sections and corrections (too many to mention).

Many thanks to Robin Friedrich for the conversion of the Reference
Manual to FrameMaker and his work on its index.