diff options
Diffstat (limited to 'trunk/doc/doxygen.1')
| -rw-r--r-- | trunk/doc/doxygen.1 | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/trunk/doc/doxygen.1 b/trunk/doc/doxygen.1 new file mode 100644 index 0000000..45090f4 --- /dev/null +++ b/trunk/doc/doxygen.1 @@ -0,0 +1,46 @@ +.TH DOXYGEN "1" "DATE" "doxygen VERSION" "User Commands" +.SH NAME +doxygen \- documentation system for various programming languages +.SH DESCRIPTION +Doxygen is a documentation system for C++, C, Java, Objective-C, IDL +(Corba and Microsoft flavors) and to some extent PHP, C#, and D. +.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 +4) Use doxygen to generate a template style sheet file for RTF, HTML or Latex. +.TP +RTF: +doxygen \fB\-w\fR rtf styleSheetFile +.TP +HTML: +doxygen \fB\-w\fR html headerFile footerFile styleSheetFile [configFile] +.TP +LaTeX: doxygen \fB\-w\fR latex headerFile footerFile styleSheetFile [configFile] +.TP +5) Use doxygen to generate an rtf extensions file +.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. +.SH AUTHOR +Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2012 +.SH SEE ALSO +doxywizard(1). |