Annotation of embedaddon/ntp/ntpd/ntpd.1, revision 1.1
1.1 ! misho 1: .TH NTPD 1 2011-12-24 "( 4.2.6p5)" "Programmer's Manual"
! 2: .\" EDIT THIS FILE WITH CAUTION (ntpd.1)
! 3: .\"
! 4: .\" It has been AutoGen-ed December 24, 2011 at 06:34:12 PM by AutoGen 5.12
! 5: .\" From the definitions ntpd-opts.def
! 6: .\" and the template file agman1.tpl
! 7: .\"
! 8: .SH NAME
! 9: ntpd \- NTP daemon program
! 10: .SH SYNOPSIS
! 11: .B ntpd
! 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 briefly documents the \fBntpd\fP command.
! 18:
! 19: .SH OPTIONS
! 20: .TP
! 21: .BR \-4 ", " \--ipv4
! 22: Force IPv4 DNS name resolution.
! 23: This option must not appear in combination with any of the following options:
! 24: ipv6.
! 25: .sp
! 26: Force DNS resolution of following host names on the command line
! 27: to the IPv4 namespace.
! 28: .TP
! 29: .BR \-6 ", " \--ipv6
! 30: Force IPv6 DNS name resolution.
! 31: This option must not appear in combination with any of the following options:
! 32: ipv4.
! 33: .sp
! 34: Force DNS resolution of following host names on the command line
! 35: to the IPv6 namespace.
! 36: .TP
! 37: .BR \-a ", " \--authreq
! 38: Require crypto authentication.
! 39: This option must not appear in combination with any of the following options:
! 40: authnoreq.
! 41: .sp
! 42: Require cryptographic authentication for broadcast client,
! 43: multicast client and symmetric passive associations.
! 44: This is the default.
! 45: .TP
! 46: .BR \-A ", " \--authnoreq
! 47: Do not require crypto authentication.
! 48: This option must not appear in combination with any of the following options:
! 49: authreq.
! 50: .sp
! 51: Do not require cryptographic authentication for broadcast client,
! 52: multicast client and symmetric passive associations.
! 53: This is almost never a good idea.
! 54: .TP
! 55: .BR \-b ", " \--bcastsync
! 56: Allow us to sync to broadcast servers.
! 57: .sp
! 58:
! 59: .TP
! 60: .BR \-c " \fIstring\fP, " \--configfile "=" \fIstring\fP
! 61: configuration file name.
! 62: .sp
! 63: The name and path of the configuration file,
! 64: /etc/ntp.conf
! 65: by default.
! 66: .TP
! 67: .BR \-d ", " \--debug-level
! 68: Increase output debug message level.
! 69: This option may appear an unlimited number of times.
! 70: .sp
! 71: Increase the debugging message output level.
! 72: .TP
! 73: .BR \-D " \fIstring\fP, " \--set-debug-level "=" \fIstring\fP
! 74: Set the output debug message level.
! 75: This option may appear an unlimited number of times.
! 76: .sp
! 77: Set the output debugging level. Can be supplied multiple times,
! 78: but each overrides the previous value(s).
! 79: .TP
! 80: .BR \-f " \fIstring\fP, " \--driftfile "=" \fIstring\fP
! 81: frequency drift file name.
! 82: .sp
! 83: The name and path of the frequency file,
! 84: /etc/ntp.drift
! 85: by default.
! 86: This is the same operation as the
! 87: driftfile driftfile
! 88: configuration specification in the
! 89: /etc/ntp.conf
! 90: file.
! 91: .TP
! 92: .BR \-g ", " \--panicgate
! 93: Allow the first adjustment to be Big.
! 94: This option may appear an unlimited number of times.
! 95: .sp
! 96: Normally,
! 97: ntpd
! 98: 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,
! 99: ntpd
! 100: will exit with a message to the system log. This option can be used with the
! 101: -q
! 102: and
! 103: -x
! 104: options.
! 105: See the
! 106: tinker
! 107: configuration file directive for other options.
! 108: .TP
! 109: .BR \-i " \fIstring\fP, " \--jaildir "=" \fIstring\fP
! 110: Jail directory.
! 111: .sp
! 112: Chroot the server to the directory
! 113: jaildir
! 114: .
! 115: This option also implies that the server attempts to drop root privileges at startup.
! 116: You may need to also specify a
! 117: -u
! 118: option.
! 119: This option is only available if the OS supports adjusting the clock
! 120: without full root privileges.
! 121: This option is supported under NetBSD (configure with
! 122: --enable-clockctl
! 123: ) and Linux (configure with
! 124: --enable-linuxcaps
! 125: ).
! 126: .TP
! 127: .BR \-I " \fIiface\fP, " \--interface "=" \fIiface\fP
! 128: Listen on an interface name or address.
! 129: This option may appear an unlimited number of times.
! 130: .sp
! 131: Open the network address given, or all the addresses associated with the
! 132: given interface name. This option may appear multiple times. This option
! 133: also implies not opening other addresses, except wildcard and localhost.
! 134: This option is deprecated. Please consider using the configuration file
! 135: interface command, which is more versatile.
! 136: .TP
! 137: .BR \-k " \fIstring\fP, " \--keyfile "=" \fIstring\fP
! 138: path to symmetric keys.
! 139: .sp
! 140: Specify the name and path of the symmetric key file.
! 141: /etc/ntp.keys
! 142: is the default.
! 143: This is the same operation as the
! 144: keys keyfile
! 145: configuration file directive.
! 146: .TP
! 147: .BR \-l " \fIstring\fP, " \--logfile "=" \fIstring\fP
! 148: path to the log file.
! 149: .sp
! 150: Specify the name and path of the log file.
! 151: The default is the system log file.
! 152: This is the same operation as the
! 153: logfile logfile
! 154: configuration file directive.
! 155: .TP
! 156: .BR \-L ", " \--novirtualips
! 157: Do not listen to virtual interfaces.
! 158: .sp
! 159: Do not listen to virtual interfaces, defined as those with
! 160: names containing a colon. This option is deprecated. Please
! 161: consider using the configuration file interface command, which
! 162: is more versatile.
! 163: .TP
! 164: .BR \-M ", " \--modifymmtimer
! 165: Modify Multimedia Timer (Windows only).
! 166: .sp
! 167: Set the Windows Multimedia Timer to highest resolution. This
! 168: ensures the resolution does not change while ntpd is running,
! 169: avoiding timekeeping glitches associated with changes.
! 170: .TP
! 171: .BR \-n ", " \--nofork
! 172: Do not fork.
! 173: .sp
! 174:
! 175: .TP
! 176: .BR \-N ", " \--nice
! 177: Run at high priority.
! 178: .sp
! 179: To the extent permitted by the operating system, run
! 180: ntpd
! 181: at the highest priority.
! 182: .TP
! 183: .BR \-p " \fIstring\fP, " \--pidfile "=" \fIstring\fP
! 184: path to the PID file.
! 185: .sp
! 186: Specify the name and path of the file used to record
! 187: ntpd's
! 188: process ID.
! 189: This is the same operation as the
! 190: pidfile pidfile
! 191: configuration file directive.
! 192: .TP
! 193: .BR \-P " \fInumber\fP, " \--priority "=" \fInumber\fP
! 194: Process priority.
! 195: This option takes an integer number as its argument.
! 196: .sp
! 197: To the extent permitted by the operating system, run
! 198: ntpd
! 199: at the specified
! 200: sched_setscheduler(SCHED_FIFO)
! 201: priority.
! 202: .TP
! 203: .BR \-q ", " \--quit
! 204: Set the time and quit.
! 205: .sp
! 206: ntpd
! 207: will exit just after the first time the clock is set. This behavior mimics that of the
! 208: ntpdate
! 209: program, which is to be retired.
! 210: The
! 211: -g
! 212: and
! 213: -x
! 214: options can be used with this option.
! 215: Note: The kernel time discipline is disabled with this option.
! 216: .TP
! 217: .BR \-r " \fIstring\fP, " \--propagationdelay "=" \fIstring\fP
! 218: Broadcast/propagation delay.
! 219: .sp
! 220: 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.
! 221: .TP
! 222: .BR \--saveconfigquit "=\fIstring\fP"
! 223: Save parsed configuration and quit.
! 224: .sp
! 225: Cause ntpd to parse its startup configuration file and save an
! 226: equivalent to the given filename and exit. This option was
! 227: designed for automated testing.
! 228: .TP
! 229: .BR \-s " \fIstring\fP, " \--statsdir "=" \fIstring\fP
! 230: Statistics file location.
! 231: .sp
! 232: Specify the directory path for files created by the statistics facility.
! 233: This is the same operation as the
! 234: statsdir statsdir
! 235: configuration file directive.
! 236: .TP
! 237: .BR \-t " \fItkey\fP, " \--trustedkey "=" \fItkey\fP
! 238: Trusted key number.
! 239: This option may appear an unlimited number of times.
! 240: .sp
! 241: Add a key number to the trusted key list.
! 242: .TP
! 243: .BR \-u " \fIstring\fP, " \--user "=" \fIstring\fP
! 244: Run as userid (or userid:groupid).
! 245: .sp
! 246: Specify a user, and optionally a group, to switch to.
! 247: This option is only available if the OS supports adjusting the clock
! 248: without full root privileges.
! 249: This option is supported under NetBSD (configure with
! 250: --enable-clockctl
! 251: ) and Linux (configure with
! 252: --enable-linuxcaps
! 253: ).
! 254: .TP
! 255: .BR \-U " \fInumber\fP, " \--updateinterval "=" \fInumber\fP
! 256: interval in seconds between scans for new or dropped interfaces.
! 257: This option takes an integer number as its argument.
! 258: .sp
! 259: Give the time in seconds between two scans for new or dropped interfaces.
! 260: For systems with routing socket support the scans will be performed shortly after the interface change
! 261: has been detected by the system.
! 262: Use 0 to disable scanning. 60 seconds is the minimum time between scans.
! 263: .TP
! 264: .BR \--var "=\fInvar\fP"
! 265: make ARG an ntp variable (RW).
! 266: This option may appear an unlimited number of times.
! 267: .sp
! 268:
! 269: .TP
! 270: .BR \--dvar "=\fIndvar\fP"
! 271: make ARG an ntp variable (RW|DEF).
! 272: This option may appear an unlimited number of times.
! 273: .sp
! 274:
! 275: .TP
! 276: .BR \-x ", " \--slew
! 277: Slew up to 600 seconds.
! 278: .sp
! 279: 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.
! 280: This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
! 281: 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.
! 282: Thus, an adjustment as much as 600 s will take almost 14 days to complete.
! 283: This option can be used with the
! 284: -g
! 285: and
! 286: -q
! 287: options.
! 288: See the
! 289: tinker
! 290: configuration file directive for other options.
! 291: Note: The kernel time discipline is disabled with this option.
! 292: .TP
! 293: .BR \--usepcc
! 294: Use CPU cycle counter (Windows only).
! 295: .sp
! 296: Attempt to substitute the CPU counter for QueryPerformanceCounter.
! 297: The CPU counter and QueryPerformanceCounter are compared, and if
! 298: they have the same frequency, the CPU counter (RDTSC on x86) is
! 299: used directly, saving the overhead of a system call.
! 300: .TP
! 301: .BR \--pccfreq "=\fIstring\fP"
! 302: Force CPU cycle counter use (Windows only).
! 303: .sp
! 304: Force substitution the CPU counter for QueryPerformanceCounter.
! 305: The CPU counter (RDTSC on x86) is used unconditionally with the
! 306: given frequency (in Hz).
! 307: .TP
! 308: .BR \-? , " \--help"
! 309: Display extended usage information and exit.
! 310: .TP
! 311: .BR \-! , " \--more-help"
! 312: Extended usage information passed thru pager.
! 313: .TP
! 314: .BR \- " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
! 315: Output version of program and exit. The default mode is `v', a simple
! 316: version. The `c' mode will print copyright information and `n' will
! 317: print the full copyright notice.
! 318: .SH OPTION PRESETS
! 319: Any option that is not marked as \fInot presettable\fP may be preset
! 320: by loading values from environment variables named:
! 321: .nf
! 322: \fBNTPD_<option-name>\fP or \fBNTPD\fP
! 323: .fi
! 324: .ad
! 325: .SH AUTHOR
! 326: David L. Mills and/or others
! 327: .br
! 328: Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
! 329:
! 330: .PP
! 331: .nf
! 332: .na
! 333: see html/copyright.html
! 334:
! 335: .fi
! 336: .ad
! 337: .PP
! 338: This manual page was \fIAutoGen\fP-erated from the \fBntpd\fP
! 339: option definitions.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to ntpd.1 CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / ntp / ntpd