diff options
Diffstat (limited to 'util/ntp-keygen.1')
| -rw-r--r-- | util/ntp-keygen.1 | 72 |
1 files changed, 43 insertions, 29 deletions
diff --git a/util/ntp-keygen.1 b/util/ntp-keygen.1 index 90f8d5cceaec..edf4c75ae1f0 100644 --- a/util/ntp-keygen.1 +++ b/util/ntp-keygen.1 @@ -1,7 +1,7 @@ -.TH NTP-KEYGEN 1 2009-12-08 "(ntp 4.2.4p8)" "Programmer's Manual" +.TH NTP-KEYGEN 1 2011-12-24 "(ntp 4.2.6p5)" "Programmer's Manual" .\" EDIT THIS FILE WITH CAUTION (ntp-keygen.1) .\" -.\" It has been AutoGen-ed Tuesday December 8, 2009 at 08:14:57 AM EST +.\" It has been AutoGen-ed December 24, 2011 at 06:34:45 PM by AutoGen 5.12 .\" From the definitions ntp-keygen-opts.def .\" and the template file agman1.tpl .\" @@ -14,7 +14,7 @@ ntp-keygen \- Create a NTP host key .PP All arguments must be options. .SH "DESCRIPTION" -This manual page documents, briefly, the \fBntp-keygen\fP command. +This manual page briefly documents the \fBntp-keygen\fP command. If there is no new host key, look for an existing one. If one is not found, create it. .SH OPTIONS @@ -22,7 +22,14 @@ If one is not found, create it. .BR \-c " \fIscheme\fP, " \--certificate "=" \fIscheme\fP certificate scheme. .sp -Just some descriptive text. +scheme is one of +RSA-MD2, RSA-MD5, RSA-SHA, RSA-SHA1, RSA-MDC2, RSA-RIPEMD160, +DSA-SHA, or DSA-SHA1. + +Select the certificate message digest/signature encryption scheme. +Note that RSA schemes must be used with a RSA sign key and DSA +schemes must be used with a DSA sign key. The default without +this option is RSA-MD5. .TP .BR \-d ", " \--debug-level Increase output debug message level. @@ -38,39 +45,38 @@ Set the output debugging level. Can be supplied multiple times, but each overrides the previous value(s). .TP .BR \-e ", " \--id-key -Write identity keys. +Write IFF or GQ identity keys. .sp -Just some descriptive text. +Write the IFF or GQ client keys to the standard output. This is +intended for automatic key distribution by mail. .TP .BR \-G ", " \--gq-params Generate GQ parameters and keys. .sp -Just some descriptive text. -.TP -.BR \-g ", " \--gq-keys -update GQ keys. -.sp -Just some descriptive text. +Generate parameters and keys for the GQ identification scheme, +obsoleting any that may exist. .TP .BR \-H ", " \--host-key generate RSA host key. .sp -Just some descriptive text. +Generate new host keys, obsoleting any that may exist. .TP .BR \-I ", " \--iffkey generate IFF parameters. .sp -Just some descriptive text. +Generate parameters for the IFF identification scheme, obsoleting +any that may exist. .TP -.BR \-i ", " \--issuer-name +.BR \-i " \fIissuer-name\fP, " \--issuer-name "=" \fIissuer-name\fP set issuer name. .sp -Just some descriptive text. +Set the suject name to name. This is used as the subject field +in certificates and in the file name for host and sign keys. .TP .BR \-M ", " \--md5key generate MD5 keys. .sp -Just some descriptive text. +Generate MD5 keys, obsoleting any that may exist. .TP .BR \-m " \fImodulus\fP, " \--modulus "=" \fImodulus\fP modulus. @@ -83,52 +89,59 @@ in the range 256 through 2048 .fi .in -4 .sp -Just some descriptive text. +The number of bits in the prime modulus. The default is 512. .TP .BR \-P ", " \--pvt-cert generate PC private certificate. .sp -Just some descriptive text. +Generate a private certificate. By default, the program generates +public certificates. .TP .BR \-p " \fIpasswd\fP, " \--pvt-passwd "=" \fIpasswd\fP output private password. .sp -Just some descriptive text. +Encrypt generated files containing private data with the specified +password and the DES-CBC algorithm. .TP .BR \-q " \fIpasswd\fP, " \--get-pvt-passwd "=" \fIpasswd\fP input private password. .sp -Just some descriptive text. +Set the password for reading files to the specified password. .TP .BR \-S " \fIsign\fP, " \--sign-key "=" \fIsign\fP generate sign key (RSA or DSA). .sp -Just some descriptive text. +Generate a new sign key of the designated type, obsoleting any +that may exist. By default, the program uses the host key as the +sign key. .TP .BR \-s " \fIhost\fP, " \--subject-name "=" \fIhost\fP set subject name. .sp -Just some descriptive text. +Set the issuer name to name. This is used for the issuer field +in certificates and in the file name for identity files. .TP .BR \-T ", " \--trusted-cert trusted certificate (TC scheme). .sp -Just some descriptive text. +Generate a trusted certificate. By default, the program generates +a non-trusted certificate. .TP .BR \-V " \fInum\fP, " \--mv-params "=" \fInum\fP generate <num> MV parameters. This option takes an integer number as its argument. .sp -Just some descriptive text. +Generate parameters and keys for the Mu-Varadharajan (MV) +identification scheme. .TP .BR \-v " \fInum\fP, " \--mv-keys "=" \fInum\fP update <num> MV keys. This option takes an integer number as its argument. .sp -Just some descriptive text. +This option has not been fully documented. .TP .BR \-? , " \--help" -Display usage information and exit. +Display extended usage information and exit. .TP .BR \-! , " \--more-help" Extended usage information passed thru pager. @@ -143,7 +156,7 @@ The \fIno-load-opts\fP form will disable the loading of earlier RC/INI files. \fI--no-load-opts\fP is handled early, out of order. .TP -.BR \-v " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]" +.BR \- " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]" Output version of program and exit. The default mode is `v', a simple version. The `c' mode will print copyright information and `n' will print the full copyright notice. @@ -154,7 +167,7 @@ environment variables named: .nf \fBNTP_KEYGEN_<option-name>\fP or \fBNTP_KEYGEN\fP .fi -.aj +.ad The environmental presets take precedence (are processed later than) the configuration files. The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". @@ -169,6 +182,7 @@ Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org .nf .na see html/copyright.html + .fi .ad .PP |