/contrib/ntp/util/ntp-keygen.1

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 176 lines · 175 code · 1 blank · 0 comment · 0 complexity · 8adb3d5984db0cee208866033145ac34 MD5 · raw file

  1. .TH NTP-KEYGEN 1 2009-12-08 "(ntp 4.2.4p8)" "Programmer's Manual"
  2. .\" EDIT THIS FILE WITH CAUTION (ntp-keygen.1)
  3. .\"
  4. .\" It has been AutoGen-ed Tuesday December 8, 2009 at 08:14:57 AM EST
  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 documents, briefly, 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. Just some descriptive text.
  26. .TP
  27. .BR \-d ", " \--debug-level
  28. Increase output debug message level.
  29. This option may appear an unlimited number of times.
  30. .sp
  31. Increase the debugging message output level.
  32. .TP
  33. .BR \-D " \fIstring\fP, " \--set-debug-level "=" \fIstring\fP
  34. Set the output debug message level.
  35. This option may appear an unlimited number of times.
  36. .sp
  37. Set the output debugging level. Can be supplied multiple times,
  38. but each overrides the previous value(s).
  39. .TP
  40. .BR \-e ", " \--id-key
  41. Write identity keys.
  42. .sp
  43. Just some descriptive text.
  44. .TP
  45. .BR \-G ", " \--gq-params
  46. Generate GQ parameters and keys.
  47. .sp
  48. Just some descriptive text.
  49. .TP
  50. .BR \-g ", " \--gq-keys
  51. update GQ keys.
  52. .sp
  53. Just some descriptive text.
  54. .TP
  55. .BR \-H ", " \--host-key
  56. generate RSA host key.
  57. .sp
  58. Just some descriptive text.
  59. .TP
  60. .BR \-I ", " \--iffkey
  61. generate IFF parameters.
  62. .sp
  63. Just some descriptive text.
  64. .TP
  65. .BR \-i ", " \--issuer-name
  66. set issuer name.
  67. .sp
  68. Just some descriptive text.
  69. .TP
  70. .BR \-M ", " \--md5key
  71. generate MD5 keys.
  72. .sp
  73. Just some descriptive text.
  74. .TP
  75. .BR \-m " \fImodulus\fP, " \--modulus "=" \fImodulus\fP
  76. modulus.
  77. This option takes an integer number as its argument.
  78. The value of \fImodulus\fP is constrained to being:
  79. .in +4
  80. .nf
  81. .na
  82. in the range 256 through 2048
  83. .fi
  84. .in -4
  85. .sp
  86. Just some descriptive text.
  87. .TP
  88. .BR \-P ", " \--pvt-cert
  89. generate PC private certificate.
  90. .sp
  91. Just some descriptive text.
  92. .TP
  93. .BR \-p " \fIpasswd\fP, " \--pvt-passwd "=" \fIpasswd\fP
  94. output private password.
  95. .sp
  96. Just some descriptive text.
  97. .TP
  98. .BR \-q " \fIpasswd\fP, " \--get-pvt-passwd "=" \fIpasswd\fP
  99. input private password.
  100. .sp
  101. Just some descriptive text.
  102. .TP
  103. .BR \-S " \fIsign\fP, " \--sign-key "=" \fIsign\fP
  104. generate sign key (RSA or DSA).
  105. .sp
  106. Just some descriptive text.
  107. .TP
  108. .BR \-s " \fIhost\fP, " \--subject-name "=" \fIhost\fP
  109. set subject name.
  110. .sp
  111. Just some descriptive text.
  112. .TP
  113. .BR \-T ", " \--trusted-cert
  114. trusted certificate (TC scheme).
  115. .sp
  116. Just some descriptive text.
  117. .TP
  118. .BR \-V " \fInum\fP, " \--mv-params "=" \fInum\fP
  119. generate <num> MV parameters.
  120. This option takes an integer number as its argument.
  121. .sp
  122. Just some descriptive text.
  123. .TP
  124. .BR \-v " \fInum\fP, " \--mv-keys "=" \fInum\fP
  125. update <num> MV keys.
  126. This option takes an integer number as its argument.
  127. .sp
  128. Just some descriptive text.
  129. .TP
  130. .BR \-? , " \--help"
  131. Display usage information and exit.
  132. .TP
  133. .BR \-! , " \--more-help"
  134. Extended usage information passed thru pager.
  135. .TP
  136. .BR \-> " [\fIrcfile\fP]," " \--save-opts" "[=\fIrcfile\fP]"
  137. Save the option state to \fIrcfile\fP. The default is the \fIlast\fP
  138. configuration file listed in the \fBOPTION PRESETS\fP section, below.
  139. .TP
  140. .BR \-< " \fIrcfile\fP," " \--load-opts" "=\fIrcfile\fP," " \--no-load-opts"
  141. Load options from \fIrcfile\fP.
  142. The \fIno-load-opts\fP form will disable the loading
  143. of earlier RC/INI files. \fI--no-load-opts\fP is handled early,
  144. out of order.
  145. .TP
  146. .BR \-v " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
  147. Output version of program and exit. The default mode is `v', a simple
  148. version. The `c' mode will print copyright information and `n' will
  149. print the full copyright notice.
  150. .SH OPTION PRESETS
  151. Any option that is not marked as \fInot presettable\fP may be preset
  152. by loading values from configuration ("RC" or ".INI") file(s) and values from
  153. environment variables named:
  154. .nf
  155. \fBNTP_KEYGEN_<option-name>\fP or \fBNTP_KEYGEN\fP
  156. .fi
  157. .aj
  158. The environmental presets take precedence (are processed later than)
  159. the configuration files.
  160. The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
  161. If any of these are directories, then the file \fI.ntprc\fP
  162. is searched for within those directories.
  163. .SH AUTHOR
  164. David L. Mills and/or others
  165. .br
  166. Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
  167. .PP
  168. .nf
  169. .na
  170. see html/copyright.html
  171. .fi
  172. .ad
  173. .PP
  174. This manual page was \fIAutoGen\fP-erated from the \fBntp-keygen\fP
  175. option definitions.