isc-config.sh.docbook revision 19c7b1a0293498a3e36692c59646ed6e15ffc8d0
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User<!--
59602f2a7c4e4809941583bed3e94cd26e628f1aTinderbox User - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater -
c78c39caab4cf8b5daefc9c65878f7f5ed3eb7a0Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
f536382c59dd492a14667b753816d920f9981f1cTinderbox User - purpose with or without fee is hereby granted, provided that the above
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews - copyright notice and this permission notice appear in all copies.
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews -
c57668a2fbbe558c1bd21652813616f2f517c469Tinderbox User - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
03ebc228ee3725738b067b6bd7082a9a731822a1Tinderbox User - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
287a6a8f9040dc43560cd69cddf83bfc0f53b76fTinderbox User - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
8de3f14f1c300c3e1ed99084cc03485b42c92bf1Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
e5a6871cd0635ecdb2bf792316a2d8c53206f4b2Tinderbox User - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
950d203b64f512b85fcc093ee1e9e3e531a1aea3Tinderbox User - PERFORMANCE OF THIS SOFTWARE.
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User-->
03ebc228ee3725738b067b6bd7082a9a731822a1Tinderbox User
3759f10fc543747668b1ca4b4671f35b0dea8445Francis Dupont<!-- Converted by db4-upgrade version 1.0 -->
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.isc-config.sh">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <info>
3759f10fc543747668b1ca4b4671f35b0dea8445Francis Dupont <date>2009-02-18</date>
d5637bdbb931ff79fced3d4858d83212ea58ed15Tinderbox User </info>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refentryinfo>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <corpname>ISC</corpname>
3759f10fc543747668b1ca4b4671f35b0dea8445Francis Dupont <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
d5637bdbb931ff79fced3d4858d83212ea58ed15Tinderbox User </refentryinfo>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <refmeta>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <refentrytitle><application>isc-config.sh</application></refentrytitle>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <manvolnum>1</manvolnum>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews <refmiscinfo>BIND9</refmiscinfo>
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User </refmeta>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <docinfo>
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews <copyright>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews <year>2009</year>
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User <year>2014</year>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <year>2015</year>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews </copyright>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User </docinfo>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User <refnamediv>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <refname><application>isc-config.sh</application></refname>
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox User <refpurpose>Get information about the installed version of ISC BIND</refpurpose>
03ebc228ee3725738b067b6bd7082a9a731822a1Tinderbox User </refnamediv>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt
dc238a06bffa79de141ee7655765e2df91498a8aTinderbox User <refsynopsisdiv>
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews <cmdsynopsis sepchar=" ">
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <command>isc-config.sh</command>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <arg choice="opt" rep="norepeat"><option>--cflags</option></arg>
3759f10fc543747668b1ca4b4671f35b0dea8445Francis Dupont <arg choice="opt" rep="norepeat"><option>--exec-prefix</option></arg>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <arg choice="opt" rep="norepeat"><option>--libs</option></arg>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <arg choice="opt" rep="norepeat"><option>--prefix</option></arg>
dc238a06bffa79de141ee7655765e2df91498a8aTinderbox User <arg choice="opt" rep="norepeat"><option>--version</option></arg>
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews <arg choice="opt" rep="repeat">libraries</arg>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt </cmdsynopsis>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User </refsynopsisdiv>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater
3759f10fc543747668b1ca4b4671f35b0dea8445Francis Dupont <refsection><info><title>DESCRIPTION</title></info>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <para><command>isc-config.sh</command>
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater prints information related to the installed version of ISC BIND,
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews such as the compiler and linker flags required to compile
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User and link programs that use ISC BIND libraries.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews </para>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <para>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater The optional libraries are used to report specific details
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews for compiling and linking for the listed libraries.
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews The allowed choices are:
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User <option>isc</option>,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <option>isccc</option>,
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <option>isccfg</option>,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <option>dns</option>,
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews <option>lwres</option>, and
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <option>bind9</option>.
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews Multiple libraries may be listed on the command line.
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User (Some libraries require other libraries, so are implied.)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews </para>
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox User
03ebc228ee3725738b067b6bd7082a9a731822a1Tinderbox User </refsection>
294e9d4c34462d29a3e766c88f452b46aeb3702fTinderbox User
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User <refsection><info><title>OPTIONS</title></info>
4c6bae917bec70e1fc4d1b761a9765075af78441Tinderbox User
294e9d4c34462d29a3e766c88f452b46aeb3702fTinderbox User
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt <variablelist>
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt <varlistentry>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews <term>--cflags</term>
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User <listitem>
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt <para>
7cc0a5d21ef046bfd630c4769943d896a7d7472cTinderbox User Prints the compiler command line options required to
03ebc228ee3725738b067b6bd7082a9a731822a1Tinderbox User compile files that use ISC BIND.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Use the <option>libraries</option> command line argument(s)
ee11dfc481f2ef6a032a715454f6290961a722d2Tinderbox User to print additional specific flags to pass to the C compiler.
ee11dfc481f2ef6a032a715454f6290961a722d2Tinderbox User </para>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </listitem>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User </varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User <varlistentry>
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews <term>--exec-prefix</term>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <listitem>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User <para>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Prints the directory prefix used in the ISC BIND installation
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User for architecture dependent files to standard output.
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews </para>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </listitem>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User </varlistentry>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <varlistentry>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews <term>--libs</term>
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User <listitem>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <para>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User Prints the linker command line options used to
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews link with the ISC BIND libraries.
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews Use the <option>libraries</option> command line argument(s)
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User to print additional specific flags.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews </para>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User </listitem>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </varlistentry>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews <varlistentry>
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User <term>--prefix</term>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <listitem>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <para>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson Prints the directory prefix used in the ISC BIND installation
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User for architecture independent files to standard output.
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews </para>
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User </listitem>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews </varlistentry>
28a5dd720187fddb16055a0f64b63a7b66f29f64Mark Andrews
03ebc228ee3725738b067b6bd7082a9a731822a1Tinderbox User <varlistentry>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <term>--version</term>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User <listitem>
a450977e98155f6e828fe6f8d52cf24674231831Mark Andrews <para>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews Prints the version of the installed ISC BIND suite.
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews </para>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User </listitem>
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews </varlistentry>
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont </variablelist>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews </refsection>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refsection><info><title>RETURN VALUES</title></info>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User
5747235bf35e7398984fd6b4632743396895ea7aTinderbox User <para><command>isc-config.sh</command>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews returns an exit status of 1 if
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews invoked with invalid arguments or no arguments at all.
a03cb08d0c4f1ca5fbc121d2f02bdffa7eb52286Mark Andrews It returns 0 if information was successfully printed.
827f8cccb5280f4da66c46186e792d1cb9d73503Mark Andrews </para>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews </refsection>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User</refentry>
5747235bf35e7398984fd6b4632743396895ea7aTinderbox User