This is Dox, version 1.1
There is some documentation in the manpage dox(1). Some notes here:
- Dox requires Qt 3.x. You must set $QTDIR to the directory where Qt resides, and Qt's binaries must be in your $PATH
- For installation, run ./configure -prefix /path/to/installdir, then make and make install.
- Dox comes with libc and STL documentation, and tables of contents for Perl and GNUstep. (the latter is autodetected at configure time)
- Further documentation can be downloaded at http://dox.berlios.de
- You can easily make documentation generated by doxygen available both in the Contents and Index tabs. To this end, run
dox-tags2dox foo.tags /path/to/generated/doc foo.index foo.toc
This will produce the files foo.index and foo.toc from the input
file foo.tags, which is a tags file produced by doxygen. Then
copy foo.toc to PREFIX/share/dox/tocs and foo.index to
PREFIX/share/dox/indices, where PREFIX is the path to which you
have installed dox (see above).
Unfortunately, in the current version of doxygen, tags files are
not quite xml compliant. To fix this, you can use
perl -pi -e 's/^\<tagfile\>/\<!DOCTYPE tagfile\>\<tagfile\>/' foo.tags
- If MANPATH or INFOPATH are not set, some fallbacks are set. See dox/main.cpp.
- Due to different conventions wrt organization of manpages and whatis databases, the manpage stuff may not work on every operating system. If you can figure out a way how to make it work on yours, send me a patch.
- For full text searching, you need htdig. If it is installed in an unusual location, put the directories where the binaries htdig, htmerge and htsearch are installed into your PATH variable at configure time.
- Info pages are neither full text searchable nor do they appear in the keyword index or are browsable by their toc. Normally, it is better to convert the original .texinfo files to html and generate toc and index files for them. Bonus: You can conveniently browse through the table of contents, and you are not restricted to the fixed width of info files. The books on http://dox.berlios.de contain examples how to do this. If someone packages up some popular texinfo books in this way, I would be happy to publish them there.
- Info pages are not available through the full text search.
- Dox can be remote controlled from the shell. See dox(1) for details. This can be used to access it quickly from Emacs. For example, you may put
(global-set-key [f5] '(lambda () (interactive)
(shell-command (concat "dox -remote \"IndexWidget.showTerm("
(thing-at-point 'word) ")\""))
(shell-command "dox -remote \"MainWindow.setActiveWindow()\"")
))
into your .emacs, .xemacs/init.el resp. When you now press F5, the word under the cursor will be looked up in the keyword index.