FbIN/hblock
1
0
Fork 0
mirror of https://github.com/hectorm/hblock.git synced 2026-04-23 07:26:33 +05:30
Code Issues Projects Releases Packages Wiki Activity

Updated help

Browse source
This commit is contained in:
Héctor Molinero Fernández 2018-06-22 22:33:06 +02:00
commit 6af3fa47f9
2 changed files with 90 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

66
README.md
View file

@ -60,28 +60,50 @@ npx hblock
You can also change the default behavior using these options:
```
Usage: hblock [options...]
-O, --output FILE Hosts file location (default: /etc/hosts)
-R, --redirection IP Destination IP for all entries in the blocklist
(default: 0.0.0.0)
-H, --header HEADER Content to be included at the beginning of the
hosts file. You can use the output of any other
command (e.g. "$(cat header.txt)")
-S, --sources URLS Sources to be used to generate the blocklist
(whitespace separated URLs)
-W, --whitelist ENTRIES Entries to be removed from the blocklist
(whitespace separated POSIX BREs)
-B, --blacklist ENTRIES Entries to be added to the blocklist
(whitespace separated domain names)
-b, --backup [DIRECTORY] Make a time-stamped backup in DIRECTORY
(default: output file directory)
-l, --lenient Match any IP address from sources, although it
will be replaced by the destination IP
(default: 0.0.0.0, 127.0.0.1 or none)
-i, --ignore-download-error Do not abort if a download error occurs
-c, --color auto|true|false Colorize the output (default: auto)
-q, --quiet Suppress non-error messages
-v, --version Show version number and quit
-h, --help Show this help and quit
-O, --output <FILE>
Output file location
(default: /etc/hosts)
-R, --redirection <REDIRECTION>
Redirection for all entries in the blocklist
(default: 0.0.0.0)
-H, --header <HEADER>
Content to be included at the beginning of the file
(e.g. "$(cat header.txt)")
-F, --footer <FOOTER>
Content to be included at the end of the file
(e.g. "$(cat footer.txt)")
-T, --template <TEMPLATE>
POSIX BREs replacement applied to each entry
\1 = <DOMAIN>, \2 = <REDIRECTION>
(default: \2 \1)
-C, --comment <COMMENT>
Character used for comments
(default: #)
-S, --sources <URLS>
Sources to be used to generate the blocklist
(whitespace separated URLs)
-W, --whitelist <ENTRIES>
Entries to be removed from the blocklist
(whitespace separated POSIX BREs)
-B, --blacklist <ENTRIES>
Entries to be added to the blocklist
-b, --backup [DIRECTORY]
Make a time-stamped backup in <DIRECTORY>
(default: output file directory)
-l, --lenient
Match all entries from sources, regardless of their IP
(default: 0.0.0.0, 127.0.0.1 or none)
-i, --ignore-download-error
Do not abort if a download error occurs
-c, --color <auto|true|false>
Colorize the output
(default: auto)
-q, --quiet
Suppress non-error messages
-v, --version
Show version number and quit
-h, --help
Show this help and quit
```
#### Preserve content

78
hblock
View file

@ -80,38 +80,52 @@ showHelp() {
if [ $# -eq 0 ]; then
printStdout '%s\n' "$(cat <<-'EOF'
Usage: hblock [options...]
-O, --output FILE Output file location
(default: /etc/hosts)
-R, --redirection IP Redirection for all entries in the blocklist
(default: 0.0.0.0)
-H, --header HEADER Content to be included at the beginning of the
file. You can use the output of any other command
(e.g. "$(cat header.txt)")
-F, --footer FOOTER Content to be included at the end of the file.
You can use the output of any other command
(e.g. "$(cat footer.txt)")
-T, --template TEMPLATE POSIX BREs replacement applied to each line
\1 -> Domain
\2 -> Redirection
(default: \2 \1)
-C, --comment COMMENT Character used for comments
(default: #)
-S, --sources URLS Sources to be used to generate the blocklist
(whitespace separated URLs)
-W, --whitelist ENTRIES Entries to be removed from the blocklist
(whitespace separated POSIX BREs)
-B, --blacklist ENTRIES Entries to be added to the blocklist
-b, --backup [DIRECTORY] Make a time-stamped backup in DIRECTORY
(default: output file directory)
-l, --lenient Match any IP address from sources, although it
will be replaced by the destination IP
(default: 0.0.0.0, 127.0.0.1 or none)
-i, --ignore-download-error Do not abort if a download error occurs
-c, --color auto|true|false Colorize the output
(default: auto)
-q, --quiet Suppress non-error messages
-v, --version Show version number and quit
-h, --help Show this help and quit
-O, --output <FILE>
Output file location
(default: /etc/hosts)
-R, --redirection <REDIRECTION>
Redirection for all entries in the blocklist
(default: 0.0.0.0)
-H, --header <HEADER>
Content to be included at the beginning of the file
(e.g. "$(cat header.txt)")
-F, --footer <FOOTER>
Content to be included at the end of the file
(e.g. "$(cat footer.txt)")
-T, --template <TEMPLATE>
POSIX BREs replacement applied to each entry
\1 = <DOMAIN>, \2 = <REDIRECTION>
(default: \2 \1)
-C, --comment <COMMENT>
Character used for comments
(default: #)
-S, --sources <URLS>
Sources to be used to generate the blocklist
(whitespace separated URLs)
-W, --whitelist <ENTRIES>
Entries to be removed from the blocklist
(whitespace separated POSIX BREs)
-B, --blacklist <ENTRIES>
Entries to be added to the blocklist
-b, --backup [DIRECTORY]
Make a time-stamped backup in <DIRECTORY>
(default: output file directory)
-l, --lenient
Match all entries from sources, regardless of their IP
(default: 0.0.0.0, 127.0.0.1 or none)
-i, --ignore-download-error
Do not abort if a download error occurs
-c, --color <auto|true|false>
Colorize the output
(default: auto)
-q, --quiet
Suppress non-error messages
-v, --version
Show version number and quit
-h, --help
Show this help and quit
Report bugs to: <https://github.com/hectorm/hblock/issues>.
EOF
)"
exit 0