[Git][NTPsec/ntpsec][master] address bug #439: No HTML for ntplogtemp or ntp_keys
Matt Selsky
gitlab at mg.gitlab.com
Thu Jan 18 07:00:10 UTC 2018
Matt Selsky pushed to branch master at NTPsec / ntpsec
Commits:
3adde4a8 by James Browning at 2018-01-17T13:29:19-08:00
address bug #439: No HTML for ntplogtemp or ntp_keys
- - - - -
6 changed files:
- docs/includes/manual.txt
- + docs/includes/ntp.keys-body.txt
- docs/includes/ntplogtemp-body.txt
- + docs/ntp_keys.txt
- + docs/ntplogtemp.txt
- ntpd/ntp.keys-man.txt
Changes:
=====================================
docs/includes/manual.txt
=====================================
--- a/docs/includes/manual.txt
+++ b/docs/includes/manual.txt
@@ -1,16 +1,19 @@
=== Manual Pages ===
-* link:ntploggps.html[+ntploggps+ - log gpsd data for use by ntpviz]
+
* link:ntp_conf.html[+ntp.conf+ - ntpd Configuration File]
+* link:ntp_keys.html[+ntp.keys+ - NTP symmetric key file format]
* link:ntpd.html[+ntpd+ - Network Time Protocol (NTP) daemon]
* link:ntpdig.html[+ntpdig+ - Simple Network Time Protocol (SNTP) client]
* link:ntpfrob.html[+ntpfrob+ - frob the local clock hardware]
* link:ntpkeygen.html[+ntpkeygen+ - generate public and private keys]
* link:ntpleapfetch.html[+ntpleapfetch+ fetch and manage leap-offset file]
+* link:ntploggps.html[+ntploggps+ - log gpsd data for use by ntpviz]
+* link:ntplogtemp.html[+ntplogtemp+ - log system temperature data for use by ntpviz]
* link:ntpmon.html[+ntpmon+ - real-time NTP status monitor]
* link:ntpq.html[+ntpq+ - standard NTP query program]
* link:ntpsweep.html[+ntpsweep+ - print information about given NTP servers]
* link:ntptime.html[+ntptime+ - read and set kernel time variables]
-* link:ntptrace.html[`ntptrace` - trace a chain of NTP servers back to the primary source]
+* link:ntptrace.html[+ntptrace+ - trace a chain of NTP servers back to the primary source]
* link:ntpviz.html[+ntpviz+ - make offset, jitter, and other plots from logfiles]
* link:ntpwait.html[+ntpwait+ - wait until ntpd is in synchronized state]
=====================================
docs/includes/ntp.keys-body.txt
=====================================
--- /dev/null
+++ b/docs/includes/ntp.keys-body.txt
@@ -0,0 +1,75 @@
+== DESCRIPTION ==
+
+This document describes the format of an NTP symmetric key file. For a
+description of the use of this type of file, see the "Authentication
+Support" page of the Web documentation.
+
+{ntpdman} reads its keys from a file specified using the -k command line
+option or the 'keys' statement in the configuration file. While key
+number 0 is fixed by the NTP standard (as 56 zero bits) and may not be
+changed, one or more keys numbered between 1 and 65534 may be
+arbitrarily set in the keys file.
+
+The key file uses the same comment conventions as the configuration
+file. Key entries use a fixed format of the form
+
+--------------
+keyno type key
+--------------
+
+where `keyno` is a positive integer (between 1 and 65534),
+`type` is the message digest algorithm, and
+`key` is the key itself.
+
+The file does not need to be sorted by `keyno`.
+
+`type` can be any digest type supported by your OpenSSL package.
+You can probably get a list from `man 1 dgst` or `openssl help`.
+(As of Jan 2018, they lie. Be sure to try it. {ntpdman} will
+print an error on startup if a selected type isn't supported.)
+
+The following types are widely supported:
+-----
+ md5, sha1, ripemd160, sha224, sha256, sha384, sha512
+-----
+
+FIPS 140-2, FIPS 180-4, and/or FIPS 202 may restrict your choices.
+If it matters to you, check with your lawyer. (Let us know if you
+find a good reference.)
+
+The `key` may be printable ASCII excluding "#" or hex encoded.
+Keys longer than 20 characters are assumed to be hex. The max
+length of a (possibly de-hexified) key is 32 bytes. If you
+want to use an ASCII key longer than 20 bytes, you must hexify it.
+
+Note that the keys used by the {ntpqman} programs are
+checked against passwords entered by hand, so it is generally
+appropriate to specify these keys in ASCII format. Or you can
+cut-paste a hex string from your password manager.
+
+== USAGE ==
+
+In order to use symmetric keys, the client side configuration file needs:
+-----
+ keys <path-to-client-keys-file>
+ trustedkey <keyno>
+ server ... key <keyno>
+-----
+The server side needs:
+-----
+ keys <path-to-server-keys-file>
+ trustedkey <keyno>
+-----
+
+Note that the client and server key files must both contain identical
+copies of the line specified by keyno.
+
+
+== FILES ==
+
+`/etc/ntp.keys`::
+ is a common location for the keys file
+
+Reminder: You have to keep it secret.
+
+// end
=====================================
docs/includes/ntplogtemp-body.txt
=====================================
--- a/docs/includes/ntplogtemp-body.txt
+++ b/docs/includes/ntplogtemp-body.txt
@@ -67,7 +67,7 @@ The log file looks like:
This the simplest use of this program. It can be used to check the
temperature readings of Zones, CPU, and disk drives every minute.
-+ntplogtemp -l /var/log/ntpstats/temperature -w 60 &::
++ntplogtemp -l /var/log/ntpstats/temperature -w 60 &+::
This will continuously log the temperature data in the background
to the file /var/log/ntpstats/temperature. Only log every 60 seconds.
@@ -83,6 +83,7 @@ One of the following exit values will be returned:
== AUTHORS ==
Gary E. Miller
+
Keane S. Wolter
// end
=====================================
docs/ntp_keys.txt
=====================================
--- /dev/null
+++ b/docs/ntp_keys.txt
@@ -0,0 +1,37 @@
+= ntp.keys - NTP symmetric key file format =
+
+[cols="10%,90%",frame="none",grid="none",style="verse"]
+|==============================
+|image:pic/alice35.gif[]|
+{millshome}pictures.html[from 'Alice's Adventures in Wonderland', Lewis Carroll]
+
+Three can keep a secret, if two are dead.
+
+|==============================
+
+== More Help ==
+
+include::includes/manual.txt[]
+
+== Table of Contents ==
+
+* link:#_description[DESCRIPTION]
+* link:#_usage[USAGE]
+* link:#_files[FILES]
+* link:#_see_also[SEE ALSO]
+
+'''''
+
+include::includes/ntp.keys-body.txt[]
+
+'''''
+
+== SEE ALSO ==
+
+link:ntp_conf.html[{ntpdconfman}],
+link:ntpd.html[{ntpdman}],
+link:ntpq.html[{ntpqman}],
+link:ntpkeygen.html[{ntpkeygenman}],
+link:ntpdig.html[{ntpdigman}].
+
+include::includes/footer.txt[]
=====================================
docs/ntplogtemp.txt
=====================================
--- /dev/null
+++ b/docs/ntplogtemp.txt
@@ -0,0 +1,32 @@
+= ntplogtemp - log system temperature data for use by ntpviz =
+//FIXME: Image duplicates the one used for panda.txt
+
+[cols="10%,90%",frame="none",grid="none",style="verse"]
+|==============================
+|image:pic/panda.gif[]|
+{millshome}pictures.html[from the DARPA Atlantic SATNET Program (1979)]
+
+P is for patching.
+
+|==============================
+
+== Related Links ==
+
+include::includes/manual.txt[]
+
+== Table of Contents ==
+
+* link:#_synopsis[SYNOPSIS]
+* link:#_description[DESCRIPTION]
+* link:#_options[OPTIONS]
+* link:#_usage[USAGE]
+* link:#_exit_status[EXIT STATUS]
+* link:#_authors[AUTHORS]
+
+'''''
+
+include::includes/ntplogtemp-body.txt[]
+
+'''''
+
+include::includes/footer.txt[]
=====================================
ntpd/ntp.keys-man.txt
=====================================
--- a/ntpd/ntp.keys-man.txt
+++ b/ntpd/ntp.keys-man.txt
@@ -7,79 +7,7 @@
== NAME ==
ntp.keys - NTP symmetric key file format
-== DESCRIPTION ==
-
-This document describes the format of an NTP symmetric key file. For a
-description of the use of this type of file, see the "Authentication
-Support" page of the Web documentation.
-
-{ntpdman} reads its keys from a file specified using the -k command line
-option or the 'keys' statement in the configuration file. While key
-number 0 is fixed by the NTP standard (as 56 zero bits) and may not be
-changed, one or more keys numbered between 1 and 65534 may be
-arbitrarily set in the keys file.
-
-The key file uses the same comment conventions as the configuration
-file. Key entries use a fixed format of the form
-
---------------
-keyno type key
---------------
-
-where `keyno` is a positive integer (between 1 and 65534),
-`type` is the message digest algorithm, and
-`key` is the key itself.
-
-The file does not need to be sorted by `keyno`.
-
-`type` can be any digest type supported by your OpenSSL package.
-You can probably get a list from `man 1 dgst` or `openssl help`.
-(As of Jan 2018, they lie. Be sure to try it. {ntpdman} will
-print an error on startup if a selected type isn't supported.)
-
-The following types are widely supported:
------
- md5, sha1, ripemd160, sha224, sha256, sha384, sha512
------
-
-FIPS 140-2, FIPS 180-4, and/or FIPS 202 may restrict your choices.
-If it matters to you, check with your lawyer. (Let us know if you
-find a good reference.)
-
-The `key` may be printable ASCII excluding "#" or hex encoded.
-Keys longer than 20 characters are assumed to be hex. The max
-length of a (possibly de-hexified) key is 32 bytes. If you
-want to use an ASCII key longer than 20 bytes, you must hexify it.
-
-Note that the keys used by the {ntpqman} programs are
-checked against passwords entered by hand, so it is generally
-appropriate to specify these keys in ASCII format. Or you can
-cut-paste a hex string from your password manager.
-
-== USAGE ==
-
-In order to use symmetric keys, the client side configuration file needs:
------
- keys <path-to-client-keys-file>
- trustedkey <keyno>
- server ... key <keyno>
------
-The server side needs:
------
- keys <path-to-server-keys-file>
- trustedkey <keyno>
------
-
-Note that the client and server key files must both contain identical
-copies of the line specified by keyno.
-
-
-== FILES ==
-
-`/etc/ntp.keys`::
- is a common location for the keys file
-
-Reminder: You have to keep it secret.
+include::../docs/includes/ntp.keys-body.txt[]
== SEE ALSO ==
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/3adde4a85e1c4a88c20cf6201d499875e887d46f
---
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/3adde4a85e1c4a88c20cf6201d499875e887d46f
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/20180118/1ba906b5/attachment.html>
More information about the vc
mailing list