PageRenderTime 20ms CodeModel.GetById 13ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/contrib/bind9/bin/check/named-checkconf.docbook

https://bitbucket.org/freebsd/freebsd-head/
Unknown | 195 lines | 175 code | 20 blank | 0 comment | 0 complexity | 2cd0a88b687f52bdc64273da6213a9d7 MD5 | raw file
  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) 2004, 2005, 2007, 2009  Internet Systems Consortium, Inc. ("ISC")
  6 - Copyright (C) 2000-2002  Internet Software Consortium.
  7 -
  8 - Permission to use, copy, modify, and/or distribute this software for any
  9 - purpose with or without fee is hereby granted, provided that the above
 10 - copyright notice and this permission notice appear in all copies.
 11 -
 12 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 13 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 14 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 15 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 16 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 17 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 18 - PERFORMANCE OF THIS SOFTWARE.
 19-->
 20
 21<!-- $Id: named-checkconf.docbook,v 1.22 2009/12/28 23:21:16 each Exp $ -->
 22<refentry id="man.named-checkconf">
 23  <refentryinfo>
 24    <date>June 14, 2000</date>
 25  </refentryinfo>
 26
 27  <refmeta>
 28    <refentrytitle><application>named-checkconf</application></refentrytitle>
 29    <manvolnum>8</manvolnum>
 30    <refmiscinfo>BIND9</refmiscinfo>
 31  </refmeta>
 32
 33  <docinfo>
 34    <copyright>
 35      <year>2004</year>
 36      <year>2005</year>
 37      <year>2007</year>
 38      <year>2009</year>
 39      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
 40    </copyright>
 41    <copyright>
 42      <year>2000</year>
 43      <year>2001</year>
 44      <year>2002</year>
 45      <holder>Internet Software Consortium.</holder>
 46    </copyright>
 47  </docinfo>
 48
 49  <refnamediv>
 50    <refname><application>named-checkconf</application></refname>
 51    <refpurpose>named configuration file syntax checking tool</refpurpose>
 52  </refnamediv>
 53
 54  <refsynopsisdiv>
 55    <cmdsynopsis>
 56      <command>named-checkconf</command>
 57      <arg><option>-h</option></arg>
 58      <arg><option>-v</option></arg>
 59      <arg><option>-j</option></arg>
 60      <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
 61      <arg choice="req">filename</arg>
 62      <arg><option>-p</option></arg>
 63      <arg><option>-z</option></arg>
 64    </cmdsynopsis>
 65  </refsynopsisdiv>
 66
 67  <refsect1>
 68    <title>DESCRIPTION</title>
 69    <para><command>named-checkconf</command>
 70      checks the syntax, but not the semantics, of a
 71      <command>named</command> configuration file.  The file is parsed
 72      and checked for syntax errors, along with all files included by it.
 73      If no file is specified, <filename>/etc/named.conf</filename> is read
 74      by default.
 75    </para>
 76    <para>
 77      Note: files that <command>named</command> reads in separate
 78      parser contexts, such as <filename>rndc.key</filename> and
 79      <filename>bind.keys</filename>, are not automatically read
 80      by <command>named-checkconf</command>.  Configuration
 81      errors in these files may cause <command>named</command> to
 82      fail to run, even if <command>named-checkconf</command> was
 83      successful.  <command>named-checkconf</command> can be run
 84      on these files explicitly, however.
 85    </para>
 86  </refsect1>
 87
 88  <refsect1>
 89    <title>OPTIONS</title>
 90
 91    <variablelist>
 92      <varlistentry>
 93        <term>-h</term>
 94        <listitem>
 95          <para>
 96            Print the usage summary and exit.
 97          </para>
 98        </listitem>
 99      </varlistentry>
100
101      <varlistentry>
102        <term>-t <replaceable class="parameter">directory</replaceable></term>
103        <listitem>
104          <para>
105            Chroot to <filename>directory</filename> so that include
106            directives in the configuration file are processed as if
107            run by a similarly chrooted named.
108          </para>
109        </listitem>
110      </varlistentry>
111
112      <varlistentry>
113        <term>-v</term>
114        <listitem>
115          <para>
116            Print the version of the <command>named-checkconf</command>
117            program and exit.
118          </para>
119        </listitem>
120      </varlistentry>
121
122      <varlistentry>
123        <term>-p</term>
124        <listitem>
125          <para>
126	    Print out the <filename>named.conf</filename> and included files
127	    in canonical form if no errors were detected.
128          </para>
129        </listitem>
130      </varlistentry>
131
132      <varlistentry>
133        <term>-z</term>
134        <listitem>
135          <para>
136	    Perform a test load of all master zones found in
137	    <filename>named.conf</filename>.
138          </para>
139        </listitem>
140      </varlistentry>
141
142      <varlistentry>
143        <term>-j</term>
144        <listitem>
145          <para>
146            When loading a zonefile read the journal if it exists.
147          </para>
148        </listitem>
149      </varlistentry>
150
151      <varlistentry>
152        <term>filename</term>
153        <listitem>
154          <para>
155            The name of the configuration file to be checked.  If not
156            specified, it defaults to <filename>/etc/named.conf</filename>.
157          </para>
158        </listitem>
159      </varlistentry>
160
161    </variablelist>
162
163  </refsect1>
164
165  <refsect1>
166    <title>RETURN VALUES</title>
167    <para><command>named-checkconf</command>
168      returns an exit status of 1 if
169      errors were detected and 0 otherwise.
170    </para>
171  </refsect1>
172
173  <refsect1>
174    <title>SEE ALSO</title>
175    <para><citerefentry>
176        <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
177      </citerefentry>,
178      <citerefentry>
179        <refentrytitle>named-checkzone</refentrytitle><manvolnum>8</manvolnum>
180      </citerefentry>,
181      <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
182    </para>
183  </refsect1>
184
185  <refsect1>
186    <title>AUTHOR</title>
187    <para><corpauthor>Internet Systems Consortium</corpauthor>
188    </para>
189  </refsect1>
190
191</refentry><!--
192 - Local variables:
193 - mode: sgml
194 - End:
195-->