summaryrefslogtreecommitdiff
path: root/ntpshmmon.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2015-03-02 18:15:27 -0500
committerEric S. Raymond <esr@thyrsus.com>2015-03-02 18:15:27 -0500
commitf4e3a55aa9445bcd76578cdf86ee3cdcfbbb0bc2 (patch)
tree9cc6ce97c4148d5e8a6c44c2ed1b2ec5f4a97678 /ntpshmmon.xml
parenta0a836b2129e62cee0267dc5c6cb32e0576ee311 (diff)
downloadgpsd-f4e3a55aa9445bcd76578cdf86ee3cdcfbbb0bc2.tar.gz
Added -n and -t termination options to ntpshmmon.
Diffstat (limited to 'ntpshmmon.xml')
-rw-r--r--ntpshmmon.xml23
1 files changed, 20 insertions, 3 deletions
diff --git a/ntpshmmon.xml b/ntpshmmon.xml
index 6a67fc7b..e343ab6e 100644
--- a/ntpshmmon.xml
+++ b/ntpshmmon.xml
@@ -23,7 +23,9 @@ BSD terms apply: see the file COPYING in the distribution root for details.
<cmdsynopsis>
<command>ntpshmmon</command>
<arg choice='opt'>-h </arg>
+ <arg choice='opt'>-n <replaceable>nsamples</replaceable></arg>
<arg choice='opt'>-s </arg>
+ <arg choice='opt'>-t <replaceable>seconds</replaceable></arg>
<arg choice='opt'>-v </arg>
<arg choice='opt'>-V </arg>
</cmdsynopsis>
@@ -38,9 +40,10 @@ ntpd, the Network Time Protocol daemon. It reads these in exactly the way an
ntpd instance does. It can be run concurrently with ntpd without
interfering with ntpd's normal operation.</para>
-<para>This program runs forever or until interrupted, generating
-sample reports to standard output. Each line consists of
-whitespace-separated textual fields.</para>
+<para>This program runs forever, or until a termination option is
+matched, or until interrupted, generating sample reports to standard
+output. Each line consists of whitespace-separated textual
+fields.</para>
<para>Here is an example of the beginning of a report file:
@@ -94,6 +97,13 @@ nanoseconds part of receiver time to be zero.</para>
</varlistentry>
<varlistentry>
+<term>-n</term>
+<listitem>
+<para>Set maximum number of samples to collect.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
<term>-s</term>
<listitem>
<para>Remove all segments specified by the units argument. This
@@ -102,6 +112,13 @@ option will normally only be of interest to GPSD developers.</para>
</varlistentry>
<varlistentry>
+<term>-t</term>
+<listitem>
+<para>Set maximum time to collect samples in seconds.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
<term>-h</term>
<listitem>
<para>Display program usage and exit.</para>