.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "DBAB" "8" "December 2021" ""
.SH "NAME"
\fBdbab\fR \- dnsmasq based ad blocking
.SH "NOTICE"
.IP "\[ci]" 4
If you like \fBdbab\fR, check out its sister project \fBdbab\-packer\fR \fIhttps://github\.com/suntong/dbab\-packer/\fR\.
.IP "\[ci]" 4
It has been my default way of using \fBdbab\fR for quite a while now, thus I'm officially recommending it over the host\-package\-installing approach\.
.IP "\[ci]" 4
I will update the Debian package for the last time and stop packaging it after 2021\.
.IP "" 0
.SH "SYNOPSIS"
.nf
# start dbab\-svr server
/etc/init\.d/dbab start

# stop dbab\-svr server
/etc/init\.d/dbab stop

# get/update ad blocking list
/usr/sbin/dbab\-get\-list

# add your own to the ad blocking list
/usr/sbin/dbab\-add\-list
.fi
.SH "DESCRIPTION"
\fBdbab\fR provides a total solution for SOHO service environment, smoothly integrates \fBDHCP\fR, \fBDNS\fR, local caching and Ad blocking into harmony operation\. Ad blocking is done by \fBDNSmasq\fR and \fBdbab\-svr\fR the pixel server, i\.e\., done at the DNS level \-\- all requests to ads\-sites are blocked right there at DNS level\. No more user space extensive pattern matching necessary at all\. Work for your mobile devices as well\. You don't need to install anything to your mobile devices to enjoy the ad\-free and speed\-up browsing\.
.SH "ALTERNATIVES"
People may also use browsers' \fBadblock\-plus\fR extension to block ads, but fewer think over how it works internally\. Here is an overview of Adblock Plus from a thousand mile high [1] \-\- whenever the browser needs to load something, the extension kicks in and do a thorough pattern matching of all known ad urls using regular expressions, then hectically replace all found ad urls with something else\. This is done on every page, every load, and every component of the web page, using JavaScript\. Thus it is by nature slow and CPU intensive, at least inefficient\. There are other alternatives to this, e\.g\., \fBprivoxy\fR, but the concepts are the same\.
.P
[1] http://adblockplus\.org/en/faq_internal
.SH "ADVANTAGES"
Comparing to other ad\-blocking efforts, \fBdbab\fR will be super light\. Only a few operations are enough to determine and stop the ads\. No heavy\-lifting (using CPU intensive URL pattern matching) necessary\. Thus it will be super light and lightning fast\.
.P
The advantages of using \fBdbab\fR are:
.IP "\[ci]" 4
\fBWork at the DNS level\fR\. Leave the web pages intact, without any pattern matching, string substitution, and/or html elements replacing\.
.IP "\[ci]" 4
\fBWork for your mobile devices as well\fR\. Were you previously in the dilemma of choosing ads free or slow response for your mobile devices (iphone, ipad, etc)? Now you don't\. You don't need to install any thing to your mobile devices for them to enjoy the ad\-free browsing experience\. Moreover, their browsing speed will increase dramatically on revisited pages/images\.
.IP "\[ci]" 4
\fBServe instantly\fR\. All ads will be replaced by a \fB1x1\fR pixel gif image served locally by the \fBdbab\-svr\fR pixel server\.
.IP "\[ci]" 4
\fBMaintenance free\fR\. You don't need to maintain the list of ad sites yourself\. The block list can be downloaded from pgl\.yoyo\.org periodically\. If you don't like some of the entries there, you can add\-to or remove\-from that list easily\.
.IP "" 0
.SH "DBAB\-SVR"
The \fBdbab\-svr\fR is a super minimal web / pixel server, it has one purpose \-\- serving a \fB1x1\fR pixel transparent gif file\. It can optionally provide the automatic WPAD service as well if so configured\. By default it listens on \fBlocalhost\fR, configurable from the file \fB/etc/dbab/dbab\.addr\fR\.
.SH "DBAB\-GET\-LIST"
The \fBdbab\-get\-list\fR is used to get \fBdnsmasq\fR blocking list from pgl\.yoyo\.org to be used by \fBDNSmasq\fR\. The result is stored as \fB/etc/dnsmasq\.d/dbab\-map\.adblock\.conf\fR\.
.P
You can run it once, or put it in a \fBcron\fR job so as to update the block list periodically\. E\.g\., to update on a weekly basis:
.IP "" 4
.nf
ln \-s /usr/sbin/dbab\-get\-list /etc/cron\.weekly/
.fi
.IP "" 0
.P
It is safe to do so, even if the machine might be offline when the \fBcron\fR job is triggered\. The existing file will be intact if download failed\.
.SH "DBAB\-ADD\-LIST"
You can use \fBdbab\-add\-list\fR to add your own entries to \fBdnsmasq\fR blocking list, if the list from pgl\.yoyo\.org is not sufficient for you\. The result is stored as \fB/etc/dnsmasq\.d/dbab\-map\.trashsites\.conf\fR\.
.SH "DBAB\-CHK\-LIST"
The \fBdbab\-chk\-list\fR can help you to check if your own list is already covered by pgl\.yoyo\.org\.
.SH "DHCP\-ADD\-WPAD"
The \fBdhcp\-add\-wpad\fR will take the content in \fB/etc/dbab/dbab\.addr\fR as the IP of the host of the \fBdhcp\fR server, the squid caching server, then enable the automatic WPAD service within the system, with the help of the \fBDNS\fR and \fBDHCP\fR server\.
.SH "FILES"
.IP "\[ci]" 4
\fB/etc/dbab/dbab\.addr\fR
.br
The IP address that \fBdbab\-svr\fR listens on\. Defaults to \fBlocalhost\fR\.
.IP "\[ci]" 4
\fB/etc/dbab/dbab\.list\-\fR
.br
The entries you want to filter out from the pgl\.yoyo\.org lists\. List sites you still wish to visit there\.
.IP "\[ci]" 4
\fB/etc/dbab/dbab\.list+\fR
.br
The entries you want to add to blocking list on top of the pgl\.yoyo\.org list, used by \fBdbab\-add\-list\fR\.
.IP "\[ci]" 4
\fB/etc/dnsmasq\.d/dbab\-map\.adblock\.conf\fR
.br
The file which \fBdbab\-get\-list\fR updates\.
.IP "\[ci]" 4
\fB/etc/dnsmasq\.d/dbab\-map\.trashsites\.conf\fR
.br
The file which \fBdbab\-add\-list\fR updates\.
.IP "\[ci]" 4
\fB/usr/share/doc/dbab/dbab\.md\fR
.br
The more detailed introduction and installation guild\.
.IP "" 0
.SH "AUTHOR(S)"
Copyright: 2013~2020 Tong SUN
.br
.P
The pixelserv was originally downloaded from
.br
http://proxytunnel\.sourceforge\.net/files/pixelserv\.pl\.txt
.br
Wrote by Piet Wintjens, with BSD (no advertising clause) license\.