cpython/Doc
Fred Drake 798654fc68 Added \indexsubitem definition; functions were previously indexed for the
wrong module.
1997-11-30 05:53:22 +00:00
..
api Several changes, e.g. restructuring of the intro to be closer to what 1997-11-25 15:34:51 +00:00
ext Added pointer to api.tex and note about the out-of-date-ness of this 1997-10-07 14:40:16 +00:00
html Simple index for the reference manuals (mostly for use on the Windows 1997-11-25 18:27:23 +00:00
icons Adding the icons used by latex2html output to the CVS tree. 1997-11-25 20:14:07 +00:00
info Added disclaimer. 1996-10-25 15:40:20 +00:00
lib Added \indexsubitem definition; functions were previously indexed for the 1997-11-30 05:53:22 +00:00
mac Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
ref Ignore html files generated by webmaker. 1997-11-25 20:10:40 +00:00
templates Added label{module-spam} 1997-07-18 21:07:34 +00:00
texinputs Fix the release date for 1.5b1 to be Nov. 26 1997-11-18 15:32:15 +00:00
tools Added the "italic correction" command ("\/") to the list of ignored commands. 1997-11-25 04:06:21 +00:00
tut Change Python-as-executable-script example to use "#! /usr/bin/env python" 1997-10-15 14:37:24 +00:00
.cvsignore Add the four latex2html output directories: api, ext, lib, tut. 1997-10-06 13:20:17 +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 The dependency of tarhtml on l2h was a bad idea. 1997-11-26 15:31:32 +00:00
README Added pointer to framereader distribution. 1996-12-18 19:55:49 +00:00
api.tex Several changes, e.g. restructuring of the intro to be closer to what 1997-11-25 15:34:51 +00:00
boilerplate.tex Fix the release date for 1.5b1 to be Nov. 26 1997-11-18 15:32:15 +00:00
copyright.tex Added disclaimer. 1996-10-25 15:40:20 +00:00
custlib.py A nicety (author lost). 1997-06-02 17:57:10 +00:00
ext.tex Added pointer to api.tex and note about the out-of-date-ness of this 1997-10-07 14:40:16 +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
index.html Simple index for the reference manuals (mostly for use on the Windows 1997-11-25 18:27:23 +00:00
keywords.py libsocket.tex: send[to] returns nbytes. 1994-08-01 12:18:36 +00:00
lib.tex Oops, did the previous delete the wrong way. 1997-11-25 00:05:12 +00:00
libaifc.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libal.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
liballos.tex Adding Martin von Loewis' documentation for his locale module. 1997-11-20 21:04:27 +00:00
libamoeba.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libanydbm.tex Added \indexsubitem definition. Non-optimal, but two modules are sharing 1997-11-30 05:38:44 +00:00
libarray.tex Added buffer_info() docs. 1997-08-14 19:50:37 +00:00
libaudioop.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libbase64.tex Added \indexsubitem definition; functions were previously indexed for the 1997-11-30 05:53:22 +00:00
libbastion.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libbinascii.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libbltin.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libcd.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libcgi.tex Remove strange use of $math$ mode to produce a backslash. 1997-11-25 00:35:44 +00:00
libcmath.tex Fixed up formatting, added descriptions for previously undocumented functions. 1997-09-30 20:14:50 +00:00
libcode.tex added code.py; codehack.py is obsolete 1997-07-18 21:08:07 +00:00
libcommands.tex Don't use $math$ mode to typeset a simple '>' sign. Use \code, not \samp. 1997-11-25 00:43:34 +00:00
libcopy.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libcrypt.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libcrypto.tex Changed URL for PCT again. 1996-10-22 02:25:24 +00:00
libctb.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libdbm.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libdis.tex Docu for dis.py, written by Martin von Loewis. 1997-11-18 15:10:53 +00:00
liberrno.tex Added doc for errorcode dictionary. 1997-11-18 15:27:51 +00:00
libexcs.tex The sequence behavior is now on the Exception root class rather than 1997-10-07 14:41:04 +00:00
libfcntl.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libfl.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libfm.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libfnmatch.tex Added \indexsubitem definition; functions were previously indexed for the 1997-11-30 05:53:22 +00:00
libformatter.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libftplib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libfuncs.tex Documented __import__, callable, isinstance, issubclass, 1997-10-05 18:53:00 +00:00
libgdbm.tex Extensive changes by AMK. 1997-07-17 16:29:42 +00:00
libgetopt.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libgl.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libglob.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libgopherlib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libgrp.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libgzip.tex New from AMK 1997-07-17 16:26:11 +00:00
libhtmllib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libhttplib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libimageop.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libimgfile.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libimghdr.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libimp.tex Update the description and the example to the new functionality, which 1997-09-09 20:53:37 +00:00
libintro.tex minor things 1995-04-04 12:29:37 +00:00
libjpeg.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libkeyword.tex Documentation for the keyword module. 1997-10-06 21:39:16 +00:00
liblocale.tex Adding Martin von Loewis' documentation for his locale module. 1997-11-20 21:04:27 +00:00
libmac.tex Patches for Mac module docs by Jack 1996-10-15 14:37:31 +00:00
libmacconsole.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmacdnr.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmacfs.tex Added missing "\end{funcdesc}" after FindFolder documentation. 1997-08-22 13:45:13 +00:00
libmacic.tex Misc Mac mods by Jack. Added libmacic.tex, and these patches: 1997-08-18 15:14:26 +00:00
libmacos.tex Changed description of SchedParams() in the following way: 1997-08-22 13:51:31 +00:00
libmacostools.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmacspeech.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libmactcp.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libmacui.tex Misc Mac mods by Jack. Added libmacic.tex, and these patches: 1997-08-18 15:14:26 +00:00
libmailbox.tex Misc Mac mods by Jack. Added libmacic.tex, and these patches: 1997-08-18 15:14:26 +00:00
libmailcap.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmain.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmarshal.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmath.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libmd5.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmimetools.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmimify.tex Documented mime_decode_header() and mime_encode_header(). 1997-08-14 14:13:01 +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 AMK's megapatch: 1997-07-17 16:34:52 +00:00
libni.tex Slip of the keyboard (f__ should be __). Dunno why I had a totally 1997-11-27 01:39:15 +00:00
libnntplib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libobjs.tex minor things 1995-04-04 12:29:37 +00:00
liboperator.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libos.tex Added os.altsep; this is '/' on DOS/Windows, and None on systems with 1997-08-29 22:37:44 +00:00
libpanel.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libparser.tex Removed leading comment about this being "introductory" documentation; 1997-11-25 04:04:00 +00:00
libpdb.tex Small wording change about global and local trace functions. 1997-10-27 19:57:20 +00:00
libpickle.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libposix.tex Added strerror() 1997-10-05 18:54:52 +00:00
libposixfile.tex Added embryonic description of fcntl.lockf(). Added pointer to that 1996-10-11 17:43:34 +00:00
libppath.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libpprint.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libprofile.tex Clarified reference to old profiler. 1997-11-18 15:28:46 +00:00
libpwd.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libpython.tex Add description for some modules that have been added since this intro 1997-11-20 21:03:33 +00:00
libqueue.tex libqueue.tex: Documentation for the Queue.py module. 1997-11-20 19:54:16 +00:00
libquopri.tex Added \indexsubitem definition; functions were previously indexed for the 1997-11-30 05:53:22 +00:00
librand.tex Updated \indexsubitem; functions had been indexed for the wrong module. 1997-11-30 05:23:47 +00:00
librandom.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libre.tex In the description of sub(), give a better explanation of the 1997-11-20 00:15:13 +00:00
libregex.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libregsub.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libresource.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
librestricted.tex Done with this for 1.4. 1996-10-24 22:14:06 +00:00
librexec.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
librfc822.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
librgbimg.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
librotor.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libselect.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libsgi.tex restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
libsgmllib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libshelve.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libsignal.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libsite.tex Change packages to site-packages (so it's clearly not a package itself). 1997-09-08 02:02:37 +00:00
libsocket.tex Document s.connect_ex(), which does not raise an exception on error. 1997-11-18 15:29:20 +00:00
libsocksvr.tex Added \indexsubitem definition; functions were previously indexed for the 1997-11-30 05:53:22 +00:00
libsomeos.tex Add description for Queue; fix typo (whichdbm should be whichdb). 1997-11-20 21:00:03 +00:00
libsoundex.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libstat.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libstd.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libstdwin.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libstring.tex count() now has a 4th parameter too. Also rephrased the docs for find 1997-10-20 22:40:26 +00:00
libstrings.tex Added ref to StringIO docs. 1997-03-03 16:03:05 +00:00
libstrio.tex Note that getvalue() must be called before close(). 1997-07-17 16:29:04 +00:00
libstruct.tex Ignore whitespace between formats (not internal to a count+format). 1997-08-26 20:39:54 +00:00
libsun.tex typos, layout and other small things 1995-04-10 11:34:00 +00:00
libsys.tex Documented brand new behavior of sys.ps1 and sys.ps2 (str() is applied 1997-11-25 21:12:27 +00:00
libsyslog.tex Added \indexsubitem definition; functions were previously indexed for the 1997-11-30 05:27:26 +00:00
libtempfile.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libtemplate.tex Added label{module-spam} 1997-07-18 21:07:34 +00:00
libtermios.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libthread.tex Updated platform specific notes (it is now more common to have this) 1997-08-14 19:51:26 +00:00
libtime.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libtraceback.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libtypes.tex Remove superfluous comman from between "not" and "in" when describing the 1997-10-13 20:48:17 +00:00
libtypes2.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libundoc.tex Add fileinput. 1997-11-24 17:50:09 +00:00
libunix.tex Spell Unix, not UNIX. 1997-04-02 06:06:03 +00:00
liburllib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
liburlparse.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libuser.tex Added docs for 'user' customization module. Renamed libuser.tex 1997-08-30 20:02:25 +00:00
libuserdict.tex Added docs for UserDict,UserList 1997-03-27 14:56:18 +00:00
libwhichdb.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libwhrandom.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libwww.tex Add xmllib; remove (slow) from description of htmllib. 1997-11-18 15:30:40 +00:00
libxdrlib.tex Ooops, found too more references to old conditions on floating point values. 1997-10-24 21:15:55 +00:00
libxmllib.tex Docu for xmllib.py, by Sjoerd Mullender. 1997-11-18 15:11:22 +00:00
libzlib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
myformat.perl Add support for NULL macro (like UNIX, ABC etc.). 1997-11-18 15:31:16 +00:00
myformat.sty Add AMK's seealso environment that is now used in the library manual 1997-07-17 18:27:53 +00:00
partparse.py Added the "italic correction" command ("\/") to the list of ignored commands. 1997-11-25 04:06:21 +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 Change Python-as-executable-script example to use "#! /usr/bin/env python" 1997-10-15 14:37:24 +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.