.. _glossary:

Glossary
==========

.. glossary::

   directory authority
        a special-purpose relay that maintains a list of currently-running
        relays and periodically publishes a consensus together with the other
        directory authorities. [#]_

   bandwidth authority
        A :term:`directory authority` that runs a :term:`scanner` and a
        :term:`generator` or obtain :term:`bandwidth list file` s from a
        :term:`generator`.

   scanner
        Term to refer to the process that measures the relays' bandwidth.
        It is also called :term:`generator` when it is the same tool that is
        used to generate :term:`bandwidth list file` s.

   generator
        Term to refer to the tool that generates the
        :term:`bandwidth list file` s. Often used as a synonym for
        :term:`scanner`.

   bandwidth list file
        The file generated by :term:`generator` s that is read by the
        :term:`directory authority` s and included in their votes.
        See `bandwidth-file-spec <https://spec.torproject.org/bandwidth-file-spec/>`_
        to know about the file specification.

   sbws scanner
        The ``sbws`` command used to run ``sbws`` as a :term:`scanner`.

   sbws generate
        The ``sbws`` command used to run ``sbws`` as a :term:`generator`.

   v3bw file
        The term used by ``sbws`` to refer to :term:`bandwidth list file`
        v1.1.0.

        .. literalinclude:: v3bw.txt
            :caption: A v3bw file

   destination
        The term used by ``sbws`` to refer to a Web server where the
        :term:`scanner` request files to perform the bandwidth measurements.

.. [#] https://metrics.torproject.org/glossary.html
