Mercurial > libervia-backend

comparison doc/libervia-tui/index.rst @ 3488:c80a0f864b5d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: updated doc following global renaming
author Goffi <goffi@goffi.org>
date Sun, 21 Mar 2021 18:23:58 +0100
parents doc/primitivus/index.rst@03fe31effa7f
children 4705f80b6e23
comparison
equal deleted inserted replaced
3487:75427f0a5445 3488:c80a0f864b5d
1 .. _primitivus-documentation:
2
3 ==========
4 Primitivus
5 ==========
6
7 ``Primitivus`` is the TUI (Terminal User Interface) frontend of Salut à Toi
8
9 Overview
10 ========
11
12 ``Primitivus`` is a text based frontend. It is specially adapted for systems without
13 graphical environments (e.g. servers), for low bandwidth remote shells (e.g. ssh) or for
14 people who like straightforward interfaces without distracting images or animations.
15
16 For the moment, Primitivus implements one 2 one chat, group chat (also called *MUC* for
17 Multi-Users Chat), and some related features (end 2 end encryption, bookmarks, gateways
18 interaction, file sending, etc.).
19
20 Usage
21 =====
22
23 Primitivus is modal (vi-like), one can switch from one mode to another
24 in the same way as in vi/vim:
25
26 - From any mode, press ``[Esc]`` to switch to normal mode.
27 - From normal mode, press ``:`` to switch to command mode.
28 - From normal mode, press ``i`` to switch to insert mode – the one you
29 use to write messages to your contacts.
30
31 Primitivus can be handled either with the mouse, in a very intuitive way, or with the
32 keyboard. Below, the keyboard shortcuts are explained.
33
34 Keyboard handling
35 -----------------
36
37 - ``+`` means that 2 keys must be pressed at the same time. Example: ``CTRL + N`` means that
38 you must press Control key and ``N`` at the same time
39 - ``,`` means that a key must be pressed after the previous combination. Example:
40 ``CTRL + F, M`` means that you must press control key and ``F`` at the same time, release
41 them, then press ``M``
42 - keys with ``SHIFT`` also work without ``SHIFT`` if ``[CapsLock]`` is set.
43
44 Main keys
45 ~~~~~~~~~
46
47 ``[Tab]`` and/or ``CTRL + up/down arrows``
48 change focus
49 ``CTRL + X``
50 quit Primitivus
51 ``CTRL + F, 1`` or ``CTRL + F, M``
52 focus on the menu
53 ``CTRL + F, 2`` or ``CTRL + F, B``
54 focus on the roster or the chat window
55 ``CTRL + F, 3`` or ``CTRL + F, E``
56 focus on the edition line
57 ``ALT + M``
58 display/hide the menu
59 ``CTRL + N``
60 show the next notification
61 ``CTRL + S``
62 hide/redisplay a pop-up window temporarily
63 ``CTRL + D``
64 enter debug mode (development versions only)
65 ``F2``
66 hide/display the roster
67 ``CTRL + L``
68 refresh the screen
69
70 Chat rooms
71 ~~~~~~~~~~
72
73 To use those keyboard shortcuts, your cursor must be in a chat room.
74
75 ``ALT + J``
76 join a chat room
77 ``ALT + P``
78 hide/display the list of participants
79 ``ALT + T``
80 hide/display timestamps
81 ``ALT + N``
82 use/don't use short nicks
83 ``ALT + L``
84 hide/display frame decorations
85 ``ALT + S``
86 change the room's topic appearance by switching between:
87 - one single line (the topic is cut if it's too long)
88 - the full topic
89 - topic hidden
90 ``SHIFT + G``
91 go to the end (bottom) of your history (note that this is UPPERCASE ``G``)
92
93
94 Edition line
95 ~~~~~~~~~~~~
96
97 ``CTRL + A`` or ``[Home]``
98 move the cursor at the beginning of the line
99 ``CTRL + E`` or ``[End]``
100 move the cursor at the end of the line
101 ``CTRL + K``
102 erase the line, starting at the cursor's position
103 ``CTRL + W``
104 erase the last word
105 ``S + [Tab]``
106 invoke completion (dependent on the context)
107 ``up/down arrows``
108 browse sent messages history
109
110 Contacts
111 ~~~~~~~~
112
113 ``ALT + D``
114 hide/display offline contacts
115 ``ALT + S``
116 hide/display contacts' status messages
117
118 Card game
119 ~~~~~~~~~
120
121 ``[space]``
122 select a card
123
124 Commands
125 ~~~~~~~~
126
127 The following commands must be typed in command mode (type ``[Esc]`` to switch to normal
128 mode, then the ``:`` at the beginning of the command will switch to command mode).
129
130 ``:quit``
131 quit Primitivus
132 ``:messages``
133 display log messages (see also the logging configuration)
134
135 ..
136 FIXME: :presence and :status are currently disabled in Primitivus
137 ``:presence [status]``
138 set your presence status. Invoked without argument, a pop-up will allow you to choose your presence status; otherwise, you can use the following arguments:
139 - ``online``
140 - ``chat`` (free to chat)
141 - ``away`` (away from keyboard)
142 - ``dnd`` (do not disturb)
143 - ``xa`` (extended away)
144 ``:status [message]``
145 set your status message. Invoked without argument, a pop-up will allow you to enter a message.
146
147 ``:history <size>``
148 set the number of lines of history to display in the chat window (``:history 0`` to clear the window)
149 ``:search <filter>``
150 do a full text search in this conversation/room. The room will be cleared an only
151 messages corresponding to ``<filter>`` will be show. Use ``:history <size>`` to
152 restore normal history
153