cage/tinmop
1
0
Fork 0
mirror of https://codeberg.org/cage/tinmop/ synced 2025-02-23 09:07:37 +01:00
Code Issues

- updated documentation.

Browse Source
This commit is contained in:
cage 2025-02-16 20:12:22 +01:00
parent cf35514531
commit f307a1a11b
2 changed files with 96 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
doc/tinmop.man
View File

@ -4,7 +4,13 @@
tinmop - a client for gemini, gopher, mastodon and pleroma social network and kamid (9p protocol over TLS)
.SH "Synopsis"
.PP
tinmop [OPTION]…
tinmop [-h|--help] [-v|--version] [-f|--folder FOLDER-NAME]
[-t|--timeline TIMELINE-NAME] [-u|--update-timeline] [-R|--reset-timeline-pagination]
[-c|--check-follows-requests] [-e|--execute-script SCRIPT-FILE] [-m|--notify-mentions]
[-o|--open-net-address NET-ADDRESS] [-G|--gemini-client-only] [-U|--gemini-gui-client-only]
[-A|--fediverse-authorization-code] [-S|--gemini-gui-server-only] [-M|--load-module MODULE-FILE]
[-F|--fediverse-account FEDIVERSE-ACCOUNT] [-X|--lisp-dependencies-uris] [--start-dummy-server]
[-Q|--search-fediverse SEARCH-FEDIVERSE-QUERY] [--bash-complete]
.SH "Description"
.PP
This document assumes basic knowledge of how fediverse works. More information about this topic can be found on the following websites:
@ -34,49 +40,65 @@ For more information about this feature, please visit: \fIhttps://kamid.omarpolo
Without options the program will start a terminal interface and will try to connect to your instance (see \fIfuzzy:Configuration\fP), the most useful command line options follows
.TP
\fB\fC\-o, \-\-open\-net\-address ARG\fP \fP
Open net address (currentli only gemini or 9p)
\fB\fC\-\-bash\-complete\fP \fP
Complete command line switches (for bash completion only).
.TP
\fB\fC\-m, \-\-notify\-mentions ARG\fP \fP
Notify messages that mentions the user
\fB\fC\-\-start\-dummy\-server\fP \fP
Start a dummy sever, just useful for debugging.
.TP
\fB\fC\-R, \-\-reset\-timeline\-pagination\fP \fP
Reset the timeline pagination. By default the new posts are fetched
starting from the last one downloaded from the instance, this switch
will force the program to fetch the last message posted by users
\fB\fC\-A, \-\-fediverse\-authorization\-code\fP \fP
Asks for server authorization code, before connecting to the fediverse instance.
.TP
\fB\fC\-G, \-\-gemini\-client\-only\fP \fP
Start as gemini client only
\fB\fC\-F, \-\-fediverse\-account FEDIVERSE\-ACCOUNT\fP \fP
Specify a fediverse user account (format: user-name@server-name).
.TP
\fB\fC\-c, \-\-check\-follows\-requests\fP \fP
Checks for follow request at start
\fB\fC\-G, \-\-gemini\-client\-only\fP \fP
Start as gemini client only.
.TP
\fB\fC\-e, \-\-execute\-script SCRIPT\-FILE\fP\fP
Execute a script file
.TP
\fB\fC\-f, \-\-folder FOLDER\-NAME\fP \fP
Start on that virtual folder
.TP
\fB\fC\-h, \-\-help\fP \fP
print program help and exit
.TP
\fB\fC\-t, \-\-timeline TIMELINE\-NAME\fP \fP
Start using this timeline
.TP
\fB\fC\-u, \-\-update\-timeline\fP \fP
Update the selected timeline
.TP
\fB\fC\-U, \-\-gemini\-gui\-client\-only\fP \fP
Start the program as A gemini GUI client
.TP
\fB\fC\-v, \-\-version\fP \fP
Print program version and exit
.TP
\fB\fC\-F, \-\-fediverse\-account\fP \fP
Specify a fediverse user account (format: user-name@server-name)
\fB\fC\-M, \-\-load\-module MODULE\-FILE\fP \fP
Load a module.
.TP
\fB\fC\-Q, \-\-search\-fediverse SEARCH\-FEDIVERSE\-QUERY\fP\fP
Search fediverse (see this guide: \fIhttps://markwrites.io/guide-for-using-mastodon-search\fP)
Search fediverse.
.TP
\fB\fC\-R, \-\-reset\-timeline\-pagination\fP \fP
Reset the timeline pagination.
.TP
\fB\fC\-S, \-\-gemini\-gui\-server\-only\fP \fP
Start as gemini gui server only.
.TP
\fB\fC\-U, \-\-gemini\-gui\-client\-only\fP \fP
Start as gemini gui client only.
.TP
\fB\fC\-X, \-\-lisp\-dependencies\-uris\fP \fP
Download lisp libraries (useful for packaging only).
.TP
\fB\fC\-c, \-\-check\-follows\-requests\fP \fP
Check follows requests.
.TP
\fB\fC\-e, \-\-execute\-script SCRIPT\-FILE\fP \fP
Execute script.
.TP
\fB\fC\-f, \-\-folder FOLDER\-NAME\fP \fP
Starting folder
.TP
\fB\fC\-h, \-\-help\fP \fP
Print help and exit.
.TP
\fB\fC\-m, \-\-notify\-mentions\fP \fP
Notify messages that mentions the user.
.TP
\fB\fC\-o, \-\-open\-net\-address NET\-ADDRESS\fP \fP
Open net address.
.TP
\fB\fC\-t, \-\-timeline TIMELINE\-NAME\fP \fP
Starting timeline.
.TP
\fB\fC\-u, \-\-update\-timeline\fP \fP
Update timeline.
.TP
\fB\fC\-v, \-\-version\fP \fP
Print program information and exit.
.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 \fIfuzzy:GUI\fP), the terminal screen layout is sketched below:
@ -759,7 +781,7 @@ thread-mark-prevent-delete-selected-message
\fBX \fP
refresh-thread-totally
.TP
\fB\\ \\ \fP
\fB/ / \fP
repeat-search
.TP
\fB\\ b \fP
@ -930,9 +952,6 @@ message-scroll-down
\fBN \fP
repeat-search
.TP
\fBb \fP
net-address-history-back
.TP
\fBd \fP
delete-shown-post
.TP
@ -1303,6 +1322,12 @@ close-open-attach-window
open-message-attach-go-up
.SS "Links window"
.TP
\fBC-J \fP
open-message-link-perform-opening
.TP
\fBC-s \fP
open-message-link-perform-fediverse-searching
.TP
\fB/ \fP
search-link-window
.TP

51
doc/tinmop.org
View File

@ -6,7 +6,13 @@
* Synopsis
tinmop [OPTION]…
tinmop [-h|--help] [-v|--version] [-f|--folder FOLDER-NAME]
[-t|--timeline TIMELINE-NAME] [-u|--update-timeline] [-R|--reset-timeline-pagination]
[-c|--check-follows-requests] [-e|--execute-script SCRIPT-FILE] [-m|--notify-mentions]
[-o|--open-net-address NET-ADDRESS] [-G|--gemini-client-only] [-U|--gemini-gui-client-only]
[-A|--fediverse-authorization-code] [-S|--gemini-gui-server-only] [-M|--load-module MODULE-FILE]
[-F|--fediverse-account FEDIVERSE-ACCOUNT] [-X|--lisp-dependencies-uris] [--start-dummy-server]
[-Q|--search-fediverse SEARCH-FEDIVERSE-QUERY] [--bash-complete]
* Description
@ -37,23 +43,26 @@
Without options the program will start a terminal interface and will try to connect to your instance (see [[Configuration]]), the most useful command line options follows
+ ~-o, --open-net-address ARG~ :: Open net address (currentli only gemini or 9p)
+ ~-m, --notify-mentions ARG~ :: Notify messages that mentions the user
+ ~-R, --reset-timeline-pagination~ ::
Reset the timeline pagination. By default the new posts are fetched
starting from the last one downloaded from the instance, this switch
will force the program to fetch the last message posted by users
+ ~-G, --gemini-client-only~ :: Start as gemini client only
+ ~-c, --check-follows-requests~ :: Checks for follow request at start
+ ~-e, --execute-script SCRIPT-FILE~ :: Execute a script file
+ ~-f, --folder FOLDER-NAME~ :: Start on that virtual folder
+ ~-h, --help~ :: print program help and exit
+ ~-t, --timeline TIMELINE-NAME~ :: Start using this timeline
+ ~-u, --update-timeline~ :: Update the selected timeline
+ ~-U, --gemini-gui-client-only~ :: Start the program as A gemini GUI client
+ ~-v, --version~ :: Print program version and exit
+ ~-F, --fediverse-account~ :: Specify a fediverse user account (format: user-name@server-name)
+ ~-Q, --search-fediverse SEARCH-FEDIVERSE-QUERY~ :: Search fediverse (see this guide: https://markwrites.io/guide-for-using-mastodon-search)
+ ~--bash-complete~ :: Complete command line switches (for bash completion only).
+ ~--start-dummy-server~ :: Start a dummy sever, just useful for debugging.
+ ~-A, --fediverse-authorization-code~ :: Asks for server authorization code, before connecting to the fediverse instance.
+ ~-F, --fediverse-account FEDIVERSE-ACCOUNT~ :: Specify a fediverse user account (format: user-name@server-name).
+ ~-G, --gemini-client-only~ :: Start as gemini client only.
+ ~-M, --load-module MODULE-FILE~ :: Load a module.
+ ~-Q, --search-fediverse SEARCH-FEDIVERSE-QUERY~ :: Search fediverse.
+ ~-R, --reset-timeline-pagination~ :: Reset the timeline pagination.
+ ~-S, --gemini-gui-server-only~ :: Start as gemini gui server only.
+ ~-U, --gemini-gui-client-only~ :: Start as gemini gui client only.
+ ~-X, --lisp-dependencies-uris~ :: Download lisp libraries (useful for packaging only).
+ ~-c, --check-follows-requests~ :: Check follows requests.
+ ~-e, --execute-script SCRIPT-FILE~ :: Execute script.
+ ~-f, --folder FOLDER-NAME~ :: Starting folder
+ ~-h, --help~ :: Print help and exit.
+ ~-m, --notify-mentions~ :: Notify messages that mentions the user.
+ ~-o, --open-net-address NET-ADDRESS~ :: Open net address.
+ ~-t, --timeline TIMELINE-NAME~ :: Starting timeline.
+ ~-u, --update-timeline~ :: Update timeline.
+ ~-v, --version~ :: Print program information and exit.
* Usage
@ -316,7 +325,6 @@
* Default keybindings for TUI
** Global keymap
- ! :: gemini-search
- > :: open-net-address
- @ :: switch-fediverse-account
@ -424,7 +432,7 @@
- p :: show-parent-post
- U :: thread-mark-prevent-delete-selected-message
- X :: refresh-thread-totally
- \\ \\ :: repeat-search
- / / :: repeat-search
- \\ b :: thread-search-previous-message-body
- \\ m :: thread-search-previous-message-meta
- c :: compose-message
@ -512,7 +520,6 @@
- / :: message-search-regex
- C-J (key /enter/) :: message-scroll-down
- N :: repeat-search
- b :: net-address-history-back
- d :: delete-shown-post
- down :: message-scroll-down
- end :: message-scroll-end
@ -663,6 +670,8 @@
** Links window
- C-J :: open-message-link-perform-opening
- C-s :: open-message-link-perform-fediverse-searching
- / :: search-link-window
- C-c :: copy-from-message-link-to-clipboard
- N :: repeat-search