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

.. program:: sitehopper_search

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

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

.. code-block:: bash

   prompt> sitehopper_search --help

will generate the following output:

::

   Help functions:
     sitehopper_search --help simple      : Get a list of simple parameters
     sitehopper_search --help all         : Get a complete list of parameters
     sitehopper_search --help defaults    : List the defaults for all parameters
     sitehopper_search --help <parameter> : Get detailed help on a parameter
