[Python-checkins] CVS: python/dist/src/Doc/inst inst.tex,1.28,1.29
Fred L. Drake
fdrake@users.sourceforge.net
Thu, 01 Mar 2001 10:37:54 -0800
Update of /cvsroot/python/python/dist/src/Doc/inst
In directory usw-pr-cvs1:/tmp/cvs-serv18749/inst
Modified Files:
inst.tex
Log Message:
Comment out section titles for sections that have not been written yet;
there is no need to clutter a reader's life with those useless things.
Suppress the "Contents" page for HTML; it is not needed for small documents
in the online environment since LaTeX2HTML generates lots of tables of links
anyway.
Various markup consistency nits.
Index: inst.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/inst/inst.tex,v
retrieving revision 1.28
retrieving revision 1.29
diff -C2 -r1.28 -r1.29
*** inst.tex 2001/02/17 00:42:56 1.28
--- inst.tex 2001/03/01 18:37:52 1.29
***************
*** 42,46 ****
--- 42,53 ----
%\end{abstract}
+
+ % The ugly "%begin{latexonly}" pseudo-environment supresses the table
+ % of contents for HTML generation.
+ %
+ %begin{latexonly}
\tableofcontents
+ %end{latexonly}
+
\section{Introduction}
***************
*** 114,117 ****
--- 121,125 ----
\file{README}), which should explain that building and installing the
module distribution is a simple matter of running
+
\begin{verbatim}
python setup.py install
***************
*** 163,169 ****
--- 171,179 ----
As described in section~\ref{new-standard}, building and installing
a module distribution using the Distutils is usually one simple command:
+
\begin{verbatim}
python setup.py install
\end{verbatim}
+
On \UNIX, you'd run this command from a shell prompt; on Windows, you
have to open a command prompt window (``DOS box'') and do it there; on
***************
*** 179,182 ****
--- 189,193 ----
module source distribution \file{foo-1.0.tar.gz} onto a
\UNIX{} system, the normal thing to do is:
+
\begin{verbatim}
gunzip -c foo-1.0.tar.gz | tar xf - # unpacks into directory foo-1.0
***************
*** 192,195 ****
--- 203,207 ----
unpack the archive. Then, open a command prompt window (``DOS box''),
and run:
+
\begin{verbatim}
cd c:\Temp\foo-1.0
***************
*** 231,238 ****
--- 243,252 ----
For example, you can build everything in one step, and then install
everything in a second step, by invoking the setup script twice:
+
\begin{verbatim}
python setup.py build
python setup.py install
\end{verbatim}
+
(If you do this, you will notice that running the \command{install}
command first runs the \command{build} command, which---in this
***************
*** 256,262 ****
--- 270,278 ----
change the build directory with the \longprogramopt{build-base} option.
For example:
+
\begin{verbatim}
python setup.py build --build-base=/tmp/pybuild/foo-1.0
\end{verbatim}
+
(Or you could do this permanently with a directive in your system or
personal Distutils configuration file; see
***************
*** 264,267 ****
--- 280,284 ----
The default layout for the build tree is as follows:
+
\begin{verbatim}
--- build/ --- lib/
***************
*** 270,273 ****
--- 287,291 ----
temp.<plat>/
\end{verbatim}
+
where \code{<plat>} expands to a brief description of the current
OS/hardware platform and Python version. The first form, with just a
***************
*** 407,412 ****
! \subsection{Tweaking compiler/linker flags}
! \label{tweak-flags}
--- 425,430 ----
! %\subsection{Tweaking compiler/linker flags}
! %\label{tweak-flags}
***************
*** 451,460 ****
--- 469,481 ----
personal stash of Python modules, probably under your home directory.
Installing a new module distribution is as simple as
+
\begin{verbatim}
python setup.py install --home=<dir>
\end{verbatim}
+
where you can supply any directory you like for the \longprogramopt{home}
option. Lazy typists can just type a tilde (\code{\textasciitilde}); the
\command{install} command will expand this to your home directory:
+
\begin{verbatim}
python setup.py install --home=~
***************
*** 487,490 ****
--- 508,512 ----
\file{/usr/local/lib/python1.\filevar{X}} rather than
\file{/usr/lib/python1.\filevar{X}}. This can be done with
+
\begin{verbatim}
/usr/bin/python setup.py install --prefix=/usr/local
***************
*** 498,501 ****
--- 520,524 ----
\file{/mnt/\filevar{@server}/export/lib/python1.\filevar{X}}. This
could be done with
+
\begin{verbatim}
/usr/local/bin/python setup.py install --prefix=/mnt/@server/export
***************
*** 549,555 ****
--- 572,580 ----
and \longprogramopt{home} options. Just use the \longprogramopt{prefix}
option to specify a base directory, e.g.
+
\begin{verbatim}
python setup.py install --prefix="\Temp\Python"
\end{verbatim}
+
to install modules to the \file{\textbackslash{}Temp} directory on the current
drive.
***************
*** 607,610 ****
--- 632,636 ----
sense to supply a relative path, which will be interpreted relative to
the installation base directory (your home directory, in this case):
+
\begin{verbatim}
python setup.py install --home=~ --install-scripts=scripts
***************
*** 616,622 ****
--- 642,650 ----
you want them in \file{/usr/local/bin} instead, you would supply this
absolute directory for the \longprogramopt{install-scripts} option:
+
\begin{verbatim}
python setup.py install --install-scripts=/usr/local/bin
\end{verbatim}
+
(This performs an installation using the ``prefix scheme,'' where the
prefix is whatever your Python interpreter was installed with---
***************
*** 629,635 ****
--- 657,665 ----
two types of modules to worry about, pure modules and non-pure modules
(i.e., modules from a non-pure distribution). For example:
+
\begin{verbatim}
python setup.py install --install-purelib=Site --install-platlib=Site
\end{verbatim}
+
The specified installation directories are relative to \filevar{prefix}.
Of course, you also have to ensure that these directories are in
***************
*** 645,648 ****
--- 675,679 ----
you use your home directory from, you might define the following
installation scheme:
+
\begin{verbatim}
python setup.py install --home=~ \
***************
*** 652,656 ****
--- 683,690 ----
--install-data=python/data
\end{verbatim}
+ % $ % -- bow to font-lock
+
or, equivalently,
+
\begin{verbatim}
python setup.py install --home=~/python \
***************
*** 660,663 ****
--- 694,699 ----
--install-data=data
\end{verbatim}
+ % $ % -- bow to font-lock
+
\code{\$PLAT} is not (necessarily) an environment variable---it will be
expanded by the Distutils as it parses your command line options (just
***************
*** 668,671 ****
--- 704,708 ----
put these options into your Distutils config file (see
section~\ref{config-files}):
+
\begin{verbatim}
[install]
***************
*** 676,680 ****
--- 713,719 ----
install-data=python/data
\end{verbatim}
+
or, equivalently,
+
\begin{verbatim}
[install]
***************
*** 685,693 ****
--- 724,735 ----
install-data=data
\end{verbatim}
+
Note that these two are \emph{not} equivalent if you supply a different
installation base directory when you run the setup script. For example,
+
\begin{verbatim}
python setup.py --install-base=/tmp
\end{verbatim}
+
would install pure modules to \filevar{/tmp/python/lib} in the first
case, and to \filevar{/tmp/lib} in the second case. (For the second
***************
*** 798,801 ****
--- 840,844 ----
For example, the following is a complete config file that just forces
all commands to run quietly by default:
+
\begin{verbatim}
[global]
***************
*** 813,816 ****
--- 856,860 ----
\command{build*} commands always forcibly rebuild all files with the
following:
+
\begin{verbatim}
[build]
***************
*** 818,825 ****
--- 862,872 ----
force=1
\end{verbatim}
+
which corresponds to the command-line arguments
+
\begin{verbatim}
python setup.py build --build-base=blib --force
\end{verbatim}
+
except that including the \command{build} command on the command-line
means that command will be run. Including a particular command in
***************
*** 831,857 ****
You can find out the complete list of options for any command using the
\longprogramopt{help} option, e.g.:
\begin{verbatim}
python setup.py build --help
\end{verbatim}
and you can find out the complete list of global options by using
\longprogramopt{help} without a command:
\begin{verbatim}
python setup.py --help
\end{verbatim}
See also the ``Reference'' section of the ``Distributing Python
Modules'' manual.
-
- \section{Pre-Distutils Conventions}
- \label{pre-distutils}
- \subsection{The Makefile.pre.in file}
- \label{makefile-pre-in}
- \subsection{Installing modules manually}
- \label{manual-install}
--- 878,907 ----
You can find out the complete list of options for any command using the
\longprogramopt{help} option, e.g.:
+
\begin{verbatim}
python setup.py build --help
\end{verbatim}
+
and you can find out the complete list of global options by using
\longprogramopt{help} without a command:
+
\begin{verbatim}
python setup.py --help
\end{verbatim}
+
See also the ``Reference'' section of the ``Distributing Python
Modules'' manual.
+ %\section{Pre-Distutils Conventions}
+ %\label{pre-distutils}
+ %\subsection{The Makefile.pre.in file}
+ %\label{makefile-pre-in}
+ %\subsection{Installing modules manually}
+ %\label{manual-install}