Commits

Thomas Kluyver  committed d7cc207

Document bdist_mac and bdist_dmg.

  • Participants
  • Parent commits b52935c
  • Branches releasenotes

Comments (0)

Files changed (2)

File doc/distutils.rst

 
     python setup.py bdist_msi
 
-cx_Freeze creates two new commands and subclasses four others in order to
+On Mac OS X, you can use ``bdist_dmg`` to build a Mac disk image.
+
+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.
 The standard command assumes that the package should be architecture
 independent if it cannot find any extension modules.
 
+bdist_mac
+`````````
+
+This command is available on Mac OS X systems, to create a Mac application
+bundle (a .app directory).
+
++-----------------------+-----------------------------------------------------+
+| option name           | description                                         |
++=======================+=====================================================+
+| bundle-iconfile       | Name of the application bundle icon file as stored  |
+|                       | in the Info.plist file.                             |
++-----------------------+-----------------------------------------------------+
+
+ .. versionadded:: 4.3
+
+bdist_dmg
+`````````
+
+This command is available on Mac OS X systems; it creates an application bundle,
+then packages it into a DMG disk image suitable for distribution and
+installation.
+
++-----------------------+-----------------------------------------------------+
+| option name           | description                                         |
++=======================+=====================================================+
+| volume-label          | Volume label of the DMG disk image                  |
++-----------------------+-----------------------------------------------------+
+
+ .. versionadded:: 4.3
+
 cx_Freeze.Executable
 --------------------
 

File doc/overview.rst

 
 cx_Freeze normally produces a folder containing an executable file for your
 program, along with the shared libraries (DLLs or .so files) needed to run it.
-To make a simple Windows installer, use a :ref:`setup script <distutils>` with
-the ``bdist_msi`` option. For a more advanced installer, use a separate tool
-like `Inno Setup <http://www.jrsoftware.org/isinfo.php>`_ to package the files
-cx_Freeze collects.
+You can make a simple Windows installer using a :ref:`setup script <distutils>`
+with the ``bdist_msi`` option, or a Mac disk image with ``bdist_dmg``. For a
+more advanced Windows installer, use a separate tool like `Inno Setup
+<http://www.jrsoftware.org/isinfo.php>`_ to package the files cx_Freeze collects.
 
 Using data files
 ----------------