home *** CD-ROM | disk | FTP | other *** search
/ Enigma Amiga Life 109 / EnigmaAmiga109CD.iso / software / on-line / ctcp-master / ctcp-master.readme < prev    next >
Text File  |  1999-12-13  |  6KB  |  161 lines
  1.  
  2.                                 CTCP-Master v1.12
  3.                        by Roger Clark (kaedric@texas.net)
  4.  
  5.  
  6. What is it?
  7.  
  8. CTCP-Master  is  an  ARexx  add-on  script  for  AmIRC  2.x  and above that adds
  9. functions  found  on  most popular Bots.  This script originated from the source
  10. code of AmIRCOS a few years ago, and has grown and added many new features since
  11. then.  The script itself is uncompressed ARexx, so you can modify it if you want
  12. without  needing  to  "decrunch"  it.   All  I  ask  is  that  you  send  me any
  13. modifications that you make if you add new features to the script.
  14.  
  15. What does it do?
  16.  
  17. This  is the list of currently supported functions in CTCP-Master.  In order for
  18. you to use any of these commands locally, you must send yourself a /MSG with the
  19. command.   AmIRC  doesn't  return  your  text  to the ARexx port the same way it
  20. handles it from remote users.
  21.  
  22.   Host Functions: Only usable by your nick.
  23.  
  24.     #AWAY
  25.       Displays an AWAY message and monitors /CTCP Page requests.
  26.  
  27.     #FAQADD
  28.       Adds a FAQ to the main FAQ listing.
  29.  
  30.     #FAQKILL
  31.       Removes a FAQ from the main FAQ listing.
  32.  
  33.     #FAQREAD
  34.       Re-reads the main FAQ listing if you edited it manually.
  35.  
  36.     #OPS
  37.       Add or Remove hostmasks from the Auto-OP list.
  38.  
  39.     #QUIT
  40.       Displays a random QUIT message from the CTCP-QuitMsgs file.
  41.  
  42.     #SHOWOPS
  43.       Shows all hostmasks being monitored for Auto-OP privledge.
  44.  
  45.     #SOUND
  46.       Opens a requestor to allow you to send a /CTCP Sound request to a user or
  47.       channel.
  48.  
  49.     #STOP
  50.       Signals CTCP-Master to exit.
  51.  
  52.   Remote User Functions:
  53.  
  54.     /CTCP Commands:
  55.  
  56.       PING
  57.         Sends a random reply to PING requests.
  58.  
  59.       SOUND
  60.         Handles SOUND requests, including auto-requesting files that are not on
  61.         your computer.
  62.  
  63.       USERINFO
  64.         Displays an enhanced USERINFO message.
  65.  
  66.   Trigger Commands:
  67.  
  68.     The  trigger  is  user-defineable  in the CTCP-Master.cfg file.  The default
  69.     trigger is the exclamation point.
  70.  
  71.       !CALC
  72.         Performs basic math functions and returns the result.
  73.         Note: Currently no error checking is done to be sure the argument
  74.               is a valid mathematical function.
  75.  
  76.       !CONVERT
  77.         Converts between various units of measurements.
  78.  
  79.       !COUNTRY (or !WHERE)
  80.         Displays ISO <--> Normal country code translations.
  81.         Example: GB is the ISO country code for Great Britain.
  82.  
  83.       !DNS
  84.         Performs a DNS lookup on the given hostname or IP address.
  85.         Using the -s switch, you can look up Port/Service information as well.
  86.  
  87.       !EXCHANGE (or !CURRENCY)
  88.         Displays current international currency exchange rates as reported
  89.         by http://www.xe.net/ucc
  90.  
  91.       !FAQ
  92.         Lists the name and decription of a selected FAQ, or lists available FAQs
  93.         if none is specified.
  94.  
  95.       !FAQADD
  96.         Lets remote users add FAQ topics to the main FAQ listing.
  97.  
  98.       !FIND
  99.         Searches Aminet for the specified text.
  100.  
  101.       !FORECAST
  102.         Will display the current weather conditions for the given city or US Zip Code,
  103.         along with an 3 to 5 day extended forecast sent via private Notice to the user.
  104.         Most International cities are supported.  This function will query the
  105.         database at http://www.wunderground.com for weather information.
  106.  
  107.       !HOROSCOPE
  108.         Displays a horoscope for the requested star sign.
  109.  
  110.       !LAST
  111.         Returns the last known /QUIT message for the selected user.
  112.  
  113.       !MONTH
  114.         Sends an ASCII calendar to the remote user.
  115.  
  116.       !PAGE
  117.         Will execute a remote command when you are paged. Additional arguments
  118.         can be passed now to an external program. Env variable $Pager is now set
  119.         with the name and reason for the page.  Use \$Pager\ to pass this as an
  120.         argument to an external program.
  121.  
  122.       !SEEN
  123.         Lists when a user was last seen on the current channel, or any channel
  124.         you may be joined to at the time of the request.
  125.  
  126.       !SHOWCOMMANDS
  127.         Displays a listing of all avaiable commands supported by CTCP-Master.
  128.  
  129.       !STOCK
  130.         Will display the last reported value and change for the given stock symbol.
  131.  
  132.       !TEMP
  133.         Will display the current temperature for the given city or US Zip Code.
  134.         Most International sities are supported.  This function will query the
  135.         database at http://www.wunderground.com for weather information.
  136.  
  137.       !TIME
  138.         Displays current time as GMT.
  139.  
  140.       !TRANSLATE
  141.         Allows you to get translations of text.  Supports English to/from
  142.         Spanish, French, German, Protuguese, Italian.
  143.  
  144.       !WEATHER
  145.         Will display the current weather conditions for the given city or US Zip Code.
  146.         Most International cities are supported.  This function will query the
  147.         database at http://www.wunderground.com for weather information.
  148.  
  149.       !ZIP
  150.         Will display the corresponding US city for the supplied ZIP Code.
  151.  
  152. Installing the script:
  153.  
  154. Simply   unarc   the   files  into  the  AmIRC:Rexx/  directory,  and  edit  the
  155. CTCP-Master.cfg  file  to show your personal information.  You can also edit the
  156. CTCP-Master.pings  file if you wish to add/change/delete any of the default ping
  157. responses.
  158.  
  159. Optionally,  you  can  rename  CTCP-Master.amirx  to Connected.amirx and it will
  160. start as soon as you connect to a Server.
  161.