1BitchX(1)                                                            BitchX(1)
2
3
4

NAME

6       BitchX - The Ultimate IRC Client
7

SYPNOSIS

9       BitchX [-aAbBcdfFHilLnNpPqrvxZ]
10

DESCRIPTION

12       BitchX  is  a  VERY  heavily  modified  ircII client.  It includes many
13       things such as built in CDCC (XDCC) offering, built  in  flood  protec‐
14       tion,  etc.   It  is  easier  to script things in BitchX because unlike
15       plain, vanilla ircII, half the script does not have to  be  devoted  to
16       changing the appearance of ircII.  It also includes many other new fea‐
17       tures, such as port scanning, advanced TCL, a CD player, a mail client,
18       screening process, etc.
19
20       BitchX  -  Based  on  EPIC  Software  Labs  epic ircII (1998).  Version
21       (BitchX-1.0c18) -- Date (20010108).
22
23

OPTIONS

25       -a     Adds default servers and command line servers to server list.
26
27       -A     Do not display the startup ansi.
28
29       -b     Load .bitchxrc or .ircrc after connecting to a server.
30
31       -B     Force BitchX to fork and return you to a shell. pid check on.
32
33       -c <channel>
34              Joins <channel> on startup.
35
36       -d     Runs BitchX in "dumb" terminal mode.
37
38       -f     Your terminal uses flow controls (^S/^Q), so BitchX shouldn't.
39
40       -F     Your terminal doesn't use flow control (default).
41
42       -H <hostname>
43              Uses the virtual hostname if possible.
44
45       -i     Ignores your autojoin entries.
46
47       -l <file>
48              Loads <file> in place of your .ircrc.
49
50       -L <file>
51              Loads <file> in place of your .ircrc and expands $expandos
52
53       -n <nickname>
54              Nickname to use
55
56       -N     Do not auto-connect to the next server.
57
58       -p <port>
59              Default server connection port (usually 6667).
60
61       -P     Toggle check pid.nickname for running program.
62
63       -q     Does not load .ircrc or .bitchxrc.
64
65       -r <file>
66              Load <file> as list of servers.
67
68       -v     Tells you about the clients version.
69
70       -x     Run BitchX in "debug" mode.
71
72       -Z     Use NAT address when doing dcc.
73
74

ENVIRONMENT

76       BitchX uses many environment variables to configure the client.   These
77              can  be  set  by  editing  your  ~/.profile or ~/.bash_login (if
78              you're using a /bin/bash shell) and adding ``export VARNAME="var
79              value"''.  Or, if you are using the tcsh shell you can set these
80              by editing ~/.tcshrc and adding ``setenv VARNAME "var  value"''.
81              Below is a list of variables.
82
83       IRCNICK
84              sets the default IRC nickname. eg, export IRCNICK="mynick"
85
86       USER   sets the default username to use.  If not set, it uses a default
87              value of "unknown" - This will only work under NON-UNIX  operat‐
88              ing systems.
89
90       IRCUSER
91              same as USER
92
93       IRCHOST
94              sets the virtual hostname to use.
95
96       IRC_HOST
97              same as IRCHOST
98
99       IRCNAME
100              sets  the  name  that  appears  in  the "realname" field on your
101              /whois.  The default value is "* I'm to lame to read  BitchX.doc
102              *".
103
104       IRCSERVER
105              sets the default IRC server to use.
106
107       IRCPORT
108              sets the default IRC port to use.  Usually 6667.
109
110       IRCPATH
111              sets   the  path  from  which  files  are  loaded.   Default  is
112              ~/.BitchX/
113
114       IRCUMODE
115              sets your default usermode.  Default is "+iw"
116
117       IRCRC  sets the filename to be used in place of ~/.bitchxrc or ~/.ircrc
118
119       IRCLIB sets the BitchX  library  path  (Used  for  some  small  example
120              scripts).
121
122       IRC_SERVERS_FILE
123              sets  the  name of the IRC server list that is loaded before any
124              other lists.
125
126       IRCFINGER
127              sets your CTCP FINGER information.
128

FILES

130       ~/.bitchxrc
131              Loaded by BitchX when it is started.
132
133       ~/.ircrc
134              If ~/.bitchxrc is not there, this  file  is  loaded  on  startup
135              instead.
136
137       ~/.ircservers
138              Contains a list of IRC servers to cycle through.
139
140       /usr/local/lib/bx/
141              System-wide configuration dir.
142
143       ~/.BitchX/BitchX.sav
144              Personal configuration file.
145
146       ~/.BitchX/BitchX.ircnames
147              Default   random   real   name.    NOTE:  Must  be  copied  from
148              /usr/local/lib/bx/
149
150       ~/.BitchX/BitchX.formats
151              Personal BitchX display formats.
152
153       ~/.BitchX/BitchX.reasons
154              Default  random  kick  messages.   NOTE:  Must  be  copied  from
155              /usr/local/lib/bx/
156
157       ~/.BitchX/BitchX.quit
158              Default  random  quit  messages.   NOTE:  Must  be  copied  from
159              /usr/local/lib/bx/
160
161       /usr/local/lib/bx/BitchX.help
162              BitchX help file.
163
164       ~/.BitchX/screens
165              Screen storage for a detached BitchX session.
166

OBTAINING

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

BUGS

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

MAILING LIST

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

MAN PAGE ORIGINAL AUTHOR

189       Wichert Akkerman <wakkerma@debian.org>
190
191

MAINTAINER

193       Robert Durdle - Dragoon@EFNet <robert@durdle.com>
194
195       dialtone <dialtone@chemlab.org>
196
197

BitchX Author

199       Colten Edwards <edwards@bitchx.dimension6.com>
200
201       panasync
202
203

Responsible for ports to other OS's

205       Brian Smith <dbsoft@technologist.com>
206
207       nuke
208
209
210
211
212                                March 22, 2001                       BitchX(1)
Impressum