external/bsd/ntp/dist/util/ntp-keygen.1

   1 .TH NTP-KEYGEN 1 2009-12-10 "(ntp 4.2.6)" "Programmer's Manual"
   2 .\"  EDIT THIS FILE WITH CAUTION  (ntp-keygen.1)
   3 .\"
   4 .\"  It has been AutoGen-ed  December 10, 2009 at 05:08:22 AM by AutoGen 5.10
   5 .\"  From the definitions    ntp-keygen-opts.def
   6 .\"  and the template file   agman1.tpl
   7 .\"
   8 .SH NAME
   9 ntp-keygen \- Create a NTP host key
  10 .SH SYNOPSIS
  11 .B ntp-keygen
  12 .\" Mixture of short (flag) options and long options
  13 .RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \--\fIopt-name\fP " [[=| ]\fIvalue\fP]]..."
  14 .PP
  15 All arguments must be options.
  16 .SH "DESCRIPTION"
  17 This manual page briefly documents the \fBntp-keygen\fP command.
  18 If there is no new host key, look for an existing one.
  19 If one is not found, create it.
  20 .SH OPTIONS
  21 .TP
  22 .BR \-c " \fIscheme\fP, " \--certificate "=" \fIscheme\fP
  23 certificate scheme.
  24 .sp
  25 scheme is one of
  26 RSA-MD2, RSA-MD5, RSA-SHA, RSA-SHA1, RSA-MDC2, RSA-RIPEMD160,
  27 DSA-SHA, or DSA-SHA1.
  28
  29 Select the certificate message digest/signature encryption scheme.
  30 Note that RSA schemes must be used with a RSA sign key and DSA
  31 schemes must be used with a DSA sign key.  The default without
  32 this option is RSA-MD5.
  33 .TP
  34 .BR \-d ", " \--debug-level
  35 Increase output debug message level.
  36 This option may appear an unlimited number of times.
  37 .sp
  38 Increase the debugging message output level.
  39 .TP
  40 .BR \-D " \fIstring\fP, " \--set-debug-level "=" \fIstring\fP
  41 Set the output debug message level.
  42 This option may appear an unlimited number of times.
  43 .sp
  44 Set the output debugging level.  Can be supplied multiple times,
  45 but each overrides the previous value(s).
  46 .TP
  47 .BR \-e ", " \--id-key
  48 Write IFF or GQ identity keys.
  49 .sp
  50 Write the IFF or GQ client keys to the standard output.  This is
  51 intended for automatic key distribution by mail.
  52 .TP
  53 .BR \-G ", " \--gq-params
  54 Generate GQ parameters and keys.
  55 .sp
  56 Generate parameters and keys for the GQ identification scheme,
  57 obsoleting any that may exist.
  58 .TP
  59 .BR \-H ", " \--host-key
  60 generate RSA host key.
  61 .sp
  62 Generate new host keys, obsoleting any that may exist.
  63 .TP
  64 .BR \-I ", " \--iffkey
  65 generate IFF parameters.
  66 .sp
  67 Generate parameters for the IFF identification scheme, obsoleting
  68 any that may exist.
  69 .TP
  70 .BR \-i " \fIissuer-name\fP, " \--issuer-name "=" \fIissuer-name\fP
  71 set issuer name.
  72 .sp
  73 Set the suject name to name.  This is used as the subject field
  74 in certificates and in the file name for host and sign keys.
  75 .TP
  76 .BR \-M ", " \--md5key
  77 generate MD5 keys.
  78 .sp
  79 Generate MD5 keys, obsoleting any that may exist.
  80 .TP
  81 .BR \-m " \fImodulus\fP, " \--modulus "=" \fImodulus\fP
  82 modulus.
  83 This option takes an integer number as its argument.
  84 The value of \fImodulus\fP is constrained to being:
  85 .in +4
  86 .nf
  87 .na
  88 in the range  256 through 2048
  89 .fi
  90 .in -4
  91 .sp
  92 The number of bits in the prime modulus.  The default is 512.
  93 .TP
  94 .BR \-P ", " \--pvt-cert
  95 generate PC private certificate.
  96 .sp
  97 Generate a private certificate.  By default, the program generates
  98 public certificates.
  99 .TP
 100 .BR \-p " \fIpasswd\fP, " \--pvt-passwd "=" \fIpasswd\fP
 101 output private password.
 102 .sp
 103 Encrypt generated files containing private data with the specified
 104 password and the DES-CBC algorithm.
 105 .TP
 106 .BR \-q " \fIpasswd\fP, " \--get-pvt-passwd "=" \fIpasswd\fP
 107 input private password.
 108 .sp
 109 Set the password for reading files to the specified password.
 110 .TP
 111 .BR \-S " \fIsign\fP, " \--sign-key "=" \fIsign\fP
 112 generate sign key (RSA or DSA).
 113 .sp
 114 Generate a new sign key of the designated type, obsoleting any
 115 that may exist.  By default, the program uses the host key as the
 116 sign key.
 117 .TP
 118 .BR \-s " \fIhost\fP, " \--subject-name "=" \fIhost\fP
 119 set subject name.
 120 .sp
 121 Set the issuer name to name.  This is used for the issuer field
 122 in certificates and in the file name for identity files.
 123 .TP
 124 .BR \-T ", " \--trusted-cert
 125 trusted certificate (TC scheme).
 126 .sp
 127 Generate a trusted certificate.  By default, the program generates
 128 a non-trusted certificate.
 129 .TP
 130 .BR \-V " \fInum\fP, " \--mv-params "=" \fInum\fP
 131 generate <num> MV parameters.
 132 This option takes an integer number as its argument.
 133 .sp
 134 Generate parameters and keys for the Mu-Varadharajan (MV)
 135 identification scheme.
 136 .TP
 137 .BR \-v " \fInum\fP, " \--mv-keys "=" \fInum\fP
 138 update <num> MV keys.
 139 This option takes an integer number as its argument.
 140 .sp
 141 This option has not been fully documented.
 142 .TP
 143 .BR \-? , " \--help"
 144 Display extended usage information and exit.
 145 .TP
 146 .BR \-! , " \--more-help"
 147 Extended usage information passed thru pager.
 148 .TP
 149 .BR \-> " [\fIrcfile\fP]," " \--save-opts" "[=\fIrcfile\fP]"
 150 Save the option state to \fIrcfile\fP.  The default is the \fIlast\fP
 151 configuration file listed in the \fBOPTION PRESETS\fP section, below.
 152 .TP
 153 .BR \-< " \fIrcfile\fP," " \--load-opts" "=\fIrcfile\fP," " \--no-load-opts"
 154 Load options from \fIrcfile\fP.
 155 The \fIno-load-opts\fP form will disable the loading
 156 of earlier RC/INI files.  \fI--no-load-opts\fP is handled early,
 157 out of order.
 158 .TP
 159 .BR \- " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
 160 Output version of program and exit.  The default mode is `v', a simple
 161 version.  The `c' mode will print copyright information and `n' will
 162 print the full copyright notice.
 163 .SH OPTION PRESETS
 164 Any option that is not marked as \fInot presettable\fP may be preset
 165 by loading values from configuration ("RC" or ".INI") file(s) and values from
 166 environment variables named:
 167 .nf
 168   \fBNTP_KEYGEN_<option-name>\fP or \fBNTP_KEYGEN\fP
 169 .fi
 170 .ad
 171 The environmental presets take precedence (are processed later than)
 172 the configuration files.
 173 The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
 174 If any of these are directories, then the file \fI.ntprc\fP
 175 is searched for within those directories.
 176 .SH AUTHOR
 177 David L. Mills and/or others
 178 .br
 179 Please send bug reports to:  http://bugs.ntp.org, bugs@ntp.org
 180
 181 .PP
 182 .nf
 183 .na
 184 see html/copyright.html
 185 .fi
 186 .ad
 187 .PP
 188 This manual page was \fIAutoGen\fP-erated from the \fBntp-keygen\fP
 189 option definitions.