PageRenderTime 53ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/bind-9.9.1-P1/bin/named/named.html

#
HTML | 309 lines | 292 code | 0 blank | 17 comment | 0 complexity | a0bbbb1eea498a2735267e662a3f27b7 MD5 | raw file
Possible License(s): BSD-3-Clause, ISC 
    

  1. <!--
    2. 

  2.  - Copyright (C) 2004-2009, 2011 Internet Systems Consortium, Inc. ("ISC")
    3. 

  3.  - Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
    4. 

  4.  - 
    5. 

  5.  - Permission to use, copy, modify, and/or distribute this software for any
    6. 

  6.  - purpose with or without fee is hereby granted, provided that the above
    7. 

  7.  - copyright notice and this permission notice appear in all copies.
    8. 

  8.  - 
    9. 

  9.  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
    10. 

  10.  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
    11. 

  11.  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
    12. 

  12.  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
    13. 

  13.  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
    14. 

  14.  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
    15. 

  15.  - PERFORMANCE OF THIS SOFTWARE.
    16. 

  16. -->
    17. 

  17. <!-- $Id$ -->
    18. 

  18. <html>
    19. 

  19. <head>
    20. 

  20. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
    21. 

  21. <title>named</title>
    22. 

  22. <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
    23. 

  23. </head>
    24. 

  24. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
    25. 

  25. <a name="man.named"></a><div class="titlepage"></div>
    26. 

  26. <div class="refnamediv">
    27. 

  27. <h2>Name</h2>
    28. 

  28. <p><span class="application">named</span> &#8212; Internet domain name server</p>
    29. 

  29. </div>
    30. 

  30. <div class="refsynopsisdiv">
    31. 

  31. <h2>Synopsis</h2>
    32. 

  32. <div class="cmdsynopsis"><p><code class="command">named</code>  [<code class="option">-4</code>] [<code class="option">-6</code>] [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>debug-level</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine-name</code></em></code>] [<code class="option">-f</code>] [<code class="option">-g</code>] [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-n <em class="replaceable"><code>#cpus</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-s</code>] [<code class="option">-S <em class="replaceable"><code>#max-socks</code></em></code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-U <em class="replaceable"><code>#listeners</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>] [<code class="option">-v</code>] [<code class="option">-V</code>] [<code class="option">-x <em class="replaceable"><code>cache-file</code></em></code>]</p></div>
    33. 

  33. </div>
    34. 

  34. <div class="refsect1" lang="en">
    35. 

  35. <a name="id2543494"></a><h2>DESCRIPTION</h2>
    36. 

  36. <p><span><strong class="command">named</strong></span>
    37. 

  37.       is a Domain Name System (DNS) server,
    38. 

  38.       part of the BIND 9 distribution from ISC.  For more
    39. 

  39.       information on the DNS, see RFCs 1033, 1034, and 1035.
    40. 

  40.     </p>
    41. 

  41. <p>
    42. 

  42.       When invoked without arguments, <span><strong class="command">named</strong></span>
    43. 

  43.       will
    44. 

  44.       read the default configuration file
    45. 

  45.       <code class="filename">/etc/named.conf</code>, read any initial
    46. 

  46.       data, and listen for queries.
    47. 

  47.     </p>
    48. 

  48. </div>
    49. 

  49. <div class="refsect1" lang="en">
    50. 

  50. <a name="id2543518"></a><h2>OPTIONS</h2>
    51. 

  51. <div class="variablelist"><dl>
    52. 

  52. <dt><span class="term">-4</span></dt>
    53. 

  53. <dd><p>
    54. 

  54.             Use IPv4 only even if the host machine is capable of IPv6.
    55. 

  55.             <code class="option">-4</code> and <code class="option">-6</code> are mutually
    56. 

  56.             exclusive.
    57. 

  57.           </p></dd>
    58. 

  58. <dt><span class="term">-6</span></dt>
    59. 

  59. <dd><p>
    60. 

  60.             Use IPv6 only even if the host machine is capable of IPv4.
    61. 

  61.             <code class="option">-4</code> and <code class="option">-6</code> are mutually
    62. 

  62.             exclusive.
    63. 

  63.           </p></dd>
    64. 

  64. <dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
    65. 

  65. <dd><p>
    66. 

  66.             Use <em class="replaceable"><code>config-file</code></em> as the
    67. 

  67.             configuration file instead of the default,
    68. 

  68.             <code class="filename">/etc/named.conf</code>.  To
    69. 

  69.             ensure that reloading the configuration file continues
    70. 

  70.             to work after the server has changed its working
    71. 

  71.             directory due to to a possible
    72. 

  72.             <code class="option">directory</code> option in the configuration
    73. 

  73.             file, <em class="replaceable"><code>config-file</code></em> should be
    74. 

  74.             an absolute pathname.
    75. 

  75.           </p></dd>
    76. 

  76. <dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt>
    77. 

  77. <dd><p>
    78. 

  78.             Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>.
    79. 

  79.             Debugging traces from <span><strong class="command">named</strong></span> become
    80. 

  80.             more verbose as the debug level increases.
    81. 

  81.           </p></dd>
    82. 

  82. <dt><span class="term">-E <em class="replaceable"><code>engine-name</code></em></span></dt>
    83. 

  83. <dd><p>
    84. 

  84.             Use a crypto hardware (OpenSSL engine) for the crypto operations
    85. 

  85.             it supports, for instance re-signing with private keys from
    86. 

  86.             a secure key store. When compiled with PKCS#11 support
    87. 

  87.             <em class="replaceable"><code>engine-name</code></em>
    88. 

  88.             defaults to pkcs11, the empty name resets it to no engine.
    89. 

  89.           </p></dd>
    90. 

  90. <dt><span class="term">-f</span></dt>
    91. 

  91. <dd><p>
    92. 

  92.             Run the server in the foreground (i.e. do not daemonize).
    93. 

  93.           </p></dd>
    94. 

  94. <dt><span class="term">-g</span></dt>
    95. 

  95. <dd><p>
    96. 

  96.             Run the server in the foreground and force all logging
    97. 

  97.             to <code class="filename">stderr</code>.
    98. 

  98.           </p></dd>
    99. 

  99. <dt><span class="term">-m <em class="replaceable"><code>flag</code></em></span></dt>
    100. 

  100. <dd><p>
    101. 

  101. 	    Turn on memory usage debugging flags.  Possible flags are
    102. 

  102. 	    <em class="replaceable"><code>usage</code></em>,
    103. 

  103. 	    <em class="replaceable"><code>trace</code></em>,
    104. 

  104. 	    <em class="replaceable"><code>record</code></em>,
    105. 

  105. 	    <em class="replaceable"><code>size</code></em>, and
    106. 

  106. 	    <em class="replaceable"><code>mctx</code></em>.
    107. 

  107. 	    These correspond to the ISC_MEM_DEBUGXXXX flags described in
    108. 

  108. 	    <code class="filename">&lt;isc/mem.h&gt;</code>.
    109. 

  109.           </p></dd>
    110. 

  110. <dt><span class="term">-n <em class="replaceable"><code>#cpus</code></em></span></dt>
    111. 

  111. <dd><p>
    112. 

  112.             Create <em class="replaceable"><code>#cpus</code></em> worker threads
    113. 

  113.             to take advantage of multiple CPUs.  If not specified,
    114. 

  114.             <span><strong class="command">named</strong></span> will try to determine the
    115. 

  115.             number of CPUs present and create one thread per CPU.
    116. 

  116.             If it is unable to determine the number of CPUs, a
    117. 

  117.             single worker thread will be created.
    118. 

  118.           </p></dd>
    119. 

  119. <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
    120. 

  120. <dd><p>
    121. 

  121.             Listen for queries on port <em class="replaceable"><code>port</code></em>.  If not
    122. 

  122.             specified, the default is port 53.
    123. 

  123.           </p></dd>
    124. 

  124. <dt><span class="term">-s</span></dt>
    125. 

  125. <dd>
    126. 

  126. <p>
    127. 

  127.             Write memory usage statistics to <code class="filename">stdout</code> on exit.
    128. 

  128.           </p>
    129. 

  129. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
    130. 

  130. <h3 class="title">Note</h3>
    131. 

  131. <p>
    132. 

  132.               This option is mainly of interest to BIND 9 developers
    133. 

  133.               and may be removed or changed in a future release.
    134. 

  134.             </p>
    135. 

  135. </div>
    136. 

  136. </dd>
    137. 

  137. <dt><span class="term">-S <em class="replaceable"><code>#max-socks</code></em></span></dt>
    138. 

  138. <dd>
    139. 

  139. <p>
    140. 

  140. 	    Allow <span><strong class="command">named</strong></span> to use up to
    141. 

  141. 	    <em class="replaceable"><code>#max-socks</code></em> sockets.
    142. 

  142. 	  </p>
    143. 

  143. <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
    144. 

  144. <h3 class="title">Warning</h3>
    145. 

  145. <p>
    146. 

  146.               This option should be unnecessary for the vast majority
    147. 

  147.               of users.
    148. 

  148. 	      The use of this option could even be harmful because the
    149. 

  149.               specified value may exceed the limitation of the
    150. 

  150.               underlying system API.
    151. 

  151. 	      It is therefore set only when the default configuration
    152. 

  152.               causes exhaustion of file descriptors and the
    153. 

  153.               operational environment is known to support the
    154. 

  154.               specified number of sockets.
    155. 

  155. 	      Note also that the actual maximum number is normally a little
    156. 

  156.               fewer than the specified value because
    157. 

  157. 	      <span><strong class="command">named</strong></span> reserves some file descriptors
    158. 

  158. 	      for its internal use.
    159. 

  159.             </p>
    160. 

  160. </div>
    161. 

  161. </dd>
    162. 

  162. <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
    163. 

  163. <dd>
    164. 

  164. <p>Chroot
    165. 

  165. 	    to <em class="replaceable"><code>directory</code></em> after
    166. 

  166.             processing the command line arguments, but before
    167. 

  167.             reading the configuration file.
    168. 

  168.           </p>
    169. 

  169. <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
    170. 

  170. <h3 class="title">Warning</h3>
    171. 

  171. <p>
    172. 

  172.               This option should be used in conjunction with the
    173. 

  173.               <code class="option">-u</code> option, as chrooting a process
    174. 

  174.               running as root doesn't enhance security on most
    175. 

  175.               systems; the way <code class="function">chroot(2)</code> is
    176. 

  176.               defined allows a process with root privileges to
    177. 

  177.               escape a chroot jail.
    178. 

  178.             </p>
    179. 

  179. </div>
    180. 

  180. </dd>
    181. 

  181. <dt><span class="term">-U <em class="replaceable"><code>#listeners</code></em></span></dt>
    182. 

  182. <dd><p>
    183. 

  183.             Use <em class="replaceable"><code>#listeners</code></em>
    184. 

  184.             worker threads to listen for incoming UDP packets on each
    185. 

  185.             address.  If not specified, <span><strong class="command">named</strong></span> will
    186. 

  186.             use all of the worker threads for this purpose; the
    187. 

  187.             <code class="option">-U</code> option allows the number to be
    188. 

  188.             decreased but not increased.
    189. 

  189.           </p></dd>
    190. 

  190. <dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
    191. 

  191. <dd>
    192. 

  192. <p>Setuid
    193. 

  193. 	    to <em class="replaceable"><code>user</code></em> after completing
    194. 

  194.             privileged operations, such as creating sockets that
    195. 

  195.             listen on privileged ports.
    196. 

  196.           </p>
    197. 

  197. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
    198. 

  198. <h3 class="title">Note</h3>
    199. 

  199. <p>
    200. 

  200.               On Linux, <span><strong class="command">named</strong></span> uses the kernel's
    201. 

  201.               		capability mechanism to drop all root privileges
    202. 

  202.               except the ability to <code class="function">bind(2)</code> to
    203. 

  203.               a
    204. 

  204.               privileged port and set process resource limits.
    205. 

  205.               Unfortunately, this means that the <code class="option">-u</code>
    206. 

  206.               option only works when <span><strong class="command">named</strong></span> is
    207. 

  207.               run
    208. 

  208.               on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or
    209. 

  209.               later, since previous kernels did not allow privileges
    210. 

  210.               to be retained after <code class="function">setuid(2)</code>.
    211. 

  211.             </p>
    212. 

  212. </div>
    213. 

  213. </dd>
    214. 

  214. <dt><span class="term">-v</span></dt>
    215. 

  215. <dd><p>
    216. 

  216.             Report the version number and exit.
    217. 

  217.           </p></dd>
    218. 

  218. <dt><span class="term">-V</span></dt>
    219. 

  219. <dd><p>
    220. 

  220.             Report the version number and build options, and exit.
    221. 

  221.           </p></dd>
    222. 

  222. <dt><span class="term">-x <em class="replaceable"><code>cache-file</code></em></span></dt>
    223. 

  223. <dd>
    224. 

  224. <p>
    225. 

  225.             Load data from <em class="replaceable"><code>cache-file</code></em> into the
    226. 

  226.             cache of the default view.
    227. 

  227.           </p>
    228. 

  228. <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
    229. 

  229. <h3 class="title">Warning</h3>
    230. 

  230. <p>
    231. 

  231.               This option must not be used.  It is only of interest
    232. 

  232.               to BIND 9 developers and may be removed or changed in a
    233. 

  233.               future release.
    234. 

  234.             </p>
    235. 

  235. </div>
    236. 

  236. </dd>
    237. 

  237. </dl></div>
    238. 

  238. </div>
    239. 

  239. <div class="refsect1" lang="en">
    240. 

  240. <a name="id2544005"></a><h2>SIGNALS</h2>
    241. 

  241. <p>
    242. 

  242.       In routine operation, signals should not be used to control
    243. 

  243.       the nameserver; <span><strong class="command">rndc</strong></span> should be used
    244. 

  244.       instead.
    245. 

  245.     </p>
    246. 

  246. <div class="variablelist"><dl>
    247. 

  247. <dt><span class="term">SIGHUP</span></dt>
    248. 

  248. <dd><p>
    249. 

  249.             Force a reload of the server.
    250. 

  250.           </p></dd>
    251. 

  251. <dt><span class="term">SIGINT, SIGTERM</span></dt>
    252. 

  252. <dd><p>
    253. 

  253.             Shut down the server.
    254. 

  254.           </p></dd>
    255. 

  255. </dl></div>
    256. 

  256. <p>
    257. 

  257.       The result of sending any other signals to the server is undefined.
    258. 

  258.     </p>
    259. 

  259. </div>
    260. 

  260. <div class="refsect1" lang="en">
    261. 

  261. <a name="id2544053"></a><h2>CONFIGURATION</h2>
    262. 

  262. <p>
    263. 

  263.       The <span><strong class="command">named</strong></span> configuration file is too complex
    264. 

  264.       to describe in detail here.  A complete description is provided
    265. 

  265.       in the
    266. 

  266.       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
    267. 

  267.     </p>
    268. 

  268. <p>
    269. 

  269.       <span><strong class="command">named</strong></span> inherits the <code class="function">umask</code>
    270. 

  270.       (file creation mode mask) from the parent process. If files
    271. 

  271.       created by <span><strong class="command">named</strong></span>, such as journal files,
    272. 

  272.       need to have custom permissions, the <code class="function">umask</code>
    273. 

  273.       should be set explicitly in the script used to start the
    274. 

  274.       <span><strong class="command">named</strong></span> process.
    275. 

  275.     </p>
    276. 

  276. </div>
    277. 

  277. <div class="refsect1" lang="en">
    278. 

  278. <a name="id2544089"></a><h2>FILES</h2>
    279. 

  279. <div class="variablelist"><dl>
    280. 

  280. <dt><span class="term"><code class="filename">/etc/named.conf</code></span></dt>
    281. 

  281. <dd><p>
    282. 

  282.             The default configuration file.
    283. 

  283.           </p></dd>
    284. 

  284. <dt><span class="term"><code class="filename">/var/run/named/named.pid</code></span></dt>
    285. 

  285. <dd><p>
    286. 

  286.             The default process-id file.
    287. 

  287.           </p></dd>
    288. 

  288. </dl></div>
    289. 

  289. </div>
    290. 

  290. <div class="refsect1" lang="en">
    291. 

  291. <a name="id2544265"></a><h2>SEE ALSO</h2>
    292. 

  292. <p><em class="citetitle">RFC 1033</em>,
    293. 

  293.       <em class="citetitle">RFC 1034</em>,
    294. 

  294.       <em class="citetitle">RFC 1035</em>,
    295. 

  295.       <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
    296. 

  296.       <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
    297. 

  297.       <span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
    298. 

  298.       <span class="citerefentry"><span class="refentrytitle">lwresd</span>(8)</span>,
    299. 

  299.       <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
    300. 

  300.       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
    301. 

  301.     </p>
    302. 

  302. </div>
    303. 

  303. <div class="refsect1" lang="en">
    304. 

  304. <a name="id2544336"></a><h2>AUTHOR</h2>
    305. 

  305. <p><span class="corpauthor">Internet Systems Consortium</span>
    306. 

  306.     </p>
    307. 

  307. </div>
    308. 

  308. </div></body>
    309. 

  309. </html>
    310. 

  310.