cpython/Doc
Fred Drake d275de985a Remove obsolete lines like this:
\setindexsubitem{(in module frobnitz)}

These are no longer needed when present before any other \setindexsubitem{}
in the module section.  The indexsubitem is now set by \bimodindex and
\stmodindex.
1998-04-04 05:56:51 +00:00
..
api Capitalize "Python" for consistency. 1998-04-03 05:02:28 +00:00
ext Hyphenate "built-in" for consistency. 1998-04-02 18:54:54 +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 Corrected citation markup in first paragraph. 1998-03-05 19:33:10 +00:00
lib Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
mac Removed line of obsolete markup. 1998-04-03 20:35:03 +00:00
perl Minor cleanliness. 1998-04-04 04:19:20 +00:00
ref Change the date to March 6, 1998. 1998-03-06 21:43:09 +00:00
templates Start at updating the template a little bit. There's a lot of stuff that's 1998-04-03 21:25:16 +00:00
texinputs Style specification for building *.ind from *.idx. This is needed to avoid 1998-04-04 04:18:06 +00:00
tools Use the new index style when running makeindex. 1998-04-04 04:20:21 +00:00
tut Normalized case rules in section headings. 1998-04-03 05:16:31 +00:00
.cvsignore Ignore *.bkm files. 1998-03-06 21:22:34 +00:00
Makefile Use new index style for makeindex. 1998-04-04 04:21:45 +00:00
README Mention the --help option to tools/mkhowto.sh. 1998-04-03 05:41:38 +00:00
TODO Added note about weird sequencing of <PRE> & <dl> around {verbatim} sections. 1998-03-27 05:18:45 +00:00
api.tex Capitalize "Python" for consistency. 1998-04-03 05:02:28 +00:00
boilerplate.tex Update documentation release date. 1998-03-05 17:15:26 +00:00
copyright.tex Mark the URL "ftp://ftp.python.org" with \url{}. 1998-02-11 14:42:06 +00:00
ext.tex Hyphenate "built-in" for consistency. 1998-04-02 18:54:54 +00:00
howto.tex Python HOWTO template document, with lots of help from AMK. 1998-03-25 15:39:49 +00:00
index.html Simple index for the reference manuals (mostly for use on the Windows 1997-11-25 18:27:23 +00:00
lib.tex Add fileinput section under Misc. Services. 1998-04-04 05:50:12 +00:00
libaifc.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libal.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
liballos.tex Added \label{} for logical addressing. 1998-02-18 15:22:08 +00:00
libamoeba.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libanydbm.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libarray.tex Use {seealso} environment to refer to the struct module. 1998-04-03 03:35:24 +00:00
libaudioop.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libbase64.tex Be more specific about where in RFC 1421 to look, since it's not at all 1998-04-02 16:24:29 +00:00
libbasehttp.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libbastion.tex Use methoddesc and memberdesc, as needed. 1998-04-02 18:51:30 +00:00
libbinascii.tex Logical markup. 1998-04-03 03:44:56 +00:00
libbinhex.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libbltin.tex Used a named target to form the reference to the Built-in Functions section. 1997-12-16 04:06:06 +00:00
libcd.tex Logical markup. 1998-03-16 06:38:42 +00:00
libcgi.tex Capitalize "Python" for consistency. 1998-04-03 03:47:03 +00:00
libcmath.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libcode.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libcommands.tex Added comment crediting Sue Williams with this documentation section (the 1998-04-03 06:56:31 +00:00
libcopy.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libcopyreg.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libcrypt.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libcrypto.tex Oops, I *thoughT* I had seen a better address for Andrew.... 1998-03-05 20:06:31 +00:00
libctb.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libdbm.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libdis.tex Minor nits. 1998-04-03 05:42:10 +00:00
liberrno.tex Use a {datadesc} environment to describe errorcode. 1998-03-10 03:53:03 +00:00
libexcs.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libfcntl.tex Fix one typo. 1998-04-03 06:54:27 +00:00
libfileinput.tex Document fileinput. 1998-04-04 04:20:51 +00:00
libfl.tex Markup nits. 1998-03-15 01:59:57 +00:00
libfm.tex Logical markup. 1998-03-15 02:04:59 +00:00
libfnmatch.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libformatter.tex Use the new {methoddesc} and {memberdesc} environments as appropriate. 1998-03-27 05:27:08 +00:00
libframework.tex Lots of markup consistency nits. 1998-04-03 07:16:46 +00:00
libftplib.tex Logical markup. 1998-03-12 06:04:53 +00:00
libfuncs.tex Small nits. 1998-04-03 07:15:54 +00:00
libgdbm.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libgetopt.tex Logical markup. 1998-03-10 03:36:00 +00:00
libgl.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libglob.tex Consistency: Don't use module name when referring to functions defined 1998-04-03 06:14:54 +00:00
libgopherlib.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libgrp.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libgzip.tex Add index entry for GzipFile class. 1998-04-03 06:48:16 +00:00
libhtmllib.tex Use the new {methoddesc} and {memberdesc} environments as appropriate. 1998-03-27 05:27:08 +00:00
libhttplib.tex Logical markup. 1998-03-12 05:54:02 +00:00
libimageop.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libimgfile.tex Small markup nits. 1998-04-03 07:09:38 +00:00
libimghdr.tex Logical markup. 1998-03-14 20:09:15 +00:00
libimp.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libintro.tex Added \label{} for logical addressing. 1998-02-18 15:21:26 +00:00
libjpeg.tex Logical markup. 1998-03-14 19:47:23 +00:00
libkeyword.tex Added \label{} for logical addressing. 1998-02-18 15:10:24 +00:00
liblocale.tex Markup consistency. 1998-04-03 06:21:23 +00:00
libmac.tex The list of module descriptions should be a {description} environment, not 1998-02-21 06:30:17 +00:00
libmacconsole.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libmacdnr.tex Logical markup, consistency. 1998-03-17 02:02:51 +00:00
libmacfs.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libmacic.tex Lots of markup consistency nits. 1998-04-03 07:16:46 +00:00
libmacos.tex Removed line of obsolete markup. 1998-04-03 20:35:03 +00:00
libmacostools.tex Lots of markup consistency nits. 1998-04-03 07:16:46 +00:00
libmacspeech.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmactcp.tex Lots of markup consistency nits. 1998-04-03 07:16:46 +00:00
libmacui.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libmailbox.tex Use methoddesc instead of funcdesc to describe the only method. 1998-04-02 18:50:21 +00:00
libmailcap.tex Some nits. 1998-04-02 15:53:07 +00:00
libmain.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmarshal.tex Spell emdash with three hyphens. 1998-03-08 06:28:00 +00:00
libmath.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libmd5.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmimetools.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libmimify.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libminiae.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libmisc.tex Added \label{} for logical addressing. 1998-02-18 15:21:26 +00:00
libmm.tex Added \label{} for logical addressing. 1998-02-18 15:22:08 +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 Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libni.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libnntplib.tex NNTP.xgtitle() description: Add a missing ")" from the response value 1998-02-16 21:57:37 +00:00
libobjs.tex \nodename{} must immediately follow \chapter{} to be handled correctly; 1998-02-19 14:00:22 +00:00
liboperator.tex Some logical markup. 1998-03-08 05:56:15 +00:00
libos.tex Logical markup. small nits. 1998-03-10 03:17:26 +00:00
libpanel.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libparser.tex Minor nits. 1998-04-03 05:31:45 +00:00
libpdb.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libpickle.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libposix.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libposixfile.tex Use \withsubitem{} for indexing extra-module functions. 1998-03-12 06:46:16 +00:00
libppath.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libpprint.tex Talk about some minor nits... 1998-04-03 07:11:32 +00:00
libprofile.tex Index entries. 1998-04-03 07:02:35 +00:00
libpwd.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libpython.tex Capitalize "Python" for consistency. 1998-04-03 07:10:41 +00:00
libqueue.tex Use the new {methoddesc} and {memberdesc} environments as appropriate. 1998-03-27 05:27:08 +00:00
libquopri.tex Small consistency nits. 1998-04-03 07:06:56 +00:00
librand.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
librandom.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libre.tex Some clarifications of out-of-range group indexes/names 1998-04-03 20:07:37 +00:00
libregex.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libregsub.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libresource.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
librestricted.tex Added \label{} for logical addressing. 1998-02-18 15:40:11 +00:00
librexec.tex Use methoddesc and memberdesc, as needed. 1998-04-02 18:51:30 +00:00
librfc822.tex Logical markup. 1998-03-14 06:17:43 +00:00
librgbimg.tex Small markup nits. 1998-04-03 07:09:38 +00:00
librotor.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libselect.tex Markup nits, index entries. 1998-04-02 18:44:38 +00:00
libsgi.tex Added \label{} for logical addressing. 1998-02-18 15:40:11 +00:00
libsgmllib.tex Use the new {methoddesc} and {memberdesc} environments as appropriate. 1998-03-27 05:27:08 +00:00
libshelve.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsignal.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libsite.tex Some logical markup. 1998-03-08 07:09:19 +00:00
libsocket.tex Use {methoddesc} as appropriate. 1998-04-03 07:04:45 +00:00
libsocksvr.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libsomeos.tex Added \label{} for logical addressing. 1998-02-18 15:39:15 +00:00
libsoundex.tex Correct spelling of emdash. 1998-03-08 07:56:48 +00:00
libstat.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libstd.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libstdwin.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libstring.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libstrings.tex Added \label{} for logical addressing. 1998-02-18 15:40:11 +00:00
libstrio.tex Use the new {methoddesc} and {memberdesc} environments as appropriate. 1998-03-27 05:27:08 +00:00
libstruct.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libsun.tex Separate chapter and section. 1998-02-19 18:59:48 +00:00
libsunaudio.tex Capitalize "Python" for consistency. 1998-04-03 07:06:01 +00:00
libsymbol.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libsys.tex New index entries. 1998-04-03 07:05:16 +00:00
libsyslog.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libtempfile.tex Logical markup. 1998-03-10 03:38:31 +00:00
libtemplate.tex Start at updating the template a little bit. There's a lot of stuff that's 1998-04-03 21:25:16 +00:00
libtermios.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libthread.tex Logical markup. 1998-04-03 06:35:54 +00:00
libtime.tex Minor nits. 1998-04-03 06:12:21 +00:00
libtoken.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libtraceback.tex Logical markup. 1998-03-08 06:12:10 +00:00
libtypes.tex Several minor markup nits. 1998-04-03 07:13:56 +00:00
libtypes2.tex "alternative" is a noun, use "alternate" for the adjective. 1998-04-03 07:12:52 +00:00
libundoc.tex Added msvcrt. 1998-03-03 02:00:14 +00:00
libunix.tex Added \label{} for logical addressing. 1998-02-18 15:47:17 +00:00
liburllib.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
liburlparse.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libuser.tex Use \envvar{FOO} instead of \code{\$FOO}. 1998-03-12 06:47:48 +00:00
libuserdict.tex Logical markup. 1998-02-19 06:26:35 +00:00
libuu.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libwhichdb.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libwhrandom.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libwww.tex Added \label{} for logical addressing. 1998-02-18 15:47:17 +00:00
libxdrlib.tex Remove obsolete lines like this: 1998-04-04 05:56:51 +00:00
libxmllib.tex Change "\," to just "," in function signatures. This is easier to maintain, 1998-03-17 06:33:25 +00:00
libzlib.tex Nits. 1998-04-03 06:49:26 +00:00
texipost.dat Incorporated Jan-Hein's changes and texinfo conversion. 1992-12-08 14:37:55 +00:00
texipre.dat Corrected citation markup in first paragraph. 1998-03-05 19:33:10 +00:00
tut.tex Normalized case rules in section headings. 1998-04-03 05:16:31 +00:00

README

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

This directory contains the LaTeX sources to the Python documentation.
They now require LaTeX2e (LaTeX 2.09 compatibility is dropped).

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.)  Many 
thanks to Robin Friedrich for the conversion of the Reference Manual
to FrameMaker and his work on its index.

If you don't have LaTeX, or if you'd rather not format the
documentation yourself, you can ftp a tar file containing HTML, PDF,
or PostScript versions of all documents.  Additional formats may be
available.  These should be in the same place where you fetched the
main Python distribution (try <http://www.python.org> or
<ftp://ftp.python.org>).

The following are the LaTeX source files:

	tut.tex				The tutorial
	lib.tex, lib*.tex		The library reference
	ext.tex				How to extend Python
	api.tex				Reference for the Python/C API

All use the "manual" document class and "python" package, derived from 
the old "myformat.sty" style file.  These contains many macro
definitions useful in documenting Python, and set some style parameters.

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 our site,
we use lpr.  For example:

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


What if I find a bug?
---------------------

First, check that the bug is present in the online version of the
documentation at <http://www.python.org/docs/>; we may have already
fixed it.

If we haven't, tell us about it.  We'd like the documentation to be
complete and accurate, but have limited time.  If you discover any
inconsistencies between the documentation and implementation, or just
have suggestions as to how to improve the documentation, let is know!
Send comments and patches to the Python Documentation Team:

			   python-docs@python.org

Thanks!


What tools do I need?
---------------------

You need to install Python; some of the scripts used to produce the
documentation are written in Python.

The simplest way to get the rest of the tools in the configuration we
used is to install the teTeX TeX distribution, version 0.9.  More
information is available on teTeX at <http://www.tug.org/tetex/>.
This is a UNIX-only TeX distribution at this time.  Note that the 0.9
release is still in testing; this documentation release was tested
with the 18 Mar 1998 release.  We'll be upgrading to the final version 
when it becomes available.

If you don't want to get teTeX, or if you're not using UNIX, here is
what you'll need:

To create DVI, PDF, or PostScript files:

	- LaTeX2e, 1995/12/01 or newer.  Older versions are likely to 
	  choke.

	- makeindex.  This is used to produce the indexes for the
	  library reference and Python/C API reference.

To create PDF files:

	- pdflatex.  We used the one in the teTeX 0.9 distribution
	  (version 0.12f at the time of this writing).  Versions even
	  a couple of patchlevels different are highly likely to
	  fail due to syntax changes for some of the pdftex
	  primitives.

To create PostScript files:

	- dvips.  Most TeX installations include this.  If you don't
	  have one, check CTAN (<ftp://ctan.tug.org/tex-archive/>).

To create info files:

	- makeinfo.  This is available from any GNU mirror.

To create HTML files:

	- Perl 5.004_04 or newer.  Find the software at
	  <http://language.perl.com/info/software.html>.

	- LaTeX2HTML 98.1p1, or newer.  Releases are available at
	  <http://www-dsed.llnl.gov/files/programs/unix/latex2html/>.


What if Times fonts are not available?
--------------------------------------

As distributed, the LaTeX documents use PostScript Times fonts.  This
is done since they are much better looking and produce smaller
PostScript files.  If, however, your TeX installation does not support 
them, they may be easily disabled.  Edit the file
texiinputs/manual.cls and comment out the line that starts
"\RequirePackage{times}" using a "%" character at the beginning of the
line.  An alternative is to install the right fonts and LaTeX style
file.


What if I want to use A4 paper?
-------------------------------

Edit the file texinputs/manual.cls.  Change the line that reads:

    \LoadClass[twoside,openright]{report}

to say:

    \LoadClass[a4paper,twoside,openright]{report}

Now do a "make clean all" to generate PostScript files.


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

The LaTeX documents can be converted to HTML using Nikos Drakos'
LaTeX2HTML converter.  See the Makefile; after some twiddling, "make
l2h" should do the trick.

For the reference manual, we use Harlequin's webmaker.  We're not very 
happy with it and hope that eventually FrameMaker will be able to
produce HTML without third party help.


What else is in here?
---------------------

There is a new LaTeX document class called "howto".  This is used for
the new series of Python HOWTO documents which is being coordinated by 
Andrew Kuchling <amk@acm.org>.  The file howto.tex is a commented
template which may be used an example.  A script to "do the right
thing" to format a howto document is included as tools/mkhowto.sh.
Support for this document class is still new, but is expected to
evolve rapidly.  Use "mkhowto.sh --help" for information on using the
formatting tool.


Copyright notice
================

The Python source is copyrighted, but you can freely use and copy it
as long as you don't change or remove the copyright notice:

----------------------------------------------------------------------
Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
The Netherlands.

                        All Rights Reserved

Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the names of Stichting Mathematisch
Centrum or CWI or Corporation for National Research Initiatives or
CNRI not be used in advertising or publicity pertaining to
distribution of the software without specific, written prior
permission.

While CWI is the initial source for this software, a modified version
is made available by the Corporation for National Research Initiatives
(CNRI) at the Internet address ftp://ftp.python.org.

STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
----------------------------------------------------------------------