From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Sat, 25 Apr 2009 21:56:27 +0000 (+0200)
Subject: collectd.conf(5): Add some information about the AuthFile format.
X-Git-Tag: collectd-4.7.0~40^2
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=1c1ebb06259ee0fd215faf5c0c4d722bb48ea726;p=collectd.git

collectd.conf(5): Add some information about the AuthFile format.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index a3834ff3..ad7cc210 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1651,6 +1651,17 @@ verified and encrypted packets are decrypted. Otherwise, signed data is
 accepted without checking the signature and encrypted data cannot be decrypted.
 For the other security levels this option is mandatory.
 
+The file format is very simple: Each line consists of a username followed by a
+colon and any number of spaces followed by the password. To demonstrate, an
+example file could look like this:
+
+  user0: foo
+  user1: bar
+
+Each time a packet is received, the modification time of the file is checked
+using L<stat(2)>. If the file has been changed, the contents is re-read. While
+the file is being read, it is locked using L<fcntl(2)>.
+
 =back
 
 =item B<TimeToLive> I<1-255>