From 805cda48e4b99f70b5dc66dd41552e68832b0231 Mon Sep 17 00:00:00 2001
From: Julien Dessaux <julien.dessaux@adyxax.org>
Date: Wed, 15 Jan 2020 16:31:21 +0100
Subject: [PATCH] Document the spool file format

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index 2f5c98d..67e142f 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,10 @@ Here is a list of the possible error messages and their meaning :
   - `INFO No jobs exist in the state file` : no jobs were found in the state file.
   - `INFO Couldn't parse job name, this shouldn't happen : %s` : the program uses a regex to strip time and date from a job entry and it did not work. This is a bug in this program! Please open an issue.
 
+## Spool file
+
+Stored in `/var/lib/bareos/bareos-zabbix-check.spool`, this spool data is a simple csv vile format where every line contains a job name and the timestamp of the last successful execution for this job.
+
 ## Limitations
 
 ### No alerts if a job fails to start on its first run