Eggdrop Tcl Archive

Extended Description File

#----------------------------------------------------------------------------
#- no!spam description file (Until: 03/03/2001) - by wreck
#- no!spam description file (revised: 02/04/2001) - by ppslim
#----------------------------------------------------------------------------
#- This is an advanced spam monitoring script that can monitor channel
#- messages, dcc sends, invites, private messages, notices, & part messages.
#- All of these types can be fully customized, or even shut off (the events
#- are only monitored where, when and how you want them to be).
#- Read no.spam.tcl itself for more info.
#
#- Essentially, this file tells you howto operate this TCL properly, and
#- no.spam.tcl itself will teach you how the script operates.
#- But you will NEED to read both in order to fully understand it.
#
#- Also, please keep in mind this script CAN be very CPU intensive.
#----------------------------------------------------------------------------
#- DCC command notes:
#
# Valid types for all DCC commands:
#   c = channel messages
#   n = notices
#   p = part messages
#
# +spam/-spam specific types:
#   a = can be used for all types (changes will effect all types)
#   m = private messages (can be used with .spams too)
#
# +spamchan/-spamchan specific type:
#   d = dcc-auto-cycling
#
# Search strings can contain wildcards.
#   * - Matches full phrases/words/sentences.
#   ? - Matches a single character.
#
# Also, case (UPPER lower sHiFtInG) doesn't matter for search strings.
#----------------------------------------------------------------------------
#- DCC commands:
#
# +spamchan <#channel> [type(s)]
#   If #channel isn't already monitored, then it will be added to your list
#   of spam channels.
#   And if no spam type is given, it will be given all types (+cdnp).
#
#   If #channel is already monitored, then the new types will be added to it.
#
# Examples:
#
#  +spamchan #zeraw
#    This will add the channel #zeraw to your spam channels, with the spam
#    types +cnp. This means no!spam will be monitoring #zeraw's channel,
#    notice, and part messages for spam.
#
#  +spamchan #zeraw n
#    If #zeraw isn't already monitored, this will add it with the type +n.
#    If #zeraw is already monitored, then it will be given +n (if needed).
#----------------------------------------------------------------------------
# -spamchan <#channel> [type(s)]
#   If no types are given, and #channel is being monitored, then it will be
#   removed from the list all together.
#
#   If types are given, they will be removed from that channel only.
#
# Examples:
#
#  -spamchan #zeraw
#    This will remove channel #zeraw from your list, including it's types.
#
#  -spamchan #zeraw np
#    This will only remove the spam type +np from #zeraw (if needed).
#    So no!spam will no longer be monitoring #zeraw's notices or parts.
#----------------------------------------------------------------------------
# spamchans
#   Returns the list of channels that are being monitored for spammers.
#----------------------------------------------------------------------------
# +spam <type> <string>
#   Adds a search string to the current list, of type.
#
# Examples:
#
#  +spam p *visit http:*
#    This will add the search string "*visit http:*" to the list of part
#    search strings you already have.
#
#  +spam a *join #*
#    This will add the search string "*join #*" to all of your
#    search string lists.
#----------------------------------------------------------------------------
# -spam <type> <string>
#   Removes a search string from the list of type.
#
# Example:
#
#  -spam c *visit http:*
#    This will remove the search string "*visit http:*" from the list of
#    channel search strings you already have.
#----------------------------------------------------------------------------
# spams <type> [string]
#   If a search string isn't given, this lists all search strings for type.
#   If a search string is given, this lists all matching strings for type.
#------------------------------------------------------------------wreck-----