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) 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 style sheet file for RTF, HTML or Latex.

    27 .TP

    28 RTF:

    29 doxygen \fB\-w\fR rtf styleSheetFile

    30 .TP

    31 HTML:

    32 doxygen \fB\-w\fR html headerFile footerFile styleSheetFile [configFile]

    33 .TP

    34 LaTeX: doxygen \fB\-w\fR latex headerFile styleSheetFile [configFile]

    35 .TP

    36 5) Use doxygen to generate an rtf extensions file

    37 .TP

    38 RTF:

    39 doxygen \fB\-e\fR rtf extensionsFile

    40 .PP

    41 If \fB\-s\fR is specified the comments in the config file will be omitted.

    42 If configName is omitted `Doxyfile' will be used as a default.

    43 .SH AUTHOR

    44 Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2007

    45 .SH SEE ALSO

    46 doxytag(1), doxywizard(1).