]> git.lizzy.rs Git - plan9front.git/blob - sys/man/1/ircrc
add HISTORY to various man pages
[plan9front.git] / sys / man / 1 / ircrc
1 .TH IRCRC 1
2 .SH NAME
3 ircrc \- internet relay chat client
4 .SH SYNOPSIS
5 .B ircrc
6 [
7 .B -p
8 .I port
9 ]
10 [
11 .B -r
12 .I realname
13 ]
14 [
15 .B -t
16 .I target
17 ]
18 [
19 .B -n
20 .I nick
21 ]
22 [
23 .I server
24 ]
25 .SH DESCRIPTION
26 .I Ircrc
27 is an IRC client.
28 Messages are sent from standard input and
29 received from standard output.
30 The default server is
31 .BR irc.freenode.net .
32 The arguments
33 .B bitlbee
34 and
35 .B oftc
36 are expanded to
37 .B im.bitlbee.org
38 and
39 .BR irc.oftc.net ,
40 respectively.
41 The options are:
42 .TP
43 .BI -p " port
44 Change the default port
45 .RB ( 6667 ).
46 .TP
47 .BI -r " realname
48 Change the default name
49 .RB ( <nil> ).
50 .TP
51 .BI -t " target
52 Set and join the target channel.
53 If multiple channels are specified,
54 only the last one will be set as
55 .IR target .
56 Messages are sent to
57 .I target
58 unless they are commands.
59 .TP
60 .BI -n " nick
61 Change the default nickname
62 .RB ( $user ).
63 .SS Commands
64 .I Ircrc
65 commands begin with a slash.
66 Unrecognized commands result in an error message
67 and send nothing to the server.
68 The commands are:
69 .TP
70 .BI /! " cmd
71 Send the output of the shell command
72 .I cmd
73 to the current target.
74 .TP
75 .B /M
76 .B MODE
77 command.
78 .TP
79 .B /N
80 .B NOTICE
81 command.
82 .TP
83 .B /T
84 .B TOPIC
85 command.
86 .TP
87 .B /W
88 .B WHOIS
89 command.
90 .TP
91 .B /a
92 .B AWAY
93 command.
94 .TP
95 .B /j
96 .B JOIN
97 command.
98 .TP
99 .B /l
100 .B LIST
101 command.
102 .TP
103 .B /m
104 .B PRIVMSG
105 command.
106 .TP
107 .B /n
108 .B NICK
109 command.
110 .TP
111 .B /p
112 .B PART
113 command.
114 .TP
115 .BI /q " cmd
116 Send the raw IRC command
117 .I cmd
118 to the server.
119 .TP
120 .BI /t " target
121 Set
122 .IR target .
123 If
124 .I target
125 is more than one channel,
126 any messages are sent to all of them.
127 .TP
128 .B /u
129 .B USERS
130 command.
131 .TP
132 .B /w
133 .B WHO
134 command.
135 .TP
136 .B /x
137 .B QUIT
138 command.
139 Control-D also sends this command.
140 .PP
141 See RFC 1459 and RFC 2812 for detailed information about
142 IRC commands.
143 .SH EXAMPLES
144 Default usage:
145 .IP
146 .EX
147 % ircrc
148 .EE
149 .PP
150 Join
151 .B irc.oftc.net
152 as a different user:
153 .IP
154 .EX
155 % ircrc -r glenda -n glenda irc.oftc.net
156 .EE
157 .PP
158 Join two channels on login:
159 .IP
160 .EX
161 % ircrc -t '#cat-v,#plan9'
162 .EE
163 .SH SOURCE
164 .B /rc/bin/ircrc
165 .SH SEE ALSO
166 .B http://tools.ietf.org/html/rfc1459
167 .br
168 .B http://tools.ietf.org/html/rfc2812
169 .SH BUGS
170 .PP
171 .I Auth/userpasswd
172 (which is called by
173 .IR ircrc )
174 isn't compiled by default.
175 .PP
176 Some fonts do not support the nickname delimiters.
177 .PP
178 If the connection is lost,
179 .I ircrc
180 waits for input before exiting.