buildsys: add DSC target

[pmg-docs.git] / pmgqm.adoc

diff --git a/pmgqm.adoc b/pmgqm.adoc
index a957d56d302b4c3552326d8813bced3bcd23a659..130f29bb1d1121c89f6e1b35d00c10c8f875ddc9 100644 (file)
--- a/pmgqm.adoc
+++ b/pmgqm.adoc
@@ -20,12 +20,43 @@ DESCRIPTION
 -----------
 endif::manvolnum[]
 ifndef::manvolnum[]
-Quarantine Management Toolkit
-=============================
+pmgqm - Quarantine Management Toolkit
+=====================================
 :pmg-toplevel:
 endif::manvolnum[]
 
-Toolkit to manage spam an virus quarantine, and send spam report mails.
+Toolkit to manage spam and virus quarantine, and send spam report mails.
+
+The possible timespans are `week`, `yesterday`, and `today`. The default
+pmgspamreport.service is run at 00:05 every day and calls the `pmgqm` command
+with the `--timespan yesterday` parameter.
+This will send a spam report if at least one new spam mail was moved to the
+quarantine since the beginning of the previous day.
+
+The service can be edited, for example, to change the timespan to `today` or
+`week`, with the following command:
+----
+systemctl edit pmgspamreport.service
+----
+
+The timer can be edited with the command below:
+----
+systemctl edit pmgspamreport.timer
+----
+
+Note that adding another `OnCalendar` event will cause the report to be sent in
+addition to the default time. If you want to prevent the default email at
+00:05, you must first reset the original `OnCalendar` setting, For example, to
+send the emails *only* at 06:00 you would enter the following lines when
+editing the timer unit:
+
+----
+[Timer]
+OnCalendar=
+OnCalendar=06:00
+----
+
+For details see the systemd man pages: `systemd.unit(5)`, `systemd.timer(5)`.
 
 ifdef::manvolnum[]
 include::pmg-copyright.adoc[]