DOXYGEN(1) User Commands DOXYGEN(1)

# [NAME](#NAME)

Doxygen - documentation system for various programming languages

# [DESCRIPTION](#DESCRIPTION)

Doxygen is a documentation system for C++, C, Java, Objective-C, IDL (CORBA and Microsoft flavors), Fortran, Python, VHDL and to some extent PHP, C#, and D.

You can use Doxygen in several ways:

1\) Generate a template configuration file\*:

doxygen \[-s] **-g** \[configName]

2\) Update an existing configuration file\*:

doxygen \[-s] **-u** \[configName]

3\) Generate documentation using an existing configuration file\*:

doxygen \[configName]

4\) Generate a template file that controls the layout of the generated documentation:

doxygen **-l** \[layoutFileName]

If layoutFileName is omitted, DoxygenLayout.xml will be used as the filename.  
If - is used for layoutFileName, Doxygen writes to standard output.

5\) Generate a template style sheet file for RTF, HTML or LaTeX:

RTF: doxygen **-w** rtf styleSheetFile

HTML: doxygen **-w** html headerFile footerFile styleSheetFile \[configFile]

LaTeX: doxygen **-w** latex headerFile footerFile styleSheetFile \[configFile]

6\) Generate an RTF extensions file:

RTF: doxygen **-e** rtf extensionsFile

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

7\) Compare the used configuration file with the template configuration file:

doxygen **-x** \[configFile]

[Compare the used configuration file with the template configuration file](#Compare)

without replacing the environment variables or CMake type replacement variables:

doxygen **-x\_noenv** \[configFile]

8\) Show a list of built-in emojis.

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 by 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

doxygen **-d** prints additional usage flags for debugging purposes

# [AUTHOR](#AUTHOR)

Doxygen version 1.18.0, Copyright Dimitri van Heesch 1997-2026

# [SEE ALSO](#SEE_ALSO)

[doxywizard(1)](/man/os/doxygen/doxywizard.1).

09-10-2026 doxygen 1.18.0

---

Document: doxygen(1) from doxygen 1.18.0-r2 (Chainguard OS)
Source: https://github.com/doxygen/doxygen