home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / bx75p3.zip / doc / bx-faq.txt < prev    next >
Text File  |  1999-02-23  |  17KB  |  440 lines
  1.   BitchX FAQ
  2.   Chris Bond, chris@uk.logics.com
  3.   v2.0.1, 11 Febuary 1998
  4.  
  5.   This document explains how to use bitchx.
  6.   ______________________________________________________________________
  7.  
  8.   Table of Contents:
  9.  
  10.   1.      General
  11.  
  12.   1.1.    Introduction
  13.  
  14.   1.2.    What is BitchX?
  15.  
  16.   1.3.    Where can I get it?
  17.  
  18.   1.4.    What are the requirements to run BitchX?
  19.  
  20.   1.5.    What OS'es have been tested to work with BitchX?
  21.  
  22.   2.      Getting started with BitchX
  23.  
  24.   2.1.    Installing BitchX with the source code
  25.  
  26.   2.2.    Compiling BitchX with tcl support
  27.  
  28.   2.3.    Starting BitchX
  29.  
  30.   2.4.    Getting to grips with the basic commands
  31.  
  32.   2.5.    What are BitchX.reasons/quit/help ?
  33.  
  34.   2.6.    Setting variables (Like i'm too lame to read BitchX.doc)
  35.  
  36.   2.7.    How do I use BitchX within XWindows?
  37.  
  38.   2.8.    What is .bitchxrc/bxglobal and .ircrc?
  39.  
  40.   3.      Commands
  41.  
  42.   3.1.    CDCC/XDCC
  43.  
  44.   3.2.    Color codes in BitchX
  45.  
  46.   3.3.    ircII Windowing - hidden windows
  47.  
  48.   3.4.    ircII Windowing - multiple visible windows
  49.  
  50.   3.5.    BitchX Variables for scripters
  51.  
  52.   4.      Contacts
  53.  
  54.   4.1.    Authors
  55.  
  56.   4.2.    Credits
  57.   ______________________________________________________________________
  58.  
  59.   11..  GGeenneerraall
  60.  
  61.   11..11..  IInnttrroodduuccttiioonn
  62.  
  63.   This document was written as an aid to help new users to BitchX to get
  64.   started.  Parts of this document have been taken from the original faq
  65.   written by Xavier and IceBreak, credit goes where nesscessry.  If
  66.   anything is not covered in the FAQ you could try joining the BitchX
  67.   support channel on EFnet, #BitchX and asking for help.  You can also
  68.   try emailing the current author of this FAQ at chris@uk.logics.com.
  69.  
  70.   11..22..  WWhhaatt iiss BBiittcchhXX??
  71.  
  72.   BitchX is a VERY heavily modified ircII client.  It includes many
  73.   things such as built in CDCC (XDCC) offering, built in flood
  74.   protection, etc.  It is easier to script things in BitchX because
  75.   unlike plain, vanilla ircII, half the script does not have to be
  76.   devoted to changing the appearance of ircII.  It also includes many
  77.   other new features, such as port scanning, a CD player, a mail client,
  78.   etc.
  79.  
  80.   11..33..  WWhheerree ccaann II ggeett iitt??
  81.  
  82.   BitchX has lots of sites devoted to it, currently these are the ones
  83.   that currently serve it.  These sites are likely to go up and down due
  84.   to the vast ammounts of traffic they generate.
  85.  
  86.   +o  ftp://ftp.uk.logics.com/pub/irc/clients/BitchX/
  87.  
  88.   +o  ftp://of.the-b.org
  89.  
  90.   +o  ftp://ftp.bitchx.com
  91.  
  92.   +o  ftp://ftp.bitchx.org
  93.  
  94.   +o  ftp://squid.newwave.net/pub/irc/clients/
  95.  
  96.   The source file name is called ircii-pana-xx.tar.gz.  If the ftp or
  97.   www sites are not working, your best chance is to go to the irc and
  98.   join #BitchX on EFnet, and do /ctcp #bitchx cdcc list.
  99.  
  100.   11..44..  WWhhaatt aarree tthhee rreeqquuiirreemmeennttss ttoo rruunn BBiittcchhXX??
  101.  
  102.   You need about 1 megabyte of free space on a system with a UNIX OS.
  103.   Your terminal program should support ANSI if you want BitchX to show
  104.   color and high ascii to be displayed correctly.  Each copy of BitchX
  105.   loaded requires about 600-1000kb of memory.
  106.  
  107.   11..55..  WWhhaatt OOSS''eess hhaavvee bbeeeenn tteesstteedd ttoo wwoorrkk wwiitthh BBiittcchhXX??
  108.  
  109.   BitchX now works with almost all UNIX OS's and also Windows 32-bit.
  110.   This is the current list of OSes that BitchX has been reported working
  111.   on:
  112.  
  113.   +o  Linux (All)
  114.  
  115.   +o  FreeBSD (All)
  116.  
  117.   +o  BSDI 2.0/2.1/3.0/3.1
  118.  
  119.   +o  SunOS 4.1.4, 5.3, 5.4, 5.5, 5.5.1
  120.  
  121.   +o  HP-UX 9.x/10.x
  122.  
  123.   +o  OSF/1 (Dec Alpha)
  124.  
  125.   +o  DEC Unix
  126.  
  127.   +o  Ultrix
  128.  
  129.   +o  IRIX
  130.  
  131.   +o  AIX
  132.  
  133.   22..  GGeettttiinngg ssttaarrtteedd wwiitthh BBiittcchhXX
  134.  
  135.   22..11..  IInnssttaalllliinngg BBiittcchhXX wwiitthh tthhee ssoouurrccee ccooddee
  136.  
  137.   BitchX is fairly simple to install, if your OS is supported you will
  138.   need to do the following:
  139.  
  140.        % gunzip ircii-pana-xx.tar.gz
  141.        % tar xvf ircii-pana-xx.tar
  142.        % cd BitchX
  143.        % ./configure
  144.        % make
  145.        % make install (only as root to install globally)
  146.  
  147.   If the you have any problems in the compilation process of BitchX.  If
  148.   you gather as much information about the error (output from make) and
  149.   join the BitchX support channel on EFnet, #BitchX, or email the author
  150.   at the following edwac@sk.sympatico.ca.  Bug reports can be sent
  151.   exactly in the same way.  You might want to check the INSTALLATION
  152.   file included in the source code for any common compile problems that
  153.   have been reported.  This file also includes details of how to use TCL
  154.   and the more advanced features of BitchX.
  155.  
  156.   22..22..  CCoommppiilliinngg BBiittcchhXX wwiitthh ttccll ssuuppppoorrtt
  157.  
  158.   BitchX has full tcl support and is constantly being updated with more
  159.   features.  To compile BitchX with tcl support you will need to obtain
  160.   a binary file of tcl.o for your operating system.  You can always get
  161.   the latest copy of these from #BitchX on EFnet, or the ftp sites.  You
  162.   will need to place the binary in BitchX/source, then after running the
  163.   GNU configure script you can edit your ../Makefile and uncomment the
  164.   following lines:
  165.  
  166.   TCLINC = -I/usr/include
  167.   TCLLIB = -L/usr/lib -ltcl -lm
  168.   TCL = -DWANT_TCL
  169.   # TCL_SRCS = tcl.c
  170.   TCL_OBJS = tcl.o
  171.  
  172.   Now when you run GNU make, BitchX will be compiled with tcl support.
  173.   You can load a tcl file with /tcl -file /patch/file.tcl.  Tcl.c is not
  174.   included in the standard BitchX package, this file is only available
  175.   to the current BitchX developers who will make binaries available.
  176.  
  177.   22..33..  SSttaarrttiinngg BBiittcchhXX
  178.  
  179.   Starting BitchX is as simple as typing BitchX at a command prompt or
  180.   by clicking on a icon. BUT there are some options which you might want
  181.   to use.
  182.  
  183.   Usage: BitchX [switches] [nickname] [server list]
  184.     The [nickname] can be at most 9 characters long
  185.     The [server list] is a whitespace separate list of server name
  186.     The [switches] may be any or all of the following
  187.      -H <hostname>        uses the virtual hostname if possible
  188.      -c <channel> joins <channel> on startup
  189.      -b           load .bitchxrc  or .ircrc after connecting to a server
  190.      -p <port>    default server connection port (usually 6667)
  191.      -f           your terminal uses flow controls (^S/^Q), so BitchX shouldn't
  192.      -F           your terminal doesn't use flow control (default)
  193.      -d           runs BitchX in "dumb" terminal mode
  194.      -q           does not load ~/.ircrc
  195.      -r file      load file as list of servers
  196.      -n nickname  nickname to use
  197.      -a           adds default servers and command line servers to server list
  198.      -x           runs BitchX in "debug" mode
  199.      -v           tells you about the client's version
  200.      -B           force BitchX to fork and return you to shell
  201.      -l <file>    loads <file> in place of your .ircrc
  202.      -L <file>    loads <file> in place of your .ircrc and expands $ expandos
  203.  
  204.   22..44..  GGeettttiinngg ttoo ggrriippss wwiitthh tthhee bbaassiicc ccoommmmaannddss
  205.  
  206.   BitchX supports all of the standard commands that you will be used to
  207.   in most other unix clients such as ircii, epic, scrollz.  Below is a
  208.   list of common commands that will be probably used a lot.
  209.  
  210.   +o  /server +server.name.here will change server to that server.
  211.  
  212.   +o  /j #channel will join the channel.
  213.  
  214.   +o  /q nick in a window will make that window a dedicated query window
  215.      to nick.
  216.  
  217.   +o  /m nick/channel will send a private message to the nick/channel.
  218.  
  219.   +o  /m =nick will send a private message to nick that you are dcc
  220.      chatting.
  221.  
  222.   +o  /m -site will send a command to an open ftp session.
  223.  
  224.   +o  /ctcp nick/channel command sends a ctcp command.
  225.  
  226.   +o  /ignore nick ALL  ignores all messages from nick.
  227.  
  228.   +o  /tig nick unignores nick.
  229.  
  230.   22..55..  WWhhaatt aarree BBiittcchhXX..rreeaassoonnss//qquuiitt//hheellpp ??
  231.  
  232.   BitchX.reasons  - Random kick messages
  233.   BitchX.quit     - Random quit messages
  234.   BitchX.help     - Help file
  235.  
  236.   All these files should be copied to the  /.BitchX directory.
  237.  
  238.   22..66..  SSeettttiinngg vvaarriiaabblleess ((LLiikkee ii''mm ttoooo llaammee ttoo rreeaadd BBiittcchhXX..ddoocc))
  239.  
  240.   One of the most frequently asked questions is how do get I get rid of
  241.   * I'm too lame to read BitchX.doc * when I do a whois on myself.  Well
  242.   the answer to this is quite easy you need to set up some variables.
  243.   The following variables can be set:
  244.  
  245.           Variable        Value
  246.           IRCNICK         - "nickname" Sets the default nickname to use.
  247.           IRCNAME         - "username" Sets the default whois username, aka
  248.                             the * I'm too lame to read BitchX.doc *
  249.           IRC_HOST        - "hostname" Sets the virtual hostname, don't worry
  250.                             about this unless you need it.
  251.           IRCSERVER       - "server"   Sets the default server to use.
  252.           IRCPORT         - "port"     Sets the default port to use.
  253.           IRCUMODE        - "modes"    Sets the default usermode.
  254.           IRCRC           - "filename" Sets the filename to use in place of
  255.                              irc-rc
  256.  
  257.   To set up these variables will depend on the type of shell you use in
  258.   bash you would type:
  259.  
  260.        % export VARIABLE="value"
  261.  
  262.   In csh/tcsh the command you type would be:
  263.  
  264.        % setenv VARIABLE "value"
  265.  
  266.   If you do not use one of these shells, I surgest you type man
  267.   "yourshell" to find out how you set up a variables.
  268.  
  269.   22..77..  HHooww ddoo II uussee BBiittcchhXX wwiitthhiinn XXWWiinnddoowwss??
  270.  
  271.   First of all to make sure BitchX work properly in XWindows you will
  272.   need to obtain rxvt or Eterm and use a vga font like vga11x19.  If you
  273.   use rxvt you will need to start it with the options "-bg black -fg
  274.   white -fn vga11x19".  Its counterpart Eterm has a .Eterm/MAIN file
  275.   that you can set the colors and font in.  If the function keys don't
  276.   work, you may need to add this to the  /.bitchxrc file:
  277.  
  278.   /bind meta3-1 chelp
  279.   /bind meta3-2 CHANNEL_CHOPS
  280.   /bind meta3-3 CHANNEL_NONOPS
  281.   /bind meta3-4 CDCC_PLIST
  282.   /bind meta3-5 DCC_PLIST
  283.   /bind meta3-6 DCC_STATS
  284.  
  285.   22..88..  WWhhaatt iiss ..bbiittcchhxxrrcc//bbxxgglloobbaall aanndd ..iirrccrrcc??
  286.  
  287.   bitchxrc and ircrc are both variants of the same thing, a file loaded
  288.   up by BitchX automatically.  What are the differences?
  289.  
  290.           .ircrc - this is loaded by all ircII clients, only put stuff
  291.                   that will work with base ircII scripting here. Also,
  292.                   this is loaded upon connecting to a server.
  293.  
  294.           .bitchxrc - this is loaded as soon as BitchX starts. Put all
  295.                   BitchX-specific scripting commands here.
  296.  
  297.   bxglobal is simply more than a global .bitchxrc file.
  298.  
  299.   33..  CCoommmmaannddss
  300.  
  301.   33..11..  CCDDCCCC//XXDDCCCC
  302.  
  303.   BitchX offers built in support for public file offering called CDCC.
  304.   Most clients tend to use XDCC file offering, for this reason BitchX
  305.   will recognise any XDCC requests the same as CDCC requests. To use
  306.   CDCC, you can type /cdcc for all the commands available.
  307.  
  308.   33..22..  CCoolloorr ccooddeess iinn BBiittcchhXX
  309.  
  310.   %K - Dark Grey                  %k - Black
  311.   %G - Bold Green                 %g - Dark Green
  312.   %Y - Yellow                     %y - Brown
  313.   %C - Bold Cyan                  %c - Cyan
  314.   %B - Bold Blue                  %b - Blue
  315.   %P - Bold Purple                %p - Purple
  316.   %M - Bold Magenta               %m - Magenta
  317.   %R - Bold Red                   %r - Red
  318.  
  319.   %n - Null Color (will nullify colors before it)
  320.   %0 %1 %2 %3 %4 %5 %6 %7 %8 %9 - Background Colors
  321.   %F - Flashing Foreground
  322.   %U - Underline text
  323.  
  324.   Using these is as simple as /eval say $cparse("%RRed Text"), you can
  325.   also mix them like such /eval say $cparse("%RRed %BBlue").
  326.  
  327.   33..33..  iirrccIIII WWiinnddoowwiinngg -- hhiiddddeenn wwiinnddoowwss
  328.  
  329.   Ok to set the scene BitchX uses a number of windows, the first window
  330.   is referred to as (1).  So for example if you joined #BitchX, on
  331.   EFnet, then typed /window new hide you will not really notice
  332.   anything.  BitchX has created a new window for you, and that window,
  333.   hereafter  referred to as (2) is hidden.  To switch to it, press
  334.   ALT+2.  Its that simple.  You will notice that it only has one status
  335.   bar, but this can be corrected by excuting the following in window 2:
  336.  
  337.   /window double on
  338.   /window split on
  339.  
  340.   There are somewhat unlimited options with this type of windowing.  A
  341.   good example of using a window would be to open a query window, or
  342.   open another server connection.
  343.  
  344.   To kill a window you need to switch to it, then use /window kill
  345.  
  346.   33..44..  iirrccIIII WWiinnddoowwiinngg -- mmuullttiippllee vviissiibbllee wwiinnddoowwss
  347.  
  348.   The windowing commands, you can create as many windows as will fit on
  349.   your screen, and assign each to a channel, assign one to receive all
  350.   your /msg's.
  351.  
  352.   Here are the current windowing commands available (/help window)
  353.  
  354.   ADD           BACK          BALANCE       BEEP_ALWAYS   BIND
  355.   CHANNEL       CREATE        DELETE        DESCRIBE      DISCON
  356.   DOUBLE        ECHO          FIXED         GOTO          GROW
  357.   HELP          HIDE          HIDE_OTHERS   HOLD_MODE     KILL
  358.   KILL_OTHERS   KILLSWAP      LAST          LASTLOG       LASTLOG_LEVEL
  359.   LEVEL         LIST          LOG           LOGFILE       MOVE
  360.   NAME          NEW           NEXT          NOSERV        NOTIFY
  361.   NOTIFY_LEVEL  NUMBER        POP           PREVIOUS      PROMPT
  362.   PUSH          QUERY         REFNUM        REMOVE        SERVER
  363.   SET           SCRATCH       SCROLLBACK    SHOW          SHOW_ALL
  364.   SHRINK        SIZE          SKIP          SPLIT         STACK
  365.   SWAP          TRIPLE        UNBIND        UPDATE
  366.  
  367.   BitchX already has some of these binds built in (/bhelp window)
  368.  
  369.      [window shortcuts]:
  370.        ^W- - Shrinks current window 1 line
  371.        ^W+ - Grows current window 1 line
  372.        ^Wm - Moves current window down 1 line
  373.        ^Wl - Lists current windows
  374.        ^Wk - Kills current window
  375.        ^Wh - Hides current window
  376.        ^Wb - Balances window sizes
  377.        ^Wn - Swaps to next window
  378.        ^Wp - Swaps to previous window
  379.         /# - Shows window number (1-4)
  380.  
  381.   The best way to use these are to experiment with the keys.  One quick
  382.   tip to use multiple servers "/window server server.name.dom".
  383.  
  384.   33..55..  BBiittcchhXX VVaarriiaabblleess ffoorr ssccrriipptteerrss
  385.  
  386.   BitchX has a number of variables, these also include the standard
  387.   ircii scripting ones, along with the extended BitchX ones.
  388.  
  389.      $,         last person who sent you a MSG
  390.      $.         last person to whom you sent a MSG
  391.      $:         last person to join a channel you are on
  392.      $;         last person to send a public message to a channel you are on
  393.      $A         text of your AWAY message, if any
  394.      $B         body of last MSG you sent
  395.      $C         current channel
  396.      $D         last person that NOTIFY detected a signon for
  397.      $E         idle time
  398.      $F         time client was started, $time() format
  399.      $H         current server numeric being processed
  400.      $I         channel you were last INVITEd to
  401.      $J         client version text string
  402.      $K         current value of CMDCHARS
  403.      $L         current contents of the input line
  404.      $M         modes of current channel, if any
  405.      $N         current nickname
  406.      $O         value of STATUS_OPER if you are an irc operator
  407.      $P         if you are a channel operator in $C, expands to a '@'
  408.      $Q         nickname of whomever you are QUERYing
  409.      $R         version of current server
  410.      $S         current server name
  411.      $T         target of current input (channel or QUERY nickname)
  412.      $U         value of cutbuffer
  413.      $V         client release date (numeric version string)
  414.      $W         current working directory
  415.      $X         your user@host address
  416.      $Y         value of REALNAME
  417.      $Z         time of day (hh:mm)
  418.      $$         a literal '$'
  419.  
  420.   There are probably a lot more, but these should get you started.
  421.  
  422.   44..  CCoonnttaaccttss
  423.  
  424.   44..11..  AAuutthhoorrss
  425.  
  426.   FAQ Author:             Chris Bond <chris@uk.logics.com>
  427.   BitchX Author:          Colten Edwards <edwac@sk.sympatico.ca>
  428.  
  429.   44..22..  CCrreeddiittss
  430.  
  431.   Some credit has to go the orignal author of this document, I have
  432.   mearly updated and added extra information.
  433.  
  434.   panasync        <edwac@sk.sympatico.ca> <- kick ass client man
  435.   Xavier          <xavier@sedated.net> <- original FAQ
  436.   IceBreak        <ice_break@hotmail.com> <- original FAQ
  437.   sX              <scoop@unreal.org> <- just cos hes a cool guy
  438.   #BitchX EFnet   <- Cool place to idle on
  439.  
  440.