.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH HBLOCK "1" "January 2024" "hBlock 3.4.4" "User Commands"
.SH NAME
hBlock \- manual page for hBlock 3.4.4
.SH SYNOPSIS
.B hblock
[\fI\,OPTION\/\fR]...
.SH DESCRIPTION
hBlock is a POSIX\-compliant shell script that gets a list of domains that serve
ads, tracking scripts and malware from multiple sources and creates a hosts
file, among other formats, that prevents your system from connecting to them.
.SH OPTIONS
.HP
\fB\-O\fR, \fB\-\-output\fR <FILE|\->, ${HBLOCK_OUTPUT_FILE}
.IP
Output file location.
.IP
If equals "\-", it is printed to stdout.
.IP
(default: \fI\,/etc/hosts\/\fP)
.HP
\fB\-H\fR, \fB\-\-header\fR <FILE|builtin|none|\->, ${HBLOCK_HEADER_FILE}
.IP
File to be included at the beginning of the output file.
.IP
If equals "builtin", the built\-in value is used.
.IP
If equals "none", an empty value is used.
.IP
If equals "\-", the stdin content is used.
.IP
If unspecified and any of the following files exists, its content is used.
.IP
${XDG_CONFIG_HOME}/hblock/header
.IP
\fI\,/etc/hblock/header\/\fP
.IP
(default: builtin)
.HP
\fB\-F\fR, \fB\-\-footer\fR <FILE|builtin|none|\->, ${HBLOCK_FOOTER_FILE}
.IP
File to be included at the end of the output file.
.IP
If equals "builtin", the built\-in value is used.
.IP
If equals "none", an empty value is used.
.IP
If equals "\-", the stdin content is used.
.IP
If unspecified and any of the following files exists, its content is used.
.IP
${XDG_CONFIG_HOME}/hblock/footer
.IP
\fI\,/etc/hblock/footer\/\fP
.IP
(default: builtin)
.HP
\fB\-S\fR, \fB\-\-sources\fR <FILE|builtin|none|\->, ${HBLOCK_SOURCES_FILE}
.IP
File with line separated URLs used to generate the blocklist.
.IP
If equals "builtin", the built\-in value is used.
.IP
If equals "none", an empty value is used.
.IP
If equals "\-", the stdin content is used.
.IP
If unspecified and any of the following files exists, its content is used.
.IP
${XDG_CONFIG_HOME}/hblock/sources.list
.IP
\fI\,/etc/hblock/sources.list\/\fP
.IP
(default: builtin)
.HP
\fB\-A\fR, \fB\-\-allowlist\fR <FILE|builtin|none|\->, ${HBLOCK_ALLOWLIST_FILE}
.IP
File with line separated entries to be removed from the blocklist.
.IP
If equals "builtin", the built\-in value is used.
.IP
If equals "none", an empty value is used.
.IP
If equals "\-", the stdin content is used.
.IP
If unspecified and any of the following files exists, its content is used.
.IP
${XDG_CONFIG_HOME}/hblock/allow.list
.IP
\fI\,/etc/hblock/allow.list\/\fP
.IP
(default: builtin)
.HP
\fB\-D\fR, \fB\-\-denylist\fR <FILE|builtin|none|\->, ${HBLOCK_DENYLIST_FILE}
.IP
File with line separated entries to be added to the blocklist.
.IP
If equals "builtin", the built\-in value is used.
.IP
If equals "none", an empty value is used.
.IP
If equals "\-", the stdin content is used.
.IP
If unspecified and any of the following files exists, its content is used.
.IP
${XDG_CONFIG_HOME}/hblock/deny.list
.IP
\fI\,/etc/hblock/deny.list\/\fP
.IP
(default: builtin)
.HP
\fB\-R\fR, \fB\-\-redirection\fR <REDIRECTION>, ${HBLOCK_REDIRECTION}
.IP
Redirection for all entries in the blocklist.
.IP
(default: 0.0.0.0)
.HP
\fB\-W\fR, \fB\-\-wrap\fR <NUMBER>, ${HBLOCK_WRAP}
.IP
Break blocklist lines after this number of entries.
.IP
(default: 1)
.HP
\fB\-T\fR, \fB\-\-template\fR <TEMPLATE>, ${HBLOCK_TEMPLATE}
.IP
Template applied to each entry.
.IP
%D = <DOMAIN>, %R = <REDIRECTION>
.IP
(default: %R %D)
.HP
\fB\-C\fR, \fB\-\-comment\fR <COMMENT>, ${HBLOCK_COMMENT}
.IP
Character used for comments.
.IP
(default: #)
.HP
\fB\-l\fR, \fB\-\-[no\-]lenient\fR, ${HBLOCK_LENIENT}
.IP
Match all entries from sources regardless of their IP, instead of
0.0.0.0, 127.0.0.1, ::, ::1 or nothing.
.IP
(default: false)
.HP
\fB\-r\fR, \fB\-\-[no\-]regex\fR, ${HBLOCK_REGEX}
.IP
Use POSIX BREs in the allowlist instead of fixed strings.
.IP
(default: false)
.HP
\fB\-f\fR, \fB\-\-[no\-]filter\-subdomains\fR, ${HBLOCK_FILTER_SUBDOMAINS}
.IP
Do not include subdomains when the parent domain is also blocked.
Useful for reducing the blocklist size in cases such as when DNS blocking
makes these subdomains redundant.
.IP
(default: false)
.HP
\fB\-c\fR, \fB\-\-[no\-]continue\fR, ${HBLOCK_CONTINUE}
.IP
Do not abort if a download error occurs.
.IP
(default: false)
.HP
\fB\-p\fR, \fB\-\-parallel\fR, ${HBLOCK_PARALLEL}
.IP
Maximum concurrency for parallel downloads.
.IP
(default: 4)
.HP
\fB\-q\fR, \fB\-\-[no\-]quiet\fR, ${HBLOCK_QUIET}
.IP
Suppress non\-error messages.
.IP
(default: false)
.HP
\fB\-x\fR, \fB\-\-color\fR <auto|true|false>, ${HBLOCK_COLOR}
.IP
Colorize the output.
.IP
(default: auto)
.HP
\fB\-v\fR, \fB\-\-version\fR
.IP
Show version number and quit.
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Show this help and quit.
.SH "REPORTING BUGS"
Report bugs to: <https://github.com/hectorm/hblock/issues>
.PP
.br
Author: Héctor Molinero Fernández <hector@molinero.dev>
.br
License: MIT, https://opensource.org/licenses/MIT
.br
Repository: https://github.com/hectorm/hblock