rnhmjoj
/
nheko
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #908 from tastytea/man-faq-etc 

Fix & enhance man page
This commit is contained in:
DeepBlueV7.X 2022-01-27 12:11:33 +00:00 committed by GitHub
parent 42ae8fa9f2 47b9668ccf
commit e51ec7ff87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 66 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -162,6 +162,27 @@ choco install nheko-reborn
---
**Q:** How do I add stickers and custom emojis?
**A:** Stickers and custom emojis are organized in image packs. There is one
user image pack that only your account has access to and there are room image
packs that are accessible by everyone in the room they are defined in. You can
activate a room image pack globally to use it in any room.
To manage image packs in nheko, go to the room settings and enter the Sticker &
Emote Settings. You will see the Private pack (your user image pack) and can
edit it there. The Shortcode is a unique identifier you use to select the image
with and the Body is the alternate text that is displayed on clients that don't
support images (like the alt tag in HTML images).
If you have the necessary permissions you can create new room packs with the
button at the bottom of the image pack list. They are the same as the user pack
but you can create as many as you want and everyone in the room can use them. It
might be a good idea to create an extra room just for your image packs to make
sharing easier.
---
### Build Requirements
- Qt5 (5.15 or greater). Required for overlapping hover handlers in Qml.

48
man/nheko.1.adoc.in
View File

@ -1,6 +1,6 @@
= nheko(1)
:doctype: manpage
:Date: 2022-01-01
:Date: 2022-01-27
:Revision: @PROJECT_VERSION@
:man source: nheko
:man manual: General Commands Manual
@ -33,9 +33,49 @@ Displays version information.
*--debug*::
Enables debug output.
*-p*, *--profile*::
*-p* _<profile>_, *--profile* _<profile>_::
Creates a unique profile, which allows you to log into several accounts at the
same time and start multiple instances of nheko.
same time and start multiple instances of nheko. Use _default_ to start with the
default profile.
== FAQ
=== How do I add stickers and custom emojis?
Stickers and custom emojis are organized in image packs. There is one user image
pack that only your account has access to and there are room image packs that
are accessible by everyone in the room they are defined in. You can activate a
room image pack globally to use it in any room.
To manage image packs in nheko, go to the room settings and enter the Sticker &
Emote Settings. You will see the Private pack (your user image pack) and can
edit it there. The Shortcode is a unique identifier you use to select the image
with and the Body is the alternate text that is displayed on clients that don't
support images (like the alt tag in HTML images).
If you have the necessary permissions you can create new room packs with the
button at the bottom of the image pack list. They are the same as the user pack
but you can create as many as you want and everyone in the room can use them. It
might be a good idea to create an extra room just for your image packs to make
sharing easier.
== COMPLETERS
Completers spawn a popup with completion candidates when you type them in
the input line.
*@*::
Open username completer.
*#*::
Open room completer.
*:*::
Open unicode emoji picker.
*~*::
Open custom emoji picker. Requires an image pack with custom emojis. Selecting
an emoji will add HTML code for the inline image into the input line.
== KEYBOARD SHORTCUTS
@ -84,6 +124,8 @@ Submit message.
== COMMANDS
Commands only work when they are used at the beginning of text.
=== Custom messages
*/me* _<message>_::