From d8bef9cdb0db9c38db829f78b8408ce64f79bd7b Mon Sep 17 00:00:00 2001
From: "Piotr F. Mieszkowski" <pfm@disroot.org>
Date: Fri, 13 May 2022 21:57:29 +0200
Subject: [PATCH] Explain syslog logging better in sample logging config

---
 gpg-lacre-logging.conf.sample | 24 ++++++++++++++++--------
 1 file changed, 16 insertions(+), 8 deletions(-)

diff --git a/gpg-lacre-logging.conf.sample b/gpg-lacre-logging.conf.sample
index 8de6b67..c3d458c 100644
--- a/gpg-lacre-logging.conf.sample
+++ b/gpg-lacre-logging.conf.sample
@@ -1,19 +1,23 @@
 # Example configuration for Lacre logging.  If you don't intend to change the
 # log format, you can just keep this file unchanged.
 
+# HANDLERS:
+#
+# Two main targets for log entries are defined here: syslog and a plain text
+# log file.  They are available as "handlers" named "syslog" and "lacrelog"
+# respectively.
+
 [loggers]
 keys=root
 
 [logger_root]
 level=NOTSET
-# Append ",syslog" to the following line if you want to send entries
-# to syslog too.
-handlers=lacrelog
+# Comma-separated handler names, see HANDLERS note at the top.
+handlers=syslog
 
 [handlers]
-# Append ",syslog" to the following line if you want to send entries
-# to syslog too.
-keys=lacrelog
+# Comma-separated handler names, see HANDLERS note at the top.
+keys=syslog
 
 [formatters]
 keys=postfixfmt
@@ -29,10 +33,14 @@ level=DEBUG
 formatter=postfixfmt
 args=('test/logs/lacre.log', 'a+')
 
+# You may want to change the second argument (handlers.SysLogHandler.LOG_MAIL)
+# to change the syslog facility used to record messages from Lacre.
 #
-# Logging to syslog is disabled by default, but you can enable it if
-# you like.
+# Options you can consider are "localX" facilities, available under names from
+# handlers.SysLogHandler.LOG_LOCAL0 to handlers.SysLogHandler.LOG_LOCAL7.
 #
+# Please refer to your syslog configuration for details on how to separate
+# records from different facilities.
 [handler_syslog]
 class=handlers.SysLogHandler
 level=INFO