mirror of https://codeberg.org/cage/tinmop/
- [GUI] changed font size for gemtext header level 3;
- updated documentation.
This commit is contained in:
cage
parent
0ffe20ab26
commit
90a6bfa02b
|
|
@ -22,8 +22,6 @@ This document assumes basic knowledge of how fediverse works. More information a
|
|||
.PP
|
||||
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
|
||||
\fIgemini://geminiprotocol.net/docs/\fP
|
||||
.IP \(em 4
|
||||
|
|
@ -86,9 +84,7 @@ Specify a fediverse user account (format: user-name@server-name)
|
|||
|
||||
.SH "Usage"
|
||||
.PP
|
||||
Users of Tinmop supposed to interact with the social network using a terminal interface (TUI, but starting with version 0.9.9.1414 a GUI
|
||||
for gemini is available See \fIGUI\fP), The terminal screen layout is sketched
|
||||
below:
|
||||
Users of Tinmop supposed to interact with the social network using a terminal interface (TUI, but starting with version 0.9.9.1414 a GUI for gemini is available See \fIGUI\fP), the terminal screen layout is sketched below:
|
||||
|
||||
.RS
|
||||
.nf
|
||||
|
|
@ -155,10 +151,7 @@ Using the program in gemini exclusive mode (option \fB"-G"\fP) the program layou
|
|||
.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).
|
||||
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 "Command window keys"
|
||||
.PP
|
||||
|
|
@ -206,7 +199,7 @@ The distribution of this software comes with a bunch of pre-backed configuration
|
|||
(see \fIFiles\fP) but user is expected to write a simple file with their credential to log into the server, if you want to use tinmop as a fediverse client.
|
||||
|
||||
.PP
|
||||
The system wide configuration files are automatically included in used defined files, the configuration directive in custom files override the system wide ones.
|
||||
The system wide configuration files are automatically included in user defined files, the configuration directive in custom files override the system wide ones.
|
||||
|
||||
.SS "Simple configuration"
|
||||
.PP
|
||||
|
|
@ -238,7 +231,7 @@ As you can see a line starting with a \fB#\fP is considered comment and skipped
|
|||
|
||||
.PP
|
||||
The file with this credential are confidential and must be put into user's home directory under the path
|
||||
\fC$HOME/.local/share/tinmop/main.conf\fP. Probably the directory \fCtinmop\fP does not exists on user system, if it does not exists must be created manually.
|
||||
\fC$HOME/.local/share/tinmop/main.conf\fP. Probably the directory \fCtinmop\fP does not exists on user system; if it does not exists will be created by the software the first time it will run.
|
||||
|
||||
.PP
|
||||
If the program was installed correctly two other files with simple 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.
|
||||
|
|
@ -248,7 +241,7 @@ Is worth mentioning again that, without an user configuration file, the program
|
|||
|
||||
.SS "Lisp program"
|
||||
.PP
|
||||
These files contains Common lisp (see \fIhttps://common-lisp.net/\fP) source code. And are used both as a way to configure the program and to write module for tinmop itself.
|
||||
These files contains Common lisp (see \fIhttps://common-lisp.net/\fP) source code. They are used both as a way to configure the program and to write module for tinmop itself.
|
||||
|
||||
.PP
|
||||
These files are the only way to configure program's keybindings: sequence of pressing button to fire command commands (do not worry it is not too difficult!).
|
||||
|
|
@ -264,7 +257,7 @@ However there is no need to write their own init file if user is happy with the
|
|||
|
||||
.SH "First time start"
|
||||
.PP
|
||||
After the configuration the program can be started but we are not ready to join the fediverse yet because tinmop need to be \fItrusted\fP by the server. Just follows the instruction on screen to register the application with your instance. This procedure should be followed once: when the program starts for the first time (but please note that there must be a file with valid credentials available).
|
||||
After the configuration, the program can be started but we are not ready to join the fediverse yet because tinmop need to be \fItrusted\fP by the server. Just follows the instruction on screen to register the application with your instance. This procedure should be followed once: when the program starts for the first time (but please note that there must be a file with valid credentials available).
|
||||
|
||||
.PP
|
||||
There is no additional steps to follow to connect to gemspace, instead.
|
||||
|
|
|
|||
|
|
@ -18,8 +18,6 @@
|
|||
|
||||
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://geminiprotocol.net/docs/]]
|
||||
- [[https://geminiprotocol.net/docs/]]
|
||||
|
||||
|
|
@ -51,9 +49,7 @@
|
|||
|
||||
* Usage
|
||||
|
||||
Users of Tinmop supposed to interact with the social network using a terminal interface (TUI, but starting with version 0.9.9.1414 a GUI
|
||||
for gemini is available See [[GUI]]), The terminal screen layout is sketched
|
||||
below:
|
||||
Users of Tinmop supposed to interact with the social network using a terminal interface (TUI, but starting with version 0.9.9.1414 a GUI for gemini is available See [[GUI]]), the terminal screen layout is sketched below:
|
||||
|
||||
#+NAME: screen-layout
|
||||
#+BEGIN_SRC text
|
||||
|
|
@ -103,10 +99,7 @@
|
|||
|
||||
#+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).
|
||||
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).
|
||||
|
||||
** Command window keys
|
||||
|
||||
|
|
@ -141,7 +134,7 @@
|
|||
The distribution of this software comes with a bunch of pre-backed configuration files
|
||||
(see [[Files]]) but user is expected to write a simple file with their credential to log into the server, if you want to use tinmop as a fediverse client.
|
||||
|
||||
The system wide configuration files are automatically included in used defined files, the configuration directive in custom files override the system wide ones.
|
||||
The system wide configuration files are automatically included in user defined files, the configuration directive in custom files override the system wide ones.
|
||||
|
||||
** Simple configuration
|
||||
|
||||
|
|
@ -168,7 +161,7 @@
|
|||
As you can see a line starting with a *#* is considered comment and skipped by the program
|
||||
|
||||
The file with this credential are confidential and must be put into user's home directory under the path
|
||||
~$HOME/.local/share/tinmop/main.conf~. Probably the directory ~tinmop~ does not exists on user system, if it does not exists must be created manually.
|
||||
~$HOME/.local/share/tinmop/main.conf~. Probably the directory ~tinmop~ does not exists on user system; if it does not exists will be created by the software the first time it will run.
|
||||
|
||||
If the program was installed correctly two other files with simple semantics are located in your system wide configuration directory (usually ~/etc/tinmop/~), please check these files for more information, as they are extensively commented.
|
||||
|
||||
|
|
@ -176,7 +169,7 @@
|
|||
|
||||
** Lisp program
|
||||
|
||||
These files contains Common lisp (see [[https://common-lisp.net/]]) source code. And are used both as a way to configure the program and to write module for tinmop itself.
|
||||
These files contains Common lisp (see [[https://common-lisp.net/]]) source code. They are used both as a way to configure the program and to write module for tinmop itself.
|
||||
|
||||
These files are the only way to configure program's keybindings: sequence of pressing button to fire command commands (do not worry it is not too difficult!).
|
||||
|
||||
|
|
@ -188,7 +181,7 @@
|
|||
|
||||
* First time start
|
||||
|
||||
After the configuration the program can be started but we are not ready to join the fediverse yet because tinmop need to be /trusted/ by the server. Just follows the instruction on screen to register the application with your instance. This procedure should be followed once: when the program starts for the first time (but please note that there must be a file with valid credentials available).
|
||||
After the configuration, the program can be started but we are not ready to join the fediverse yet because tinmop need to be /trusted/ by the server. Just follows the instruction on screen to register the application with your instance. This procedure should be followed once: when the program starts for the first time (but please note that there must be a file with valid credentials available).
|
||||
|
||||
There is no additional steps to follow to connect to gemspace, instead.
|
||||
|
||||
|
|
|
|||
|
|
@ -145,7 +145,7 @@ gemini.h3.background = #f4ecd8
|
|||
|
||||
gemini.h3.font = Sans
|
||||
|
||||
gemini.h3.size = 14
|
||||
gemini.h3.size = 12
|
||||
|
||||
gemini.h3.weight = normal
|
||||
|
||||
|
|
|
|||
|
|
@ -17,14 +17,14 @@
|
|||
(in-package :api-client)
|
||||
|
||||
(defparameter *client* nil
|
||||
"The tooter client, used to access mastodon")
|
||||
"The tooter client, used to access mastodon/pleroma")
|
||||
|
||||
(defparameter *credentials* nil
|
||||
"An istance of 'credentials' used to holds the intormation needed to
|
||||
access a mastodon instance")
|
||||
access a mastodon/pleroma instance")
|
||||
|
||||
(defparameter *client-lock* (make-lock)
|
||||
"The Lock for prevent race conditions when accessing the mastodon server")
|
||||
"The Lock for prevent race conditions when accessing the mastodon/pleroma server")
|
||||
|
||||
(defun credentials-filename ()
|
||||
"The name of the file where credentials are stored."
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
|
||||
(define-constant +protocol-scheme+ "https://" :test #'string=
|
||||
:documentation "The scheme of the protocol that the
|
||||
mastodon server understand.")
|
||||
mastodon/pleroma server understand.")
|
||||
|
||||
(defun make-base-slot ()
|
||||
"Makes the 'base' slots for credential, used in credentials
|
||||
|
|
@ -47,7 +47,7 @@ initform."
|
|||
:initform (make-base-slot)
|
||||
:initarg :base
|
||||
:accessor base
|
||||
:documentation "The url of the mastodon instance to be accessed")
|
||||
:documentation "The url of the mastodon/pleroma instance to be accessed")
|
||||
(key
|
||||
:initform nil
|
||||
:initarg :key
|
||||
|
|
@ -63,7 +63,7 @@ initform."
|
|||
:initarg :access-token
|
||||
:accessor access-token
|
||||
:documentation "Access token to access the instance"))
|
||||
(:documentation "Represents the credentials to access a mastodon
|
||||
(:documentation "Represents the credentials to access a mastodon/pleroma
|
||||
instance"))
|
||||
|
||||
(defmethod marshal:class-persistant-slots ((object credentials))
|
||||
|
|
@ -85,7 +85,7 @@ initform."
|
|||
|
||||
(defun credentials-complete-p ()
|
||||
"Returns non nil if *credentials* contains all necessary data to log
|
||||
into the mastodon server"
|
||||
into the mastodon/pleroma server"
|
||||
(when *credentials*
|
||||
(with-accessors ((base base)
|
||||
(key key)
|
||||
|
|
@ -97,7 +97,7 @@ into the mastodon server"
|
|||
access-token))))
|
||||
|
||||
(defclass api-client (tooter:client) ()
|
||||
(:documentation "A mastodon client instance"))
|
||||
(:documentation "A mastodon/pleroma client instance"))
|
||||
|
||||
(defun copy-credentials-to-client ()
|
||||
"Copy credential data from `*credentials*' into `*client*'"
|
||||
|
|
@ -141,7 +141,7 @@ parameter, returns nil if a socket can not be opened."
|
|||
(_ "<!doctype html><html><head><meta charset=\"utf-8\"/></head><body><h1>~a has been successfully authorized, you can close this tab.</h1></body></html>"))
|
||||
|
||||
(defun catch-auth-code (socket)
|
||||
"When an user authorize a client to access mastodon the server send
|
||||
"When an user authorize a client to access mastodon/pleroma the server send
|
||||
an http request to an arbitrary URI chosen by the user.
|
||||
|
||||
This URI contains the authorization code neede to make the client
|
||||
|
|
|
|||
Loading…
Reference in New Issue