[BACK]Return to man.rndc-confgen.html CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / external / mpl / bind / dist / doc / arm

Annotation of src/external/mpl/bind/dist/doc/arm/man.rndc-confgen.html, Revision 1.1.1.4

1.1       christos    1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
                      2: <!--
1.1.1.3   christos    3:  - Copyright (C) 2000-2019 Internet Systems Consortium, Inc. ("ISC")
1.1       christos    4:  -
                      5:  - This Source Code Form is subject to the terms of the Mozilla Public
                      6:  - License, v. 2.0. If a copy of the MPL was not distributed with this
                      7:  - file, You can obtain one at http://mozilla.org/MPL/2.0/.
                      8: -->
                      9: <html lang="en">
                     10: <head>
                     11: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                     12: <title>rndc-confgen</title>
                     13: <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
                     14: <link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
                     15: <link rel="up" href="Bv9ARM.ch12.html" title="Manual pages">
                     16: <link rel="prev" href="man.pkcs11-tokens.html" title="pkcs11-tokens">
                     17: <link rel="next" href="man.rndc.conf.html" title="rndc.conf">
                     18: </head>
                     19: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
                     20: <div class="navheader">
                     21: <table width="100%" summary="Navigation header">
                     22: <tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
                     23: <tr>
                     24: <td width="20%" align="left">
                     25: <a accesskey="p" href="man.pkcs11-tokens.html">Prev</a> </td>
                     26: <th width="60%" align="center">Manual pages</th>
                     27: <td width="20%" align="right"> <a accesskey="n" href="man.rndc.conf.html">Next</a>
                     28: </td>
                     29: </tr>
                     30: </table>
                     31: <hr>
                     32: </div>
                     33: <div class="refentry">
                     34: <a name="man.rndc-confgen"></a><div class="titlepage"></div>
                     35:
                     36:
                     37:
                     38:
                     39:
                     40:   <div class="refnamediv">
                     41: <h2>Name</h2>
                     42: <p>
                     43:     <span class="application">rndc-confgen</span>
                     44:      &#8212; rndc key generation tool
                     45:   </p>
                     46: </div>
                     47:
                     48:
                     49:
                     50:   <div class="refsynopsisdiv">
                     51: <h2>Synopsis</h2>
                     52:     <div class="cmdsynopsis"><p>
                     53:       <code class="command">rndc-confgen</code>
                     54:        [<code class="option">-a</code>]
                     55:        [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></code>]
                     56:        [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>]
                     57:        [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>]
                     58:        [<code class="option">-h</code>]
                     59:        [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>]
                     60:        [<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
                     61:        [<code class="option">-s <em class="replaceable"><code>address</code></em></code>]
                     62:        [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>]
                     63:        [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]
                     64:     </p></div>
                     65:   </div>
                     66:
                     67:   <div class="refsection">
                     68: <a name="id-1.13.36.7"></a><h2>DESCRIPTION</h2>
                     69:
                     70:     <p><span class="command"><strong>rndc-confgen</strong></span>
                     71:       generates configuration files
                     72:       for <span class="command"><strong>rndc</strong></span>.  It can be used as a
                     73:       convenient alternative to writing the
                     74:       <code class="filename">rndc.conf</code> file
                     75:       and the corresponding <span class="command"><strong>controls</strong></span>
                     76:       and <span class="command"><strong>key</strong></span>
                     77:       statements in <code class="filename">named.conf</code> by hand.
                     78:       Alternatively, it can be run with the <span class="command"><strong>-a</strong></span>
                     79:       option to set up a <code class="filename">rndc.key</code> file and
                     80:       avoid the need for a <code class="filename">rndc.conf</code> file
                     81:       and a <span class="command"><strong>controls</strong></span> statement altogether.
                     82:     </p>
                     83:
                     84:   </div>
                     85:
                     86:   <div class="refsection">
                     87: <a name="id-1.13.36.8"></a><h2>OPTIONS</h2>
                     88:
                     89:
                     90:     <div class="variablelist"><dl class="variablelist">
                     91: <dt><span class="term">-a</span></dt>
                     92: <dd>
                     93:           <p>
                     94:             Do automatic <span class="command"><strong>rndc</strong></span> configuration.
                     95:             This creates a file <code class="filename">rndc.key</code>
                     96:             in <code class="filename">/etc</code> (or whatever
                     97:             <code class="varname">sysconfdir</code>
                     98:             was specified as when <acronym class="acronym">BIND</acronym> was
                     99:             built)
                    100:             that is read by both <span class="command"><strong>rndc</strong></span>
                    101:             and <span class="command"><strong>named</strong></span> on startup.  The
                    102:             <code class="filename">rndc.key</code> file defines a default
                    103:             command channel and authentication key allowing
                    104:             <span class="command"><strong>rndc</strong></span> to communicate with
                    105:             <span class="command"><strong>named</strong></span> on the local host
                    106:             with no further configuration.
                    107:           </p>
                    108:           <p>
                    109:             Running <span class="command"><strong>rndc-confgen -a</strong></span> allows
                    110:             BIND 9 and <span class="command"><strong>rndc</strong></span> to be used as
                    111:             drop-in
                    112:             replacements for BIND 8 and <span class="command"><strong>ndc</strong></span>,
                    113:             with no changes to the existing BIND 8
                    114:             <code class="filename">named.conf</code> file.
                    115:           </p>
                    116:           <p>
                    117:             If a more elaborate configuration than that
                    118:             generated by <span class="command"><strong>rndc-confgen -a</strong></span>
                    119:             is required, for example if rndc is to be used remotely,
                    120:             you should run <span class="command"><strong>rndc-confgen</strong></span> without
                    121:             the
                    122:             <span class="command"><strong>-a</strong></span> option and set up a
                    123:             <code class="filename">rndc.conf</code> and
                    124:             <code class="filename">named.conf</code>
                    125:             as directed.
                    126:           </p>
                    127:         </dd>
                    128: <dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
                    129: <dd>
                    130:           <p>
                    131:             Specifies the algorithm to use for the TSIG key.  Available
                    132:             choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
                    133:             hmac-sha384 and hmac-sha512.  The default is hmac-sha256.
                    134:           </p>
                    135:         </dd>
                    136: <dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
                    137: <dd>
                    138:           <p>
                    139:             Specifies the size of the authentication key in bits.
                    140:             Must be between 1 and 512 bits; the default is the
                    141:             hash size.
                    142:           </p>
                    143:         </dd>
                    144: <dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
                    145: <dd>
                    146:           <p>
                    147:             Used with the <span class="command"><strong>-a</strong></span> option to specify
                    148:             an alternate location for <code class="filename">rndc.key</code>.
                    149:           </p>
                    150:         </dd>
                    151: <dt><span class="term">-h</span></dt>
                    152: <dd>
                    153:           <p>
                    154:             Prints a short summary of the options and arguments to
                    155:             <span class="command"><strong>rndc-confgen</strong></span>.
                    156:           </p>
                    157:         </dd>
                    158: <dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
                    159: <dd>
                    160:           <p>
                    161:             Specifies the key name of the rndc authentication key.
                    162:             This must be a valid domain name.
                    163:             The default is <code class="constant">rndc-key</code>.
                    164:           </p>
                    165:         </dd>
                    166: <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
                    167: <dd>
                    168:           <p>
                    169:             Specifies the command channel port where <span class="command"><strong>named</strong></span>
                    170:             listens for connections from <span class="command"><strong>rndc</strong></span>.
                    171:             The default is 953.
                    172:           </p>
                    173:         </dd>
                    174: <dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
                    175: <dd>
                    176:           <p>
                    177:             Specifies the IP address where <span class="command"><strong>named</strong></span>
                    178:             listens for command channel connections from
                    179:             <span class="command"><strong>rndc</strong></span>.  The default is the loopback
                    180:             address 127.0.0.1.
                    181:           </p>
                    182:         </dd>
                    183: <dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
                    184: <dd>
                    185:           <p>
                    186:             Used with the <span class="command"><strong>-a</strong></span> option to specify
                    187:             a directory where <span class="command"><strong>named</strong></span> will run
                    188:             chrooted.  An additional copy of the <code class="filename">rndc.key</code>
                    189:             will be written relative to this directory so that
                    190:             it will be found by the chrooted <span class="command"><strong>named</strong></span>.
                    191:           </p>
                    192:         </dd>
                    193: <dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
                    194: <dd>
                    195:           <p>
                    196:             Used with the <span class="command"><strong>-a</strong></span> option to set the
                    197:             owner
                    198:             of the <code class="filename">rndc.key</code> file generated.
                    199:             If
                    200:             <span class="command"><strong>-t</strong></span> is also specified only the file
                    201:             in
                    202:             the chroot area has its owner changed.
                    203:           </p>
                    204:         </dd>
                    205: </dl></div>
                    206:   </div>
                    207:
                    208:   <div class="refsection">
                    209: <a name="id-1.13.36.9"></a><h2>EXAMPLES</h2>
                    210:
                    211:     <p>
                    212:       To allow <span class="command"><strong>rndc</strong></span> to be used with
                    213:       no manual configuration, run
                    214:     </p>
                    215:     <p><strong class="userinput"><code>rndc-confgen -a</code></strong>
                    216:     </p>
                    217:     <p>
                    218:       To print a sample <code class="filename">rndc.conf</code> file and
                    219:       corresponding <span class="command"><strong>controls</strong></span> and <span class="command"><strong>key</strong></span>
                    220:       statements to be manually inserted into <code class="filename">named.conf</code>,
                    221:       run
                    222:     </p>
                    223:     <p><strong class="userinput"><code>rndc-confgen</code></strong>
                    224:     </p>
                    225:   </div>
                    226:
                    227:   <div class="refsection">
                    228: <a name="id-1.13.36.10"></a><h2>SEE ALSO</h2>
                    229:
                    230:     <p><span class="citerefentry">
                    231:         <span class="refentrytitle">rndc</span>(8)
                    232:       </span>,
                    233:       <span class="citerefentry">
                    234:         <span class="refentrytitle">rndc.conf</span>(5)
                    235:       </span>,
                    236:       <span class="citerefentry">
                    237:         <span class="refentrytitle">named</span>(8)
                    238:       </span>,
                    239:       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
                    240:     </p>
                    241:   </div>
                    242:
                    243: </div>
                    244: <div class="navfooter">
                    245: <hr>
                    246: <table width="100%" summary="Navigation footer">
                    247: <tr>
                    248: <td width="40%" align="left">
                    249: <a accesskey="p" href="man.pkcs11-tokens.html">Prev</a> </td>
                    250: <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch12.html">Up</a></td>
                    251: <td width="40%" align="right"> <a accesskey="n" href="man.rndc.conf.html">Next</a>
                    252: </td>
                    253: </tr>
                    254: <tr>
                    255: <td width="40%" align="left" valign="top">
                    256: <span class="application">pkcs11-tokens</span> </td>
                    257: <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
                    258: <td width="40%" align="right" valign="top"> <code class="filename">rndc.conf</code>
                    259: </td>
                    260: </tr>
                    261: </table>
                    262: </div>
1.1.1.4 ! christos  263: <p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.14.1 (Stable Release)</p>
1.1       christos  264: </body>
                    265: </html>

CVSweb <webmaster@jp.NetBSD.org>