plan9fox/sys/man/1/ircrc
2012-10-12 09:17:47 -05:00

174 lines
2.2 KiB
Plaintext

.TH IRCRC 1
.SH NAME
ircrc \- internet relay chat client
.SH SYNOPSIS
.B ircrc
[
.B -p
.I port
]
[
.B -r
.I realname
]
[
.B -t
.I target
]
[
.B -n
.I nick
]
[
.I server
]
.SH DESCRIPTION
.I Ircrc
is an IRC client.
Messages are sent from stdin and received from stdout.
The default server is
.BR irc.freenode.net .
.I Ircrc
expands
.B bitlbee
and
.B oftc
to
.B im.bitlbee.org
and
.BR irc.oftc.net ,
respectively.
The options are:
.TP
.BI -p " port
Change the default port
.RB ( 6667 ).
.TP
.BI -r " realname
Change the default name
.RB ( <nil> ).
.TP
.BI -t " target
Set and join the target channel
(multiple channels may be separated by commas).
.TP
.BI -n " nick
Change the default nickname
.RB ( $user ).
.SS Commands
.I Ircrc
understands the following commands:
.TP
.BI /! " cmd
Send the output of the shell command
.I cmd
to the current target.
.TP
.B /M
.B MODE
command.
.TP
.B /N
.B NOTICE
command.
.TP
.B /T
.B TOPIC
command.
.TP
.B /W
.B WHOIS
command.
.TP
.B /a
.B AWAY
command.
.TP
.B /j
.B JOIN
command.
.TP
.B /l
.B LIST
command.
.TP
.B /m
.B PRIVMSG
command.
.TP
.B /n
.B NICK
command.
.TP
.B /p
.B PART
command.
.TP
.BI /q " cmd
Send the raw IRC command
.I cmd
to the server.
.TP
.BI /t " target
Set the current target.
Messages are sent to
.I target
unless they are commands.
If the current target is more than one channel,
any messages are sent to all of them.
.TP
.B /u
.B USERS
command.
.TP
.B /w
.B WHO
command.
.TP
.B /x
.B QUIT
command.
.PP
Anything else is sent as a message to the current target.
See RFC 1459 and RFC 2812 for detailed information about
IRC commands.
.SH EXAMPLES
Default usage:
.IP
.EX
% ircrc
.EE
.PP
Join
.B irc.oftc.net
as a different user:
.IP
.EX
% ircrc -r glenda -n glenda irc.oftc.net
.EE
.PP
Join two channels on login
(remember to set the target to a single channel,
otherwise messages are sent to both):
.IP
.EX
% ircrc -t '#cat-v,#plan9'
.EE
.SH SOURCE
.B /rc/bin/ircrc
.SH SEE ALSO
.B http://tools.ietf.org/html/rfc1459
.br
.B http://tools.ietf.org/html/rfc2812
.SH BUGS
.PP
.I Ircrc
calls the inexistent
.IR auth/userpasswd .
.PP
Some of
.BR irc.freenode.net 's
welcome messages contain control characters.
.PP
Some fonts do not support the nickname delimiters.