summaryrefslogtreecommitdiffstats
path: root/doc/doxygen.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/doxygen.1')
-rw-r--r--doc/doxygen.144
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).