annotate Doc/texinputs/distutils.sty @ 21467:4e35fa5d5708 legacy-trunk

Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.
author Fred Drake <fdrake@acm.org>
date Tue, 18 Dec 2001 16:31:08 +0000
parents 6979966ee94d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12363
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
1 %
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
2 % LaTeX commands and macros needed for the two Distutils manuals,
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
3 % inst.tex and dist.tex.
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
4 %
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
5 % $Id$
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
6 %
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
7
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
8 % My gripe list about the Python style files:
12382
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
9 % * I want italics in verbatim environments for variable
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
10 % text (verbatim.sty?)
12363
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
11 % * I hate escaping underscores (url.sty fixes this)
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
12
12382
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
13 % '\command' is for Distutils commands which, depending on your
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
14 % perspective, are just arguments to the setup script, or sub-
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
15 % commands of the setup script, or the classes that implement
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
16 % each "command".
12363
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
17 \newcommand{\command}[1]{\code{#1}}
12382
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
18
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
19 % '\option' is for Distutils options *in* the setup script. Command-
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
20 % line options *to* the setup script are marked up in the usual
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
21 % way, ie. with '\programopt' or '\longprogramopt'
12363
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
22 \newcommand{\option}[1]{\textsf{\small{#1}}}
12382
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
23
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
24 % '\filevar' is for variable components of file/path names -- eg.
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
25 % when you put 'prefix' in a pathname, you mark it up with
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
26 % '\filevar' so that it still looks pathname-ish, but is
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
27 % distinguished from the literal part of the path. Fred says
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
28 % this can be accomplished just fine with '\var', but I violently
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
29 % disagree. Pistols at dawn will sort this one out.
12363
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
30 \newcommand{\filevar}[1]{{\textsl{\filenq{#1}}}}
12382
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
31
5f29d7c02433 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Greg Ward <gward@python.net>
parents: 12363
diff changeset
32 % Just while the code and docs are still under development.
12363
7f650df271c9 LaTeX macros for the Distutils manuals.
Greg Ward <gward@python.net>
parents:
diff changeset
33 \newcommand{\XXX}[1]{\textbf{**#1**}}