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

.. program:: spruce

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

A description of the commandline interface can be obtained by executing **SPRUCE**
with the `--help` option.

.. code-block:: bash

   prompt> spruce --help

will generate the following output:

::

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