about summary refs log tree commit diff
path: root/catgirl.1
blob: 9e28bdaf6e35d21c585b8dcc617932049efe1450 (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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
.Dd May 29, 2022
.Dt CATGIRL 1
.Os
.
.Sh NAME
.Nm catgirl
.Nd IRC client
.
.Sh SYNOPSIS
.Nm
.Op Fl KRelqv
.Op Fl C Ar copy
.Op Fl H Ar hash
.Op Fl I Ar highlight
.Op Fl N Ar notify
.Op Fl O Ar open
.Op Fl S Ar bind
.Op Fl T Ns Op Ar timestamp
.Op Fl a Ar plain
.Op Fl c Ar cert
.Op Fl h Ar host
.Op Fl i Ar ignore
.Op Fl j Ar join
.Op Fl k Ar priv
.Op Fl m Ar mode
.Op Fl n Ar nick
.Op Fl p Ar port
.Op Fl r Ar real
.Op Fl s Ar save
.Op Fl t Ar trust
.Op Fl u Ar user
.Op Fl w Ar pass
.Op Ar config ...
.
.Nm
.Fl o
.Op Fl S Ar bind
.Op Fl h Ar host
.Op Fl p Ar port
.Op Ar config ...
.
.Nm
.Fl g Ar cert
.
.Sh DESCRIPTION
The
.Nm
IRC client
provides a curses interface
for TLS-only
Internet Relay Chat.
The only required option is
.Fl h ,
the host name to connect to.
See
.Sx EXAMPLES
for managing further configuration.
Type
.Ic /help
in
.Nm
to view the list of
.Sx COMMANDS
and
.Sx KEY BINDINGS .
.
.Pp
Options can be loaded from files
listed on the command line.
Files are searched for in
.Pa $XDG_CONFIG_DIRS/catgirl
.Po
usually
.Pa ~/.config/catgirl
.Pc
unless the path starts with
.Ql / ,
.Ql \&./
or
.Ql \&../ .
Files and flags listed later
on the command line
take precedence over
those listed earlier.
.
.Pp
Each option is placed on a line,
and lines beginning with
.Ql #
are ignored.
The options are listed below
following their corresponding flags.
.
.Bl -tag -width Ds
.It Fl C Ar util | Cm copy No = Ar util
Set the utility used by
.Ic /copy .
Subsequent
.Cm copy
options append arguments to
.Ar util .
The URL to copy is provided to
.Ar util
on standard input.
The default is the first available of
.Xr pbcopy 1 ,
.Xr wl-copy 1 ,
.Xr xclip 1 ,
.Xr xsel 1 .
.
.It Fl H Ar seed,bound | Cm hash No = Ar seed,bound
Set the initial seed
of the nick and channel
color hash function
and the maximum IRC color value
produced by the function.
The default is 0,75.
To use only colors from
the 16-color terminal set,
use 0,15.
To disable nick and channel colors,
use 0,0.
.
.It Fl I Ar pattern | Cm highlight No = Ar pattern
Add a case-insensitive message highlight pattern,
which may contain
.Ql * ,
.Ql \&?
and
.Ql []
wildcards as in
.Xr glob 7 .
The format of the pattern is as follows:
.Bd -ragged -offset indent
.Ar nick Ns Op Ar !user@host Op Ar command Op Ar channel Op Ar message
.Ed
.Pp
The commands which can be matched are:
.Sy INVITE ,
.Sy JOIN ,
.Sy NICK ,
.Sy NOTICE ,
.Sy PART ,
.Sy PRIVMSG ,
.Sy QUIT ,
.Sy SETNAME .
.
.It Fl K | Cm kiosk
Disable the
.Ic /copy ,
.Ic /debug ,
.Ic /exec ,
.Ic /join ,
.Ic /list ,
.Ic /msg ,
.Ic /open ,
.Ic /part ,
.Ic /query ,
.Ic /quote
commands.
Replace the username
with a hash of its original value.
.
.It Fl N Ar util | Cm notify No = Ar util
Send notifications using a utility.
Subsequent
.Cm notify
options append arguments to
.Ar util .
The window name and message
are provided to
.Ar util
as two additional arguments,
appropriate for
.Xr notify-send 1 .
.
.It Fl O Ar util | Cm open No = Ar util
Set the utility used by
.Ic /open .
Subsequent
.Cm open
options append arguments to
.Ar util .
The URL to open is provided to
.Ar util
as an argument.
The default is the first available of
.Xr open 1 ,
.Xr xdg-open 1 .
.
.It Fl R | Cm restrict
Disable the
.Ic /copy ,
.Ic /exec
and
.Ic /open
commands,
the
.Cm notify
option,
and viewing this manual with
.Ic /help .
.
.It Fl S Ar host | Cm bind No = Ar host
Bind to source address
.Ar host
when connecting to the server.
To connect from any address
over IPv4 only,
use 0.0.0.0.
To connect from any address
over IPv6 only,
use ::.
.
.It Fl T Ns Oo Ar format Oc | Cm timestamp Op = Ar format
Show timestamps by default,
in the specified
.Xr strftime 3
.Ar format .
The format string may contain
raw IRC formatting codes.
The default format is
.Qq \&%X .
.
.It Fl a Ar user : Ns Ar pass | Cm sasl-plain No = Ar user : Ns Ar pass
Authenticate as
.Ar user
with
.Ar pass
using SASL PLAIN.
Leave
.Ar pass
blank to prompt for the password.
.
.It Fl c Ar path | Cm cert No = Ar path
Load the TLS client certificate from
.Ar path .
The
.Ar path
is searched for in the same manner
as configuration files.
If the private key is in a separate file,
it is loaded with
.Cm priv .
With
.Cm sasl-external ,
authenticate using SASL EXTERNAL.
Certificates can be generated with
.Fl g .
.
.It Fl e | Cm sasl-external
Authenticate using SASL EXTERNAL,
also known as CertFP.
The TLS client certificate is loaded with
.Cm cert .
See
.Sx Configuring CertFP .
.
.It Fl g Ar path
Generate a TLS client certificate using
.Xr openssl 1
and write it to
.Ar path .
.
.It Fl h Ar host | Cm host No = Ar host
Connect to
.Ar host .
.
.It Fl i Ar pattern | Cm ignore No = Ar pattern
Add a case-insensitive message ignore pattern,
which may contain
.Ql * ,
.Ql \&?
and
.Ql []
wildcards as in
.Xr glob 7 .
The format of the pattern is as follows:
.Bd -ragged -offset indent
.Ar nick Ns Op Ar !user@host Op Ar command Op Ar channel Op Ar message
.Ed
.Pp
The commands which can be matched are:
.Sy INVITE ,
.Sy JOIN ,
.Sy NICK ,
.Sy NOTICE ,
.Sy PART ,
.Sy PRIVMSG ,
.Sy QUIT ,
.Sy SETNAME .
.
.It Fl j Ar channels Oo Ar keys Oc | Cm join No = Ar channels Oo Ar keys Oc
Join the comma-separated list of
.Ar channels
with the optional comma-separated list of channel
.Ar keys .
.
.It Fl k Ar path | Cm priv No = Ar priv
Load the TLS client private key from
.Ar path .
The
.Ar path
is searched for in the same manner
as configuration files.
.
.It Fl l | Cm log
Log chat events to files in paths
.Pa $XDG_DATA_HOME/catgirl/log/network/channel/YYYY-MM-DD.log .
.
.It Fl m Ar mode | Cm mode No = Ar mode
Set the user
.Ar mode .
.
.It Fl n Ar nick | Cm nick No = Ar nick
Set nickname to
.Ar nick .
The default nickname is
the value of the environment variable
.Ev USER .
.
.It Fl o
Print the server certificate chain
to standard output in PEM format
and exit.
.
.It Fl p Ar port | Cm port No = Ar port
Connect to
.Ar port .
The default port is 6697.
.
.It Fl q | Cm quiet
Raise the default message visibility threshold
for new windows,
hiding general events
(joins, quits, etc.).
.
.It Fl r Ar real | Cm real No = Ar real
Set realname to
.Ar real .
The default realname is the same as the nickname.
.
.It Fl s Ar name | Cm save No = Ar name
Save and load the contents of windows from
.Ar name
in
.Pa $XDG_DATA_DIRS/catgirl ,
or an absolute or relative path if
.Ar name
starts with
.Ql / ,
.Ql \&./ ,
or
.Ql \&../ .
.
.It Fl t Ar path | Cm trust No = Ar path
Trust the self-signed certificate
loaded from
.Ar path
and disable server name verification.
The
.Ar path
is searched for in the same manner
as configuration files.
See
.Sx Connecting to Servers with Self-signed Certificates .
.
.It Fl u Ar user | Cm user No = Ar user
Set username to
.Ar user .
The default username is the same as the nickname.
.
.It Fl v | Cm debug
Log raw IRC messages to the
.Sy <debug>
window
as well as standard error
if it is not a terminal.
.
.It Fl w Ar pass | Cm pass No = Ar pass
Log in with the server password
.Ar pass .
Leave
.Ar pass
blank to prompt for the password.
.El
.
.Ss Configuring CertFP
.Bl -enum
.It
Generate a new TLS client certificate:
.Bd -literal -offset indent
$ catgirl -g ~/.config/catgirl/example.pem
.Ed
.It
Connect to the server using the certificate:
.Bd -literal -offset indent
cert = example.pem
# or: $ catgirl -c example.pem
.Ed
.It
Identify with services or use
.Cm sasl-plain ,
then add the certificate fingerprint
to your account:
.Bd -literal -offset indent
/ns CERT ADD
.Ed
.It
Enable SASL EXTERNAL
to require successful authentication
when connecting
(not possible on all networks):
.Bd -literal -offset indent
cert = example.pem
sasl-external
# or: $ catgirl -e -c example.pem
.Ed
.El
.
.Ss Connecting to Servers with Self-signed Certificates
.Bl -enum
.It
Connect to the server
and write its certificate to a file:
.Bd -literal -offset indent
$ catgirl -o -h irc.example.org > ~/.config/catgirl/example.pem
.Ed
.It
Configure
.Nm
to trust the certificate:
.Bd -literal -offset indent
trust = example.pem
# or: $ catgirl -t example.pem
.Ed
.El
.
.Sh INTERFACE
The
.Nm
interface is split
into three areas.
.
.Ss Status Line
The top line of the terminal
shows window statuses.
Only the currently active window
and windows with activity are listed.
The status line for a window
might look like this:
.Bd -literal -offset indent
1+ #ascii.town +3 ~7 @
.Ed
.Pp
The number on the left
is the window number.
Following it may be one of
.Ql - ,
.Ql + ,
.Ql ++ ,
as well as
.Ql = .
These indicate
the message visibility threshold
and mute status
of the window.
.Pp
On the right side,
the number following
.Ql +
indicates the number of unread messages.
The number following
.Ql ~
indicates how many lines
are below the scroll position.
An
.Ql @
indicates that there is unsent input
in the window's
.Sx Input Line .
.Pp
.Nm
will also set the terminal title,
if possible,
to the name of the network
and active window,
followed by the unread count
for that window,
and the unread count
for all other windows
in parentheses.
.
.Ss Chat Area
The chat area shows
messages and events.
Regular messages are shown
with the nick between
.Ql <>
angle brackets.
Actions are shown
with the nick preceded by
.Ql * .
Notices are shown
with the nick between
.Ql -
hyphens.
.Pp
Blank lines are inserted into the chat
as unread markers.
.Pp
While scrolling,
the most recent 5 lines of chat
are kept visible below a marker line.
.
.Ss Input Line
The bottom line of the terminal
is where messages and commands are entered.
When entering a message, action or notice,
your nick appears on the left,
as it would in the
.Sx Chat Area .
When entering a command,
no nick is shown.
.Pp
Formatting codes are shown
in the input line
as reverse-video uppercase letters.
These will not appear in the sent message.
.Pp
Input that is too long
to send as a single message
will have a red background
starting at the point where it will be split
into a second message.
.
.Sh COMMANDS
Any unique prefix can be used to abbreviate a command.
For example,
.Ic /join
can be typed
.Ic /j .
.
.Ss Chat Commands
.Bl -tag -width Ds
.It Ic /away Op Ar message
Set or clear your away status.
.It Ic /cs Ar command
Send a command to ChanServ.
.It Ic /invite Ar nick
Invite a user to the channel.
.It Ic /join Op Ar channel Op Ar key
Join the named channel,
the current channel,
or the channel you've been invited to.
.It Ic /list Op Ar channel
List channels.
.It Ic /me Op Ar action
Send an action message.
.It Ic /msg Ar nick message
Send a private message.
.It Ic /names
List users in the channel.
.It Ic /nick Ar nick
Change nicknames.
.It Ic /notice Ar message
Send a notice.
.It Ic /ns Ar command
Send a command to NickServ.
.It Ic /ops
List channel operators.
.It Ic /part Op Ar message
Leave the channel.
.It Ic /query Ar nick
Start a private conversation.
.It Ic /quit Op Ar message
Quit IRC.
.It Ic /quote Ar command
Send a raw IRC command.
Use
.Ic M--
to show unknown replies.
.It Ic /say Ar message
Send a regular message.
.It Ic /setname Ar name
Update realname
if supported by the server.
.It Ic /topic Op Ar topic
Show or set the topic of the channel.
Press
.Ic Tab
twice to copy the current topic.
.It Ic /whois Op Ar nick
Query information about a user or yourself.
.It Ic /whowas Ar nick
Query past information about a user.
.El
.
.Ss UI Commands
.Bl -tag -width Ds
.It Ic /close Op Ar name | num
Close the named, numbered or current window.
.It Ic /copy Op Ar nick | substring
Copy the most recent URL from
.Ar nick
or matching
.Ar substring .
.It Ic /debug
Toggle logging in the
.Sy <debug>
window.
.It Ic /exec Ar command
Run
.Ar command
with
.Ev SHELL
and interpret its output
as input to the current window,
including as commands.
.It Ic /help
View this manual.
Type
.Ic q
to return to
.Nm .
.It Ic /help Ar topic
List the server help for a topic.
Try
.Ic /help index
for a list of topics.
.It Ic /highlight Op Ar pattern
List message highlight patterns
or temporarily add a pattern.
To permanently add a pattern,
use the
.Cm highlight
option.
.It Ic /ignore Op Ar pattern
List message ignore patterns
or temporarily add a pattern.
To permanently add a pattern,
use the
.Cm ignore
option.
.It Ic /move Oo Ar name Oc Ar num
Move the named or current window to number.
.It Ic /open Op Ar count
Open each of
.Ar count
most recent URLs.
.It Ic /open Ar nick | substring
Open the most recent URL from
.Ar nick
or matching
.Ar substring .
.It Ic /unhighlight Ar pattern
Temporarily remove a message highlight pattern.
.It Ic /unignore Ar pattern
Temporarily remove a message ignore pattern.
.It Ic /window
List all windows.
.It Ic /window Ar name | substring
Switch to window by name
or matching substring.
.It Ic /window Ar num | Ic / Ns Ar num
Switch to window by number.
.El
.
.Ss Operator Commands
.Bl -tag -width Ds
.It Ic /ban Op Ar mask ...
List or ban masks from the channel.
.It Ic /deop Op Ar nick ...
Revoke channel operator status from users or yourself.
.It Ic /devoice Op Ar nick ...
Revoke voice from users or yourself in the channel.
.It Ic /except Op Ar mask ...
List or add masks to the channel ban exception list.
.It Ic /invex Op Ar mask ...
List or add masks to the channel invite list.
.It Ic /kick Ar nick Op Ar message
Kick a user from the channel.
.It Ic /mode Oo Ar modes Oc Op Ar param ...
Show or set channel modes.
In the
.Sy <network>
window,
show or set user modes.
.It Ic /op Op Ar nick ...
Grant users or yourself channel operator status.
.It Ic /unban Ar mask ...
Unban masks from the channel.
.It Ic /unexcept Ar mask ...
Remove masks from the channel ban exception list.
.It Ic /uninvex Ar mask ...
Remove masks from the channel invite list.
.It Ic /voice Op Ar nick ...
Grant users or yourself voice in the channel.
.El
.
.Sh KEY BINDINGS
The
.Nm
interface provides
.Xr emacs 1 Ns -like
line editing
as well as keys for IRC formatting.
The prefixes
.Ic C-
and
.Ic M-
represent the control and meta (alt)
modifiers, respectively.
.
.Ss Line Editing
.Bl -tag -width Ds -compact
.It Ic C-a
Move to beginning of line.
.It Ic C-b
Move left.
.It Ic C-d
Delete next character.
.It Ic C-e
Move to end of line.
.It Ic C-f
Move right.
.It Ic C-k
Delete to end of line.
.It Ic C-t
Transpose characters.
.It Ic C-u
Delete to beginning of line.
.It Ic C-w
Delete previous word.
.It Ic C-x
Expand a text macro beginning with
.Ql \e .
.It Ic C-y
Paste previously deleted text.
.It Ic M-Enter
Insert a newline without sending a command.
.It Ic M-b
Move to previous word.
.It Ic M-d
Delete next word.
.It Ic M-f
Move to next word.
.It Ic M-q
Collapse all whitespace.
.It Ic Tab
Complete nick, channel, command or macro.
.El
.Pp
Arrow and navigation keys
also work as expected.
.
.Ss Window Keys
.Bl -tag -width Ds -compact
.It Ic C-l
Redraw the UI.
.It Ic C-n
Switch to next window.
.It Ic C-p
Switch to previous window.
.It Ic C-r
Scroll to previous line matching input.
.It Ic C-s
Scroll to next line matching input.
.It Ic C-v
Scroll down a page.
.It Ic M-+
Raise message visibility threshold,
hiding ignored messages,
general events
(joins, quits, etc.),
or non-highlighted messages.
.It Ic M--
Lower message visibility threshold,
showing ignored messages
and unknown replies.
.It Ic M-=
Toggle mute.
Muted windows do not appear in the status line
unless you are mentioned.
.It Ic M-/
Switch to previously selected window.
.It Ic M-<
Scroll to top.
.It Ic M->
Scroll to bottom.
.It Ic M- Ns Ar n
Switch to window by number 0\(en9.
.It Ic M-a
Cycle through unread windows.
.It Ic M-l
List the contents of the window
without word-wrapping
and with timestamps.
Press
.Ic Enter
to return to
.Nm .
.It Ic M-m
Insert a blank line in the window.
.It Ic M-n
Scroll to next highlight.
.It Ic M-p
Scroll to previous highlight.
.It Ic M-s
Reveal spoiler text.
.It Ic M-t
Toggle timestamps.
.It Ic M-u
Scroll to first unread line.
.It Ic M-v
Scroll up a page.
.El
.
.Ss IRC Formatting
.Bl -tag -width "C-z C-v" -compact
.It Ic C-z C-v
Insert the next input character literally.
.It Ic C-z b
Toggle bold.
.It Ic C-z c
Set or reset color.
.It Ic C-z i
Toggle italics.
.It Ic C-z o
Reset formatting.
.It Ic C-z p
Manually toggle paste mode.
.It Ic C-z r
Toggle reverse color.
.It Ic C-z s
Set spoiler text (black on black).
.It Ic C-z u
Toggle underline.
.El
.
.Pp
Some color codes can be inserted
with the following:
.Bl -column "C-z A" "magenta" "C-z N" "orange (dark yellow)"
.It Ic C-z A Ta gray Ta Ic C-z N Ta brown (dark red)
.It Ic C-z B Ta blue Ta Ic C-z O Ta orange (dark yellow)
.It Ic C-z C Ta cyan Ta Ic C-z P Ta pink (light magenta)
.It Ic C-z G Ta green Ta Ic C-z R Ta red
.It Ic C-z K Ta black Ta Ic C-z W Ta white
.It Ic C-z M Ta magenta Ta Ic C-z Y Ta yellow
.El
.
.Pp
To set other colors, follow
.Ic C-z c
by one or two digits for the foreground color,
optionally followed by a comma
and one or two digits for the background color.
To reset color, follow
.Ic C-z c
by a non-digit.
.
.Pp
The color numbers are as follows:
.Bl -column "99" "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
.It 99 Ta default Ta Ta
.El
.
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev SHELL
The shell used by
.Ic /exec .
The default is
.Pa /bin/sh .
.It Ev USER
The default nickname.
.El
.
.Sh FILES
.Bl -tag -width Ds
.It Pa $XDG_CONFIG_DIRS/catgirl
Configuration files are searched for first in
.Ev $XDG_CONFIG_HOME ,
usually
.Pa ~/.config ,
followed by the colon-separated list of paths
.Ev $XDG_CONFIG_DIRS ,
usually
.Pa /etc/xdg .
.It Pa ~/.config/catgirl
The most likely location of configuration files.
.
.It Pa $XDG_DATA_DIRS/catgirl
Save files are searched for first in
.Ev $XDG_DATA_HOME ,
usually
.Pa ~/.local/share ,
followed by the colon-separated list of paths
.Ev $XDG_DATA_DIRS ,
usually
.Pa /usr/local/share:/usr/share .
.It Pa ~/.local/share/catgirl
The most likely location of save files.
.El
.
.Sh EXIT STATUS
The
.Nm
client exits 0
if requested by the user,
.Dv EX_UNAVAILABLE
(69)
if the connection is lost,
and >0 if any other error occurs.
.
.Sh EXAMPLES
Join
.Li #ascii.town
from the command line:
.Bd -literal -offset indent
$ catgirl -h irc.tilde.chat -j '#ascii.town'
.Ed
.Pp
Create a configuration file in
.Pa ~/.config/catgirl/tilde :
.Bd -literal -offset indent
host = irc.tilde.chat
join = #ascii.town
.Ed
.Pp
Load the configuration file:
.Bd -literal -offset indent
$ catgirl tilde
.Ed
.
.Sh STANDARDS
.Bl -item
.It
.Rs
.%A Adam
.%A Attila Molnar
.%T invite-notify Extension
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/invite-notify
.Re
.It
.Rs
.%A Jack Allnutt
.%A Val Lorentz
.%A Daniel Oaks
.%T Modern IRC Client Protocol
.%I ircdocs
.%U https://modern.ircdocs.horse/index.html
.Re
.It
.Rs
.%A Kiyoshi Aman
.%A Kyle Fuller
.%A St\('ephan Kochen
.%A Alexey Sokolov
.%A James Wheare
.%T Message Tags
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/message-tags
.Re
.It
.Rs
.%A Kiyoshi Aman
.%T extended-join Extension
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/extended-join
.Re
.It
.Rs
.%A Waldo Bastian
.%A Ryan Lortie
.%A Lennart Poettering
.%T XDG Base Directory Specification
.%U https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
.%D November 24, 2010
.Re
.It
.Rs
.%A Christine Dodrill
.%A Ryan
.%A James Wheare
.%T chghost Extension
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/chghost
.Re
.It
.Rs
.%A Kyle Fuller
.%A St\('ephan Kochen
.%A Alexey Sokolov
.%A James Wheare
.%T server-time Extension
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/server-time
.Re
.It
.Rs
.%A Lee Hardy
.%A Perry Lorier
.%A Kevin L. Mitchell
.%A Attila Molnar
.%A Daniel Oakley
.%A William Pitcock
.%A James Wheare
.%T Client Capability Negotiation
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/core/capability-negotiation
.Re
.It
.Rs
.%A S. Josefsson
.%T The Base16, Base32, and Base64 Data Encodings
.%I IETF
.%R RFC 4648
.%U https://tools.ietf.org/html/rfc4648
.%D October 2006
.Re
.It
.Rs
.%A C. Kalt
.%T Internet Relay Chat: Client Protocol
.%I IETF
.%R RFC 2812
.%U https://tools.ietf.org/html/rfc2812
.%D April 2000
.Re
.It
.Rs
.%A Janne Mareike Koschinski
.%T setname Extension
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/setname
.Re
.It
.Rs
.%A Mantas Mikul\[u0117]nas
.%T userhost-in-names Extension
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/userhost-in-names
.Re
.It
.Rs
.%A Daniel Oaks
.%T IRC Formatting
.%I ircdocs
.%U https://modern.ircdocs.horse/formatting.html
.Re
.It
.Rs
.%A Daniel Oaks
.%T Standard Replies Extension
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/standard-replies
.Re
.It
.Rs
.%A J. Oikarinen
.%A D. Reed
.%T Internet Relay Chat Protocol
.%I IETF
.%R RFC 1459
.%U https://tools.ietf.org/html/rfc1459
.%D May 1993
.Re
.It
.Rs
.%A William Pitcock
.%A Jilles Tjoelker
.%T IRCv3.1 SASL Authentication
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/sasl-3.1
.Re
.It
.Rs
.%A William Pitcock
.%T multi-prefix Extension
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/multi-prefix
.Re
.It
.Rs
.%A James Wheare
.%T Message IDs
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/message-ids
.Re
.It
.Rs
.%A James Wheare
.%T reply Client Tag
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/client-tags/reply
.Re
.It
.Rs
.%A K. Zeilenga, Ed.
.%T The PLAIN Simple Authentication and Security Layer (SASL) Mechanism
.%I IETF
.%R RFC 4616
.%U https://tools.ietf.org/html/rfc4616
.%D August 2006
.Re
.El
.
.Ss Extensions
The
.Nm
client implements the
.Sy causal.agency/consumer
vendor-specific IRCv3 capability
offered by
.Xr pounce 1 .
The consumer position is stored in the
.Cm save
file.
.
.Sh AUTHORS
.An June Bug Aq Mt june@causal.agency
.
.Sh BUGS
Send mail to
.Aq Mt list+catgirl@causal.agency
or join
.Li #ascii.town
on
.Li irc.tilde.chat .