summary refs log tree commit diff
path: root/catgirl.1
blob: 84ed857330167efbfaa056cc72884775aa7d85d1 (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
.Dd December 2, 2018
.Dt CATGIRL 1
.Os
.
.Sh NAME
.Nm catgirl
.Nd IRC client
.
.Sh SYNOPSIS
.Nm
.Op Fl Nv
.Op Fl W Ar pass
.Op Fl a Ar auth
.Op Fl h Ar host
.Op Fl j Ar chan
.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 W Ar pass
Send
.Ql WEBIRC
command with
.Ar pass .
See
.Sx ENVIRONMENT
for details.
.
.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 l Ar path
Log messages to subdirectories by target
and files by date under
.Ar path .
.
.It Fl n Ar nick
Set nickname to
.Ar nick .
.
.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
.Ql ~irc
view.
.
.It Fl w Ar pass
Log in with
.Ar pass .
.El
.
.Pp
If
.Fl h
or
.Fl n
are not provided,
they will be prompted for.
.
.Sh COMMANDS
Any unique prefix
may be used to abbreviate a command.
A slash followed immediately by a number
is equivalent to
.Ic /view .
.
.Bl -tag -width Ds
.It Ic /close
Close the current view.
Later views are renumbered.
.
.It Ic /help
Equivalent to
.Ic /man .
.
.It Ic /join Ar chan
Join a channel.
.
.It Ic /man
View this manual.
.
.It Ic /me Ar action
Send a CTCP
.Ql ACTION
to the current target.
.
.It Ic /names
List users in the current channel.
Equivalent to
.Ic /who .
.
.It Ic /nick Ar nick
Change nicknames.
.
.It Ic /open Op Ar range
.Xr open 1
.Ar range
most recent URLs
appearing in the current view.
.Ar range
may be a hypen- or comma-separated range
from the most recent URL,
starting at 1.
The default
.Ar range
is 1.
.
.It Ic /open Ar substring
.Xr open 1
the most recent URL
appearing in the current view
matching
.Ar substring .
.
.It Ic /part
Leave the current channel.
.
.It Ic /query Ar nick
Open a private message view with
.Ar nick .
.
.It Ic /quit Op Ar message
Quit IRC.
The default
.Ar message
is
.Dq Goodbye .
.
.It Ic /topic Op Ar topic
Show the topic of the current channel
or set it to
.Ar topic .
.
.It Ic /url
Hide the UI and
list the most recent URLs
which appeared in the current view.
Press
.Aq Enter
to resume the UI.
.
.It Ic /view Ar num
Switch to view number
.Ar num .
.
.It Ic /view Ar name
Switch to view for
.Ar name .
.
.It Ic /who
List users in the current channel.
.
.It Ic /whois Ar nick
Query information about a user.
.El
.
.Pp
Additionally,
messages entered in the
.Ql ~irc
view
will be sent as raw IRC commands.
.
.Sh KEY BINDINGS
.Nm
provides Emacs-like
line editing keys,
as well as keys for entering
IRC formatting codes.
The prefixes
.Sy C- ,
.Sy M-
and
.Sy S-
represent the control, meta and shift modifiers,
respectively.
Special keys are enclosed in
.Aq angle brackets .
.
.Ss View Keys
.Bl -tag -width <PageDown>
.It Sy C-l
Redraw the UI.
.
.It Sy M-m
Insert a blank line in the view.
.
.It Sy M-0 .. Sy M-9
Switch to view by number.
See
.Ic /view .
.
.It Sy S- Ns Aq Sy Left
Scroll view up by one line.
.
.It Sy S- Ns Aq Sy Right
Scroll view down by one line.
.
.It Aq Sy PageUp
Scroll view up by half a page.
.
.It Aq Sy PageDown
Scroll view down by half a page.
.El
.
.Ss Line Editing
.Bl -tag -width "C-f, <Right>"
.It Sy C-b , Aq Sy Left
Move cursor left.
.
.It Sy C-f , Aq Sy Right
Move cursor right.
.
.It Sy C-a , Aq Sy Home
Move cursor to beginning of line.
.
.It Sy C-e , Aq Sy End
Move cursor to end of line.
.
.It Sy M-b
Move cursor to beginning of word.
.
.It Sy M-f
Move cursor to end of word.
.
.It Aq Sy Backspace
Delete character before cursor.
.
.It Sy C-d , Aq Sy Delete
Delete character under cursor.
.
.It Sy C-w , Sy M- Ns Aq Sy Backspace
Delete word before cursor.
.
.It Sy M-d
Delete word after cursor.
.
.It Sy C-k
Delete line after cursor.
.
.It Aq Sy Tab
Cycle through completions
for commands, nicks and channels.
.El
.
.Ss IRC Formatting
.Bl -tag -width Ds
.It Sy C-n
Reset formatting.
.
.It Sy C-o
Toggle bold.
Note: this may need to be typed as
.Sy C-v C-o .
.
.It Sy C-t
Toggle italic.
.
.It Sy C-u
Toggle underline.
.
.It Sy C-v
Toggle reverse video.
Note: this must usually be typed as
.Sy C-v C-v .
.
.It Sy C-r
Set or reset color.
.El
.
.Pp
To reset color,
follow
.Sy C-r
by a non-digit.
To set the foreground color,
follow
.Sy C-r
by one or two digits.
To set the foreground and background colors,
follow
.Sy C-r
by one or two digits,
a comma,
and one or two digits.
.
.Pp
The colors are as follows:
.Pp
.Bl -tag -width Ds -compact
.It 0
white
.It 1
black
.It 2
blue
.It 3
green
.It 4
red
.It 5
brown (dark red)
.It 6
magenta
.It 7
orange (dark yellow)
.It 8
yellow
.It 9
light green
.It 10
cyan
.It 11
light cyan
.It 12
light blue
.It 13
pink (light magenta)
.It 14
gray
.It 15
light gray
.El
.
.Sh ENVIRONMENT
.Bl -tag -width SSH_CLIENT
.It Ev SSH_CLIENT
If
.Fl W
is passed and
.Ev SSH_CLIENT
is set,
the
.Ql WEBIRC
command is used
to set the hostname
to the first word of
.Ev SSH_CLIENT ,
usually the client IP address.
.El
.
.Sh EXAMPLES
.Dl catgirl -h ascii.town -j '&town'
.
.Sh STANDARDS
.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
.
.Sh CAVEATS
.Nm
does not support unencrypted connections.