git: 9front

ref: 05f4fb831c30b6d9511dabb41004ac60f65532c7
dir: /sys/man/1/ircrc/

View raw version
.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
]
[
.B -u
] [
.I server
]
.SH DESCRIPTION
.I Ircrc
is an IRC client.
Messages are sent from standard input and
received from standard output.
The default server is
.BR irc.oftc.net ,
and TLS is used by default through
.I tlsclient
(see
.IR tlssrv (8)).
The arguments
.B bitlbee
and
.B oftc
are expanded to
.B im.bitlbee.org
and
.BR irc.oftc.net ,
respectively.
.PP
The NickServ and server passwords are read if
available via the authentication agent
.IR factotum (4)
and are searched for using the following keyspecs,
respectively:
.IP
.EX
proto=pass server=$server service=irc user=$nick
proto=pass server=$server service=ircsrv user=$nick
.EE
.PP
The options are:
.TP
.BI -p " port
Change the default port
.RB ( 6697 ).
.TP
.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.
.TP
.BI -n " nick
Change the default nickname
.RB ( $user ).
.TP
.BI -u
.br
Disable TLS.
.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:
.TF "/M target \(+-flag…"
.TP
.BI "/! " cmd
Send the output of the shell command
.I cmd
to the current target.
.TP
.BI "/M " "target \(+-flag…"
.LR MODE :
set
.RB ( + )
or remove
.RB ( - )
a mode
.I flag
for
.IR target .
Multiple flags may be joined together and followed by an optional arguments list.
.TP
.BI "/N " target\ msg
.LR NOTICE :
send the notice
.I msg
to
.IR target .
.TP
.BI "/T " chan [ :topic ]
.LR TOPIC :
set the channel
.IR chan 's
.IR topic ,
or clear it if empty.
With only the
.I chan
argument,
print the current topic.
.TP
.BI "/W [" server ] user
.LR WHOIS :
query
.I server
for information about
.IR user .
If
.I server
is unspecified, query the current server.
.TP
.BI "/a [" text ]
.LR AWAY :
set away status to
.I text
if provided, or clear it otherwise.
.TP
.BI "/j " chans [ keys ]
.LR JOIN :
join a comma-separated channel list
.IR chans ,
optionally providing a corresponding key list
.I keys
in the same order and format.
Providing channel name
.L 0
parts all joined channels.
.TP
.BI "/l [" chans ]
.LR LIST :
list information about visible channels in the comma-separated list
.I chans
or all visible channels if empty.
The argument may instead be a list of conditions to filter results by.
.TP
.BI "/m " "target text"
.LR PRIVMSG :
send the message
.I text
to
.IR target .
.TP
.BI "/n " name
.LR NICK :
change nickname to
.IR name .
.TP
.BI "/p " chans [ msg ]
.LR PART :
part comma-separated channel list
.IR chans ,
with parting message
.I msg
if provided.
.TP
.BI "/q " cmd
Send the raw IRC command
.I cmd
to the server.
.TP
.BI "/t [" targets ]
Push all subsequent messages to a comma-separated list of
.IR targets ,
or clear if empty.
.TP
.BI "/u [" server ]
.LR USERS :
query user statistics for
.IR server ,
or current one if empty.
.TP
.BI "/w " mask
.LR WHO :
query for visible users matching
.IR mask ,
or if
.I mask
is a channel, list it's members.
.TP
.BI "/x [" message ]
.LR QUIT :
terminate the session with a quit
.I message
if provided.
Control-D also sends this command.
.PP
Unless noted otherwise, command targets may be either users or channels.
.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:
.IP
.EX
% ircrc -t '#cat-v,#plan9'
.EE
.SH SOURCE
.B /rc/bin/ircrc
.SH SEE ALSO
.IR factotum (4),
.IR tlssrv (8)
.br
.B http://tools.ietf.org/html/rfc1459
.br
.B http://tools.ietf.org/html/rfc2812
.br
.B https://modern.ircdocs.horse
.br
HELP command and specific server documentation.
.SH BUGS
.PP
Some fonts do not support the nickname delimiters.
.PP
If the connection is lost,
.I ircrc
waits for input before exiting.