pi-hole/pihole.8

.TH "Pi-hole" "8" "Pi-hole" "Pi-hole" "May 2018"
.SH "NAME"

Pi-hole : A black-hole for internet advertisements
.br
.SH "SYNOPSIS"

\fBpihole\fR (\fB-w\fR|\fB-b\fR|\fB-wild\fR) [options] domain(s)
.br
\fBpihole -a\fR \fB-p\fR password
.br
\fBpihole -a\fR (-c|-f|-k)
.br
\fBpihole -a\fR [\fB-r\fR hostrecord]
.br
\fBpihole -a -e\fR email
.br
\fBpihole -a -i\fR interface
.br
\fBpihole -a -l\fR privacylevel
.br
\fBpihole -c\fR [-j|-r|-e]
.br
\fBpihole\fR \fB-d\fR [-a] 
.br
\fBpihole -f
.br
pihole -r
.br
pihole -t 
.br
pihole -g\fR
.br
\fBpihole\fR -\fBq\fR [options]
.br
\fBpihole\fR \fB-l\fR (on|off|off noflush)
.br
\fBpihole -up \fR[--checkonly]
.br
\fBpihole uninstall
.br
pihole status
.br
pihole restartdns\fR
.br
\fBpihole\fR (\fBenable\fR|\fBdisable\fR [time])
.br
\fBpihole\fR \fBcheckout\fR repo [branch]
.br
\fBpihole\fR \fBhelp\fR
.br
.SH "DESCRIPTION"

Available commands and options:
.br

\fB-w, whitelist\fR [options] [<domain1> <domain2 ...>]
.br
	Adds or removes specified domain or domains tho the Whitelist
.br

\fB-b, blacklist\fR [options] [<domain1> <domain2 ...>]
.br
	Adds or removes specified domain or domains to the blacklist
.br

\fB-wild, wildcard\fR [options] [<domain1> <domain2 ...>]
.br
	Add or removes specified domain, and all subdomains to the blacklist
.br
		
.br
	(Whitelist/Blacklist manipulation options):
.br
		-d, --delmode   Remove domain(s) from the list
.br
		-nr, --noreload Update list without refreshing dnsmasq
.br
		-q, --quiet     Make output less verbose
.br
		-l, --list      Display all your listed domains
.br
		--nuke          Removes all entries in a list
.br

\fB-d, debug\fR [\fB-a\fR]	
.br
	Start a debugging session Add '-a' to enable automated debugging
.br

\fB-f, flush\fR
.br
	Flush the Pi-hole log
.br
		
.br
\fB-r, reconfigure\fR
.br
	Reconfigure or Repair Pi-hole subsystems
.br

\fB-t, tail\fR
.br
	View the live output of the Pi-hole log
.br

\fB-a, admin\fR [options] Console
.br
	
.br
	(Admin console options):
.br
		-p, password    Set Admin Console password
.br
		-c, celsius     Set Celsius as preferred temperature unit
.br
		-f, fahrenheit  Set Fahrenheit as preferred temperature unit
.br
		-k, kelvin      Set Kelvin as preferred temperature unit
.br
		-r, hostrecord  Add a name to the DNS associated to an IPv4/IPv6 address
.br
		-e, email       Set an administrative contact address for the Block Page
.br
		-i, interface   Specify dnsmasq's interface listening behavior
.br
		-l, privacylevel <level> Set privacy level (0 = lowest, 3 = highest)
.br
		
.br
\fB-c, chronometer\fR	[options]
.br
	Calculates stats and displays to an LCD 
.br

	(Chronometer Options):
.br
		-j, --json      Output stats as JSON formatted string
.br
		-r, --refresh   Set update frequency (in seconds)
.br
		-e, --exit      Output stats and exit witout refreshing
.br

\fB-g, updateGravity\fR	
.br
	Update the list of ad-serving domains
.br

\fB-q, query\fR [option]	
.br
	Query the adlists for a specified domain
.br

	(Query options):
.br
		-adlist     Print the name of the block list URL
.br
 		-exact      Search the block lists for exact domain matches
.br
 		-all        Return all query matches within a block list
.br

\fB-h, --help, help\fR	
.br
	Show a help dialog
.br

\fB-l, logging\fR [on|off|off noflush]	
.br
	Specify whether the Pi-hole log should be used 
.br

	(Logging options):
.br
		on Enable the Pi-hole log at /var/log/pihole.log
.br
		off Disable and flush the Pi-hole log at /var/log/pihole.log
.br
		off noflush Disable the Pi-hole log at /var/log/pihole.log
.br
	
.br
\fB-up, updat\fBe\fR\fR\fBPihole\fR [--check-only]	
.br
	Update Pi-hole subsystems 
.br
		Add '--check-only' to exit script before update is performed.
.br

\fB-v, version\fR [repo] [options]	
.br
	Show installed versions of Pi-hole, Admin Console &amp; FTL
.br
 
.br
 	(repo options):
.br
		-p, --pihole    Only retrieve info regarding Pi-hole repository
.br
		-a, --admin     Only retrieve info regarding AdminLTE repository
.br
		-f, --ftl       Only retrieve info regarding FTL repository
.br
	(version options):
.br
		-c, --current   Return the current version
.br
		-l, --latest    Return the latest version
.br
		--hash          Return the Github hash from your local repositories
.br

\fBuninstall\fR
.br
	Uninstall Pi-hole from your system
.br

\fBstatus\fR
.br
	Display the running status of Pi-hole subsystems
.br

\fBenable\fR
.br
	Enable Pi-hole subsystems
.br

\fBdisable\fR	[time]
.br
	Disable Pi-hole subsystems, optionally for a set duration
.br
		
.br
	(time options):	
.br
		#s  Disable Pi-hole functionality for # second(s)
.br
		#m  Disable Pi-hole functionality for # minute(s)
.br

\fBrestartdns\fR
.br
	Restart Pi-hole subsystems
.br

\fBcheckout\fR [repo][branch]	
.br
	Switch Pi-hole subsystems to a different Github branch
.br

	(repo options):
.br
		core        Change the branch of Pi-hole's core subsystem
.br
		web         Change the branch of Admin Console subsystem
.br
		ftl         Change the branch of Pi-hole's FTL subsystem
.br
	(branch options):
.br
		master      Update subsystems to the latest stable release
.br
		dev         Update subsystems to the latest development release
.br

.SH "EXAMPLE"
Some usage examples
.br

	Whitelist/blacklist manipulation
.br

	\fBpihole -w iloveads.example.com\fR	Add "iloveads.example.com" to whitelist
.br
	\fBpihole -b -d noads.example.com\fR	Remove "noads.example.com" from blacklist 
.br
	\fBpihole -wild ads.example\fR		Add "ads.example" as wildcard - would block ads.example.net
.br

	Changing the web ui password
.br
	
.br
	\fBpihole -a -p ExamplePassword\fR	Change the password to "ExamplePassword"
.br

	Updating lists from internet sources
.br
	
.br
	\fBpihole -g\fR						Update the list of ad-serving domains
.br

	Displaying version information
.br
	
.br
	\fBpihole -v -c\fR					Display the current version of AdminLTE
.br
	
.br
	Temporarily disabling Pi-hole
.br
	
.br
	\fBpihole disable 5m\fR				Disable Pi-hole functionality for five minutes
.br
	
.br
	Switching Pi-hole subsystem branches
.br
	
.br
	\fBpihole checkout master\fR			Switch to master branch
.br
	\fBpihole checkout core dev\fR		Switch to core development branch
.br
.SH "SEE ALSO"

dmasq(8), lighttpd(8)
.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