doc/doxygen.1

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