OS Manuals

/usr/bin/g-ir-scanner

From gobject-introspection-bin 1.86.0-r4 (os), captured 2026-11-05 by running g-ir-scanner --help (exit 0). permalink

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)
OptionDescriptionSource
--versionshow program's version number and exithelp
-h, --helpshow this help message and exithelp + man
--quietIf passed, do not print details of normal operation.help + man
--format FORMATThis parameters decides which the resulting format will be used.help + man
-i, --include INCLUDESAdd the specified introspection dependency to the scanned namespace.help + man + man
--include-uninstalled INCLUDES_UNINSTALLEDAdd the specified introspection dependency to the scanned namespace.help + man
--add-include-path INCLUDE_PATHSAdd a directory to the path which the scanner uses to find GIR files.help + man
--program PROGRAMprogram to executehelp
--lib-dirs-envvar LIB_DIRS_ENVVARenvironment variable to write a list of library directories to (for running the transient binary), instead of standard LD_LIBRARY_PATHhelp
--program-arg PROGRAM_ARGSAdditional argument to pass to program for introspection.help + man
--libtool LIBTOOL_PATHFull path to libtool executable.help + man
--no-libtoolDisable usage of libtool for compiling stub introspection binary.help + man
--external-libraryIf true, the library is located on the system,not in the current directoryhelp
-l, --library LIBRARIESlibraries of this unithelp
--extra-library EXTRA_LIBRARIESExtra libraries to link the binary againsthelp
-L, --library-path LIBRARY_PATHSInclude this directory when searching for a library.help + man
--header-onlyIf specified, just generate a GIR for the given header fileshelp
-n, --namespace NAMESPACE_NAMEname of namespace for this unit, also used to compute --identifier-prefix and --symbol-prefixhelp + man
--nsversion NAMESPACE_VERSIONversion of namespace for this unithelp + man
--strip-prefix STRIP_PREFIXOption --strip-prefix is deprecated, please see --identifier-prefix andhelp
--identifier-prefix IDENTIFIER_PREFIXESRemove this prefix from C identifiers (structure typedefs, etc.).help + man
--identifier-filter-cmd IDENTIFIER_FILTER_CMDFilter 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_PREFIXESRemove this prefix from C symbols (function names)help + man
--symbol-filter-cmd SYMBOL_FILTER_CMDFilter 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-unprefixedIf specified, the scanner will accept identifiers and symbols which do not match the namespace prefix.help + man
--add-init-section INIT_SECTIONSadd extra initialization code in the introspection programhelp
-o, --output OUTPUToutput filename to write to, defaults to - (stdout)help + man
--pkg PACKAGESList of pkg-config packages to get compiler and linker flags from.help + man
--pkg-export PACKAGES_EXPORTList of pkg-config packages that are provided by the generated gir.help + man
--warn-allDisplay warnings for public API which is not introspectable.help + man
--warn-errorTurn warnings into fatal errorshelp + man
--strictIf true, enable strict warnings for introspectionhelp + man
-v, --verboseBe verbose, include some debugging information.help + man
--c-include C_INCLUDESHeaders which should be included in C programs.help + man
--filelist FILELISTfile containing headers and sources to be scannedhelp
--compiler COMPILERThe 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_FORMATname of the documentation format used in the project, should be one of gi- docgen, gtk-doc-docbook, gtk-doc-markdown or hotdochelp
--function-decoration FUNCTION_DECORATIONMacro to decorate functions in generated codehelp
--include-first-in-header INCLUDE_FIRST_HEADERHeader to include first in generated headerhelp
--include-last-in-header INCLUDE_LAST_HEADERHeader to include after the other headers in generated headerhelp
--include-first-in-src INCLUDE_FIRST_SRCHeader to include first in generated sourceshelp
--include-last-in-src INCLUDE_LAST_SRCHeader to include after the other headers in generated sourceshelp
--sources-top-dirs SOURCES_TOP_DIRSPaths to the sources directories used to determine relative files locations to be used in the gir file.help
--use-binary-wrapper WRAPPERwrapper to use for running programs (useful when cross-compiling)help
--binary-wrapper-args-beginStart additional binary wrapper argumentshelp
--binary-wrapper-args-endEnd additional binary wrapper argumentshelp
--use-ldd-wrapper LDD_WRAPPERwrapper to use instead of ldd (useful when cross-compiling)help
--ldd-wrapper-args-beginStart additional ldd wrapper argumentshelp
--ldd-wrapper-args-endEnd additional ldd wrapper argumentshelp
--cflags-beginStart preprocessor/compiler flagshelp
--cflags-endEnd preprocessor/compiler flagshelp
-I CPP_INCLUDESPre-processor include filehelp
-D CPP_DEFINESPre-processor definehelp
-U CPP_UNDEFINESPre-processor undefinehelp
-p PROGRAMSpecifies a binary that will be introspected.help + man
-IdirectoryInclude this directory in the list of directories to be searched for header files. (in the manual page but not in --help)man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.