.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "JIRC 1p"
.TH JIRC 1p "2009-10-26" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
jirc \- Bridges an IRC channel to a Jabber conference room.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
jirc [\s-1OPTIONS\s0] \-\-config \s-1CONFIG\s0
.PP
.Vb 3
\& \-C, \-\-config CONFIG  Load config file as specified by CONFIG
\& \-V, \-\-version        Report version of script
\& \-h, \-\-help           Show detailed documentation.
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-C \s-1CONFIG\s0\fR, \fB\-\-config \s-1CONFIG\s0\fR" 8
.IX Item "-C CONFIG, --config CONFIG"
Specify the configuration file to load.  Required.
.IP "\fB\-V\fR, \fB\-\-version\fR" 8
.IX Item "-V, --version"
Report the version of this script.
.IP "\fB\-h\fR,\fB\-\-help\fR" 8
.IX Item "-h,--help"
Show detailed documentation.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The jirc bot logs into an \s-1IRC\s0 channel and a Jabber conference room.  It will
relay conversations between the two rooms, identifying each of the speakers
in braces ([]).  Actions are forwarded as well.
.PP
There are some in-room commands that jirc responds to:
.PP
.Vb 3
\& !help       Display summary of available jirc commands.
\& !who        Display a list of people online on the other end of the bridge.
\& !shutdown   Immediately quit the rooms and shutdown.
.Ve
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
The file specified with the \fB\-\-config\fR option contains field/value pairs,
one per line:
.PP
.Vb 1
\& field: value
.Ve
.PP
For example:
.PP
.Vb 1
\& mode: production
.Ve
.PP
The required configuration fields are:
.IP "\fBmode\fR" 8
.IX Item "mode"
Can be either \*(L"production\*(R" or \*(L"test\*(R".  When running in \*(L"test\*(R" mode, the
nicks and channel names all have \*(L"\-test\*(R" appended to them so that jirc
behavior can be tested in separate channel.
.IP "\fBirc-nick\fR" 8
.IX Item "irc-nick"
The \s-1IRC\s0 nickname to sign in with.  Since this is a bridge, a short nick is
recommended.  To avoid confusion, it should match the \fBjabber-alias\fR.
.IP "\fBirc-username\fR" 8
.IX Item "irc-username"
The \s-1IDENT\s0 username to sign in with.  Since this is a bridge, a short name is
recommended.  To avoid confusion, it should match the \fBirc-nick\fR.
.IP "\fBirc-ircname\fR" 8
.IX Item "irc-ircname"
The \s-1IRC\s0 Username to sign in with.  Since this is a bridge, a description
of the bridge and a contact email address is recommended.
.IP "\fBirc-chan\fR" 8
.IX Item "irc-chan"
The \s-1IRC\s0 channel to join; the \s-1IRC\s0 side of the bridge.
.IP "\fBirc-server\fR" 8
.IX Item "irc-server"
The \s-1IRC\s0 server to join.
.IP "\fBjabber-protocol\fR" 8
.IX Item "jabber-protocol"
The Jabber protocol to use, either \*(L"\s-1XMPP\s0\*(R" or \*(L"Legacy\*(R".
.IP "\fBjabber-id\fR" 8
.IX Item "jabber-id"
The Jabber identifier, in the form: NAME@SERVER/RESOURCE
.IP "\fBjabber-server-ip\fR" 8
.IX Item "jabber-server-ip"
Not all Jabber servers run on the same \s-1IP\s0 as the A record
for their domain indicates. If your server runs like this,
set the correct \s-1IP\s0 or hostname here. Note that jirc doesn't
currently pay attention to \s-1SRV\s0 records.
.IP "\fBjabber-password\fR" 8
.IX Item "jabber-password"
The password for the Jabber \s-1ID\s0.
.IP "\fBjabber-plaintext\fR" 8
.IX Item "jabber-plaintext"
Set to \*(L"1\*(R" to allow the password to be sent over the wire in plaintext
or not \- you'll need this for some servers that don't support
\&\s-1DIGEST\-MD5\s0 with legacy authentication.  (Default: 0)
.IP "\fBjabber-reconnect-delay\fR" 8
.IX Item "jabber-reconnect-delay"
How long to wait in seconds between disconnects before attempting a
reconnect.  (Default: 0)
.IP "\fBjabber-port\fR" 8
.IX Item "jabber-port"
The port to use for Jabber connections.  This is normally 5222.
.IP "\fBjabber-conference\fR" 8
.IX Item "jabber-conference"
The name of the Jabber conference room to join, in the form ROOM@SERVER
.IP "\fBjabber-alias\fR" 8
.IX Item "jabber-alias"
The Jabber alias to use when joining the Jabber conference room.  Since
this is a bridge, a short nick is recommend.  To avoid confusion, it should
match the \fBirc-nick\fR.
.IP "\fBjabber-admin\fR" 8
.IX Item "jabber-admin"
The email address of this bot's owner.
.IP "\fBprefix\fR" 8
.IX Item "prefix"
The prefix used for the built-in in-room commands.  This is normally \*(L"!\*(R".
.IP "\fBquiet-status\fR" 8
.IX Item "quiet-status"
Suppress bridging of status messages (joins, parts and presence changes). 
Normally 0.
.IP "\fBirc-port\fR" 8
.IX Item "irc-port"
The port to use for \s-1IRC\s0 connections.  This is normally 6667.
.IP "\fBirc-reconnect\fR" 8
.IX Item "irc-reconnect"
How many seconds to wait until reconnecting after a missed \s-1IRC\s0 \*(L"\s-1TIME\s0\*(R" response.
This is normally 60.
.IP "\fBirc-time-delay\fR" 8
.IX Item "irc-time-delay"
How many seconds between \*(L"\s-1TIME\s0\*(R" requests.  This is normally 30.
.IP "\fBirc-debug\fR" 8
.IX Item "irc-debug"
When set to 1, this enables verbose debugging of the \s-1IRC\s0 side of communications.
This is normally 0.
.IP "\fBjabber-debug\fR" 8
.IX Item "jabber-debug"
When set to 1, this enables verbose debugging of the Jabber side of
communications.  This is normally 0.
.IP "\fBdebug\fR" 8
.IX Item "debug"
When set to 1, this enable verbose debugging of the general operation of the
jirc bridge.  This is normally 0.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kees Cook <kees@outflux.net>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2005\-2009 by Kees Cook <kees@outflux.net>.
This program is licensed under the terms of the \s-1GNU\s0 General Public License.