diff options
| author | Eric S. Raymond <esr@thyrsus.com> | 2015-03-17 09:37:04 -0400 |
|---|---|---|
| committer | Eric S. Raymond <esr@thyrsus.com> | 2015-03-17 09:37:04 -0400 |
| commit | e0c70f343854df8c2fe723a87a5c434c8780e089 (patch) | |
| tree | 209d081a827eed761c2c618434bc69d659eebf8c /ntpshmmon.xml | |
| parent | ef2d01e4b190988b346e75a59d582429c3e893ac (diff) | |
| download | gpsd-e0c70f343854df8c2fe723a87a5c434c8780e089.tar.gz | |
Document the comment-line convention for ntpshmmon format.
Diffstat (limited to 'ntpshmmon.xml')
| -rw-r--r-- | ntpshmmon.xml | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/ntpshmmon.xml b/ntpshmmon.xml index 00486282..09007526 100644 --- a/ntpshmmon.xml +++ b/ntpshmmon.xml @@ -63,8 +63,12 @@ sample NTP3 1424926258.995647636 1424926258.995406476 1424926259.000000000 0 -20 version of the output format; the version line begins with "ntpshmmon version" and is followed by a numeric version field.</para> -<para>The remainder of the file is sample lines. The fields of a -sample line are as follows: +<para>The remainder of the file is either commments or sample lines. A +comment line begins with a # and should ignored by programs that +interpret this format. This program never generates such lines +itself.</para> + +<para>The fields of a sample line are as follows: <orderedlist> <listitem><para>The keyword "sample"</para></listitem> |