OS Manuals

/usr/bin/gtkdoc-scan

Documentation tool for public library API

From gtk-doc 1.37.0-r0 (os), captured 2026-11-05 by running gtkdoc-scan --help (exit 0). permalink

usage: gtkdoc-scan [-h] [--version] --module MODULE [--source-dir SOURCE_DIR]
                   [--ignore-headers IGNORE_HEADERS] [--output-dir OUTPUT_DIR]
                   [--deprecated-guards DEPRECATED_GUARDS] [--ignore-decorators IGNORE_DECORATORS]
                   [--rebuild-sections] [--rebuild-types]
                   [headers ...]

gtkdoc-scan version 1.37.0 - scan header files for public symbols

positional arguments:
  headers

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --module MODULE       Name of the doc module being processed.
  --source-dir SOURCE_DIR
                        Directories containing the source files to scan
  --ignore-headers IGNORE_HEADERS
                        A space-separated list of header files/dirs not to scan
  --output-dir OUTPUT_DIR
                        The directory where the results are stored
  --deprecated-guards DEPRECATED_GUARDS
                        A |-separated list of symbols used as deprecation guards
  --ignore-decorators IGNORE_DECORATORS
                        A |-separated list of additional decorators indeclarations that should be
                        ignored
  --rebuild-sections    Rebuild (overwrite) the MODULE-sections.txt file
  --rebuild-types       Automatically recreate the MODULE.types file usingall the *_get_type()
                        functions found
Options (10)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--versionshow program's version number and exithelp
--module MODULEName of the doc module being processed.help
--source-dir SOURCE_DIRDirectories containing the source files to scanhelp
--ignore-headers IGNORE_HEADERSA space-separated list of header files/dirs not to scanhelp
--output-dir OUTPUT_DIRThe directory where the results are storedhelp
--deprecated-guards DEPRECATED_GUARDSA |-separated list of symbols used as deprecation guardshelp
--ignore-decorators IGNORE_DECORATORSA |-separated list of additional decorators indeclarations that should be ignoredhelp
--rebuild-sectionsRebuild (overwrite) the MODULE-sections.txt filehelp
--rebuild-typesAutomatically recreate the MODULE.types file usingall the *_get_type() functions foundhelp

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