Commit e455d306 authored by Eric S. Raymond's avatar Eric S. Raymond

Fix maerkup - in asciidoc, backticks suppress attribute expansion.

parent 991b7376
......@@ -19,7 +19,7 @@ include::includes/accopt.txt[]
== Access Control Support ==
The `{ntpd}` daemon implements a general purpose access control list (ACL)
The +{ntpd}+ daemon implements a general purpose access control list (ACL)
containing address/match entries sorted first by increasing address
values and then by increasing mask values. A match occurs when the
bitwise AND of the mask and the packet source address is equal to the
......@@ -27,19 +27,19 @@ bitwise AND of the mask and address in the list. The list is searched in
order with the last match found defining the restriction flags
associated with the entry.
The ACL is specified as a list of `restrict` commands in the following
The ACL is specified as a list of +restrict+ commands in the following
format:
`restrict address [mask mask] [flag][...]`
+restrict address [mask mask] [flag][...]+
The `address` argument expressed in dotted-quad form is the address of a
host or network. Alternatively, the `address` argument can be a valid
host DNS name. The `mask` argument expressed in IPv4 or IPv6 numeric
address form defaults to all mask bits on, meaning that the `address` is
The +address+ argument expressed in dotted-quad form is the address of a
host or network. Alternatively, the +address+ argument can be a valid
host DNS name. The +mask+ argument expressed in IPv4 or IPv6 numeric
address form defaults to all mask bits on, meaning that the +address+ is
treated as the address of an individual host. A default entry (address
0.0.0.0, mask 0.0.0.0 for IPv4 and address :: mask :: for IPv6) is
always the first entry in the list. `restrict default`, with no mask
option, modifies both IPv4 and IPv6 default entries. `restrict source`
always the first entry in the list. +restrict default+, with no mask
option, modifies both IPv4 and IPv6 default entries. +restrict source+
configures a template restriction automatically added at runtime for
each association, whether configured, ephemeral, or preemptable, and
removed when the association is demobilized.
......@@ -72,7 +72,7 @@ considered an alternative to the NTP authentication facilities. Source
address based restrictions are easily circumvented by a determined
cracker.
Default restriction list entries with the flags `ignore, ntpport`, for
Default restriction list entries with the flags +ignore, ntpport+, for
each of the local host's interface addresses are inserted into the table
at startup to prevent the server from attempting to synchronize to its
own time. A default entry is also always present, though if it is
......
......@@ -34,7 +34,7 @@ There are three types of associations in NTP: _persistent_,
_preemptable_ and _ephemeral_. Persistent associations are mobilized by
a configuration command and never demobilized. Preemptable associations
are mobilized by a configuration command which
includes the `preempt` option or upon arrival of an automatic server
includes the +preempt+ option or upon arrival of an automatic server
discovery packet. They are are demobilized by timeout or when preempted
by a "better" server, as described on the link:discover.html[Automatic
Server Discovery Schemes] page. Ephemeral associations are mobilized
......@@ -69,16 +69,16 @@ client (mode 3) request to the specified server and expects a server
described as a "pull" operation, in that the host pulls the time and
related values from the server.
A host is configured in client mode using the `server` (sic) command and
A host is configured in client mode using the +server+ (sic) command and
specifying the server DNS name or IPv4 or IPv6 address; the server
requires no prior configuration. The `iburst` option described later on
requires no prior configuration. The +iburst+ option described later on
this page is recommended for clients, as this speeds up initial
synchronization from several minutes to several seconds. The `burst`
synchronization from several minutes to several seconds. The +burst+
option described later on this page can be useful to reduce jitter on
very noisy dial-up or ISDN network links.
Ordinarily, the program automatically manages the poll interval between
the default minimum and maximum values. The `minpoll` and `maxpoll`
the default minimum and maximum values. The +minpoll+ and +maxpoll+
options can be used to bracket the range. Unless noted otherwise, these
options should not be used with reference clock drivers.
......@@ -106,16 +106,16 @@ message. Since an intruder can impersonate a symmetric active peer and
cause a spurious symmetric passive association to be mobilized,
symmetric passive mode should always be cryptographically validated.
A peer is configured in symmetric active mode using the `peer` command
A peer is configured in symmetric active mode using the +peer+ command
and specifying the other peer DNS name or IPv4 or IPv6 address. The
`burst` and `iburst` options should not be used in symmetric modes, as
+burst+ and +iburst+ options should not be used in symmetric modes, as
this can upset the intended symmetry of the protocol and result in
spurious duplicate or dropped messages.
As symmetric modes are most often used as root servers for moderate to
large subnets where rapid response is required, it is generally best to
set the minimum and maximum poll intervals of each root server to the
same value using the `minpoll` and `maxpoll` options.
same value using the +minpoll+ and +maxpoll+ options.
[[broad]]
== Broadcast/Multicast Modes ==
......@@ -129,11 +129,11 @@ a level-3 router, multicast mode can be used. Additional information is
on the link:discover.html[Automatic NTP Configuration Options] page.
A server is configured to send broadcast or multicast messages using the
`broadcast` command and specifying the subnet address for broadcast or
+broadcast+ command and specifying the subnet address for broadcast or
the multicast group address for multicast. A broadcast client is enabled
using the link:confopt.html#broadcastclient[`broadcastclient`] command,
using the link:confopt.html#broadcastclient[+broadcastclient+] command,
while a multicast client is enabled using the
link:confopt.html#multicastclient[`multicastclient`] command and
link:confopt.html#multicastclient[+multicastclient+] command and
specifying the multicast group address. Multiple commands of either type
can be used. However, the association is not mobilized until the first
broadcast or multicast message is actually received.
......@@ -158,7 +158,7 @@ link:discover.html[Automatic Server Discovery Schemes] page.
NTP uses an intricate heuristic algorithm to automatically control the
poll interval for maximum accuracy consistent with minimum network
overhead. The algorithm measures the incidental offset and jitter to
determine the best poll interval. When `{ntpd}` starts, the interval is
determine the best poll interval. When +{ntpd}+ starts, the interval is
the default minimum 64 sec. Under normal conditions when the clock
discipline has stabilized, the interval increases in steps to the
default maximum 1024 sec. In addition, should a server become unreachable
......@@ -177,8 +177,8 @@ interval, for example, the capture range is only 0.24 PPM.
In the NTPv4 specification and reference implementation, the poll
interval is expressed in log~2~ units, properly called the _poll
exponent._ It is constrained by the lower limit `minpoll` and upper
limit `maxpoll` options of the link:confopt.html[`server`] command. The
exponent._ It is constrained by the lower limit +minpoll+ and upper
limit +maxpoll+ options of the link:confopt.html[+server+] command. The
limits default to 6 (64 sec) and 10 (1024 sec), respectively, which are
appropriate for the vast majority of cases.
......@@ -209,8 +209,8 @@ hr), respectively.
== Burst Options ==
Occasionally it is necessary to send packets temporarily at intervals
less than the poll interval. For instance, with the `burst` and `iburst`
options of the link:confopt.html[`server`] command, the poll program
less than the poll interval. For instance, with the +burst+ and +iburst+
options of the link:confopt.html[+server+] command, the poll program
sends a burst of several packets at 2-sec intervals. In either case the
poll program avoids sending needless packets if the server is not
responding. The client begins a burst with a single packet. When the
......@@ -222,23 +222,23 @@ is not responding. Additional details are on the link:poll.html[Poll
Program] page.
There are two burst options where a single poll event triggers a burst.
They should be used only with the `server` and `pool` commands, but not
They should be used only with the +server+ and +pool+ commands, but not
with reference clock drivers nor symmetric mode peers. In both modes,
received server packets update the clock filter, which selects the best
(most accurate) time values. When the last packet in the burst is sent,
the next received packet updates the system variables and adjusts the
system clock as if only a single packet exchange had occurred.
The `iburst` option is useful where the system clock must be set quickly
The +iburst+ option is useful where the system clock must be set quickly
or when the network attachment requires an initial calling or training
sequence, as in PPP or ISDN services. In general, this option is
recommended for `server` and `pool` commands. A burst is sent only when
recommended for +server+ and +pool+ commands. A burst is sent only when
the server is unreachable; in particular, when first starting up.
Ordinarily, the clock is set within a few seconds after the first
received packet. See the link:clock.html[Clock State Machine] page for
further details about the startup behavior.
The `burst` option is useful in cases of severe network jitter or when
The +burst+ option is useful in cases of severe network jitter or when
the network attachment requires an initial calling or training sequence.
This option is recommended when the minimum poll exponent is larger than
10 (1024 sec). A burst is sent only when the server is reachable. The
......
......@@ -82,7 +82,7 @@ order to assure reliable operation, the signal level must be in the
range where the audio gain control is effective. In general, this means
the input signal level must be such as to cause the AGC to set the gain
somewhere in the middle of the range from 0 to 255, as indicated in the
timecode displayed by the `{ntpq}` program.
timecode displayed by the +{ntpq}+ program.
The IRIG driver operates by disciplining a logical clock based
on the codec sample clock to the audio signal as received. This is done
......@@ -92,16 +92,16 @@ audio signal, the sample clock frequency tolerance must be less than 250
PPM (.025 percent) for the IRIG driver.
The largest error observed so far is about 60 PPM, but it is possible
some sound cards or codecs may exceed that value. In any case, the
configuration file command `tinker codec` command can be used to change
configuration file command +tinker codec+ command can be used to change
the systematic offset in units of 125 PPM.
The drivers include provisions to select the input port and to monitor
the input signal. The `fudge flag 2` command selects the microphone port
the input signal. The +fudge flag 2+ command selects the microphone port
if set to zero or the line-in port if set to one. It does not seem
useful to specify the compact disc player port. The `fudge flag 3`
useful to specify the compact disc player port. The +fudge flag 3+
command enables the input signal monitor using the previously selected
output port and output gain. Both of these flags can be set in the
configuration file or remotely using the `{ntpq}` utility program.
configuration file or remotely using the +{ntpq}+ utility program.
[[short]]
== Shortwave Radio Drivers ==
......@@ -162,8 +162,8 @@ best WWV frequency is 15 MHz.
== Autotune Modes ==
The shortwave drivers include support for an optional autotune function
compatible with ICOM receivers and transceivers. The `mode` keyword of
the `server` configuration command specifies the ICOM ID select code in
compatible with ICOM receivers and transceivers. The +mode+ keyword of
the +server+ configuration command specifies the ICOM ID select code in
decimal. A missing or zero argument disables the CI-V interface. Since
all ICOM select codes are less than 128, the high order bit of the code
is used by the driver to specify the baud rate. If this bit is not set,
......@@ -193,7 +193,7 @@ radios.
The audio drivers include extensive setup and debugging support to help
hook up the audio signals and monitor the driver operations. The
documentation page for each driver describes the various messages that
can be produced either in real time or written to the `clockstats` file
can be produced either in real time or written to the +clockstats+ file
for later analysis. Of particular help in verifying signal connections
and compatibility is a provision to monitor the signal via headphones or
speaker.
......@@ -215,12 +215,12 @@ results in a level the line-in port can handle..
It is very easy to underdriven or overdrive the audio codec, in which
case the drivers will not synchronize to the signal. The drivers use
`fudge flag2` to enable audio monitoring of the input signal. This is
+fudge flag2+ to enable audio monitoring of the input signal. This is
useful during setup to confirm the signal is actually reaching the audio
codec and generally free of noise and interference. Note that the
monitor volume must be set before the driver is started.
The drivers write a synthesized timecode to the `clockstats` file each
The drivers write a synthesized timecode to the +clockstats+ file each
time the clock is set or verified and at other times if verbose
monitoring is enabled. The format includes several fixed-length fields
defining the UTC time to the millisecond, together with additional
......
......@@ -79,9 +79,9 @@ vulnerability analysis is in the white paper
//Directions for doing that are on the "Building and Installing the
//Distribution page."
//"or `autokey`" should be appended to the next line when it works
Authentication is configured separately for each association using the `key`
subcommand on the `peer`, `server`, `broadcast` and `manycastclient`
//"or +autokey+" should be appended to the next line when it works
Authentication is configured separately for each association using the +key+
subcommand on the +peer+, +server+, +broadcast+ and +manycastclient+
configuration commands. The authentication options described below
specify the locations of the key files, if other than default, which
symmetric keys are trusted and the interval between various
......@@ -97,9 +97,9 @@ discarded. Furthermore, the Autokey scheme requires a preliminary
protocol exchange to obtain the server certificate, verify its
credentials and initialize the protocol
The `auth` flag controls whether new associations or remote
The +auth+ flag controls whether new associations or remote
configuration commands require cryptographic authentication. This flag
can be set or reset by the `enable` and `disable` commands and also by
can be set or reset by the +enable+ and +disable+ commands and also by
remote configuration commands sent by a {ntpqman} program
running in another machine. If this flag is enabled, which is the
default case, new broadcast client and symmetric passive associations
......@@ -236,13 +236,13 @@ with each other, but may not represent good security practice.
The cryptotype of an association is determined at the time of
mobilization, either at configuration time or some time later when a
message of appropriate cryptotype arrives. When mobilized by a `server`
or `peer` configuration command and no `key` or `autokey` subcommands
are present, the association is not authenticated; if the `key`
message of appropriate cryptotype arrives. When mobilized by a +server+
or +peer+ configuration command and no +key+ or +autokey+ subcommands
are present, the association is not authenticated; if the +key+
subcommand is present, the association is authenticated using the
symmetric key ID specified.
//If the `autokey` subcommand is present, the
//If the +autokey+ subcommand is present, the
//association is authenticated using Autokey.
//
//When multiple identity schemes are supported in the Autokey protocol,
......@@ -338,14 +338,14 @@ routines required.
//support for the Autokey public key algorithms and protocol specified in
//RFC-5906 "Network Time Protocol Version 4: Autokey Specification". This
//support is available only if the OpenSSL library has been installed and
//the `--enable-autokey` option is used when the distribution is built.
//the +--enable-autokey+ option is used when the distribution is built.
//
//Public key cryptography is generally considered more secure than
//symmetric key cryptography, since the security is based on private and
//public values which are generated by each participant and where the
//private value is never revealed. Autokey uses X.509 public certificates,
//which can be produced by commercial services, the OpenSSL application
//program, or the link:keygen.html[`{ntpkeygen}`] utility program in the
//program, or the link:keygen.html[+{ntpkeygen}+] utility program in the
//NTP software distribution.
Note that according to US law, NTP binaries including OpenSSL library
......@@ -357,7 +357,7 @@ directly from OpenSSL, which is outside the US, and build outside the
US.
Authentication is configured separately for each association using the
`key` or `autokey` option of the `server` configuration command, as
+key+ or +autokey+ option of the +server+ configuration command, as
described in the link:confopt.html[Server Options] page. The
link:keygen.html[{ntpkeygen}] page describes the files required for the
various authentication schemes. Further details are in the briefings,
......@@ -370,9 +370,9 @@ authenticated packets, the server responds with authenticated packets if
correct, or a crypto-NAK packet if not.. In the case of unsolicited
packets which might consume significant resources, such as broadcast or
symmetric mode packets, authentication is required, unless overridden
by a `disable auth` command. In the current climate of targeted
by a +disable auth+ command. In the current climate of targeted
broadcast or "letterbomb" attacks, defeating this requirement would be
decidedly dangerous. In any case, the `notrust `flag, described on the
decidedly dangerous. In any case, the +notrust +flag, described on the
link:authopt.html[Access Control Options] page, can be used to disable
access to all but correctly authenticated clients..
......@@ -402,9 +402,9 @@ intruder cannot disrupt the protocol by sending a bogus crypto-NAK.
Keys and related information are specified in a keys file, which must be
distributed and stored using secure means beyond the scope of the NTP
protocol itself. Besides the keys used for ordinary NTP associations,
additional keys can be used as passwords for the `{ntpq}`
utility program. Ordinarily, the `{ntpkeys}` file is generated by the
`{ntpkeygen}` program, but it can be constructed and edited using an
additional keys can be used as passwords for the +{ntpq}+
utility program. Ordinarily, the +{ntpkeys}+ file is generated by the
+{ntpkeygen}+ program, but it can be constructed and edited using an
ordinary text editor.
Each line of the keys file consists of three fields: a key ID in the
......@@ -426,24 +426,24 @@ IDs in the range 11-20, the key is a 40-character hex digit string. The
key is truncated or zero-filled internally to either 128 or 160 bits,
depending on the key type. The line can be edited later or new lines can
be added to change any field. The key can be change to a password, such
as `2late4Me` for key ID 10. Note that two or more keys files can be
as +2late4Me+ for key ID 10. Note that two or more keys files can be
combined in any order as long as the key IDs are distinct.
When `{ntpd}` is started, it reads the keys file specified by the `keys`
When +{ntpd}+ is started, it reads the keys file specified by the +keys+
command and installs the keys in the key cache. However, individual keys
must be activated with the `trustedkey` configuration command before
must be activated with the +trustedkey+ configuration command before
use. This allows, for instance, the installation of possibly several
batches of keys and then activating a key remotely using `{ntpq}`.
The `controlkey` command selects the key ID used as the password
for the `{ntpq}` utility.
batches of keys and then activating a key remotely using +{ntpq}+.
The +controlkey+ command selects the key ID used as the password
for the +{ntpq}+ utility.
//[[windows]]
//== Microsoft Windows Authentication ==
//
//In addition to the above means, `{ntpd}` supports Microsoft Windows
//In addition to the above means, +{ntpd}+ supports Microsoft Windows
//MS-SNTP authentication using Active Directory services. This support was
//contributed by the Samba Team and is still in development. It is enabled
//using the `mssntp` flag of the `restrict` command described on the
//using the +mssntp+ flag of the +restrict+ command described on the
//link:accopt.html#restrict[Access Control Options] page. [red]#Note: Potential
//users should be aware that these services involve a TCP connection to
//another process that could potentially block, denying services to other
......
This diff is collapsed.
......@@ -21,7 +21,7 @@ include::includes/install.txt[]
* link:#win[Building and Installing for Windows]
* link:#conf[Configuration]
* link:#prob[If You Have Problems]
* link:#additional[Additional `waf` Commands]
* link:#additional[Additional +waf+ Commands]
'''''
......@@ -41,8 +41,8 @@ every individual computer and operating system with a common
executable, even with the same system but different versions and
options. Therefore, it is necessary to configure, build and install
for each system and version. In almost all cases, these procedures are
completely automatic, The user types `./waf configure`, `./waf build`,
and `./waf install` in that order and the build system does the
completely automatic, The user types +./waf configure+, +./waf build+,
and +./waf install+ in that order and the build system does the
rest. There are some exceptions, as noted below and on the
link:hints.html[Hints and Kinks] pages.
......@@ -58,23 +58,23 @@ This distribution uses common compilers and tools that come with most
Unix distributions. Not all of these tools exist in the standard
distribution of modern Unix versions (compilers are likely to be an
add-on product). If this is the case, consider using the GNU tools and
`gcc` compiler included as freeware in some systems. For a successful
+gcc+ compiler included as freeware in some systems. For a successful
build, all of these tools should be accessible via the current path.
The first thing to do is uncompress the distribution and extract the
source tree. In the distribution base directory use the
`./waf configure` command to perform an automatic configuration procedure.
+./waf configure+ command to perform an automatic configuration procedure.
This command inspects the hardware and software environment and
configures the build process accordingly. Use the `waf` command to
compile and link the distribution and the `install` command to install
the executables by default in `/usr/local/bin`.
configures the build process accordingly. Use the +waf+ command to
compile and link the distribution and the +install+ command to install
the executables by default in +/usr/local/bin+.
If your site supports multiple architectures and uses NFS to share
files, you can use a single source tree to build executables for
multiple architectures. While running on a particular architecture,
change to the base directory and create a subdirectory using a command
like `mkdir A.machine, `which will create an architecture-specific
directory, then change to this directory and mumble `../configure`. The
like +mkdir A.machine, +which will create an architecture-specific
directory, then change to this directory and mumble +../configure+. The
remaining steps are the same whether building in the base directory or
in the subdirectory.
......@@ -90,9 +90,9 @@ help or money so we can hire skilled technical help.
== Configuration ==
You are now ready to configure the daemon. You will need to create a NTP
configuration file by default in `/etc/{ntpconf}.` Newbies should see the
configuration file by default in +/etc/{ntpconf}+. Newbies should see the
link:quick.html[Quick Start] page for orientation. Seasoned veterans can
start with the link:ntpd.html[`{ntpd}` - Network Time Protocol (NTP)
start with the link:ntpd.html[+{ntpd}+ - Network Time Protocol (NTP)
daemon] page and move on to the specific configuration option pages from
there.
......@@ -103,7 +103,7 @@ If you have problems with your hardware and software environment (e.g.
operating system-specific issues), browse the link:hints.html[Hints and
Kinks] pages. For other problems a tutorial on debugging technique is in
the link:debug.html[NTP Debugging Technique] page. A list of important
system log messages is on the link:msyslog.html[`{ntpd}` System Log
system log messages is on the link:msyslog.html[+{ntpd}+ System Log
Messages] page.
The first line of general assistance is the {project-shortname} web site
......@@ -116,12 +116,12 @@ Users are invited to report bugs and offer suggestions via the
link:bugs.html[NTP Bug Reporting Procedures] page.
[[additional]]
== Additional `waf` commands ==
== Additional +waf+ commands ==
`./waf clean`::
+./waf clean+::
Cleans out object files, programs and temporary files.
`./waf distclean`::
Does the work of `clean`, but cleans out all directories in
+./waf distclean+::
Does the work of +clean+, but cleans out all directories in
preparation for a new distribution release.
......
......@@ -33,13 +33,13 @@ Most computers today incorporate a time-of-year (TOY) chip to maintain
the time when the power is off. When the computer is restarted, the chip
is used to initialize the operating system time. In case there is no TOY
chip or the TOY time is different from NTP time by more than the panic
threshold, the daemon `` assumes something must be terribly wrong, so
threshold, the daemon assumes something must be terribly wrong, so
exits with a message to the system operator to set the time manually.
With the `-g` option on the command line, the daemon sets the clock to
With the +-g+ option on the command line, the daemon sets the clock to
NTP time at the first update, but exits if the offset exceeds the panic
threshold at subsequent updates. The panic threshold default is 1000 s,
but it can be changed with the `panic` option of the
link:miscopt.html#tinker[`tinker`] command.
but it can be changed with the +panic+ option of the
link:miscopt.html#tinker[+tinker+] command.
[[step]]
== Step and Stepout Thresholds ==
......@@ -54,12 +54,12 @@ by default 300 s, the system clock is stepped to the correct time.
In practice, the need for a step has been extremely rare and almost
always the result of a hardware failure or operator error. The step
threshold and stepout threshold can be changed using the `step` and
`stepout` options of the link:miscopt.html#tinker[`tinker`] command,
threshold and stepout threshold can be changed using the +step+ and
+stepout+ options of the link:miscopt.html#tinker[+tinker+] command,
respectively. If the step threshold is set to zero, the step function is
entirely disabled and the clock is always slewed. The daemon sets the
step threshold to 600 s using the `-x` option on the command line. If
the `-g` option is used or the step threshold is set greater than 0.5 s,
step threshold to 600 s using the +-x+ option on the command line. If
the +-g+ option is used or the step threshold is set greater than 0.5 s,
the precision time kernel support is disabled.
Historically, the most important application of the step function was
......
......@@ -35,13 +35,13 @@ of candidates is greater than the _maxclock_ _threshold_, the association
is demobilized. This is useful in the schemes described on the
link:discover.html[Automatic Server Discovery Schemes] page. The
maxclock threshold default is 10, but it can be changed using the
`maxclock` option of the link:miscopt.html#tos[`tos`] command. Further
+maxclock+ option of the link:miscopt.html#tos[+tos+] command. Further
pruning is subject to the following termination conditions, but no
associations will be automatically demobilized.
The termination condition has two parts. First, if the number of
survivors is not greater than the _minclock_ _threshold_ set by the
`minclock` option of the link:miscopt.html#tos[`tos`] command, the
+minclock+ option of the link:miscopt.html#tos[+tos+] command, the
pruning process terminates. The _minclock_ default is 3, but can be
changed to fit special conditions, as described on the
link:prefer.html[Mitigation Rules and the prefer Keyword] page.
......
......@@ -47,9 +47,9 @@ to the default IPv4 address family. IPv6 addresses can be identified by
the presence of colons ":" in the address field. IPv6 addresses can be
used almost everywhere where IPv4 addresses can be used, with the
exception of reference clock addresses, which are always IPv4. Note that
in contexts where a host name is expected, a `-4` qualifier preceding
the host name forces DNS resolution to the IPv4 namespace, while a `-6`
qualifier forces DNS resolution to the IPv6 namespace.
in contexts where a host name is expected, a +-4+ qualifier preceding
the host name forces DNS resolution to the IPv4 namespace, while a
+-6+ qualifier forces DNS resolution to the IPv6 namespace.
[[association]]
== Association Commands ==
......
......@@ -139,7 +139,7 @@ mailto:kardel%28at%29ntp%28dot%29org[<kardel (at) ntp
modules for PARSE, support scripts, syslog cleanup, dynamic interface
handling
29. mailto:kuehn@ntp.org[Johannes Maximilian Kuehn <kuehn@ntp.org>]
Rewrote `sntp` to comply with NTPv4 specification, `ntpq saveconfig`
Rewrote +sntp+ to comply with NTPv4 specification, +ntpq saveconfig+
30. mailto:jones@hermes.chpc.utexas.edu[William L. Jones
<jones@hermes.chpc.utexas.edu>] RS/6000 AIX modifications, HPUX
modifications
......
This diff is collapsed.
This diff is collapsed.
......@@ -159,8 +159,8 @@ possibly lengthy convergence time. In a cold start when no frequency
file is available, the reference implementation first measures the
oscillator frequency over a five-min interval. This generally results in
a residual frequency error less than 1 PPM. The measurement interval can
be changed using the `stepout` option of the
link:miscopt.html#tinker[`tinker`] command.
be changed using the +stepout+ option of the
link:miscopt.html#tinker[+tinker+] command.
In order to reduce the clock offset error at restart, the reference
implementation next disables oscillator frequency discipline and enables
......@@ -168,15 +168,15 @@ clock offset discipline with a small time constant. This is designed to
quickly reduce the clock offset error without causing a frequency surge.
This configuration is continued for an interval of five-min, after which
the clock offset error is usually no more than a millisecond. The
measurement interval can be changed using the `stepout` option of the
link:miscopt.html#tinker[`tinker`] command.
measurement interval can be changed using the +stepout+ option of the
link:miscopt.html#tinker[+tinker+] command.
Another concern at restart is the time necessary for the select and
cluster algorithms to refine and validate the initial clock offset
estimate. Normally, this takes several updates before setting the system
clock. As the default minimum poll interval in most configurations is
about one minute, it can take several minutes before setting the system
clock. The `iburst` option of the link:confopt.html#burst[`server`]
clock. The +iburst+ option of the link:confopt.html#burst[+server+]
command changes the behavior at restart and is recommended for
client/server configurations. When this option is enabled, the client
sends a volley of six requests at intervals of two seconds. This usually
......@@ -192,8 +192,8 @@ When backup sources are included in the configuration, the reference
implementation waits an interval of several minutes without regular
sources before switching to backup sources. This is generally enough to
avoid startup transients due to premature switching to backup sources.
The interval can be changed using the `orphanwait` option of the
link:miscopt.html#tos[`tos`] command.
The interval can be changed using the +orphanwait+ option of the
link:miscopt.html#tos[+tos+] command.
'''''
......
This diff is collapsed.
......@@ -33,28 +33,28 @@ disabled if another source is available and operating.
== Monitor Data ==
No `filegen clockstats` monitor data are produced by this driver.
No +filegen clockstats+ monitor data are produced by this driver.
== Fudge Factors ==
`time1` 'time'::
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
with default 0.0.
`time2` 'time'::
+time2+ 'time'::
Specifies the frequency offset calibration factor, in parts per
million, with default 0.0.
`stratum` 'number'::
+stratum+ 'number'::
Specifies the driver stratum, in decimal from 0 to 15, with default 5.
`refid` 'string'::
+refid+ 'string'::
Specifies the driver reference identifier, an ASCII string from one to
four characters, with default `LOCL`.
`flag1 0 | 1`::
four characters, with default +LOCL+.
+flag1 {0 | 1}+::
Not used by this driver.
`flag2 0 | 1`::
+flag2 {0 | 1}+::
Not used by this driver.
`flag3 0 | 1`::
+flag3 {0 | 1}+::
Not used by this driver.
`flag4 0 | 1`::
+flag4 {0 | 1}+::
Not used by this driver.
== Additional Information ==
......
......@@ -6,7 +6,7 @@
Address: 127.127.10.'u'
Reference ID: GPS
Serial Port: /dev/gps__u__; 9600bps 8N1
Features: `tty_clk`
Features: +tty_clk+
== Deprecation warning ==
......@@ -28,7 +28,7 @@ to the receiver. For use with multiple computers, one of them is
connected directly to the receiver and generates the polling messages.
The other computers just listen to the receiver output directly or
through a buffer amplifier. For computers that just listen,
`fudge flag2` must be set and the `ppsclock` streams module configured
+fudge flag2+ must be set and the +ppsclock+ streams module configured
on each of them.
This receiver is capable of a comprehensive and large volume of
......@@ -42,29 +42,29 @@ of the distribution.
== Monitor Data ==
When enabled by the `flag4` fudge flag, every received timecode is
written as-is to the `clockstats` file.
When enabled by the +flag4+ fudge flag, every received timecode is
written as-is to the +clockstats+ file.
== Fudge Factors ==
`time1` 'time'::
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
with default 0.0.
`time2` 'time'::
+time2+ 'time'::
Not used by this driver.
`stratum` 'number'::
+stratum+ 'number'::
Specifies the driver stratum, in decimal from 0 to 15, with default 0.
`refid` 'string'::
+refid+ 'string'::
Specifies the driver reference identifier, an ASCII string from one to
four characters, with default `GPS`.
`flag1 0 | 1`::
four characters, with default +GPS+.
+flag1 {0 | 1}+::
Not used by this driver.
`flag2 0 | 1`::
+flag2 {0 | 1}+::
Set for computers that listen-only.
`flag3 0 | 1`::
+flag3 {0 | 1}+::
Not used by this driver.
`flag4 0 | 1`::
Enable verbose `clockstats` recording if set.
+flag4 {0 | 1}+::
Enable verbose +clockstats+ recording if set.
== Author ==
......
......@@ -24,14 +24,14 @@ receiving four or more satellites.
The receiver should be configured before starting the NTP daemon, in
order to establish reliable position and operating conditions. It does
not initiate surveying or hold mode. For use with NTP, the daylight
savings time feature should be disables (`D0` command) and the broadcast
mode set to operate in UTC (`BU` command).
savings time feature should be disables (+D0+ command) and the broadcast
mode set to operate in UTC (+BU+ command).
The timecode format supported by this driver is selected by the poll
sequence `B5`, which initiates a line in the following format to be
repeated once per second until turned off by the `B0` command.
sequence +B5+, which initiates a line in the following format to be
repeated once per second until turned off by the +B0+ command.
Format `B5` (24 ASCII printing characters):
Format +B5+ (24 ASCII printing characters):
-------------------------------------------------------
<cr><lf>i yy ddd hh:mm:ss.000bbb
......@@ -52,7 +52,7 @@ receiver status string (SR) is written to the clockstats file.
The time quality character is encoded in IEEE P1344 standard:
Format `TQ` (IEEE P1344 estimated worst-case time quality)
Format +TQ+ (IEEE P1344 estimated worst-case time quality)
-----------------------------------------
0 clock locked, maximum accuracy
......@@ -69,7 +69,7 @@ B clock unlocked, accuracy < 10 s
The status string is encoded as follows:
Format `SR` (25 ASCII printing characters)
Format +SR+ (25 ASCII printing characters)
----------------------------------------------
V=vv S=ss T=t P=pdop E=ee
......@@ -87,9 +87,9 @@ intrinsic jitter of the radio itself.
== Monitor Data ==
When enabled by the `flag4` fudge flag, an additional line containing
When enabled by the +flag4+ fudge flag, an additional line containing
the latitude, longitude, elevation and optional deviation data is
written to the `clockstats` file. The deviation data operates with an
written to the +clockstats+ file. The deviation data operates with an
external pulse-per-second (PPS) input, such as a cesium oscillator or
another radio clock. The PPS input should be connected to the B event
channel and the radio initialized for deviation data on that channel.
......@@ -99,24 +99,24 @@ over the last 16 seconds.
== Fudge Factors ==
`time1` 'time'::
+time1+ 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
with default 0.0.
`time2` 'time'::
+time2+ 'time'::
Not used by this driver.
`stratum` 'number'::
+stratum+ 'number'::
Specifies the driver stratum, in decimal from 0 to 15, with default 0.
`refid` 'string'::
+refid+ 'string'::
Specifies the driver reference identifier, an ASCII string from one to
four characters, with default `GPS`.
`flag1 0 | 1`::
four characters, with default +GPS+.
+flag1 {0 | 1}+::
Not used by this driver.
`flag2 0 | 1`::
+flag2 {0 | 1}+::
Not used by this driver.
`flag3 0 | 1`::
+flag3 {0 | 1}+::
Not used by this driver.
`flag4 0 | 1`::
Enable verbose `clockstats` recording if set.
+flag4 {0 | 1}+::
Enable verbose +clockstats+ recording if set.
== Author ==
......
......@@ -34,22 +34,22 @@ The actual line speed ranges from 1200 bps with USNO to 14,400 bps with