usage: gi-docgen [-h] {help,index,generate,gen-index,gen-deps,search,check,serve} ...
options:
-h, --help show this help message and exit
Commands:
If no command is specified, default to help
{help,index,generate,gen-index,gen-deps,search,check,serve}
help Show the help for gi-docgen or a sub-command
index Generates an index of all the symbols
generate Generates the reference
gen-index Generates the symbol indices for search
gen-deps Generates the build dependencies
search Search terms in the symbol indices
check Checks introspection data for valid documentation
serve Serve the gi-docgen output locally
Options (3)
| Option | Description | Source |
|---|
-h, --help | show this help message and exit | help + man |
--quiet | do not print details of the current operation (in the manual page but not in --help) | man |
--fatal-warnings | make warnings fatal errors (in the manual page but not in --help) | man |
Exit status (2) from the manual page
0 | The command was successful. |
1 | Error, or warning, was generated. |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.