OS Manuals

/usr/bin/doxygen

A documentation system for C++, C, Java, IDL and PHP

From doxygen 1.18.0-r2 (os), captured 2026-11-05 by running doxygen --help (exit 0). permalink

Doxygen version 1.18.0
Copyright Dimitri van Heesch 1997-2025

You can use Doxygen in a number of ways:

1) Use Doxygen to generate a template configuration file*:
    /usr/bin/doxygen [-s] -g [configName]

2) Use Doxygen to update an old configuration file*:
    /usr/bin/doxygen [-s] -u [configName]

3) Use Doxygen to generate documentation using an existing configuration file*:
    /usr/bin/doxygen [configName]

4) Use Doxygen to generate a template file controlling the layout of the
   generated documentation:
    /usr/bin/doxygen -l [layoutFileName]

    In case layoutFileName is omitted DoxygenLayout.xml will be used as filename.
    If - is used for layoutFileName Doxygen will write to standard output.

5) Use Doxygen to generate a template style sheet file for RTF, HTML or Latex.
    RTF:        /usr/bin/doxygen -w rtf styleSheetFile
    HTML:       /usr/bin/doxygen -w html headerFile footerFile styleSheetFile [configFile]
    LaTeX:      /usr/bin/doxygen -w latex headerFile footerFile styleSheetFile [configFile]

6) Use Doxygen to generate a rtf extensions file
    /usr/bin/doxygen -e rtf extensionsFile

    If - is used for extensionsFile Doxygen will write to standard output.

7) Use Doxygen to compare the used configuration file with the template configuration file
    /usr/bin/doxygen -x [configFile]

   Use Doxygen to compare the used configuration file with the template configuration file
   without replacing the environment variables or CMake type replacement variables
    /usr/bin/doxygen -x_noenv [configFile]

8) Use Doxygen to show a list of built-in emojis.
    /usr/bin/doxygen -f emoji outputFileName

    If - is used for outputFileName Doxygen will write to standard output.

*) If -s is specified the comments of the configuration items in the config file will be omitted.
   If configName is omitted 'Doxyfile' will be used as a default.
   If - is used for configFile Doxygen will write / read the configuration to /from standard output / input.

If -q is used for a Doxygen documentation run, Doxygen will see this as if QUIET=YES has been set.

-v print version string, -V print extended version information
-h,-? prints usage help information
/usr/bin/doxygen -d prints additional usage flags for debugging purposes
Options (2)
OptionDescriptionSource
-v, -V printman
-h, -? printsdoxygen -d prints additional usage flags for debugging purposesman

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