[ntpsec commit] Improve the ntpfrob web page.
Eric S. Raymond
esr at ntpsec.org
Sun Oct 18 09:51:12 UTC 2015
Module: ntpsec
Branch: master
Commit: 30b58bcbae425cfe98b2dccd4bfde2312e0dc1ed
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=30b58bcbae425cfe98b2dccd4bfde2312e0dc1ed
Author: Eric S. Raymond <esr at thyrsus.com>
Date: Sun Oct 18 05:48:34 2015 -0400
Improve the ntpfrob web page.
This change re-uses the orphaned graphic that used to be on the page
referring to autoconf. Where it said "Gnu autoconfigure tools are in
the backpack." it now says "Assorted doohickeys for clock-frobbing are
in the backpack."
---
devel-docs/TODO | 5 -----
docs/includes/ntpfrob-body.txt | 11 ++++++++---
docs/ntpfrob.txt | 16 ++++++++++++++++
3 files changed, 24 insertions(+), 8 deletions(-)
diff --git a/devel-docs/TODO b/devel-docs/TODO
index 1e75103..6eea9d6 100644
--- a/devel-docs/TODO
+++ b/devel-docs/TODO
@@ -85,8 +85,6 @@ they are salvageable.
=== Documentation ===
-* Write a glossary of Mills-speak.
-
* Short doc on how to tell your ntpd is running correctly.
Perhaps lifted from GPSD Time Service HOWTO?
@@ -99,9 +97,6 @@ they are salvageable.
scripts/plot_summary.txt
scripts/update-leap/update-leap.txt
-* Similarly, includes/footer.txt is a tabular hack made to resemble the
- old HTML and should be cleaned up.
-
* The format and organization of the NEWS file needs a rethink.
* Phabricator-centered workflow needs to be written up and integrated
diff --git a/docs/includes/ntpfrob-body.txt b/docs/includes/ntpfrob-body.txt
index 7ea9770..b48f4bf 100644
--- a/docs/includes/ntpfrob-body.txt
+++ b/docs/includes/ntpfrob-body.txt
@@ -2,17 +2,21 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
+[[synop]]
== Synopsis ==
+{ntpfrob}+ [ +-A+] [ +-a+ 'tick' ] [ +-p+ 'ppsdev' ] [+-c+] [+-e+] [+-s+]
+[[descr]]
== Description ==
The {ntpfrob} program frobs the local clock hardware. It collects
several small diagnostic functions into a set that will differ
-depending on your platform and underlying system calls.
-Portions of it formerly traveled as +tickadj+ and +ntptime+.
+depending on your platform and underlying system calls. Portions of
+it formerly traveled as +tickadj+ and some undocumented small
+utilities.
+[[cmd]]
== Command Line Options ==
+-a+ 'tick'::
@@ -30,7 +34,8 @@ Portions of it formerly traveled as +tickadj+ and +ntptime+.
+-j+::
Report in self-describing JSON.
-== Modes of operation ==
+[[usage]]
+== Usage ==
Documentation for some of these functions is scanty; this is a problem
inherited from ancient days along with their code. If you suspect
diff --git a/docs/ntpfrob.txt b/docs/ntpfrob.txt
index 65d819e..188e52d 100644
--- a/docs/ntpfrob.txt
+++ b/docs/ntpfrob.txt
@@ -1,5 +1,21 @@
= `ntpfrob` - frob the local clock hardware =
+[cols="10%,90%",frame="none",grid="none",style="verse"]
+|==============================
+|image:pic/pogo3a.gif[]|
+{millshome}pictures.html[from 'Pogo', Walt Kelly]
+
+Assorted doohickeys for clock-frobbing are in the backpack.
+
+|==============================
+
+== Table of Contents ==
+
+* link:#synop[Synopsis]
+* link:#descr[Description]
+* link:#cmd[Command Line Options]
+* link:#usage[Usage]
+
include::includes/ntpfrob-body.txt[]
'''''
More information about the vc
mailing list