home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / bx75p3.zip / doc / pana-docs2.txt < prev    next >
Text File  |  1999-02-23  |  9KB  |  388 lines
  1.   ircII 2.8 + BitchX Documentation
  2.   Patrick J. Edwards, pje120@cs.usask.ca
  3.   Tue Feb 13 13:50:47 GMT 1996
  4.  
  5.  
  6.   1.  Introduction
  7.  
  8.   BitchX is a new and exciting IRC client being written by Colten
  9.   Edwards <http://mailto:edwac@sk.sympatico.ca>. It includes many new
  10.   features that IRCists have been asking for. The sources are based on
  11.   ircii-Plutotium and ircii-EPiC to create a new and distictive IRC
  12.   client. Heres a small list of the cool features you get with BitchX:
  13.  
  14.  
  15.   o  When run under Linux, BitchX has an added bonus of being in full
  16.      color.
  17.  
  18.   o  Friends, Shit, and Bot Lists built in.
  19.  
  20.   o  Built in Link Looking, incase your into split servers.
  21.  
  22.   o  Millisecond accuracy on a ping.
  23.  
  24.   o  Several new functions for scripters to use, and a few new
  25.      variables.
  26.  
  27.   o  Extended set of DCC commands and options, like auto-getting,
  28.      queues, public offers, and graphical displays.
  29.  
  30.   o  A more logical command set, like /W for /WHO and /WI for /WHOIS.
  31.  
  32.   o  Mass functions, like mass ban, mass op, etc.
  33.  
  34.   o  And tons of other commands, like /RESET and /MESG, incase your not
  35.      very popular on IRC.
  36.  
  37.  
  38.   You may be thinking great. But I get all that functionality from a
  39.   script, or you maybe thinking BitchX is a script. Well, read on for
  40.   more of an explanation of what BitchX is all about.
  41.  
  42.  
  43.   First of all, its not a script. Secondly, when you load up a script
  44.   say Phoenix or LiCe it takes a long time to load. Plus you probably
  45.   have other scripts that you load. For example I used to load up to
  46.   100k of scripts. That 100k would take up alot of memory, and was slow
  47.   loading, and slow executing. BitchX doesn't have this problem. It has
  48.   all these commands loaded hard-coded into the syetem, and the
  49.   executable approximately the same size.
  50.  
  51.  
  52.   The bottom line is IRC load fast, it does everything fast, in less
  53.   memory.
  54.  
  55.  
  56.   Well, if you have read up to this point, and are thinking BitchX is a
  57.   good thing, you can get it from The BitchX Homepage
  58.   <http://www.cs.usask.ca/undergrads/pje120/bitchx/>.
  59.  
  60.  
  61.  
  62.  
  63.   2.  New commands
  64.  
  65.  
  66.  
  67.   2.1.  Fixed/Changed Commands
  68.  
  69.   These commands existed before in ircII, but now are either fixed or
  70.   changed in some way. Likely, in a better, more natural way.
  71.  
  72.      D  Can be used for DESCRIBE.
  73.  
  74.      I  see INVITE.
  75.  
  76.      INVITE
  77.         Now works like this, /I nick1 nick2 to the current channel, and
  78.         /I nick1 #channel1 nick2 channel2.
  79.  
  80.      IG <nick>
  81.         Ignore lamer by user@host.
  82.  
  83.      IGH <nick>
  84.         Ignore lamer's whole host.
  85.  
  86.      NIG <nick>
  87.         Unignore lamer.
  88.  
  89.      J <channel>
  90.         For JOIN.
  91.  
  92.      L channel
  93.         For PART. If no argument is given the current channel is left.
  94.  
  95.      M <nick or channel>
  96.         For MSG.
  97.  
  98.      N channel
  99.         For NAMES. If no argument is given the current channel is used.
  100.  
  101.      T string
  102.         For TOPIC. If no argument is given it shows the topic on the
  103.         current channel.
  104.  
  105.      SC channel
  106.         For NAMES. If no argument is given the current channel is used.
  107.  
  108.      W channelmask
  109.         Does a WHO. If no arguments are given it does a WHO on the
  110.         current channel.
  111.  
  112.      WI nick
  113.         Does a WHOIS. If no arguement is given, a WHOIS is done on your
  114.         nick.
  115.  
  116.      WII nicknick
  117.         Simular to WI.
  118.  
  119.      WW nick
  120.         Does a WHOWAS.
  121.  
  122.      DIRLM
  123.         Directs last message to the current channel.
  124.  
  125.      DIRLN
  126.         Directs last notice to the current channel.
  127.  
  128.  
  129.   2.2.  Mass Commands
  130.  
  131.   These are for doing mass operations on a channel.
  132.  
  133.      MOP channel pattern
  134.         Mass op. Does a /MODE channel +o on all people.
  135.  
  136.      MD channel pattern
  137.         Mass deop. Does a /MODE channel -o on all people.
  138.  
  139.      MK channel <pattern> reason
  140.         Mass kick on non-ops matching pattern.
  141.  
  142.      MB channe pattern
  143.         Mass ban all non-ops.
  144.  
  145.      MKB channel <pattern> reason
  146.         Mass kickban of all non ops matching pattern.
  147.  
  148.      MUB channel pattern
  149.         Mass unban.
  150.  
  151.      BOOT
  152.         See MULTI.
  153.  
  154.      MULTI channel nick1 nick2 ... nickn :reason
  155.         Kick multiple nicks off the channel with optional reason.
  156.  
  157.  
  158.   2.3.  Ban/Unban/Kick/Unkick Commands
  159.  
  160.   Should you havethe chance to become an op on a popular channel, you
  161.   might need a few of these.
  162.  
  163.      K channel <nick> reason
  164.         Kick nick from channel.
  165.  
  166.      KB
  167.  
  168.      BK
  169.  
  170.      FUCKchannel <nick> reason
  171.         Kick and Ban nick from channel.
  172.  
  173.      B
  174.  
  175.      BAN channel <nick>
  176.         Ban nick from channel.
  177.  
  178.      SB
  179.  
  180.      SBAN channel <nick>
  181.         Ban nick's entire site from channel.
  182.  
  183.      SK channel <nick> reason
  184.         Site Kick and Ban nick.
  185.  
  186.      DBAN
  187.  
  188.      UB channel nick-pattern
  189.         If no arguements are given all bans on the channel will be
  190.         removed.
  191.  
  192.  
  193.   2.4.  List Commands
  194.  
  195.   Frequently, you may find people that you trust alot on IRC, these are
  196.   you friends. But even more frequently you'll find people on IRC are
  197.   annoying, so annoying that they deserve to be shitlisted. That's what
  198.   this whole section is about.
  199.      BOT <nick> <channel>
  200.         Add user as a bot to a channel. Channel can be a *.
  201.  
  202.      UNBOT <nick> <channel>
  203.         Remove nick from the bot list.
  204.  
  205.      ADDUSER <nick> <channel> level autoop prot passwd
  206.         Add nick to your personal friends list on channel. Level,
  207.         autoop, prot, and passwd are all optional, and default to
  208.         nothing, except Level, which defaults to 40. The following are
  209.         for the level.
  210.  
  211.         25 Enable ctcp invite and whoami.
  212.  
  213.         50+
  214.            Ops channel ops and and unbans.
  215.  
  216.         90+
  217.            Disable flood protection, plus Kick and Deop.
  218.  
  219.         Autoop values are:
  220.  
  221.         0  No ops.
  222.  
  223.         1  10 second delay before oping.
  224.  
  225.         2  instant autoop.
  226.  
  227.         other
  228.            does nothing.
  229.  
  230.         Note that the user is not saved until a SAVELIST is issued.
  231.  
  232.      UNUSER <nick>
  233.         Deletes a user from the user list.
  234.  
  235.      ADDSHIT <nick> <channel> <level> reason
  236.         Adds a user to the shit list.
  237.  
  238.      UNSHIT <nick>
  239.         Removes a user from the shit list.
  240.  
  241.      USERLIST
  242.         Displays all users in the friends list.
  243.  
  244.      SHITLIST
  245.         Displays all users in the shit list.
  246.  
  247.      BOTLIST
  248.         Displays all users in the bot list.
  249.  
  250.      SAVELIST
  251.         Save the shit, friends, and bot lists. This saves the
  252.         information to the $(CTOOLZ_DIR)/BitchX.sav file.
  253.  
  254.      SAVEA
  255.         Saves information to the .ircrc over writing it.
  256.  
  257.  
  258.   2.5.  Miscellaneous Commands
  259.  
  260.   2.6.  DCC Commands
  261.  
  262.  
  263.  
  264.  
  265.   3.  New SET commands
  266.  
  267.   Along with the new IRC there are new options you can set.
  268.  
  269.      ANNOY_KICK on|off
  270.         Kick people for using bold, inverse, or beep on protected
  271.         channels.
  272.  
  273.      AOP on|off
  274.         Set on if you want to automatically op people.
  275.  
  276.      AUTOCK on|off
  277.         Kicks people who send /xdcc * send.
  278.  
  279.      AUTO_NSLOOKUP on|off
  280.         Sets whether IP numbers are looked up on a /JOIN or /WHOIS.
  281.  
  282.      AUTO_REJOIN 0|1|2|3|4|5
  283.         Sets how you should auto rejoin if kicked from a channel. The
  284.         channel key is remebered.
  285.  
  286.         0  off.
  287.  
  288.         1  rejoin normally.
  289.  
  290.         2  rejoin with a newuser name (the person's who kicked you).
  291.  
  292.         3  rejoin with a random nick name.
  293.  
  294.         4  rejoin with a random user name.
  295.  
  296.         5  rejoin with a random user name and nick name.
  297.  
  298.      CHECK_BEEP_USERS on|off
  299.  
  300.  
  301.  
  302.   4.  New functions
  303.  
  304.   Firstly the new functions:
  305.  
  306.      $annoy(text)
  307.         Inserts random ^B, ^V, ^_, and makes random letters capitals.
  308.  
  309.      $cluster(hostname)
  310.         Makes aa.bb.cc into *.bb.cc format.
  311.  
  312.      $cool(text)
  313.         Makes ThInGs lOoK LiKe tHiS.
  314.  
  315.      $eleet(text)
  316.         Increases your eleetness.
  317.  
  318.      $getkey(channel)
  319.         Shows the channel key.
  320.  
  321.      $stripansi(text)
  322.         Strips ansi sequences from text.
  323.  
  324.      $uptime()
  325.         Display up time in Days, Hours, Minutes, Seconds.
  326.  
  327.      $open(file RW|R|W T|B)
  328.         Opens a file descriptor.
  329.  
  330.  
  331.      $read(number)
  332.         Reads from a file returning text.
  333.  
  334.      $write(number args)
  335.         Write args to a file.
  336.  
  337.      $eof(number)
  338.         Returns if EOF of file or not.
  339.  
  340.      $close(number)
  341.         Closes a file.
  342.  
  343.      $rename(oldfile newfile)
  344.         Renames a file.
  345.  
  346.      $rot13(text)
  347.         Rot 13's text.
  348.  
  349.      $rmdir(dirname)
  350.  
  351.      $unlink()
  352.  
  353.      bcopy()
  354.  
  355.      $check_user()
  356.  
  357.      $check_shit()
  358.         compat ctoolz null function.
  359.  
  360.      $readlog()
  361.         Read msg log file.
  362.  
  363.      remlog()
  364.         Removes msg log file.
  365.  
  366.      $which(filename)
  367.  
  368.   And the new variables:
  369.  
  370.      $E Shows idle time.
  371.  
  372.      $F Time online.
  373.  
  374.      $J Shows which version of IRC is in use.
  375.  
  376.      $X Userhost.
  377.  
  378.      $Y Real name.
  379.  
  380. New status line variables:
  381.         %D Show dcc percentage done on status line.
  382.  
  383.         %^ Show number of recieved messages while away on status line.
  384.  
  385.  
  386.  
  387.   5.  The Future of BitchX
  388.