From 1ddd24480e13eb046b3b54a0a0f8081c46d363a7 Mon Sep 17 00:00:00 2001 From: Jim Grisham Date: Sun, 28 Nov 2021 16:31:11 -0500 Subject: [PATCH] Update pihole-FTL.conf.5 based on comments from PR Comments may actually start with `;` or `#` (anywhere in a line), but as the Pi-hole web front-end currently (as of 2021) relies on the PHP 'parse-ini-file' routine to read this file, use ';' unless you do not plan on installing the web interface. According to the PR comments, no comment token may necessarily be required by FTL itself, but `;` seems to protect any other special characters from blocking the current web interface from restarting FTL due to those php parsing peculiarities. --- manpages/pihole-FTL.conf.5 | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/manpages/pihole-FTL.conf.5 b/manpages/pihole-FTL.conf.5 index 7d4f1426..ba79c67f 100644 --- a/manpages/pihole-FTL.conf.5 +++ b/manpages/pihole-FTL.conf.5 @@ -1,14 +1,17 @@ -.TH "pihole-FTL.conf" "5" "pihole-FTL.conf" "pihole-FTL.conf" "November 2020" +.TH "pihole-FTL.conf" "5" "November 2021" "pihole-FTL.conf" "November 2021" .SH "NAME" -pihole-FTL.conf - FTL's config file +pihole-FTL.conf \- FTL's config file .br .SH "DESCRIPTION" /etc/pihole/pihole-FTL.conf will be read by \fBpihole-FTL(8)\fR on startup. -.br -Comments may start with ';' or '#' (anywhere in a line), but as the Pi-hole web front-end currently relies on the PHP 'parse-ini-file' routine to read this file, use ';' unless you do not plan on installing the web interface. -.br +.HP +.\" Warn the reader that bash-style comments must be preceded by a semicolon +.\" until the current (as of 2021) web interface is retired, since special +.\" characters such as # conflict with the PHP 'parse-ini-file' routine +Comments are allowed anywhere in a line. Comments should begin with a semicolon (';') if any use of the Pi-hole web interface is expected. +.P For each setting the option shown first is the default. .br