1.. _reference: 2 3***************** 4Command Reference 5***************** 6 7.. % \section{Building modules: the \protect\command{build} command family} 8.. % \label{build-cmds} 9.. % \subsubsection{\protect\command{build}} 10.. % \label{build-cmd} 11.. % \subsubsection{\protect\command{build\_py}} 12.. % \label{build-py-cmd} 13.. % \subsubsection{\protect\command{build\_ext}} 14.. % \label{build-ext-cmd} 15.. % \subsubsection{\protect\command{build\_clib}} 16.. % \label{build-clib-cmd} 17 18 19.. _install-cmd: 20 21Installing modules: the :command:`install` command family 22========================================================= 23 24The install command ensures that the build commands have been run and then runs 25the subcommands :command:`install_lib`, :command:`install_data` and 26:command:`install_scripts`. 27 28.. % \subsubsection{\protect\command{install\_lib}} 29.. % \label{install-lib-cmd} 30 31 32.. _install-data-cmd: 33 34:command:`install_data` 35----------------------- 36 37This command installs all data files provided with the distribution. 38 39 40.. _install-scripts-cmd: 41 42:command:`install_scripts` 43-------------------------- 44 45This command installs all (Python) scripts in the distribution. 46 47.. % \subsection{Cleaning up: the \protect\command{clean} command} 48.. % \label{clean-cmd} 49 50 51.. _sdist-cmd: 52 53Creating a source distribution: the :command:`sdist` command 54============================================================ 55 56.. XXX fragment moved down from above: needs context! 57 58The manifest template commands are: 59 60+-------------------------------------------+-----------------------------------------------+ 61| Command | Description | 62+===========================================+===============================================+ 63| :command:`include pat1 pat2 ...` | include all files matching any of the listed | 64| | patterns | 65+-------------------------------------------+-----------------------------------------------+ 66| :command:`exclude pat1 pat2 ...` | exclude all files matching any of the listed | 67| | patterns | 68+-------------------------------------------+-----------------------------------------------+ 69| :command:`recursive-include dir pat1 pat2 | include all files under *dir* matching any of | 70| ...` | the listed patterns | 71+-------------------------------------------+-----------------------------------------------+ 72| :command:`recursive-exclude dir pat1 pat2 | exclude all files under *dir* matching any of | 73| ...` | the listed patterns | 74+-------------------------------------------+-----------------------------------------------+ 75| :command:`global-include pat1 pat2 ...` | include all files anywhere in the source tree | 76| | matching --- & any of the listed patterns | 77+-------------------------------------------+-----------------------------------------------+ 78| :command:`global-exclude pat1 pat2 ...` | exclude all files anywhere in the source tree | 79| | matching --- & any of the listed patterns | 80+-------------------------------------------+-----------------------------------------------+ 81| :command:`prune dir` | exclude all files under *dir* | 82+-------------------------------------------+-----------------------------------------------+ 83| :command:`graft dir` | include all files under *dir* | 84+-------------------------------------------+-----------------------------------------------+ 85 86The patterns here are Unix-style "glob" patterns: ``*`` matches any sequence of 87regular filename characters, ``?`` matches any single regular filename 88character, and ``[range]`` matches any of the characters in *range* (e.g., 89``a-z``, ``a-zA-Z``, ``a-f0-9_.``). The definition of "regular filename 90character" is platform-specific: on Unix it is anything except slash; on Windows 91anything except backslash or colon. 92 93.. XXX Windows support not there yet 94 95.. % \section{Creating a built distribution: the 96.. % \protect\command{bdist} command family} 97.. % \label{bdist-cmds} 98 99.. % \subsection{\protect\command{bdist}} 100.. % \subsection{\protect\command{bdist\_dumb}} 101.. % \subsection{\protect\command{bdist\_rpm}} 102.. % \subsection{\protect\command{bdist\_wininst}} 103 104 105