.. _index:

========================
configglue documentation
========================

Getting help
============

Having trouble? We'd like to help!

* Try the :doc:`FAQ <faq/index>` -- it's got answers to many common questions.

* Looking for specific information? Try the :ref:`genindex`, :ref:`modindex`
  or the :doc:`detailed table of contents <contents>`.

* Ask a question in the `#configglue IRC channel`_.

* Report bugs with configglue in our `ticket tracker`_.

.. _#configglue IRC channel: irc://irc.freenode.net/configglue
.. _ticket tracker: https://bugs.launchpad.net/configglue

First steps
===========

    * **From scratch:**
      :doc:`Overview <intro/overview>` |
      :doc:`Installation <intro/install>` |
      :doc:`Quickstart <intro/quickstart>`

The schema
==========

    * **Schemas:**
      :doc:`Schema syntax <topics/schemas>` |
      :doc:`Option types <ref/schemas/options>`

    * **Advanced:**
      :doc:`Custom options <howto/custom-schema-options>`

The configuration file
======================

    * **Basic:**
      :doc:`Syntax overview <topics/config-file>`

    * **Advanced:**
      :doc:`Environment variables <topics/environment-variables>`

The command-line
================

    * **Basic:**
      :doc:`Overview <topics/command-line>`

    * **Advanced:**
      :doc:`Environment variables <topics/environment-variables>`

Applications
============

    * **Getting started:**
      :doc:`Writing configglue-enabled applications <topics/base-app>`

The configglue open-source project
==================================

    * **Third-party distributions:**
      :doc:`Overview <misc/distributions>`

    * **configglue over time:**
      :doc:`Release notes and upgrading instructions <releases/index>`