OS Manuals

/usr/bin/valadoc

Compiler for the GObject type system

From vala 0.56.19-r3 (os), captured 2026-11-10 by running valadoc --help (exit 0). permalink

Usage:
  valadoc [OPTION…] FILE... - Vala Documentation Tool

Help Options:
  -h, --help                                  Show help options

Application Options:
  -o, --directory=DIRECTORY                   Output directory
  -b, --basedir=DIRECTORY                     Base source directory
  -D, --define=SYMBOL...                      Define SYMBOL
  --profile=PROFILE                           Minimum runtime dependency: 'gobject' (default) or 'posix' (minimal libc)
  --enable-experimental                       Enable experimental features
  --enable-experimental-non-null              Enable experimental enhancements for non-null types
  --metadatadir=DIRECTORY...                  Look for GIR .metadata files in DIRECTORY
  --girdir=DIRECTORY...                       Look for .gir files in DIRECTORY
  --vapidir=DIRECTORY...                      Look for package bindings in DIRECTORY
  --pkg=PACKAGE...                            Include binding for PACKAGE
  --driver                                    Name of an driver or path to a custom driver (DEPRECATED AND IGNORED)
  --importdir=DIRECTORY...                    Look for external documentation in DIRECTORY
  --import=PACKAGE...                         Include binding for PACKAGE
  --alternative-resource-dir=DIRECTORY...     Alternative resource directories
  --wiki=DIRECTORY                            Wiki directory
  --deps                                      Adds packages to the documentation
  --doclet=PLUGIN                             Name of an included doclet or path to custom doclet
  -X, --doclet-arg=ARG                        Pass arguments to the doclet
  --no-protected                              Removes protected elements from documentation
  --internal                                  Adds internal elements to documentation
  --private                                   Adds private elements to documentation
  --use-svg-images                            Generate SVG image charts instead of PNG
  --package-name=NAME                         package name
  --package-version=VERSION                   package version
  --gir=NAME-VERSION.gir                      GObject-Introspection repository file name
  --version                                   Display version number
  --force                                     force
  --fatal-warnings                            Treat warnings as fatal
  --verbose                                   Show all warnings
  --no-color                                  Disable colored output
  --target-glib='MAJOR.MINOR', or 'auto'      Target version of glib for code generation
Options (32)
OptionDescriptionSource
-h, --helpShow help optionshelp + man
-o, --directory DIRECTORYOutput directoryhelp + man
-b, --basedir DIRECTORYBase source directoryhelp + man
-D, --define SYMBOL...Define SYMBOLhelp + man
--profile PROFILEMinimum runtime dependency: 'gobject' (default) or 'posix' (minimal libc)help + man
--enable-experimentalEnable experimental featureshelp + man
--enable-experimental-non-nullEnable experimental enhancements for non-null typeshelp + man
--metadatadir DIRECTORY...Look for GIR .metadata files in DIRECTORYhelp + man
--girdir DIRECTORY...Look for .gir files in DIRECTORYhelp + man
--vapidir DIRECTORY...Look for package bindings in DIRECTORYhelp + man
--pkg PACKAGE...Include binding for PACKAGEhelp + man
--driverName of an driver or path to a custom driver (DEPRECATED AND IGNORED)help + man
--importdir DIRECTORY...Look for external documentation in DIRECTORYhelp + man
--import PACKAGE...Include binding for PACKAGEhelp + man
--alternative-resource-dir DIRECTORY...Alternative resource directorieshelp + man
--wiki DIRECTORYWiki directoryhelp + man
--depsAdds packages to the documentationhelp + man
--doclet PLUGINName of an included doclet or path to custom doclethelp + man
-X, --doclet-arg ARGPass arguments to the doclethelp + man
--no-protectedRemoves protected elements from documentationhelp + man
--internalAdds internal elements to documentationhelp + man
--privateAdds private elements to documentationhelp + man
--use-svg-imagesGenerate SVG image charts instead of PNGhelp + man
--package-name NAMEpackage namehelp + man
--package-version VERSIONpackage versionhelp + man
--gir NAME-VERSION.girGObject-Introspection repository file namehelp + man
--versionDisplay version numberhelp + man
--forceforcehelp + man
--fatal-warningsTreat warnings as fatalhelp + man
--verboseShow all warningshelp + man
--no-colorDisable colored outputhelp + man
--target-glib 'MAJOR.MINOR'Target version of glib for code generationhelp + 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.