Commits

Thomas Kluyver committed 95cddf3

Convert docs for cxfreeze script to use Sphinx option directives

Comments (0)

Files changed (1)

 
 Further customization can be done using the following options:
 
-+-----------------------+-----------------------------------------------------+
-| option name           | description                                         |
-+=======================+=====================================================+
-| --version             | show version number and exit                        |
-+-----------------------+-----------------------------------------------------+
-| -h, --help            | show this help message and exit                     |
-+-----------------------+-----------------------------------------------------+
-| -O                    | optimize generated bytecode as per PYTHONOPTIMIZE;  |
-|                       | use -OO in order to remove doc strings              |
-+-----------------------+-----------------------------------------------------+
-| -c, --compress        | compress byte code in zip files                     |
-+-----------------------+-----------------------------------------------------+
-| -s, --silent          | suppress all output except warnings                 |
-+-----------------------+-----------------------------------------------------+
-| --base-name           | file on which to base the executable; if the name   |
-|                       | of the file is not an absolute file name, the       |
-|                       | subdirectory bases inside the cx_Freeze package     |
-|                       | will be searched for a file matching the name,      |
-|                       | without regard to the extension                     |
-+-----------------------+-----------------------------------------------------+
-| --init-script         | script which will be executed upon startup; if the  |
-|                       | name of the file is not an absolute file name, the  |
-|                       | subdirectory initscripts inside the cx_Freeze       |
-|                       | package will be searched for a file matching the    |
-|                       | name, without regard to the extension               |
-+-----------------------+-----------------------------------------------------+
-| --target-dir          | directory in which to place the executable and any  |
-|                       | dependent files                                     |
-+-----------------------+-----------------------------------------------------+
-| --target-name         | the name of the file to create; the default is the  |
-|                       | base name of the script and the extension of the    |
-|                       | base executable name                                |
-+-----------------------+-----------------------------------------------------+
-| --shared-name         | the name of the file to create; the default is the  |
-|                       | base name of the script and the extension of the    |
-|                       | base executable name                                |
-+-----------------------+-----------------------------------------------------+
-| --no-copy-deps        | do not copy any dependent files (extensions, shared |
-|                       | libraries, etc.) to the target directory; this also |
-|                       | modifies the default init script to ConsoleKeepPath |
-|                       | and means that the target executable requires a     |
-|                       | Python installation to execute properly             |
-+-----------------------+-----------------------------------------------------+
-| --default-path        | list of paths separated by the standard path        |
-|                       | separator for the platform which will be used to    |
-|                       | initialize the search path instead of sys.path      |
-+-----------------------+-----------------------------------------------------+
-| --include-path        | list of paths separated by the standard path        |
-|                       | separator for the platform which will be used to    |
-|                       | add to the search path                              |
-+-----------------------+-----------------------------------------------------+
-| --replace-paths       | replace all the paths in modules found in the given |
-|                       | paths with the given replacement string; multiple   |
-|                       | values are separated by the standard path separator |
-|                       | for the platform and each value is of the form      |
-|                       | <search>=<replace>; <search> can be * which means   |
-|                       | all paths not already specified                     |
-+-----------------------+-----------------------------------------------------+
-| --include-modules     | comma separated list of names of modules to include |
-+-----------------------+-----------------------------------------------------+
-| --exclude-modules     | comma separated list of names of modules to exclude |
-+-----------------------+-----------------------------------------------------+
-| --ext-list-file       | name of file in which to place the list of          |
-|                       | dependent files which were copied to the target     |
-|                       | directory                                           |
-+-----------------------+-----------------------------------------------------+
-| -z, --zip-include     | name of file to add to the zip file or a            |
-|                       | specification of the form <name>=<arcname> which    |
-|                       | will specify the archive name to use; multiple      |
-|                       | --zip-include arguments can be used                 |
-+-----------------------+-----------------------------------------------------+
+.. option:: --version
+
+   show version number and exit
+
+.. option:: -h, --help
+
+   show this help message and exit
+
+
+.. option:: -O
+
+    optimize generated bytecode as per PYTHONOPTIMIZE; use -OO in order to
+    remove doc strings
+
+.. option:: -c, --compress
+
+    compress byte code in zip files
+
+.. option:: -s, --silent
+
+    suppress all output except warnings and errors
+
+.. option:: --base-name=NAME
+
+    file on which to base the target file; if the name of
+    the file is not an absolute file name, the
+    subdirectory bases (rooted in the directory in which
+    the freezer is found) will be searched for a file
+    matching the name
+
+.. option:: --init-script=NAME
+
+    script which will be executed upon startup; if the
+    name of the file is not an absolute file name, the
+    subdirectory initscripts (rooted in the directory in
+    which the cx_Freeze package is found) will be searched
+    for a file matching the name
+
+.. option:: --target-dir=DIR, --install-dir=DIR
+
+    The directory in which to place the target file and any dependent files
+
+.. option:: --target-name=NAME
+
+    the name of the file to create instead of the base
+    name of the script and the extension of the base binary
+
+.. option:: --no-copy-deps
+
+    do not copy the dependent files (extensions, shared
+    libraries, etc.) to the target directory; this also
+    modifies the default init script to ConsoleKeepPath.py
+    and means that the target executable requires a Python
+    installation to execute properly
+
+.. option:: --default-path=DIRS
+
+   list of paths separated by the standard path separator
+   for the platform which will be used to initialize
+   sys.path prior to running the module finder
+
+.. option:: --include-path=DIRS
+
+    list of paths separated by the standard path separator
+    for the platform which will be used to modify sys.path
+    prior to running the module finder
+
+.. option:: --replace-paths=DIRECTIVES
+
+    replace all the paths in modules found in the given
+    paths with the given replacement string; multiple
+    values are separated by the standard path separator
+    and each value is of the form path=replacement_string;
+    path can be * which means all paths not already
+    specified
+
+.. option:: --include-modules=NAMES
+
+    comma separated list of modules to include
+
+.. option:: --exclude-modules=NAMES
+
+    comma separated list of modules to exclude
+
+.. option:: --ext-list-file=NAME
+
+    name of file in which to place the list of dependent
+    files which were copied into the target directory
+
+.. option:: -z SPEC, --zip-include=SPEC
+
+    name of file to add to the zip file or a specification
+    of the form name=arcname which will specify the
+    archive name to use; multiple --zip-include arguments
+    can be used
+
+.. option:: --icon=ICON
+
+   name of the icon file for the application