[Git][NTPsec/ntpsec][master] Adding documentation files for temp-log script

[deamoneye]

deamoneye pushed to branch master at NTPsec / ntpsec


Commits:
2d6c756b by Keane Wolter at 2017-01-31T15:45:14-05:00
Adding documentation files for temp-log script

- - - - -


2 changed files:

- + contrib/temp-log-body.txt
- + contrib/temp-log.txt


Changes:

=====================================
contrib/temp-log-body.txt
=====================================
--- /dev/null
+++ b/contrib/temp-log-body.txt
@@ -0,0 +1,85 @@
+// This is the body of the manual page for temp-log
+// It's included in two places: once for the docs/ HTML
+// tree, and once to make an individual man page.
+
+== SYNOPSIS ==
+[verse]
+temp-log [-h] [-l LOGFILE] [-o] [-w WAIT] [-v] [-V]
+
+  -h, --help            show this help message and exit
+  -l LOGFILE, --logfile LOGFILE
+                        append log data to LOGFILE instead of stdout
+  -o, --once            log one line, then exit
+  -w WAIT, --wait WAIT  wait WAIT seconds after each log line, default 60
+  -v, --verbose         be verbose
+  -V, --version         show program's version number and exit
+
+== DESCRIPTION ==
+
+temp-log gathers temperature readings across a system.  temp-log must be
+run as root to be able to run sensor commands.
+
+The default is to write the data to stdout once every 60 seconds.
+The log file looks like:
+
+-----------------------------------------------------
+# time, sensor, value
+1485816568 ZONE0 39.0
+1485816568 ZONE1 20.0
+1485816568 ZONE2 42.0
+1485816568 ZONE3 0.0
+-----------------------------------------------------
+
++Time+ is the POSIX time of when the log line is written.
+
++Sensor+ is the sensor the temperature reading was obtained from.
+
++Value+ is the temperature reading in celsius.
+
+== OPTIONS ==
+
++-h, --help+::
+  Displays usage information and exits.
+
++-l LOGFILE, --logfile LOGFILE+::
+  Append log data to LOGFILE instead of stdout
+
++-o, --once+::
+  Log the data once, then exit
+
++-v, --verbose+::
+  Be verbose
+
++-w WAIT, --wait WAIT+::
+  Wait WAIT seconds after each log line.  The default is 60 seconds.  The
+  minimum wait time is 5 seconds.
+
++-V, --version+::
+ show program's version number and exit
+
+== USAGE ==
+
++temp-log+::
+  This the simplest use of this program. It can be used to check the
+  temperature readings of Zones, CPU, and disk drives every minute.
+
++gps-log -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.
+
+== EXIT STATUS ==
+
+One of the following exit values will be returned:
+
+0 (EXIT_SUCCESS)::
+  Successful program execution.
+1 (EXIT_FAILURE)::
+  The operation failed or the command syntax was not valid.
+
+== AUTHORS ==
+
+Gary E. Miller
+Keane S. Wolter
+
+// end
+


=====================================
contrib/temp-log.txt
=====================================
--- /dev/null
+++ b/contrib/temp-log.txt
@@ -0,0 +1,18 @@
+= temp-log - log tempd data for use by ntpviz =
+
+[cols="10%,90%",frame="none",grid="none",style="verse"]
+|==============================
+|image:pic/dogsnake.gif[]|
+{millshome}pictures.html[from 'Alice's Adventures in Wonderland', Lewis Carroll]
+
+S is for snakeoil.
+
+|==============================
+
+'''''
+
+include::includes/temp-log-body.txt[]
+
+'''''
+
+include::includes/footer.txt[]



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/2d6c756b7491faca90312b50520bd308dd2f5626
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20170131/bb17b80c/attachment.html>