1NHEKO(1)                    General Commands Manual                   NHEKO(1)
2
3
4

NAME

6       nheko - Desktop client for Matrix using Qt and C++17
7

SYNOPSIS

9       nheko [OPTIONS]
10

DESCRIPTION

12       The motivation behind the project is to provide a native desktop app
13       for Matrix that feels more like a mainstream chat app (Element,
14       Telegram etc) and less like an IRC client.
15

OPTIONS

17       -h, --help
18           Displays help on commandline options.
19
20       --help-all
21           Displays help including Qt specific options.
22
23       -v, --version
24           Displays version information.
25
26       --debug
27           Enables debug output.
28
29       -p <profile>, --profile <profile>
30           Creates a unique profile, which allows you to log into several
31           accounts at the same time and start multiple instances of nheko.
32           Use default to start with the default profile.
33

FAQ

35   How do I add stickers and custom emojis?
36       Stickers and custom emojis are organized in image packs. There is one
37       user image pack that only your account has access to and there are room
38       image packs that are accessible by everyone in the room they are
39       defined in. You can activate a room image pack globally to use it in
40       any room.
41
42       To manage image packs in nheko, go to the room settings and enter the
43       Sticker & Emote Settings. You will see the Private pack (your user
44       image pack) and can edit it there. The Shortcode is a unique identifier
45       you use to select the image with and the Body is the alternate text
46       that is displayed on clients that don’t support images (like the alt
47       tag in HTML images).
48
49       If you have the necessary permissions you can create new room packs
50       with the button at the bottom of the image pack list. They are the same
51       as the user pack but you can create as many as you want and everyone in
52       the room can use them. It might be a good idea to create an extra room
53       just for your image packs to make sharing easier.
54

COMPLETERS

56       Completers spawn a popup with completion candidates when you type them
57       in the input line.
58
59       @
60           Open username completer.
61
62       #
63           Open room completer.
64
65       :
66           Open unicode emoji picker.
67
68       ~
69           Open custom emoji picker. Requires an image pack with custom
70           emojis. Selecting an emoji will add HTML code for the inline image
71           into the input line.
72

KEYBOARD SHORTCUTS

74   Room list
75       Ctrl-Up/Ctrl-Down
76           Navigate within the room list.
77
78       Ctrl-K
79           Search and select rooms from the room list.
80
81       Alt-A, Ctrl-Shift-A
82           Select next room with activity.
83
84   Timeline/Messaging
85       PgUp/PgDn
86           Scroll timeline per page.
87
88       Alt-Up/Alt-Down
89           Reply to a message.
90
91       Up/Down
92           Edit a message.
93
94       Ctrl-E
95           Edit message currently selected as reply.
96
97       Alt-F
98           Forward message currently selected as reply.
99
100       Ctrl-P/Ctrl-N
101           Reenter previous/next message.
102
103       Ctrl-U
104           Delete everything in the input line.
105
106       Ctrl-Left/Ctrl-Right
107           Jump one word left/right in the input line.
108
109       Shift-Enter
110           Insert line break.
111
112       Enter
113           Submit message.
114

COMMANDS

116       Commands only work when they are used at the beginning of text.
117
118   Custom messages
119       /me <message>
120           Send a message as an emote, where your username is prefixed.
121
122       /react <text>
123           Send a message as a reaction when you’re replying to a message.
124
125       /md <message>
126           Force Markdown when sending the current message.
127
128       /plain <message>
129           Force plain text when sending the current message.
130
131       /rainbow <message>
132           Send a message in rainbow colors.
133
134       /rainbowme <message>
135           Send a message as a rainbow-colored emote, where your username is
136           prefixed.
137
138       /notice <message>
139           Send a message as a notice.
140
141       /rainbownotice <notice>
142           Send a message as a rainbow-colored notice.
143
144   Room management
145       /join <roomname>
146           Join a room.
147
148       /part, /leave
149           Leave the current room.
150
151       /invite <username> [reason]
152           Invite a user into the current room.  reason is optional.
153
154       /kick <username> [reason]
155           Kick a user from the current room.  reason is optional.
156
157       /ban <username> [reason]
158           Ban a user from the current room.  reason is optional.
159
160       /unban <username> [reason]
161           Unban a user.  reason is optional.
162
163       /roomnick <roomname>
164           Change your nickname in a single room.
165
166   Emoticons
167       /shrug [message]
168           Inserts ¯\_(ツ)_/¯ followed by an optional message.
169
170       /fliptable
171           Inserts (╯°□°)╯︵ ┻━┻
172
173       /unfliptable
174           Inserts ┯━┯╭( º _ º╭)
175
176       /sovietflip
177           Inserts ノ┬─┬ノ ︵ ( \\o°o)\\
178
179   Advanced
180       /clear-timeline
181           Removes all but the most recent messages from the currently
182           rendered timeline and then refetches it from the server; can be
183           used to fix some cache issues.
184
185       /reset-state
186           Fetches all the state events in the current room again; can be used
187           to fix some cache issues.
188
189       /rotate-megolm-session
190           Rotates the encryption key used to send encrypted messages in a
191           room.
192
193       /goto <address>
194           address can be one of:
195
196           <event ID>
197               Jumps to event with the specified ID and highlights it.
198
199           <message index>
200               Jumps to the message with the specified index and highlights
201               it.
202
203           <Matrix URI>
204               Handles Matrix URI as if you clicked on it.
205
206       /converttodm
207           Converts a room to a direct conversation.
208
209       /converttoroom
210           Converts a direct conversation to a normal room.
211

FILES

213       Configuration file
214           ${XDG_CONFIG_HOME:-~/.config}/nheko/nheko.conf
215
216       Log file
217           ${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/nheko.log
218
219       Database
220           ${XDG_DATA_HOME:-~/.local/share}/nheko/nheko/*/data.mdb
221
222       Media cache
223           ${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/media_cache
224

REPORTING BUGS

226       Please report issues on our bug tracker at
227       https://github.com/Nheko-Reborn/nheko/issues.
228
229
230
231nheko 0.9.3                       2022-01-27                          NHEKO(1)
Impressum