Linux HOWTOs

About | Home | Search

HOWTO: doxygen
Description: Documentation system
Click here for ChangeLog
NOTE: I use GNU tar >= 1.13.25 so it's -j for .tar.bz2 files,
it's safe to assume that make, gcc, binutils, fileutils/coreutils, gawk, sed, and grep are prerequisites for almost everything

# Doxygen 1.5.5
# =============
# Slackware 10.0's 'doxygen' package includes version 1.3.7, 10.1's includes
# 1.4.0, 10.2's includes 1.4.4, 11.0's includes 1.4.7, and 12.0's
# includes 1.5.2

# Prerequisites:
# flex (< 2.4.31, see below)
# bison
# Perl
# Qt >= 3.3 (for the GUI front-end doxywizard)
# teTeX (for LaTeX, PS, and PDF output;
#  Slackware has a tetex package)
# GraphViz's dot >= 1.8.10
# Ghostscript
# Python (for 'make docs')

# I've had trouble building older versions with certain versions of flex,
# ones newer than the version that comes with Slackware.  With Doxygen
# 1.5.1 and Slackware's flex 2.5.4a package it was fine, and this time
# it was fine with Doxygen 1.5.5 and flex 2.5.34

test -f installed/doxygen-1.5.5.src.tar.gz &&
 mv installed/doxygen-1.5.5.src.tar.gz .
test ! -f doxygen-1.5.5.src.tar.gz &&
mkdir -p -m 0700 src
cd src
find -maxdepth 1 -type d -name "doxygen-*" -exec rm -r {} \;
tar xzvf ~/doxygen-1.5.5.src.tar.gz
cd doxygen-1.5.5
test $UID = 0 && chown -R root:root .
chmod -R u+w .

# I specify --english-only below because that is the only language I
# read/write (well).  If this is not the case for you, leave that one off.

# Leave off --with-doxywizard if you don't have Qt installed

./configure --prefix /usr --docdir /usr/doc --english-only --with-doxywizard

# If you want to generate the user manual (requires Python):
make docs

# If you want a PDF version of the manual:
# (latex/doxygen_manual.pdf)
make pdf

# Become root to install it

test -x /sbin/removepkg && /sbin/removepkg doxygen
test -d /usr/doc/doxygen && rm -r /usr/doc/doxygen
make install

# This will install the docs into /usr/doc/doxygen
test -f /etc/profile.d/ && source /etc/profile.d/
make install_docs

# Become yourself again

mkdir -p -m 0700 installed
rm -f installed/doxygen-*.src.tar.*
mv doxygen-1.5.5.src.tar.gz installed/

# If you ever want to uninstall Doxygen, this should do it:
test -d src/doxygen-* && ( cd src/doxygen-* ; make uninstall )
( cd /usr/bin ; rm -f doxygen doxytag doxywizard )
test -d /usr/doc/doxygen && rm -r /usr/doc/doxygen
( cd /usr/man/man1 ; rm -f doxygen.1 doxytag.1 doxywizard.1 )
find ~/src -maxdepth 1 -type d -name "doxygen-*" -exec rm -r {} \;
rm -f ~/installed/doxygen-*.tar.*

Back to the list

Last updated: Tue, 07 Aug 2018 12:06:17 -0400
Jason Englander <jason at englanders dot us>