Initial import of the ircii-pana-1.1-final source tree.

git-svn-id: svn://svn.code.sf.net/p/bitchx/code/tags/ircii-pana-1.1-final@1 13b04d17-f746-0410-82c6-800466cd88b0

doc/pana-docs/pana-docs.txt

@@ -0,0 +1,401 @@
+  ircII 2.8 + BitchX Documentation
+  Patrick J. Edwards, ppjjee112200@@ccss..uussaasskk..ccaa
+  Tue Feb 13 13:50:47 GMT 1996
+
+
+  11..  IInnttrroodduuccttiioonn
+
+  BitchX is a new and exciting IRC client being written by Colten
+  Edwards <hhttttpp::////mmaaiillttoo::eeddwwaacc@@ssaasskknneett..sskk..ccaa>. It includes many new
+  features that IRCists have been asking for. The sources are based on
+  ircii-Plutotium and ircii-EPiC to create a new and distictive IRC
+  client. Heres a small list of the cool features you get with BitchX:
+
+
+  +o  When run under Linux, BitchX has an added bonus of being in full
+     color.
+
+  +o  Friends, Shit, and Bot Lists built in.
+
+  +o  Built in Link Looking, incase you into split servers.
+
+  +o  Millisecond accuracy on a ping.
+
+  +o  Several new functions for scripters to use, and a few new
+     variables.
+
+  +o  Extended set of DCC commands and options, like auto-getting,
+     queues, public offers, and graphical displays.
+
+  +o  A more logical command set, like /W for /WHO and /WI for /WHOIS.
+
+  +o  Mass functions, like mass ban, mass op, etc.
+
+  +o  And tons of other commands, like /RESET and /MESG, incase your not
+     very popular on IRC.
+
+
+  You may be thinking great. But I get all that functionality from a
+  script, or you maybe thinking BitchX is a script. Well, read on for
+  more of an explanation of what BitchX is all about.
+
+
+  First of all, its not a script. Secondly, when you load up a script
+  say Phoenix or LiCe it takes a long time to load. Plus you probably
+  have other scripts that you load. For example I used to load up to
+  100k of scripts. That 100k would take up alot of memory, and was slow
+  loading, and slow executing. BitchX doesn't have this problem. It has
+  all these commands loaded hard-coded into the syetem, and the
+  executable approximately the same size.
+
+
+  The bottom line is IRC load fast, it does everything fast, in less
+  memory.
+
+
+  Well, if you have read up to this point, and are thinking BitchX is a
+  good thing, you can get it from The BitchX Homepage
+  <hhttttpp::////wwwwww..ccss..uussaasskk..ccaa//uunnddeerrggrraaddss//ppjjee112200//bbiittcchhxx//>.
+
+
+
+
+  22..  NNeeww ccoommmmaannddss
+
+
+
+  22..11..  FFiixxeedd//CChhaannggeedd CCoommmmaannddss
+
+  These commands existed before in ircII, but now are either fixed or
+  changed in some way. Likely, in a better, more natural way.
+
+     DD  Can be used for DESCRIBE.
+
+     II  see INVITE.
+
+     IINNVVIITTEE
+        Now works like this, /I nick1 nick2 to the current channel, and
+        /I nick1 #channel1 nick2 channel2.
+
+     IIGG <<nniicckk>>
+        Ignore lamer by user@host.
+
+     IIGGHH <<nniicckk>>
+        Ignore lamer's whole host.
+
+     NNIIGG <<nniicckk>>
+        Unignore lamer.
+
+     JJ <<cchhaannnneell>>
+        For JOIN.
+
+     LL cchhaannnneell
+        For PART. If no argument is given the current channel is left.
+
+     MM <<nniicckk oorr cchhaannnneell>>
+        For MSG.
+
+     NN cchhaannnneell
+        For NAMES. If no argument is given the current channel is used.
+
+     TT ssttrriinngg
+        For TOPIC. If no argument is given it shows the topic on the
+        current channel.
+
+     SSCC cchhaannnneell
+        For NAMES. If no argument is given the current channel is used.
+
+     WW cchhaannnneellmmaasskk
+        Does a WHO. If no arguments are given it does a WHO on the
+        current channel.
+
+     WWII nniicckk
+        Does a WHOIS. If no arguement is given, a WHOIS is done on your
+        nick.
+
+     WWIIII nniicckknniicckk
+        Simular to WI.
+
+     WWWW nniicckk
+        Does a WHOWAS.
+
+     DDIIRRLLMM
+        Directs last message to the current channel.
+
+     DDIIRRLLNN
+        Directs last notice to the current channel.
+
+
+  22..22..  MMaassss CCoommmmaannddss
+
+  These are for doing mass operations on a channel.
+
+     MMOOPP cchhaannnneell ppaatttteerrnn
+        Mass op. Does a /MODE channel +o on all people.
+
+     MMDD cchhaannnneell ppaatttteerrnn
+        Mass deop. Does a /MODE channel -o on all people.
+
+     MMKK cchhaannnneell <<ppaatttteerrnn>> rreeaassoonn
+        Mass kick on non-ops matching pattern.
+
+     MMBB cchhaannnnee ppaatttteerrnn
+        Mass ban all non-ops.
+
+     MMKKBB cchhaannnneell <<ppaatttteerrnn>> rreeaassoonn
+        Mass kickban of all non ops matching pattern.
+
+     MMUUBB cchhaannnneell ppaatttteerrnn
+        Mass unban.
+
+     BBOOOOTT
+        See MULTI.
+
+     MMUULLTTII cchhaannnneell nniicckk11 nniicckk22 ...... nniicckknn ::rreeaassoonn
+        Kick multiple nicks off the channel with optional reason.
+
+
+  22..33..  BBaann//UUnnbbaann//KKiicckk//UUnnkkiicckk CCoommmmaannddss
+
+  Should you havethe chance to become an op on a popular channel, you
+  might need a few of these.
+
+     KK cchhaannnneell <<nniicckk>> rreeaassoonn
+        Kick nick from channel.
+
+     KKBB
+
+     BBKK
+
+     FFUUCCKKcchhaannnneell <<nniicckk>> rreeaassoonn
+        Kick and Ban nick from channel.
+
+     BB
+
+     BBAANN cchhaannnneell <<nniicckk>>
+        Ban nick from channel.
+
+     SSBB
+
+     SSBBAANN cchhaannnneell <<nniicckk>>
+        Ban nick's entire site from channel.
+
+     SSKK cchhaannnneell <<nniicckk>> rreeaassoonn
+        Site Kick and Ban nick.
+
+     DDBBAANN
+
+     UUBB cchhaannnneell nniicckk--ppaatttteerrnn
+        If no arguements are given all bans on the channel will be
+        removed.
+
+
+  22..44..  LLiisstt CCoommmmaannddss
+
+  Frequently, you may find people that you trust alot on IRC, these are
+  you friends. But even more frequently you'll find people on IRC are
+  annoying, so annoying that they deserve to be shitlisted. That's what
+  this whole section is about.
+     BBOOTT <<nniicckk>> <<cchhaannnneell>>
+        Add user as a bot to a channel. Channel can be a *.
+
+     UUNNBBOOTT <<nniicckk>> <<cchhaannnneell>>
+        Remove nick from the bot list.
+
+     AADDDDUUSSEERR <<nniicckk>> <<cchhaannnneell>> lleevveell aauuttoooopp pprroott ppaasssswwdd
+        Add nick to your personal friends list on channel. Level,
+        autoop, prot, and passwd are all optional, and default to
+        nothing, except Level, which defaults to 40. The following are
+        for the level.
+
+        2255 Enable ctcp invite and whoami.
+
+        5500++
+           Ops channel ops and and unbans.
+
+        9900++
+           Disable flood protection, plus Kick and Deop.
+
+        Autoop values are:
+
+        00  No ops.
+
+        11  10 second delay before oping.
+
+        22  instant autoop.
+
+        ootthheerr
+           does nothing.
+
+        Note that the user is not saved until a SAVELIST is issued.
+
+     UUNNUUSSEERR <<nniicckk>>
+        Deletes a user from the user list.
+
+     AADDDDSSHHIITT <<nniicckk>> <<cchhaannnneell>> <<lleevveell>> rreeaassoonn
+        Adds a user to the shit list.
+
+     UUNNSSHHIITT <<nniicckk>>
+        Removes a user from the shit list.
+
+     UUSSEERRLLIISSTT
+        Displays all users in the friends list.
+
+     SSHHIITTLLIISSTT
+        Displays all users in the shit list.
+
+     BBOOTTLLIISSTT
+        Displays all users in the bot list.
+
+     SSAAVVEELLIISSTT
+        Save the shit, friends, and bot lists. This saves the
+        information to the $(CTOOLZ_DIR)/BitchX.sav file.
+
+     SSAAVVEEAA
+        Saves information to the ..iirrccrrcc over writing it.
+
+
+  22..55..  MMiisscceellllaanneeoouuss CCoommmmaannddss
+
+  22..66..  DDCCCC CCoommmmaannddss
+
+
+
+
+  33..  NNeeww SSEETT ccoommmmaannddss
+
+  Along with the new IRC there are new options you can set.
+
+     AANNNNOOYY__KKIICCKK oonn||ooffff
+        Kick people for using bold, inverse, or beep on protected
+        channels.
+
+     AAOOPP oonn||ooffff
+        Set on if you want to automatically op people.
+
+     AAUUTTOOCCKK oonn||ooffff
+        Kicks people who send /xdcc * send.
+
+     AAUUTTOO__NNSSLLOOOOKKUUPP oonn||ooffff
+        Sets whether IP numbers are looked up on a /JOIN or /WHOIS.
+
+     AAUUTTOO__RREEJJOOIINN 00||11||22||33||44||55
+        Sets how you should auto rejoin if kicked from a channel. The
+        channel key is remebered.
+
+        00  off.
+
+        11  rejoin normally.
+
+        22  rejoin with a newuser name (the person's who kicked you).
+
+        33  rejoin with a random nick name.
+
+        44  rejoin with a random user name.
+
+        55  rejoin with a random user name and nick name.
+
+     CCHHEECCKK__BBEEEEPP__UUSSEERRSS oonn||ooffff
+
+
+
+  44..  NNeeww ffuunnccttiioonnss
+
+  Firstly the new functions:
+
+     $$aannnnooyy((tteexxtt))
+        Inserts random ^B, ^V, ^_, and makes random letters capitals.
+
+     $$cclluusstteerr((hhoossttnnaammee))
+        Makes aa.bb.cc into *.bb.cc format.
+
+     $$ccooooll((tteexxtt))
+        Makes ThInGs lOoK LiKe tHiS.
+
+     $$eelleeeett((tteexxtt))
+        Increases your eleetness.
+
+     $$ggeettkkeeyy((cchhaannnneell))
+        Shows the channel key.
+
+     $$ssttrriippaannssii((tteexxtt))
+        Strips ansi sequences from text.
+
+     $$uuppttiimmee(())
+        Display up time in Days, Hours, Minutes, Seconds.
+
+     $$ooppeenn((ffiillee RRWW||RR||WW TT||BB))
+        Opens a file descriptor.
+
+
+     $$rreeaadd((nnuummbbeerr))
+        Reads from a file returning text.
+
+     $$wwrriittee((nnuummbbeerr aarrggss))
+        Write args to a file.
+
+     $$eeooff((nnuummbbeerr))
+        Returns if EOF of file or not.
+
+     $$cclloossee((nnuummbbeerr))
+        Closes a file.
+
+     $$rreennaammee((oollddffiillee nneewwffiillee))
+        Renames a file.
+
+     $$rroott1133((tteexxtt))
+        Rot 13's text.
+
+     $$rrmmddiirr((ddiirrnnaammee))
+
+     $$uunnlliinnkk(())
+
+     bbccooppyy(())
+
+     $$cchheecckk__uusseerr(())
+
+     $$cchheecckk__sshhiitt(())
+        compat ctoolz null function.
+
+     $$rreeaaddlloogg(())
+        Read msg log file.
+
+     rreemmlloogg(())
+        Removes msg log file.
+
+     $$wwhhiicchh((ffiilleennaammee))
+
+  And the new variables:
+
+     $$EE Shows idle time.
+
+     $$FF Time online.
+
+     $$JJ Shows which version of IRC is in use.
+
+     $$XX Userhost.
+
+     $$YY Real name.
+
+New status line variables:
+	%D Show dcc percentage done on status line.
+
+	%^ Show number of recieved messages while away on status line.
+	
+
+
+  55..  TThhee FFuuttuurree ooff BBiittcchhXX
+
+
+
+
+
+
+
+
+
+
+
+
+
+