.. cleanmymac documentation master file, created by
   sphinx-quickstart on Sat Jan  2 00:20:11 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Clean My Mac
============

A simple command line utility designed to clean your mac

.. code-block:: bash

    $ cleanmymac

.. program-output:: cleanmymac --version

for a detailed view of the command line interface to **cleanmymac** see :ref:`cli`

.. warning::

    This is work in progress and involves deleting files from your system.
    Use at your own risk!


How to:
-------

.. toctree::
    :maxdepth: 2

    install
    configuration
    extending

Api Reference:
--------------

.. toctree::
   :maxdepth: 2

   modules/builtins
   modules/cli
   modules/colors
   modules/constants
   modules/log
   modules/registry
   modules/schema
   modules/target
   modules/util


Indices and tables
==================

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