1
0
mirror of https://github.com/pi-hole/pi-hole synced 2025-01-05 13:40:56 +00:00

Requested changes (also tabs -> spaces)

Signed-off-by: Rob Gill <rrobgill@protonmail.com>
This commit is contained in:
Rob Gill 2018-06-02 14:13:30 +10:00 committed by GitHub
parent ef65bac79b
commit d01a568b8b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

182
pihole.8
View File

@ -9,7 +9,7 @@ Pi-hole : A black-hole for internet advertisements
.br .br
\fBpihole -a\fR \fB-p\fR password \fBpihole -a\fR \fB-p\fR password
.br .br
\fBpihole -a\fR (-c|-f|-k) \fBpihole -a\fR (\fB-c|-f|-k\fR)
.br .br
\fBpihole -a\fR [\fB-r\fR hostrecord] \fBpihole -a\fR [\fB-r\fR hostrecord]
.br .br
@ -33,10 +33,12 @@ pihole -g\fR
.br .br
\fBpihole\fR -\fBq\fR [options] \fBpihole\fR -\fBq\fR [options]
.br .br
\fBpihole\fR \fB-l\fR (on|off|off noflush) \fBpihole\fR \fB-l\fR (\fBon|off|off noflush\fR)
.br .br
\fBpihole -up \fR[--checkonly] \fBpihole -up \fR[--checkonly]
.br .br
\fBpihole -v\fR [-p|-a|-f] [-c|-l|-hash]
.br
\fBpihole uninstall \fBpihole uninstall
.br .br
pihole status pihole status
@ -56,269 +58,273 @@ Available commands and options:
\fB-w, whitelist\fR [options] [<domain1> <domain2 ...>] \fB-w, whitelist\fR [options] [<domain1> <domain2 ...>]
.br .br
Adds or removes specified domain or domains tho the Whitelist Adds or removes specified domain or domains tho the Whitelist
.br .br
\fB-b, blacklist\fR [options] [<domain1> <domain2 ...>] \fB-b, blacklist\fR [options] [<domain1> <domain2 ...>]
.br .br
Adds or removes specified domain or domains to the blacklist Adds or removes specified domain or domains to the blacklist
.br .br
\fB-wild, wildcard\fR [options] [<domain1> <domain2 ...>] \fB-wild, wildcard\fR [options] [<domain1> <domain2 ...>]
.br .br
Add or removes specified domain, and all subdomains to the blacklist Add or removes specified domain, and all subdomains to the blacklist
.br .br
(Whitelist/Blacklist manipulation options):
.br .br
(Whitelist/Blacklist manipulation options): -d, --delmode Remove domain(s) from the list
.br .br
-d, --delmode Remove domain(s) from the list -nr, --noreload Update list without refreshing dnsmasq
.br .br
-nr, --noreload Update list without refreshing dnsmasq -q, --quiet Make output less verbose
.br .br
-q, --quiet Make output less verbose -l, --list Display all your listed domains
.br .br
-l, --list Display all your listed domains --nuke Removes all entries in a list
.br
--nuke Removes all entries in a list
.br .br
\fB-d, debug\fR [\fB-a\fR] \fB-d, debug\fR [-a]
.br .br
Start a debugging session Add '-a' to enable automated debugging Start a debugging session
.br
-a Enable automated debugging
.br .br
\fB-f, flush\fR \fB-f, flush\fR
.br .br
Flush the Pi-hole log Flush the Pi-hole log
.br .br
.br .br
\fB-r, reconfigure\fR \fB-r, reconfigure\fR
.br .br
Reconfigure or Repair Pi-hole subsystems Reconfigure or Repair Pi-hole subsystems
.br .br
\fB-t, tail\fR \fB-t, tail\fR
.br .br
View the live output of the Pi-hole log View the live output of the Pi-hole log
.br .br
\fB-a, admin\fR [options] Console \fB-a, admin\fR [options]
.br .br
(Admin options):
.br .br
(Admin console options): -p, password Set Web Interface password
.br .br
-p, password Set Admin Console password -c, celsius Set Celsius as preferred temperature unit
.br .br
-c, celsius Set Celsius as preferred temperature unit -f, fahrenheit Set Fahrenheit as preferred temperature unit
.br .br
-f, fahrenheit Set Fahrenheit as preferred temperature unit -k, kelvin Set Kelvin as preferred temperature unit
.br .br
-k, kelvin Set Kelvin as preferred temperature unit -r, hostrecord Add a name to the DNS associated to an IPv4/IPv6 address
.br .br
-r, hostrecord Add a name to the DNS associated to an IPv4/IPv6 address -e, email Set an administrative contact address for the Block Page
.br .br
-e, email Set an administrative contact address for the Block Page -i, interface Specify dnsmasq's interface listening behavior
.br .br
-i, interface Specify dnsmasq's interface listening behavior -l, privacylevel <level> Set privacy level (0 = lowest, 3 = highest)
.br
-l, privacylevel <level> Set privacy level (0 = lowest, 3 = highest)
.br .br
.br .br
\fB-c, chronometer\fR [options] \fB-c, chronometer\fR [options]
.br .br
Calculates stats and displays to an LCD Calculates stats and displays to an LCD
.br .br
(Chronometer Options): (Chronometer Options):
.br .br
-j, --json Output stats as JSON formatted string -j, --json Output stats as JSON formatted string
.br .br
-r, --refresh Set update frequency (in seconds) -r, --refresh Set update frequency (in seconds)
.br .br
-e, --exit Output stats and exit witout refreshing -e, --exit Output stats and exit witout refreshing
.br .br
\fB-g, updateGravity\fR \fB-g, updateGravity\fR
.br .br
Update the list of ad-serving domains Update the list of ad-serving domains
.br .br
\fB-q, query\fR [option] \fB-q, query\fR [option]
.br .br
Query the adlists for a specified domain Query the adlists for a specified domain
.br .br
(Query options): (Query options):
.br .br
-adlist Print the name of the block list URL -adlist Print the name of the block list URL
.br .br
-exact Search the block lists for exact domain matches -exact Search the block lists for exact domain matches
.br .br
-all Return all query matches within a block list -all Return all query matches within a block list
.br .br
\fB-h, --help, help\fR \fB-h, --help, help\fR
.br .br
Show a help dialog Show a help dialog
.br .br
\fB-l, logging\fR [on|off|off noflush] \fB-l, logging\fR [on|off|off noflush]
.br .br
Specify whether the Pi-hole log should be used Specify whether the Pi-hole log should be used
.br .br
(Logging options): (Logging options):
.br .br
on Enable the Pi-hole log at /var/log/pihole.log on Enable the Pi-hole log at /var/log/pihole.log
.br .br
off Disable and flush the Pi-hole log at /var/log/pihole.log off Disable and flush the Pi-hole log at /var/log/pihole.log
.br .br
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
.br .br
\fB-up, updat\fBe\fR\fR\fBPihole\fR [--check-only] \fB-up, updat\fBe\fR\fR\fBPihole\fR [--check-only]
.br .br
Update Pi-hole subsystems Update Pi-hole subsystems
.br .br
Add '--check-only' to exit script before update is performed.
--check-only Exit script before update is performed.
.br .br
\fB-v, version\fR [repo] [options] \fB-v, version\fR [repo] [options]
.br .br
Show installed versions of Pi-hole, Admin Console &amp; FTL Show installed versions of Pi-hole, Web Interface &amp; FTL
.br .br
.br .br
(repo options): (repo options):
.br .br
-p, --pihole Only retrieve info regarding Pi-hole repository -p, --pihole Only retrieve info regarding Pi-hole repository
.br .br
-a, --admin Only retrieve info regarding AdminLTE repository -a, --admin Only retrieve info regarding AdminLTE repository
.br .br
-f, --ftl Only retrieve info regarding FTL repository -f, --ftl Only retrieve info regarding FTL repository
.br .br
(version options): (version options):
.br .br
-c, --current Return the current version -c, --current Return the current version
.br .br
-l, --latest Return the latest version -l, --latest Return the latest version
.br .br
--hash Return the Github hash from your local repositories --hash Return the Github hash from your local repositories
.br .br
\fBuninstall\fR \fBuninstall\fR
.br .br
Uninstall Pi-hole from your system Uninstall Pi-hole from your system
.br .br
\fBstatus\fR \fBstatus\fR
.br .br
Display the running status of Pi-hole subsystems Display the running status of Pi-hole subsystems
.br .br
\fBenable\fR \fBenable\fR
.br .br
Enable Pi-hole subsystems Enable Pi-hole subsystems
.br .br
\fBdisable\fR [time] \fBdisable\fR [time]
.br .br
Disable Pi-hole subsystems, optionally for a set duration Disable Pi-hole subsystems, optionally for a set duration
.br .br
.br .br
(time options): (time options):
.br .br
#s Disable Pi-hole functionality for # second(s) #s Disable Pi-hole functionality for # second(s)
.br .br
#m Disable Pi-hole functionality for # minute(s) #m Disable Pi-hole functionality for # minute(s)
.br .br
\fBrestartdns\fR \fBrestartdns\fR
.br .br
Restart Pi-hole subsystems Restart Pi-hole subsystems
.br .br
\fBcheckout\fR [repo][branch] \fBcheckout\fR [repo][branch]
.br .br
Switch Pi-hole subsystems to a different Github branch Switch Pi-hole subsystems to a different Github branch
.br .br
(repo options): (repo options):
.br .br
core Change the branch of Pi-hole's core subsystem core Change the branch of Pi-hole's core subsystem
.br .br
web Change the branch of Admin Console subsystem web Change the branch of Admin Console subsystem
.br .br
ftl Change the branch of Pi-hole's FTL subsystem ftl Change the branch of Pi-hole's FTL subsystem
.br .br
(branch options): (branch options):
.br .br
master Update subsystems to the latest stable release master Update subsystems to the latest stable release
.br .br
dev Update subsystems to the latest development release dev Update subsystems to the latest development release
.br
branchname Update subsystems to the specified branchname
.br .br
.SH "EXAMPLE" .SH "EXAMPLE"
Some usage examples Some usage examples
.br .br
Whitelist/blacklist manipulation Whitelist/blacklist manipulation
.br .br
\fBpihole -w iloveads.example.com\fR Add "iloveads.example.com" to whitelist \fBpihole -w iloveads.example.com\fR Add "iloveads.example.com" to whitelist
.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
\fBpihole -wild ads.example\fR Add "ads.example" as wildcard - would block ads.example.net \fBpihole -wild example\fR Add "example" as wildcard - would block ads.example.net, example.com etc.
.br .br
Changing the web ui password Changing the web ui password
.br .br
.br .br
\fBpihole -a -p ExamplePassword\fR Change the password to "ExamplePassword" \fBpihole -a -p ExamplePassword\fR Change the password to "ExamplePassword"
.br .br
Updating lists from internet sources Updating lists from internet sources
.br .br
.br .br
\fBpihole -g\fR Update the list of ad-serving domains \fBpihole -g\fR Update the list of ad-serving domains
.br .br
Displaying version information Displaying version information
.br .br
.br .br
\fBpihole -v -c\fR Display the current version of AdminLTE \fBpihole -v -a -c\fR Display the current version of AdminLTE
.br .br
.br .br
Temporarily disabling Pi-hole Temporarily disabling Pi-hole
.br .br
.br .br
\fBpihole disable 5m\fR Disable Pi-hole functionality for five minutes \fBpihole disable 5m\fR Disable Pi-hole functionality for five minutes
.br .br
.br .br
Switching Pi-hole subsystem branches Switching Pi-hole subsystem branches
.br .br
.br .br
\fBpihole checkout master\fR Switch to master branch \fBpihole checkout master\fR Switch to master branch
.br .br
\fBpihole checkout core dev\fR Switch to core development branch \fBpihole checkout core dev\fR Switch to core development branch
.br .br
.SH "SEE ALSO" .SH "SEE ALSO"
dmasq(8), lighttpd(8) dnsmasq(8), lighttpd(8)
.br .br
.SH "COLOPHON" .SH "COLOPHON"