API documentation
=================

This API documentation is based on the source code of version |release|
of the `proc` package.

.. contents::
   :local:
   :depth: 1

Generic modules
---------------

The following generic modules are available:

.. contents::
   :local:
   :depth: 1

The :mod:`proc` module
~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: proc
   :members:

The :mod:`proc.unix` module
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: proc.unix
   :members:

The :mod:`proc.core` module
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: proc.core
   :members:

The :mod:`proc.tree` module
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: proc.tree
   :members:

Application modules
-------------------

Each of the following modules integrates with a specific application:

.. contents::
   :local:
   :depth: 1

These modules are meant to actually be used (for those who are interested in
them) but they also function as examples of how to use the :mod:`proc.core` and
:mod:`proc.tree` modules.

The :mod:`proc.apache` module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: proc.apache
   :members:

The :mod:`proc.cron` module
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: proc.cron
   :members:

The :mod:`proc.gpg` module
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: proc.gpg
   :members:

The :mod:`proc.notify` module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: proc.notify
   :members: