-
Notifications
You must be signed in to change notification settings - Fork 17
/
rirc.1
140 lines (140 loc) · 3.24 KB
/
rirc.1
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
'\" t
.TH RIRC 1 rirc\-VERSION
.SH NAME
rirc \- a minimalistic internet relay chat client
.SH SYNOPSIS
\fBrirc\fR [ \fB-hv\fR ] [ \fB-s\fR \fIserver\fR [ \fB...\fR ]]
.SH OPTIONS
.TP 4
.B "-h, --help"
Print help message and exit
.TP
.B "-v, --version"
Print rirc version and exit
.TP
.BI "-s, --server=" server
Set connection \fIhostname\fP
.TP
.BI "-p, --port=" port
Set connection \fIport\fP
.TP
.BI "-w, --pass=" pass
Set IRC \fIpassword\fP
.TP
.BI "-u, --username=" username
Set IRC \fIusername\fP
.TP
.BI "-r, --realname=" realname
Set IRC \fIrealname\fP
.TP
.BI "-m, --mode=" modes
Set IRC user \fImodes\fP
.TP
.BI "-n, --nicks=" nicks
Set comma separated list of \fInicks\fP to use
.TP
.BI "-c, --chans=" chans
Set comma separated list of \fIchannels\fP to join
.TP
.BI --tls-cert= path
Set TLS client certificate file \fIpath\fP
.TP
.BI --tls-ca-file= path
Set TLS peer certificate file \fIpath\fP
.TP
.BI --tls-ca-path= path
Set TLS peer certificate directory \fIpath\fP
.TP
.BI --tls-verify= mode
Set TLS peer certificate verification \fImode\fP:
.EX
\(bu \fIdisabled\fP - cert is not verified
\(bu \fIoptional\fP - cert is verified, handshake continues on error
\(bu \fIrequired\fP - cert is verified, handshake is aborted on error (default)
.EE
.TP
.B --tls-disable
Set TLS disabled
.TP
.BI --sasl= mechanism
Authenticate with SASL \fImechanism\fP:
.EX
\(bu \fIexternal\fP - requires \fI--tls-cert\fP
\(bu \fIplain\fP - requires \fI--sasl-user\fP and \fI--sasl-pass\fP
.EE
.TP
.BI --sasl-user= user
Authenticate with SASL \fIusername\fP
.TP
.BI --sasl-pass= pass
Authenticate with SASL \fIpassword\fP
.TP
.B --ipv4
Use IPv4 addresses only
.TP
.B --ipv6
Use IPv6 addresses only
.SH USAGE
rirc is controlled by a combination of keys and commands, where:
<arg> denotes required arguments
[arg] denotes optional arguments
.TP
Commands:
\fB:clear\fP
\fB:close\fP
\fB:connect\fP [hostname] [options]
\fB:disconnect\fP
\fB:quit\fP
.TP
Keys:
\fB^N\fP Go to next buffer
\fB^P\fP Go to previous buffer
\fB^L\fP Clear current buffer
\fB^X\fP Close current buffer
\fB^C\fP Cancel current input/action
\fB^U\fP Scroll current buffer back
\fB^D\fP Scroll current buffer forward
\fBPgUp\fP Scroll current buffer back
\fBPgDn\fP Scroll current buffer forward
\fBHome\fP Scroll current buffer to top
\fBEnd\fP Scroll current buffer to bottom
\fB ←\fP Input cursor back
\fB →\fP Input cursor forward
\fB ↑\fP Input history back
\fB ↓\fP Input history forward
.TP
IRC commands:
\fB/away\fP [away message]
\fB/join\fP [target, [targets...]]
\fB/kick\fP <channel> <nick>
\fB/mode\fP <target> <modes>
\fB/nick\fP <nick>
\fB/notice\fP <target> <message>
\fB/part\fP [target] [message]
\fB/privmsg\fP <target> <message>
\fB/quit\fP [message]
\fB/topic\fP [topic]
\fB/topic-unset\fP
\fB/whois\fP <target>
.TP
CTCP commands
\fB/ctcp-action\fP <target> <message>
\fB/ctcp-clientinfo\fP [target]
\fB/ctcp-finger\fP [target]
\fB/ctcp-ping\fP [target]
\fB/ctcp-source\fP [target]
\fB/ctcp-time\fP [target]
\fB/ctcp-userinfo\fP [target]
\fB/ctcp-version\fP [target]
.TP
IRCv3 commands
\fB/cap-ls\fP
\fB/cap-list\fP
.SH SEE ALSO
.UR https://rcr.io/rirc/
Additional documentation
.UE .
.SH AUTHORS
Richard 'rcr' Robbins
.ME .