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

.. _freeform_help:

.. program:: freeform

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

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

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

will generate the following output:

::

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