.\"  $HeadURL$ $LastChangedRevision$
.pso ircw-config --format=man
.TH IRCW 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.ne 5
.SH NAME
ircw \- IRC client wrapper
.br
.ne 5
.SH SYNOPSIS
.B ircw
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel
] [
.B \-h
|
.B \-\-help
] 
[
.B \-p
|
.B \-\-list\-paths
] 
[
.B \-f
.I file
|
.B \-\-file=\fIfile
] 
[
.B \-l
|
.B \-\-list
] 
[
.B \-n
|
.B \-\-simulate
] 
.br
.ne 5
.SH DESCRIPTION
.B Ircw
is a wrapper for an environment-specified IRC client program.
It ensures that the complete standard environment for IRC clients
is setup. 
.PP
It also provides some log file management.
.PP
It also maintains the notion of IRC networks, rather than IRC
servers. These are specified via a configuration file.
.ne 5
.SH CONFIGURATION
Several environment variables must be set up in order to use
.B ircw\fR,
or, for that matter, to use an IRC client program. However,
.B ircw
gives extensive help when these are not set, so the best way
to configure it is simply to repeatedly try to run it setting
the environment variables it suggests after each failed invocation.
.br
.ne 5
.SH OPTIONS
.TP 25
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B ircw
will be. The message types displayed for the different values of 
.I level
are as follows:
.RS 25
.TP 5
.B 0
internal errors only
.TP
.B 1
internal errors and normal errors 
.TP
.B 2
internal errors, normal errors and warnings
.TP 
.B 3
internal errors, normal errors, warnings and informational messages
.TP 
.B >3
all the above plus application-specific debug messages.
.RE
.TP 25
.B \-f\fR, \fB\-\-file=\fIfile
Information about IRC networks will be loaded from 
.I file
instead of the default.
.TP
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.TP
.B \-l\fR, \fB\-\-list
List the contents of the IRC networks configuration file.
.TP
.B \-n\fR, \fB\-\-simulate
Do not start the IRC client, just show what would be done.
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B ircw
uses.
.TP 
.B \-v\fR, \fB\-\-verbose
Equivalent to
.B \-d 3\fR.
.TP
.B \-V\fR, \fB\-\-version
Print the program's version number and exit.
.br
.ne 5
.SH EXIT STATUS
On success
.B ircw
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
.TP 25
.B \*[ircw_etc_prefix]/ircnetworks
default configuration file specifying IRC networks
.br
.ne 5
.SH ENVIRONMENT VARIABLES
.TP 25
.B IRCSCRIPTS
This is a space-separated list of scripts you wish the client to load.
.TP
.B IRCSERVER
The name of an IRC network or an individual server
.TP
.B IRCLOGDIR
Directory to which logs should be written
.TP
.B IRCCMD
The command to invoke the IRC client
.TP
.B IRCUMODE
Desired 'umode'
.TP
.B IRCNICK
Your IRC nickname
.TP
.B IRCNAME
You real or not-so-real name
.br
.ne 5
.SH EXAMPLES
The following command generates a FAD database to standard output for the 
entire system:
.IP
.nf
.fam C
.B export IRCSCRIPTS=/dev/null
.B export IRCLOGDIR=/tmp
.B export IRCSERVER=dalnet
.B export IRCCMD=bitchx
.B export IRCUMODE='+iw-s'
.B export IRCNAME='Mr B. Blob'
.B export IRCNICK=MrBlob
.B ircw
.fam T
.fi
.br
.ne 5
.SH CAVEATS
None.
.br
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B ircw\fR.
.br
.ne 5
.SH SEE ALSO
None.
.br
.ne 5
.SH AUTHOR
ADE_APP_TOKEN_AUTHOR_NAME <ADE_APP_TOKEN_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 1994-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.