gsstest: fixed compilation errors
[tridge/bind9.git] / isc-config.sh.docbook
1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3                [<!ENTITY mdash "&#8212;">]>
4 <!--
5  - Copyright (C) 2009  Internet Systems Consortium, Inc. ("ISC")
6  -
7  - Permission to use, copy, modify, and/or distribute this software for any
8  - purpose with or without fee is hereby granted, provided that the above
9  - copyright notice and this permission notice appear in all copies.
10  -
11  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  - PERFORMANCE OF THIS SOFTWARE.
18 -->
19
20 <!-- $Id: isc-config.sh.docbook,v 1.2 2009/02/18 23:47:48 tbox Exp $ -->
21 <refentry id="man.isc-config.sh">
22   <refentryinfo>
23     <date>December 19, 2008</date>
24   </refentryinfo>
25
26   <refmeta>
27     <refentrytitle><application>isc-config.sh</application></refentrytitle>
28     <manvolnum>1</manvolnum>
29     <refmiscinfo>BIND9</refmiscinfo>
30   </refmeta>
31
32   <docinfo>
33     <copyright>
34       <year>2009</year>
35       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
36     </copyright>
37   </docinfo>
38
39   <refnamediv>
40     <refname><application>isc-config.sh</application></refname>
41     <refpurpose>Get information about the installed version of ISC BIND</refpurpose>
42   </refnamediv>
43
44   <refsynopsisdiv>
45     <cmdsynopsis>
46       <command>isc-config.sh</command>
47       <arg><option>--cflags</option></arg>
48       <arg><option>--exec-prefix</option></arg>
49       <arg><option>--libs</option></arg>
50       <arg><option>--prefix</option></arg>
51       <arg><option>--version</option></arg>
52       <arg choice="opt" rep="repeat">libraries</arg>
53     </cmdsynopsis>
54   </refsynopsisdiv>
55
56   <refsect1>
57     <title>DESCRIPTION</title>
58     <para><command>isc-config.sh</command>
59         prints information related to the installed version of ISC BIND,
60         such as the compiler and linker flags required to compile
61         and link programs that use ISC BIND libraries.
62     </para>
63     <para>
64         The optional libraries are used to report specific details
65         for compiling and linking for the listed libraries.
66         The allowed choices are:
67         <option>isc</option>,
68         <option>isccc</option>,
69         <option>isccfg</option>,
70         <option>dns</option>,
71         <option>lwres</option>, and
72         <option>bind9</option>.
73         Multiple libraries may be listed on the command line.
74         (Some libraries require other libraries, so are implied.)
75     </para>
76
77   </refsect1>
78
79   <refsect1>
80     <title>OPTIONS</title>
81
82     <variablelist>
83
84       <varlistentry>
85         <term>--cflags</term>
86         <listitem>
87           <para>
88             Prints the compiler command line options required to
89             compile files that use ISC BIND.
90             Use the <option>libraries</option> command line argument(s)
91             to print additional specific flags to pass to the C compiler.
92           </para>
93         </listitem>
94       </varlistentry>
95
96       <varlistentry>
97         <term>--exec-prefix</term>
98         <listitem>
99           <para>
100             Prints the directory prefix used in the ISC BIND installation
101             for architecture dependent files to standard output.
102           </para>
103         </listitem>
104       </varlistentry>
105
106       <varlistentry>
107         <term>--libs</term>
108         <listitem>
109           <para>
110             Prints the linker command line options used to
111             link with the ISC BIND libraries.
112             Use the <option>libraries</option> command line argument(s)
113             to print additional specific flags.
114           </para>
115         </listitem>
116       </varlistentry>
117
118       <varlistentry>
119         <term>--prefix</term>
120         <listitem>
121           <para>
122             Prints the directory prefix used in the ISC BIND installation
123             for architecture independent files to standard output.
124           </para>
125         </listitem>
126       </varlistentry>
127
128       <varlistentry>
129         <term>--version</term>
130         <listitem>
131           <para>
132             Prints the version of the installed ISC BIND suite.
133           </para>
134         </listitem>
135       </varlistentry>
136
137     </variablelist>
138
139   </refsect1>
140
141   <refsect1>
142     <title>RETURN VALUES</title>
143     <para><command>isc-config.sh</command>
144       returns an exit status of 1 if
145       invoked with invalid arguments or no arguments at all.
146       It returns 0 if information was successfully printed.
147     </para>
148   </refsect1>
149
150   <refsect1>
151     <title>AUTHOR</title>
152     <para><corpauthor>Internet Systems Consortium</corpauthor>
153     </para>
154   </refsect1>
155
156 </refentry><!--
157  - Local variables:
158  - mode: sgml
159  - End:
160 -->