[Git][NTPsec/ntpsec][master] Add many formatting changes ...
Matt Selsky
gitlab at mg.gitlab.com
Wed Oct 9 06:28:30 UTC 2019
Matt Selsky pushed to branch master at NTPsec / ntpsec
Commits:
519b1fe0 by James Browning at 2019-10-08T19:07:24Z
Add many formatting changes ...
The debug and standard HTML pages contain broken variable substitution that
render to things like "the {ntpfrob} program" instead of "the ntpfrob(8)
program" and "be reported by {ntpq}/{ntpmon}." instead of "be reported by
ntpq(1)/ntpmon(1)."
The ntpd-body includes simmilar but different errors like "the
/etc/{ntpconf} file" instead of "the /etc/ntp.conf file"
The access-commands and clock-options include problems with redefining
already placed anchors. Possible results are seeking to the wrong place in
the document when corresponding links are clicked.
- - - - -
6 changed files:
- docs/build.adoc
- docs/debug.adoc
- docs/includes/access-commands.adoc
- docs/includes/clock-options.adoc
- docs/includes/ntpd-body.adoc
- docs/standards.adoc
Changes:
=====================================
docs/build.adoc
=====================================
@@ -72,7 +72,7 @@ the executables by default in +/usr/local/bin+.
== Configuration
You are now ready to configure the daemon. You will need to create an 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)
daemon] page and move on to the specific configuration option pages from
=====================================
docs/debug.adoc
=====================================
@@ -154,7 +154,7 @@ Record the time of day and offset displayed by the +ntpq+
link:ntpq.html#peer[+peer+] command. Wait for an hour or so and record the
time of day and offset. Calculate the frequency as the offset difference
divided by the time difference. If the frequency offset is much above 100 ppm,
-the link:ntpfrob.html[{ntpfrob}] program might be useful to adjust the
+the link:ntpfrob.html[{ntpfrobman}] program might be useful to adjust the
kernel clock frequency below that value. For systems that do not support
this program, this might be one using a command in the system startup
file.
=====================================
docs/includes/access-commands.adoc
=====================================
@@ -109,7 +109,7 @@ though if it is otherwise unconfigured; no flags are associated with
the default entry (i.e., everything besides your own NTP server is
unrestricted).
-[[restrict]]
+[[unrestrict]]
+unrestrict+ _address_[/_cidr_] [+mask+ _mask_] [+flag+ +...+]::
Like a +restrict+ command, but turns off the specified flags rather
than turning them on (expected to be useful mainly with ntpq
=====================================
docs/includes/clock-options.adoc
=====================================
@@ -1,6 +1,6 @@
// Options for refclocks. Included twice.
-[[options]]
+[[options-inner]]
+refclock+ _drivername_ [+unit+ _u_] [+prefer+] [+subtype+ _int_] [+mode+ _int_] [+minpoll+ _int_] [+maxpoll+ _int_] [+time1+ _sec_] [+time2+ _sec_] [+stratum+ _int_] [+refid+ _string_] [+path+ 'filename'] [+ppspath+ 'filename'] [+baud+ 'number'] [+flag1+ {+0+ | +1+}] [+flag2+ {+0+ | +1+}] [+flag3+ {+0+ | +1+}] [+flag4+ {+0+ | +1+}]::
This command is used to configure reference clocks.
The required _drivername_ argument is the shortname of a driver type
=====================================
docs/includes/ntpd-body.adoc
=====================================
@@ -75,7 +75,7 @@ the IPv6 namespace.
+-c+ _string_, +--configfile+=_string_::
configuration file name.
+
-The name and path of the configuration file, +/etc/{ntpconf}+ by
+The name and path of the configuration file, `/etc/{ntpconf}` by
default.
+-d+, +--debug-level+::
@@ -91,7 +91,7 @@ default.
+
The name and path of the frequency file, +/etc/ntp.drift+ by default.
This is the same operation as the _driftfile_
-configuration specification in the +/etc/{ntpconf}+ file.
+configuration specification in the `/etc/{ntpconf}` file.
+-g+, +--panicgate+::
Allow the first adjustment to be big. This option may appear an
@@ -503,7 +503,7 @@ as described in {ntpdconfman}.
[options="header"]
|===================================================================
|File |Default |Option |Option
-|configuration file |+/etc/{ntpconf}+ |+-c+ |+conffile+
+|configuration file |`/etc/{ntpconf}` |+-c+ |+conffile+
|configuration directory |+/etc/ntp.d+ |+-c+ |+conffile+
|frequency file |none |+-f+ |+driftfile+
|leapseconds file |none | |+leapfile+
@@ -516,7 +516,7 @@ as described in {ntpdconfman}.
Configuration files are parsed according to the following rules:
-. The plain config file (normally +/etc/{ntpconf}+ but the path can be
+. The plain config file (normally `/etc/{ntpconf}` but the path can be
overridden by the -c option) is read first if it exists.
. Then the configuration directory, if it exists, is scanned. Normally
=====================================
docs/standards.adoc
=====================================
@@ -71,7 +71,7 @@ In the table of KISS codes (Figure 13), only RATE still exists and is
implemented in NTPsec; others proved unnecessary or (in the cases of
DENY and RSTR) outright dangerous. INIT and STEP are no longer KoD
types but persist as peer statuses that may be reported by
-{ntpqman}/{ntpmon}. NTPsec has additional codes DNS and NTS for
+{ntpqman}/{ntpmonman}. NTPsec has additional codes DNS and NTS for
preparatory phases in association setup.
The continuing relevance of much of Appendix A is doubtful.
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/519b1fe0e2510889008e1a275ca3c012ecf8b31e
--
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/519b1fe0e2510889008e1a275ca3c012ecf8b31e
You're receiving this email because of your account on gitlab.com.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20191009/dd66d815/attachment-0001.htm>
More information about the vc
mailing list