1
0
mirror of https://github.com/pi-hole/pi-hole synced 2024-12-22 14:58:08 +00:00

Requested changes to manpages - now align with docs.pi-hole.net/ftldns. weird bolding issues fixed

Signed-off-by: Rob Gill <rrobgill@protonmail.com>
This commit is contained in:
Rob Gill 2018-06-04 09:54:53 +10:00
parent ed7ebfd58d
commit 49fb4421dd
3 changed files with 56 additions and 18 deletions

View File

@ -18,8 +18,12 @@ pihole-FTL - Pi-hole : The Faster-Than-Light (FTL) Engine
.br .br
\fBpihole-FTL -f\fR \fBpihole-FTL -f\fR
.br .br
\fBpihole-FTL -h\fR
.br
\fBpihole-FTL dnsmasq-test\fR \fBpihole-FTL dnsmasq-test\fR
.br .br
\fBpihole-FTL --\fR (\fBoptions\fR)
.br
.SH "DESCRIPTION" .SH "DESCRIPTION"
Pi-hole : The Faster-Than-Light (FTL) Engine is a lightweight, purpose-built daemon used to provide statistics needed for the Pi-hole Web Interface, and its API can be easily integrated into your own projects. Although it is an optional component of the Pi-hole ecosystem, it will be installed by default to provide statistics. As the name implies, FTL does its work \fIvery\fR \fIquickly\fR! Pi-hole : The Faster-Than-Light (FTL) Engine is a lightweight, purpose-built daemon used to provide statistics needed for the Pi-hole Web Interface, and its API can be easily integrated into your own projects. Although it is an optional component of the Pi-hole ecosystem, it will be installed by default to provide statistics. As the name implies, FTL does its work \fIvery\fR \fIquickly\fR!
@ -28,7 +32,7 @@ Pi-hole : The Faster-Than-Light (FTL) Engine is a lightweight, purpose-built dae
Usage Usage
.br .br
\fB\fBservi\fRce pihole-FTL start\fR \fBservice pihole-FTL start\fR
.br .br
Start the pihole-FTL daemon Start the pihole-FTL daemon
.br .br
@ -80,6 +84,16 @@ Command line arguments
.br .br
Don't start FTL, show help Don't start FTL, show help
.br .br
\fBdnsmasq-test\fR
.br
Test resolver config file syntax
.br
\fB--\fR (options)
.br
Pass options to internal resolver
.br
.SH "EXAMPLE" .SH "EXAMPLE"
Command line arguments can be arbitrarily combined, e.g: Command line arguments can be arbitrarily combined, e.g:
.br .br
@ -92,3 +106,7 @@ Start ftl in foreground with more verbose logging, process everything and shutdo
.SH "SEE ALSO" .SH "SEE ALSO"
\fBpihole\fR(8), \fBpihole-FTL.conf\fR(5) \fBpihole\fR(8), \fBpihole-FTL.conf\fR(5)
.br .br
.SH "COLOPHON"
Get sucked into the latest news and community activity by entering Pi-hole's orbit. Information about Pi-hole, and the latest version of the software can be found at https://pi-hole.net
.br

View File

@ -8,57 +8,77 @@ pihole-FTL.conf - FTL's config file
/etc/pihole/pihole-FTL.conf will be read by \fBpihole-FTL(8)\fR on startup. /etc/pihole/pihole-FTL.conf will be read by \fBpihole-FTL(8)\fR on startup.
.br .br
SOCKET_LISTENING=localonly|all \fBSOCKET_LISTENING=localonly|all\fR
.br .br
Listen only for local socket connections or permit all connections Listen only for local socket connections or permit all connections
.br .br
QUERY_DISPLAY=yes|no \fBQUERY_DISPLAY=yes|no\fR
.br .br
Display all queries? Set to no to hide query display Display all queries? Set to no to hide query display
.br .br
AAAA_QUERY_ANALYSIS=yes|no \fBAAAA_QUERY_ANALYSIS=yes|no\fR
.br .br
Allow FTL to analyze AAAA queries from pihole.log? Allow FTL to analyze AAAA queries from pihole.log?
.br .br
MAXDBDAYS=365 \fBRESOLVE_IPV6=yes|no\fR
.br
How long should queries be stored in the database?
.br
Setting this to 0 disables the database altogether
.br
RESOLVE_IPV6=yes|no
.br .br
Should FTL try to resolve IPv6 addresses to host names? Should FTL try to resolve IPv6 addresses to host names?
.br .br
RESOLVE_IPV4=yes|no \fBRESOLVE_IPV4=yes|no\fR
.br .br
Should FTL try to resolve IPv4 addresses to host names? Should FTL try to resolve IPv4 addresses to host names?
.br .br
DBINTERVAL=1.0 \fBMAXDBDAYS=365\fR
.br
How long should queries be stored in the database?
.br
Setting this to 0 disables the database
.br
\fBDBINTERVAL=1.0\fR
.br .br
How often do we store queries in FTL's database [minutes]? How often do we store queries in FTL's database [minutes]?
.br .br
DBFILE=/etc/pihole/pihole-FTL.db \fBDBFILE=/etc/pihole/pihole-FTL.db\fR
.br .br
Specify path and filename of FTL's SQLite long-term database. Specify path and filename of FTL's SQLite long-term database.
.br .br
Setting this to DBFILE= disables the database altogether Setting this to DBFILE= disables the database altogether
.br .br
MAXLOGAGE=24.0 \fBMAXLOGAGE=24.0\fR
.br .br
Up to how many hours of queries should be imported from the database and logs? Up to how many hours of queries should be imported from the database and logs?
.br .br
Maximum is 744 (31 days) Maximum is 744 (31 days)
.br .br
\fBFTLPORT=4711\fR
.br
On which port should FTL be listening?
.br
\fBPRIVACYLEVEL=0|1|2|3\fR
.br
Which privacy level is used?
.br
\fBIGNORE_LOCALHOST=no|yes\fR
.br
Should FTL ignore queries coming from the local machine?
.br
\fBBLOCKINGMODE=IP|IP-AAAA-NODATA|NXDOMAIN|NULL\fR
.br
How should FTL reply to blocked queries?
.br
For each setting, the option shown first is the default. For each setting, the option shown first is the default.
.br .br
.SH "SEE ALSO" .SH "SEE ALSO"

View File

@ -181,7 +181,7 @@ Available commands and options:
off noflush Disable the Pi-hole log at /var/log/pihole.log off noflush Disable the Pi-hole log at /var/log/pihole.log
.br .br
\fB-up, updat\fBe\fR\fR\fBPihole\fR [--check-only] \fB-up, updatePihole\fR [--check-only]
.br .br
Update Pi-hole subsystems Update Pi-hole subsystems
.br .br
@ -277,7 +277,7 @@ Some usage examples
.br .br
\fBpihole -b -d noads.example.com\fR Remove "noads.example.com" from blacklist \fBpihole -b -d noads.example.com\fR Remove "noads.example.com" from blacklist
.br .br
\fB\fBpihole -wild example\fR.com\fR Add "example" as wildcard - would block ads.example.com, www.example.com etc. \fBpihole -wild example.com\fR Add "example.com" as wildcard - would block ads.example.com, www.example.com etc.
.br .br
Changing the Web Interface password Changing the Web Interface password