[pmg-devel] [PATCH v2 pmg-docs 1/2] add pmgqm timespan and timer/service edit info

[Mira Limbeck]

The case of customizing the service and timer files comes up from time
to time. As we haven't documented it yet, add it to the documentation
together with a clarification of the `yesterday` timespan parameter.

Signed-off-by: Mira Limbeck <m.limbeck at proxmox.com>
---
v2:
 - reworded based on Dylan's suggestions

 pmgqm.adoc | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/pmgqm.adoc b/pmgqm.adoc
index 08ad172..046c91e 100644
--- a/pmgqm.adoc
+++ b/pmgqm.adoc
@@ -27,6 +27,23 @@ endif::manvolnum[]
 
 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
+----
+
 ifdef::manvolnum[]
 include::pmg-copyright.adoc[]
 endif::manvolnum[]
-- 
2.30.2