Lines Matching +full:cm +full:- +full:poll +full:- +full:mode
1 /* -*- Mode: Text -*- */
7 // We want the synopsis to be "/etc/ntp.conf" but we need the prog-name
8 // to be ntp.conf - the latter is also how autogen produces the output
10 prog-name = "ntp.conf";
11 file-path = "/etc/ntp.conf";
12 prog-title = "Network Time Protocol daemon (ntpd) configuration format";
15 explain = <<- _END_EXPLAIN
18 doc-section = {
19 ds-type = 'DESCRIPTION';
20 ds-format = 'mdoc';
21 ds-text = <<- _END_PROG_MDOC_DESCRIP
48 host addresses written in numeric, dotted-quad form,
64 .Bl -bullet -offset indent
113 If the Basic Socket Interface Extensions for IPv6 (RFC-2553)
117 .Cm reslist
141 .Bl -tag -width indent
143 .Op Cm burst
144 .Op Cm iburst
145 .Op Cm version Ar version
146 .Op Cm prefer
147 .Op Cm minpoll Ar minpoll
148 .Op Cm maxpoll Ar maxpoll
149 .Op Cm xmtnonce
152 .Op Cm key Ar key \&| Cm autokey
153 .Op Cm burst
154 .Op Cm iburst
155 .Op Cm version Ar version
156 .Op Cm prefer
157 .Op Cm minpoll Ar minpoll
158 .Op Cm maxpoll Ar maxpoll
159 .Op Cm true
160 .Op Cm xmtnonce
163 .Op Cm key Ar key \&| Cm autokey
164 .Op Cm version Ar version
165 .Op Cm prefer
166 .Op Cm minpoll Ar minpoll
167 .Op Cm maxpoll Ar maxpoll
168 .Op Cm true
169 .Op Cm xleave
172 .Op Cm key Ar key \&| Cm autokey
173 .Op Cm version Ar version
174 .Op Cm prefer
175 .Op Cm minpoll Ar minpoll
176 .Op Cm ttl Ar ttl
177 .Op Cm xleave
180 .Op Cm key Ar key \&| Cm autokey
181 .Op Cm version Ar version
182 .Op Cm prefer
183 .Op Cm minpoll Ar minpoll
184 .Op Cm maxpoll Ar maxpoll
185 .Op Cm ttl Ar ttl
190 be used and the mode in which to operate.
194 either a DNS name or an IP address in dotted-quad notation.
201 .Bl -tag -width indent
204 client mode association with a number of remote servers.
205 In this mode the local clock can synchronized to the
210 client mode association with the specified remote server or local
212 In this mode the local clock can synchronized to the
221 persistent symmetric-active mode association with the specified
223 In this mode the local clock can be synchronized to
233 command mobilizes a persistent broadcast mode association.
240 In broadcast mode the local server sends periodic broadcast
260 manycast client mode association for the multicast address
275 is to operate in client mode with the remote servers that are
292 .Bl -tag -width indent
293 .It Cm autokey
298 .It Cm burst
304 .It Cm iburst
316 .It Cm key Ar key
323 .It Cm minpoll Ar minpoll
324 .It Cm maxpoll Ar maxpoll
325 These options specify the minimum and maximum poll intervals
327 The maximum poll
329 .Cm maxpoll
332 minimum poll interval defaults to 6 (64 s), but can be decreased by
334 .Cm minpoll
336 .It Cm noselect
339 .It Cm preempt
341 .It Cm prefer
353 .It Cm true
359 .It Cm ttl Ar ttl
362 It specifies the time-to-live
372 .It Cm version Ar version
375 Versions 1-4 are the choices, with version 4 the
377 .It Cm xleave
379 .Cm peer
381 .Cm broadcast
382 modes only, this flag enables interleave mode.
383 .It Cm xmtnonce
385 .Cm server
387 .Cm pool
392 .Bl -tag -width indent
399 server, then enters the broadcast client mode, in which it
402 to avoid accidental or malicious disruption in this mode, both the
403 server and client should operate using symmetric-key or public-key
415 accidental or malicious disruption in this mode, both the server
416 and client should operate using symmetric-key or public-key
425 exchange with the server, then enters the broadcast client mode, in
428 in order to avoid accidental or malicious disruption in this mode,
429 both the server and client should operate using symmetric-key or
430 public-key authentication as described in
452 specification RFC-1305 defines a scheme which provides
456 operating in Cipher Block Chaining (CBC) mode, commonly called
457 DES-CBC.
459 5 (MD5) algorithm using a private key, commonly called keyed-MD5.
460 Either algorithm computes a message digest, or one-way hash, which
488 .Cm key
490 .Cm autokey
525 .Cm auth
562 is manycast mode, in which clients periodically troll
567 cryptographic authentication can be used in this mode.
569 of manycast mode is that potential servers need not be
581 .Ss Symmetric-Key Cryptography
582 The original RFC-1305 specification allows any one of possibly
583 65,535 keys, each distinguished by a 32-bit key identifier, to
631 described in RFC-1305 and in addition the Autokey protocol,
659 All modes use in addition a variant of the S-KEY scheme,
660 in which a pseudo-random key list is generated and used
670 .Xr ntp-keygen 1ntpkeygenmdoc
681 .Cm md5WithRSAEncryption ,
800 Bob sends Cathy a thing called a crypto-NAK, which tells her
824 .Xr ntp-keygen 1ntpkeygenmdoc
854 .Cm trustRoot ; .
857 .Bl -tag -width indent
863 poll interval.
865 For poll intervals above the specified interval, a session key list
872 protocol defined in RFC-1305.
879 .Op Cm cert Ar file
880 .Op Cm leap Ar file
881 .Op Cm randfile Ar file
882 .Op Cm host Ar file
883 .Op Cm gq Ar file
884 .Op Cm gqpar Ar file
885 .Op Cm iffpar Ar file
886 .Op Cm mvpar Ar file
887 .Op Cm pw Ar password
903 .Bl -tag -width indent
904 .It Cm cert Ar file
909 .It Cm gqpar Ar file
915 .It Cm host Ar file
921 .It Cm iffpar Ar file
926 .It Cm leap Ar file
931 .It Cm mvpar Ar file
936 .It Cm pw Ar password
941 .It Cm randfile Ar file
974 Specifies the interval between re-randomization of certain
978 deflect brute-force attacks on the algorithms of the scheme;
981 For poll
998 arguments are 32-bit unsigned
1004 .Bl -tag -width indent
1074 .Bl -tag -width indent
1080 .Bl -tag -width indent
1081 .It Cm clockstats
1086 .Cm clockstats :
1087 .Bd -literal
1094 clock address in dotted-quad notation.
1102 .It Cm cryptostats
1108 .Cm cryptostats :
1109 .Bd -literal
1116 address in dotted-quad notation, The final message field includes the
1121 .It Cm loopstats
1126 .Cm loopstats :
1127 .Bd -literal
1134 show time offset (seconds), frequency offset (parts per million -
1137 .It Cm peerstats
1145 .Cm peerstats :
1146 .Bd -literal
1147 48773 10847.650 127.127.4.1 9714 -0.001605376 0.000000000 0.001424877 0.000958674
1153 show the peer address in dotted-quad notation and status,
1159 .It Cm rawstats
1160 Enables recording of raw-timestamp statistics information.
1167 .Cm rawstats :
1168 .Bd -literal
1176 in dotted-quad notation.
1182 .It Cm sysstats
1187 .Cm sysstats :
1188 .Bd -literal
1197 .Bl -tag -width indent
1198 .It Time since restart Cm 36000
1200 .It Packets received Cm 81965
1202 .It Packets processed Cm 0
1204 .It Current version Cm 9546
1206 .It Previous version Cm 56
1208 .It Bad version Cm 71793
1210 .It Access denied Cm 512
1212 .It Bad length or format Cm 540
1214 .It Bad authentication Cm 10
1216 .It Rate exceeded Cm 147
1219 .It Cm statsdir Ar directory_path
1224 .Cm filegen
1227 .It Cm filegen Ar name Xo
1228 .Op Cm file Ar filename
1229 .Op Cm type Ar typename
1230 .Op Cm link | nolink
1231 .Op Cm enable | disable
1253 .Bl -tag -width indent
1254 .It Cm name
1256 .Cm statistics
1258 .It Cm file Ar filename
1262 .Ar Cm prefix ,
1263 .Ar Cm filename
1265 .Ar Cm suffix :
1266 .Bl -tag -width indent
1267 .It Cm prefix
1274 server, usually specified as a compile-time constant.
1285 .It Cm filename
1299 .It Cm suffix
1304 .It Cm type Ar typename
1308 .Bl -tag -width indent
1309 .It Cm none
1311 .It Cm pid
1329 .It Cm day
1338 .Cm YYYYMMdd .
1339 .Cm YYYY
1340 is a 4-digit year number (e.g., 1992).
1341 .Cm MM
1343 .Cm dd
1349 .It Cm week
1352 The term week is defined by computing day-of-year
1356 filename base: A dot, a 4-digit year number, the letter
1357 .Cm W ,
1358 and a 2-digit week number.
1362 .It Cm month
1365 file name suffix consists of a dot, a 4-digit year number, and
1366 a 2-digit month.
1367 .It Cm year
1371 .It Cm age
1376 .Cm a ,
1377 and an 8-digit number.
1379 running at the start of the corresponding 24-hour period.
1381 .Cm enable ;
1383 .Cm disable .
1385 .It Cm link | nolink
1390 .Cm link
1392 .Cm nolink .
1399 .Cm C ,
1407 .It Cm enable \&| Cm disable
1461 .Ss The Kiss-of-Death Packet
1469 for this purpose called the "kiss-of-death" (KoD) packet.
1471 to zero and the reference identifier field set to a four-byte
1474 .Cm noserve
1476 .Cm notrust
1479 .Cm limited
1497 .Bl -tag -width indent
1499 .Op Cm average Ar avg
1500 .Op Cm minimum Ar min
1501 .Op Cm monitor Ar prob
1504 .Cm limited
1508 .Cm average
1511 .Cm minimum
1515 and a kiss-o'-death packet returned if enabled.
1533 .Op Cm mask Ar mask
1534 .Op Cm ippeerlimit Ar int
1558 .Cm default ,
1562 .Cm ippeerlimit
1565 where a value of -1 means "unlimited", the current default.
1571 .Cm flag
1580 restrict informational queries and attempts to do run-time
1584 .Bl -tag -width indent
1585 .It Cm ignore
1591 .It Cm kod
1592 If this flag is set when a rate violation occurs, a kiss-o'-death
1596 .Cm discard average
1598 .It Cm limited
1608 .Cm limited
1610 .It Cm lowpriotrap
1620 .It Cm noepeer
1630 .Cm noepeer
1631 to become the default in ntp-4.4.
1632 .It Cm nomodify
1641 .It Cm noquery
1648 .It Cm nopeer
1654 .Cm pool
1656 .Cm pool
1658 .Cm nopeer
1660 .Cm "restrict source ..."
1664 .Cm nopeer
1666 .It Cm noserve
1672 .It Cm notrap
1673 Decline to provide mode 6 control message trap service to matching
1679 .It Cm notrust
1681 .It Cm ntpport
1689 .Cm ntpport
1692 .Cm ntpport
1698 .Cm reftime .
1699 .It Cm version
1707 .Cm manycastclient
1709 .Cm manycast
1719 Remove a previously-set restriction. This is useful for
1723 .Cm source
1725 .Cm restrict source
1728 .Cm source
1746 with the anycast paradigm described in RFC-1546,
1770 .Cm D
1772 .Cm FF )
1778 and minimum feasible time-to-live (TTL) hops, depending
1805 in burst mode in order to reliably set the host clock
1808 in a volley of eight client/server at 2-s intervals
1817 in ordinary client/server mode.
1821 and the effects of implosion due to near-simultaneous
1829 The manycast poll interval is
1830 normally eight times the system poll interval,
1832 .Cm minpoll
1836 .Cm maxpolll
1850 .Cm minclock
1852 .Cm minsane
1857 .Cm minsane
1860 .Cm minclock
1865 .Cm minsane
1867 .Cm minclock
1870 .Cm minsane
1875 .Cm minclock
1876 servers are found, the manycast poll interval is immediately
1878 .Cm maxpoll .
1880 .Cm minclock
1882 the manycast poll interval is doubled.
1884 after that, the poll interval is doubled again until
1886 .Cm maxpoll .
1887 Further transmissions use the same poll interval and
1891 it the system poll interval.
1916 .Cm floor
1918 .Cm ceiling
1925 .Cm minclock .
1928 which repeats at the designated poll interval.
1932 If during a poll interval the number of client associations
1934 .Cm minclock ,
1936 to the initial poll interval and TTL hops and operation
1944 .Cm maxpoll
1974 .Cm floor
1989 re-associate accordingly.
2013 Each time a manycast client sends a client mode packet
2026 About once an hour or less often if the poll interval
2028 This is in general transparent in client/server mode.
2043 .Bl -tag -width indent
2046 .Cm bcpollbstep Ar gate
2050 by the specified number of broadcast poll intervals,
2058 broadcast mode, attempts to perform a replay attack are possible.
2060 to any number of poll intervals between 0 and 4.
2063 .Bl -tag -width indent
2066 .Cm ceiling Ar ceiling |
2067 .Cm cohort { 0 | 1 } |
2068 .Cm floor Ar floor |
2069 .Cm minclock Ar minclock |
2070 .Cm minsane Ar minsane
2077 and is most useful in manycast mode.
2080 .Bl -tag -width indent
2081 .It Cm ceiling Ar ceiling
2083 .Cm ceiling
2085 .Cm minclock
2089 .It Cm cohort Bro 0 | 1 Brc
2097 .It Cm floor Ar floor
2099 .Cm floor
2101 .Cm minclock
2105 .It Cm minclock Ar minclock
2108 .Cm minclock
2113 .It Cm minsane Ar minsane
2123 .Cm minsane
2127 .It Cm ttl Ar hop ...
2130 In manycast mode these values are used in turn
2131 in an expanding-ring search.
2137 satellite and modem reference clocks plus a special pseudo-clock
2157 .Qq Pulse-per-second (PPS) Signal Interfacing
2207 number in the range 0-3.
2220 .Cm key ,
2221 .Cm version
2223 .Cm ttl
2226 .Cm mode
2230 .Cm prefer
2242 .Cm minpoll
2244 .Cm maxpoll
2261 .Cm refid
2263 .Cm stratum
2267 device-dependent time offsets and four flags that can be included
2281 .Cm stratum
2284 involving both a reference clock and a pulse-per-second (PPS)
2288 .Cm refid
2293 .Bl -tag -width indent
2298 .Op Cm prefer
2299 .Op Cm mode Ar int
2300 .Op Cm minpoll Ar int
2301 .Op Cm maxpoll Ar int
2306 .Bl -tag -width indent
2307 .It Cm prefer
2319 .It Cm mode Ar int
2320 Specifies a mode number which is interpreted in a
2321 device-specific fashion.
2326 .It Cm minpoll Ar int
2327 .It Cm maxpoll Ar int
2332 .Cm minpoll
2334 .Cm maxpoll
2337 .Cm minpoll
2339 .Cm maxpoll
2347 .Op Cm time1 Ar sec
2348 .Op Cm time2 Ar sec
2349 .Op Cm stratum Ar int
2350 .Op Cm refid Ar string
2351 .Op Cm mode Ar int
2352 .Op Cm flag1 Cm 0 \&| Cm 1
2353 .Op Cm flag2 Cm 0 \&| Cm 1
2354 .Op Cm flag3 Cm 0 \&| Cm 1
2355 .Op Cm flag4 Cm 0 \&| Cm 1
2368 .Bl -tag -width indent
2369 .It Cm time1 Ar sec
2371 the driver, a fixed-point decimal number in seconds.
2398 .It Cm time2 Ar secs
2399 Specifies a fixed-point decimal number in seconds, which is
2400 interpreted in a driver-dependent way.
2408 .It Cm stratum Ar int
2413 .It Cm refid Ar string
2419 .It Cm mode Ar int
2420 Specifies a mode number which is interpreted in a
2421 device-specific fashion.
2426 .It Cm flag1 Cm 0 \&| Cm 1
2427 .It Cm flag2 Cm 0 \&| Cm 1
2428 .It Cm flag3 Cm 0 \&| Cm 1
2429 .It Cm flag4 Cm 0 \&| Cm 1
2436 .Cm flag4
2439 .Cm clockstats
2450 .Bl -tag -width indent
2484 in parts-per-million (PPM).
2495 a 6-bit code.
2499 .Cm auth | Cm bclient |
2500 .Cm calibrate | Cm kernel |
2501 .Cm mode7 | Cm monitor |
2502 .Cm ntp | Cm stats |
2503 .Cm peer_clear_digest_early |
2504 .Cm unpeer_crypto_early | Cm unpeer_crypto_nak_early | Cm unpeer_digest_early
2509 .Cm auth | Cm bclient |
2510 .Cm calibrate | Cm kernel |
2511 .Cm mode7 | Cm monitor |
2512 .Cm ntp | Cm stats |
2513 .Cm peer_clear_digest_early |
2514 .Cm unpeer_crypto_early | Cm unpeer_crypto_nak_early | Cm unpeer_digest_early
2523 .Bl -tag -width indent
2524 .It Cm auth
2530 .It Cm bclient
2538 .It Cm calibrate
2543 .It Cm kernel
2550 .It Cm mode7
2551 Enables processing of NTP mode 7 implementation-specific requests
2562 using standard mode 6 requests.
2563 .It Cm monitor
2574 .It Cm ntp
2581 .It Cm peer_clear_digest_early
2585 receives a crypto-NAK packet that
2590 a properly forged and appropriately delivered crypto-NAK packet
2596 .Cm peerstats
2601 .It Cm stats
2608 .It Cm unpeer_crypto_early
2625 .Cm peerstats
2630 .It Cm unpeer_crypto_nak_early
2633 receives a crypto-NAK packet that
2638 a properly forged and appropriately delivered crypto-NAK packet
2644 .Cm peerstats
2649 .It Cm unpeer_digest_early
2664 .Cm peerstats
2683 .Cm listen | Cm ignore | Cm drop
2686 .Cm all | Cm ipv4 | Cm ipv6 | Cm wildcard
2688 .Oo Cm / Ar prefixlen
2693 .Cm interface
2705 .Cm ignore
2707 .Cm drop
2712 .Cm interface
2715 .Cm interface
2718 .Fl -interface ,
2721 .Fl -novirtualips
2722 command-line options are specified in the configuration file,
2725 .Cm nic
2727 .Cm interface .
2733 .Li https://hpiers.obspm.fr/iers/bul/bulc/ntp/leap-seconds.list
2735 .Li ftp://hpiers.obspm.fr/iers/bul/bulc/ntp/leap-seconds.list .
2737 .Cm leapfile
2741 .Cm leapfile directive or when
2742 .Cm ntpd detects that the
2745 .Cm ntpd
2750 .Xr update-leap 1update_leapmdoc
2758 .Cm --enable-leap-smear
2760 .Cm configure
2765 .Sy DO NOT USE THIS OPTION ON PUBLIC-ACCESS SERVERS!
2781 .Ql - ,
2789 .Ql -
2796 .Cm clock ,
2797 .Cm peer ,
2798 .Cm sys
2800 .Cm sync
2805 .Cm info
2809 .Cm events
2813 .Cm statistics
2818 .Cm status
2824 .Cm all
2828 .Cm all
2833 .Bd -literal
2842 .Bd -literal
2860 .Cm maxdepth Ar count | Cm maxmem Ar kilobytes |
2861 .Cm mindepth Ar count | Cm maxage Ar seconds |
2862 .Cm initialloc Ar count | Cm initmem Ar kilobytes |
2863 .Cm incalloc Ar count | Cm incmem Ar kilobytes
2870 .Bl -tag -width indent
2875 .Cm incalloc
2877 .Cm incmem
2880 .Cm mru
2882 .Cm maxdepth
2884 .Cm maxmem are used, the last one used controls.
2886 .It Cm mindepth Ar count
2889 .Cm mindepth
2893 .It Cm maxage Ar seconds
2895 .Cm mindepth
2898 .Cm maxage
2902 .Cm maxdepth / moxmem .
2904 .It Cm initalloc Ar count
2905 .It Cm initmem Ar kilobytes
2909 .It Cm incalloc Ar count
2910 .It Cm incmem Ar kilobytes
2918 .Cm driftfile
2919 (frequency file) will be written, with a default value of 1e-7 (0.1 PPM).
2923 .Cm threshold
2931 or the JJY driver (type 40, mode 100 - 180).
2935 For the JJY driver (type 40 mode 100 - 180), the argument is
2939 .It Xo Cm pollskewlist
2941 .Ar poll
2946 .Cm default
2950 Enable skewing of our poll requests to our servers.
2951 .Ar poll
2952 is a number between 3 and 17 inclusive, identifying a specific poll interval.
2953 A poll interval is 2^n seconds in duration,
2954 so a poll value of 3 corresponds to 8 seconds
2956 a poll interval of 17 corresponds to
2958 The next two numbers must be between 0 and one-half of the poll interval,
2961 specifies how early the poll may start,
2964 specifies how late the poll may be delayed.
2990 .Cm ntpd
2992 .Cm ntpq
2994 .Cm ntpdc .
2997 .Cm memlock Ar Nmegabytes |
2998 .Cm stacksize Ar N4kPages
2999 .Cm filenum Ar Nfiledescriptors
3002 .Bl -tag -width indent
3003 .It Cm memlock Ar Nmegabytes
3010 The default is 32 megabytes on non-Linux machines, and -1 under Linux.
3011 -1 means "do not lock the process into memory".
3013 .It Cm stacksize Ar N4kPages
3018 .It Cm filenum Ar Nfiledescriptors
3025 .Cm ntpq 's
3026 .Cm saveconfig
3029 .Cm saveconfigdir
3031 .Cm saveconfig
3033 .Cm ntpd .
3037 .Cm :config
3039 .Cm config-from-file
3041 .Cm ntpd
3045 .Cm saveconfigdir .
3047 .Cm saveconfigdir
3049 .Cm ntpd 's
3056 .Cm saveconfig\ ntp-%Y%m%d-%H%M%S.conf .
3058 .Cm savedconfig .
3060 .It Ic setvar Ar variable Op Cm default
3070 .Cm default
3098 .It Cm sysinfo
3100 .It Cm sysstats
3104 .Cm allan Ar allan |
3105 .Cm dispersion Ar dispersion |
3106 .Cm freq Ar freq |
3107 .Cm huffpuff Ar huffpuff |
3108 .Cm panic Ar panic |
3109 .Cm step Ar step |
3110 .Cm stepback Ar stepback |
3111 .Cm stepfwd Ar stepfwd |
3112 .Cm stepout Ar stepout
3133 .Bl -tag -width indent
3134 .It Cm allan Ar allan
3140 .It Cm dispersion Ar dispersion
3143 .It Cm freq Ar freq
3145 parts-per-million.
3148 .It Cm huffpuff Ar huffpuff
3150 huff-n'-puff filter span, which determines the most recent interval
3157 .It Cm panic Ar panic
3162 .It Cm step Ar step
3171 .It Cm stepback Ar stepback
3182 .It Cm stepfwd Ar stepfwd
3184 .It Cm stepout Ar stepout
3191 .It Cm writevar Ar assocID\ name = value [,...]
3194 .Cm assocID
3201 .Cm assocID
3204 .Op Cm port Ar port_number
3205 .Op Cm interface Ar interface_address
3217 .It Cm ttl Ar hop ...
3221 .Cm manycast
3222 mode these values are used in-turn in an expanding-ring search.
3231 .It Cm hop Ar ...
3234 In manycast mode these values are used in turn in
3235 an expanding-ring search.
3242 doc-section = {
3243 ds-type = 'FILES';
3244 ds-format = 'mdoc';
3245 ds-text = <<- _END_MDOC_FILES
3246 .Bl -tag -width /etc/ntp.drift -compact
3256 Diffie-Hellman agreement parameters
3261 doc-section = {
3262 ds-type = 'SEE ALSO';
3263 ds-format = 'mdoc';
3264 ds-text = <<- _END_MDOC_SEE_ALSO
3283 doc-section = {
3284 ds-type = 'BUGS';
3285 ds-format = 'mdoc';
3286 ds-text = <<- _END_MDOC_BUGS
3300 doc-section = {
3301 ds-type = 'NOTES';
3302 ds-format = 'mdoc';
3303 ds-text = <<- _END_MDOC_NOTES