docs: add man page (#290)
This commit is contained in:
parent
f8c5805794
commit
09f8a48298
2 changed files with 134 additions and 0 deletions
70
man/discordo.1
Normal file
70
man/discordo.1
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
.nh
|
||||
.TH discordo 1
|
||||
.SH NAME
|
||||
.PP
|
||||
\fB\fCdiscordo\fR - A lightweight, secure, and feature-rich Discord terminal client
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fB\fCdiscordo\fR [\fB\fC--token "TOKEN"\fR]
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
\fB\fCdiscordo\fR is a lightweight, secure, and feature-rich Discord terminal client.
|
||||
|
||||
.PP
|
||||
If no token is provided, you will be prompted with an interactive login.
|
||||
.br
|
||||
The token is stored securely in the default OS-specific keyring.
|
||||
|
||||
.SH USAGE
|
||||
.PP
|
||||
The default keybindings in the app are as follow
|
||||
|
||||
.SS Guilds Tree
|
||||
.TS
|
||||
allbox;
|
||||
l l
|
||||
l l .
|
||||
\fB\fCAction\fR \fB\fCKeybinding\fR
|
||||
Focus Alt + g
|
||||
.TE
|
||||
|
||||
.SS Messages Text
|
||||
.TS
|
||||
allbox;
|
||||
l l
|
||||
l l .
|
||||
\fB\fCAction\fR \fB\fCKeybinding\fR
|
||||
Focus Alt + m
|
||||
Show image i
|
||||
Copy message content c
|
||||
Reply without mention r
|
||||
Reply with mention R
|
||||
Select reply s
|
||||
Reply previous Up arrow
|
||||
Select next Down arrow
|
||||
Select first Home
|
||||
Select last End
|
||||
.TE
|
||||
|
||||
.SS Message Input
|
||||
.TS
|
||||
allbox;
|
||||
l l
|
||||
l l .
|
||||
\fB\fCAction\fR \fB\fCKeybinding\fR
|
||||
Focus Alt + i
|
||||
Send message Enter
|
||||
Paste from clipboard Ctrl + v
|
||||
Launch editor Ctrl + e
|
||||
.TE
|
||||
|
||||
.SH FILES
|
||||
.PP
|
||||
\fI$HOME/.config/discordo/config.yml\fP
|
||||
The configuration file.
|
||||
|
||||
.PP
|
||||
\fI$HOME/.cache/discordo/logs.txt\fP
|
||||
The log file.
|
||||
64
man/discordo.md
Normal file
64
man/discordo.md
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
discordo 1
|
||||
=======================================
|
||||
|
||||
NAME
|
||||
----
|
||||
|
||||
`discordo` - A lightweight, secure, and feature-rich Discord terminal client
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
`discordo` [`--token "TOKEN"`]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
`discordo` is a lightweight, secure, and feature-rich Discord terminal client.
|
||||
|
||||
If no token is provided, you will be prompted with an interactive login.
|
||||
The token is stored securely in the default OS-specific keyring.
|
||||
|
||||
USAGE
|
||||
-------
|
||||
|
||||
The default keybindings in the app are as follow
|
||||
|
||||
### Guilds Tree
|
||||
|
||||
| Action | Keybinding |
|
||||
| ------ | ---------- |
|
||||
| Focus | Alt + g |
|
||||
|
||||
### Messages Text
|
||||
|
||||
| Action | Keybinding |
|
||||
| --------------------- | ---------- |
|
||||
| Focus | Alt + m |
|
||||
| Show image | i |
|
||||
| Copy message content | c |
|
||||
| Reply without mention | r |
|
||||
| Reply with mention | R |
|
||||
| Select reply | s |
|
||||
| Reply previous | Up arrow |
|
||||
| Select next | Down arrow |
|
||||
| Select first | Home |
|
||||
| Select last | End |
|
||||
|
||||
### Message Input
|
||||
|
||||
| Action | Keybinding |
|
||||
| -------------------- | ---------- |
|
||||
| Focus | Alt + i |
|
||||
| Send message | Enter |
|
||||
| Paste from clipboard | Ctrl + v |
|
||||
| Launch editor | Ctrl + e |
|
||||
|
||||
FILES
|
||||
-----
|
||||
|
||||
*$HOME/.config/discordo/config.yml*
|
||||
The configuration file.
|
||||
|
||||
*$HOME/.cache/discordo/logs.txt*
|
||||
The log file.
|
||||
Loading…
Add table
Reference in a new issue