an experimental irc client
rockorager.dev
1comlink(1)
2
3# NAME
4
5comlink - an IRC client
6
7# SYNOPSIS
8
9*comlink* [options...]
10
11# DESCRIPTION
12
13Comlink is an IRC client for your terminal. It employs many modern terminal
14features, such as the Kitty Keyboard Protocol, mouse shapes, and OSC 8
15hyperlinks. It also uses many IRCv3 extensions to provide a modern chat
16experience.
17
18# OPTIONS
19
20*-v*, *--version*
21 Print the version and exit.
22
23# CONFIGURATION
24
25Comlink is configured using *lua 5.4*. A lua file defining the API for
26configuration should be available in _$PREFIX/share/comlink/lua/comlink.lua_.
27Configuration will be loaded from _$XDG_CONFIG_HOME/comlink/init.lua_. Local lua
28modules will be searched for within this directory. The search paths are:
29
30```
31 $XDG_CONFIG_HOME/comlink/\*.lua
32 $XDG_CONFIG_HOME/comlink/lua/\*.lua
33 $XDG_CONFIG_HOME/comlink/lua/\*/init.lua
34```
35
36The most simple configuration is
37
38```
39 local comlink = require("comlink")
40 comlink.connect({
41 server = "chat.sr.ht",
42 user = "rockorager",
43 nick = "rockorager",
44 password = "password",
45 real_name = "Tim Culverhouse",
46 })
47```
48
49# KEYBOARD SHORTCUTS
50
51Many keyboard shortcuts may be configured in the configuration file. The
52shortcuts shown here are the defaults.
53
54## NAVIGATION AND UI
55
56*CTRL-C*
57 Quit comlink.
58
59*ALT-UP*
60 Select the previous channel or buffer.
61
62*ALT-DOWN*
63 Select the next channel or buffer.
64
65*CTRL-L*
66 Redraw the entire screen.
67
68*PAGE_UP*
69 Scroll the channel up 3 messages.
70
71*PAGE_DOWN*
72 Scroll the channel down 3 messages.
73
74*HOME*
75 Scroll the channel to the most recent message.
76
77*TAB*
78 Open completion options for the last word in the input field. Cycle
79 through options when the completion menu is open.
80
81*SHIFT-TAB*
82 If the compeletion menu is open, cycle through options.
83
84
85
86## EDITING
87
88*CTRL-A*
89 Move the cursor to the beginning of the input field.
90
91*CTRL-E*, *END*
92 Move the cursor to the end of the input field.
93
94*CTRL-B*
95 Move the cursor left one character.
96
97*CTRL-F*
98 Move the cursor right one character.
99
100*CTRL-K*
101 Delete from the cursor to the end of the input field.
102
103*CTRL-U*
104 Delete from the cursor to the start of the input field.
105
106*CTRL-D*
107 Delete the character after the cursor
108
109*ALT-B*, *ALT-LEFT*
110 Move the cursor backwards one word.
111
112*ALT-F*, *ALT-RIGHT*
113 Move the cursor forwards one word.
114
115*CTRL-W*, *ALT-BACKSPACE*
116 Delete the word before the cursor.
117
118*ALT-D*
119 Delete the word after the cursor.
120
121*ENTER*
122 Send the text in the input field.
123
124# SEE ALSO
125
126*comlink*(3), *comlink_connection*(3), *comlink_channel*(3)
127
128# AUTHORS
129
130Written and maintained by Tim Culverhouse <tim@timculverhouse.com>, assisted by
131open source contributors.
132
133# REPORTING BUGS
134
135Bugs may be reported to the mailing list <~rockorager/comlink@lists.sr.ht> or at
136https://github.com/rockorager/comlink.