.TH APACHKCONFIG 8 "Mon Jun 21 2004"
.UC 4
.SH NAME
apachkconfig \- updates and queries addons config information for different Apache favours

.SH SYNOPSIS
\fBapachkconfig\fR \fB--list\fR [\fIname\fR]
.br
\fBapachkconfig\fR \fB--add\fR \fIname\fR
.br
\fBapachkconfig\fR \fB--del\fR \fIname\fR
.br
\fBapachkconfig\fR [\fB--favour|--level\fR \fIfavours\fR] \fIname\fR <\fBon\fR|\fBoff\fR|\fBreset\fR>
.br
\fBapachkconfig\fR [\fB--favour|--level\fR \fIfavours\fR] \fIname\fR 
.br

.SH DESCRIPTION
\fBapachkconfig\fR provides a simple command-line tool for maintaining the
apache addon configuration (e.g /etc/httpd*/addon.d) directories by relieving
system administrators of the task of directly manipulating the numerous
symbolic links in those directories.

This implementation (as well as this man page) of \fBapachkconfig\fR was
inspired by the \fBchkconfig\fR command used for manipulating SYSV services.

\fBapachkconfig\fR has five distinct functions: adding new addon for
management, removing addons from management, listing the current
startup information for addons, changing the startup information
for addons, and checking the startup state of a particular addon.

When \fBapachkconfig\fR is run without any options, it displays usage
information.  If only an addon name is given, it checks to see if
the service is configured to be loaded by the default apache favour. If
it is, \fBapachkconfig\fR returns true; otherwise it returns false. The
\fB--favour\fR option may be used to have \fBapachkconfig\fR query an
alternative favour rather than the default one.

If one of \fBon\fR, \fBoff\fR, or \fRreset\fR is specified after the
addon name, \fBapachkconfig\fR changes the startup information for the
specified addon.  The \fBon\fR and \fBoff\fR flags cause the addon
to be loaded or ignored, respectively, by the apache favour being changed.
The \fBreset\fR flag resets the startup information for the addon to
whatever is specified in the config file in question.

By default, the \fBon\fR, \fBoff\fR and \fBreset\fR options affect all
of the apache favours installed.  The \fB--favour\fR option may be used
to specify which favours are affected.

.SH OPTIONS
.TP
\fB-\-favour \fIfavours\fR
Specifies the apache favours an operation should pertain to. It is given as
an alpha-numeric string. For example, \fB--favour 1p2\fR specifies
favours 1 (Apache-13), p (Apache13-mod_perl) and 2 (Apache2).

.TP
\fB-\-add\fR \fIname\fR

This option adds a new addon for management by \fBapachkconfig\fR.
When a new addon is added, \fBapachkconfig\fR ensures that the service
has an activate entry in every favour. If any apache favour is missing
such an entry, \fBchkconfig\fR creates the appropriate entry as specified
by the default values in the addon config file.

.TP
\fB-\-del\fR \fIname\fR
The addon is removed from \fBapachkconfig\fR management, and any symbolic
links in apache addon config directories (e.g /etc/httpd*/addon.d) which
pertain to it are removed.

.TP
\fB-\-list\fR \fIname\fR
This option lists all of the addons which \fBapachkconfig\fR knows about,
and whether they are loaded or ignored by each apache favour. If \fIname\fR
is specified, information is only displayed about addon \fIname\fR.

.SH FAVOUR FILES

Each addon which should be manageable by \fBapachkconfig\fR needs two
or more commented lines added to its config file. The first line
tells \fBapachkconfig\fR for what favours the addon should be loaded
by default, as well as the load priority level and optionally favour
restriction list. If the addon should not, by default, be loaded in any
favours, a \fB\-\fR should be used in place of the favours list. If the addon
should never be loaded by any other apache favour, exept some exactly named,
add the list of restricted favours after the priority level. The second
line contains a description for the service, and may be extended across
multiple lines with backslash continuation.

For example, awstats.conf has these three lines:
.nf
.fn C
# apachkconfig: 1p2 50 
# description: Real-time logfile analyzer to get advanced web statistics \e
               AWStats is a short for Advanced Web Statistics. It's a free \e
	       tool that generates advanced web (but also ftp, syslog or \e
	       mail) server access statistics graphically.
.fn R
.fi
This says that the awstats CGI script config should be loaded by apache
favours 1, p, and 2, that its start priority should be 50, and that its stop
priority should be 80.  You should be able to figure out what the
description says; the \e causes the line to be continued.  The
extra space in front of the line is ignored.

Second example, webauth.conf make sense only for Apache2:
.nf
.fn C
# apachkconfig: - 12 2
# description: A WebAuth (GSS-API) authentication module for Apache2
.fn R
.fi
This says that the webauth module config could be loaded only by apache
favour 2, that its start priority should be 12 and that it should be disabled
by default.

.SH SEE ALSO
.IR chkconfig (8)
.IR httpd (8)

.SH AUTHOR
.nf
Yury Konovalov <yurix@altlinux.org>
.fi