Skip to content

Commit

Permalink
nroff checked pihole.8 for formatting. nroff -man pihole.8
Browse files Browse the repository at this point in the history
Signed-off-by: Dan Schaper <[email protected]>
  • Loading branch information
dschaper committed Jul 29, 2018
1 parent 9668188 commit f90c412
Showing 1 changed file with 56 additions and 25 deletions.
81 changes: 56 additions & 25 deletions manpages/pihole.8
Original file line number Diff line number Diff line change
Expand Up @@ -125,13 +125,16 @@ Available commands and options:
.br
-k, kelvin Set Kelvin as preferred temperature unit
.br
-r, hostrecord Add a name to the DNS associated to an IPv4/IPv6 address
-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
-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)
-l, privacylevel <level> Set privacy level
(0 = lowest, 3 = highest)
.br

\fB-c, chronometer\fR [options]
Expand Down Expand Up @@ -181,7 +184,8 @@ Available commands and 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
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
Expand All @@ -204,7 +208,8 @@ Available commands and options:
.br
-p, --pihole Only retrieve info regarding Pi-hole repository
.br
-a, --admin Only retrieve info regarding AdminLTE repository
-a, --admin Only retrieve info regarding AdminLTE
repository
.br
-f, --ftl Only retrieve info regarding FTL repository
.br
Expand All @@ -214,7 +219,8 @@ Available commands and options:
.br
-l, --latest Return the latest version
.br
--hash Return the Github hash from your local repositories
--hash Return the Github hash from your local
repositories
.br

\fBuninstall\fR
Expand Down Expand Up @@ -266,7 +272,8 @@ Available commands and options:
.br
master Update subsystems to the latest stable release
.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
Expand All @@ -275,50 +282,74 @@ Available commands and options:
Some usage examples
.br

Whitelist/blacklist manipulation
Whitelist/blacklist manipulation
.br

\fBpihole -w iloveads.example.com\fR Add "iloveads.example.com" to whitelist
\fBpihole -w iloveads.example.com\fR
.br
\fBpihole -b -d noads.example.com\fR Remove "noads.example.com" from blacklist
Adds "iloveads.example.com" to whitelist
.br
\fBpihole --wild example.com\fR Add example.com as a wildcard - would
block all subdomains of example.com, including example.com itself.

\fBpihole -b -d noads.example.com\fR
.br
\fBpihole --regex "ad.*\\.example\\.com$"\fR Add "ad.*\\.example\\.com$" to the regex
blacklist - would block all subdomains of example.com which start with "ad"
Removes "noads.example.com" from blacklist
.br

Changing the Web Interface password
\fBpihole --wild example.com\fR
.br
Adds example.com as a wildcard - would block all subdomains of
example.com, including example.com itself.
.br

\fBpihole -a -p ExamplePassword\fR Change the password to "ExamplePassword"
\fBpihole --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"
.br

Updating lists from internet sources
Changing the Web Interface password
.br

\fBpihole -g\fR Update the list of ad-serving domains
\fBpihole -a -p ExamplePassword\fR
.br
Change the password to "ExamplePassword"
.br

Displaying version information
Updating lists from internet sources
.br

\fBpihole -v -a -c\fR Display the current version of AdminLTE
\fBpihole -g\fR
.br
Update the list of ad-serving domains
.br

Temporarily disabling Pi-hole
Displaying version information
.br

\fBpihole disable 5m\fR Disable Pi-hole functionality for five minutes
\fBpihole -v -a -c\fR
.br
Display the current version of AdminLTE
.br

Switching Pi-hole subsystem branches
Temporarily disabling Pi-hole
.br

\fBpihole disable 5m\fR
.br
Disable Pi-hole functionality for five minutes
.br

Switching Pi-hole subsystem branches
.br

\fBpihole checkout master\fR
.br
Switch to master branch
.br

\fBpihole checkout master\fR Switch to master branch
\fBpihole checkout core dev\fR
.br
\fBpihole checkout core dev\fR Switch to core development branch
Switch to core development branch
.br
.SH "SEE ALSO"

Expand Down

0 comments on commit f90c412

Please sign in to comment.