packages icon



 BitchX(1)                                                         BitchX(1)
                               March 22, 2001



 NAME
      BitchX - The Ultimate IRC Client

 SYPNOSIS
      BitchX [-aAbBcdfFHilLnNpPqrvxZ]

 DESCRIPTION
      BitchX is a VERY heavily modified ircII client.  It includes many
      things such as built in CDCC (XDCC) offering, built in flood
      protection, etc.  It is easier to script things in BitchX because
      unlike plain, vanilla ircII, half the script does not have to be
      devoted to changing the appearance of ircII.  It also includes many
      other new features, such as port scanning, advanced TCL, a CD player,
      a mail client, screening process, etc.

      BitchX - Based on EPIC Software Labs epic ircII (1998). Version
      (BitchX-1.0c18) -- Date (20010108).


 OPTIONS
      -a   Adds default servers and command line servers to server list.

      -A   Do not display the startup ansi.

      -b   Load .bitchxrc or .ircrc after connecting to a server.

      -B   Force BitchX to fork and return you to a shell. pid check on.

      -c <channel>
           Joins <channel> on startup.

      -d   Runs BitchX in "dumb" terminal mode.

      -f   Your terminal uses flow controls (^S/^Q), so BitchX shouldn't.

      -F   Your terminal doesn't use flow control (default).

      -H <hostname>
           Uses the virtual hostname if possible.

      -i   Ignores your autojoin entries.

      -l <file>
           Loads <file> in place of your .ircrc.

      -L <file>
           Loads <file> in place of your .ircrc and expands $expandos

      -n <nickname>
           Nickname to use




                                    - 1 -           Formatted:  July 1, 2022






 BitchX(1)                                                         BitchX(1)
                               March 22, 2001



      -N   Do not auto-connect to the next server.

      -p <port>
           Default server connection port (usually 6667).

      -P   Toggle check pid.nickname for running program.

      -q   Does not load .ircrc or .bitchxrc.

      -r <file>
           Load <file> as list of servers.

      -v   Tells you about the clients version.

      -x   Run BitchX in "debug" mode.

      -Z   Use NAT address when doing dcc.


 ENVIRONMENT
      BitchX
           uses many environment variables to configure the client.  These
           can be set by editing your ~/.profile or ~/.bash_login (if you're
           using a /bin/bash shell) and adding ``export VARNAME="var
           value"''.  Or, if you are using the tcsh shell you can set these
           by editing ~/.tcshrc and adding ``setenv VARNAME "var value"''.
           Below is a list of variables.

      IRCNICK
           sets the default IRC nickname. eg, export IRCNICK="mynick"

      USER sets the default username to use.  If not set, it uses a default
           value of "unknown" - This will only work under NON-UNIX operating
           systems.

      IRCUSER
           same as USER

      IRCHOST
           sets the virtual hostname to use.

      IRC_HOST
           same as IRCHOST

      IRCNAME
           sets the name that appears in the "realname" field on your
           /whois.  The default value is "* I'm to lame to read BitchX.doc
           *".

      IRCSERVER
           sets the default IRC server to use.



                                    - 2 -           Formatted:  July 1, 2022






 BitchX(1)                                                         BitchX(1)
                               March 22, 2001



      IRCPORT
           sets the default IRC port to use.  Usually 6667.

      IRCPATH
           sets the path from which files are loaded.  Default is ~/.BitchX/

      IRCUMODE
           sets your default usermode.  Default is "+iw"

      IRCRC
           sets the filename to be used in place of ~/.bitchxrc or ~/.ircrc

      IRCLIB
           sets the BitchX library path (Used for some small example
           scripts).

      IRC_SERVERS_FILE
           sets the name of the IRC server list that is loaded before any
           other lists.

      IRCFINGER
           sets your CTCP FINGER information.

 FILES
      ~/.bitchxrc
           Loaded by BitchX when it is started.

      ~/.ircrc
           If ~/.bitchxrc is not there, this file is loaded on startup
           instead.

      ~/.ircservers
           Contains a list of IRC servers to cycle through.

      /usr/local/lib/bx/
           System-wide configuration dir.

      ~/.BitchX/BitchX.sav
           Personal configuration file.

      ~/.BitchX/BitchX.ircnames
           Default random real name.  NOTE: Must be copied from
           /usr/local/lib/bx/

      ~/.BitchX/BitchX.formats
           Personal BitchX display formats.

      ~/.BitchX/BitchX.reasons
           Default random kick messages.  NOTE: Must be copied from
           /usr/local/lib/bx/




                                    - 3 -           Formatted:  July 1, 2022






 BitchX(1)                                                         BitchX(1)
                               March 22, 2001



      ~/.BitchX/BitchX.quit
           Default random quit messages.  NOTE: Must be copied from
           /usr/local/lib/bx/

      /usr/local/lib/bx/BitchX.help
           BitchX help file.

      ~/.BitchX/screens
           Screen storage for a detached BitchX session.

 OBTAINING
      You can always download the newest version of BitchX by joining
      #BitchX on EFNet and typing "/offers" in the channel window.  To check
      what the latest version is type "!explain latest" and the bot will
      tell you.  You can also ftp to ftp.BitchX.com to get the latest
      client, scripts, tcl objects, documentation, and many other useful
      items.  You can also point your browser to http://www.BitchX.com for
      some more things.

 BUGS
      Please report all bugs to an op on #BitchX on EFNet, e-mail panasync
      or send an e-mail to the mailing list.


 MAILING LIST
      There is a BitchX mailing list, to subscribe simply send an e-mail to:
      majordomo@lists.BitchX.com with only the words "subscribe BitchX" in
      the body.  You will receive another mail to confirm this and once you
      have replied you can post to the list by sending e-mail to
      bitchx@lists.BitchX.com. This is a helpful place for bug reports


 MAN PAGE MAINTAINER
      dialtone <dialtone@chemlab.org>


 BitchX Author
      Colten Edwards <edwards@bitchx.dimension6.com>

      panasync


 Responsible for ports to other OS's
      Brian Smith <dbsoft@technologist.com>

      nuke








                                    - 4 -           Formatted:  July 1, 2022