From d4fa190243c7c9a3d8d568c54aae4ab4a40dddf7 Mon Sep 17 00:00:00 2001
From: DL6ER <dl6er@dl6er.de>
Date: Wed, 16 Jan 2019 09:49:15 +0100
Subject: [PATCH] Add configuration documentation for new debug flags

Signed-off-by: DL6ER <dl6er@dl6er.de>
---
 docs/ftldns/configfile.md | 62 ++++++++++++++++++++++++++++++++-------
 1 file changed, 52 insertions(+), 10 deletions(-)

diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md
index 28b1271..dd99564 100644
--- a/docs/ftldns/configfile.md
+++ b/docs/ftldns/configfile.md
@@ -2,13 +2,15 @@ You can create a file `/etc/pihole/pihole-FTL.conf` that will be read by *FTL*DN
 
 Possible settings (**the option shown first is the default**):
 
-On which port should FTL be listening?
-
 ## DNS settings
 
 ### BLOCKINGMODE
 `BLOCKINGMODE=NULL|IP-NODATA-AAAA|IP|NXDOMAIN`
 
+How should `FTL` reply to blocked queries?
+
+**[More details](blockingmode.md)**
+
 ## Statistics settings
 
 ### MAXLOGAGE
@@ -38,10 +40,6 @@ Allow `FTL` to analyze AAAA queries from pihole.log?
 
 Should `FTL` only analyze A and AAAA queries?
 
-How should `FTL` reply to blocked queries?
-
-**[More details](blockingmode.md)**
-
 ## Socket settings
 
 ### SOCKET_LISTENING
@@ -52,6 +50,8 @@ Listen only for local socket connections or permit all connections
 ### FTLPORT
 `FTLPORT=4711`
 
+On which port should FTL be listening?
+
 ## Host name resolution
 
 ### RESOLVE_IPV6
@@ -96,15 +96,57 @@ Specify path and filename of FTL's SQLite3 long-term database. Setting this to `
 **[More details](database.md)**
 
 ## Debugging options
+### DEBUG_DATABASE
+`DEBUG_DATABASE=false|true`
 
-### REGEX_DEBUGMODE
-```
-REGEX_DEBUGMODE=false|true
-```
+Print debugging information about database actions. This prints performed SQL statements as well as some general information such as the time it took to store the queries and how many have been saved to the database.
+
+### DEBUG_NETWORKING
+`DEBUG_NETWORKING=false|true`
+
+Prints a list of the detected interfaces on startup of `pihole-FTL`. Also prints whether these interfaces are IPv4 or IPv6 interfaces.
+
+### DEBUG_LOCKS
+`DEBUG_LOCKS=false|true`
+
+Print information about shared memory locks. Messages will be generated when waiting, obtaining, and releasing a lock.
+
+### DEBUG_QUERIES
+`DEBUG_QUERIES=false|true`
+
+Print extensive query information (domains, types, replies, etc.). This has always been part of the legacy `debug` mode of `pihole-FTL`.
+
+### DEBUG_FLAGS
+`DEBUG_FLAGS=false|true`
+
+Print flags of queries received by the DNS hooks. Only effective when `DEBUG_QUERIES` is enabled as well.
+
+### DEBUG_SHMEM
+`DEBUG_SHMEM=false|true`
+
+Print information about shared memory buffers. Messages are either about creating or enlarging shmem objects or string injections.
+
+### DEBUG_GC
+`DEBUG_GC=false|true`
+
+Print information about garbage collection (GC): What is to be removed, how many have been removed and how long did GC take.
+
+### DEBUG_ARP
+`DEBUG_ARP=false|true`
+
+Print information about ARP table processing: How long did parsing take, whether read MAC addresses are valid, and if the `macvendor.db` file exists.
+
+### DEBUG_REGEX
+`DEBUG_REGEX=false|true`
 
 Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`.
 
 **[More details](regex/overview.md)**
 
+Due to legacy reasons, we also support the following setting to be used for enabling the same functionality:
+
+`REGEX_DEBUGMODE=false|true`
+
+Note that if one of them is set to `true`, the other one cannot be used to disable this setting again.
 
 {!abbreviations.md!}