/Doc/distutils/commandref.rst

http://unladen-swallow.googlecode.com/ · ReStructuredText · 104 lines · 76 code · 28 blank · 0 comment · 0 complexity · f5e59f389970a91c761d56e8a31227fe MD5 · raw file

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