[PATCH] large restructure of format

Paul Theodoropoulos paul at anastrophe.com
Fri Jun 22 20:41:05 UTC 2018


---
 docs/includes/ntpviz-body.txt | 61 ++++++++++++++-----------------------------
 1 file changed, 20 insertions(+), 41 deletions(-)

diff --git a/docs/includes/ntpviz-body.txt b/docs/includes/ntpviz-body.txt
index 1329ba4f4..dca76218c 100644
--- a/docs/includes/ntpviz-body.txt
+++ b/docs/includes/ntpviz-body.txt
@@ -4,32 +4,11 @@
 
 == SYNOPSIS ==
 [verse]
-ntpviz [-d LOGDIR] [-g] [-n name] [-p DAYS]
-         [-s starttime] [-e endtime]
-         [-o OUTDIR]
-         [-c | --clip]
-         [-w SIZE | --width SIZE]
-         [--all-peer-jitters |
-          --all-peer-offsets |
-          --local-error |
-          --local-freq-temps |
-          --local-gps |
-          --local-jitter |
-          --local-offset |
-          --local-offset-histogram |
-          --local-offset-multiplot |
-          --local-stability |
-          --local-temps |
-          --peer-jitters=hosts |
-          --peer-offsets=hosts]
-         [-D DLVL | --debug DLVL]
-         [-N | --nice]
-         [-V | --version]
-         [@OPTIONFILE]
+ntpviz   [OPTION...] [@OPTIONFILE]
 
 == DESCRIPTION ==
 
-This utility analyzes files in an NTP log directory and generates
+ntpviz analyzes files in an NTP log directory and generates
 statistical plots from them.  It can output either PNG images or the
 gnuplot programs to generate them to standard output.  In its default
 mode it generates an HTML directory containing an index page and
@@ -38,46 +17,46 @@ subset of comparative plots for multiple directories.
 
 === Basic Options ===
 
+-c or --clip::
+    Normally all data are plotted.  This option limits the range of
+    the plots to the data between 1% and 99%.  This is useful for
+    ignoring a few spikes in the data.
+
 -d LOGDIR or --datadir LOGDIR::
     Specifies one or more logfile directories to examine; the default is
     the single directory /var/log/ntpstats.
 
+-e TIME or --endtime TIME::
+    With -s and -e you set the start and end times.  TIME is either numeric
+    POSIX time (seconds since the start of the epoch) or ISO 8601-style
+    timestamps (yyyy-mmm-ddThh:mm:ss). +
+    The default end time is the last logfile entry timestamp.   +
+    The default start time is computed as the end time minus DAYS. +
+    Alternatively you may specify either -s or -e (but not both) and use
+    -p to set the plot period in days.
+
 -g or --generate::
     Run plot through gnuplot to make png.  The default is to generate
     gnuplot programs.
 
+-n STR or --name STR::
+    Set the sitename shown in the plot title, and is effective only for the
+    single-directory case. The default is the basename of the log directory.
+
 -o OUTDIR or --outdir OUTDIR::
     Set the directory for all output to be OUTDIR.  If OUTDIR does
     not exist it is created.  The default OUTDIR is 'ntpgraphs'.
     Warning: existing PNG files and index.html in the output directory
     will be clobbered.
 
--n STR or --name STR::
-    Set the sitename shown in the plot title, and is effective only for the
-    single-directory case. The default is the basename of the log directory.
-
 -p DAYS or --period DAYS::
     The default DAYS is for the period of 7 days.  DAYS can be a
     floating point number, so "-p 0.5" plots 12 hours.  DAYS is ignored
     if -s and -e are given.
 
--e TIME or --endtime TIME::
-    With -s and -e you set the start and end times.  TIME is either numeric
-    POSIX time (seconds since the start of the epoch) or ISO 8601-style
-    timestamps (yyyy-mmm-ddThh:mm:ss). +
-    The default end time is the last logfile entry timestamp.   +
-    The default start time is computed as the end time minus DAYS. +
-    Alternatively you may specify either -s or -e (but not both) and use
-    -p to set the plot period in days.
-
 -s TIME or --starttime TIME::
     See -e and -p.
 
--c or --clip::
-    Normally all the data is plotted.  This option limits the range of
-    the plots to the data between 1% and 99%.  This is useful for
-    ignoring a few spikes in the data.
-
 -w SIZE or --width SIZE::
     Set the size of the output plots.  SIZE can be one of 's', 'm', or 'l'.
     's' is for browser on small screens (1024x768).  'm' for medium screens
-- 
2.11.0



More information about the devel mailing list