contrib/ntp/ntpd/ntpdsim.1

   1 .TH NTPDSIM 1 2009-12-08 "( 4.2.4p8)" "Programmer's Manual"
   2 .\"  EDIT THIS FILE WITH CAUTION  (ntpdsim.1)
   3 .\"
   4 .\"  It has been AutoGen-ed  Tuesday December  8, 2009 at 08:13:14 AM EST
   5 .\"  From the definitions    ntpdsim-opts.def
   6 .\"  and the template file   agman1.tpl
   7 .\"
   8 .SH NAME
   9 ntpdsim \- NTP daemon simulation program
  10 .SH SYNOPSIS
  11 .B ntpdsim
  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 \fBntpdsim\fP command.
  18
  19 .SH OPTIONS
  20 .TP
  21 .BR \-4 ", " \--ipv4
  22 Force IPv4 DNS name resolution.
  23 This option is a member of the ipv4 class of options.
  24 .sp
  25 Force DNS resolution of following host names on the command line
  26 to the IPv4 namespace.
  27 .TP
  28 .BR \-6 ", " \--ipv6
  29 Force IPv6 DNS name resolution.
  30 This option is a member of the ipv4 class of options.
  31 .sp
  32 Force DNS resolution of following host names on the command line
  33 to the IPv6 namespace.
  34 .TP
  35 .BR \-a ", " \--authreq
  36 Require crypto authentication.
  37 This option must not appear in combination with any of the following options:
  38 authnoreq.
  39 .sp
  40 Require cryptographic authentication for broadcast client,
  41 multicast client and symmetric passive associations.
  42 This is the default.
  43 .TP
  44 .BR \-A ", " \--authnoreq
  45 Do not require crypto authentication.
  46 This option must not appear in combination with any of the following options:
  47 authreq.
  48 .sp
  49 Do not require cryptographic authentication for broadcast client,
  50 multicast client and symmetric passive associations.
  51 This is almost never a good idea.
  52 .TP
  53 .BR \-b ", " \--bcastsync
  54 Allow us to sync to broadcast servers.
  55 .sp
  56
  57 .TP
  58 .BR \-B " \fIstring\fP, " \--simbroadcastdelay "=" \fIstring\fP
  59 Simulator broadcast delay.
  60 .sp
  61
  62 .TP
  63 .BR \-c " \fIstring\fP, " \--configfile "=" \fIstring\fP
  64 configuration file name.
  65 .sp
  66 The name and path of the configuration file,
  67 /etc/ntp.conf
  68 by default.
  69 .TP
  70 .BR \-C " \fIstring\fP, " \--phasenoise "=" \fIstring\fP
  71 Phase noise level.
  72 .sp
  73
  74 .TP
  75 .BR \-d ", " \--debug-level
  76 Increase output debug message level.
  77 This option may appear an unlimited number of times.
  78 .sp
  79 Increase the debugging message output level.
  80 .TP
  81 .BR \-D " \fIstring\fP, " \--set-debug-level "=" \fIstring\fP
  82 Set the output debug message level.
  83 This option may appear an unlimited number of times.
  84 .sp
  85 Set the output debugging level.  Can be supplied multiple times,
  86 but each overrides the previous value(s).
  87 .TP
  88 .BR \-f " \fIstring\fP, " \--driftfile "=" \fIstring\fP
  89 frequency drift file name.
  90 .sp
  91 The name and path of the frequency file,
  92 /etc/ntp.drift
  93 by default.
  94 This is the same operation as the
  95 driftfile driftfile
  96 configuration specification in the
  97 /etc/ntp.conf
  98 file.
  99 .TP
 100 .BR \-g ", " \--panicgate
 101 Allow the first adjustment to be Big.
 102 .sp
 103 Normally,
 104 ntpd
 105 exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default. This option allows the time to be set to any value without restriction; however, this can happen only once. If the threshold is exceeded after that,
 106 ntpd
 107 will exit with a message to the system log. This option can be used with the
 108 -q
 109 and
 110 -x
 111 options.
 112 See the
 113 tinker
 114 configuration file directive for other options.
 115 .TP
 116 .BR \-H " \fIstring\fP, " \--simslew "=" \fIstring\fP
 117 Simuator slew.
 118 .sp
 119
 120 .TP
 121 .BR \-i " \fIstring\fP, " \--jaildir "=" \fIstring\fP
 122 Jail directory.
 123 .sp
 124 Chroot the server to the directory
 125 jaildir
 126 .
 127 This option also implies that the server attempts to drop root privileges at startup (otherwise, chroot gives very little additional security), and it is only available if the OS supports to run the server without full root privileges.
 128 You may need to also specify a
 129 -u
 130 option.
 131 .TP
 132 .BR \-I " \fIiface\fP, " \--interface "=" \fIiface\fP
 133 Listen on interface.
 134 This option may appear an unlimited number of times.
 135 .sp
 136
 137 .TP
 138 .BR \-k " \fIstring\fP, " \--keyfile "=" \fIstring\fP
 139 path to symmetric keys.
 140 .sp
 141 Specify the name and path of the symmetric key file.
 142 /etc/ntp.keys
 143 is the default.
 144 This is the same operation as the
 145 keys keyfile
 146 configuration file directive.
 147 .TP
 148 .BR \-l " \fIstring\fP, " \--logfile "=" \fIstring\fP
 149 path to the log file.
 150 .sp
 151 Specify the name and path of the log file.
 152 The default is the system log file.
 153 This is the same operation as the
 154 logfile logfile
 155 configuration file directive.
 156 .TP
 157 .BR \-L ", " \--novirtualips
 158 Do not listen to virtual IPs.
 159 .sp
 160 Do not listen to virtual IPs. The default is to listen.
 161 .TP
 162 .BR \-M ", " \--modifymmtimer
 163 Modify Multimedia Timer (Windows only).
 164 .sp
 165 Set the Windows Multimedia Timer to highest resolution.
 166 .TP
 167 .BR \-n ", " \--nofork
 168 Do not fork.
 169 .sp
 170
 171 .TP
 172 .BR \-N ", " \--nice
 173 Run at high priority.
 174 .sp
 175 To the extent permitted by the operating system, run
 176 ntpd
 177 at the highest priority.
 178 .TP
 179 .BR \-O " \fIstring\fP, " \--servertime "=" \fIstring\fP
 180 Server time.
 181 .sp
 182
 183 .TP
 184 .BR \-p " \fIstring\fP, " \--pidfile "=" \fIstring\fP
 185 path to the PID file.
 186 .sp
 187 Specify the name and path of the file used to record
 188 ntpd's
 189 process ID.
 190 This is the same operation as the
 191 pidfile pidfile
 192 configuration file directive.
 193 .TP
 194 .BR \-P " \fInumber\fP, " \--priority "=" \fInumber\fP
 195 Process priority.
 196 This option takes an integer number as its argument.
 197 .sp
 198 To the extent permitted by the operating system, run
 199 ntpd
 200 at the specified
 201 sched_setscheduler(SCHED_FIFO)
 202 priority.
 203 .TP
 204 .BR \-q ", " \--quit
 205 Set the time and quit.
 206 .sp
 207 ntpd
 208 will exit just after the first time the clock is set. This behavior mimics that of the
 209 ntpdate
 210 program, which is to be retired.
 211 The
 212 -g
 213 and
 214 -x
 215 options can be used with this option.
 216 Note: The kernel time discipline is disabled with this option.
 217 .TP
 218 .BR \-r " \fIstring\fP, " \--propagationdelay "=" \fIstring\fP
 219 Broadcast/propagation delay.
 220 .sp
 221 Specify the default propagation delay from the broadcast/multicast server to this client. This is necessary only if the delay cannot be computed automatically by the protocol.
 222 .TP
 223 .BR \-U " \fInumber\fP, " \--updateinterval "=" \fInumber\fP
 224 interval in seconds between scans for new or dropped interfaces.
 225 This option takes an integer number as its argument.
 226 .sp
 227 Give the time in seconds between two scans for new or dropped interfaces.
 228 For systems with routing socket support the scans will be performed shortly after the interface change
 229 has been detected by the system.
 230 Use 0 to disable scanning.
 231 .TP
 232 .BR \-s " \fIstring\fP, " \--statsdir "=" \fIstring\fP
 233 Statistics file location.
 234 .sp
 235 Specify the directory path for files created by the statistics facility.
 236 This is the same operation as the
 237 statsdir statsdir
 238 configuration file directive.
 239 .TP
 240 .BR \-S " \fIstring\fP, " \--endsimtime "=" \fIstring\fP
 241 Simulation end time.
 242 .sp
 243
 244 .TP
 245 .BR \-t " \fItkey\fP, " \--trustedkey "=" \fItkey\fP
 246 Trusted key number.
 247 This option may appear an unlimited number of times.
 248 .sp
 249 Add a key number to the trusted key list.
 250 .TP
 251 .BR \-T " \fIstring\fP, " \--freqerr "=" \fIstring\fP
 252 Simulation frequency error.
 253 .sp
 254
 255 .TP
 256 .BR \-W " \fIstring\fP, " \--walknoise "=" \fIstring\fP
 257 Simulation random walk noise.
 258 .sp
 259
 260 .TP
 261 .BR \-u " \fIstring\fP, " \--user "=" \fIstring\fP
 262 Run as userid (or userid:groupid).
 263 .sp
 264 Specify a user, and optionally a group, to switch to.
 265 This option is only available if the OS supports to run the server without full root privileges.
 266 Currently, this option is supported under NetBSD (configure with
 267 --enable-clockctl
 268 ) and Linux (configure with
 269 --enable-linuxcaps
 270 ).
 271 .TP
 272 .BR \-v " \fInvar\fP, " \--var "=" \fInvar\fP
 273 make ARG an ntp variable (RW).
 274 This option may appear an unlimited number of times.
 275 .sp
 276
 277 .TP
 278 .BR \-V " \fIndvar\fP, " \--dvar "=" \fIndvar\fP
 279 make ARG an ntp variable (RW|DEF).
 280 This option may appear an unlimited number of times.
 281 .sp
 282
 283 .TP
 284 .BR \-x ", " \--slew
 285 Slew up to 600 seconds.
 286 .sp
 287 Normally, the time is slewed if the offset is less than the step threshold, which is 128 ms by default, and stepped if above the threshold.
 288 This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
 289 Note: Since the slew rate of typical Unix kernels is limited to 0.5 ms/s, each second of adjustment requires an amortization interval of 2000 s.
 290 Thus, an adjustment as much as 600 s will take almost 14 days to complete.
 291 This option can be used with the
 292 -g
 293 and
 294 -q
 295 options.
 296 See the
 297 tinker
 298 configuration file directive for other options.
 299 Note: The kernel time discipline is disabled with this option.
 300 .TP
 301 .BR \-Y " \fIstring\fP, " \--ndelay "=" \fIstring\fP
 302 Simulation network delay.
 303 .sp
 304
 305 .TP
 306 .BR \-Z " \fIstring\fP, " \--pdelay "=" \fIstring\fP
 307 Simulation processing delay.
 308 .sp
 309
 310 .TP
 311 .BR \-? , " \--help"
 312 Display usage information and exit.
 313 .TP
 314 .BR \-! , " \--more-help"
 315 Extended usage information passed thru pager.
 316 .TP
 317 .BR \-> " [\fIrcfile\fP]," " \--save-opts" "[=\fIrcfile\fP]"
 318 Save the option state to \fIrcfile\fP.  The default is the \fIlast\fP
 319 configuration file listed in the \fBOPTION PRESETS\fP section, below.
 320 .TP
 321 .BR \-< " \fIrcfile\fP," " \--load-opts" "=\fIrcfile\fP," " \--no-load-opts"
 322 Load options from \fIrcfile\fP.
 323 The \fIno-load-opts\fP form will disable the loading
 324 of earlier RC/INI files.  \fI--no-load-opts\fP is handled early,
 325 out of order.
 326 .TP
 327 .BR \-v " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
 328 Output version of program and exit.  The default mode is `v', a simple
 329 version.  The `c' mode will print copyright information and `n' will
 330 print the full copyright notice.
 331 .SH OPTION PRESETS
 332 Any option that is not marked as \fInot presettable\fP may be preset
 333 by loading values from configuration ("RC" or ".INI") file(s) and values from
 334 environment variables named:
 335 .nf
 336   \fBNTPDSIM_<option-name>\fP or \fBNTPDSIM\fP
 337 .fi
 338 .aj
 339 The environmental presets take precedence (are processed later than)
 340 the configuration files.
 341 The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
 342 If any of these are directories, then the file \fI.ntprc\fP
 343 is searched for within those directories.
 344 .SH AUTHOR
 345 David L. Mills and/or others
 346 .br
 347 Please send bug reports to:  http://bugs.ntp.org, bugs@ntp.org
 348
 349 .PP
 350 .nf
 351 .na
 352 see html/copyright.html
 353 .fi
 354 .ad
 355 .PP
 356 This manual page was \fIAutoGen\fP-erated from the \fBntpdsim\fP
 357 option definitions.