[Git][NTPsec/ntpsec][master] Added documentation for ntpsnmpd config files.

[Ian Bruene]

Ian Bruene pushed to branch master at NTPsec / ntpsec


Commits:
c677c79f by Ian Bruene at 2018-03-05T18:08:34Z
Added documentation for ntpsnmpd config files.

- - - - -


1 changed file:

- docs/includes/ntpsnmpd-body.txt


Changes:

=====================================
docs/includes/ntpsnmpd-body.txt
=====================================
--- a/docs/includes/ntpsnmpd-body.txt
+++ b/docs/includes/ntpsnmpd-body.txt
@@ -17,7 +17,7 @@ running NTP and SNMP daemons for ntpsnmpd to work.
 == Options ==
 
 +-c+ filename, +--configfile+=filename::
-  The path of the configuration file, /etc/ntpsnmpd.conf by default
+  Alternate path for the configuration file, /etc/ntpsnmpd.conf by default
 +-n+, +--nofork+::
   Do not fork
 +-x+, +--master-addr+::
@@ -33,11 +33,63 @@ running NTP and SNMP daemons for ntpsnmpd to work.
 +-V+, +--version+::
   Print the version string and exit.
 
-== Files ==
+== Configuration Files ==
 
-/etc/ntpsnmpd.conf the default name of the configuration file
+=== /etc/ntpsnmpd.conf ===
 
-/var/ntpsnmpd/notify.conf the location of notification flags
+[[master-addr]]
++master-addr+ _addr_::
+  The address of the SNMP master agent to connect to. Can be either a named
+  socket or an IP address / hostname and port number.
+
+[[ntp-addr]]
++ntp-addr+ _addr_::
+  The address of the NTP daemon to monitor.
+
+[[logfile]]
++logfile+ _filename_::
+  Log debugging output to the specified file.
+
+[[loglevel]]
++loglevel+ _level_::
+  Threshold for log messages. Equivilent to -D
+
+=== /var/ntpsnmpd/notify.conf ===
+  This file is used to store the state of options that can be set
+  by writing to certain OIDs. Any comments will be overwritten by
+  ntpsnmpd upon write.
+
+[[notify-mode-change]]
++notify-mode-change+ [ True | False ]::
+  Enable notifications on ntpd mode change.
+
+[[notify-stratum-change]]
++notify-stratum-change+ [ True | False ]::
+  Enable notifications on NTP stratum change.
+
+[[notify-syspeer-change]]
++notify-syspeer-change+ [ True | False ]::
+  Enable notifications when ntpd selects a new system peer.
+
+[[notify-add-association]]
++notify-add-association+ [ True | False ]::
+  Enable notifications when ntpd adds a new peer.
+
+[[notify-rm-association]]
++notify-rm-association+ [ True | False ]::
+  Enable notifications when ntpd removes a peer.
+
+[[notify-leap-announced]]
++notify-leap-announced+ [ True | False ]::
+  Enable notifications on leap second announcement.
+
+[[notify-heartbeat]]
++notify-heartbeat+ [ True | False ]::
+  Send heartbeat notification.
+
+[[heartbeat-interval]]
++heartbeat-interval+ _interval_::
+  Frequency of heartbeat notification in integer seconds.
 
 == Known Limitations ==
 



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/c677c79f56c27c1e8ac34125114503c0060a22e1

---
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/c677c79f56c27c1e8ac34125114503c0060a22e1
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/20180305/ea4a4ab3/attachment.html>