GAMGI Formats: Help Config

# Help Config

- Source
- Agent

### source

Indicates whether the Help documentation should be fetched from the local computer or from a remote (HTTP or FTP) server.

    Example: <help source="local"/> (default)
    Allowed values: local, remote (optional)

### local

Indicates the path to the local doc directory where the GAMGI documentation starts. It is needed only when source is set to local. This is equivalent to create the GAMGI environment variable, containing the same path.

    Example: <help local="/home/carlos/gamgi/gamgi"/> (default)
    (after defining GAMGI in ~/.bashrc: GAMGI=/home/carlos/gamgi/gamgi; export GAMGI)
    Allowed values: 100 ASCII characters maximum (defined in GAMGI_IO_PATHNAME) (optional)

### remote

Indicates the path to the remote doc directory where the GAMGI documentation starts. It is needed only when source is set to remote.

    Example: <help remote="http://www.gamgi.org/"/> (default)
    (defined in GAMGI_IO_WEBSITE)
    Allowed values: 100 ASCII characters maximum (defined in GAMGI_IO_PATHNAME) (optional)

Home