5.2 Command Line Help

All of FRED parameters are documented in chapter 7, the same documentation is available from the FRED executable on the command line. Typing

fred --help

will return the following list of help options:

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

The different help options do the following

simple

provides a minimal list and a brief description of parameters required to run FRED. By default long lines will be wrapped at 80 columns, but a wider terminal can be accommodated by entering the number of columns in your terminal after "simple".

For example:

fred --help simple 120

will display the simple list of parameters formatted for a 120 column terminal.

all

provides a complete list and brief description of all parameters used by FRED. By default long lines will be wrapped at 80 columns, if you as using a wider terminal you can enter the number of columns in your terminal after simple. So for example

fred --help all 120

will display the list of parameters formatted for a 120 column terminal.

defaults

Lists the default value of all parameters, if any.

<parameter>

Provides a detailed description of the specified parameter. (e.g. "fred -help -dbase" will provided a detailed description of the -dbase parameter.)

html

Write all information available from the command line help to the html file FRED_help.html.

				FRED Fast Rigid Exhaustive Docking

				FRED Fast Rigid Exhaustive Docking