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

Update manpage

Signed-off-by: Christian König <github@yubiuser.dev>
This commit is contained in:
Christian König 2024-12-16 12:42:07 +01:00
parent 4d55bc1ae3
commit 3ac426b5d1
No known key found for this signature in database
2 changed files with 34 additions and 44 deletions

View File

@ -5,13 +5,15 @@ Pi-hole : A black-hole for internet advertisements
.br .br
.SH "SYNOPSIS" .SH "SYNOPSIS"
\fBpihole\fR (\fB-w\fR|\fB-b\fR|\fB--wild\fR|\fB--regex\fR) [options] domain(s) \fBpihole\fR (\fB-allow\fR|\fB-deny\fR) [options] domain(s)
.br
\fBpihole\fR (\fB--allow-regex\fR|\fB--regex\fR) [options] domain(s)
.br
\fBpihole\fR (\fB--allow-wild\fR|\fB--wild\fR) [options] domain(s)
.br .br
\fBpihole setpassword\fR password \fBpihole setpassword\fR password
.br .br
\fBpihole -c\fR [-j|-r|-e] \fBpihole\fR \fB-d\fR [-a] [-c]
.br
\fBpihole\fR \fB-d\fR [-a]
.br .br
\fBpihole -f \fBpihole -f
.br .br
@ -19,7 +21,7 @@ pihole -r
.br .br
\fBpihole\fR \fB-t\fR [arg] \fBpihole\fR \fB-t\fR [arg]
.br .br
pihole -g\fR \fBpihole -g\fR
.br .br
\fBpihole\fR -\fBq\fR [options] \fBpihole\fR -\fBq\fR [options]
.br .br
@ -27,20 +29,22 @@ pihole -g\fR
.br .br
\fBpihole -up \fR[--check-only] \fBpihole -up \fR[--check-only]
.br .br
\fBpihole -v\fR [-p|-a|-f] [-c|-l|-hash] \fBpihole -v\fR
.br .br
\fBpihole uninstall \fBpihole uninstall\fR
.br .br
pihole status \fBpihole status\fR
.br .br
pihole reloaddns\fR \fBpihole reloaddns\fR
.br .br
pihole reloadlists\fR \fBpihole reloadlists\fR
.br .br
\fBpihole\fR (\fBenable\fR|\fBdisable\fR [time]) \fBpihole\fR (\fBenable\fR|\fBdisable\fR [time])
.br .br
\fBpihole\fR \fBcheckout\fR repo [branch] \fBpihole\fR \fBcheckout\fR repo [branch]
.br .br
\fBpihole\fR \api\fR endpoint
.br
\fBpihole\fR \fBhelp\fR \fBpihole\fR \fBhelp\fR
.br .br
.SH "DESCRIPTION" .SH "DESCRIPTION"
@ -93,6 +97,7 @@ Available commands and options:
.br .br
-a Enable automated debugging -a Enable automated debugging
-c Include a Pi-hole database integrity check
.br .br
\fB-f, flush\fR \fB-f, flush\fR
@ -126,11 +131,9 @@ Available commands and options:
(Query options): (Query options):
.br .br
-adlist Print the name of the block list URL -partial Search the adlists for partially matching domains
.br .br
-exact Search the block lists for exact domain matches -all Return all query matches within a adlists
.br
-all Return all query matches within a block list
.br .br
\fB-h, --help, help\fR \fB-h, --help, help\fR
@ -161,31 +164,11 @@ Available commands and options:
--check-only 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
.br .br
Show installed versions of Pi-hole, Web Interface &amp; FTL Show installed versions of Pi-hole, Web Interface &amp; FTL
.br .br
.br
(repo options):
.br
-p, --pihole Only retrieve info regarding Pi-hole repository
.br
-a, --admin Only retrieve info regarding web
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
\fBsetpassword\fR \fBsetpassword\fR
.br .br
Set Web Interface password Set Web Interface password
@ -201,14 +184,14 @@ Available commands and options:
Display the running status of Pi-hole subsystems Display the running status of Pi-hole subsystems
.br .br
\fBenable\fR \fBenable\fR [time]
.br .br
Enable Pi-hole subsystems Enable Pi-hole blocking, optionally for a set duration
.br .br
\fBdisable\fR [time] \fBdisable\fR [time]
.br .br
Disable Pi-hole subsystems, optionally for a set duration Disable Pi-hole blocking, optionally for a set duration
.br .br
(time options): (time options):
@ -250,6 +233,11 @@ Available commands and options:
.br .br
branchname Update subsystems to the specified branchname branchname Update subsystems to the specified branchname
.br .br
\fBapi\fR endpoint
.br
Query the Pi-hole API at <endpoint>
.br
.SH "EXAMPLE" .SH "EXAMPLE"
Some usage examples Some usage examples
@ -263,7 +251,7 @@ Allow-/denylist manipulation
Allow "iloveads.example.com" Allow "iloveads.example.com"
.br .br
\fBpihole deny not noads.example.com\fR \fBpihole deny remove noads.example.com\fR
.br .br
Removes "noads.example.com" from denylist Removes "noads.example.com" from denylist
.br .br
@ -299,9 +287,9 @@ Updating lists from internet sources
Displaying version information Displaying version information
.br .br
\fBpihole -v -a -c\fR \fBpihole -v\fR
.br .br
Display the current version of web Display the current version of Pi-hole
.br .br
Temporarily disabling Pi-hole Temporarily disabling Pi-hole
@ -330,10 +318,11 @@ Switching Pi-hole subsystem branches
Flush information stored in Pi-hole's network tables Flush information stored in Pi-hole's network tables
.br .br
.SH "SEE ALSO" \fBpihole api stats/summary\fR
\fBlighttpd\fR(8), \fBpihole-FTL\fR(8)
.br .br
Queries FTL for the stats/summary endpoint
.br
.SH "COLOPHON" .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. 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.

1
pihole
View File

@ -501,6 +501,7 @@ Options:
uninstall Uninstall Pi-hole from your system uninstall Uninstall Pi-hole from your system
status Display the running status of Pi-hole subsystems status Display the running status of Pi-hole subsystems
enable Enable Pi-hole subsystems enable Enable Pi-hole subsystems
Add '-h' for more info on enable usage
disable Disable Pi-hole subsystems disable Disable Pi-hole subsystems
Add '-h' for more info on disable usage Add '-h' for more info on disable usage
reloaddns Update the lists and flush the cache without restarting the DNS server reloaddns Update the lists and flush the cache without restarting the DNS server