~rcr/rirc

ref: 3847d59f9c5984177e90cc84972388f880b5aa4c rirc/docs/rirc.1 -rw-r--r-- 2.7 KiB
3847d59f — Richard Robbins add --tls-cert-ca flag 2 months ago
                                                                                
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
'\" t
.TH RIRC 1 rirc\-VERSION
.SH NAME
rirc \- a minimalistic irc client written in C
.SH SYNOPSIS
\fBrirc\fR [ \fB-hv\fR ] [ \fB-s\fR \fIserver\fR [ \fB...\fR ]]
.SH DESCRIPTION
.PP
rirc is a lightweight Internet Relay Chat client.
.PP
Connections are TLS enabled over port 6697 by default.
.SH OPTIONS
.TP 5
.B "-h, --help"
Print help message and exit
.TP
.B "-v, --version"
Print rirc version and exit
.SS Server options
.TP 5
.BI "-s, --server=" server
Connect to \fIserver\fP
.TP
.BI "-p, --port=" port
Connect to \fIserver\fP using \fIport\fP
.TP
.BI "-w, --pass=" pass
Connect to \fIserver\fP using \fIpass\fP
.TP
.BI "-u, --username=" username
Connect to \fIserver\fP using \fIusername\fP
.TP
.BI "-r, --realname=" realname
Connect to \fIserver\fP using \fIrealname\fP
.TP
.BI "-m, --mode=" mode
Connect to \fIserver\fP with user \fImode\fP
.TP
.BI "-n, --nicks=" nicks
Comma separated list of \fInicks\fP to use for \fIserver\fP
.TP
.BI "-c, --chans=" chans
Comma separated list of \fIchannels\fP to join for \fIserver\fP
.SS Server connection options
.TP 5
.B --ipv4
Connect to \fIserver\fP using only ipv4 addresses
.TP
.B --ipv6
Connect to \fIserver\fP using only ipv6 addresses
.TP
.B --tls-disable
Set \fIserver\fP TLS disabled, default port to 6667
.TP
.BI --tls-verify= mode
Set \fIserver\fP 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
.BI --tls-cert-ca= path
Set \fIserver\fP TLS ca cert file \fIpath\fP
.SH USAGE
.TS
l .
rirc is controlled by a combination of key bindings and commands, where:
  <arg> denotes required arguments
  [arg] denotes optional arguments
.TE

.TS
.tab(;);
lb l .
Keys:
  ^N;go to next channel
  ^P;go to previous channel
  ^C;cancel current input/action
  ^L;clear current channel
  ^X;close current channel
  ^U;scroll current buffer up
  ^D;scroll current buffer down
  <left>;input cursor back
  <right>;input cursor forward
  <up>;input history back
  <down>;input history forward
.TE

.TS
l .
Commands beginning with ':' are interpreted as rirc commands
and control the local client, e.g.:
.TE

.TS
.tab(;);
lb l .
Commands:
  :clear;
  :close;
  :connect;
  :disconnect;
  :quit;
.TE

.TS
l .
Commands beginning with '/' are interpreted as IRC commands
and will be sent to the current server, e.g.:
.TE

.TS
.tab(;);
lb l .
IRC commands:
  /join;[target, [targets...]]
  /me;<message>
  /nick;[nick]
  /part;[target [targets...]] [part message]
  /privmsg;<target> <message>
  /quit;[quit message]
  /raw;<message>
.TE
.SH AUTHORS
.MT mail@rcr.io
Richard 'rcr' Robbins
.ME .
.SH SEE ALSO
.UR https://rcr.io/rirc/
Additional documentation
.UE .