isc-config.sh.docbook revision 14a656f94b1fd0ababd84a772228dfa52276ba15
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed<!--
938440694b33cd752e9e4b71a526368b4811c177Tinderbox User - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed -
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - Permission to use, copy, modify, and/or distribute this software for any
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - purpose with or without fee is hereby granted, provided that the above
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - copyright notice and this permission notice appear in all copies.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed -
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed - PERFORMANCE OF THIS SOFTWARE.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed-->
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!-- Converted by db4-upgrade version 1.0 -->
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.isc-config.sh">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <info>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <date>2009-02-18</date>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </info>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <refentryinfo>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <corpname>ISC</corpname>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </refentryinfo>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <refmeta>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <refentrytitle><application>isc-config.sh</application></refentrytitle>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <manvolnum>1</manvolnum>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <refmiscinfo>BIND9</refmiscinfo>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </refmeta>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <docinfo>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <copyright>
87a58323be6bc89b50c216ac01c3e92f4721ab7cAutomatic Updater <year>2009</year>
938440694b33cd752e9e4b71a526368b4811c177Tinderbox User <year>2014</year>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </copyright>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </docinfo>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <refnamediv>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <refname><application>isc-config.sh</application></refname>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <refpurpose>Get information about the installed version of ISC BIND</refpurpose>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </refnamediv>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <refsynopsisdiv>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <cmdsynopsis sepchar=" ">
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <command>isc-config.sh</command>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>--cflags</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>--exec-prefix</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>--libs</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>--prefix</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>--version</option></arg>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <arg choice="opt" rep="repeat">libraries</arg>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </cmdsynopsis>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </refsynopsisdiv>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refsection><info><title>DESCRIPTION</title></info>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <para><command>isc-config.sh</command>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed prints information related to the installed version of ISC BIND,
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed such as the compiler and linker flags required to compile
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed and link programs that use ISC BIND libraries.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed The optional libraries are used to report specific details
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed for compiling and linking for the listed libraries.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed The allowed choices are:
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <option>isc</option>,
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <option>isccc</option>,
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <option>isccfg</option>,
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <option>dns</option>,
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <option>lwres</option>, and
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <option>bind9</option>.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed Multiple libraries may be listed on the command line.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed (Some libraries require other libraries, so are implied.)
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refsection><info><title>OPTIONS</title></info>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <variablelist>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <term>--cflags</term>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed Prints the compiler command line options required to
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed compile files that use ISC BIND.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed Use the <option>libraries</option> command line argument(s)
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed to print additional specific flags to pass to the C compiler.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <term>--exec-prefix</term>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed Prints the directory prefix used in the ISC BIND installation
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed for architecture dependent files to standard output.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <term>--libs</term>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed Prints the linker command line options used to
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed link with the ISC BIND libraries.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed Use the <option>libraries</option> command line argument(s)
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed to print additional specific flags.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <term>--prefix</term>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed Prints the directory prefix used in the ISC BIND installation
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed for architecture independent files to standard output.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <term>--version</term>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed Prints the version of the installed ISC BIND suite.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </para>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </listitem>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </varlistentry>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </variablelist>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refsection><info><title>RETURN VALUES</title></info>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed <para><command>isc-config.sh</command>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed returns an exit status of 1 if
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed invoked with invalid arguments or no arguments at all.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed It returns 0 if information was successfully printed.
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed </para>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
6db1357c34f26079dc2516b02d712df228e3db99Jeremy Reed
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt</refentry>