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

Merge pull request #2313 from pi-hole/fix/pihole-man-usage

Fix wildcard/regex usage formatting
This commit is contained in:
Dan Schaper 2018-07-29 15:43:19 -07:00 committed by GitHub
commit 82a64db42b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -125,13 +125,16 @@ Available commands and options:
.br .br
-k, kelvin Set Kelvin as preferred temperature unit -k, kelvin Set Kelvin as preferred temperature unit
.br .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 .br
-e, email Set an administrative contact address for the Block Page -e, email Set an administrative contact address for the
Block Page
.br .br
-i, interface Specify dnsmasq's interface listening behavior -i, interface Specify dnsmasq's interface listening behavior
.br .br
-l, privacylevel <level> Set privacy level (0 = lowest, 3 = highest) -l, privacylevel <level> Set privacy level
(0 = lowest, 3 = highest)
.br .br
\fB-c, chronometer\fR [options] \fB-c, chronometer\fR [options]
@ -181,7 +184,8 @@ Available commands and 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
@ -204,7 +208,8 @@ Available commands and 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
@ -214,7 +219,8 @@ Available commands and options:
.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
@ -266,7 +272,8 @@ Available commands and 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 .br
branchname Update subsystems to the specified branchname branchname Update subsystems to the specified branchname
.br .br
@ -278,47 +285,71 @@ Some usage examples
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
.br .br
\fBpihole -b -d noads.example.com\fR Remove "noads.example.com" from blacklist Adds "iloveads.example.com" to whitelist
.br .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 .br
\fBpihole --regex "ad.*\.example\.com$"\fR Add "ad.*\.example\.com$" to the regex Removes "noads.example.com" from blacklist
blacklist - would block all subdomains of example.com which start with "ad" .br
\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 --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 .br
Changing the Web Interface password Changing the Web Interface password
.br .br
\fBpihole -a -p ExamplePassword\fR Change the password to "ExamplePassword" \fBpihole -a -p ExamplePassword\fR
.br
Change the password to "ExamplePassword"
.br .br
Updating lists from internet sources Updating lists from internet sources
.br .br
\fBpihole -g\fR Update the list of ad-serving domains \fBpihole -g\fR
.br
Update the list of ad-serving domains
.br .br
Displaying version information Displaying version information
.br .br
\fBpihole -v -a -c\fR Display the current version of AdminLTE \fBpihole -v -a -c\fR
.br
Display the current version of AdminLTE
.br .br
Temporarily disabling Pi-hole Temporarily disabling Pi-hole
.br .br
\fBpihole disable 5m\fR Disable Pi-hole functionality for five minutes \fBpihole disable 5m\fR
.br
Disable Pi-hole functionality for five minutes
.br .br
Switching Pi-hole subsystem branches Switching Pi-hole subsystem branches
.br .br
\fBpihole checkout master\fR Switch to master branch \fBpihole checkout master\fR
.br .br
\fBpihole checkout core dev\fR Switch to core development branch Switch to master branch
.br
\fBpihole checkout core dev\fR
.br
Switch to core development branch
.br .br
.SH "SEE ALSO" .SH "SEE ALSO"