|
1 /****************************************************************************** |
|
2 * |
|
3 * |
|
4 * |
|
5 * Copyright (C) 1997-2008 by Dimitri van Heesch. |
|
6 * |
|
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. |
|
12 * |
|
13 * Documents produced by Doxygen are derivative works derived from the |
|
14 * input used in their production; they are not affected by this license. |
|
15 * |
|
16 */ |
|
17 /*! \page installdox_usage Installdox usage |
|
18 |
|
19 Installdox is a perl script that is generated by doxygen whenever |
|
20 tag files are used (See \c TAGFILES |
|
21 in section \ref config_extref). The script is |
|
22 located in the same directory where the HTML files are located. |
|
23 |
|
24 Its purpose is to set the location of the external documentation |
|
25 for each tag file at install time. |
|
26 |
|
27 Calling \c installdox with option <b>-h</b> at the command line |
|
28 will give you a brief description of the usage of the program. |
|
29 |
|
30 The following options are available: |
|
31 <dl> |
|
32 <dt><b>-l <tt>\<tagfile\>\@\<location\></tt></b><dd> |
|
33 Each tag file contains information about the files, classes and members |
|
34 documented in a set of HTML files. A user can install these |
|
35 HTML files anywhere on his/her hard disk or web site. |
|
36 Therefore installdox \e requires the location of the |
|
37 documentation for each tag file <tt>\<tagfile\></tt> |
|
38 that is used by doxygen. The location <tt>\<location\></tt> can be |
|
39 an absolute path or a URL. |
|
40 |
|
41 \par Note: |
|
42 Each \<tagfile\> must be unique and should only be the name of the |
|
43 file, not including the path. |
|
44 |
|
45 <dt><b>-q</b><dd> |
|
46 When this option is specified, installdox will generate no output other |
|
47 than fatal errors. |
|
48 </dl> |
|
49 Optionally a list of HTML files may be given. |
|
50 These files are scanned and modified if needed. |
|
51 If this list is omitted all files in the current directory |
|
52 that end with \c .html are used. |
|
53 |
|
54 The \c installdox script is unique for each generated class browser |
|
55 in the sense that it `knows' what tag files are used. It will generate an error if |
|
56 the <b>-l</b> option is missing for a tag file or if an invalid tag file |
|
57 is given. |
|
58 |
|
59 */ |