.. _configuration:

Keygrabber configuration
========================

Command-line options
--------------------

All options can be specified on the command line, though most are only used
for debugging. It is recommended that only the ``-c`` option be used for
production use.

The following is the output of ``keygrabber -h``, which describes the available
command line options.

.. include:: .build/keygrabber.txt
   :literal:


Configuration file
------------------

keygrabber uses the :mod:`python:ConfigParser` Python module to parse its
configuration file. All of the module's syntax features, such as inline
variable substitutions and explicit default values, are supported by keygrabber.

Refer to the sample configuration file below and to the
:mod:`python:ConfigParser` documentation for specific information on the
required file structure.


Sample configuration
--------------------

.. include:: ../sample.conf
   :literal: