.\" Terry Ross 

.TH "PageSix" 1 "Mar 02 2006" "Version 8.03" "IRC bot"

.SH NAME

PageSix \- Source Mage GNU/Linux IRC service bot

.SH SYNOPSIS

.BI "!command " arguments...

.br

.BI "page_six command " arguments...

.SH DESCRIPTION

.B PageSix

is an Internet Relay Chat 'bot' meant to perform service activities in support of Source Mage GNU/Linux channels on 

.I irc.freenode.net

.SH OPTIONS

.SS Conversions

.br

.I Distance related

.RS 2

.TP

.BI "km2mi " "kilometers"

Given a specified number of kilometers, returns the approximate number of miles.

.TP

.BI "mi2km " "miles"

Given a specified number of miles, returns the approximate number of kilometers.

.RE

.I Temperature related

.RS 2

.TP

.BI "c2f " "celsius"

Given degrees celsius, returns degrees fahrenheit.

.TP

.BI "f2c " "fahrenheit"

Given degrees fahrenheit, returns degrees celsius.

.RE

.I Latitude and Longitude

.RS 2

.TP

.BI "dms2dd " "deg min sec"

.RI "Given " "degrees minutes" " and optional " seconds ", returns decimal degrees in the form of dd.ffff. The " degrees ", " minutes " and " seconds " can be seperated by spaces, colons or periods."

.RE

.\" Gaze related commands

.SS Gaze related commands

These commands are equivalent to gaze commands you would run on your

Source Mage GNU/Linux machine.  Useful if you are on a different 

computer and don't actually have access to gaze.  In addition, there are

a few commands that aren't equivalent to any actual gaze commands, but

fit best in this category. Can be called with either 

.B gaze command

or

.BR command .

.RS 2

.TP

.BI "gaze creator " spell

Tells you who created

.I spell

originally.

.TP

.BI "gaze entered " spell

Tells you When 

.I spell

was originally created

.TP

.BI "gaze guilty " spell

Tells you who created  

.I spell

originally.

.TP

.BI "gaze from " target

Attempts to show what spell 

.I target

came from.  Note that the implementation in ruskie's bot, 

.BR scry ,

is much more effective.

.TP

.BI "gaze license " spell

Tells you what type of license 

.I spell

falls under.

.\" gaze maintainer

.TP

.BI "gaze maintainer " section

Gives the name and email address of the maintainer of grimoire section

.IR section .

.TP

.BI "gaze md5 " spell

Gives the m5sum for 

.IR spell .

.TP

.BI "gaze search " phrase

Searches for 

.I phrase

in the long and short spell descriptions and in the spell name.  Note 

that this uses a database generated four times daily, and is 

significantly faster than the standard gaze version. 

.TP

.BI "gaze source " spell

Shows the filename of the source tarball for 

.IR spell .

.TP

.BI "gaze source url " spell

Shows the first (and only the first) source URL for

.IR spell .

.TP

.BI "gaze updated " spell

Shows the date that 

.I spell

it was last updated (as opposed to the last modification).

.TP

.BI "gaze url " spell

Gives the URL to the welcome page for 

.IR spell .

.TP

.BI "gaze version " spell

Gives the current (stable OR z-rejected OR games - depending upon where 

.I spell

is located) version of

.IR spell .

.TP 

.BI "gaze versions " spell

Gives the version number for 

.I spell

for ALL of the standard grimoires where the spell can be found..

.TP

.BI "gaze what " spell

Prints the spell's short description.  Equivalent to 

.B gaze short spell.

.sp 2

.I Examples:

.br

!gaze what vim

.br

!gaze what short vim

.br

!gaze short vim

.br

!what short vim

.br

!what vim

.br

!short vim

.TP

.BI "gaze [what] full " spell

Prints the spell's description. Equivalent to

.sp 2

.I Examples:

.br

!gaze what full vim

.br

!gaze full vim

.br

!full vim

.br

!gaze what long vim

.br

!gaze long vim

.br

!long vim

.TP

.BI "gaze where " spell

Gives the name of the section that the spell is in.

.TP

.B "unmaintained"

Shows the unmaintained sections.

.RE

.SS Bug information

Used for getting details on a particular bug.

.RS 2

.TP

.BI "bug info [" # "]" "number"

Given the bug 

.IR number ,

page_six will return a short discription of the bug, and a link to the bug on 

.I bugzilla.

.RE

.SS Bug searching

Allows you to search 

.I bugzilla

for bugs by a single 

.I target 

search word or by grimoire section.

.RS 2

.TP

.BI "bug search [" section "] " target

Searches for any 

.BR "NEW" , " ASSIGNED" , 

or

.B REOPENED

bugs on 

.IR bugzilla ,

using the 

.I target 

word for the search. 

if the optional

.I section

is found, it will instead search for all 

.B NEW, ASSIGNED

or

.B REOPENED

bugs in the requested 

.I target

section.

.SS Bug checking

Bug checking checks http://bugs.sourcemage.org for new bugs (this

will be changed soon to allow you to change the level).  You can use

the full 

.B bug check

or abbreviate it to 

.B BC

when you give the commands.

.I Note: as of 01 March 2006, not all of these commands are fully

.I implemented.

.RS 2

.TP

.BI "bug check [" on | off | status ]

Turns bug checking on or off, or displays the current status.

.RE

.RS 2

.TP

.BI "bug check debugging [" on | off | status ]

Turns bug checking on or off, or displays the current debugging status. 

Debugging output is generally only visible on the the bots' home channel.

.RE

.RS 2

.TP

.BI "bug check confirm [" on | off | status ]

Turns bug check confirmations on or off, or displays the current

confirm status.  All this feature does is print a quick note to the bots'

home channel whenever a bug check is made.

.TP

.BI "bug check time " seconds

Change the number of seconds bug check waits before running.

.RE

.SS Tracker checking

Tracker checking checks for new posts on the Source Mage GNU/Linux 

web site.  Forum topics, personal blog entries, stories, quotes, 

polls etc. all fit in to this category.  You can use the full

.B "tracker check"

or abbreviate it to

.B "tc"

when you give most of the commands.

.RS 2

.TP

.BI "tracker check [" on | off | status ]

Turns tracker checking on or off, or displays the current status, 

showing whether it is on or off, how often the checks are made, and 

when the last check was made, and whether debugging and confirmations 

are on or off.

.TP

.BI "tracker check debugging [" on | off | status ]

Turn tracker checking debugging on or off, or displays the current debugging status.

.TP

.BI "tracker check confirm [" on | off | status ]

Turns tracker checking confirmations on or off, or displays the current confirm status. All this feature does is print a quick note to the bots home channel whenever a tracker check is made, if on.

.TP

.BI "tracker check time " seconds

Change the number of seconds tracker check waits before running.

.SS Miscellaneous commands

.TP

.BI "calc " calculation

Use Google Calc. More than just a simple four function calculator, you can get conversions, etc.

.TP

.B "commands"

Gives a (with any luck, up-to-date) list of the commands available.

.TP

.BI "define " "word or phrase"

Attempts to get and deliver a definition from WordNet. Note that some definitions are very long, and there is currently no way to stop the output.

.TP

.BI "context " number

When you use

.B !mention

or

.BR !lastmention ,

there will be a line number displayed on the left of the string.  Use the number to see the line in context.

.TP

.B cycle

Has the bot cycle the current channel (part and immediately rejoin);

.TP

.B help

Get some basic help information from the bot.

.TP

.B info

Get some general information about the bot.

.TP

.BI "join " channel

This command is limited to certain users.  Has the bot join the

specified

.IR channel .

.TP

.BI karma

Generates an HTML page giving instructions and listing current karma

levels, then provides the link.

.TP

.BI "karma " target " [ score | level ] | [ score | level ] " target

Gives the current karma level for 

.I target

.RS 2

.I Examples:

.sp 2

!karma page_six level

.br

!karma page_six score

.br

!karma level page_six

.br

!karma score page_six

.br

.RE

.TP

.BI "karma " target "  + | ++ | +5 | - | -- | -5 

Raises or lowers the karma level for 

.I target

by 1, 2, or 5 points.

.TP

.BI "lastmention [" target ]

Checks the log and after doing some filtering to exclude certain types

of lines, gives the last line that

.I target 

was mentioned on.  If 

.I target 

is not included, then it gives the last line that the nick of

the person giving the command was mentioned.  It also generates a file

showing a significant number of other mentions that it can see over the

the years. 

.sp 1

It will print a line number on the left.  You can use this line number with

the

.BI "!context " number

command, to see the line in context.

.TP

.B "markers"

Scrapes the Xplanet Marker data from 

.I http://wiki.sourcemage.org and runs

it through a sed transform.  Makes the basic and transformed versions

available in a format that can be dropped directly into 

.I ~/.xplanet/markers/sourcemage

.TP

.BI "mention [" target ]

Checks the log and after doing some filtering to exclude certain types

of lines, gives the last line that

.I target 

was mentioned on.  If 

.I target 

is not included, then it gives the last line that the nick of

the person giving the command was mentioned.  It also generates a file

showing a significant number of other mentions that it can see over the

the years. 

.sp 1

It will print a line number on the left.  You can use this line number with

the

.BI "!context " number

command, to see the line in context.

.TP

.BI "nick " nick

Changes the 'nick' of the bot.  Limited to certain users.

.TP

.B prisoner

Temporarily disabled.  Runs the dialog from the introduct to the TV

series "The Prisoner" with the bot 

.BR ib .

.TP

.BI "part " channel

Has the bot leave the specified channel. Limited to certain users.

.TP

.B rehash

Causes the bot to quit and restart.  Generally used after recompilation.

.TP

.B sign on time | signon time | signontime

Just shows when the bot last signed on to the network.  Old code,

to be updated.

.TP

.B sleep ib

Logs in to the bot 

.B ib

and put it to sleep for ten minutes or so.  This allows anyone to put

.B ib

to sleep.

.TP

.B spells

Gets and displays the current total number of Source Mage GNU/Linux spells 

as given at http://codex.sourcemage.org/listing.txt - in addition, it lists 

the number given by various values fed to gaze grimoire.

.TP

.B spells sorcerer | sorcerer spells

TEMP DISABLED: Equivalent to 'spells' - but for Sorcerer.

.TP

.B spells lunar | lunar spells | modules lunar | lunar modules | modules

Equivalent to 'spells' - but for giving the count of Lunar Linux modules.

.TP

.BI "timein [ list | " target ]

Attempts to give the local time of 

.IR target.

.I target can be a location (posix time zone locations, plus additional ones added

by request) or a Source Mage GNU/Linux user.  If 

.B list

is used instead, it prints a list of the Source Mage GNU/Linux users that it knows

about.

.TP

.B uptime

Gives the uptime details for the computer the bot is running on.

.TP

.BI "users " target

Gets the current Xplanet marker information from 

.I http://wiki.sourcemage.org

then attempts to generate a map for 

.IR target .

.I target

can be an SMGL user, a continent, a country, a state, or another geographical

area (a province, a time zone, etc.).

This map will show cities (depending upon the scale, actually) in grey,

developers in red, and users in blue.  The image will then be made available.

In addition, certain checks are made, and if the image differs from the

last one produced for that target, the new image is uploaded to a historical

archive where people can browse and see how things change over time.

.TP

.BI "vote"

.TP

.BI "vote " target " [ score | level ] | [ score | level ] " target ] 

.TP 

.BI "vote " target "  + | - 

Equivalent to the commands for karma, but you can only vote once, and then

only up (+) or down (-).

.TP

.B "wake ib"

Has the bot log in to 

.B ib

and wake it up.  This allows anyone to wake ib, even if they can't log in.

.TP

.BI "whatis " target

Searches the whatis database for complete words.

.SS Queries

Queries allow you to get certain information directly from the bot.  

This is mostly information that doesn't rate being placed in any sort of

status information, but is useful for debugging.

.RS 2

.TP

.B query chan

Tells what channel the query was made on.  Yes, it sounds superfluous, but there are situations where it is necessary.  For instance, depending on how the bot logs in, the case of the channel could change. (sourcemage, SOURCEMAGE, Sourcemage) -- if things mysteriously stop working, I can look at the current case and compare it to the case of the logfile.

.TP

.B query [chans|channels]

Gives a list of what channels the bot is currently on.

.TP

.B query debugging

Gives information on whether debugging is on or off in various 

procedures.

.TP

.B query last known bug

Gives information regarding the last bug that the bot is aware of.

.TP

.B query last known post

Gives information regarding the last post that the bot is aware of.

.TP

.B query server

Tells what IRC server the bot is connected to.

.TP

.B query version

Gives information about the bot.

.RE

.SS Force settings

Allows you to force certain settings in the bot.  Mostly used for debugging.

.RS 2

.TP

.B force last [known] bug

This fools the bot into thinking that the last bug it knows about is 

different than what it actually is.  This way, it will repeat information

that it has already given.

.TP

.B force update man [page]

Just an easy way for me to create a new tarball and HTML page for this man page

when it is updated, while simultaneously letting anyone on the channel know

that there is a new version

.RE

.SH AUTHOR

Terry 'qnr' Ross <terry at aliboom dot com>

.SH BUGS

Tends to be a bit of a wiseacre, but can be calmed down with some botsnacks.

Any others that you come across, I'd appreciate it if you'd let me know

using the email address in the AUTHOR section.