plan9fox/sys/man/1/ircrc

190 lines
2.3 KiB
Plaintext
Raw Normal View History

2012-10-11 16:31:40 +00:00
.TH IRCRC 1
.SH NAME
ircrc \- internet relay chat client
.SH SYNOPSIS
.B ircrc
[
.B -p
.I port
]
[
.B -P
.I server password
]
[
2012-10-11 16:31:40 +00:00
.B -r
.I realname
]
[
.B -t
.I target
]
[
.B -n
.I nick
]
[
.B -T
] [
2012-10-11 16:31:40 +00:00
.I server
]
.SH DESCRIPTION
.I Ircrc
is an IRC client.
Messages are sent from standard input and
received from standard output.
2012-10-11 16:31:40 +00:00
The default server is
2021-06-15 14:28:00 +00:00
.BR irc.oftc.net .
The arguments
2012-10-12 14:17:47 +00:00
.B bitlbee
and
.B oftc
are expanded to
2012-10-12 14:17:47 +00:00
.B im.bitlbee.org
and
.BR irc.oftc.net ,
respectively.
2012-10-11 16:31:40 +00:00
The options are:
.TP
.BI -p " port
Change the default port
.RB ( 6667 ).
.TP
.BI -P " server password
Specify a password for the remote server.
.TP
2012-10-11 16:31:40 +00:00
.BI -r " realname
Change the default name
.RB ( <nil> ).
.TP
.BI -t " target
Set and join the target channel.
If multiple channels are specified,
only the last one will be set as
.IR target .
Messages are sent to
.I target
unless they are commands.
2012-10-11 16:31:40 +00:00
.TP
.BI -n " nick
Change the default nickname
.RB ( $user ).
.TP
.BI -T
.br
Use tls through
2015-01-29 12:17:34 +00:00
.IR tlssrv (8).
2012-10-11 16:31:40 +00:00
.SS Commands
.I Ircrc
commands begin with a slash.
Unrecognized commands result in an error message
and send nothing to the server.
The commands are:
2012-10-11 16:31:40 +00:00
.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
.IR target .
If
2012-10-11 16:31:40 +00:00
.I target
is more than one channel,
2012-10-12 14:17:47 +00:00
any messages are sent to all of them.
2012-10-11 16:31:40 +00:00
.TP
.B /u
.B USERS
command.
.TP
.B /w
.B WHO
command.
.TP
.B /x
.B QUIT
command.
Control-D also sends this command.
2012-10-11 16:31:40 +00:00
.PP
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
2012-10-12 14:17:47 +00:00
.PP
Join two channels on login:
2012-10-12 14:17:47 +00:00
.IP
.EX
% ircrc -t '#cat-v,#plan9'
.EE
2012-10-11 16:31:40 +00:00
.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
2012-10-12 14:17:47 +00:00
Some fonts do not support the nickname delimiters.
.PP
If the connection is lost,
.I ircrc
waits for input before exiting.