1
@node ntp-keygen Invocation
2
@section Invoking ntp-keygen
4
@cindex Create a NTP host key
6
# -*- buffer-read-only: t -*- vi: set ro:
8
# DO NOT EDIT THIS FILE (ntp-keygen-opts.texi)
10
# It has been AutoGen-ed Monday September 10, 2007 at 08:39:22 PM EDT
11
# From the definitions ntp-keygen-opts.def
12
# and the template file aginfo.tpl
14
This program has no explanation.
16
If there is no new host key, look for an existing one.
17
If one is not found, create it.
19
This section was generated by @strong{AutoGen},
20
the aginfo template and the option descriptions for the @command{ntp-keygen} program. It documents the ntp-keygen usage text and option meanings.
22
This software is released under a specialized copyright license.
25
* ntp-keygen usage:: ntp-keygen usage help (-?)
26
* ntp-keygen certificate:: certificate option (-c)
27
* ntp-keygen debug-level:: debug-level option (-d)
28
* ntp-keygen get-pvt-passwd:: get-pvt-passwd option (-q)
29
* ntp-keygen gq-keys:: gq-keys option (-g)
30
* ntp-keygen gq-params:: gq-params option (-G)
31
* ntp-keygen host-key:: host-key option (-H)
32
* ntp-keygen id-key:: id-key option (-e)
33
* ntp-keygen iffkey:: iffkey option (-I)
34
* ntp-keygen issuer-name:: issuer-name option (-i)
35
* ntp-keygen md5key:: md5key option (-M)
36
* ntp-keygen modulus:: modulus option (-m)
37
* ntp-keygen mv-keys:: mv-keys option (-v)
38
* ntp-keygen mv-params:: mv-params option (-V)
39
* ntp-keygen pvt-cert:: pvt-cert option (-P)
40
* ntp-keygen pvt-passwd:: pvt-passwd option (-p)
41
* ntp-keygen set-debug-level:: set-debug-level option (-D)
42
* ntp-keygen sign-key:: sign-key option (-S)
43
* ntp-keygen subject-name:: subject-name option (-s)
44
* ntp-keygen trusted-cert:: trusted-cert option (-T)
47
@node ntp-keygen usage
48
@subsection ntp-keygen usage help (-?)
49
@cindex ntp-keygen usage
51
This is the automatically generated usage text for ntp-keygen:
55
Using OpenSSL version 90704f
56
ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.5p71
57
USAGE: ntp-keygen [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
58
Flg Arg Option-Name Description
59
-c Str certificate certificate scheme
60
-d no debug-level Increase output debug message level
61
- may appear multiple times
62
-D Str set-debug-level Set the output debug message level
63
- may appear multiple times
64
-e no id-key Write identity keys
65
-G no gq-params Generate GQ parameters and keys
66
-g no gq-keys update GQ keys
67
-H no host-key generate RSA host key
68
-I no iffkey generate IFF parameters
69
-i no issuer-name set issuer name
70
-M no md5key generate MD5 keys
71
-m Num modulus modulus
72
it must lie in the range: 256 to 2048
73
-P no pvt-cert generate PC private certificate
74
-p Str pvt-passwd output private password
75
-q Str get-pvt-passwd input private password
76
-S Str sign-key generate sign key (RSA or DSA)
77
-s Str subject-name set subject name
78
-T no trusted-cert trusted certificate (TC scheme)
79
-V Num mv-params generate <num> MV parameters
80
-v Num mv-keys update <num> MV keys
81
-v opt version Output version information and exit
82
-? no help Display usage information and exit
83
-! no more-help Extended usage information passed thru pager
84
-> opt save-opts Save the option state to a config file
85
-< Str load-opts Load options from a config file
86
- disabled as --no-load-opts
87
- may appear multiple times
89
Options are specified by doubled hyphens and their name
90
or by a single hyphen and the flag character.
92
The following option preset mechanisms are supported:
93
- reading file /users/stenn/.ntprc
94
- reading file /deacon/backroom/snaps/ntp-stable/util/.ntprc
95
- examining environment variables named NTP_KEYGEN_*
97
If there is no new host key, look for an existing one.
98
If one is not found, create it.
100
please send bug reports to: http://bugs.ntp.isc.org, bugs@@ntp.org
104
@node ntp-keygen certificate
105
@subsection certificate option (-c)
106
@cindex ntp-keygen-certificate
108
This is the ``certificate scheme'' option.
110
This option has some usage constraints. It:
113
must be compiled in by defining @code{OPENSSL} during the compilation.
116
Just some descriptive text.
118
@node ntp-keygen debug-level
119
@subsection debug-level option (-d)
120
@cindex ntp-keygen-debug-level
122
This is the ``increase output debug message level'' option.
124
This option has some usage constraints. It:
127
may appear an unlimited number of times.
129
must be compiled in by defining @code{DEBUG} during the compilation.
132
Increase the debugging message output level.
134
@node ntp-keygen set-debug-level
135
@subsection set-debug-level option (-D)
136
@cindex ntp-keygen-set-debug-level
138
This is the ``set the output debug message level'' option.
140
This option has some usage constraints. It:
143
may appear an unlimited number of times.
145
must be compiled in by defining @code{DEBUG} during the compilation.
148
Set the output debugging level. Can be supplied multiple times,
149
but each overrides the previous value(s).
151
@node ntp-keygen id-key
152
@subsection id-key option (-e)
153
@cindex ntp-keygen-id-key
155
This is the ``write identity keys'' option.
157
This option has some usage constraints. It:
160
must be compiled in by defining @code{OPENSSL} during the compilation.
163
Just some descriptive text.
165
@node ntp-keygen gq-params
166
@subsection gq-params option (-G)
167
@cindex ntp-keygen-gq-params
169
This is the ``generate gq parameters and keys'' option.
171
This option has some usage constraints. It:
174
must be compiled in by defining @code{OPENSSL} during the compilation.
177
Just some descriptive text.
179
@node ntp-keygen gq-keys
180
@subsection gq-keys option (-g)
181
@cindex ntp-keygen-gq-keys
183
This is the ``update gq keys'' option.
185
This option has some usage constraints. It:
188
must be compiled in by defining @code{OPENSSL} during the compilation.
191
Just some descriptive text.
193
@node ntp-keygen host-key
194
@subsection host-key option (-H)
195
@cindex ntp-keygen-host-key
197
This is the ``generate rsa host key'' option.
199
This option has some usage constraints. It:
202
must be compiled in by defining @code{OPENSSL} during the compilation.
205
Just some descriptive text.
207
@node ntp-keygen iffkey
208
@subsection iffkey option (-I)
209
@cindex ntp-keygen-iffkey
211
This is the ``generate iff parameters'' option.
213
This option has some usage constraints. It:
216
must be compiled in by defining @code{OPENSSL} during the compilation.
219
Just some descriptive text.
221
@node ntp-keygen issuer-name
222
@subsection issuer-name option (-i)
223
@cindex ntp-keygen-issuer-name
225
This is the ``set issuer name'' option.
227
This option has some usage constraints. It:
230
must be compiled in by defining @code{OPENSSL} during the compilation.
233
Just some descriptive text.
235
@node ntp-keygen md5key
236
@subsection md5key option (-M)
237
@cindex ntp-keygen-md5key
239
This is the ``generate md5 keys'' option.
240
Just some descriptive text.
242
@node ntp-keygen modulus
243
@subsection modulus option (-m)
244
@cindex ntp-keygen-modulus
246
This is the ``modulus'' option.
248
This option has some usage constraints. It:
251
must be compiled in by defining @code{OPENSSL} during the compilation.
254
Just some descriptive text.
256
@node ntp-keygen pvt-cert
257
@subsection pvt-cert option (-P)
258
@cindex ntp-keygen-pvt-cert
260
This is the ``generate pc private certificate'' option.
262
This option has some usage constraints. It:
265
must be compiled in by defining @code{OPENSSL} during the compilation.
268
Just some descriptive text.
270
@node ntp-keygen pvt-passwd
271
@subsection pvt-passwd option (-p)
272
@cindex ntp-keygen-pvt-passwd
274
This is the ``output private password'' option.
276
This option has some usage constraints. It:
279
must be compiled in by defining @code{OPENSSL} during the compilation.
282
Just some descriptive text.
284
@node ntp-keygen get-pvt-passwd
285
@subsection get-pvt-passwd option (-q)
286
@cindex ntp-keygen-get-pvt-passwd
288
This is the ``input private password'' option.
290
This option has some usage constraints. It:
293
must be compiled in by defining @code{OPENSSL} during the compilation.
296
Just some descriptive text.
298
@node ntp-keygen sign-key
299
@subsection sign-key option (-S)
300
@cindex ntp-keygen-sign-key
302
This is the ``generate sign key (rsa or dsa)'' option.
304
This option has some usage constraints. It:
307
must be compiled in by defining @code{OPENSSL} during the compilation.
310
Just some descriptive text.
312
@node ntp-keygen subject-name
313
@subsection subject-name option (-s)
314
@cindex ntp-keygen-subject-name
316
This is the ``set subject name'' option.
318
This option has some usage constraints. It:
321
must be compiled in by defining @code{OPENSSL} during the compilation.
324
Just some descriptive text.
326
@node ntp-keygen trusted-cert
327
@subsection trusted-cert option (-T)
328
@cindex ntp-keygen-trusted-cert
330
This is the ``trusted certificate (tc scheme)'' option.
332
This option has some usage constraints. It:
335
must be compiled in by defining @code{OPENSSL} during the compilation.
338
Just some descriptive text.
340
@node ntp-keygen mv-params
341
@subsection mv-params option (-V)
342
@cindex ntp-keygen-mv-params
344
This is the ``generate <num> mv parameters'' option.
346
This option has some usage constraints. It:
349
must be compiled in by defining @code{OPENSSL} during the compilation.
352
Just some descriptive text.
354
@node ntp-keygen mv-keys
355
@subsection mv-keys option (-v)
356
@cindex ntp-keygen-mv-keys
358
This is the ``update <num> mv keys'' option.
360
This option has some usage constraints. It:
363
must be compiled in by defining @code{OPENSSL} during the compilation.
366
Just some descriptive text.