.. _plugin:rss: === RSS === | about ----- | :author: FeedBackLoop :contact: FREENODE/#fbf :distribution: core :license: | description ----------- | the rss mantra is of the following: 1) add a url with !rss-add 2) use !rss-start in the channel you want the feed to appear 3) run !rss-scan to see what tokens you can use .. add them with !rss-additem 4) change markup with !rss-addmarkup .. see !rss-markuplist for possible markups 5) check with !rss-feeds in a channel to see what feeds are running in a channel 6) in case of trouble check !rss-running to see what feeds are monitored 7) enjoy | commands -------- | :commands in this plugin: rss-stop .. rss-delchannel .. rss-markuplist .. rss-nextpoll .. rss-list .. rss-addchannel .. rss-stopall .. rss-sync .. rss-register .. rss-channels .. rss-additem .. rss-stopwatch .. rss-watch .. rss-get .. rss-addmarkup .. rss-running .. rss-url .. rss-setsleeptime .. rss-link .. rss-all .. rss-seturl .. rss-setitems .. rss-sleeptime .. rss-search .. rss-markup .. rss-delmarkup .. rss-lastpoll .. rss-import .. rss-del .. rss-add .. rss-feeds .. rss-start .. rss-itemslist .. rss-scan .. rss-delitem .. rss-description | 1) *rss-add .. [handle_rssadd]* :description: arguments: - add a rss item. :permissions: USER :code: :ref:`fbf.plugs.extra.rss_rss-add_command`. :examples: :: ;rss-add fbfbot https://github.com/feedbackflow/fbfbot/commits/master.atom 2) *rss-addchannel .. [handle_rssaddchannel]* :description: arguments: [] [] [] - add a channel to rss item. :permissions: OPER :code: :ref:`fbf.plugs.extra.rss_rss-addchannel_command`. :examples: :: ;rss-addchannel fbfbot #dunkbots :: ;rss-addchannel fbfbot main #dunkbots 3) *rss-additem .. [handle_rssadditem]* :description: arguments: - add an item (token) to a feeds tokens to be displayed, see rss-scan for a list of available tokens. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-additem_command`. :examples: :: ;rss-additem fbfbot link 4) *rss-addmarkup .. [handle_rssaddmarkup]* :description: arguments: - add a markup to a feeds markuplist. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-addmarkup_command`. :examples: :: ;rss-addmarkup fbfbot all-lines 1 5) *rss-all .. [handle_rssall]* :description: arguments: - search titles of all cached data of a feed. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-all_command`. :examples: :: ;rss-all fbfbot 6) *rss-channels .. [handle_rsschannels]* :description: arguments: - show channels of rss feed. :permissions: OPER :code: :ref:`fbf.plugs.extra.rss_rss-channels_command`. :examples: :: ;rss-channels fbfbot 7) *rss-del .. [handle_rssdel]* :description: arguments: .. delete a rss item. :permissions: OPER .. RSS :code: :ref:`fbf.plugs.extra.rss_rss-del_command`. :examples: :: ;rss-del mekker 8) *rss-delchannel .. [handle_rssdelchannel]* :description: arguments: [] [] [] - delete channel from feed. :permissions: OPER :code: :ref:`fbf.plugs.extra.rss_rss-delchannel_command`. :examples: :: ;rss-delchannel fbfbot #dunkbots :: ;rss-delchannel fbfbot main #dunkbots 9) *rss-delitem .. [handle_rssdelitem]* :description: arguments: - delete token from a feeds itemlist. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-delitem_command`. :examples: :: ;rss-delitem fbfbot link 10) *rss-delmarkup .. [handle_rssdelmarkup]* :description: arguments: - delete markup from a feeds markuplist. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-delmarkup_command`. :examples: :: ;rss-delmarkup fbfbot all-lines 11) *rss-description .. [handle_rssdescription]* :description: arguments: - search descriptions in cached data. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-description_command`. :examples: :: ;rss-description fbfbot gozer 12) *rss-feeds .. [handle_rssfeeds]* :description: arguments: [] - show what feeds are running in a channel. :permissions: USER .. RSS :code: :ref:`fbf.plugs.extra.rss_rss-feeds_command`. :examples: :: ;rss-feeds :: ;rss-feeds #dunkbots 13) *rss-get .. [handle_rssget]* :description: arguments: - fetch feed data. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-get_command`. 14) *rss-import .. [handle_rssimport]* :description: arguments: - import feeds uses OPML. :permissions: OPER :code: :ref:`fbf.plugs.extra.rss_rss-import_command`. :examples: :: ;rss-import http://feedbackflow.org/feeds.opml 15) *rss-itemslist .. [handle_rssitemslist]* :description: argumetns - show list of tokens of feed that are being displayed. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-itemslist_command`. :examples: :: ;rss-itemslist fbfbot 16) *rss-lastpoll .. [handle_rsslastpoll]* :description: [] :permissions: OPER .. USER :code: :ref:`fbf.plugs.extra.rss_rss-lastpoll_command`. :examples: :: ;rss-lastpoll fbfbot :: ;rss-lastpoll all 17) *rss-link .. [handle_rsslink]* :description: arguments: - search link entries in cached data. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-link_command`. :examples: :: ;rss-link fbfbot gozer 18) *rss-list .. [handle_rsslist]* :description: no arguments - return list of available rss items. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-list_command`. :examples: :: ;rss-list 19) *rss-markup .. [handle_rssmarkup]* :description: arguments: - show the markup of a feed. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-markup_command`. :examples: :: ;rss-markup fbfbot 20) *rss-markuplist .. [handle_rssmarkuplist]* :description: no arguments - show possible markups that can be used. :permissions: USER :code: :ref:`fbf.plugs.extra.rss_rss-markuplist_command`. :examples: :: ;rss-markuplist 21) *rss-nextpoll .. [handle_rssnextpoll]* :description: [] :permissions: OPER .. USER :code: :ref:`fbf.plugs.extra.rss_rss-nextpoll_command`. :examples: :: ;rss-nextpoll fbfbot :: ;rss-nextpoll all 22) *rss-register .. [handle_rssregister]* :description: arguments: - register and start a rss item. :permissions: USER :code: :ref:`fbf.plugs.extra.rss_rss-register_command`. 23) *rss-running .. [handle_rssrunning]* :description: no arguments - show which watchers are running. :permissions: RSS .. OPER :code: :ref:`fbf.plugs.extra.rss_rss-running_command`. :examples: :: ;rss-running 24) *rss-scan .. [handle_rssscan]* :description: arguments: - scan rss item for used xml tokens. :permissions: USER :code: :ref:`fbf.plugs.extra.rss_rss-scan_command`. :examples: :: ;rss-scan fbfbot 25) *rss-search .. [handle_rsssearch]* :description: arguments: - search in titles of cached data. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-search_command`. :examples: :: ;rss-search json 26) *rss-setitems .. [handle_rsssetitems]* :description: arguments: - set tokens to display - see rss-scan for available tokens. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-setitems_command`. :examples: :: ;rss-setitems fbfbot author author link pubDate 27) *rss-setsleeptime .. [handle_rsssetsleeptime]* :description: arguments: - set sleeptime of feed, minimum is 60 seconds. :permissions: OPER :code: :ref:`fbf.plugs.extra.rss_rss-setsleeptime_command`. :examples: :: ;rss-setsleeptime fbfbot 600 28) *rss-seturl .. [handle_rssseturl]* :description: arguments: - set url of feed. :permissions: OPER :code: :ref:`fbf.plugs.extra.rss_rss-seturl_command`. :examples: :: ;rss-seturl fbfbot https://github.com/feedbackflow/fbfbot/commits/master.atom 29) *rss-sleeptime .. [handle_rsssleeptime]* :description: arguments: - get sleeptime of rss item. :permissions: USER :code: :ref:`fbf.plugs.extra.rss_rss-sleeptime_command`. :examples: :: ;rss-sleeptime fbfbot 30) *rss-start .. [handle_rssstart]* :description: arguments: - start a rss feed to a user/channel. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-start_command`. :examples: :: ;rss-start fbfbot 31) *rss-stop .. [handle_rssstop]* :description: arguments: .. stop a rss feed to a user/channel. :permissions: RSS .. USER :code: :ref:`fbf.plugs.extra.rss_rss-stop_command`. :examples: :: ;rss-stop fbfbot 32) *rss-stopall .. [handle_rssstopall]* :description: no arguments - stop all rss feeds to a channel. :permissions: RSS .. OPER :code: :ref:`fbf.plugs.extra.rss_rss-stopall_command`. :examples: :: ;rss-stopall 33) *rss-stopwatch .. [handle_rssstopwatch]* :description: arguments: - stop watching a feed. :permissions: OPER :code: :ref:`fbf.plugs.extra.rss_rss-stopwatch_command`. :examples: :: ;rss-stopwatch fbfbot 34) *rss-sync .. [handle_rsssync]* :description: arguments: - sync a feed with the latest. :permissions: OPER :code: :ref:`fbf.plugs.extra.rss_rss-sync_command`. :examples: :: ;rss-sync mekker 35) *rss-url .. [handle_rssurl]* :description: arguments: - return url of feed. :permissions: OPER :code: :ref:`fbf.plugs.extra.rss_rss-url_command`. :examples: :: ;rss-url fbfbot 36) *rss-watch .. [handle_rsswatch]* :description: arguments: [secondstosleep] - start watching a feed. :permissions: USER :code: :ref:`fbf.plugs.extra.rss_rss-watch_command`. :examples: :: ;rss-watch fbfbot :: ;rss-watch fbfbot 600