summaryrefslogtreecommitdiffstats
path: root/doc/installdox_usage.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>1999-12-15 19:25:10 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>1999-12-15 19:25:10 (GMT)
commit322885a8700a209812bf5a94205260c9bef6ac1f (patch)
treecc1cd70cf5761ddf72ff114c0b65576c3f4c1d2a /doc/installdox_usage.doc
parent361bf7915be13b5c74688e33c427aea30641814c (diff)
downloadDoxygen-322885a8700a209812bf5a94205260c9bef6ac1f.zip
Doxygen-322885a8700a209812bf5a94205260c9bef6ac1f.tar.gz
Doxygen-322885a8700a209812bf5a94205260c9bef6ac1f.tar.bz2
initial version
Diffstat (limited to 'doc/installdox_usage.doc')
-rw-r--r--doc/installdox_usage.doc61
1 files changed, 61 insertions, 0 deletions
diff --git a/doc/installdox_usage.doc b/doc/installdox_usage.doc
new file mode 100644
index 0000000..d22e4a7
--- /dev/null
+++ b/doc/installdox_usage.doc
@@ -0,0 +1,61 @@
+/******************************************************************************
+ *
+ * $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 installdox_usage Installdox usage
+
+Installdox is a perl script that is generated by doxygen whenever
+tag files are used (See \c TAGFILES
+in section \ref config_extref)
+or the search engine is enabled (See \c SEARCHENGINE
+in section \ref config_search). The script is
+located in the same directory where the HTML files are located.
+
+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.
+
+Calling \c installdox with option <b>-h</b> at the command line
+will give you a brief description of the usage of the program.
+
+The following options are available:
+<dl>
+<dt><b>-l <tt>\<tagfile\>\@\<location\></tt></b><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 \e requires the location of the
+ documentation for each tag file <tt>\<tagfile\></tt>
+ that is used by doxygen. The location <tt>\<location\></tt> can be
+ an absolute path or a URL.
+
+ \par Notice:
+ Each <tagfile> must be unique and should only be the name of the
+ file, not including the path.
+
+<dt><b>-q</b><dd>
+ When this option is specified, installdox will generate no output other
+ than fatal errors.
+</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 \c .html are used.
+
+The \c installdox 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.
+
+*/