Differences between revisions 2 and 3
Revision 2 as of 2008-01-07 19:47:35
Size: 2465
Editor: Peter
Comment:
Revision 3 as of 2008-01-07 20:23:33
Size: 2465
Editor: Peter
Comment:
Deletions are marked like this. Additions are marked like this.
Line 9: Line 9:
Empty lines and lines starting with a hash character (`#') are ignored. Empty lines and lines starting with a hash character ('#') are ignored.
Line 12: Line 12:
A feed is defined by the keyword `feed', following by an unique identifier. The configuration parameters for the feed are specified between an opening brace and a closing brace. A feed is defined by the keyword 'feed', following by an unique identifier. The configuration parameters for the feed are specified between an opening brace and a closing brace.
Line 25: Line 25:
    Define the channels to automatically send new items to. This option only makes sense when the update parameter is set to `auto'.     Define the channels to automatically send new items to. This option only makes sense when the update parameter is set to 'auto'.
Line 40: Line 40:
    Specifies how the web feed should be updated. When this parameter is set to `auto', the web feed will be updated periodically, with an interval specified by the refresh parameter. When this parameter is set to `command', the web feed will be updated when a command in the channel is used. If this parameter is not specified, then the default value `command' will be used.     Specifies how the web feed should be updated. When this parameter is set to 'auto', the web feed will be updated periodically, with an interval specified by the refresh parameter. When this parameter is set to 'command', the web feed will be updated when a command in the channel is used. If this parameter is not specified, then the default value 'command' will be used.

The manual page for the IrcBot web feed plugin configuration file format.

Name

feed.conf - configuration file for the ppbot web feed reader plugin

Description

The feed.conf file defines the parameters for the web feed reader plugin for ppbot. The file consists of feed definitions and configuration parameters.

Empty lines and lines starting with a hash character ('#') are ignored.

Feed definition

A feed is defined by the keyword 'feed', following by an unique identifier. The configuration parameters for the feed are specified between an opening brace and a closing brace.

The supported web feeds are:

  • Really Simple Syndication (RSS 2.0)
  • RDF Site Summary (RSS 0.90 and 1.0)
  • Rich Site Summary (RSS 0.91 and 0.92)
  • Atom (0.3 and 1.0)

Parameters

The following parameters and arguments are recognized:

channels connection:#channel [...]

  • Define the channels to automatically send new items to. This option only makes sense when the update parameter is set to 'auto'.

count number

  • Set the maximum number of items to show in a feed when using the command. If this parameter is not specified, then the default number of 5 items will be used.

name feedname

  • Define the name for the web feed. This name will be prefixed with the messages in the channel.

location url

  • Define the web location of the web feed. This should be a complete and valid URL. The location may be specified with a http, feed, or rss URI scheme. This parameter is mandatory.

refresh minutes

  • Set the refresh interval for updating the web feed. If this parameter is not specified, then the default interval of 30 minutes will be used.

update auto | command

  • Specifies how the web feed should be updated. When this parameter is set to 'auto', the web feed will be updated periodically, with an interval specified by the refresh parameter. When this parameter is set to 'command', the web feed will be updated when a command in the channel is used. If this parameter is not specified, then the default value 'command' will be used.

Example

An example feed.conf file:

feed kerneltrap {
    location   "http://kerneltrap.org/node/feed"
    name       "Kerneltrap"
    update     auto
    refresh    30
    channels   pointless:#test
}

See Also

IrcBotManual, IrcBotConfManual

FeedConfManual (last edited 2009-08-25 17:25:05 by localhost)