about summary refs log tree commit diff
path: root/catgirl.1
blob: 5511ed4defeb5c8f66fdb2bcd7e1695b184a6ce5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
.Dd October 3, 2019
.Dt CATGIRL 1
.Os
.
.Sh NAME
.Nm catgirl
.Nd IRC client
.
.Sh SYNOPSIS
.Nm
.Op Fl NPRv
.Op Fl a Ar auth
.Op Fl h Ar host
.Op Fl j Ar chan
.Op Fl k Ar keys
.Op Fl l Ar path
.Op Fl n Ar nick
.Op Fl p Ar port
.Op Fl r Ar real
.Op Fl u Ar user
.Op Fl w Ar pass
.
.Sh DESCRIPTION
.Nm
is a curses, TLS-only IRC client.
.
.Pp
The arguments are as follows:
.
.Bl -tag -width "-w pass"
.It Fl N
Send notifications with
.Xr notify-send 1 .
.
.It Fl P
Prompt for nickname.
.
.It Fl R
Restrict the use of the
.Ic /join ,
.Ic /query ,
.Ic /quote ,
.Ic /raw
commands.
.
.It Fl a Ar auth
Authenticate with SASL PLAIN.
.Ar auth
is a colon-separated
username and password pair.
.
.It Fl h Ar host
Connect to
.Ar host .
.
.It Fl j Ar chan
Join
.Ar chan
after connecting.
.Ar chan
may be a comma-separated list.
.
.It Fl k Ar keys
Set keys for channels in
.Fl j .
.Ar keys
may be a comma-separated list.
.
.It Fl l Ar path
Log messages to
subdirectories of
.Ar path
named by channel or nick
in files named by date.
.
.It Fl n Ar nick
Set nickname to
.Ar nick .
The default nickname
is the user's name.
.
.It Fl p Ar port
Connect to
.Ar port .
The default port is 6697.
.
.It Fl r Ar real
Set realname to
.Ar real .
The default realname is
the same as the nickname.
.
.It Fl u Ar user
Set username to
.Ar user .
The default username is
the same as the nickname.
.
.It Fl v
Show raw IRC protocol in the
.Sy <raw>
window.
If standard error is not a terminal,
output raw IRC protocol
to standard error.
.
.It Fl w Ar pass
Log in with
.Ar pass .
.El
.
.Sh COMMANDS
Any unique prefix
may be used to abbreviate a command.
.
.Ss Chat Commands
.Bl -tag -width Ds
.It Ic /join Ar chan Op Ar key
Join a channel.
.
.It Ic /list Op Ar chan
List channels.
.
.It Ic /me Op Ar action
Send an action message.
.
.It Ic /names , /who
List users in the current channel.
.
.It Ic /nick Ar nick
Change nicknames.
.
.It Ic /part Op Ar message
Leave the current channel.
.
.It Ic /query Ar nick
Open a private message view.
.
.It Ic /quit Op Ar message
Quit IRC.
.
.It Ic /quote Ar command
Send a raw IRC command.
.
.It Ic /topic Op Ar topic
Show or set the topic of the current channel.
.
.It Ic /whois Ar nick
Query information about a user.
.
.It Ic /znc Ar command
Send
.Xr znc 1
command.
.El
.
.Pp
Any messages entered in the
.Sy <raw>
window will be sent as raw IRC commands.
.
.Ss UI Commands
.Bl -tag -width Ds
.It Ic /close
Close the current window.
.
.It Ic /help , /man
View this manual.
.
.It Ic /move Ar num
Move window to number.
If
.Ar num
starts with
.Cm +
or
.Cm - ,
the number is relative to the current window.
.
.It Ic /open Op Ar range
Open a
.Ar range
of recent URLs
in the current window with
.Xr open 1 .
URLs are numbered
from the most recent
starting at 1.
The
.Ar range
may be a single number,
or a hyphen- or comma-separated range.
.
.It Ic /open Ar substring
Open the most recent URL
in the current window
matching the
.Ar substring .
.
.It Ic /raw
Toggle the
.Sy <raw>
window.
.
.It Ic /url
Hide the UI
and list the most recent URLs
in the current window.
Press
.Ic Enter
to resume the UI.
.
.It Ic /window Ar name
Switch to window by name.
.
.It Ic /window Ar num , Ic / Ns Ar num
Switch to window by number.
If
.Ar num
starts with
.Cm +
or
.Cm - ,
the number is relative to the current window.
.El
.
.Sh KEY BINDINGS
.Nm
provides
.Xr emacs 1 Ns -like
line editing keys
as well as keys for applying IRC formatting.
The prefixes
.Ic C- , M- , S-
represent the control, meta (alt) and shift modifiers,
respectively.
.Ic M- Ns Ar x
sequences can also be typed as
.Ic Esc
followed by
.Ar x .
.
.Ss Line Editing
.Bl -tag -width Ds -compact
.It Ic C-a
Move cursor to beginning of line.
.It Ic C-b
Move cursor left.
.It Ic C-d
Delete character under cursor.
.It Ic C-e
Move cursor to end of line.
.It Ic C-f
Move cursor right.
.It Ic C-k
Delete line after cursor.
.It Ic C-u
Delete line.
.It Ic C-w
Delete word before cursor.
.It Ic M-b
Move cursor to beginning of word.
.It Ic M-d
Delete word after cursor.
.It Ic M-f
Move cursor to end of word.
.It Ic Tab
Cycle through completions for
commands, nicks and channels.
.El
.
.Ss IRC Formatting
.Bl -tag -width Ds -compact
.It Ic C-_
Toggle underline.
.It Ic C-o
Toggle bold.
.It Ic C-r
Set or reset color.
.It Ic C-s
Reset formatting.
.It Ic C-t
Toggle italics.
.It Ic C-v
Toggle reverse video.
This must usually be typed as
.Ic C-v C-v .
.El
.
.Pp
To reset color, follow
.Ic C-r
by a non-digit.
To set colors, follow
.Ic C-r
by one or two digits
to set the foreground color,
optionally followed by a comma
and one or two digits
to set the background color.
.
.Pp
The color numbers are as follows:
.Pp
.Bl -column "7" "orange (dark yellow)" "15" "pink (light magenta)"
.It 0 Ta white Ta \ 8 Ta yellow
.It 1 Ta black Ta \ 9 Ta light green
.It 2 Ta blue Ta 10 Ta cyan
.It 3 Ta green Ta 11 Ta light cyan
.It 4 Ta red Ta 12 Ta light blue
.It 5 Ta brown (dark red) Ta 13 Ta pink (light magenta)
.It 6 Ta magenta Ta 14 Ta gray
.It 7 Ta orange (dark yellow) Ta 15 Ta light gray
.El
.
.Ss Window Keys
.Bl -tag -width "PageDown" -compact
.It Ic C-l
Redraw the UI.
.It Ic C-n
Switch to the next window.
.It Ic C-p
Switch to the previous window.
.It Ic M-/
Switch to the previously active window.
.It Ic M-a
Switch to next hot or unread window.
.It Ic M-l
Hide the UI and list the log for the current window.
.It Ic M-m
Insert a blank line in the window.
.It Ic M- Ns Ar n
Switch to window by number 0\(en9.
.It Ic Down
Scroll window down by one line.
.It Ic PageDown
Scroll window down by one page.
.It Ic PageUp
Scroll window up by one page.
.It Ic Up
Scroll window up by one line.
.El
.
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev USER
The default nickname.
.El
.
.Sh EXAMPLES
.Dl catgirl -h chat.freenode.net -j '#ascii.town'
.
.Sh STANDARDS
.Nm
is a partial implementation of the following:
.
.Bl -item
.It
.Rs
.%A C. Kalt
.%T Internet Relay Chat: Client Protocol
.%I IETF
.%N RFC 2812
.%D April 2000
.%U https://tools.ietf.org/html/rfc2812
.Re
.
.It
.Rs
.%A Kevin L. Mitchell
.%A Perry Lorier
.%A Lee Hardy
.%A William Pitcock
.%T IRCv3.1 Client Capability Negotiation
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/core/capability-negotiation-3.1.html
.Re
.
.It
.Rs
.%A Jilles Tjoelker
.%A William Pitcock
.%T IRCv3.1 SASL Authentication
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/sasl-3.1.html
.Re
.
.It
.Rs
.%A K. Zeilenga, Ed.
.%Q OpenLDAP Foundation
.%T The PLAIN Simple Authentication and Security Layer (SASL) Mechanism
.%I IETF
.%N RFC 4616
.%D August 2006
.%U https://tools.ietf.org/html/rfc4616
.Re
.
.It
.Rs
.%A S. Josefsson
.%Q SJD
.%T The Base16, Base32, and Base64 Data Encodings
.%I IETF
.%N RFC 4648
.%D October 2006
.%U https://tools.ietf.org/html/rfc4648
.Re
.El
.
.Sh CAVEATS
.Nm
does not support unencrypted connections.