<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Doxygen manual: Installdox usage</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.4.4 --> <h1><a class="anchor" name="installdox_usage">Installdox usage</a></h1>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>) or the search engine is enabled (See <code>SEARCHENGINE</code> in section <a class="el" href="config.html#config_search">Search engine options</a>). The script is located in the same directory where the HTML files are located.<p> Its purpose is to set the location of the external documentation for each tag file and to set the correct links to the search engine at install time.<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> The following options are available: <dl> <dt><b>-l <code><tagfile>@<location></code></b></dt> <dd>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><tagfile></code> that is used by doxygen. The location <code><location></code> can be an absolute path or a URL.<p> <dl compact><dt><b>Note:</b></dt><dd>Each <tagfile> 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> 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> 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. <hr size="1"><address style="align: right;"><small>Generated on Wed Nov 15 11:05:48 2006 for Doxygen manual by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address> </body> </html>
