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

.. program:: rocs 

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

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

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


will generate the following output:

::

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

