NAME

apachkconfig - updates and queries addons config information for different Apache favours

SYNOPSIS

apachkconfig --list [name]
apachkconfig --add name
apachkconfig --del name
apachkconfig [--favour|--level favours] name <on|off|reset>
apachkconfig [--favour|--level favours] name

DESCRIPTION

apachkconfig 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 apachkconfig was inspired by the chkconfig command used for manipulating SYSV services.

apachkconfig 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 apachkconfig 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, apachkconfig returns true; otherwise it returns false. The --favour option may be used to have apachkconfig query an alternative favour rather than the default one.

If one of on, off, or reset is specified after the addon name, apachkconfig changes the startup information for the specified addon. The on and off flags cause the addon to be loaded or ignored, respectively, by the apache favour being changed. The reset flag resets the startup information for the addon to whatever is specified in the config file in question.

By default, the on, off and reset options affect all of the apache favours installed. The --favour option may be used to specify which favours are affected.

OPTIONS

--favour favours

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

--add name

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

--del name

The addon is removed from apachkconfig management, and any symbolic links in apache addon config directories (e.g /etc/httpd*/addon.d) which pertain to it are removed.

--list name

This option lists all of the addons which apachkconfig knows about, and whether they are loaded or ignored by each apache favour. If name is specified, information is only displayed about addon name.

FAVOUR FILES

Each addon which should be manageable by apachkconfig needs two or more commented lines added to its config file. The first line tells apachkconfig 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 - 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:

# apachkconfig: 1p2 50 
# description: Real-time logfile analyzer to get advanced web statistics \


               AWStats is a short for Advanced Web Statistics. It's a free \
	       tool that generates advanced web (but also ftp, syslog or \
	       mail) server access statistics graphically.

Second example, webauth.conf make sense only for Apache2:

# apachkconfig: - 12 2
# description: A WebAuth (GSS-API) authentication module for Apache2

SEE ALSO

chkconfig(8) httpd(8)

AUTHOR

Yury Konovalov <yurix@altlinux.org>