doxygen.1 1.52 KB
Newer Older
1 2
.TH DOXYGEN "1" "DATE" "doxygen VERSION" "User Commands"
.SH NAME
3
doxygen \- documentation system for various programming languages
4
.SH DESCRIPTION
5 6
Doxygen is a documentation system for C++, C, Java, Objective-C, IDL
(Corba and Microsoft flavors) and to some extent PHP, C#, and D.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
.PP
You can use doxygen in a number of ways:
.TP
1) Use doxygen to generate a template configuration file:
.IP
doxygen [-s] \fB\-g\fR [configName]
.IP
If - is used for configName doxygen will write to standard output.
.TP 
2) Use doxygen to update an old configuration file:
.IP
doxygen [-s] \fB\-u\fR [configName]
.TP
3) Use doxygen to generate documentation using an existing configuration file:
.IP
doxygen [configName]
.IP
If - is used for configName doxygen will read from standard input.
.TP
26 27 28 29 30
4) Use doxygen to generate a template file controlling the layout of the generated documentation:
.IP
doxygen -l layoutFileName.xml
.TP
5) Use doxygen to generate a template style sheet file for RTF, HTML or Latex.
31 32 33 34 35 36 37
.TP
RTF:
doxygen \fB\-w\fR rtf styleSheetFile
.TP
HTML:
doxygen \fB\-w\fR html headerFile footerFile styleSheetFile [configFile]
.TP
38
LaTeX: doxygen \fB\-w\fR latex headerFile footerFile styleSheetFile [configFile]
39
.TP
40
6) Use doxygen to generate an rtf extensions file
41 42 43 44 45 46
.TP
RTF:
doxygen \fB\-e\fR rtf extensionsFile
.PP
If \fB\-s\fR is specified the comments in the config file will be omitted.
If configName is omitted `Doxyfile' will be used as a default.
47
.SH AUTHOR
Dimitri van Heesch's avatar
Dimitri van Heesch committed
48
Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2014
49
.SH SEE ALSO
50
doxywizard(1).