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

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 364 lines · 279 code · 85 blank · 0 comment · 0 complexity · 180cbfc4314af34a2fe0d3093ab5e3ef MD5 · raw file

  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. If there is no new host key, look for an existing one.
  15. If one is not found, create it.
  16. This section was generated by @strong{AutoGen},
  17. the aginfo template and the option descriptions for the @command{ntp-keygen} program. It documents the ntp-keygen usage text and option meanings.
  18. This software is released under a specialized copyright license.
  19. @menu
  20. * ntp-keygen usage:: ntp-keygen usage help (-?)
  21. * ntp-keygen certificate:: certificate option (-c)
  22. * ntp-keygen debug-level:: debug-level option (-d)
  23. * ntp-keygen get-pvt-passwd:: get-pvt-passwd option (-q)
  24. * ntp-keygen gq-keys:: gq-keys option (-g)
  25. * ntp-keygen gq-params:: gq-params option (-G)
  26. * ntp-keygen host-key:: host-key option (-H)
  27. * ntp-keygen id-key:: id-key option (-e)
  28. * ntp-keygen iffkey:: iffkey option (-I)
  29. * ntp-keygen issuer-name:: issuer-name option (-i)
  30. * ntp-keygen md5key:: md5key option (-M)
  31. * ntp-keygen modulus:: modulus option (-m)
  32. * ntp-keygen mv-keys:: mv-keys option (-v)
  33. * ntp-keygen mv-params:: mv-params option (-V)
  34. * ntp-keygen pvt-cert:: pvt-cert option (-P)
  35. * ntp-keygen pvt-passwd:: pvt-passwd option (-p)
  36. * ntp-keygen set-debug-level:: set-debug-level option (-D)
  37. * ntp-keygen sign-key:: sign-key option (-S)
  38. * ntp-keygen subject-name:: subject-name option (-s)
  39. * ntp-keygen trusted-cert:: trusted-cert option (-T)
  40. @end menu
  41. @node ntp-keygen usage
  42. @subsection ntp-keygen usage help (-?)
  43. @cindex ntp-keygen usage
  44. This is the automatically generated usage text for ntp-keygen:
  45. @exampleindent 0
  46. @example
  47. Using OpenSSL version 90704f
  48. ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.5p247-RC
  49. USAGE: ntp-keygen [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
  50. Flg Arg Option-Name Description
  51. -c Str certificate certificate scheme
  52. -d no debug-level Increase output debug message level
  53. - may appear multiple times
  54. -D Str set-debug-level Set the output debug message level
  55. - may appear multiple times
  56. -e no id-key Write IFF or GQ identity keys
  57. -G no gq-params Generate GQ parameters and keys
  58. -H no host-key generate RSA host key
  59. -I no iffkey generate IFF parameters
  60. -i Str issuer-name set issuer name
  61. -M no md5key generate MD5 keys
  62. -m Num modulus modulus
  63. - it must be: 256 to 2048
  64. -P no pvt-cert generate PC private certificate
  65. -p Str pvt-passwd output private password
  66. -q Str get-pvt-passwd input private password
  67. -S Str sign-key generate sign key (RSA or DSA)
  68. -s Str subject-name set subject name
  69. -T no trusted-cert trusted certificate (TC scheme)
  70. -V Num mv-params generate <num> MV parameters
  71. -v Num mv-keys update <num> MV keys
  72. opt version Output version information and exit
  73. -? no help Display extended usage information and exit
  74. -! no more-help Extended usage information passed thru pager
  75. -> opt save-opts Save the option state to a config file
  76. -< Str load-opts Load options from a config file
  77. - disabled as --no-load-opts
  78. - may appear multiple times
  79. Options are specified by doubled hyphens and their name
  80. or by a single hyphen and the flag character.
  81. The following option preset mechanisms are supported:
  82. - reading file /users/stenn/.ntprc
  83. - reading file /deacon/backroom/snaps/ntp-stable/util/.ntprc
  84. - examining environment variables named NTP_KEYGEN_*
  85. If there is no new host key, look for an existing one.
  86. If one is not found, create it.
  87. please send bug reports to: http://bugs.ntp.org, bugs@@ntp.org
  88. @end example
  89. @exampleindent 4
  90. @node ntp-keygen certificate
  91. @subsection certificate option (-c)
  92. @cindex ntp-keygen-certificate
  93. This is the ``certificate scheme'' option.
  94. This option has some usage constraints. It:
  95. @itemize @bullet
  96. @item
  97. must be compiled in by defining @code{OPENSSL} during the compilation.
  98. @end itemize
  99. Just some descriptive text.
  100. @node ntp-keygen debug-level
  101. @subsection debug-level option (-d)
  102. @cindex ntp-keygen-debug-level
  103. This is the ``increase output debug message level'' option.
  104. This option has some usage constraints. It:
  105. @itemize @bullet
  106. @item
  107. may appear an unlimited number of times.
  108. @item
  109. must be compiled in by defining @code{DEBUG} during the compilation.
  110. @end itemize
  111. Increase the debugging message output level.
  112. @node ntp-keygen set-debug-level
  113. @subsection set-debug-level option (-D)
  114. @cindex ntp-keygen-set-debug-level
  115. This is the ``set the output debug message level'' option.
  116. This option has some usage constraints. It:
  117. @itemize @bullet
  118. @item
  119. may appear an unlimited number of times.
  120. @item
  121. must be compiled in by defining @code{DEBUG} during the compilation.
  122. @end itemize
  123. Set the output debugging level. Can be supplied multiple times,
  124. but each overrides the previous value(s).
  125. @node ntp-keygen id-key
  126. @subsection id-key option (-e)
  127. @cindex ntp-keygen-id-key
  128. This is the ``write identity keys'' option.
  129. This option has some usage constraints. It:
  130. @itemize @bullet
  131. @item
  132. must be compiled in by defining @code{OPENSSL} during the compilation.
  133. @end itemize
  134. Just some descriptive text.
  135. @node ntp-keygen gq-params
  136. @subsection gq-params option (-G)
  137. @cindex ntp-keygen-gq-params
  138. This is the ``generate gq parameters and keys'' option.
  139. This option has some usage constraints. It:
  140. @itemize @bullet
  141. @item
  142. must be compiled in by defining @code{OPENSSL} during the compilation.
  143. @end itemize
  144. Just some descriptive text.
  145. @node ntp-keygen gq-keys
  146. @subsection gq-keys option (-g)
  147. @cindex ntp-keygen-gq-keys
  148. This is the ``update gq keys'' option.
  149. This option has some usage constraints. It:
  150. @itemize @bullet
  151. @item
  152. must be compiled in by defining @code{OPENSSL} during the compilation.
  153. @end itemize
  154. Just some descriptive text.
  155. @node ntp-keygen host-key
  156. @subsection host-key option (-H)
  157. @cindex ntp-keygen-host-key
  158. This is the ``generate rsa host key'' option.
  159. This option has some usage constraints. It:
  160. @itemize @bullet
  161. @item
  162. must be compiled in by defining @code{OPENSSL} during the compilation.
  163. @end itemize
  164. Just some descriptive text.
  165. @node ntp-keygen iffkey
  166. @subsection iffkey option (-I)
  167. @cindex ntp-keygen-iffkey
  168. This is the ``generate iff parameters'' option.
  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. Just some descriptive text.
  175. @node ntp-keygen issuer-name
  176. @subsection issuer-name option (-i)
  177. @cindex ntp-keygen-issuer-name
  178. This is the ``set issuer name'' option.
  179. This option has some usage constraints. It:
  180. @itemize @bullet
  181. @item
  182. must be compiled in by defining @code{OPENSSL} during the compilation.
  183. @end itemize
  184. Just some descriptive text.
  185. @node ntp-keygen md5key
  186. @subsection md5key option (-M)
  187. @cindex ntp-keygen-md5key
  188. This is the ``generate md5 keys'' option.
  189. Just some descriptive text.
  190. @node ntp-keygen modulus
  191. @subsection modulus option (-m)
  192. @cindex ntp-keygen-modulus
  193. This is the ``modulus'' option.
  194. This option has some usage constraints. It:
  195. @itemize @bullet
  196. @item
  197. must be compiled in by defining @code{OPENSSL} during the compilation.
  198. @end itemize
  199. Just some descriptive text.
  200. @node ntp-keygen pvt-cert
  201. @subsection pvt-cert option (-P)
  202. @cindex ntp-keygen-pvt-cert
  203. This is the ``generate pc private certificate'' option.
  204. This option has some usage constraints. It:
  205. @itemize @bullet
  206. @item
  207. must be compiled in by defining @code{OPENSSL} during the compilation.
  208. @end itemize
  209. Just some descriptive text.
  210. @node ntp-keygen pvt-passwd
  211. @subsection pvt-passwd option (-p)
  212. @cindex ntp-keygen-pvt-passwd
  213. This is the ``output private password'' option.
  214. This option has some usage constraints. It:
  215. @itemize @bullet
  216. @item
  217. must be compiled in by defining @code{OPENSSL} during the compilation.
  218. @end itemize
  219. Just some descriptive text.
  220. @node ntp-keygen get-pvt-passwd
  221. @subsection get-pvt-passwd option (-q)
  222. @cindex ntp-keygen-get-pvt-passwd
  223. This is the ``input private password'' option.
  224. This option has some usage constraints. It:
  225. @itemize @bullet
  226. @item
  227. must be compiled in by defining @code{OPENSSL} during the compilation.
  228. @end itemize
  229. Just some descriptive text.
  230. @node ntp-keygen sign-key
  231. @subsection sign-key option (-S)
  232. @cindex ntp-keygen-sign-key
  233. This is the ``generate sign key (rsa or dsa)'' option.
  234. This option has some usage constraints. It:
  235. @itemize @bullet
  236. @item
  237. must be compiled in by defining @code{OPENSSL} during the compilation.
  238. @end itemize
  239. Just some descriptive text.
  240. @node ntp-keygen subject-name
  241. @subsection subject-name option (-s)
  242. @cindex ntp-keygen-subject-name
  243. This is the ``set subject name'' option.
  244. This option has some usage constraints. It:
  245. @itemize @bullet
  246. @item
  247. must be compiled in by defining @code{OPENSSL} during the compilation.
  248. @end itemize
  249. Just some descriptive text.
  250. @node ntp-keygen trusted-cert
  251. @subsection trusted-cert option (-T)
  252. @cindex ntp-keygen-trusted-cert
  253. This is the ``trusted certificate (tc scheme)'' option.
  254. This option has some usage constraints. It:
  255. @itemize @bullet
  256. @item
  257. must be compiled in by defining @code{OPENSSL} during the compilation.
  258. @end itemize
  259. Just some descriptive text.
  260. @node ntp-keygen mv-params
  261. @subsection mv-params option (-V)
  262. @cindex ntp-keygen-mv-params
  263. This is the ``generate <num> mv parameters'' option.
  264. This option has some usage constraints. It:
  265. @itemize @bullet
  266. @item
  267. must be compiled in by defining @code{OPENSSL} during the compilation.
  268. @end itemize
  269. Just some descriptive text.
  270. @node ntp-keygen mv-keys
  271. @subsection mv-keys option (-v)
  272. @cindex ntp-keygen-mv-keys
  273. This is the ``update <num> mv keys'' option.
  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. Just some descriptive text.