aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/doc/commandlineoptions.rst
blob: d373561cd6d274998b6ae61b1cdaae18105ca72f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.. _command-line:

Command line options
********************

Usage
-----

::

   shiboken [options] header-file typesystem-file


Options
-------

``--disable-verbose-error-messages``
    Disable verbose error messages. Turn the CPython code hard to debug but saves a few kilobytes
    in the generated binding.

.. _parent-heuristic:

``--enable-parent-ctor-heuristic``
    This flag enable an useful heuristic which can save a lot of work related to object ownership when
    writing the typesystem.
    For more info, check :ref:`ownership-parent-heuristics`.

.. _pyside-extensions:

``--enable-pyside-extensions``
    Enable pyside extensions like support for signal/slots. Use this if you are creating a binding based
    on PySide.

.. _return-heuristic:

``--enable-return-value-heuristic``
    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.