mirror of https://codeberg.org/cage/tinmop/
- updated manpage.
This commit is contained in:
parent
c91ec87737
commit
cfbbb4a13e
175
doc/man.org
175
doc/man.org
|
@ -4,18 +4,24 @@
|
||||||
tinmop - a client for gemini or pleroma social network
|
tinmop - a client for gemini or pleroma social network
|
||||||
|
|
||||||
* Synopsis
|
* Synopsis
|
||||||
tinmop [OPTION]...
|
|
||||||
|
tinmop [OPTION]…
|
||||||
|
|
||||||
* Description
|
* Description
|
||||||
|
|
||||||
This document assumes basic knowledge of how fediverse works. More
|
This document assumes basic knowledge of how fediverse works. More
|
||||||
information about this topic can be found on the
|
information about this topic can be found on the following websites:
|
||||||
official website ([[https://docs.joinmastodon.org/]]).
|
|
||||||
|
|
||||||
Tinmop proposes an extensible terminal interface to connect with
|
- [[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
|
Pleroma social network or for the gemini protocol
|
||||||
|
|
||||||
gemini://gemini.circumlunar.space/
|
- gemini://gemini.circumlunar.space/
|
||||||
|
- [[https://gemini.circumlunar.space/docs/]]
|
||||||
|
|
||||||
* Options
|
* Options
|
||||||
|
|
||||||
|
@ -66,7 +72,7 @@
|
||||||
|
|
||||||
- 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;
|
- conversations window :: show the /private/ conversations the user is having with others;
|
||||||
|
|
||||||
|
@ -74,40 +80,58 @@
|
||||||
|
|
||||||
- command window :: the window where the user instruct the software to perform commands
|
- 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. By
|
|
||||||
default you can move focus to each window (except command window
|
Using the program in gemini exclusive mode (option *"-G"*) the program layout is simplified:
|
||||||
that can not get focus explicitly) using *'M-arrow key'* (meta is
|
|
||||||
*ALT* on many keyboards). There is a contextual help that appears
|
#+NAME: screen-layout-gemini-fullscreen
|
||||||
when the user input data that provide hints about commands and a
|
#+BEGIN_SRC text
|
||||||
quick help window that can be shown by hitting ~?~ (if this
|
|
||||||
|
+------------------------------------------+
|
||||||
|
| |
|
||||||
|
| 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
|
||||||
|
*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).
|
keybinding has not been customized).
|
||||||
|
|
||||||
** Command window keys
|
** Command window keys
|
||||||
|
|
||||||
The command window has a few hardcoded command keys to interact
|
The command window has a few hardcoded command keys to interact
|
||||||
with it:
|
with it:
|
||||||
|
|
||||||
- the *left* and *right* arrow keys move the cursor;
|
- the *left* and *right* arrow keys move the cursor;
|
||||||
- the key *home* and *end* move the cursor to the start and end of
|
- the key *home* and *end* move the cursor to the start and end of
|
||||||
the input respectively;
|
the input respectively;
|
||||||
- *canc* and *backspace* delete the next and previous character
|
- *canc* and *backspace* delete the next and previous character
|
||||||
respectively;
|
respectively;
|
||||||
- the *new line* (often called *enter* key) send the input to the
|
- the *new line* (often called *enter* key) send the input to the
|
||||||
program;
|
program;
|
||||||
- *C-k* (that is: "press 'control' and while pressed press 'k')
|
- *C-k* (that is: "press 'control' and while pressed press 'k')
|
||||||
/kills/ (deletes) the text from the cursor position to the end of
|
/kills/ (deletes) the text from the cursor position to the end of
|
||||||
the input previously typed;
|
the input previously typed;
|
||||||
- press *M-left* and *M-right* (*left alt* and *left* or *right*
|
- press *M-left* and *M-right* (*left alt* and *left* or *right*
|
||||||
arrow together) to browse pages of the suggestion window; the
|
arrow together) to browse pages of the suggestion window; the
|
||||||
suggestion window is a window that holds a previously inputted
|
suggestion window is a window that holds a previously inputted
|
||||||
data that are compatible with the string the user is typing into
|
data that are compatible with the string the user is typing into
|
||||||
the command window;
|
the command window;
|
||||||
- if suggestions are gemini URI press *TAB* to input the current
|
- if suggestions are gemini URI press *TAB* to input the current
|
||||||
selected suggestion;
|
selected suggestion;
|
||||||
- if suggestion window is *not* rendered, pressing *up* and *down*
|
- if suggestion window is *not* rendered, pressing *up* and *down*
|
||||||
arrow keys will cycle through input history, if there is not a
|
arrow keys will cycle through input history, if there is not a
|
||||||
suggestion window rendered pressing *up* and *down* will scroll
|
suggestion window rendered pressing *up* and *down* will scroll
|
||||||
on suggestions.
|
on suggestions.
|
||||||
|
|
||||||
** Folders
|
** Folders
|
||||||
|
|
||||||
|
@ -150,10 +174,10 @@
|
||||||
|
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Not incidentally the information in the example above are the
|
Not incidentally the information in the example above are the
|
||||||
absolute minimum the user has to provide before starts the program
|
absolute minimum the user has to provide before starts the program
|
||||||
and connect to pleroma (to use tinmop as a gemini browser only an
|
and connect to pleroma (to use tinmop as a gemini browser only an
|
||||||
empty file will suffice): the name you chose when you made the
|
empty file will suffice): the name you chose when you made the
|
||||||
account on the server and the address of the server.
|
account on the server and the address of the server.
|
||||||
|
|
||||||
As you can see a line starting with a *#* is considered comment and
|
As you can see a line starting with a *#* is considered comment and
|
||||||
|
@ -207,13 +231,13 @@
|
||||||
once: when the program starts for the first time (but please note
|
once: when the program starts for the first time (but please note
|
||||||
that there must be a file with valid credentials available).
|
that there must be a file with valid credentials available).
|
||||||
|
|
||||||
There is no additional steps to follow to connect to gemspace,
|
There is no additional steps to follow to connect to gemspace,
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
* Gempub support
|
* Gempub support
|
||||||
|
|
||||||
Tinmop maintains a gempub library scanning a directory on your
|
Tinmop maintains a gempub library scanning a directory on your
|
||||||
file system (library directory); the library directory path can be
|
file system (library directory); the library directory path can be
|
||||||
set using the configuration directive:
|
set using the configuration directive:
|
||||||
|
|
||||||
#+BEGIN_SRC text
|
#+BEGIN_SRC text
|
||||||
|
@ -222,11 +246,11 @@
|
||||||
|
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
the default value is ~$XDG_DATA_HOME~ (usually something like
|
the default value is ~$XDG_DATA_HOME~ (usually something like
|
||||||
~$HOME/.local/share/tinmop/~).
|
~$HOME/.local/share/tinmop/~).
|
||||||
|
|
||||||
Using *'M-g g l'* the library can be inspected using a simple query
|
Using *'M-g g l'* the library can be inspected using a simple query
|
||||||
language (similar to SQL) that search in the metadata of the gempub
|
language (similar to SQL) that search in the metadata of the gempub
|
||||||
files, example of query follows:
|
files, example of query follows:
|
||||||
|
|
||||||
#+BEGIN_SRC text
|
#+BEGIN_SRC text
|
||||||
|
@ -248,55 +272,55 @@
|
||||||
- published;
|
- published;
|
||||||
- copyright.
|
- copyright.
|
||||||
|
|
||||||
You can use ~< > = != <= >= like~ operators for comparison and the
|
You can use ~< > = != <= >= like~ operators for comparison and the
|
||||||
two logical operator ~and~ and ~or~, the character ~%~ act like a
|
two logical operator ~and~ and ~or~, the character ~%~ act like a
|
||||||
wildcard and means: /'any sequence of character'/.
|
wildcard and means: /'any sequence of character'/.
|
||||||
|
|
||||||
Note that the right hand side of the operator must be wrapped in
|
Note that the right hand side of the operator must be wrapped in
|
||||||
quotes.
|
quotes.
|
||||||
|
|
||||||
After the search is performed a window with the results is shown,
|
After the search is performed a window with the results is shown,
|
||||||
selecting an item of this window will open the gempub and will add
|
selecting an item of this window will open the gempub and will add
|
||||||
all its table of contents on the tour mode, so that the book could
|
all its table of contents on the tour mode, so that the book could
|
||||||
be browsed.
|
be browsed.
|
||||||
|
|
||||||
For more information on tour mode see below or use
|
For more information on tour mode see below or use
|
||||||
*'C-h A <enter> tour mode'*.
|
*'C-h A <enter> tour mode'*.
|
||||||
|
|
||||||
* Tour mode
|
* Tour mode
|
||||||
|
|
||||||
Tinmop maintains a queue of links that can be then visited by the
|
Tinmop maintains a queue of links that can be then visited by the
|
||||||
user, this queue is called *tour*.
|
user, this queue is called *tour*.
|
||||||
|
|
||||||
There are two ways to add a link to the tour:
|
There are two ways to add a link to the tour:
|
||||||
|
|
||||||
- when a link window is open and focused pressing *t* will start a
|
- when a link window is open and focused pressing *t* will start a
|
||||||
prompt for link indices to be saved in the tour; the prompt expect
|
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
|
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:
|
range is a couple of index separated by a dash, example below:
|
||||||
|
|
||||||
#+BEGIN_SRC text
|
#+BEGIN_SRC text
|
||||||
1 2 5 8-12
|
1 2 5 8-12
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
The string above will save the link index number 1, 2, 3, 5, 8, 9,
|
The string above will save the link index number 1, 2, 3, 5, 8, 9,
|
||||||
10, 11, 12 to the tour.
|
10, 11, 12 to the tour.
|
||||||
|
|
||||||
The other way to add links to the tour is using the command
|
The other way to add links to the tour is using the command
|
||||||
*'gemlog-add-unread-posts-tour'* (default keychord: *'M-g s t a'*)
|
*'gemlog-add-unread-posts-tour'* (default keychord: *'M-g s t a'*)
|
||||||
that will add all the unread posts to the tour.
|
that will add all the unread posts to the tour.
|
||||||
|
|
||||||
There are a few more useful command to manipulate the tour:
|
There are a few more useful command to manipulate the tour:
|
||||||
|
|
||||||
- next-tour-link :: (*'M-t t'* or just 't' if a gemini window is focused)
|
- next-tour-link :: (*'M-t t'* or just 't' if a gemini window is focused)
|
||||||
follows the next link in the tour;
|
follows the next link in the tour;
|
||||||
|
|
||||||
- show-tour-links :: (*'M-t s'* or just *'T'* if a gemini window is focused)
|
- show-tour-links :: (*'M-t s'* or just *'T'* if a gemini window is focused)
|
||||||
shows the contents of the tour in a link window
|
shows the contents of the tour in a link window
|
||||||
|
|
||||||
- clean-all-tour :: (*'M-t c'*)
|
- clean-all-tour :: (*'M-t c'*)
|
||||||
|
|
||||||
- shuffle-tour :: (*'M-t S'*) shuffle the contents of the tour
|
- shuffle-tour :: (*'M-t S'*) shuffle the contents of the tour
|
||||||
|
|
||||||
* How to get more help
|
* How to get more help
|
||||||
|
|
||||||
|
@ -308,17 +332,18 @@
|
||||||
|
|
||||||
$ tinmop -o gemini://gemini.circumlunar.space
|
$ tinmop -o gemini://gemini.circumlunar.space
|
||||||
|
|
||||||
The program has an inline help (default binding for help is "?")
|
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
|
||||||
You can search the help strings with a command (default: "C-h a").
|
help can be searched (default: "C-h A").
|
||||||
|
|
||||||
Moreover you can have some useful hint at the program web page:
|
Moreover you can have some useful hint at the program web page:
|
||||||
|
|
||||||
[https://www.autistici.org/interzona/tinmop/]
|
[https://www.autistici.org/interzona/tinmop/]
|
||||||
|
|
||||||
* BUGS
|
* 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]].
|
[[https://notabug.org/cage/tinmop/issues/][issue tracker]].
|
||||||
|
|
||||||
* Contributing
|
* Contributing
|
||||||
|
@ -356,11 +381,11 @@
|
||||||
|
|
||||||
* Privacy
|
* Privacy
|
||||||
|
|
||||||
The author of this software collects no user data information with
|
The author of this software collects no user data information with
|
||||||
this software.
|
this software.
|
||||||
|
|
||||||
But this software is a client to connect and interact to one or more
|
But this software is a client to connect and interact to one or more
|
||||||
remote computer. So potentially it could share a lot of information
|
remote computer. So potentially it could share a lot of information
|
||||||
with other actors but just after the user allowed it to do so.
|
with other actors but just after the user allowed it to do so.
|
||||||
|
|
||||||
It is the user responsibility to checks the privacy conditions of the
|
It is the user responsibility to checks the privacy conditions of the
|
||||||
|
@ -369,8 +394,8 @@
|
||||||
By default, pressing "!" will contact the remote service located at:
|
By default, pressing "!" will contact the remote service located at:
|
||||||
"gemini://houston.coder.town/search".
|
"gemini://houston.coder.town/search".
|
||||||
|
|
||||||
Moreover launching ~quick_quicklisp.sh~ will contact
|
Moreover launching ~quick_quicklisp.sh~ will contact
|
||||||
[[https://www.quicklisp.org/]], check the
|
[[https://www.quicklisp.org/]], check the
|
||||||
[[https://beta.quicklisp.org/quicklisp.lisp][quicklisp sources]] for
|
[[https://beta.quicklisp.org/quicklisp.lisp][quicklisp sources]] for
|
||||||
details.
|
details.
|
||||||
|
|
||||||
|
|
156
doc/tinmop.man
156
doc/tinmop.man
|
@ -6,20 +6,29 @@ tinmop - a client for gemini or pleroma social network
|
||||||
|
|
||||||
.SH "Synopsis"
|
.SH "Synopsis"
|
||||||
.PP
|
.PP
|
||||||
tinmop [OPTION]...
|
tinmop [OPTION]…
|
||||||
|
|
||||||
.SH "Description"
|
.SH "Description"
|
||||||
.PP
|
.PP
|
||||||
This document assumes basic knowledge of how fediverse works. More
|
This document assumes basic knowledge of how fediverse works. More
|
||||||
information about this topic can be found on the
|
information about this topic can be found on the following websites:
|
||||||
official website (\fIhttps://docs.joinmastodon.org/\fP).
|
|
||||||
|
.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
|
.PP
|
||||||
Tinmop proposes an extensible terminal interface to connect with
|
Tinmop proposes an extensible terminal interface to connect with
|
||||||
Pleroma social network or for the gemini protocol
|
Pleroma social network or for the gemini protocol
|
||||||
|
|
||||||
.PP
|
.IP \(em 4
|
||||||
gemini://gemini.circumlunar.space/
|
gemini://gemini.circumlunar.space/
|
||||||
|
.IP \(em 4
|
||||||
|
\fIhttps://gemini.circumlunar.space/docs/\fP
|
||||||
|
|
||||||
.SH "Options"
|
.SH "Options"
|
||||||
.PP
|
.PP
|
||||||
|
@ -98,7 +107,7 @@ shows the tag users subscribed for and available messages for each tag;
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fBthreads window\fP
|
\fBthreads window\fP
|
||||||
for a given timeline and folder (see \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
|
.TP
|
||||||
\fBconversations window\fP
|
\fBconversations window\fP
|
||||||
|
@ -112,48 +121,76 @@ show the body of the message selected in the tag window or gemini page
|
||||||
\fBcommand window\fP
|
\fBcommand window\fP
|
||||||
the window where the user instruct the software to perform commands
|
the window where the user instruct the software to perform commands
|
||||||
|
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
The main way to interact with the program is using the keyboard. By
|
Using the program in gemini exclusive mode (option \fB"-G"\fP) the program layout is simplified:
|
||||||
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
|
.RS
|
||||||
\fBALT\fP on many keyboards). There is a contextual help that appears
|
.nf
|
||||||
when the user input data that provide hints about commands and a
|
\fC
|
||||||
quick help window that can be shown by hitting \fC?\fP (if this
|
+------------------------------------------+
|
||||||
|
| |
|
||||||
|
| 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
|
||||||
|
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).
|
keybinding has not been customized).
|
||||||
|
|
||||||
.SS "Command window keys"
|
.SS "Command window keys"
|
||||||
.PP
|
.PP
|
||||||
The command window has a few hardcoded command keys to interact
|
The command window has a few hardcoded command keys to interact
|
||||||
with it:
|
with it:
|
||||||
|
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
the \fBleft\fP and \fBright\fP arrow keys move the cursor;
|
the \fBleft\fP and \fBright\fP arrow keys move the cursor;
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
the key \fBhome\fP and \fBend\fP move the cursor to the start and end of
|
the key \fBhome\fP and \fBend\fP move the cursor to the start and end of
|
||||||
|
.PP
|
||||||
the input respectively;
|
the input respectively;
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
\fBcanc\fP and \fBbackspace\fP delete the next and previous character
|
\fBcanc\fP and \fBbackspace\fP delete the next and previous character
|
||||||
|
.PP
|
||||||
respectively;
|
respectively;
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
the \fBnew line\fP (often called \fBenter\fP key) send the input to the
|
the \fBnew line\fP (often called \fBenter\fP key) send the input to the
|
||||||
|
.PP
|
||||||
program;
|
program;
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
\fBC-k\fP (that is: "press 'control' and while pressed press 'k')
|
\fBC-k\fP (that is: "press 'control' and while pressed press 'k')
|
||||||
\fIkills\fP (deletes) the text from the cursor position to the end of
|
.PP
|
||||||
|
\fIkills\fP (deletes) the text from the cursor position to the end of
|
||||||
the input previously typed;
|
the input previously typed;
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
press \fBM-left\fP and \fBM-right\fP (\fBleft alt\fP and \fBleft\fP or \fBright\fP
|
press \fBM-left\fP and \fBM-right\fP (\fBleft alt\fP and \fBleft\fP or \fBright\fP
|
||||||
arrow together) to browse pages of the suggestion window; the
|
.PP
|
||||||
suggestion window is a window that holds a previously inputted
|
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
|
data that are compatible with the string the user is typing into
|
||||||
the command window;
|
the command window;
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
if suggestions are gemini URI press \fBTAB\fP to input the current
|
if suggestions are gemini URI press \fBTAB\fP to input the current
|
||||||
selected suggestion;
|
.PP
|
||||||
|
selected suggestion;
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
if suggestion window is \fBnot\fP rendered, pressing \fBup\fP and \fBdown\fP
|
if suggestion window is \fBnot\fP rendered, pressing \fBup\fP and \fBdown\fP
|
||||||
arrow keys will cycle through input history, if there is not a
|
.PP
|
||||||
suggestion window rendered pressing \fBup\fP and \fBdown\fP will scroll
|
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.
|
on suggestions.
|
||||||
|
|
||||||
.SS "Folders"
|
.SS "Folders"
|
||||||
|
@ -205,10 +242,10 @@ username = username
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
Not incidentally the information in the example above are the
|
Not incidentally the information in the example above are the
|
||||||
absolute minimum the user has to provide before starts the program
|
absolute minimum the user has to provide before starts the program
|
||||||
and connect to pleroma (to use tinmop as a gemini browser only an
|
and connect to pleroma (to use tinmop as a gemini browser only an
|
||||||
empty file will suffice): the name you chose when you made the
|
empty file will suffice): the name you chose when you made the
|
||||||
account on the server and the address of the server.
|
account on the server and the address of the server.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
|
@ -271,13 +308,13 @@ once: when the program starts for the first time (but please note
|
||||||
that there must be a file with valid credentials available).
|
that there must be a file with valid credentials available).
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
There is no additional steps to follow to connect to gemspace,
|
There is no additional steps to follow to connect to gemspace,
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
.SH "Gempub support"
|
.SH "Gempub support"
|
||||||
.PP
|
.PP
|
||||||
Tinmop maintains a gempub library scanning a directory on your
|
Tinmop maintains a gempub library scanning a directory on your
|
||||||
file system (library directory); the library directory path can be
|
file system (library directory); the library directory path can be
|
||||||
set using the configuration directive:
|
set using the configuration directive:
|
||||||
|
|
||||||
.RS
|
.RS
|
||||||
|
@ -290,12 +327,12 @@ gempub.directory.library = /absolute/path/to/your/gempub/library
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
the default value is \fC$XDG_DATA_HOME\fP (usually something like
|
the default value is \fC$XDG_DATA_HOME\fP (usually something like
|
||||||
\fC$HOME/.local/share/tinmop/\fP).
|
\fC$HOME/.local/share/tinmop/\fP).
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
Using \fB'M-g g l'\fP the library can be inspected using a simple query
|
Using \fB'M-g g l'\fP the library can be inspected using a simple query
|
||||||
language (similar to SQL) that search in the metadata of the gempub
|
language (similar to SQL) that search in the metadata of the gempub
|
||||||
files, example of query follows:
|
files, example of query follows:
|
||||||
|
|
||||||
.RS
|
.RS
|
||||||
|
@ -330,36 +367,37 @@ published;
|
||||||
copyright.
|
copyright.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
You can use \fC< > = != <= >= like\fP operators for comparison and the
|
You can use \fC< > = != <= >= like\fP operators for comparison and the
|
||||||
two logical operator \fCand\fP and \fCor\fP, the character \fC%\fP act like a
|
two logical operator \fCand\fP and \fCor\fP, the character \fC%\fP act like a
|
||||||
wildcard and means: \fI'any sequence of character'\fP.
|
wildcard and means: \fI'any sequence of character'\fP.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
Note that the right hand side of the operator must be wrapped in
|
Note that the right hand side of the operator must be wrapped in
|
||||||
quotes.
|
quotes.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
After the search is performed a window with the results is shown,
|
After the search is performed a window with the results is shown,
|
||||||
selecting an item of this window will open the gempub and will add
|
selecting an item of this window will open the gempub and will add
|
||||||
all its table of contents on the tour mode, so that the book could
|
all its table of contents on the tour mode, so that the book could
|
||||||
be browsed.
|
be browsed.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
For more information on tour mode see below or use
|
For more information on tour mode see below or use
|
||||||
\fB'C-h A <enter> tour mode'\fP.
|
\fB'C-h A <enter> tour mode'\fP.
|
||||||
|
|
||||||
.SH "Tour mode"
|
.SH "Tour mode"
|
||||||
.PP
|
.PP
|
||||||
Tinmop maintains a queue of links that can be then visited by the
|
Tinmop maintains a queue of links that can be then visited by the
|
||||||
user, this queue is called \fBtour\fP.
|
user, this queue is called \fBtour\fP.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
There are two ways to add a link to the tour:
|
There are two ways to add a link to the tour:
|
||||||
|
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
when a link window is open and focused pressing \fBt\fP will start a
|
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
|
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
|
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:
|
range is a couple of index separated by a dash, example below:
|
||||||
|
|
||||||
.RS
|
.RS
|
||||||
|
@ -369,12 +407,13 @@ range is a couple of index separated by a dash, example below:
|
||||||
.fi
|
.fi
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
|
.PP
|
||||||
The string above will save the link index number 1, 2, 3, 5, 8, 9,
|
The string above will save the link index number 1, 2, 3, 5, 8, 9,
|
||||||
10, 11, 12 to the tour.
|
10, 11, 12 to the tour.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
The other way to add links to the tour is using the command
|
The other way to add links to the tour is using the command
|
||||||
\fB'gemlog-add-unread-posts-tour'\fP (default keychord: \fB'M-g s t a'\fP)
|
\fB'gemlog-add-unread-posts-tour'\fP (default keychord: \fB'M-g s t a'\fP)
|
||||||
that will add all the unread posts to the tour.
|
that will add all the unread posts to the tour.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
|
@ -383,11 +422,13 @@ There are a few more useful command to manipulate the tour:
|
||||||
.TP
|
.TP
|
||||||
\fBnext-tour-link\fP
|
\fBnext-tour-link\fP
|
||||||
(\fB'M-t t'\fP or just 't' if a gemini window is focused)
|
(\fB'M-t t'\fP or just 't' if a gemini window is focused)
|
||||||
|
.PP
|
||||||
follows the next link in the tour;
|
follows the next link in the tour;
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fBshow-tour-links\fP
|
\fBshow-tour-links\fP
|
||||||
(\fB'M-t s'\fP or just \fB'T'\fP if a gemini window is focused)
|
(\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
|
shows the contents of the tour in a link window
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
|
@ -395,7 +436,7 @@ shows the contents of the tour in a link window
|
||||||
(\fB'M-t c'\fP)
|
(\fB'M-t c'\fP)
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fBshuffle-tour \fP
|
\fBshuffle-tour\fP
|
||||||
(\fB'M-t S'\fP) shuffle the contents of the tour
|
(\fB'M-t S'\fP) shuffle the contents of the tour
|
||||||
|
|
||||||
.SH "How to get more help"
|
.SH "How to get more help"
|
||||||
|
@ -412,10 +453,9 @@ For information about gemini:
|
||||||
$ tinmop -o gemini://gemini.circumlunar.space
|
$ tinmop -o gemini://gemini.circumlunar.space
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
The program has an inline help (default binding for help is "?")
|
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
|
||||||
.PP
|
help can be searched (default: "C-h A").
|
||||||
You can search the help strings with a command (default: "C-h a").
|
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
Moreover you can have some useful hint at the program web page:
|
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"
|
.SH "BUGS"
|
||||||
.PP
|
.PP
|
||||||
There are many, totally unknown, hiding in the code! Please help the
|
There are many, totally unknown, hiding in the code; this is scary!
|
||||||
programmer to nail them using the
|
😱 Please help the programmer to nail them using the
|
||||||
https://notabug.org/cage/tinmop/issues/ \fBat\fP \fIissue tracker\fP.
|
https://notabug.org/cage/tinmop/issues/ \fBat\fP \fIissue tracker\fP.
|
||||||
|
|
||||||
.SH "Contributing"
|
.SH "Contributing"
|
||||||
|
@ -477,12 +517,12 @@ in the directory \fC$HOME/.local/share/tinmop/\fP.
|
||||||
|
|
||||||
.SH "Privacy"
|
.SH "Privacy"
|
||||||
.PP
|
.PP
|
||||||
The author of this software collects no user data information with
|
The author of this software collects no user data information with
|
||||||
this software.
|
this software.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
But this software is a client to connect and interact to one or more
|
But this software is a client to connect and interact to one or more
|
||||||
remote computer. So potentially it could share a lot of information
|
remote computer. So potentially it could share a lot of information
|
||||||
with other actors but just after the user allowed it to do so.
|
with other actors but just after the user allowed it to do so.
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
|
@ -494,8 +534,8 @@ By default, pressing "!" will contact the remote service located at:
|
||||||
"gemini://houston.coder.town/search".
|
"gemini://houston.coder.town/search".
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
Moreover launching \fCquick_quicklisp.sh\fP will contact
|
Moreover launching \fCquick_quicklisp.sh\fP will contact
|
||||||
\fIhttps://www.quicklisp.org/\fP, check the
|
\fIhttps://www.quicklisp.org/\fP, check the
|
||||||
https://beta.quicklisp.org/quicklisp.lisp \fBat\fP \fIquicklisp sources\fP for
|
https://beta.quicklisp.org/quicklisp.lisp \fBat\fP \fIquicklisp sources\fP for
|
||||||
details.
|
details.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue