1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.12"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>Doxygen: Output Formats</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
15 <script type="text/javascript" src="navtree.js"></script>
16 <script type="text/javascript">
17 $(document).ready(initResizable);
19 <link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
24 <table cellspacing="0" cellpadding="0">
26 <tr style="height: 56px;">
27 <td id="projectalign" style="padding-left: 0.5em;">
28 <div id="projectname">Doxygen
35 <!-- end header part -->
36 <!-- Generated by Doxygen 1.8.12 -->
38 <div id="side-nav" class="ui-resizable side-nav-resizable">
40 <div id="nav-tree-contents">
41 <div id="nav-sync" class="sync"></div>
44 <div id="splitbar" style="-moz-user-select:none;"
45 class="ui-resizable-handle">
48 <script type="text/javascript">
49 $(document).ready(function(){initNavTree('output.html','');});
51 <div id="doc-content">
53 <div class="headertitle">
54 <div class="title">Output Formats </div> </div>
56 <div class="contents">
57 <div class="textblock"><p><a name="aoutput:20formats"></a></p>
58 <p>The following output formats are <em>directly</em> supported by doxygen: </p><dl>
60 <dd>Generated if <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code> in the configuration file. </dd>
61 <dt><img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> </dt>
62 <dd>Generated if <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code> in the configuration file. </dd>
63 <dt><b>Man pages</b> </dt>
64 <dd>Generated if <a class="el" href="config.html#cfg_generate_man">GENERATE_MAN</a> is set to <code>YES</code> in the configuration file. </dd>
66 <dd><p class="startdd">Generated if <a class="el" href="config.html#cfg_generate_rtf">GENERATE_RTF</a> is set to <code>YES</code> in the configuration file.</p>
67 <p class="enddd">Note that the RTF output probably only looks nice with Microsoft's Word. If you have success with other programs, please let me know. </p>
70 <dd><p class="startdd">Generated if <a class="el" href="config.html#cfg_generate_xml">GENERATE_XML</a> is set to <code>YES</code> in the configuration file.</p>
73 <dt><b>Docbook</b> </dt>
74 <dd><p class="startdd">Generated if <a class="el" href="config.html#cfg_generate_docbook">GENERATE_DOCBOOOK</a> is set to <code>YES</code> in the configuration file.</p>
78 <p>The following output formats are <em>indirectly</em> supported by doxygen: </p><dl>
79 <dt><b>Compiled HTML Help</b> (a.k.a. Windows 98 help) </dt>
80 <dd>Generated by Microsoft's HTML Help workshop from the HTML output if <a class="el" href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a> is set to <code>YES</code>. </dd>
81 <dt><b>Qt Compressed Help (.qch)</b> </dt>
82 <dd>Generated by Qt's qhelpgenerator tool from the HTML output if <a class="el" href="config.html#cfg_generate_qhp">GENERATE_QHP</a> is set to <code>YES</code>. </dd>
83 <dt><b>Eclipse Help</b> </dt>
84 <dd>Generated from HTML with a special index file that is generated when <a class="el" href="config.html#cfg_generate_eclipsehelp">GENERATE_ECLIPSEHELP</a> is set to <code>YES</code>. </dd>
85 <dt><b>XCode DocSets</b> </dt>
86 <dd>Compiled from HTML with a special index file that is generated when <a class="el" href="config.html#cfg_generate_docset">GENERATE_DOCSET</a> is set to <code>YES</code>. </dd>
87 <dt><b>PostScript</b> </dt>
88 <dd>Generated from the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> output by running <code>make ps</code> in the output directory. For the best results <a class="el" href="config.html#cfg_pdf_hyperlinks">PDF_HYPERLINKS</a> should be set to <code>NO</code>. </dd>
89 <dt><b>PDF</b> </dt>
90 <dd>Generated from the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> output by running <code>make pdf</code> in the output directory. To improve the PDF output, you typically would want to enable the use of <code>pdflatex</code> by setting <a class="el" href="config.html#cfg_use_pdflatex">USE_PDFLATEX</a> to <code>YES</code> in the configuration file. In order to get hyperlinks in the PDF file you also need to enable <a class="el" href="config.html#cfg_pdf_hyperlinks">PDF_HYPERLINKS</a>. </dd>
93 Go to the <a href="searching.html">next</a> section or return to the
94 <a href="index.html">index</a>.
96 </div></div><!-- contents -->
97 </div><!-- doc-content -->
98 <!-- start footer part -->
99 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
101 <li class="footer">Generated by
102 <a href="http://www.doxygen.org/index.html">
103 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>