external/bsd/bind/dist/contrib/zkt-1.1.3/man/zkt-conf.8.org

   1 .TH zkt-conf 8 "February 22, 2010" "ZKT 1.0" ""
   2 \" turn off hyphenation
   3 .\"     if n .nh
   4 .nh
   5 .SH NAME
   6 zkt-conf \(em Secure DNS zone key config tool
   7
   8 .SH SYNOPSYS
   9 .na
  10 .B zkt-conf
  11 .RB [ \-V|\-\-view
  12 .IR "name" ]
  13 .RB [ \-w|\-\-write ]
  14 .B \-d|\-\-default
  15 .RB [ \-O|\-\-option
  16 .IR "optstr" ]
  17 .br
  18 .B zkt-conf
  19 .RB [ \-V|\-\-view
  20 .IR "name" ]
  21 .RB [ \-w|\-\-write ]
  22 .RB [ \-s ]
  23 .RB [ \-c|\-\-config
  24 .IR "file" ]
  25 .RB [ \-O|\-\-option
  26 .IR "optstr" ]
  27 .br
  28 .B zkt-conf
  29 .RB [ \-V|\-\-view
  30 .IR "name" ]
  31 .RB [ \-w|\-\-write ]
  32 .B  \-l|\-\-local
  33 .RB [ \-c|\-\-config
  34 .IR "file" ]
  35 .RB [ \-O|\-\-option
  36 .IR "optstr" ]
  37
  38 .B zkt-conf
  39 .RB [ \-c
  40 .IR "file" ]
  41 .RB [ \-w|\-\-write ]
  42 .I "zonefile"
  43
  44 .br
  45 .ad
  46
  47 .SH DESCRIPTION
  48 The
  49 .I zkt-conf
  50 command helps to create and show a config file for use by
  51 the Zone Key Tool commands, which are currently
  52 .I dnssec-zkt(8)
  53 and
  54 .IR zkt-signer(8) .
  55 .PP
  56 In general, the ZKT commands uses three sources for the config parameters:
  57 .HP 3
  58 a)
  59 The build-in default parameters
  60 .HP 3
  61 b)
  62 The side wide config file or the file specified with option -c
  63 will overload the built-in vars.
  64 The site wide config file is the file
  65 .I /var/named/dnssec.conf
  66 or the one set by the environment variable ZKT_CONF.
  67 .HP 3
  68 c)
  69 The local config file
  70 .I dnssec.conf
  71 in the current zone directory will also overload the parameters read so far.
  72 .PP
  73 Because of this overloading feature, none of the config files has to have
  74 a complete parameter set.
  75 Typically the local config file will have only those parameters which are
  76 different from the global or built-in ones.
  77 .PP
  78 The default operation of
  79 .I zkt-conf(8)
  80 is to print the site wide config file (same as option
  81 .BR \-s ).
  82 Option
  83 .B \-d
  84 will print out the built-in defaults while
  85 .B \-l
  86 just print the local config parameters which are different to the global ones.
  87 In the last case
  88 .B \-a
  89 gives the complete
  90 .RB ( \-\-all )
  91 parameter list.
  92 .PP
  93 In all forms of the command, the parameters are changeable via option
  94 .B \-O
  95 .RB ( \-\-config-option ).
  96 .PP
  97 With option
  98 .B \-w
  99 .RB ( \-\-write )
 100 the parameters will be written back to the config file.
 101 This is useful in case of an ZKT upgrade or if one or more parameters are changed
 102 by option
 103 .BR \-O .
 104 .PP
 105 Option
 106 .B \-t
 107 checks some of the parameter for reasonable values.
 108 .PP
 109 If the option
 110 .B \-t
 111 is given, all config parameters are checked against reasonable values.
 112 .PP
 113 Which config file is shown (or modified or checked) is determined by option
 114 .B \-d
 115 which means the built-in defaults, option
 116 .B \-l
 117 which means the local config file or
 118 .B \-s
 119 which specifies the site wide config file.
 120 Option
 121 .B \-s
 122 is the default.
 123
 124 .SH GENERAL OPTIONS
 125 .TP
 126 .BI \-V " view" ", \-\-view=" view
 127 Try to read the default configuration out of a file named
 128 .I dnssec-<view>.conf .
 129 Instead of specifying the \-V or \-\-view option every time,
 130 it is also possible to create a hard or softlink to the
 131 executable file to give it an additional name like
 132 .I zkt-conf-<view> .
 133 .TP
 134 .BI \-c " file" ", \-\-config=" file
 135 Read all parameter from the specified config file.
 136 Otherwise the default config file is read or build in defaults
 137 will be used.
 138 .TP
 139 .BI \-O " optstr" ", \-\-config-option=" optstr
 140 Set any config file parameter via the commandline.
 141 Several config file options could be specified at the argument string
 142 but have to be delimited by semicolon (or newline).
 143 .TP
 144 .BR \-a ", " \-\-all
 145 In case of showing the local config file parameter
 146 .RI ( \-l )
 147 print all parameter, not just the ones different o the site wide or built-in defaults.
 148
 149 .SH COMMAND OPTIONS
 150 .TP
 151 .BR \-h ", " \-\-help
 152 Print out the online help.
 153 .TP
 154 .BR \-d ", " \-\-built-in-defaults
 155 List all the built-in default paremeter.
 156 .TP
 157 .BR \-s ", " \-\-sidecfg
 158 List all side wide config parameters (this is the default).
 159 .TP
 160 .BR \-l ", "  \-\-localconf
 161 List all local config parameters which are different to the site-wide config
 162 parameters.
 163 With otion
 164 .B \-a
 165 .RB ( \-\-all )
 166 all config parameters will be shown.
 167
 168
 169 .SH SAMPLE USAGE
 170 .TP
 171 .fam C
 172 .B "zkt-conf \-d
 173 .fam T
 174 Print the built-in default config pars.
 175 .TP
 176 .fam C
 177 .B "zkt-conf \-d \-w
 178 .fam T
 179 Write all the built-in defaults into the site wide config file.
 180 .TP
 181 .fam C
 182 .B "zkt-conf \-s \-\--option "SerialFormat: unixtime; Zonedir: /var/named/zones" "\-w
 183 .fam T
 184 Change two parameters in the site wide dnssec.conf file.
 185
 186 .SH ENVIRONMENT VARIABLES
 187 .TP
 188 ZKT_CONFFILE
 189 Specifies the name of the default global configuration files.
 190
 191 .SH FILES
 192 .TP
 193 .I /var/named/dnssec.conf
 194 Default global configuration file.
 195 The name of the default global config file is settable via
 196 the environment variable ZKT_CONFFILE.
 197 .TP
 198 .I /var/named/dnssec-<view>.conf
 199 View specific global configuration file.
 200 .TP
 201 .I ./dnssec.conf
 202 Local configuration file (additionallx used in
 203 .B \-l
 204 mode).
 205
 206 .SH BUGS
 207 .PP
 208 Some of the general options will not be meaningful in all of the command modes.
 209 .PP
 210
 211 .SH AUTHORS
 212 Holger Zuleger
 213
 214 .SH COPYRIGHT
 215 Copyright (c) 2010 by Holger Zuleger.
 216 Licensed under the BSD Licences. There is NO warranty; not even for MERCHANTABILITY or
 217 FITNESS FOR A PARTICULAR PURPOSE.
 218 .\"--------------------------------------------------
 219 .SH SEE ALSO
 220 dnssec-keygen(8), dnssec-signzone(8), rndc(8), named.conf(5), zkt-signer(8), dnssec-zkt(8),
 221 .br
 222 RFC4641
 223 "DNSSEC Operational Practices" by Miek Gieben and Olaf Kolkman,
 224 .br
 225 DNSSEC HOWTO Tutorial by Olaf Kolkman, RIPE NCC
 226 .br
 227 (http://www.nlnetlabs.nl/dnssec_howto/)