Command line options


shiboken [options] header-file typesystem-file



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


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 Parentship heuristics.


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


Enable heuristics to detect parent relationship on return values. For more info, check Return value heuristics.


Avoid the use of the ‘#define protected public’ hack.


If a class have an isNull() const method, it will be used to compute the value of boolean casts


Specify the supported api version used to generate the bindings.


Do not generate any code, just the documentation.


Semicolon separated list of type system entries (classes, namespaces, global functions and enums) to be dropped from generation.


Generator set to be used (e.g. qtdoc).


Skip deprecated functions.


Print a diff of wrapper files.


Dry run, do not generate wrapper files.


Text file containing a description of the binding project. Replaces and overrides command line arguments.

-I<path>, --include-paths=<path>[:<path>:...]

Include paths used by the C++ parser.

… _system-include-paths:

-isystem<path>, --system-include-paths=<path>[:<path>:...]

System include paths used by the C++ parser

-F<path>, --framework-include-paths=<path>[:<path>:...]

Framework include paths used by the C++ parser

--language-level=, -std=<level>

C++ Language level (c++11..c++17, default=c++14)

-T<path>, --typesystem-paths=<path>[:<path>:...]

Paths used when searching for type system files.


The directory where the generated files will be written.


File used for copyright headers of generated files.


Show all warnings.


Avoid printing any message.


Set the debug level.


Display this help and exit.


Output version information and exit.

QtDocGenerator Options


The documentation parser used to interpret the documentation input files (qdoc|doxygen).


Directory used to search code snippets used by the documentation.


Directory with XML files generated by documentation tool.


Directory used to search for extra documentation sections.


Directory where library source code is located.


List of additional XML files to be converted to .rst files (for example, tutorials).