contrib/ntp/util/ntp-keygen-opts.texi

   1 @node ntp-keygen Invocation
   2 @section Invoking ntp-keygen
   3 @pindex ntp-keygen
   4 @cindex Create a NTP host key
   5 @ignore
   6 #
   7 # EDIT THIS FILE WITH CAUTION  (ntp-keygen-opts.texi)
   8 #
   9 # It has been AutoGen-ed  Tuesday December  8, 2009 at 08:14:57 AM EST
  10 # From the definitions    ntp-keygen-opts.def
  11 # and the template file   aginfo.tpl
  12 @end ignore
  13 This program has no explanation.
  14
  15 If there is no new host key, look for an existing one.
  16 If one is not found, create it.
  17
  18 This section was generated by @strong{AutoGen},
  19 the aginfo template and the option descriptions for the @command{ntp-keygen} program.  It documents the ntp-keygen usage text and option meanings.
  20
  21 This software is released under a specialized copyright license.
  22
  23 @menu
  24 * ntp-keygen usage::                  ntp-keygen usage help (-?)
  25 * ntp-keygen certificate::            certificate option (-c)
  26 * ntp-keygen debug-level::            debug-level option (-d)
  27 * ntp-keygen get-pvt-passwd::         get-pvt-passwd option (-q)
  28 * ntp-keygen gq-keys::                gq-keys option (-g)
  29 * ntp-keygen gq-params::              gq-params option (-G)
  30 * ntp-keygen host-key::               host-key option (-H)
  31 * ntp-keygen id-key::                 id-key option (-e)
  32 * ntp-keygen iffkey::                 iffkey option (-I)
  33 * ntp-keygen issuer-name::            issuer-name option (-i)
  34 * ntp-keygen md5key::                 md5key option (-M)
  35 * ntp-keygen modulus::                modulus option (-m)
  36 * ntp-keygen mv-keys::                mv-keys option (-v)
  37 * ntp-keygen mv-params::              mv-params option (-V)
  38 * ntp-keygen pvt-cert::               pvt-cert option (-P)
  39 * ntp-keygen pvt-passwd::             pvt-passwd option (-p)
  40 * ntp-keygen set-debug-level::        set-debug-level option (-D)
  41 * ntp-keygen sign-key::               sign-key option (-S)
  42 * ntp-keygen subject-name::           subject-name option (-s)
  43 * ntp-keygen trusted-cert::           trusted-cert option (-T)
  44 @end menu
  45
  46 @node ntp-keygen usage
  47 @subsection ntp-keygen usage help (-?)
  48 @cindex ntp-keygen usage
  49
  50 This is the automatically generated usage text for ntp-keygen:
  51
  52 @exampleindent 0
  53 @example
  54 Using OpenSSL version 90704f
  55 ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.5p247-RC
  56 USAGE:  ntp-keygen [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
  57   Flg Arg Option-Name    Description
  58    -c Str certificate    certificate scheme
  59    -d no  debug-level    Increase output debug message level
  60                                 - may appear multiple times
  61    -D Str set-debug-level Set the output debug message level
  62                                 - may appear multiple times
  63    -e no  id-key         Write IFF or GQ identity keys
  64    -G no  gq-params      Generate GQ parameters and keys
  65    -H no  host-key       generate RSA host key
  66    -I no  iffkey         generate IFF parameters
  67    -i Str issuer-name    set issuer name
  68    -M no  md5key         generate MD5 keys
  69    -m Num modulus        modulus
  70                                 - it must be:  256 to 2048
  71    -P no  pvt-cert       generate PC private certificate
  72    -p Str pvt-passwd     output private password
  73    -q Str get-pvt-passwd input private password
  74    -S Str sign-key       generate sign key (RSA or DSA)
  75    -s Str subject-name   set subject name
  76    -T no  trusted-cert   trusted certificate (TC scheme)
  77    -V Num mv-params      generate <num> MV parameters
  78    -v Num mv-keys        update <num> MV keys
  79       opt version        Output version information and exit
  80    -? no  help           Display extended usage information and exit
  81    -! no  more-help      Extended usage information passed thru pager
  82    -> opt save-opts      Save the option state to a config file
  83    -< Str load-opts      Load options from a config file
  84                                 - disabled as --no-load-opts
  85                                 - may appear multiple times
  86
  87 Options are specified by doubled hyphens and their name
  88 or by a single hyphen and the flag character.
  89
  90 The following option preset mechanisms are supported:
  91  - reading file /users/stenn/.ntprc
  92  - reading file /deacon/backroom/snaps/ntp-stable/util/.ntprc
  93  - examining environment variables named NTP_KEYGEN_*
  94
  95 If there is no new host key, look for an existing one.
  96 If one is not found, create it.
  97
  98 please send bug reports to:  http://bugs.ntp.org, bugs@@ntp.org
  99 @end example
 100 @exampleindent 4
 101
 102 @node ntp-keygen certificate
 103 @subsection certificate option (-c)
 104 @cindex ntp-keygen-certificate
 105
 106 This is the ``certificate scheme'' option.
 107
 108 This option has some usage constraints.  It:
 109 @itemize @bullet
 110 @item
 111 must be compiled in by defining @code{OPENSSL} during the compilation.
 112 @end itemize
 113
 114 Just some descriptive text.
 115
 116 @node ntp-keygen debug-level
 117 @subsection debug-level option (-d)
 118 @cindex ntp-keygen-debug-level
 119
 120 This is the ``increase output debug message level'' option.
 121
 122 This option has some usage constraints.  It:
 123 @itemize @bullet
 124 @item
 125 may appear an unlimited number of times.
 126 @item
 127 must be compiled in by defining @code{DEBUG} during the compilation.
 128 @end itemize
 129
 130 Increase the debugging message output level.
 131
 132 @node ntp-keygen set-debug-level
 133 @subsection set-debug-level option (-D)
 134 @cindex ntp-keygen-set-debug-level
 135
 136 This is the ``set the output debug message level'' option.
 137
 138 This option has some usage constraints.  It:
 139 @itemize @bullet
 140 @item
 141 may appear an unlimited number of times.
 142 @item
 143 must be compiled in by defining @code{DEBUG} during the compilation.
 144 @end itemize
 145
 146 Set the output debugging level.  Can be supplied multiple times,
 147 but each overrides the previous value(s).
 148
 149 @node ntp-keygen id-key
 150 @subsection id-key option (-e)
 151 @cindex ntp-keygen-id-key
 152
 153 This is the ``write identity keys'' option.
 154
 155 This option has some usage constraints.  It:
 156 @itemize @bullet
 157 @item
 158 must be compiled in by defining @code{OPENSSL} during the compilation.
 159 @end itemize
 160
 161 Just some descriptive text.
 162
 163 @node ntp-keygen gq-params
 164 @subsection gq-params option (-G)
 165 @cindex ntp-keygen-gq-params
 166
 167 This is the ``generate gq parameters and keys'' option.
 168
 169 This option has some usage constraints.  It:
 170 @itemize @bullet
 171 @item
 172 must be compiled in by defining @code{OPENSSL} during the compilation.
 173 @end itemize
 174
 175 Just some descriptive text.
 176
 177 @node ntp-keygen gq-keys
 178 @subsection gq-keys option (-g)
 179 @cindex ntp-keygen-gq-keys
 180
 181 This is the ``update gq keys'' option.
 182
 183 This option has some usage constraints.  It:
 184 @itemize @bullet
 185 @item
 186 must be compiled in by defining @code{OPENSSL} during the compilation.
 187 @end itemize
 188
 189 Just some descriptive text.
 190
 191 @node ntp-keygen host-key
 192 @subsection host-key option (-H)
 193 @cindex ntp-keygen-host-key
 194
 195 This is the ``generate rsa host key'' option.
 196
 197 This option has some usage constraints.  It:
 198 @itemize @bullet
 199 @item
 200 must be compiled in by defining @code{OPENSSL} during the compilation.
 201 @end itemize
 202
 203 Just some descriptive text.
 204
 205 @node ntp-keygen iffkey
 206 @subsection iffkey option (-I)
 207 @cindex ntp-keygen-iffkey
 208
 209 This is the ``generate iff parameters'' option.
 210
 211 This option has some usage constraints.  It:
 212 @itemize @bullet
 213 @item
 214 must be compiled in by defining @code{OPENSSL} during the compilation.
 215 @end itemize
 216
 217 Just some descriptive text.
 218
 219 @node ntp-keygen issuer-name
 220 @subsection issuer-name option (-i)
 221 @cindex ntp-keygen-issuer-name
 222
 223 This is the ``set issuer name'' option.
 224
 225 This option has some usage constraints.  It:
 226 @itemize @bullet
 227 @item
 228 must be compiled in by defining @code{OPENSSL} during the compilation.
 229 @end itemize
 230
 231 Just some descriptive text.
 232
 233 @node ntp-keygen md5key
 234 @subsection md5key option (-M)
 235 @cindex ntp-keygen-md5key
 236
 237 This is the ``generate md5 keys'' option.
 238 Just some descriptive text.
 239
 240 @node ntp-keygen modulus
 241 @subsection modulus option (-m)
 242 @cindex ntp-keygen-modulus
 243
 244 This is the ``modulus'' option.
 245
 246 This option has some usage constraints.  It:
 247 @itemize @bullet
 248 @item
 249 must be compiled in by defining @code{OPENSSL} during the compilation.
 250 @end itemize
 251
 252 Just some descriptive text.
 253
 254 @node ntp-keygen pvt-cert
 255 @subsection pvt-cert option (-P)
 256 @cindex ntp-keygen-pvt-cert
 257
 258 This is the ``generate pc private certificate'' option.
 259
 260 This option has some usage constraints.  It:
 261 @itemize @bullet
 262 @item
 263 must be compiled in by defining @code{OPENSSL} during the compilation.
 264 @end itemize
 265
 266 Just some descriptive text.
 267
 268 @node ntp-keygen pvt-passwd
 269 @subsection pvt-passwd option (-p)
 270 @cindex ntp-keygen-pvt-passwd
 271
 272 This is the ``output private password'' option.
 273
 274 This option has some usage constraints.  It:
 275 @itemize @bullet
 276 @item
 277 must be compiled in by defining @code{OPENSSL} during the compilation.
 278 @end itemize
 279
 280 Just some descriptive text.
 281
 282 @node ntp-keygen get-pvt-passwd
 283 @subsection get-pvt-passwd option (-q)
 284 @cindex ntp-keygen-get-pvt-passwd
 285
 286 This is the ``input private password'' option.
 287
 288 This option has some usage constraints.  It:
 289 @itemize @bullet
 290 @item
 291 must be compiled in by defining @code{OPENSSL} during the compilation.
 292 @end itemize
 293
 294 Just some descriptive text.
 295
 296 @node ntp-keygen sign-key
 297 @subsection sign-key option (-S)
 298 @cindex ntp-keygen-sign-key
 299
 300 This is the ``generate sign key (rsa or dsa)'' option.
 301
 302 This option has some usage constraints.  It:
 303 @itemize @bullet
 304 @item
 305 must be compiled in by defining @code{OPENSSL} during the compilation.
 306 @end itemize
 307
 308 Just some descriptive text.
 309
 310 @node ntp-keygen subject-name
 311 @subsection subject-name option (-s)
 312 @cindex ntp-keygen-subject-name
 313
 314 This is the ``set subject name'' option.
 315
 316 This option has some usage constraints.  It:
 317 @itemize @bullet
 318 @item
 319 must be compiled in by defining @code{OPENSSL} during the compilation.
 320 @end itemize
 321
 322 Just some descriptive text.
 323
 324 @node ntp-keygen trusted-cert
 325 @subsection trusted-cert option (-T)
 326 @cindex ntp-keygen-trusted-cert
 327
 328 This is the ``trusted certificate (tc scheme)'' option.
 329
 330 This option has some usage constraints.  It:
 331 @itemize @bullet
 332 @item
 333 must be compiled in by defining @code{OPENSSL} during the compilation.
 334 @end itemize
 335
 336 Just some descriptive text.
 337
 338 @node ntp-keygen mv-params
 339 @subsection mv-params option (-V)
 340 @cindex ntp-keygen-mv-params
 341
 342 This is the ``generate <num> mv parameters'' option.
 343
 344 This option has some usage constraints.  It:
 345 @itemize @bullet
 346 @item
 347 must be compiled in by defining @code{OPENSSL} during the compilation.
 348 @end itemize
 349
 350 Just some descriptive text.
 351
 352 @node ntp-keygen mv-keys
 353 @subsection mv-keys option (-v)
 354 @cindex ntp-keygen-mv-keys
 355
 356 This is the ``update <num> mv keys'' option.
 357
 358 This option has some usage constraints.  It:
 359 @itemize @bullet
 360 @item
 361 must be compiled in by defining @code{OPENSSL} during the compilation.
 362 @end itemize
 363
 364 Just some descriptive text.