isc-config.sh.docbook 4.5 KB
Newer Older
Lamont Jones's avatar
Lamont Jones committed
1
<!--
2
 - Copyright (C) Internet Systems Consortium, Inc. ("ISC")
Lamont Jones's avatar
Lamont Jones committed
3
 -
4 5 6
 - 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/.
7 8 9
 -
 - See the COPYRIGHT file distributed with this work for additional
 - information regarding copyright ownership.
Lamont Jones's avatar
Lamont Jones committed
10 11
-->

12 13 14 15 16
<!-- 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>
Lamont Jones's avatar
Lamont Jones committed
17
  <refentryinfo>
18 19
    <corpname>ISC</corpname>
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
Lamont Jones's avatar
Lamont Jones committed
20 21 22 23 24 25 26 27 28 29 30
  </refentryinfo>

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

  <docinfo>
    <copyright>
      <year>2009</year>
31
      <year>2014</year>
32 33
      <year>2015</year>
      <year>2016</year>
34
      <year>2018</year>
35
      <year>2019</year>
Lamont Jones's avatar
Lamont Jones committed
36 37 38 39 40 41 42 43 44 45
      <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>
46
    <cmdsynopsis sepchar=" ">
Lamont Jones's avatar
Lamont Jones committed
47
      <command>isc-config.sh</command>
48 49 50 51 52
      <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>
Lamont Jones's avatar
Lamont Jones committed
53 54 55 56
      <arg choice="opt" rep="repeat">libraries</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

57 58
  <refsection><info><title>DESCRIPTION</title></info>

Lamont Jones's avatar
Lamont Jones committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
    <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>

78 79 80
  </refsection>

  <refsection><info><title>OPTIONS</title></info>
Lamont Jones's avatar
Lamont Jones committed
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


    <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>

140 141 142
  </refsection>

  <refsection><info><title>RETURN VALUES</title></info>
Lamont Jones's avatar
Lamont Jones committed
143 144 145 146 147 148

    <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>
149
  </refsection>
Lamont Jones's avatar
Lamont Jones committed
150

151
</refentry>