Documentation for depend.apache.eclass

1.  NAME

depend.apache.eclass - Functions to allow ebuilds to depend on apache

2.  DESCRIPTION

This eclass handles depending on apache in a sane way and provides information about where certain binaries and configuration files are located.

To make use of this eclass simply call one of the need/want_apache functions described below. Make sure you use the need/want_apache call after you have defined DEPEND and RDEPEND. Also note that you can not rely on the automatic RDEPEND=DEPEND that portage does if you use this eclass.

See Bug 107127 for more information.

3.  EXAMPLE

Here is an example of an ebuild depending on apache:

DEPEND="virtual/Perl-CGI"
RDEPEND="${DEPEND}"
need_apache2

Another example which demonstrates non-standard IUSE options for optional apache support:

DEPEND="server? ( virtual/Perl-CGI )"
RDEPEND="${DEPEND}"
want_apache2 server

4.  FUNCTIONS

want_apache [myiuse]

An ebuild calls this to get the dependency information for optional apache support. If the myiuse parameter is not given it defaults to apache2.

want_apache2 [myiuse]

An ebuild calls this to get the dependency information for optional apache-2.x support. If the myiuse parameter is not given it defaults to apache2.

want_apache2_2 [myiuse]

An ebuild calls this to get the dependency information for optional apache-2.2.x support. If the myiuse parameter is not given it defaults to apache2.

need_apache

An ebuild calls this to get the dependency information for apache.

need_apache2

An ebuild calls this to get the dependency information for apache-2.x.

need_apache2_2

An ebuild calls this to get the dependency information for apache-2.2.x.

has_apache

An ebuild calls this to get runtime variables for an indirect apache dependency without USE-flag, in which case want_apache does not work. DO NOT call this function in global scope.

has_apache_threads [myflag]

An ebuild calls this to make sure thread-safety is enabled if apache has been built with a threaded MPM. If the myflag parameter is not given it defaults to threads.

has_apache_threads_in <myforeign> [myflag]

An ebuild calls this to make sure thread-safety is enabled in a foreign package if apache has been built with a threaded MPM. If the myflag parameter is not given it defaults to threads.

5.  ECLASS VARIABLES

APACHE_VERSION

Stores the version of apache we are going to be ebuilding. This variable is set by the want/need_apache functions.

APXS

Path to the apxs tool. This variable is set by the want/need_apache functions.

APACHE_BIN

Path to the apache binary. This variable is set by the want/need_apache functions.

APACHE_CTL

Path to the apachectl tool. This variable is set by the want/need_apache functions.

APACHE_BASEDIR

Path to the server root directory. This variable is set by the want/need_apache functions.

APACHE_CONFDIR

Path to the configuration file directory. This variable is set by the want/need_apache functions.

APACHE_MODULES_CONFDIR

Path where module configuration files are kept. This variable is set by the want/need_apache functions.

APACHE_VHOSTS_CONFDIR

Path where virtual host configuration files are kept. This variable is set by the want/need_apache functions.

APACHE_MODULESDIR

Path where we install modules. This variable is set by the want/need_apache functions.

APACHE_DEPEND = "www-servers/apache"

Dependencies for Apache

APACHE2_DEPEND = "=www-servers/apache-2*"

Dependencies for Apache 2.x

APACHE2_2_DEPEND = "=www-servers/apache-2.2*"

Dependencies for Apache 2.2.x

6.  MAINTAINERS

apache-devs@gentoo.org

7.  REPORTING BUGS

Please report bugs via http://bugs.gentoo.org/

8.  FILES

/usr/portage/eclass/depend.apache.eclass

9.  SEE ALSO

ebuild (5)

The contents of this document, unless otherwise expressly stated, are licensed under the CC-BY-SA-2.5 license. The Gentoo Name and Logo Usage Guidelines apply.