Help System
===========

The WS has a built-in help system which explains the function of it's many
configuration options. This help system can be access from both the Web and
command line.

Options are organized into categories. There are also global options and
project options. Global options affect the WS server as a whole. Project
options are project specific. However, some project options (e.g. ``contact``)
may be specified globally. Global options are placed in ``config.xml`` whereas
project options are set in ``project.xml`` files which are loaded
automatically when located one level down from the WS ``projects`` directory.
E.g. ``projects/p1234/project.xml``.

Web Interface
-------------

To access the Web help navigate to:

::

    https://xxx.xxx.xxx.xxx/admin/help

The menu on the left side lists the global and project specific options. Note
that ``Gromacs Options`` refers to old 0xa4 Gromacs. Refer to
``Generic Options`` for 0xa7 and newer projects.

The help system lists option names, their type and default values.

Command Line
------------

The option help can also be accessed from the command line. To view global
options run:

::

    ./fah-work --help

To view a specific option run:

::

    ./fah-work --help <option>

To view project options run:

::

    ./fah-work --project-help