Documentation for the Google plugin for Supybot

Purpose

Accesses Google for various things.

Commands

• cache <url>

  Returns a link to the cached version of <url> if it is available.

• calc <expression>

  Uses Google's calculator to calculate the value of <expression>.

• fight <search string> <search string> [<search string> ...]

  Returns the results of each search, in order, from greatest number of results to least.

• google <search> [--{language,restrict} <value>] [--{notsafe,similar}]

  Searches google.com for the given string. As many results as can fit are included. --language accepts a language abbreviation; --restrict restricts the results to certain classes of things; --similar tells Google not to filter similar results. --notsafe allows possibly work- unsafe results.

• lucky <search>

  Does a google search, but only returns the first result.

• meta <search> [--{language,restrict} <value>] [--{similar,notsafe}]

  Searches google and gives all the interesting meta information about the search. See the help for the google command for a detailed description of the parameters.

• phonebook <phone number>

  Looks <phone number> up on Google.

• spell <word>

  Returns Google's spelling recommendation for <word>.

• stats takes no arguments

  Returns interesting information about this Google module. Mostly useful for making sure you don't go over your 1000 requests/day limit.

Configuration

• supybot.plugins.Google.public

  This config variable defaults to True and is not channel specific.

  Determines whether this plugin is publicly visible.

• supybot.plugins.Google.groupsSnarfer

  This config variable defaults to False and is channel specific.

  Determines whether the groups snarfer is enabled. If so, URLs at groups.google.com will be snarfed and their group/title messaged to the channel.

• supybot.plugins.Google.searchSnarfer

  This config variable defaults to False and is channel specific.

  Determines whether the search snarfer is enabled. If so, messages (even unaddressed ones) beginning with the word google will result in the first URL Google returns being sent to the channel.

• supybot.plugins.Google.colorfulFilter

  This config variable defaults to False and is channel specific.

  Determines whether the word google in the bot's output will be made colorful (like Google's logo).

• supybot.plugins.Google.bold

  This config variable defaults to True and is channel specific.

  Determines whether results are bolded.

• supybot.plugins.Google.maximumResults

  This config variable defaults to 10 and is channel specific.

  Determines the maximum number of results returned from the google command.

• supybot.plugins.Google.defaultLanguage

  This config variable defaults to "lang_en" and is channel specific.

  Determines what default language is used in searches. If left empty, no specific language will be requested. Valid strings: lang_ar, lang_zh-CN, lang_zh-TW, lang_cs, lang_da, lang_nl, lang_en, lang_et, lang_fi, lang_fr, lang_de, lang_el, lang_iw, lang_hu, lang_is, lang_it, lang_ja, lang_ko, lang_lv, lang_lt, lang_no, lang_pt, lang_pl, lang_ro, lang_ru, lang_es, lang_sv, and lang_tr.

• supybot.plugins.Google.safeSearch

  This config variable defaults to True and is channel specific.

  Determines whether safeSearch is on by default.

• supybot.plugins.Google.licenseKey

  This config variable defaults to "" and is not channel specific.

  Sets the Google license key for using Google's Web Services API. This is necessary before you can do any searching with this module.

• supybot.plugins.Google.state
  • supybot.plugins.Google.state.searches

    This config variable defaults to 0 and is not channel specific.

    Used to keep the total number of searches Google has done for this bot. You shouldn't modify this.

  • supybot.plugins.Google.state.time

    This config variable defaults to 0.0 and is not channel specific.

    Used to keep the total amount of time Google has spent searching for this bot. You shouldn't modify this.