cage
/
tinmop
mirror of https://codeberg.org/cage/tinmop/
1
0
Fork 0
Code Issues

- updating documentation (mentioning navigation keys).

This commit is contained in:
cage 2021-04-28 16:39:54 +02:00
parent 8e924ded74
commit 5a8f8edf87
2 changed files with 25 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/man.org
View File

@ -63,11 +63,9 @@
The screen is subdivided in five window:
- tag window :: shows the tag users subscribed for and available
messages for each tag;
- tag window :: shows the tag users subscribed for and available messages for each tag;
- threads window :: for a given timeline and folder (see
[[Folders]]) show the discussions saved in user's local database;
- threads window :: for a given timeline and folder (see [[Folders]]) show the discussions saved in user's local database;
- conversations window :: show the /private/ conversations the user is having with others;
@ -75,11 +73,13 @@
- command window :: the window where the user instruct the software to perform commands
The main way to interact with the program is using the keyboard.
There is a contextual help that appears when the user input data
that provide hints about commands and a quick help window that can
be shown by hitting ~?~ (if this keybinding has not been
customized).
The main way to interact with the program is using the keyboard. By
default you can move focus to each window (except command window
that can not get focus explicitly) using *'M-arrow key'* (meta is
*ALT* on many keyboards). There is a contextual help that appears
when the user input data that provide hints about commands and a
quick help window that can be shown by hitting ~?~ (if this
keybinding has not been customized).
** Folders
@ -142,6 +142,9 @@
(usually ~/etc/tinmop/~), please check these files for more
information, as they are extensively commented.
Is worth mentioning again that, without an user configuration file,
the program can be used as gemini client.
** Lisp program
These files contains Common lisp (see [[https://common-lisp.net/]])

24
doc/tinmop.man
View File

@ -91,15 +91,11 @@ The screen is subdivided in five window:
.TP
\fBtag window\fP
shows the tag users subscribed for and available
.PP
messages for each tag;
shows the tag users subscribed for and available messages for each tag;
.TP
\fBthreads window\fP
for a given timeline and folder (see
.PP
\fIFolders\fP) show the discussions saved in user's local database;
for a given timeline and folder (see \fIFolders\fP) show the discussions saved in user's local database;
.TP
\fBconversations window\fP
@ -114,11 +110,13 @@ show the body of the message selected in the tag window or gemini page
the window where the user instruct the software to perform commands
.PP
The main way to interact with the program is using the keyboard.
There is a contextual help that appears when the user input data
that provide hints about commands and a quick help window that can
be shown by hitting \fC?\fP (if this keybinding has not been
customized).
The main way to interact with the program is using the keyboard. By
default you can move focus to each window (except command window
that can not get focus explicitly) using \fB'M-arrow key'\fP (meta is
\fBALT\fP on many keyboards). There is a contextual help that appears
when the user input data that provide hints about commands and a
quick help window that can be shown by hitting \fC?\fP (if this
keybinding has not been customized).
.SS "Folders"
.PP
@ -192,6 +190,10 @@ semantics are located in your system wide configuration directory
(usually \fC/etc/tinmop/\fP), please check these files for more
information, as they are extensively commented.
.PP
Is worth mentioning again that, without an user configuration file,
the program can be used as gemini client.
.SS "Lisp program"
.PP
These files contains Common lisp (see \fIhttps://common-lisp.net/\fP)