diff options
| author | mueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7> | 1999-12-15 19:29:47 (GMT) |
|---|---|---|
| committer | mueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7> | 1999-12-15 19:29:47 (GMT) |
| commit | daf91dc906e217e81f77f491e0abf505a91289b8 (patch) | |
| tree | 223d088e44a6b0956dd0437ed4851244b2e7f36c /doc/doxysearch_usage.doc | |
| parent | a6cb7ef1dc7c3d6b6ff949646b9b2deda3fc0bf3 (diff) | |
| download | Doxygen-daf91dc906e217e81f77f491e0abf505a91289b8.zip Doxygen-daf91dc906e217e81f77f491e0abf505a91289b8.tar.gz Doxygen-daf91dc906e217e81f77f491e0abf505a91289b8.tar.bz2 | |
mods for doxygen-0.49-990728
Diffstat (limited to 'doc/doxysearch_usage.doc')
| -rw-r--r-- | doc/doxysearch_usage.doc | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/doc/doxysearch_usage.doc b/doc/doxysearch_usage.doc index a4a3e96..e3b1657 100644 --- a/doc/doxysearch_usage.doc +++ b/doc/doxysearch_usage.doc @@ -67,7 +67,7 @@ follow these steps: documentation. Apart from the documentation, Doxygen will create the following files: <ul> - <li>A small CGI script. the name of the script is determined by the + <li>A small shell script. the name of the script is determined by the \c CGI_NAME tag in the configuration file. The script is a small wrapper that calls \c doxysearch with the correct parameters. Using this script allows multiple @@ -80,6 +80,16 @@ follow these steps: <li>\c search.gif: this is the image that is used for the search button. </ul> + \par Notice: + On the Windows platform Unix shell scripts cannot be used. + In fact the HTTP daemon that I tried (apache for Windows) only + recognized <code>.cgi</code> files that were renamed + executables (so DOS batch files do not seem to work either). Therefore, + on Windows a small C program will generated by doxygen. + You should compile and link the program with your favourite + compiler and change the extension of the executable from + <code>.exe</code> to <code>.cgi</code>. + <li>Copy (or move) the CGI script to the directory where the CGI binaries are located. This is usually a special directory on your system or in your @@ -112,7 +122,8 @@ This can be done by carefully following these steps: <li>Goto the html directory of the Qt-distribution: <pre>cd $QTDIR/html</pre> <li>Generate the search index by typing: - <pre>doxytag -s search.idx *.html</pre> + <pre>doxytag -s search.idx</pre> + in the directory where the HTML files are located. This will parse all files and build a search index. Apart from the file <code>search.idx</code> two other files will be generated: <code>search.gif</code> and <code>search.cgi</code> |