2018-06-01 23:39:51 +00:00
.TH "Pi-hole" "8" "Pi-hole" "Pi-hole" "May 2018"
.SH "NAME"
Pi-hole : A black-hole for internet advertisements
.br
.SH "SYNOPSIS"
2018-07-13 01:38:43 +00:00
\fB pihole\fR (\fB -w\fR |\fB -b\fR |\fB --wild\fR |\fB --regex\fR ) [options] domain(s)
2018-06-01 23:39:51 +00:00
.br
\fB pihole -a\fR \fB -p\fR password
.br
2018-06-02 04:13:30 +00:00
\fB pihole -a\fR (\fB -c|-f|-k\fR )
2018-06-01 23:39:51 +00:00
.br
\fB pihole -a\fR [\fB -r\fR hostrecord]
.br
\fB pihole -a -e\fR email
.br
\fB pihole -a -i\fR interface
.br
\fB pihole -a -l\fR privacylevel
.br
\fB pihole -c\fR [-j|-r|-e]
.br
2018-06-03 12:15:26 +00:00
\fB pihole\fR \fB -d\fR [-a]
2018-06-01 23:39:51 +00:00
.br
\fB pihole -f
.br
pihole -r
.br
2018-06-03 12:15:26 +00:00
pihole -t
2018-06-01 23:39:51 +00:00
.br
pihole -g\fR
.br
\fB pihole\fR -\fB q\fR [options]
.br
2018-06-02 04:13:30 +00:00
\fB pihole\fR \fB -l\fR (\fB on|off|off noflush\fR )
2018-06-01 23:39:51 +00:00
.br
2019-06-30 06:02:51 +00:00
\fB pihole -up \fR [--check-only]
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
\fB pihole -v\fR [-p|-a|-f] [-c|-l|-hash]
.br
2018-06-01 23:39:51 +00:00
\fB pihole uninstall
.br
pihole status
.br
pihole restartdns\fR
.br
\fB pihole\fR (\fB enable\fR |\fB disable\fR [time])
.br
\fB pihole\fR \fB checkout\fR repo [branch]
.br
\fB pihole\fR \fB help\fR
.br
.SH "DESCRIPTION"
Available commands and options:
.br
\fB -w, whitelist\fR [options] [<domain1> <domain2 ...>]
.br
2018-06-02 04:13:30 +00:00
Adds or removes specified domain or domains tho the Whitelist
2018-06-01 23:39:51 +00:00
.br
\fB -b, blacklist\fR [options] [<domain1> <domain2 ...>]
.br
2018-06-02 04:13:30 +00:00
Adds or removes specified domain or domains to the blacklist
2018-06-01 23:39:51 +00:00
.br
2019-07-22 20:26:27 +00:00
\fB --regex, regex\fR [options] [<regex1> <regex2 ...>]
.br
Add or removes specified regex filter to the regex blacklist
.br
\fB --whiteregex\fR [options] [<regex1> <regex2 ...>]
.br
Add or removes specified regex filter to the regex whitelist
.br
2018-07-13 01:38:43 +00:00
\fB --wild, wildcard\fR [options] [<domain1> <domain2 ...>]
2018-06-01 23:39:51 +00:00
.br
2018-07-08 18:37:33 +00:00
Add or removes specified domain to the wildcard blacklist
.br
2019-07-22 20:26:27 +00:00
\fB --whitewild\fR [options] [<domain1> <domain2 ...>]
2018-07-08 18:37:33 +00:00
.br
2019-07-22 20:26:27 +00:00
Add or removes specified domain to the wildcard whitelist
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
(Whitelist/Blacklist manipulation options):
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-d, --delmode Remove domain(s) from the list
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-nr, --noreload Update list without refreshing dnsmasq
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-q, --quiet Make output less verbose
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-l, --list Display all your listed domains
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
--nuke Removes all entries in a list
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
\fB -d, debug\fR [-a]
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
Start a debugging session
2018-06-02 04:13:30 +00:00
.br
-a Enable automated debugging
2018-06-01 23:39:51 +00:00
.br
\fB -f, flush\fR
.br
2018-06-02 04:13:30 +00:00
Flush the Pi-hole log
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-06-01 23:39:51 +00:00
\fB -r, reconfigure\fR
.br
2018-06-02 04:13:30 +00:00
Reconfigure or Repair Pi-hole subsystems
2018-06-01 23:39:51 +00:00
.br
\fB -t, tail\fR
.br
2018-06-02 04:13:30 +00:00
View the live output of the Pi-hole log
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
\fB -a, admin\fR [options]
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
(Admin options):
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-p, password Set Web Interface password
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-c, celsius Set Celsius as preferred temperature unit
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-f, fahrenheit Set Fahrenheit as preferred temperature unit
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-k, kelvin Set Kelvin as preferred temperature unit
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
-r, hostrecord Add a name to the DNS associated to an
IPv4/IPv6 address
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
-e, email Set an administrative contact address for the
Block Page
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-i, interface Specify dnsmasq's interface listening behavior
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
-l, privacylevel <level> Set privacy level
2018-12-10 15:18:25 +00:00
(0 = lowest, 4 = highest)
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-06-01 23:39:51 +00:00
\fB -c, chronometer\fR [options]
.br
2018-06-03 12:15:26 +00:00
Calculates stats and displays to an LCD
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
(Chronometer Options):
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-j, --json Output stats as JSON formatted string
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-r, --refresh Set update frequency (in seconds)
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-e, --exit Output stats and exit witout refreshing
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
\fB -g, updateGravity\fR
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
Update the list of ad-serving domains
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
\fB -q, query\fR [option]
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
Query the adlists for a specified domain
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
(Query options):
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-adlist Print the name of the block list URL
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-exact Search the block lists for exact domain matches
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-all Return all query matches within a block list
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
\fB -h, --help, help\fR
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
Show a help dialog
2018-06-01 23:39:51 +00:00
.br
2018-06-30 03:34:15 +00:00
\fB -l, logging\fR [on|off|off noflush]
2018-06-01 23:39:51 +00:00
.br
2018-06-30 03:34:15 +00:00
Specify whether the Pi-hole log should be used
2018-06-01 23:39:51 +00:00
.br
(Logging options):
.br
2018-06-02 04:13:30 +00:00
on Enable the Pi-hole log at /var/log/pihole.log
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
off Disable and flush the Pi-hole log at
/var/log/pihole.log
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
off noflush Disable the Pi-hole log at /var/log/pihole.log
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-06-03 23:54:53 +00:00
\fB -up, updatePihole\fR [--check-only]
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
Update Pi-hole subsystems
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
--check-only Exit script before update is performed.
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
\fB -v, version\fR [repo] [options]
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
Show installed versions of Pi-hole, Web Interface & FTL
2018-06-01 23:39:51 +00:00
.br
2018-06-30 03:34:15 +00:00
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
(repo options):
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-p, --pihole Only retrieve info regarding Pi-hole repository
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
-a, --admin Only retrieve info regarding AdminLTE
repository
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-f, --ftl Only retrieve info regarding FTL repository
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
(version options):
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-c, --current Return the current version
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
-l, --latest Return the latest version
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
--hash Return the Github hash from your local
repositories
2018-06-01 23:39:51 +00:00
.br
\fB uninstall\fR
.br
2018-06-02 04:13:30 +00:00
Uninstall Pi-hole from your system
2018-06-01 23:39:51 +00:00
.br
\fB status\fR
.br
2018-06-02 04:13:30 +00:00
Display the running status of Pi-hole subsystems
2018-06-01 23:39:51 +00:00
.br
\fB enable\fR
.br
2018-06-02 04:13:30 +00:00
Enable Pi-hole subsystems
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:46:45 +00:00
\fB disable\fR [time]
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
Disable Pi-hole subsystems, optionally for a set duration
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-06-30 03:34:15 +00:00
(time options):
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
#s Disable Pi-hole functionality for # second(s)
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
#m Disable Pi-hole functionality for # minute(s)
2018-06-01 23:39:51 +00:00
.br
\fB restartdns\fR
.br
2018-06-02 04:13:30 +00:00
Restart Pi-hole subsystems
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
\fB checkout\fR [repo] [branch]
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
Switch Pi-hole subsystems to a different Github branch
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
(repo options):
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
core Change the branch of Pi-hole's core subsystem
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
web Change the branch of Admin Console subsystem
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
ftl Change the branch of Pi-hole's FTL subsystem
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
(branch options):
2018-06-01 23:39:51 +00:00
.br
2018-06-02 04:13:30 +00:00
master Update subsystems to the latest stable release
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
dev Update subsystems to the latest development
release
2018-06-02 04:13:30 +00:00
.br
branchname Update subsystems to the specified branchname
2018-06-01 23:39:51 +00:00
.br
.SH "EXAMPLE"
2018-06-02 04:13:30 +00:00
2018-06-01 23:39:51 +00:00
Some usage examples
.br
2018-07-29 01:28:25 +00:00
Whitelist/blacklist manipulation
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
\fB pihole -w iloveads.example.com\fR
2018-07-08 18:37:33 +00:00
.br
2018-07-29 01:28:25 +00:00
Adds "iloveads.example.com" to whitelist
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
\fB pihole -b -d noads.example.com\fR
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
Removes "noads.example.com" from blacklist
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
\fB pihole --wild example.com\fR
.br
Adds example.com as a wildcard - would block all subdomains of
example.com, including example.com itself.
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-07-29 01:28:25 +00:00
\fB pihole --regex "ad.*\\ .example\\ .com$"\fR
.br
Adds "ad.*\\ .example\\ .com$" to the regex blacklist.
Would block all subdomains of example.com which start with "ad"
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
Changing the Web Interface password
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-07-29 01:28:25 +00:00
\fB pihole -a -p ExamplePassword\fR
.br
Change the password to "ExamplePassword"
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
Updating lists from internet sources
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-07-29 01:28:25 +00:00
\fB pihole -g\fR
.br
Update the list of ad-serving domains
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-07-29 01:28:25 +00:00
Displaying version information
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-07-29 01:28:25 +00:00
\fB pihole -v -a -c\fR
.br
Display the current version of AdminLTE
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-07-29 01:28:25 +00:00
Temporarily disabling Pi-hole
.br
\fB pihole disable 5m\fR
.br
Disable Pi-hole functionality for five minutes
.br
Switching Pi-hole subsystem branches
.br
\fB pihole checkout master\fR
.br
Switch to master branch
2018-06-01 23:39:51 +00:00
.br
2018-06-03 12:15:26 +00:00
2018-07-29 01:28:25 +00:00
\fB pihole checkout core dev\fR
2018-06-01 23:39:51 +00:00
.br
2018-07-29 01:28:25 +00:00
Switch to core development branch
2018-06-01 23:39:51 +00:00
.br
2019-06-15 07:12:44 +00:00
\fB pihole arpflush\fR
.br
Flush information stored in Pi-hole's network tables
.br
2018-06-01 23:39:51 +00:00
.SH "SEE ALSO"
2018-06-03 12:15:26 +00:00
\fB lighttpd\fR (8), \fB pihole-FTL\fR (8)
2018-06-01 23:39:51 +00:00
.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