.. _index:

|project_name| documentation
============================

This is the documentation for |project_name| |release|, last updated
|today|.


Introduction
------------

The ipset library provides C data types for storing sets of IP
addresses, and maps of IP addresses to integers.  It supports both
IPv4 and IPv6 addresses.  It's implemented using "Binary Decision
Diagrams" (BDDs, https://en.wikipedia.org/wiki/Binary_decision_diagram),
which (we hypothesize) makes it space efficient for large sets.


Contents
--------

.. toctree::
   :maxdepth: 2

   commands
   file-format
   maps
   sets


Indices and tables
------------------

* :ref:`genindex`
* :ref:`search`
