summaryrefslogtreecommitdiffstats
path: root/doc/commandlineoptions.rst
diff options
context:
space:
mode:
authorHugo Parente Lima <hugo.pl@gmail.com>2012-02-23 20:35:14 -0200
committerHugo Parente Lima <hugo.pl@gmail.com>2012-02-23 20:35:14 -0200
commitfde271521a750b7d5936435f8fcac4b86c8540f1 (patch)
treeca72de13df2cb2a979419c57ebc7b733cc36fcaf /doc/commandlineoptions.rst
parent2c198ea403aa6c374bc062f85ac95b61acbb87ae (diff)
parentbbb7d417e75043dec53c84ceafec5c07cc282a81 (diff)
downloadshiboken-master.tar.gz
shiboken-master.tar.xz
shiboken-master.zip
Merge GeneratorRunner project into Shiboken.HEADmaster
This initial merge introduces few regression that can easily be fixed, they are: - You can't choose what generator will be run, it always run CppGenerator and HeaderGenerator. - DummyGenerator test of GeneratorRunner was commented out. The directory structure is also nto ideal and may change a bit in later commits. Conflicts: CMakeLists.txt data/CMakeLists.txt doc/CMakeLists.txt doc/_templates/index.html doc/_templates/layout.html doc/_themes/pysidedocs/static/pysidedocs.css doc/commandlineoptions.rst doc/conf.py.in doc/contents.rst doc/images/bindinggen-development.png doc/images/boostqtarch.png tests/CMakeLists.txt
Diffstat (limited to 'doc/commandlineoptions.rst')
-rw-r--r--doc/commandlineoptions.rst70
1 files changed, 69 insertions, 1 deletions
diff --git a/doc/commandlineoptions.rst b/doc/commandlineoptions.rst
index 2dacfc13..d373561c 100644
--- a/doc/commandlineoptions.rst
+++ b/doc/commandlineoptions.rst
@@ -1,3 +1,5 @@
+.. _command-line:
+
Command line options
********************
@@ -6,7 +8,7 @@ Usage
::
- shiboken [options]
+ shiboken [options] header-file typesystem-file
Options
@@ -35,3 +37,69 @@ Options
Enable heuristics to detect parent relationship on return values.
For more info, check :ref:`return-value-heuristics`.
+.. _api-version:
+
+``--api-version=<version>``
+ Specify the supported api version used to generate the bindings.
+
+.. _debug-level:
+
+``--debug-level=[sparse|medium|full]``
+ Set the debug level.
+
+.. _documentation-only:
+
+``--documentation-only``
+ Do not generate any code, just the documentation.
+
+.. _drop-type-entries:
+
+``--drop-type-entries="<TypeEntry0>[;TypeEntry1;...]"``
+ Semicolon separated list of type system entries (classes, namespaces,
+ global functions and enums) to be dropped from generation.
+
+.. _generation-set:
+
+``--generation-set``
+ Generator set to be used (e.g. qtdoc).
+
+.. _help:
+
+``--help``
+ Display this help and exit.
+
+.. _include-paths:
+
+``--include-paths=<path>[:<path>:...]``
+ Include paths used by the C++ parser.
+
+.. _license-file=[license-file]:
+
+``--license-file=[license-file]``
+ File used for copyright headers of generated files.
+
+.. _no-suppress-warnings:
+
+``--no-suppress-warnings``
+ Show all warnings.
+
+.. _output-directory:
+
+``--output-directory=[dir]``
+ The directory where the generated files will be written.
+
+.. _silent:
+
+``--silent``
+ Avoid printing any message.
+
+.. _typesystem-paths:
+
+``--typesystem-paths=<path>[:<path>:...]``
+ Paths used when searching for type system files.
+
+.. _version:
+
+``--version``
+ Output version information and exit.
+