.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "A2QUERY.IN 1"
.TH A2QUERY.IN 1 2024-04-05 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
a2query \- retrieve runtime configuration from a local Apache 2 HTTP server
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBa2query\fR  [\-m [\fIMODULE\fR]] [\-s [\fISITE\fR]] [\-c [\fICONF\fR]] [\-a] [\-v]
[\-M] [\-d] [\-h]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBa2query\fR is a program designed to retrieve configuration values from a locally
available Apache 2 HTTP web server. It was designed to be as robust as possible
by returning feasible values even if the Apache 2 syntax validator fails.
.PP
This program is primarily meant to be used from maintainer scripts.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \-a 4
.IX Item "-a"
Returns the Apache 2 "Module Magic Version" (API version) number, the server was
compiled with. The returned version does not contain any minor versions which
are known to be compatible with the major version returned.
.IP "\-c [\fICONF\fR]" 4
.IX Item "-c [CONF]"
Checks whether the configuration \fICONF\fR is enabled. If no argument was given,
all enabled configuration files are being returned. \fICONF\fR is compared by
string comparison by ignoring a leading "mod_" prefix and possibly a '.conf' or
\&'.load' suffix.
.IP \-h 4
.IX Item "-h"
Displays a brief summary how the program can be called and exits.
.IP "\-m [\fIMODULE\fR]" 4
.IX Item "-m [MODULE]"
Checks whether the module \fIMODULE\fR is enabled, The argument is interpreted in
the same way, as for configuration files queried by the \-c switch.
.IP \-M 4
.IX Item "-M"
Returns the currently enabled Apache 2 MPM (Multi Processing Module).
.IP "\-s [\fISITE\fR]" 4
.IX Item "-s [SITE]"
Checks whether the module \fISITE\fR is enabled, The argument is interpreted in
the same way, as for configuration files queried by the \-c switch.
.IP \-v 4
.IX Item "-v"
returns the currently installed Apache 2 HTTP server version
.IP \-q 4
.IX Item "-q"
suppress any output. This is useful to invoke a2query from another script. This
is useful if only the return code is of interest.
.SH "EXIT CODES"
.IX Header "EXIT CODES"
\&\fBa2query\fR returns with a zero (0) exit status if the requested operation was
effectuated successfully and with a non-zero status otherwise. In case of an
error it leaves with error code 32 if a requested module, site or
configuration was not found and 33 if a module, site or configuration was
disabled by a maintainer script. However, exit status 1 is returned if the
module was not found at all
.SH "SEE ALSO"
.IX Header "SEE ALSO"
apache2ctl(8), apache2(8), perl(1)
.SH AUTHOR
.IX Header "AUTHOR"
This manual and a2query was written by Arno Toell <debian@toell.net>.