TBLOCK

An anticapitalist ad-blocker that uses the hosts file

SUMMARY

-   About
-   Features
-   Installation
-   Post-installation
-   Usage
-   Copyright
-   Libraries used
-   Contact

ABOUT

TBlock is a free and open-source ad-blocker, written in Python. It uses
the hosts file to block advertising and tracking domains, which means it
protects your whole system against these domains. TBlock is compatible
with most of filter formats, and also has a built-in filter converter,
to help you share your custom filters with people that are using
different ad-blockers.

FEATURES

-   Free and open-source software
-   Easy to install
-   Does not cost any money
-   Does not track your personal data
-   Does not make you fingerprintable, unlike some ad-blocking browser
    extensions
-   Fast rules parsing
-   Blocks ads for your whole operating system
-   Compatible with most filter formats
-   Has an online filter repository to help you find and subscribe to
    filters in an easier way
-   Has a built-in filter converter

INSTALLATION

There are various methods to install TBlock. You need to install TBlock
as root, since superuser privileges are required to edit the hosts file.

With python

This is the fastest and easiest way to install TBlock on your machine.
Simply run the following command:

    $ sudo pip install tblock

Other installation methods

More installation methods can be found on our website:

Manually

To build and install TBlock manually, run the following:

    $ git clone https://codeberg.org/tblock/tblock.git
    $ cd tblock
    $ make
    $ sudo make install

POST-INSTALLATION

After the installation and after each update of TBlock, you should
update your local version of the remote filter repository, by running:

    $ sudo tblock -Y

USAGE

To show the help page of TBlock, simply run:

    $ tblock -h

To show the help page of the built-in converter, simply run:

    $ tblockc -h

You can find more help about usage on TBlock’s wiki.

COPYRIGHT

TBlock and its converter are released under GPLv3.

LIBRARIES USED

TBlock uses the external libraries:

  Name       Author             License      Homepage
  ---------- ------------------ ------------ -------------------------------------
  colorama   Jonathan Hartley   BSD          https://github.com/tartley/colorama
  requests   Kenneth Reitz      Apache 2.0   https://requests.readthedocs.io
  urllib3    Andrey Petrov      MIT          https://urllib3.readthedocs.io/

CONTACT

-   Email: twann@ctemplar.com
-   Mastodon: @tblock@fosstodon.org
-   Telegram: https://t.me/tblock
-   Website: https://tblock.codeberg.page/
