home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / gscr20.zip / helpme.txt < prev    next >
Text File  |  1997-06-17  |  7KB  |  231 lines
  1. Enhancements to GammaTech IRC written by:
  2.  
  3. Greg Spath
  4. http://www.epix.net/~gspath
  5. gspath@epix.net
  6. Wease on EFnet
  7.  
  8.  
  9. ---------
  10. /alias [/command] [parameters] [+] [/command2] [parameters2] [+] ...
  11.  
  12.     sets an alias for /command.
  13.     parameters can be any parameters passed to the command.
  14.     You can set an alias to represent more than one command
  15.     by separating each command with a '+'
  16.     
  17.     Special variable parameters can be used:
  18.  
  19.     $0 =  All words typed after the alias
  20.     $1 = first word typed after the alias
  21.     $2 = second word typed after the alias
  22.     $3 = third word typed after the alias
  23.     $ch = window title
  24.     $me = your current nickname
  25.  
  26.     Typing /alias alone lists all currently set aliases.
  27.  
  28.     examples: To set up an alias to run an external program
  29.           called 'heart':
  30.           
  31.           /alias /heart /pipe heart $0
  32.  
  33.           To set up an alias to do a /whois and a /ping on 
  34.                   a specified nick:
  35.  
  36.           /alias /whoping /whois $1 + /ping $1
  37.  
  38.     
  39.     if /command exists in the list, it is changed, not added.
  40.  
  41.  
  42.  
  43. ---------
  44. /add id hostmask [actions]
  45.  
  46.     adds a hostmask to the joinlist.  The actions specified
  47.     are carried out if you are a channel operator and any 
  48.     nick with the specified hostmask joins the channel.
  49.     If the id already exists in the list, then existing
  50.     entry is changed, not added.
  51.  
  52.     hostmask is of the form:
  53.         nickname!username@host
  54.         (i.e. Wease!gks@here.epix.net)
  55.  
  56.     The wildcard, '*' may be used in the hostmask.
  57.         example: *!*gks@*.epix.net will be carried out if
  58.              Wease from the above example joins the channel.
  59.  
  60.     Actions are a combination of:
  61.         +o Make the person who joined an operator
  62.         +k Kick the person who just joined
  63.         +b Ban and Kick the person who just joined
  64.         +i Ignore the person who just joined...and let them know.
  65.         +g greet the person with the current greet message
  66.         +p private greet the person with the current greet message.
  67.         +n notice the person with the current greet message
  68.         +scriptname runs the specified external routine, as 
  69.            follows: /scr scriptname nick
  70.  
  71.     It is best to use +g +p or +n with a single global hostmask. 
  72.  
  73.     Examples:
  74.         /add Wease *!*gks@*.epix.net +o  (makes 'Wease' an Op on join)
  75.         /add Everyone * +g  (Greet everybody if greets are enabled)
  76.         /add Wease *!*gks@*.epix.net +b  (since 'Wease' already exists
  77.                                                   in the joinlist, his entry
  78.                                                   is changed, not added)
  79.  
  80.  
  81.  
  82.  
  83. ----------
  84. /change id [joinactions]
  85.  
  86.     changes the join actions for the specified already existing
  87.     id in the join list.  If joinactions is omitted, then all
  88.     actions are cleared for that id.
  89.  
  90.     Example:
  91.         /change Wease +o +p
  92.         changes the existing entry for Wease to make him a channel op
  93.                 as well as receive a private greet message on join.
  94.  
  95.  
  96.  
  97. ----------
  98. /remove id
  99.  
  100.     removes the joinlist info for the specified id
  101.  
  102.  
  103.  
  104. ----------
  105. /removealias /alias
  106.  
  107.     removes the specified /alias from the list
  108.  
  109.  
  110.  
  111. ----------
  112. /joinlist
  113.  
  114.      displays the entire join action list created using /add
  115.  
  116.  
  117.  
  118. ----------
  119. /last [number]
  120.  
  121.     displays the last number messages to you.  If number is omitted
  122.     then the entire message buffer is displayed.
  123.  
  124.     See the next section for info on controlling the
  125.     message buffer.
  126.  
  127.  
  128. ----------
  129. /set [variable] [value]
  130.  
  131.     sets script variable to value.
  132.  
  133.     /set lists all variables used in this script.
  134.     /set variable lists the current value of specified variable
  135.  
  136.  
  137.     Variables used in this script:
  138.  
  139.     Variable:     Possible Values:       Use:
  140.     ---------     ----------------       ----
  141.     configfile    any valid filename     /save command writes to this file
  142.     autorun          any valid filename     called from configfile to run any
  143.                                              commands in the file specified
  144.     onjoin          any valid filename     script to run when you join a channel
  145.         onleave       any valid filename     script to run when you leave a channel
  146.         kickmirc      [on|off]               turn on to kick ppl using mirc colors
  147.     buffer          positive integer       The size of the message log buffer
  148.         rollbuffer    [on|off]               determines whether the message log
  149.                                              buffer should automatically 'roll'
  150.                                              when full.  Best to leave off for 
  151.                                              large buffers (>20)  If off, a 
  152.                          message is displayed when the 
  153.                                              buffer is full.
  154.         log           [on|off]               set on to log incoming messages 
  155.                                              to you
  156.     logme         [on|off]               set on to log messages originated
  157.                                              by you
  158.         nummsgs       positive integer       the number of messages in the buffer
  159.         joinactions   positive integer       the number of join action items
  160.         aliases       positive integer       the number of aliases set
  161.         join          [on|off]                 set on to enable all join actions
  162.     greet         [on|off]               set on to enable autogreet message
  163.         greetscr      [on|off]               set on to enable autogreet scripts
  164.     greetmsg      text                   the autogreet message
  165.  
  166.  
  167.     greetmsg can contain the following special characters:
  168.         $ch The name of the current channel
  169.         $ni The nickname of the person who joined.
  170.  
  171.     Example greetmsg:
  172.         /set greetmsg Hi $ni -- Welcome to $ch
  173.         
  174.         would display:
  175.  
  176.         Hi Wease -- Welcome to #OurPlace
  177.  
  178.         if 1)  greet = on
  179.            2)  a hostmask used by 'Wease' is set to +g +p or +n
  180.            3)  'Wease' joins a channel you are on (#OurPlace).
  181.  
  182.  
  183. ----------
  184. /savemsgs [filename]
  185.  
  186.     saves the current message buffer to filename.  If no filename is
  187.     given, the messages are saved to "msgsave.txt"
  188.  
  189.  
  190. ----------
  191. /exec [external command]
  192.  
  193.     Show the output of an external text-based OS/2 program in the 
  194.          current window.  This only displays the output, and does not
  195.      send it to the IRC server.
  196.  
  197.     Example:
  198.         /exec dir
  199.         would display a directory listing to the current window.
  200.  
  201.  
  202. ----------
  203. /pipe [command]
  204.  
  205.     sends the output of an external text-based OS/2 program to the
  206.           current channel or query for all to see.
  207.  
  208.     Example:
  209.         /pipe heart SomeGirl
  210.         would display the output of heart.cmd to the current
  211.                 channel or query.    
  212.  
  213.  
  214. ----------
  215. /save
  216.  
  217.     saves the current environment to the file specified by the
  218.     configfile variable.  See /set for info on setting configfile.
  219.  
  220.  
  221. ----------
  222. /init
  223.  
  224.     Reads all settings from configfile and initializes the external
  225.     3rd party REXX library used for grepping hostmasks.
  226.  
  227.  
  228. ----------
  229. /start program [parameters]
  230.  
  231.     run an OS/2 program...either text mode or PM based