commandlineoptions.rst.txt

.. _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`. .. _avoid-protected-hack: ``--avoid-protected-hack`` Avoid the use of the '#define protected public' hack. .. _use-isnull-as-nb_nonzero: ``--use-isnull-as-nb_nonzero`` If a class have an isNull() const method, it will be used to compute the value of boolean casts .. _api-version: ``--api-version=<version>`` Specify the supported api version used to generate the bindings. .. _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). .. _skip-deprecated: ``--skip-deprecated`` Skip deprecated functions. .. _diff: ``--diff`` Print a diff of wrapper files. .. _dryrun: ``--dryrun`` Dry run, do not generate wrapper files. .. _--project-file: ``--project-file=<file>`` Text file containing a description of the binding project. Replaces and overrides command line arguments. .. _include-paths: ``-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 .. _framework-include-paths: ``-F<path>, --framework-include-paths=<path>[:<path>:...]`` Framework include paths used by the C++ parser .. _language-level: ``--language-level=, -std=<level>`` C++ Language level (c++11..c++17, default=c++14) .. _typesystem-paths: ``-T<path>, --typesystem-paths=<path>[:<path>:...]`` Paths used when searching for type system files. .. _output-directory: ``--output-directory=[dir]`` The directory where the generated files will be written. .. _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. .. _silent: ``--silent`` Avoid printing any message. .. _debug-level: ``--debug-level=[sparse|medium|full]`` Set the debug level. .. _help: ``--help`` Display this help and exit. .. _version: ``--version`` Output version information and exit. QtDocGenerator Options ---------------------- .. _doc-parser: ``--doc-parser=<parser>`` The documentation parser used to interpret the documentation input files (qdoc|doxygen). .. _documentation-code-snippets-dir: ``--documentation-code-snippets-dir=<dir>`` Directory used to search code snippets used by the documentation. .. _documentation-data-dir: ``--documentation-data-dir=<dir>`` Directory with XML files generated by documentation tool. .. _documentation-extra-sections-dir=<dir>: ``--documentation-extra-sections-dir=<dir>`` Directory used to search for extra documentation sections. .. _library-source-dir: ``--library-source-dir=<dir>`` Directory where library source code is located. .. _additional-documentation: ``--additional-documentation=<file>`` List of additional XML files to be converted to .rst files (for example, tutorials).