Welcome to the Dox homepage!

What is Dox?

Dox is a graphical documentation browser for Unix/X11.

Features:

  • Manpage browser.
  • Info browser.
  • Access to books in HTML format via their respective table of contents. glibc and STL are included in the release, others can be downloaded.
  • Integration of Debian's docbase.
  • Access to books in HTML format via their respective keyword index.
  • Search in manpage titles and contents (cf. apropos and whatis).
  • Interface to the pydoc and perldoc utilities.
  • Fulltext search in HTML documentation
  • Extensibility: Tables of content and keyword indices can be added by installing simple XML files to be extracted from the documentation.
  • Remote controllable from the shell.
  • A utility for converting tags files generated by Doxygen to keyword indices.
Dox is distributed under the terms of the GNU General Public License, version 2.

Resources

DownloadDownload.
Mailing listMailing list.
Web forumWeb based forum.
BerliOSBerliOS summary.

Screenshots

Viewing a man page
Viewing a man page screenshot
Keyword Index
Keyword index screenshot
Full text searching
Full text searching screenshot
Viewing an info page
Viewing an info page screenshot

Status

Dox is reasonably feature complete. Of course, there is much room for further improvement, but I don't have the time for doing any nontrivial work on it currently. Patches and documentation are welcome. I would also be happy to make further HTML books available on this web page if someone prepares them.

Requirements

For compiling Dox, you need Qt 3.0, downloadable from Trolltech. Qt 2.x won't do! Although it integrates nicely into KDE, it does not require kdelibs. I've developed and tested this program only under SuSE 7.3. Other operating systems (even Linux) may have a different organization of manpages, so there may be problems I cannot investigate myself. Portability patches are very welcome :-)

Additional books

Install these packages with
     tar xvzf foo.tar.gz
     cd foo
     ./install -prefix /path/where/dox/is/installed

Bernd Gehrmann
BerliOS Logo