diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2005-01-29 11:51:21 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2005-01-29 11:51:21 (GMT) |
commit | c635cffd1d8bcf5bcbe90ce2c3c5fc3371e01a1c (patch) | |
tree | 5d48c44b9a2f19b38592c2cb51a919ebd456c8fb /doc/doxygen.1 | |
parent | 13feb604f3aa783f927ed47df8e4c561a8d8032a (diff) | |
download | Doxygen-c635cffd1d8bcf5bcbe90ce2c3c5fc3371e01a1c.zip Doxygen-c635cffd1d8bcf5bcbe90ce2c3c5fc3371e01a1c.tar.gz Doxygen-c635cffd1d8bcf5bcbe90ce2c3c5fc3371e01a1c.tar.bz2 |
Release-1.4.1-20050129
Diffstat (limited to 'doc/doxygen.1')
-rw-r--r-- | doc/doxygen.1 | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/doxygen.1 b/doc/doxygen.1 new file mode 100644 index 0000000..3736aaa --- /dev/null +++ b/doc/doxygen.1 @@ -0,0 +1,44 @@ +.TH DOXYGEN "1" "DATE" "doxygen VERSION" "User Commands" +.SH NAME +doxygen \- manual page for doxygen VERSION +.SH DESCRIPTION +Doxygen version VERSION +Copyright Dimitri van Heesch 1997-2005 +.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 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 SEE ALSO +doxytag(1), doxywizard(1). |