eventd-im.conf(5)

IM plugin configuration

Build version: 0.25.0 - v0.25.0

Name

eventd-im.conf — IM plugin configuration

Synopsis

Configuration for the IM plugin.

Description

The im plugin provides messaging through libpurple.

Global sections

Section [IM]

Accounts=

A string list

A list of account names to be used in the account specific sections.

Section [IMAccount account name]

Each section should refer to an account name (see the section called “Section [IM]).

Protocol=

A string

A libpurple protocol name, e.g. "prpl-irc".

Username=

A string

A libpurple user name, the exact format is protocol-dependant, e.g. "bot@chat.freenode.net".

Password=

A string

The password of the account, if needed.

Port=

An integer

The connection port, needed for some protocols.

UseTLS= (defaults to true)

A boolean

Whether to use TLS or not.

For IRC, simply uses TLS. For XMPP and Oscar, forces TLS.

ChatLeaveTimeout= (defaults to -1)

A time in seconds (-1 for infinity)

The number of seconds the plugin will remain connected to a chat room.

ReconnectTimeout= (defaults to 5)

A strictly positive time in seconds

The number of seconds the plugin will wait before attempting to connect after a connection failure. This amount is doubled after each failed attempt, up to 3600 (1 hour).

ReconnectMaxTries= (defaults to 0)

An integer (0 for infinity)

The number of time the plugin will retry to connect after a connection failure.

Action sections

Section [IM]

Disable=

A boolean

If true, no message is sent.

Account=

An account name

The account that will send the message (see eventd-im.conf(5)).

Recipients=

A list of recipient name

A list of recipients to send the message to, the exact format is protocol-dependant, e.g. "example@xmpp.org" or "#project".

Chat= (defaults to true)

A boolean

If true, Recipient= is used as a chat room name (e.g. some protocols requires to join a chat room before talking in it).

Message=

A format string

The message to be sent.

See Also

eventd core man pages
eventd(1)

eventd daemon command-line options

eventdctl(1)

eventdctl (control tool) command-line options

eventd.conf(5)

eventd configuration

Contains information about all the event configuration

Plugins distributed with eventd will use the same scheme: eventd-plugin-name for their additional eventd command-line options, eventdctl-plugin-name for their additional eventdctl command-line options, eventd-plugin-name.conf for their configuration,

Plugins man pages