man-pages/man1/a2query.1.html
2021-03-31 01:06:50 +01:00

126 lines
4.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of A2QUERY.IN</TITLE>
</HEAD><BODY>
<H1>A2QUERY.IN</H1>
Section: User Contributed Perl Documentation (1)<BR>Updated: 2020-08-12<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
a2query - retrieve runtime configuration from a local Apache 2 HTTP server
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>a2query</B> [-m [<I></I><FONT SIZE="-1"><I>MODULE</I></FONT><I></I>]] [-s [<I></I><FONT SIZE="-1"><I>SITE</I></FONT><I></I>]] [-c [<I></I><FONT SIZE="-1"><I>CONF</I></FONT><I></I>]] [-a] [-v]
[-M] [-d] [-h]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>a2query</B> is a program designed to retrieve configuration values from a locally
available Apache 2 <FONT SIZE="-1">HTTP</FONT> web server. It was designed to be as robust as possible
by returning feasible values even if the Apache 2 syntax validator fails.
<P>
This program is primarily meant to be used from maintainer scripts.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1">-a<DD>
Returns the Apache 2 ``Module Magic Version'' (<FONT SIZE="-1">API</FONT> 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.
<DT id="2">-c [<I></I><FONT SIZE="-1"><I>CONF</I></FONT><I></I>]<DD>
Checks whether the configuration <I></I><FONT SIZE="-1"><I>CONF</I></FONT><I></I> is enabled. If no argument was given,
all enabled configuration files are being returned. <I></I><FONT SIZE="-1"><I>CONF</I></FONT><I></I> is compared by
string comparison by ignoring a leading ``mod_'' prefix and possibly a '.conf' or
'.load' suffix.
<DT id="3">-h<DD>
Displays a brief summary how the program can be called and exits.
<DT id="4">-m [<I></I><FONT SIZE="-1"><I>MODULE</I></FONT><I></I>]<DD>
Checks whether the module <I></I><FONT SIZE="-1"><I>MODULE</I></FONT><I></I> is enabled, The argument is interpreted in
the same way, as for configuration files queried by the -c switch.
<DT id="5">-M<DD>
Returns the currently enabled Apache 2 <FONT SIZE="-1">MPM</FONT> (Multi Processing Module).
<DT id="6">-s [<I></I><FONT SIZE="-1"><I>SITE</I></FONT><I></I>]<DD>
Checks whether the module <I></I><FONT SIZE="-1"><I>SITE</I></FONT><I></I> is enabled, The argument is interpreted in
the same way, as for configuration files queried by the -c switch.
<DT id="7">-v<DD>
returns the currently installed Apache 2 <FONT SIZE="-1">HTTP</FONT> server version
<DT id="8">-q<DD>
suppress any output. This is useful to invoke a2query from another script. This
is useful if only the return code is of interest.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>EXIT CODES</H2>
<B>a2query</B> 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
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<A HREF="/cgi-bin/man/man2html?8+apache2ctl">apache2ctl</A>(8), <A HREF="/cgi-bin/man/man2html?8+apache2">apache2</A>(8), <A HREF="/cgi-bin/man/man2html?1+perl">perl</A>(1)
<A NAME="lbAH">&nbsp;</A>
<H2>AUTHOR</H2>
This manual and a2query was written by Arno Toell &lt;<A HREF="mailto:debian@toell.net">debian@toell.net</A>&gt;.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="9"><A HREF="#lbAB">NAME</A><DD>
<DT id="10"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="11"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="12"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="13"><A HREF="#lbAF">EXIT CODES</A><DD>
<DT id="14"><A HREF="#lbAG">SEE ALSO</A><DD>
<DT id="15"><A HREF="#lbAH">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:06 GMT, March 31, 2021
</BODY>
</HTML>