Mercurial > cpython-lru_cache-weakref

annotate Doc/distutils/commandref.rst @ 70817:dd775b1561ba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix markup.
author Georg Brandl <georg@python.org>
date Tue, 14 Jun 2011 21:09:55 +0200
parents 790353becf8c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
1 .. _reference:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
2
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
3 *****************
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
4 Command Reference
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
5 *****************
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
6
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
7 .. % \section{Building modules: the \protect\command{build} command family}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
8 .. % \label{build-cmds}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
9 .. % \subsubsection{\protect\command{build}}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
10 .. % \label{build-cmd}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
11 .. % \subsubsection{\protect\command{build\_py}}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
12 .. % \label{build-py-cmd}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
13 .. % \subsubsection{\protect\command{build\_ext}}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
14 .. % \label{build-ext-cmd}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
15 .. % \subsubsection{\protect\command{build\_clib}}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
16 .. % \label{build-clib-cmd}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
17
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
18
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
19 .. _install-cmd:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
20
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
21 Installing modules: the :command:`install` command family
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
22 =========================================================
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
23
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
24 The install command ensures that the build commands have been run and then runs
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
25 the subcommands :command:`install_lib`, :command:`install_data` and
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
26 :command:`install_scripts`.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
27
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
28 .. % \subsubsection{\protect\command{install\_lib}}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
29 .. % \label{install-lib-cmd}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
30
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
31
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
32 .. _install-data-cmd:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
33
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
34 :command:`install_data`
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
35 -----------------------
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
36
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
37 This command installs all data files provided with the distribution.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
38
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
39
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
40 .. _install-scripts-cmd:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
41
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
42 :command:`install_scripts`
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
43 --------------------------
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
44
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
45 This command installs all (Python) scripts in the distribution.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
46
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
47 .. % \subsection{Cleaning up: the \protect\command{clean} command}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
48 .. % \label{clean-cmd}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
49
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
50
63350
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
51 .. _sdist-cmd:
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
52
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
53 Creating a source distribution: the :command:`sdist` command
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
54 ============================================================
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
55
63351
790353becf8c After distutils doc reversal, change back **bold todo** items to XXX comments.
Georg Brandl <georg@python.org>
parents: 63350
diff changeset
56 .. XXX fragment moved down from above: needs context!
63350
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
57
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
58 The manifest template commands are:
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
59
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
60 +-------------------------------------------+-----------------------------------------------+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
61 | Command | Description |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
62 +===========================================+===============================================+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
63 | :command:`include pat1 pat2 ...` | include all files matching any of the listed |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
64 | | patterns |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
65 +-------------------------------------------+-----------------------------------------------+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
66 | :command:`exclude pat1 pat2 ...` | exclude all files matching any of the listed |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
67 | | patterns |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
68 +-------------------------------------------+-----------------------------------------------+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
69 | :command:`recursive-include dir pat1 pat2 | include all files under *dir* matching any of |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
70 | ...` | the listed patterns |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
71 +-------------------------------------------+-----------------------------------------------+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
72 | :command:`recursive-exclude dir pat1 pat2 | exclude all files under *dir* matching any of |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
73 | ...` | the listed patterns |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
74 +-------------------------------------------+-----------------------------------------------+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
75 | :command:`global-include pat1 pat2 ...` | include all files anywhere in the source tree |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
76 | | matching --- & any of the listed patterns |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
77 +-------------------------------------------+-----------------------------------------------+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
78 | :command:`global-exclude pat1 pat2 ...` | exclude all files anywhere in the source tree |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
79 | | matching --- & any of the listed patterns |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
80 +-------------------------------------------+-----------------------------------------------+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
81 | :command:`prune dir` | exclude all files under *dir* |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
82 +-------------------------------------------+-----------------------------------------------+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
83 | :command:`graft dir` | include all files under *dir* |
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
84 +-------------------------------------------+-----------------------------------------------+
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
85
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
86 The patterns here are Unix-style "glob" patterns: ``*`` matches any sequence of
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
87 regular filename characters, ``?`` matches any single regular filename
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
88 character, and ``[range]`` matches any of the characters in *range* (e.g.,
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
89 ``a-z``, ``a-zA-Z``, ``a-f0-9_.``). The definition of "regular filename
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
90 character" is platform-specific: on Unix it is anything except slash; on Windows
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
91 anything except backslash or colon.
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
92
63351
790353becf8c After distutils doc reversal, change back **bold todo** items to XXX comments.
Georg Brandl <georg@python.org>
parents: 63350
diff changeset
93 .. XXX Windows support not there yet
63350
f574a071886d reverted distutils doc to its 3.1 state
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 57726
diff changeset
94
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
95 .. % \section{Creating a built distribution: the
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
96 .. % \protect\command{bdist} command family}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
97 .. % \label{bdist-cmds}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
98
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
99 .. % \subsection{\protect\command{bdist}}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
100 .. % \subsection{\protect\command{bdist\_dumb}}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
101 .. % \subsection{\protect\command{bdist\_rpm}}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
102 .. % \subsection{\protect\command{bdist\_wininst}}
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
103
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
104