diff options
Diffstat (limited to 'doc/output.doc')
| -rw-r--r-- | doc/output.doc | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/output.doc b/doc/output.doc new file mode 100644 index 0000000..1e8da9e --- /dev/null +++ b/doc/output.doc @@ -0,0 +1,48 @@ +/****************************************************************************** + * + * $Id$ + * + * Copyright (C) 1997-1999 by Dimitri van Heesch. + * + * Permission to use, copy, modify, and distribute this software and its + * documentation under the terms of the GNU General Public License is hereby + * granted. No representations are made about the suitability of this software + * for any purpose. It is provided "as is" without express or implied warranty. + * See the GNU General Public License for more details. + * + * All output generated with Doxygen is not covered by this license. + * + */ +/*! \page output.html + +\section output Output Formats + +\addindex output formats + +The following output formats are \e directly supported by doxygen: +<dl> +<dt><b>HTML</b> +<dd>Generated if GENERATE_HTML is set to YES in the configuration file. +<dt>\f$\mbox{\LaTeX}\f$ +<dd>Generated if GENERATE_LATEX is set to YES in the configuration file. +<dt><b>Man pages</b> +<dd>Generated if GENERATE_MAN is set to YES in the configuration file. +</dl> + +The following output formats are \e indirectly supported by doxygen: +<dl> +<dt><b>Compressed HTML</b> (a.k.a. Windows 98 help) +<dd>Generated by Microsoft's HTML Help workshop from the HTML output if + \c GENERATE_HTMLHELP is set to \c YES. +<dt><b>Postscript</b> +<dd>Generated from the \f$\mbox{\LaTeX}\f$ output by + running <code>make ps</code> in the output directory. + For the best results \c PDF_HYPERLINKS should be set to \c NO. +<dt><b>PDF</b>\htmlonly \endhtmlonly +<dd>Generated from the \f$\mbox{\LaTeX}\f$ output by + running <code>make pdf</code> in the output directory. + In order to get hyperlinks in the pdf file, + \c PDF_HYPERLINKS should be set to \c YES. +</dl> + +*/ |