Usage: g-ir-scanner [options] sources
Options:
--version show program's version number and exit
-h, --help show this help message and exit
--quiet If passed, do not print details of normal operation
--format=FORMAT format to use, one of gidl, gir
-i INCLUDES, --include=INCLUDES
Add specified gir file as dependency
--include-uninstalled=INCLUDES_UNINSTALLED
A file path to a dependency; only use this "
"when building multiple .gir files inside a "
"single module.
--add-include-path=INCLUDE_PATHS
include paths for other GIR files
--program=PROGRAM program to execute
--lib-dirs-envvar=LIB_DIRS_ENVVAR
environment variable to write a list of library directories to (for
running the transient binary), instead of standard LD_LIBRARY_PATH
--program-arg=PROGRAM_ARGS
extra arguments to program
--libtool=LIBTOOL_PATH
full path to libtool
--no-libtool do not use libtool
--external-library If true, the library is located on the system,not in the current directory
-l LIBRARIES, --library=LIBRARIES
libraries of this unit
--extra-library=EXTRA_LIBRARIES
Extra libraries to link the binary against
-L LIBRARY_PATHS, --library-path=LIBRARY_PATHS
directories to search for libraries
--header-only If specified, just generate a GIR for the given header files
-n NAMESPACE_NAME, --namespace=NAMESPACE_NAME
name of namespace for this unit, also used to compute --identifier-prefix
and --symbol-prefix
--nsversion=NAMESPACE_VERSION
version of namespace for this unit
--strip-prefix=STRIP_PREFIX
Option --strip-prefix is deprecated, please see --identifier-prefix and
--symbol-prefix.
--identifier-prefix=IDENTIFIER_PREFIXES
Remove this prefix from C identifiers (structure typedefs, etc.). May be
specified multiple times. This is also used as the default for --symbol-
prefix if the latter is not specified.
--identifier-filter-cmd=IDENTIFIER_FILTER_CMD
Filter identifiers (struct and union typedefs) through the given shell
command which will receive the identifier name as input to stdin and is
expected to output the filtered results to stdout.
--symbol-prefix=SYMBOL_PREFIXES
Remove this prefix from C symbols (function names)
--symbol-filter-cmd=SYMBOL_FILTER_CMD
Filter symbols (function names) through the given shell command which will
receive the symbol name as input to stdin and is expected to output the
filtered results to stdout.
--accept-unprefixed If specified, accept symbols and identifiers that do not match the
namespace prefix.
--add-init-section=INIT_SECTIONS
add extra initialization code in the introspection program
-o OUTPUT, --output=OUTPUT
output filename to write to, defaults to - (stdout)
--pkg=PACKAGES pkg-config packages to get cflags from
--pkg-export=PACKAGES_EXPORT
Associated pkg-config packages for this library
--warn-all If true, enable all warnings for introspection
--warn-error Turn warnings into fatal errors
--strict If true, enable strict warnings for introspection
-v, --verbose be verbose
--c-include=C_INCLUDES
headers which should be included in C programs
--filelist=FILELIST file containing headers and sources to be scanned
--compiler=COMPILER the C compiler to use internally
--doc-format=DOC_FORMAT
name of the documentation format used in the project, should be one of gi-
docgen, gtk-doc-docbook, gtk-doc-markdown or hotdoc
--function-decoration=FUNCTION_DECORATION
Macro to decorate functions in generated code
--include-first-in-header=INCLUDE_FIRST_HEADER
Header to include first in generated header
--include-last-in-header=INCLUDE_LAST_HEADER
Header to include after the other headers in generated header
--include-first-in-src=INCLUDE_FIRST_SRC
Header to include first in generated sources
--include-last-in-src=INCLUDE_LAST_SRC
Header to include after the other headers in generated sources
--sources-top-dirs=SOURCES_TOP_DIRS
Paths to the sources directories used to determine relative files
locations to be used in the gir file. This is especially useful when build
dir and source dir are different and mirrored.
Cross compilation options:
--use-binary-wrapper=WRAPPER
wrapper to use for running programs (useful when cross-compiling)
--binary-wrapper-args-begin
Start additional binary wrapper arguments
--binary-wrapper-args-end
End additional binary wrapper arguments
--use-ldd-wrapper=LDD_WRAPPER
wrapper to use instead of ldd (useful when cross-compiling)
--ldd-wrapper-args-begin
Start additional ldd wrapper arguments
--ldd-wrapper-args-end
End additional ldd wrapper arguments
Preprocessor options:
--cflags-begin Start preprocessor/compiler flags
--cflags-end End preprocessor/compiler flags
-I CPP_INCLUDES Pre-processor include file
-D CPP_DEFINES Pre-processor define
-U CPP_UNDEFINES Pre-processor undefine
-p Ignored
Options (56)
| Option | Description | Source |
|---|---|---|
--version | show program's version number and exit | help |
-h, --help | show this help message and exit | help + man |
--quiet | If passed, do not print details of normal operation. | help + man |
--format FORMAT | This parameters decides which the resulting format will be used. | help + man |
-i, --include INCLUDES | Add the specified introspection dependency to the scanned namespace. | help + man + man |
--include-uninstalled INCLUDES_UNINSTALLED | Add the specified introspection dependency to the scanned namespace. | help + man |
--add-include-path INCLUDE_PATHS | Add a directory to the path which the scanner uses to find GIR files. | help + man |
--program PROGRAM | program to execute | help |
--lib-dirs-envvar LIB_DIRS_ENVVAR | environment variable to write a list of library directories to (for running the transient binary), instead of standard LD_LIBRARY_PATH | help |
--program-arg PROGRAM_ARGS | Additional argument to pass to program for introspection. | help + man |
--libtool LIBTOOL_PATH | Full path to libtool executable. | help + man |
--no-libtool | Disable usage of libtool for compiling stub introspection binary. | help + man |
--external-library | If true, the library is located on the system,not in the current directory | help |
-l, --library LIBRARIES | libraries of this unit | help |
--extra-library EXTRA_LIBRARIES | Extra libraries to link the binary against | help |
-L, --library-path LIBRARY_PATHS | Include this directory when searching for a library. | help + man |
--header-only | If specified, just generate a GIR for the given header files | help |
-n, --namespace NAMESPACE_NAME | name of namespace for this unit, also used to compute --identifier-prefix and --symbol-prefix | help + man |
--nsversion NAMESPACE_VERSION | version of namespace for this unit | help + man |
--strip-prefix STRIP_PREFIX | Option --strip-prefix is deprecated, please see --identifier-prefix and | help |
--identifier-prefix IDENTIFIER_PREFIXES | Remove this prefix from C identifiers (structure typedefs, etc.). | help + man |
--identifier-filter-cmd IDENTIFIER_FILTER_CMD | Filter identifiers (struct and union typedefs) through the given shell command which will receive the identifier name as input to stdin and is expected to output the filtered results to stdout. | help |
--symbol-prefix SYMBOL_PREFIXES | Remove this prefix from C symbols (function names) | help + man |
--symbol-filter-cmd SYMBOL_FILTER_CMD | Filter symbols (function names) through the given shell command which will receive the symbol name as input to stdin and is expected to output the filtered results to stdout. | help |
--accept-unprefixed | If specified, the scanner will accept identifiers and symbols which do not match the namespace prefix. | help + man |
--add-init-section INIT_SECTIONS | add extra initialization code in the introspection program | help |
-o, --output OUTPUT | output filename to write to, defaults to - (stdout) | help + man |
--pkg PACKAGES | List of pkg-config packages to get compiler and linker flags from. | help + man |
--pkg-export PACKAGES_EXPORT | List of pkg-config packages that are provided by the generated gir. | help + man |
--warn-all | Display warnings for public API which is not introspectable. | help + man |
--warn-error | Turn warnings into fatal errors | help + man |
--strict | If true, enable strict warnings for introspection | help + man |
-v, --verbose | Be verbose, include some debugging information. | help + man |
--c-include C_INCLUDES | Headers which should be included in C programs. | help + man |
--filelist FILELIST | file containing headers and sources to be scanned | help |
--compiler COMPILER | The C compiler to be used internally by g-ir-scanner when introspecting the run time type information, like properties, signals, ancestors, and implemented interfaces. | help + man |
--doc-format DOC_FORMAT | name of the documentation format used in the project, should be one of gi- docgen, gtk-doc-docbook, gtk-doc-markdown or hotdoc | help |
--function-decoration FUNCTION_DECORATION | Macro to decorate functions in generated code | help |
--include-first-in-header INCLUDE_FIRST_HEADER | Header to include first in generated header | help |
--include-last-in-header INCLUDE_LAST_HEADER | Header to include after the other headers in generated header | help |
--include-first-in-src INCLUDE_FIRST_SRC | Header to include first in generated sources | help |
--include-last-in-src INCLUDE_LAST_SRC | Header to include after the other headers in generated sources | help |
--sources-top-dirs SOURCES_TOP_DIRS | Paths to the sources directories used to determine relative files locations to be used in the gir file. | help |
--use-binary-wrapper WRAPPER | wrapper to use for running programs (useful when cross-compiling) | help |
--binary-wrapper-args-begin | Start additional binary wrapper arguments | help |
--binary-wrapper-args-end | End additional binary wrapper arguments | help |
--use-ldd-wrapper LDD_WRAPPER | wrapper to use instead of ldd (useful when cross-compiling) | help |
--ldd-wrapper-args-begin | Start additional ldd wrapper arguments | help |
--ldd-wrapper-args-end | End additional ldd wrapper arguments | help |
--cflags-begin | Start preprocessor/compiler flags | help |
--cflags-end | End preprocessor/compiler flags | help |
-I CPP_INCLUDES | Pre-processor include file | help |
-D CPP_DEFINES | Pre-processor define | help |
-U CPP_UNDEFINES | Pre-processor undefine | help |
-p PROGRAM | Specifies a binary that will be introspected. | help + man |
-Idirectory | Include this directory in the list of directories to be searched for header files. (in the manual page but not in --help) | man |