Erebot latest-0.6.0-67-g4eb2f5d documentation

Usage

«  Configuration   ::   Contents   ::   Compatible modules  »

Usage

Options

-c <FILE>, --config <FILE>

Use the given configuration <FILE> instead of the default Erebot.xml. The given path is interpreted relative to the current directory.

-d, --daemon

Run the bot in the background.

Note

Both the POSIX and pcntl PHP extensions must be enabled for this option to work.

-n, --no-daemon

Run the bot in the foreground. This is the default unless Erebot -d is used.

-p <FILE>, --pidfile <FILE>

Path to the file where the bot’s PID will be written, relative to the current directory.

-g <GROUP/GID>, --group <GROUP/GID>

Switch to this group identity during startup. The group may be expressed as either a group name (eg. root) or as a numeric GID (eg. 0).

-u <USER/UID>, --user <USER/UID>

Switch to this user identity during startup. The user may be expressed as either a user name (eg. root) or as a numeric UID (eg. 0).

-h, --help

Display the bot’s help and exit.

-v, --version

Display the bot’s version and exit.

Environment variables

Several environment variables related to language settings control the way the bot produces its output. The first variable to appear in the environment takes precedence over the others.

LANGUAGE

Defines the system’s supported languages, as a colon-separated list of country names with optional regions. Eg.

LANGUAGE=en_US:en
LC_ALL

Defines supported languages for various types of formatting operations, like message formatting, date/time formatting and so on. Setting this variable is equivalent to setting each of the other LC_* variables individually to the same value.

LC_MESSAGES

Defines supported languages when outputting textual messages.

LC_MONETARY

Defines supported languages when outputting monetary values.

LC_TIME

Defines supported languages when outputting dates/times.

LC_NUMERIC

Defines supported languages when outputting other numeric values (eg. floating-point values).

LANG

Defines the system’s supported languages and encodings, as a colon-separated list of country names with their optional region and their encoding. Eg.

LANG=en_US.utf8

«  Configuration   ::   Contents   ::   Compatible modules  »