diff options
Diffstat (limited to 'util/ntp-keygen-opts.texi')
| -rw-r--r-- | util/ntp-keygen-opts.texi | 217 |
1 files changed, 108 insertions, 109 deletions
diff --git a/util/ntp-keygen-opts.texi b/util/ntp-keygen-opts.texi index d54e9ba5a102..a907c0e7bde9 100644 --- a/util/ntp-keygen-opts.texi +++ b/util/ntp-keygen-opts.texi @@ -6,7 +6,7 @@ # # EDIT THIS FILE WITH CAUTION (ntp-keygen-opts.texi) # -# 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 aginfo.tpl @end ignore @@ -16,31 +16,30 @@ If there is no new host key, look for an existing one. If one is not found, create it. This section was generated by @strong{AutoGen}, -the aginfo template and the option descriptions for the @command{ntp-keygen} program. It documents the ntp-keygen usage text and option meanings. +the aginfo template and the option descriptions for the @command{ntp-keygen} program. It documents the @command{ntp-keygen} usage text and option meanings. This software is released under a specialized copyright license. @menu * ntp-keygen usage:: ntp-keygen usage help (-?) -* ntp-keygen certificate:: certificate option (-c) -* ntp-keygen debug-level:: debug-level option (-d) -* ntp-keygen get-pvt-passwd:: get-pvt-passwd option (-q) -* ntp-keygen gq-keys:: gq-keys option (-g) -* ntp-keygen gq-params:: gq-params option (-G) -* ntp-keygen host-key:: host-key option (-H) -* ntp-keygen id-key:: id-key option (-e) -* ntp-keygen iffkey:: iffkey option (-I) -* ntp-keygen issuer-name:: issuer-name option (-i) -* ntp-keygen md5key:: md5key option (-M) -* ntp-keygen modulus:: modulus option (-m) -* ntp-keygen mv-keys:: mv-keys option (-v) -* ntp-keygen mv-params:: mv-params option (-V) -* ntp-keygen pvt-cert:: pvt-cert option (-P) -* ntp-keygen pvt-passwd:: pvt-passwd option (-p) -* ntp-keygen set-debug-level:: set-debug-level option (-D) -* ntp-keygen sign-key:: sign-key option (-S) -* ntp-keygen subject-name:: subject-name option (-s) -* ntp-keygen trusted-cert:: trusted-cert option (-T) +* ntp-keygen certificate:: certificate option (-c) +* ntp-keygen debug-level:: debug-level option (-d) +* ntp-keygen get-pvt-passwd:: get-pvt-passwd option (-q) +* ntp-keygen gq-params:: gq-params option (-G) +* ntp-keygen host-key:: host-key option (-H) +* ntp-keygen id-key:: id-key option (-e) +* ntp-keygen iffkey:: iffkey option (-I) +* ntp-keygen issuer-name:: issuer-name option (-i) +* ntp-keygen md5key:: md5key option (-M) +* ntp-keygen modulus:: modulus option (-m) +* ntp-keygen mv-keys:: mv-keys option (-v) +* ntp-keygen mv-params:: mv-params option (-V) +* ntp-keygen pvt-cert:: pvt-cert option (-P) +* ntp-keygen pvt-passwd:: pvt-passwd option (-p) +* ntp-keygen set-debug-level:: set-debug-level option (-D) +* ntp-keygen sign-key:: sign-key option (-S) +* ntp-keygen subject-name:: subject-name option (-s) +* ntp-keygen trusted-cert:: trusted-cert option (-T) @end menu @node ntp-keygen usage @@ -51,8 +50,7 @@ This is the automatically generated usage text for ntp-keygen: @exampleindent 0 @example -Using OpenSSL version 90704f -ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.5p247-RC +ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.6p5 USAGE: ntp-keygen [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... Flg Arg Option-Name Description -c Str certificate certificate scheme @@ -67,7 +65,8 @@ USAGE: ntp-keygen [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... -i Str issuer-name set issuer name -M no md5key generate MD5 keys -m Num modulus modulus - - it must be: 256 to 2048 + - It must be in the range: + 256 to 2048 -P no pvt-cert generate PC private certificate -p Str pvt-passwd output private password -q Str get-pvt-passwd input private password @@ -84,16 +83,16 @@ USAGE: ntp-keygen [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... - disabled as --no-load-opts - may appear multiple times -Options are specified by doubled hyphens and their name -or by a single hyphen and the flag character. +Options are specified by doubled hyphens and their name or by a single +hyphen and the flag character. The following option preset mechanisms are supported: - - reading file /users/stenn/.ntprc - - reading file /deacon/backroom/snaps/ntp-stable/util/.ntprc + - reading file $HOME/.ntprc + - reading file ./.ntprc - examining environment variables named NTP_KEYGEN_* -If there is no new host key, look for an existing one. -If one is not found, create it. +If there is no new host key, look for an existing one. If one is not +found, create it. please send bug reports to: http://bugs.ntp.org, bugs@@ntp.org @end example @@ -111,7 +110,14 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -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. @node ntp-keygen debug-level @subsection debug-level option (-d) @@ -123,34 +129,15 @@ This option has some usage constraints. It: @itemize @bullet @item may appear an unlimited number of times. -@item -must be compiled in by defining @code{DEBUG} during the compilation. @end itemize Increase the debugging message output level. -@node ntp-keygen set-debug-level -@subsection set-debug-level option (-D) -@cindex ntp-keygen-set-debug-level - -This is the ``set the output debug message level'' option. - -This option has some usage constraints. It: -@itemize @bullet -@item -may appear an unlimited number of times. -@item -must be compiled in by defining @code{DEBUG} during the compilation. -@end itemize - -Set the output debugging level. Can be supplied multiple times, -but each overrides the previous value(s). - -@node ntp-keygen id-key -@subsection id-key option (-e) -@cindex ntp-keygen-id-key +@node ntp-keygen get-pvt-passwd +@subsection get-pvt-passwd option (-q) +@cindex ntp-keygen-get-pvt-passwd -This is the ``write identity keys'' option. +This is the ``input private password'' option. This option has some usage constraints. It: @itemize @bullet @@ -158,7 +145,7 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -Just some descriptive text. +Set the password for reading files to the specified password. @node ntp-keygen gq-params @subsection gq-params option (-G) @@ -172,13 +159,14 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -Just some descriptive text. +Generate parameters and keys for the GQ identification scheme, +obsoleting any that may exist. -@node ntp-keygen gq-keys -@subsection gq-keys option (-g) -@cindex ntp-keygen-gq-keys +@node ntp-keygen host-key +@subsection host-key option (-H) +@cindex ntp-keygen-host-key -This is the ``update gq keys'' option. +This is the ``generate rsa host key'' option. This option has some usage constraints. It: @itemize @bullet @@ -186,13 +174,13 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -Just some descriptive text. +Generate new host keys, obsoleting any that may exist. -@node ntp-keygen host-key -@subsection host-key option (-H) -@cindex ntp-keygen-host-key +@node ntp-keygen id-key +@subsection id-key option (-e) +@cindex ntp-keygen-id-key -This is the ``generate rsa host key'' option. +This is the ``write iff or gq identity keys'' option. This option has some usage constraints. It: @itemize @bullet @@ -200,7 +188,8 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -Just some descriptive text. +Write the IFF or GQ client keys to the standard output. This is +intended for automatic key distribution by mail. @node ntp-keygen iffkey @subsection iffkey option (-I) @@ -214,7 +203,8 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -Just some descriptive text. +Generate parameters for the IFF identification scheme, obsoleting +any that may exist. @node ntp-keygen issuer-name @subsection issuer-name option (-i) @@ -228,14 +218,15 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -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. @node ntp-keygen md5key @subsection md5key option (-M) @cindex ntp-keygen-md5key This is the ``generate md5 keys'' option. -Just some descriptive text. +Generate MD5 keys, obsoleting any that may exist. @node ntp-keygen modulus @subsection modulus option (-m) @@ -249,7 +240,36 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -Just some descriptive text. +The number of bits in the prime modulus. The default is 512. + +@node ntp-keygen mv-keys +@subsection mv-keys option (-v) +@cindex ntp-keygen-mv-keys + +This is the ``update <num> mv keys'' option. + +This option has some usage constraints. It: +@itemize @bullet +@item +must be compiled in by defining @code{OPENSSL} during the compilation. +@end itemize + +This option has no @samp{doc} documentation. + +@node ntp-keygen mv-params +@subsection mv-params option (-V) +@cindex ntp-keygen-mv-params + +This is the ``generate <num> mv parameters'' option. + +This option has some usage constraints. It: +@itemize @bullet +@item +must be compiled in by defining @code{OPENSSL} during the compilation. +@end itemize + +Generate parameters and keys for the Mu-Varadharajan (MV) +identification scheme. @node ntp-keygen pvt-cert @subsection pvt-cert option (-P) @@ -263,7 +283,8 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -Just some descriptive text. +Generate a private certificate. By default, the program generates +public certificates. @node ntp-keygen pvt-passwd @subsection pvt-passwd option (-p) @@ -277,21 +298,23 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -Just some descriptive text. +Encrypt generated files containing private data with the specified +password and the DES-CBC algorithm. -@node ntp-keygen get-pvt-passwd -@subsection get-pvt-passwd option (-q) -@cindex ntp-keygen-get-pvt-passwd +@node ntp-keygen set-debug-level +@subsection set-debug-level option (-D) +@cindex ntp-keygen-set-debug-level -This is the ``input private password'' option. +This is the ``set the output debug message level'' option. This option has some usage constraints. It: @itemize @bullet @item -must be compiled in by defining @code{OPENSSL} during the compilation. +may appear an unlimited number of times. @end itemize -Just some descriptive text. +Set the output debugging level. Can be supplied multiple times, +but each overrides the previous value(s). @node ntp-keygen sign-key @subsection sign-key option (-S) @@ -305,7 +328,9 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -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. @node ntp-keygen subject-name @subsection subject-name option (-s) @@ -319,7 +344,8 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -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. @node ntp-keygen trusted-cert @subsection trusted-cert option (-T) @@ -333,32 +359,5 @@ This option has some usage constraints. It: must be compiled in by defining @code{OPENSSL} during the compilation. @end itemize -Just some descriptive text. - -@node ntp-keygen mv-params -@subsection mv-params option (-V) -@cindex ntp-keygen-mv-params - -This is the ``generate <num> mv parameters'' option. - -This option has some usage constraints. It: -@itemize @bullet -@item -must be compiled in by defining @code{OPENSSL} during the compilation. -@end itemize - -Just some descriptive text. - -@node ntp-keygen mv-keys -@subsection mv-keys option (-v) -@cindex ntp-keygen-mv-keys - -This is the ``update <num> mv keys'' option. - -This option has some usage constraints. It: -@itemize @bullet -@item -must be compiled in by defining @code{OPENSSL} during the compilation. -@end itemize - -Just some descriptive text. +Generate a trusted certificate. By default, the program generates +a non-trusted certificate. |