.. include:: ../substitutions
.. include:: ../../apps-substitutions

.. _brood_help:

.. program:: brood

======================
Command Line Help
======================

A description of the command line interface can be obtained by executing **BROOD**
with the `--help` option.

.. code-block:: console
   
   > brood --help

will generate the following output:

::

   Help functions:
    brood --help simple      : Get a list of simple parameters
    brood --help all         : Get a complete list of parameters
    brood --help defaults    : List the defaults for all parameters
    brood --help <parameter> : Get detailed help on a parameter
    brood --help html        : Create an html help file for this program
    brood --help versions    : List the toolkits and versions used in the application

