named-checkconf.docbook 6.02 KB
Newer Older
Evan Hunt's avatar
Evan Hunt committed
1 2
<!DOCTYPE book [
<!ENTITY mdash "&#8212;">]>
Brian Wellington's avatar
Brian Wellington committed
3
<!--
4
 - Copyright (C) 2000-2002, 2004, 2005, 2007, 2009, 2014-2016  Internet Systems Consortium, Inc. ("ISC")
Brian Wellington's avatar
Brian Wellington committed
5
 -
6 7 8
 - 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/.
Brian Wellington's avatar
Brian Wellington committed
9
-->
10

Evan Hunt's avatar
Evan Hunt committed
11 12 13 14 15
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-checkconf">
  <info>
    <date>2014-01-10</date>
  </info>
16
  <refentryinfo>
Evan Hunt's avatar
Evan Hunt committed
17 18
    <corpname>ISC</corpname>
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
19 20 21 22 23 24 25 26
  </refentryinfo>

  <refmeta>
    <refentrytitle><application>named-checkconf</application></refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

27 28
  <docinfo>
    <copyright>
Mark Andrews's avatar
Mark Andrews committed
29 30 31
      <year>2000</year>
      <year>2001</year>
      <year>2002</year>
32 33
      <year>2004</year>
      <year>2005</year>
Mark Andrews's avatar
Mark Andrews committed
34
      <year>2007</year>
Automatic Updater's avatar
Automatic Updater committed
35
      <year>2009</year>
Mark Andrews's avatar
Mark Andrews committed
36
      <year>2014</year>
37
      <year>2015</year>
38
      <year>2016</year>
39 40 41 42
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

43 44 45 46 47 48
  <refnamediv>
    <refname><application>named-checkconf</application></refname>
    <refpurpose>named configuration file syntax checking tool</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
Evan Hunt's avatar
Evan Hunt committed
49
    <cmdsynopsis sepchar=" ">
50
      <command>named-checkconf</command>
Evan Hunt's avatar
Evan Hunt committed
51 52 53 54 55 56 57 58
      <arg choice="opt" rep="norepeat"><option>-h</option></arg>
      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
      <arg choice="opt" rep="norepeat"><option>-j</option></arg>
      <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
      <arg choice="req" rep="norepeat">filename</arg>
      <arg choice="opt" rep="norepeat"><option>-p</option></arg>
      <arg choice="opt" rep="norepeat"><option>-x</option></arg>
      <arg choice="opt" rep="norepeat"><option>-z</option></arg>
59 60 61
    </cmdsynopsis>
  </refsynopsisdiv>

Evan Hunt's avatar
Evan Hunt committed
62
  <refsection><info><title>DESCRIPTION</title></info>
63

64
    <para><command>named-checkconf</command>
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
      checks the syntax, but not the semantics, of a
      <command>named</command> configuration file.  The file is parsed
      and checked for syntax errors, along with all files included by it.
      If no file is specified, <filename>/etc/named.conf</filename> is read
      by default.
    </para>
    <para>
      Note: files that <command>named</command> reads in separate
      parser contexts, such as <filename>rndc.key</filename> and
      <filename>bind.keys</filename>, are not automatically read
      by <command>named-checkconf</command>.  Configuration
      errors in these files may cause <command>named</command> to
      fail to run, even if <command>named-checkconf</command> was
      successful.  <command>named-checkconf</command> can be run
      on these files explicitly, however.
80
    </para>
Evan Hunt's avatar
Evan Hunt committed
81
  </refsection>
82

Evan Hunt's avatar
Evan Hunt committed
83
  <refsection><info><title>OPTIONS</title></info>
84

85 86 87

    <variablelist>
      <varlistentry>
88 89 90 91 92 93 94 95 96
        <term>-h</term>
        <listitem>
          <para>
            Print the usage summary and exit.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
97
        <term>-t <replaceable class="parameter">directory</replaceable></term>
98 99
        <listitem>
          <para>
100
            Chroot to <filename>directory</filename> so that include
101
            directives in the configuration file are processed as if
102
            run by a similarly chrooted <command>named</command>.
103 104
          </para>
        </listitem>
105 106
      </varlistentry>

107 108
      <varlistentry>
        <term>-v</term>
109 110 111 112 113 114
        <listitem>
          <para>
            Print the version of the <command>named-checkconf</command>
            program and exit.
          </para>
        </listitem>
115 116
      </varlistentry>

117 118 119 120 121 122 123 124 125 126
      <varlistentry>
        <term>-p</term>
        <listitem>
          <para>
	    Print out the <filename>named.conf</filename> and included files
	    in canonical form if no errors were detected.
          </para>
        </listitem>
      </varlistentry>

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
      <varlistentry>
        <term>-x</term>
        <listitem>
          <para>
	    When printing the configuration files in canonical
            form, obscure shared secrets by replacing them with
            strings of question marks ('?'). This allows the
            contents of <filename>named.conf</filename> and related
            files to be shared &mdash; for example, when submitting
            bug reports &mdash; without compromising private data.
            This option cannot be used without <option>-p</option>.
          </para>
        </listitem>
      </varlistentry>

142 143
      <varlistentry>
        <term>-z</term>
144 145
        <listitem>
          <para>
146 147
	    Perform a test load of all master zones found in
	    <filename>named.conf</filename>.
148 149
          </para>
        </listitem>
150 151
      </varlistentry>

152
      <varlistentry>
153
        <term>-j</term>
154 155 156 157 158
        <listitem>
          <para>
            When loading a zonefile read the journal if it exists.
          </para>
        </listitem>
159 160
      </varlistentry>

161 162
      <varlistentry>
        <term>filename</term>
163 164 165 166 167 168
        <listitem>
          <para>
            The name of the configuration file to be checked.  If not
            specified, it defaults to <filename>/etc/named.conf</filename>.
          </para>
        </listitem>
169 170 171 172
      </varlistentry>

    </variablelist>

Evan Hunt's avatar
Evan Hunt committed
173
  </refsection>
174

Evan Hunt's avatar
Evan Hunt committed
175
  <refsection><info><title>RETURN VALUES</title></info>
176

177 178 179 180
    <para><command>named-checkconf</command>
      returns an exit status of 1 if
      errors were detected and 0 otherwise.
    </para>
Evan Hunt's avatar
Evan Hunt committed
181
  </refsection>
182

Evan Hunt's avatar
Evan Hunt committed
183
  <refsection><info><title>SEE ALSO</title></info>
184

185 186
    <para><citerefentry>
        <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
187
      </citerefentry>,
188 189 190
      <citerefentry>
        <refentrytitle>named-checkzone</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
191 192
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
    </para>
Evan Hunt's avatar
Evan Hunt committed
193 194
  </refsection>
</refentry>