Commits

Thomas Kluyver  committed 81c8fac

Improve documentation of distutils command arguments

  • Participants
  • Parent commits 95cddf3
  • Branches docs-review

Comments (0)

Files changed (1)

File doc/distutils.rst

 
 On Mac OS X, you can use ``bdist_dmg`` to build a Mac disk image.
 
+
+
+distutils commands
+------------------
+
 cx_Freeze creates four new commands and subclasses four others in order to
 provide the ability to both build and install executables. In typical distutils
 fashion they can be provided in the setup script, on the command line or in
 a ``setup.cfg`` configuration file. They are described in further detail below.
 
-distutils commands
-------------------
+To specify options in the script, use underscores in the name instead of dashes.
+For example::
+
+    setup(...
+          options = {'build_exe': {'init_script':'Console'}} )
 
 build
 `````
 +-----------------------+-----------------------------------------------------+
 | option name           | description                                         |
 +=======================+=====================================================+
-| build-exe (-b)        | directory for built executables and dependent files |
+| build-exe (-b)        | directory for built executables and dependent files,|
+|                       | defaults to ``build/``                              |
 +-----------------------+-----------------------------------------------------+
 
 build_exe
 +-----------------------+-----------------------------------------------------+
 | option name           | description                                         |
 +=======================+=====================================================+
-| build-exe (-b)        | directory for built executables and dependent files |
+| build-exe (-b)        | directory for built executables and dependent files,|
+|                       | defaults to ``build/``                              |
 +-----------------------+-----------------------------------------------------+
 | optimize (-o)         | optimization level, one of 0 (disabled), 1 or 2     |
 +-----------------------+-----------------------------------------------------+