external/bsd/bind/dist/bin/confgen/ddns-confgen.8

   1 .\"     $NetBSD$
   2 .\"
   3 .\" Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
   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: ddns-confgen.8,v 1.10 2009/09/19 01:14:52 tbox Exp
  18 .\"
  19 .hy 0
  20 .ad l
  21 .\"     Title: ddns\-confgen
  22 .\"    Author:
  23 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  24 .\"      Date: Jan 29, 2009
  25 .\"    Manual: BIND9
  26 .\"    Source: BIND9
  27 .\"
  28 .TH "DDNS\-CONFGEN" "8" "Jan 29, 2009" "BIND9" "BIND9"
  29 .\" disable hyphenation
  30 .nh
  31 .\" disable justification (adjust text to left margin only)
  32 .ad l
  33 .SH "NAME"
  34 ddns\-confgen \- ddns key generation tool
  35 .SH "SYNOPSIS"
  36 .HP 13
  37 \fBddns\-confgen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\-s\ \fIname\fR | \-z\ \fIzone\fR] [\fB\-q\fR] [name]
  38 .SH "DESCRIPTION"
  39 .PP
  40 \fBddns\-confgen\fR
  41 generates a key for use by
  42 \fBnsupdate\fR
  43 and
  44 \fBnamed\fR. It simplifies configuration of dynamic zones by generating a key and providing the
  45 \fBnsupdate\fR
  46 and
  47 \fBnamed.conf\fR
  48 syntax that will be needed to use it, including an example
  49 \fBupdate\-policy\fR
  50 statement.
  51 .PP
  52 If a domain name is specified on the command line, it will be used in the name of the generated key and in the sample
  53 \fBnamed.conf\fR
  54 syntax. For example,
  55 \fBddns\-confgen example.com\fR
  56 would generate a key called "ddns\-key.example.com", and sample
  57 \fBnamed.conf\fR
  58 command that could be used in the zone definition for "example.com".
  59 .PP
  60 Note that
  61 \fBnamed\fR
  62 itself can configure a local DDNS key for use with
  63 \fBnsupdate \-l\fR.
  64 \fBddns\-confgen\fR
  65 is only needed when a more elaborate configuration is required: for instance, if
  66 \fBnsupdate\fR
  67 is to be used from a remote system.
  68 .SH "OPTIONS"
  69 .PP
  70 \-a \fIalgorithm\fR
  71 .RS 4
  72 Specifies the algorithm to use for the TSIG key. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512. The default is hmac\-sha256.
  73 .RE
  74 .PP
  75 \-h
  76 .RS 4
  77 Prints a short summary of the options and arguments to
  78 \fBddns\-confgen\fR.
  79 .RE
  80 .PP
  81 \-k \fIkeyname\fR
  82 .RS 4
  83 Specifies the key name of the DDNS authentication key. The default is
  84 \fBddns\-key\fR
  85 when neither the
  86 \fB\-s\fR
  87 nor
  88 \fB\-z\fR
  89 option is specified; otherwise, the default is
  90 \fBddns\-key\fR
  91 as a separate label followed by the argument of the option, e.g.,
  92 \fBddns\-key.example.com.\fR
  93 The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods.
  94 .RE
  95 .PP
  96 \-q
  97 .RS 4
  98 Quiet mode: Print only the key, with no explanatory text or usage examples.
  99 .RE
 100 .PP
 101 \-r \fIrandomfile\fR
 102 .RS 4
 103 Specifies a source of random data for generating the authorization. If the operating system does not provide a
 104 \fI/dev/random\fR
 105 or equivalent device, the default source of randomness is keyboard input.
 106 \fIrandomdev\fR
 107 specifies the name of a character device or file containing random data to be used instead of the default. The special value
 108 \fIkeyboard\fR
 109 indicates that keyboard input should be used.
 110 .RE
 111 .PP
 112 \-s \fIname\fR
 113 .RS 4
 114 Single host mode: The example
 115 \fBnamed.conf\fR
 116 text shows how to set an update policy for the specified
 117 \fIname\fR
 118 using the "name" nametype. The default key name is ddns\-key.\fIname\fR. Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name. This option cannot be used with the
 119 \fB\-z\fR
 120 option.
 121 .RE
 122 .PP
 123 \-z \fIzone\fR
 124 .RS 4
 125 zone mode: The example
 126 \fBnamed.conf\fR
 127 text shows how to set an update policy for the specified
 128 \fIzone\fR
 129 using the "zonesub" nametype, allowing updates to all subdomain names within that
 130 \fIzone\fR. This option cannot be used with the
 131 \fB\-s\fR
 132 option.
 133 .RE
 134 .SH "SEE ALSO"
 135 .PP
 136 \fBnsupdate\fR(1),
 137 \fBnamed.conf\fR(5),
 138 \fBnamed\fR(8),
 139 BIND 9 Administrator Reference Manual.
 140 .SH "AUTHOR"
 141 .PP
 142 Internet Systems Consortium
 143 .SH "COPYRIGHT"
 144 Copyright \(co 2009 Internet Systems Consortium, Inc. ("ISC")
 145 .br