From 069bbda3928a0aa651de8ca046feab0fc829d444 Mon Sep 17 00:00:00 2001 From: cage Date: Thu, 19 Oct 2023 18:10:30 +0200 Subject: [PATCH] - updated documentation. --- doc/tinmop.man | 28 ++++++++++++++++++---------- doc/tinmop.org | 28 +++++++++++++++++----------- 2 files changed, 35 insertions(+), 21 deletions(-) diff --git a/doc/tinmop.man b/doc/tinmop.man index 0f74283..b7e1f8b 100644 --- a/doc/tinmop.man +++ b/doc/tinmop.man @@ -2,7 +2,7 @@ .SH "Name" .PP -tinmop - a client for gemini, gopher, pleroma social network and kamid (9p protocol over TLS) +tinmop - a client for gemini, gopher, mastodon and pleroma social network and kamid (9p protocol over TLS) .SH "Synopsis" .PP @@ -20,12 +20,14 @@ This document assumes basic knowledge of how fediverse works. More information a \fIhttps://docs.joinmastodon.org/\fP . .PP -Tinmop proposes an extensible terminal interface to connect with Pleroma social network, the gemini and gopher protocol +Tinmop proposes an extensible terminal interface to connect with Mastodon or Pleroma social network, the gemini (for connecting to gemspace an optional graphical interface is also available) and gopher protocol. + + .IP \(em 4 -gemini://gemini.circumlunar.space/ +\fIgemini://geminiprotocol.net/docs/\fP .IP \(em 4 -\fIhttps://gemini.circumlunar.space/docs/\fP +\fIhttps://geminiprotocol.net/docs/\fP .PP Finally tinmop can connect to network file system using 9p protocol over TLS (using client certificates as authentication method). @@ -224,7 +226,7 @@ username = username .RE .PP -Not incidentally the information in the example above are the absolute minimum the user has to provide before starts the program 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 account on the server and the address of the server. +Not incidentally the information in the example above are the absolute minimum the user has to provide before starts the program and connect to pleroma/mastodon (to use tinmop as a gemini browser only an empty file will suffice): the name you chose when you made the account on the server and the address of the server. .PP As you can see a line starting with a \fB#\fP is considered comment and skipped by the program @@ -374,22 +376,28 @@ For help with pleroma visit the pleroma website: .PP \fIhttps://pleroma.social/\fP +.PP +The mastodon website can be found at: + +.PP +\fIhttps://joinmastodon.org/\fP + .PP For information about gemini: .PP -$ tinmop -o gemini://gemini.circumlunar.space +$ tinmop -o gemini://geminiprotocol.net/ .PP -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"). +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 that can be searched (default: "C-h A"). .PP Moreover you can have some useful hint at the program web page: .PP -[\fIhttps://www.autistici.org/interzona/tinmop/\fP] +\fIhttps://www.autistici.org/interzona/tinmop/\fP -.SH "Default keybindings" +.SH "Default keybindings for TUI" .SS "Global keymap" .TP \fB! \fP @@ -1319,7 +1327,7 @@ There are many, totally unknown, hiding in the code; this is scary! 😱 Please .SH "Contributing" .PP -There is always need for help, you can join the developer, sending patches or translating the UI to your favourite language. +There is always need for help, you can join the developer, sending patches or https://translate.codeberg.org/projects/tinmop/ \fBat\fP \fItranslating the UI\fP to your favourite language. .PP Just point your browser to the https://codeberg.org/cage/tinmop/ \fBat\fP \fIcode repository\fP. diff --git a/doc/tinmop.org b/doc/tinmop.org index 3307812..644b885 100644 --- a/doc/tinmop.org +++ b/doc/tinmop.org @@ -2,7 +2,7 @@ * Name - tinmop - a client for gemini, gopher, pleroma social network and kamid (9p protocol over TLS) + tinmop - a client for gemini, gopher, mastodon and pleroma social network and kamid (9p protocol over TLS) * Synopsis @@ -16,10 +16,12 @@ - [[https://pleroma.social/]] ; - [[https://docs.joinmastodon.org/]] . - Tinmop proposes an extensible terminal interface to connect with Pleroma social network, the gemini and gopher protocol + Tinmop proposes an extensible terminal interface to connect with Mastodon or Pleroma social network, the gemini (for connecting to gemspace an optional graphical interface is also available) and gopher protocol. - - gemini://gemini.circumlunar.space/ - - [[https://gemini.circumlunar.space/docs/]] + + + - [[gemini://geminiprotocol.net/docs/]] + - [[https://geminiprotocol.net/docs/]] Finally tinmop can connect to network file system using 9p protocol over TLS (using client certificates as authentication method). @@ -159,7 +161,7 @@ #+END_SRC - Not incidentally the information in the example above are the absolute minimum the user has to provide before starts the program 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 account on the server and the address of the server. + Not incidentally the information in the example above are the absolute minimum the user has to provide before starts the program and connect to pleroma/mastodon (to use tinmop as a gemini browser only an empty file will suffice): the name you chose when you made the account on the server and the address of the server. As you can see a line starting with a *#* is considered comment and skipped by the program @@ -260,19 +262,23 @@ For help with pleroma visit the pleroma website: - https://pleroma.social/ + [[https://pleroma.social/]] + + The mastodon website can be found at: + + [[https://joinmastodon.org/]] For information about gemini: - $ tinmop -o gemini://gemini.circumlunar.space + $ tinmop -o gemini://geminiprotocol.net/ - 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"). + 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 that 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/] + [[https://www.autistici.org/interzona/tinmop/]] -* Default keybindings +* Default keybindings for TUI ** Global keymap @@ -632,7 +638,7 @@ * Contributing - There is always need for help, you can join the developer, sending patches or translating the UI to your favourite language. + There is always need for help, you can join the developer, sending patches or [[https://translate.codeberg.org/projects/tinmop/][translating the UI]] to your favourite language. Just point your browser to the [[https://codeberg.org/cage/tinmop/][code repository]].