mirror of
https://codeberg.org/cage/tinmop/
synced 2025-03-07 10:37:37 +01:00
- updated manpage.
This commit is contained in:
cage
parent
c91ec87737
commit
cfbbb4a13e
43
doc/man.org
43
doc/man.org
@ -4,18 +4,24 @@
|
||||
tinmop - a client for gemini or pleroma social network
|
||||
|
||||
* Synopsis
|
||||
tinmop [OPTION]...
|
||||
|
||||
tinmop [OPTION]…
|
||||
|
||||
* Description
|
||||
|
||||
This document assumes basic knowledge of how fediverse works. More
|
||||
information about this topic can be found on the
|
||||
official website ([[https://docs.joinmastodon.org/]]).
|
||||
information about this topic can be found on the following websites:
|
||||
|
||||
- [[https://en.wikipedia.org/wiki/Fediverse]] ;
|
||||
- [[https://pleroma.social/]] ;
|
||||
- [[https://docs.joinmastodon.org/]] .
|
||||
|
||||
|
||||
Tinmop proposes an extensible terminal interface to connect with
|
||||
Pleroma social network or for the gemini protocol
|
||||
|
||||
gemini://gemini.circumlunar.space/
|
||||
- gemini://gemini.circumlunar.space/
|
||||
- [[https://gemini.circumlunar.space/docs/]]
|
||||
|
||||
* Options
|
||||
|
||||
@ -74,6 +80,24 @@
|
||||
|
||||
- command window :: the window where the user instruct the software to perform commands
|
||||
|
||||
|
||||
Using the program in gemini exclusive mode (option *"-G"*) the program layout is simplified:
|
||||
|
||||
#+NAME: screen-layout-gemini-fullscreen
|
||||
#+BEGIN_SRC text
|
||||
|
||||
+------------------------------------------+
|
||||
| |
|
||||
| main window |
|
||||
| |
|
||||
| |
|
||||
| |
|
||||
+------------------------------------------+
|
||||
| command window |
|
||||
+------------------------------------------+
|
||||
|
||||
#+END_SRC
|
||||
|
||||
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
|
||||
@ -308,17 +332,18 @@
|
||||
|
||||
$ tinmop -o gemini://gemini.circumlunar.space
|
||||
|
||||
The program has an inline help (default binding for help is "?")
|
||||
|
||||
You can search the help strings with a command (default: "C-h a").
|
||||
The program has an inline help (default binding for help is "?"), a
|
||||
manpage (default binding to view the manpage is "C-h m") and inline
|
||||
help can be searched (default: "C-h A").
|
||||
|
||||
Moreover you can have some useful hint at the program web page:
|
||||
|
||||
[https://www.autistici.org/interzona/tinmop/]
|
||||
|
||||
* BUGS
|
||||
There are many, totally unknown, hiding in the code! Please help the
|
||||
programmer to nail them using the
|
||||
|
||||
There are many, totally unknown, hiding in the code; this is scary!
|
||||
😱 Please help the programmer to nail them using the
|
||||
[[https://notabug.org/cage/tinmop/issues/][issue tracker]].
|
||||
|
||||
* Contributing
|
||||
|
||||
@ -6,20 +6,29 @@ tinmop - a client for gemini or pleroma social network
|
||||
|
||||
.SH "Synopsis"
|
||||
.PP
|
||||
tinmop [OPTION]...
|
||||
tinmop [OPTION]…
|
||||
|
||||
.SH "Description"
|
||||
.PP
|
||||
This document assumes basic knowledge of how fediverse works. More
|
||||
information about this topic can be found on the
|
||||
official website (\fIhttps://docs.joinmastodon.org/\fP).
|
||||
information about this topic can be found on the following websites:
|
||||
|
||||
.IP \(em 4
|
||||
\fIhttps://en.wikipedia.org/wiki/Fediverse\fP ;
|
||||
.IP \(em 4
|
||||
\fIhttps://pleroma.social/\fP ;
|
||||
.IP \(em 4
|
||||
\fIhttps://docs.joinmastodon.org/\fP .
|
||||
|
||||
|
||||
.PP
|
||||
Tinmop proposes an extensible terminal interface to connect with
|
||||
Pleroma social network or for the gemini protocol
|
||||
|
||||
.PP
|
||||
.IP \(em 4
|
||||
gemini://gemini.circumlunar.space/
|
||||
.IP \(em 4
|
||||
\fIhttps://gemini.circumlunar.space/docs/\fP
|
||||
|
||||
.SH "Options"
|
||||
.PP
|
||||
@ -112,6 +121,27 @@ show the body of the message selected in the tag window or gemini page
|
||||
\fBcommand window\fP
|
||||
the window where the user instruct the software to perform commands
|
||||
|
||||
|
||||
.PP
|
||||
Using the program in gemini exclusive mode (option \fB"-G"\fP) the program layout is simplified:
|
||||
|
||||
.RS
|
||||
.nf
|
||||
\fC
|
||||
+------------------------------------------+
|
||||
| |
|
||||
| main window |
|
||||
| |
|
||||
| |
|
||||
| |
|
||||
+------------------------------------------+
|
||||
| command window |
|
||||
+------------------------------------------+
|
||||
|
||||
\fP
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
The main way to interact with the program is using the keyboard. By
|
||||
default you can move focus to each window (except command window
|
||||
@ -130,28 +160,35 @@ with it:
|
||||
the \fBleft\fP and \fBright\fP arrow keys move the cursor;
|
||||
.IP \(em 4
|
||||
the key \fBhome\fP and \fBend\fP move the cursor to the start and end of
|
||||
.PP
|
||||
the input respectively;
|
||||
.IP \(em 4
|
||||
\fBcanc\fP and \fBbackspace\fP delete the next and previous character
|
||||
.PP
|
||||
respectively;
|
||||
.IP \(em 4
|
||||
the \fBnew line\fP (often called \fBenter\fP key) send the input to the
|
||||
.PP
|
||||
program;
|
||||
.IP \(em 4
|
||||
\fBC-k\fP (that is: "press 'control' and while pressed press 'k')
|
||||
.PP
|
||||
\fIkills\fP (deletes) the text from the cursor position to the end of
|
||||
the input previously typed;
|
||||
.IP \(em 4
|
||||
press \fBM-left\fP and \fBM-right\fP (\fBleft alt\fP and \fBleft\fP or \fBright\fP
|
||||
.PP
|
||||
arrow together) to browse pages of the suggestion window; the
|
||||
suggestion window is a window that holds a previously inputted
|
||||
data that are compatible with the string the user is typing into
|
||||
the command window;
|
||||
.IP \(em 4
|
||||
if suggestions are gemini URI press \fBTAB\fP to input the current
|
||||
.PP
|
||||
selected suggestion;
|
||||
.IP \(em 4
|
||||
if suggestion window is \fBnot\fP rendered, pressing \fBup\fP and \fBdown\fP
|
||||
.PP
|
||||
arrow keys will cycle through input history, if there is not a
|
||||
suggestion window rendered pressing \fBup\fP and \fBdown\fP will scroll
|
||||
on suggestions.
|
||||
@ -358,6 +395,7 @@ There are two ways to add a link to the tour:
|
||||
|
||||
.IP \(em 4
|
||||
when a link window is open and focused pressing \fBt\fP will start a
|
||||
.PP
|
||||
prompt for link indices to be saved in the tour; the prompt expect
|
||||
a simple, comma or space separated, list of indices or index range, index
|
||||
range is a couple of index separated by a dash, example below:
|
||||
@ -369,6 +407,7 @@ range is a couple of index separated by a dash, example below:
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
The string above will save the link index number 1, 2, 3, 5, 8, 9,
|
||||
10, 11, 12 to the tour.
|
||||
|
||||
@ -383,11 +422,13 @@ There are a few more useful command to manipulate the tour:
|
||||
.TP
|
||||
\fBnext-tour-link\fP
|
||||
(\fB'M-t t'\fP or just 't' if a gemini window is focused)
|
||||
.PP
|
||||
follows the next link in the tour;
|
||||
|
||||
.TP
|
||||
\fBshow-tour-links\fP
|
||||
(\fB'M-t s'\fP or just \fB'T'\fP if a gemini window is focused)
|
||||
.PP
|
||||
shows the contents of the tour in a link window
|
||||
|
||||
.TP
|
||||
@ -395,7 +436,7 @@ shows the contents of the tour in a link window
|
||||
(\fB'M-t c'\fP)
|
||||
|
||||
.TP
|
||||
\fBshuffle-tour \fP
|
||||
\fBshuffle-tour\fP
|
||||
(\fB'M-t S'\fP) shuffle the contents of the tour
|
||||
|
||||
.SH "How to get more help"
|
||||
@ -412,10 +453,9 @@ For information about gemini:
|
||||
$ tinmop -o gemini://gemini.circumlunar.space
|
||||
|
||||
.PP
|
||||
The program has an inline help (default binding for help is "?")
|
||||
|
||||
.PP
|
||||
You can search the help strings with a command (default: "C-h a").
|
||||
The program has an inline help (default binding for help is "?"), a
|
||||
manpage (default binding to view the manpage is "C-h m") and inline
|
||||
help can be searched (default: "C-h A").
|
||||
|
||||
.PP
|
||||
Moreover you can have some useful hint at the program web page:
|
||||
@ -425,8 +465,8 @@ Moreover you can have some useful hint at the program web page:
|
||||
|
||||
.SH "BUGS"
|
||||
.PP
|
||||
There are many, totally unknown, hiding in the code! Please help the
|
||||
programmer to nail them using the
|
||||
There are many, totally unknown, hiding in the code; this is scary!
|
||||
😱 Please help the programmer to nail them using the
|
||||
https://notabug.org/cage/tinmop/issues/ \fBat\fP \fIissue tracker\fP.
|
||||
|
||||
.SH "Contributing"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user