===================================
BIND Response Policy Zone Generator
===================================

The :file:`rpzgen.py` script will generate a BIND response policy zone (RPZ)
definition from a list of "hosts files."  These files contain a list of DNS
domains to be "blocked" by the resolver, preventing clients from reaching the
servers at those names.

Currently, the following hosts lists are used:

* `StevenBlack's Consolidated Hosts list`_
* Custom list

Host lists must be in the standard "hosts file" format (i.e. an IP address,
followed by whitespace, followed by a DNS name.  Only the first name on each
line is used.  Wildcard names are permitted.


Requirements
============

Only Python 3 is required; no external dependencies are used.


Usage
=====

The generated RPZ file is written to standard output.  To save it to a file,
use shell redirection:

.. code:: sh

    ./rpzgen.py > blackhole.rpz.zone

.. _StevenBlack's Consolidated Hosts list: https://github.com/StevenBlack/hosts