Mercurial > libervia-backend

comparison doc/primitivus/index.rst @ 3021:8ec35cf13f66

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: added, overview, configuration and Primitivus documentation + some small modifications
author Goffi <goffi@goffi.org>
date Sun, 21 Jul 2019 22:14:30 +0200
parents
children 03fe31effa7f
comparison
equal deleted inserted replaced
3020:af9d71303605 3021:8ec35cf13f66
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 - ``C`` stands for ``Ctrl``
38 - ``M`` means *Meta*, on a PC it is usually the ``Alt`` key
39 - ``S`` stands for ``Shift``
40
41 Main keys
42 ~~~~~~~~~
43
44 ``[tab]`` and/or ``C-up/down arrows``
45 change focus
46 ``C-x``
47 quit Primitivus
48 ``C-f 1`` or ``C-f m``
49 focus on the menu
50 ``C-f 2`` or ``C-f b``
51 focus on the roster or the chat window
52 ``C-f 3`` or ``C-f e``
53 focus on the edition line
54 ``M-m``
55 display/hide the menu
56 ``C-n``
57 show the next notification
58 ``C-s``
59 hide/redisplay a pop-up window temporarily
60 ``C-d``
61 enter debug mode (development versions only)
62 ``F2``
63 hide/display the roster
64 ``C-l``
65 refresh the screen
66
67 Chat rooms
68 ~~~~~~~~~~
69
70 To use those keyboard shortcuts, your cursor must be in a chat room.
71
72 ``M-j``
73 join a chat room
74 ``M-p``
75 hide/display the list of participants
76 ``M-t``
77 hide/display timestamps
78 ``M-n``
79 use/don't use short nicks
80 ``M-l``
81 hide/display frame decorations
82 ``M-s``
83 change the room's topic appearance by switching between:
84 - one single line (the topic is cut if it's too long)
85 - the full topic
86 - topic hidden
87 ``G``
88 go to the end (bottom) of your history (note that this is UPPERCASE ``G``)
89
90
91 Edition line
92 ~~~~~~~~~~~~
93
94 ``C-a`` or ``[home]``
95 move the cursor at the beginning of the line
96 ``C-e`` or ``[end]``
97 move the cursor at the end of the line
98 ``C-k``
99 erase the line, starting at the cursor's position
100 ``C-w``
101 erase the last word
102 ``S-[tab]``
103 invoke completion (dependent on the context)
104 ``up/down arrows``
105 browse sent messages history
106
107 Contacts
108 ~~~~~~~~
109
110 ``M-d``
111 hide/display offline contacts
112 ``M-s``
113 hide/display contacts' status messages
114
115 Card game
116 ~~~~~~~~~
117
118 ``space``
119 select a card
120
121 Commands
122 ~~~~~~~~
123
124 The following commands must be typed in command mode (type ``[Esc]`` to switch to normal
125 mode, then the ``:`` at the beginning of the command will switch to command mode).
126
127 ``:quit``
128 quit Primitivus
129 ``:messages``
130 display log messages (see also the logging configuration)
131
132 ..
133 FIXME: :presence and :status are currently disabled in Primitivus
134 ``:presence [status]``
135 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:
136 - ``online``
137 - ``chat`` (free to chat)
138 - ``away`` (away from keyboard)
139 - ``dnd`` (do not disturb)
140 - ``xa`` (extended away)
141 ``:status [message]``
142 set your status message. Invoked without argument, a pop-up will allow you to enter a message.
143
144 ``:history <size>``
145 set the number of lines of history to display in the chat window (``:history 0`` to clear the window)
146 ``:search <filter>``
147 do a full text search in this conversation/room. The room will be cleared an only
148 messages corresponding to ``<filter>`` will be show. Use ``:history <size>`` to
149 restore normal history
150