Pi-hole/pi-hole
Pi-hole/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole.git synced 2025-03-30 20:20:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update pihole-FTL.conf.5 based on comments from PR

Browse source 
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.
This commit is contained in:
Jim Grisham 2021-11-28 16:31:11 -05:00 • committed by GitHub
parent 131b365cc4
commit 1ddd24480e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
manpages/pihole-FTL.conf.5
View file

@ -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