OS Manuals

/usr/bin/gtkdoc-mkdb

Documentation tool for public library API

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

usage: gtkdoc-mkdb [-h] [--version] --module MODULE [--source-dir SOURCE_DIR]
                   [--source-suffixes SOURCE_SUFFIXES] [--ignore-files IGNORE_FILES]
                   [--output-dir OUTPUT_DIR] [--tmpl-dir TMPL_DIR]
                   [--main-sgml-file MAIN_SGML_FILE] [--expand-content-files EXPAND_CONTENT_FILES]
                   [--sgml-mode | --xml-mode] [--default-stability {,Stable,Private,Unstable}]
                   [--default-includes DEFAULT_INCLUDES] [--output-format OUTPUT_FORMAT]
                   [--name-space NAME_SPACE] [--outputallsymbols] [--outputsymbolswithoutsince]

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 parsed
  --source-dir SOURCE_DIR
  --source-suffixes SOURCE_SUFFIXES
  --ignore-files IGNORE_FILES
  --output-dir OUTPUT_DIR
  --tmpl-dir TMPL_DIR   DEPRECATED
  --main-sgml-file MAIN_SGML_FILE
  --expand-content-files EXPAND_CONTENT_FILES
  --sgml-mode
  --xml-mode
  --default-stability {,Stable,Private,Unstable}
  --default-includes DEFAULT_INCLUDES
  --output-format OUTPUT_FORMAT
  --name-space NAME_SPACE
  --outputallsymbols
  --outputsymbolswithoutsince
Options (18)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--versionshow program's version number and exithelp
--module MODULEName of the doc module being parsedhelp
--source-dir SOURCE_DIRhelp
--source-suffixes SOURCE_SUFFIXEShelp
--ignore-files IGNORE_FILEShelp
--output-dir OUTPUT_DIRhelp
--tmpl-dir TMPL_DIRDEPRECATEDhelp
--main-sgml-file MAIN_SGML_FILEhelp
--expand-content-files EXPAND_CONTENT_FILEShelp
--sgml-modehelp
--xml-modehelp
--default-stabilityhelp
--default-includes DEFAULT_INCLUDEShelp
--output-format OUTPUT_FORMAThelp
--name-space NAME_SPACEhelp
--outputallsymbolshelp
--outputsymbolswithoutsincehelp

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