From 4210fe1925e8d576ecaa66ff22307919e47739c2 Mon Sep 17 00:00:00 2001 From: tastytea Date: Thu, 27 Jan 2022 14:02:25 +0100 Subject: Rename man page so GitHub renders it. --- man/CMakeLists.txt | 2 +- man/nheko.1.adoc | 238 ++++++++++++++++++++++++++++++++++++++++++++++++++++ man/nheko.1.adoc.in | 238 ---------------------------------------------------- 3 files changed, 239 insertions(+), 239 deletions(-) create mode 100644 man/nheko.1.adoc delete mode 100644 man/nheko.1.adoc.in diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt index aadeb15b..9ae5cbe5 100644 --- a/man/CMakeLists.txt +++ b/man/CMakeLists.txt @@ -2,7 +2,7 @@ include(GNUInstallDirs) -configure_file("${PROJECT_NAME}.1.adoc.in" "${PROJECT_NAME}.1.adoc" @ONLY) +configure_file("${PROJECT_NAME}.1.adoc" "${PROJECT_NAME}.1.adoc" @ONLY) find_program (ASCIIDOC_COMPILER a2x) if (NOT ASCIIDOC_COMPILER) diff --git a/man/nheko.1.adoc b/man/nheko.1.adoc new file mode 100644 index 00000000..fe3ff3b3 --- /dev/null +++ b/man/nheko.1.adoc @@ -0,0 +1,238 @@ += nheko(1) +:doctype: manpage +:Date: 2022-01-27 +:Revision: @PROJECT_VERSION@ +:man source: nheko +:man manual: General Commands Manual + +== NAME + +nheko - Desktop client for Matrix using Qt and C++17 + +== SYNOPSIS + +*nheko* [_OPTIONS_] + +== DESCRIPTION + +The motivation behind the project is to provide a native desktop app for Matrix +that feels more like a mainstream chat app (Element, Telegram etc) and less like +an IRC client. + +== OPTIONS + +*-h*, *--help*:: +Displays help on commandline options. + +*--help-all*:: +Displays help including Qt specific options. + +*-v*, *--version*:: +Displays version information. + +*--debug*:: +Enables debug output. + +*-p* __, *--profile* __:: +Creates a unique profile, which allows you to log into several accounts at the +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 + +=== Room list + +*Ctrl-Up/Ctrl-Down*:: +Navigate within the room list. + +*Ctrl-K*:: +Search and select rooms from the room list. + +*Alt-A*, *Ctrl-Shift-A*:: +Select next room with activity. + +=== Timeline/Messaging + +*PgUp/PgDn*:: +Scroll timeline per page. + +*Alt-Up/Alt-Down*:: +Reply to a message. + +*Up/Down*:: +Edit a message. + +*Ctrl-E*:: +Edit message currently selected as reply. + +*Alt-F*:: +Forward message currently selected as reply. + +*Ctrl-P/Ctrl-N*:: +Reenter previous/next message. + +*Ctrl-U*:: +Delete everything in the input line. + +*Ctrl-Left/Ctrl-Right*:: +Jump one word left/right in the input line. + +*Shift-Enter*:: +Insert line break. + +*Enter*:: +Submit message. + +== COMMANDS + +Commands only work when they are used at the beginning of text. + +=== Custom messages + +*/me* __:: +Send a message as an emote, where your username is prefixed. + +*/react* __:: +Send a message as a reaction when you’re replying to a message. + +*/md* __:: +Force Markdown when sending the current message. + +*/plain* __:: +Force plain text when sending the current message. + +*/rainbow* __:: +Send a message in rainbow colors. + +*/rainbowme* __:: +Send a message as a rainbow-colored emote, where your username is prefixed. + +*/notice* __:: +Send a message as a notice. + +*/rainbownotice* __:: +Send a message as a rainbow-colored notice. + +=== Room management + +*/join* __:: +Join a room. + +*/part*, */leave*:: +Leave the current room. + +*/invite* __ _[reason]_:: +Invite a user into the current room. _reason_ is optional. + +*/kick* __ _[reason]_:: +Kick a user from the current room. _reason_ is optional. + +*/ban* __ _[reason]_:: +Ban a user from the current room. _reason_ is optional. + +*/unban* __ _[reason]_:: +Unban a user. _reason_ is optional. + +*/roomnick* __:: +Change your nickname in a single room. + +=== Emoticons + +*/shrug* _[message]_:: +Inserts `¯\_(ツ)_/¯` followed by an optional _message_. + +*/fliptable*:: +Inserts `(╯°□°)╯︵ ┻━┻` + +*/unfliptable*:: +Inserts `┯━┯╭( º _ º╭)` + +*/sovietflip*:: +Inserts `ノ┬─┬ノ ︵ ( \\o°o)\\` + +=== Advanced + +*/clear-timeline*:: +Removes all but the most recent messages from the currently rendered timeline +and then refetches it from the server; can be used to fix some cache issues. + +*/rotate-megolm-session*:: +Rotates the encryption key used to send encrypted messages in a room. + +*/goto* _
_:: + +_address_ can be one of: + + __;; + Jumps to event with the specified ID and highlights it. + + __;; + Jumps to the message with the specified index and highlights it. + + __;; + Handles Matrix URI as if you clicked on it. + +*/converttodm*:: +Converts a room to a direct conversation. + +*/converttoroom*:: +Converts a direct conversation to a normal room. + +== FILES + +*Configuration file*:: +`${XDG_CONFIG_HOME:-~/.config}/nheko/nheko.conf` + +*Log file*:: +`${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/nheko.log` + +*Database*:: +`${XDG_DATA_HOME:-~/.local/share}/nheko/nheko/*/data.mdb` + +*Media cache*:: +`${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/media_cache` + + +== REPORTING BUGS + +Please report issues on our bug tracker at +. diff --git a/man/nheko.1.adoc.in b/man/nheko.1.adoc.in deleted file mode 100644 index fe3ff3b3..00000000 --- a/man/nheko.1.adoc.in +++ /dev/null @@ -1,238 +0,0 @@ -= nheko(1) -:doctype: manpage -:Date: 2022-01-27 -:Revision: @PROJECT_VERSION@ -:man source: nheko -:man manual: General Commands Manual - -== NAME - -nheko - Desktop client for Matrix using Qt and C++17 - -== SYNOPSIS - -*nheko* [_OPTIONS_] - -== DESCRIPTION - -The motivation behind the project is to provide a native desktop app for Matrix -that feels more like a mainstream chat app (Element, Telegram etc) and less like -an IRC client. - -== OPTIONS - -*-h*, *--help*:: -Displays help on commandline options. - -*--help-all*:: -Displays help including Qt specific options. - -*-v*, *--version*:: -Displays version information. - -*--debug*:: -Enables debug output. - -*-p* __, *--profile* __:: -Creates a unique profile, which allows you to log into several accounts at the -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 - -=== Room list - -*Ctrl-Up/Ctrl-Down*:: -Navigate within the room list. - -*Ctrl-K*:: -Search and select rooms from the room list. - -*Alt-A*, *Ctrl-Shift-A*:: -Select next room with activity. - -=== Timeline/Messaging - -*PgUp/PgDn*:: -Scroll timeline per page. - -*Alt-Up/Alt-Down*:: -Reply to a message. - -*Up/Down*:: -Edit a message. - -*Ctrl-E*:: -Edit message currently selected as reply. - -*Alt-F*:: -Forward message currently selected as reply. - -*Ctrl-P/Ctrl-N*:: -Reenter previous/next message. - -*Ctrl-U*:: -Delete everything in the input line. - -*Ctrl-Left/Ctrl-Right*:: -Jump one word left/right in the input line. - -*Shift-Enter*:: -Insert line break. - -*Enter*:: -Submit message. - -== COMMANDS - -Commands only work when they are used at the beginning of text. - -=== Custom messages - -*/me* __:: -Send a message as an emote, where your username is prefixed. - -*/react* __:: -Send a message as a reaction when you’re replying to a message. - -*/md* __:: -Force Markdown when sending the current message. - -*/plain* __:: -Force plain text when sending the current message. - -*/rainbow* __:: -Send a message in rainbow colors. - -*/rainbowme* __:: -Send a message as a rainbow-colored emote, where your username is prefixed. - -*/notice* __:: -Send a message as a notice. - -*/rainbownotice* __:: -Send a message as a rainbow-colored notice. - -=== Room management - -*/join* __:: -Join a room. - -*/part*, */leave*:: -Leave the current room. - -*/invite* __ _[reason]_:: -Invite a user into the current room. _reason_ is optional. - -*/kick* __ _[reason]_:: -Kick a user from the current room. _reason_ is optional. - -*/ban* __ _[reason]_:: -Ban a user from the current room. _reason_ is optional. - -*/unban* __ _[reason]_:: -Unban a user. _reason_ is optional. - -*/roomnick* __:: -Change your nickname in a single room. - -=== Emoticons - -*/shrug* _[message]_:: -Inserts `¯\_(ツ)_/¯` followed by an optional _message_. - -*/fliptable*:: -Inserts `(╯°□°)╯︵ ┻━┻` - -*/unfliptable*:: -Inserts `┯━┯╭( º _ º╭)` - -*/sovietflip*:: -Inserts `ノ┬─┬ノ ︵ ( \\o°o)\\` - -=== Advanced - -*/clear-timeline*:: -Removes all but the most recent messages from the currently rendered timeline -and then refetches it from the server; can be used to fix some cache issues. - -*/rotate-megolm-session*:: -Rotates the encryption key used to send encrypted messages in a room. - -*/goto* _
_:: - -_address_ can be one of: - - __;; - Jumps to event with the specified ID and highlights it. - - __;; - Jumps to the message with the specified index and highlights it. - - __;; - Handles Matrix URI as if you clicked on it. - -*/converttodm*:: -Converts a room to a direct conversation. - -*/converttoroom*:: -Converts a direct conversation to a normal room. - -== FILES - -*Configuration file*:: -`${XDG_CONFIG_HOME:-~/.config}/nheko/nheko.conf` - -*Log file*:: -`${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/nheko.log` - -*Database*:: -`${XDG_DATA_HOME:-~/.local/share}/nheko/nheko/*/data.mdb` - -*Media cache*:: -`${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/media_cache` - - -== REPORTING BUGS - -Please report issues on our bug tracker at -. -- cgit 1.5.1