summaryrefslogtreecommitdiffstats
path: root/isc-config.sh.docbook
blob: d98d7d59a70763b3458d12a4778e325d58dfeac7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<!--
 - Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 -
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
 -
 - See the COPYRIGHT file distributed with this work for additional
 - information regarding copyright ownership.
-->

<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="man.isc-config.sh">
  <info>
    <date>2009-02-18</date>
  </info>
  <refentryinfo>
    <corpname>ISC</corpname>
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
  </refentryinfo>

  <refmeta>
    <refentrytitle><application>isc-config.sh</application></refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

  <docinfo>
    <copyright>
      <year>2009</year>
      <year>2014</year>
      <year>2015</year>
      <year>2016</year>
      <year>2018</year>
      <year>2019</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refnamediv>
    <refname><application>isc-config.sh</application></refname>
    <refpurpose>Get information about the installed version of ISC BIND</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis sepchar=" ">
      <command>isc-config.sh</command>
      <arg choice="opt" rep="norepeat"><option>--cflags</option></arg>
      <arg choice="opt" rep="norepeat"><option>--exec-prefix</option></arg>
      <arg choice="opt" rep="norepeat"><option>--libs</option></arg>
      <arg choice="opt" rep="norepeat"><option>--prefix</option></arg>
      <arg choice="opt" rep="norepeat"><option>--version</option></arg>
      <arg choice="opt" rep="repeat">libraries</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection><info><title>DESCRIPTION</title></info>

    <para><command>isc-config.sh</command>
	prints information related to the installed version of ISC BIND,
	such as the compiler and linker flags required to compile
	and link programs that use ISC BIND libraries.
    </para>
    <para>
	The optional libraries are used to report specific details
	for compiling and linking for the listed libraries.
	The allowed choices are:
        <option>isc</option>,
        <option>isccc</option>,
        <option>isccfg</option>,
        <option>dns</option>,
        <option>lwres</option>, and
        <option>bind9</option>.
	Multiple libraries may be listed on the command line.
	(Some libraries require other libraries, so are implied.)
    </para>

  </refsection>

  <refsection><info><title>OPTIONS</title></info>


    <variablelist>

      <varlistentry>
        <term>--cflags</term>
        <listitem>
          <para>
            Prints the compiler command line options required to
            compile files that use ISC BIND.
            Use the <option>libraries</option> command line argument(s)
            to print additional specific flags to pass to the C compiler.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>--exec-prefix</term>
        <listitem>
          <para>
            Prints the directory prefix used in the ISC BIND installation
            for architecture dependent files to standard output.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>--libs</term>
        <listitem>
          <para>
            Prints the linker command line options used to
            link with the ISC BIND libraries.
            Use the <option>libraries</option> command line argument(s)
            to print additional specific flags.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>--prefix</term>
        <listitem>
          <para>
            Prints the directory prefix used in the ISC BIND installation
            for architecture independent files to standard output.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>--version</term>
        <listitem>
          <para>
            Prints the version of the installed ISC BIND suite.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsection>

  <refsection><info><title>RETURN VALUES</title></info>

    <para><command>isc-config.sh</command>
      returns an exit status of 1 if
      invoked with invalid arguments or no arguments at all.
      It returns 0 if information was successfully printed.
    </para>
  </refsection>

</refentry>