Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > bbf8b69a7c5792df8049c96b78d19811 > files > 781

doxygen-1.7.4-2.fc14.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Doxygen manual: Installdox usage</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Doxygen manual</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
</div>
<div class="header">
  <div class="headertitle">
<div class="title">Installdox usage </div>  </div>
</div>
<div class="contents">
<div class="textblock"><p>Installdox is a perl script that is generated by doxygen whenever tag files are used (See <code>TAGFILES</code> in section <a class="el" href="config.html#config_extref">External reference options</a>). The script is located in the same directory where the HTML files are located.</p>
<p>Its purpose is to set the location of the external documentation for each tag file at install time.</p>
<p>Calling <code>installdox</code> with option <b>-h</b> at the command line will give you a brief description of the usage of the program.</p>
<p>The following options are available: </p>
<dl>
<dt><b>-l <code>&lt;tagfile&gt;@&lt;location&gt;</code></b></dt>
<dd><p class="startdd">Each tag file contains information about the files, classes and members documented in a set of HTML files. A user can install these HTML files anywhere on his/her hard disk or web site. Therefore installdox <em>requires</em> the location of the documentation for each tag file <code>&lt;tagfile&gt;</code> that is used by doxygen. The location <code>&lt;location&gt;</code> can be an absolute path or a URL.</p>
<dl class="user"><dt><b>Note:</b></dt><dd>Each &lt;tagfile&gt; must be unique and should only be the name of the file, not including the path.</dd></dl>
</dd>
<dt><b>-q</b></dt>
<dd>When this option is specified, installdox will generate no output other than fatal errors. </dd>
</dl>
<p>Optionally a list of HTML files may be given. These files are scanned and modified if needed. If this list is omitted all files in the current directory that end with <code></code>.html are used.</p>
<p>The <code>installdox</code> script is unique for each generated class browser in the sense that it `knows' what tag files are used. It will generate an error if the <b>-l</b> option is missing for a tag file or if an invalid tag file is given. </p>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jun 27 2011 for Doxygen manual by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>