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

.. program:: filter

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

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

.. code-block:: bash
   
   prompt> filter --help


will generate the following output:

::

  Help functions:
    filter --help simple      : Get a list of simple parameters
    filter --help all         : Get a complete list of parameters
    filter --help <parameter> : Get detailed help on a parameter
    filter --help html        : Create an HTML help file for this program
