1 /******************************************************************************
5 * Copyright (C) 1997-2015 by Dimitri van Heesch.
7 * Permission to use, copy, modify, and distribute this software and its
8 * documentation under the terms of the GNU General Public License is hereby
9 * granted. No representations are made about the suitability of this software
10 * for any purpose. It is provided "as is" without express or implied warranty.
11 * See the GNU General Public License for more details.
13 * Documents produced by Doxygen are derivative works derived from the
14 * input used in their production; they are not affected by this license.
17 /*! \page doxygen_usage Doxygen usage
19 Doxygen is a command line based utility. Calling \c doxygen with the
20 `--help` option at the command line will give you a brief description of the
23 All options consist of a leading character <tt>-</tt>,
24 followed by one character and one or more arguments depending on the option.
26 To generate a manual for your project you typically
27 need to follow these steps:
29 <li> You document your source code with
30 special documentation blocks (see section \ref specialblock).
31 <li> You generate a configuration file (see section \ref config) by
32 calling doxygen with the \c -g option:
34 doxygen -g <config_file>
36 <li> You edit the configuration file so it matches your project.
37 In the configuration file you can specify the input files and
38 a lot of optional information.
39 <li> You let doxygen generate the documentation, based on the settings in the
46 If you have a configuration file generated with an older version of
47 doxygen, you can upgrade it to the current version by running doxygen
50 doxygen -u <config_file>
52 All configuration settings in the original configuration file will be copied
53 to the new configuration file. Any new options will have their default value.
54 Note that comments that you may have added in the original configuration file
57 \section doxygen_finetune Fine-tuning the output
58 If you want to fine-tune the way the output looks, doxygen allows you
59 generate default style sheet, header, and footer files that you can edit
62 <li>For HTML output, you can generate the default header file
63 (see \ref cfg_html_header "HTML_HEADER"), the default footer
64 (see \ref cfg_html_footer "HTML_FOOTER"), and the default style
65 sheet (see \ref cfg_html_stylesheet "HTML_STYLESHEET"), using the
68 doxygen -w html header.html footer.html stylesheet.css <config_file>
70 The `config_file` is optional. When omitted doxygen will search for
71 a file named `Doxyfile` and process that. When this is also not found it
72 will used the default settings.
74 <li>For \LaTeX output, you can generate the first and last part of \c refman.tex
75 (see \ref cfg_latex_header "LATEX_HEADER" and
76 \ref cfg_latex_footer "LATEX_FOOTER") and the style sheet included
77 by that header (normally <code>doxygen.sty</code>), using the following
80 doxygen -w latex header.tex footer.tex doxygen.sty <config_file>
82 If you need non-default options (for instance to use extra \LaTeX packages)
83 you need to make a config file with those options set correctly and then specify
84 that config file after the generated files (make a backup of the configuration
85 file first so you don't loose it in case you forget to specify one of the
87 <li>For RTF output, you can generate the default style sheet file (see
88 \ref cfg_rtf_stylesheet_file "RTF_STYLESHEET_FILE") using:
90 doxygen -w rtf rtfstyle.cfg
93 \warning When using a custom header you are responsible
94 for the proper inclusion of any scripts and style sheets that doxygen
95 needs, which is dependent on the configuration options and may changes
96 when upgrading to a new doxygen release.
100 <li> If you do not want documentation for each item inside the configuration
101 file then you can use the optional \c -s option. This can use be
102 used in combination with the \c -u option, to add or strip the
103 documentation from an existing configuration file.
104 Please use the \c -s option if you send me a configuration file
105 as part of a bug report!
106 <li> To make doxygen read/write to standard input/output instead of from/to
107 a file, use \c - for the file name.
112 Go to the <a href="doxywizard_usage.html">next</a> section or return to the
113 <a href="index.html">index</a>.