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

https://bitbucket.org/freebsd/freebsd-head/ · HTML · 113 lines · 96 code · 0 blank · 17 comment · 0 complexity · c19f597db2fae5d7e05f09d00d8f5aa0 MD5 · raw file

  1. <!--
  2. - Copyright (C) 2004, 2005, 2007, 2009 Internet Systems Consortium, Inc. ("ISC")
  3. - Copyright (C) 2000-2002 Internet Software Consortium.
  4. -
  5. - Permission to use, copy, modify, and/or distribute this software for any
  6. - purpose with or without fee is hereby granted, provided that the above
  7. - copyright notice and this permission notice appear in all copies.
  8. -
  9. - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10. - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11. - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12. - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13. - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14. - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15. - PERFORMANCE OF THIS SOFTWARE.
  16. -->
  17. <!-- $Id$ -->
  18. <html>
  19. <head>
  20. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21. <title>named-checkconf</title>
  22. <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  23. </head>
  24. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  25. <a name="man.named-checkconf"></a><div class="titlepage"></div>
  26. <div class="refnamediv">
  27. <h2>Name</h2>
  28. <p><span class="application">named-checkconf</span> &#8212; named configuration file syntax checking tool</p>
  29. </div>
  30. <div class="refsynopsisdiv">
  31. <h2>Synopsis</h2>
  32. <div class="cmdsynopsis"><p><code class="command">named-checkconf</code> [<code class="option">-h</code>] [<code class="option">-v</code>] [<code class="option">-j</code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] {filename} [<code class="option">-p</code>] [<code class="option">-z</code>]</p></div>
  33. </div>
  34. <div class="refsect1" lang="en">
  35. <a name="id2543396"></a><h2>DESCRIPTION</h2>
  36. <p><span><strong class="command">named-checkconf</strong></span>
  37. checks the syntax, but not the semantics, of a
  38. <span><strong class="command">named</strong></span> configuration file. The file is parsed
  39. and checked for syntax errors, along with all files included by it.
  40. If no file is specified, <code class="filename">/etc/named.conf</code> is read
  41. by default.
  42. </p>
  43. <p>
  44. Note: files that <span><strong class="command">named</strong></span> reads in separate
  45. parser contexts, such as <code class="filename">rndc.key</code> and
  46. <code class="filename">bind.keys</code>, are not automatically read
  47. by <span><strong class="command">named-checkconf</strong></span>. Configuration
  48. errors in these files may cause <span><strong class="command">named</strong></span> to
  49. fail to run, even if <span><strong class="command">named-checkconf</strong></span> was
  50. successful. <span><strong class="command">named-checkconf</strong></span> can be run
  51. on these files explicitly, however.
  52. </p>
  53. </div>
  54. <div class="refsect1" lang="en">
  55. <a name="id2543445"></a><h2>OPTIONS</h2>
  56. <div class="variablelist"><dl>
  57. <dt><span class="term">-h</span></dt>
  58. <dd><p>
  59. Print the usage summary and exit.
  60. </p></dd>
  61. <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
  62. <dd><p>
  63. Chroot to <code class="filename">directory</code> so that include
  64. directives in the configuration file are processed as if
  65. run by a similarly chrooted named.
  66. </p></dd>
  67. <dt><span class="term">-v</span></dt>
  68. <dd><p>
  69. Print the version of the <span><strong class="command">named-checkconf</strong></span>
  70. program and exit.
  71. </p></dd>
  72. <dt><span class="term">-p</span></dt>
  73. <dd><p>
  74. Print out the <code class="filename">named.conf</code> and included files
  75. in canonical form if no errors were detected.
  76. </p></dd>
  77. <dt><span class="term">-z</span></dt>
  78. <dd><p>
  79. Perform a test load of all master zones found in
  80. <code class="filename">named.conf</code>.
  81. </p></dd>
  82. <dt><span class="term">-j</span></dt>
  83. <dd><p>
  84. When loading a zonefile read the journal if it exists.
  85. </p></dd>
  86. <dt><span class="term">filename</span></dt>
  87. <dd><p>
  88. The name of the configuration file to be checked. If not
  89. specified, it defaults to <code class="filename">/etc/named.conf</code>.
  90. </p></dd>
  91. </dl></div>
  92. </div>
  93. <div class="refsect1" lang="en">
  94. <a name="id2543569"></a><h2>RETURN VALUES</h2>
  95. <p><span><strong class="command">named-checkconf</strong></span>
  96. returns an exit status of 1 if
  97. errors were detected and 0 otherwise.
  98. </p>
  99. </div>
  100. <div class="refsect1" lang="en">
  101. <a name="id2543580"></a><h2>SEE ALSO</h2>
  102. <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
  103. <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
  104. <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
  105. </p>
  106. </div>
  107. <div class="refsect1" lang="en">
  108. <a name="id2543610"></a><h2>AUTHOR</h2>
  109. <p><span class="corpauthor">Internet Systems Consortium</span>
  110. </p>
  111. </div>
  112. </div></body>
  113. </html>