diff options
Diffstat (limited to 'doc/commandlineoptions.rst')
-rw-r--r-- | doc/commandlineoptions.rst | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/doc/commandlineoptions.rst b/doc/commandlineoptions.rst new file mode 100644 index 000000000..0761982d4 --- /dev/null +++ b/doc/commandlineoptions.rst @@ -0,0 +1,76 @@ +.. _command-line: + +Command line options +******************** + +Usage +----- + +:: + + generator [options] header-file typesystem-file + + +Options +------- + +.. _api-version: + +``--api-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. + +.. _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. + |