.\"	$eterna: ircII.1,v 1.20 2005/01/01 11:25:09 mrg Exp $
.TH IRCII 1 "31 October 2002"
.SH NAME
ircII \- interface to the Internet Relay Chat system
.SH SYNOPSIS
.B irc
.RB [ \-c
.IR chan ]
.RB [ \-p
.IR portno ]
.RB [ \-P
.IR portno ]
.RB [ \-b ]
.RB [ \-f ]
.RB [ \-F ]
.RB [ \-s ]
.RB [ \-S ]
.RB [ \-t ]
.RB [ \-T ]
.RB [ \-d ] 
.IR [ nickname
.IR [ "server list" ]]
.RB [ \-a ]
.RB [ \-v ]
.RB [ \-q ]
.RB [ \-h
.IR "hostname"
.RB ]
.RB [ \-icb ]
.RB [ \-irc ]
.SH DESCRIPTION
The
.I ircII
program is a full screen, termcap based interface to Internet Relay Chat.
It gives full access to all of the normal
.I IRC
functions, plus a variety of additional options.
.SH OPTIONS
.TP
.BI \-c " chan"
Automatically join channel
.IR chan .
.TP
.BI \-p " portno"
Set the IRC port number to
.I portno
(default: 6667, the standard
.I IRC
port).
Only supply this if you connect to a server which uses a port other than 6667.
.TP
.BI \-P " portno"
Set the ICB port number to
.I portno
(default: 7326, the standard ICB port).
.TP
.B \-b
Load the .ircrc file before connection to a server, not afterwards.
.TP
.B \-f
Use flow control (^S and ^Q) to stop/start the display.
Normally these are both bound to other functions within
.IR irc .
This switch is ignored if the
.B \ -d
switch is used.
.TP
.B \-F
Don't use flow control (^S and ^Q) to stop start the display.
This switch is ignored if the
.B \ -d
switch is used.
.TP
.B \-s
Don't start up the ircio process to connect to the
.I IRC
server (default).
.TP
.B \-S
Start up the ircio process to connect to the
.I IRC
server.
.TP
.B \-t
Don't use the termcap
.I ti
and
.I te
sequences when starting and exiting (default).
.TP
.B \-T
Do use the termcap
.I ti
and
.I te
sequences when starting and exiting if they exist.
.TP
.B \-d
Start in "dumb" mode.
All input is taken directly from stdin and all output goes to stdout
without using any of the
.IR termcap (5)
screen control codes.
.TP
.I nickname
Set the nickname
(overrides the environment variable
.BR IRCNICK ;
default: the username).
.TP
.I server
Set the list of servers with which
.B irc
will try to connect upon startup.
This list is also used by the program's
.B /server
command.
The format for lines in the list is:
.IP
.B hostname
.RB [:portno[:password[:nick]]]
for IRC connections.
For ICB connections, the format is:
.IP
.B ICB/hostname
.RB [:portno[::nick[:group[:mode]]]]
with
.RB group
being the initial group and
.RB mode
being the initial group mode.
See /HELP ICB for more information
about ICB.
.IP
If the
.B hostname
is in the format
.RB :servergroup:host.com
then
.B servergroup
is taken to be the Server Group for this server entry.
.TP
.BI \-a
This adds the normal
.B irc
server list to the command line list of
.B irc
servers.
.TP
.BI \-v
Print the version and release date of
.I ircII
and exit.
.TP
.BI \-q
Start up
.B irc
quickly -- don't load the IRCRC file.
.TP
.BI \-h " hostname"
This option instructs
.B ircII
to use the given
.I hostname
as the local address.  Useful only on
multi-homed hosts.
.TP
.BI \-icb
Use ICB connections by default.
.TP
.BI \-irc
Use IRC connections by default.
.SH "DETAILED DESCRIPTION"
.SS "The Screen:"
The
screen is split into two parts, separated by an inverse-video
status line (if supported).
The upper (larger) part of the screen displays responses from the
.I IRC
server.
The lower part of the screen (a single line) accepts keyboard input.
.LP
Some terminals do not support certain features required by
.IR ircII ,
in which case you receive a message stating this.
If this occurs, try changing the terminal type or run
.I ircII
with the
.B -d
option.
.SS "Irc Commands:"
Any line beginning with the slash character '/' is regarded as an
.I ircII
command (the command character may be changed; type '/help set cmdchar').
Any line not beginning with this character is treated as a message to
be sent to the current channel.
To produce a listing of commands, type '/help ?'.
To receive information about the commands type '/help
.B <command> '.
.SS "The .ircrc File:"
When
.I ircII
is executed, it checks the user's home directory for a
.I \&.ircrc
file, executing the commands in the file.
Commands in this file do not
need to have a leading slash character '/'.
This allows predefinition of aliases and other features.
.SH EXAMPLES
.TP
.B "irc -c #users -p 5555"
Connect
.I IRC
to port number 5555 of the default host and enter on channel #users.
.TP
.B "irc Mermaid"
Use the nickname "Mermaid".
.TP
.B "irc Mermaid server1:5000 server2::passwd server3"
Use the nickname "Mermaid" and the modified server list.
.TP
.B "irc piglet3 :ln:irc1.lamenet.org :ln:irc1.lamenet.org"
Use the nickname "piglet3", initially connecting to irc.au.lamenet.org,
with also irc.us.lamenet.org added to the server list, both having a
server group name "ln".
.TP
.B "irc oink ICB/www.icb.net"
Use the nick "oink" making an ICB connection to www.icb.net.
.TP
.B "irc -d"
Use dumb mode.
.TP
.B "irc -f"
Allow use of ^S/^Q to stop/start screen display.
.TP
.B "irc -e elisa"
Interface
.I IRC
with a program called
.IR elisa .
.LP
.B "setenv IRCNICK Mermaid"
.br
.B "setenv IRCNAME ""The one and only :)"""
.TP
.B irc
Set the username (if not specified elsewhere) to "Mermaid".
The user's name (when provided inside parentheses in response to a
WHOIS command) is set to "The one and only :)".
.SH FILES
.TP 2.2i
.I /usr/bin/ircII
the executable program
.TP
~/.ircrc
default initialization file
.TP
~/.irc/
directory you can put your own
.I ircII
scripts into, that can then be loaded with /load
.TP
.I /etc/irc/
directory containing message-of-the-day, master initialization, help files and 
.I ircII
scripts
.I /etc/irc/script/local
is the master initialization file for the site, loaded before .ircrc is.
This is a Debian GNU/Linux conffile.
.TP
.I /usr/share/ircII/
shared repository for help, translation tables and distributed scripts.
.SH "THE HELP FILES"
All of the
.B ircII
commands are fully described in the help files package.
The best way to start here is with the
.IR /HELP\ ?
command as this prints a listing of all available help files.
.SH "SIGNALS"
.I ircII
handles the following signals
.TP
.B SIGUSR1
Closes all
.I DCC
connections and
.I EXEC'ed
processes.
.TP
.B SIGUSR2
Drops
.I ircII
back to the command line.
.SH "ENVIRONMENT VARIABLES"
It can be helpful to predefine certain variables in
in the
.IR \&.cshrc ,
.IR \&.profile ,
or
.IR \&.login
file:
.TP
.B IRCNICK
The user's
.I IRC
nickname.
.TP
.B IRCNAME
The user's
.I IRC
realname (otherwise retreived from
.IR /etc/passwd )
.TP
.B IRCSERVER
The default
.I IRC
server(s) (see server
.B option
for details)
.TP
.B IRCSERVERSFILE
The file containing the default list of server(s), usually
PREFIX/lib/irc/ircII.servers.  This file should contain one server
entry per line.
.TP
.B HOME   
Overrides the default home path in
.IR /etc/passwd .
.TP
.B TERM   
The type of terminal in use.
.fi
.SH "FILES"
.I ircII
uses the following files under the library directory, usually PREFIX/share/irc.
.TP
.B ircII.servers
The initial list of servers if none are provided on the command line.
.TP
.B ircII.motd
Message of the day.
This file is displayed only once each time it is changed.
.SH "SEE ALSO"
ircd(8)
.SH BUGS
Please notify the current developer of the software of any bugs in
current versions.
.SH AUTHORS
Program written by Michael Sandrof (ms5n+@andrew.cmu.edu).
Now being maintained by Matthew Green (mrg@eterna.com.au). Debian specific
extensions by the Debian Maintainer Bernd Eckenfels (ecki@debian.org).
Names of contributors and contact address can be retrieved with the
.B /info command.
This manual page written by Darren Reed (avalon@coombs.anu.EDU.AU),
revised by R. P. C. Rodgers (rodgers@maxwell.mmwb.ucsf.edu),
by the lynX, and by Matthew Green (mrg@eterna.com.au).
.\" end of man page