erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc (overview, libervia-tui): rename "Primitivus" to "Libervia TUI":

Browse source 
The TUI documentation was still using the legacy name. The reference in the overview is
also commented out, as the TUI is temporarily broken.
This commit is contained in:
Goffi 2026-11-03 20:59:54 +01:00
commit 0805f77f45
2 changed files with 26 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

26
doc/libervia-tui/index.rst
View file

@ -1,26 +1,26 @@
.. _primitivus-documentation:
.. _libervia-tui-documentation:
==========
Primitivus
==========
============
Libervia TUI
============
``Primitivus`` is the TUI (Terminal User Interface) frontend of Libervia
``Libervia TUI`` is the TUI (Terminal User Interface) frontend of Libervia
Overview
========
``Primitivus`` is a text based frontend. It is specially adapted for systems without
``Libervia TUI`` is a text based frontend. It is specially adapted for systems without
graphical environments (e.g. servers), for low bandwidth remote shells (e.g. ssh) or for
people who like straightforward interfaces without distracting images or animations.
For the moment, Primitivus implements one 2 one chat, group chat (also called *MUC* for
For the moment, Libervia TUI implements one 2 one chat, group chat (also called *MUC* for
Multi-Users Chat), and some related features (end 2 end encryption, bookmarks, gateways
interaction, file sending, etc.).
Usage
=====
Primitivus is modal (vi-like), one can switch from one mode to another
Libervia TUI is modal (vi-like), one can switch from one mode to another
in the same way as in vi/vim:
- From any mode, press ``[Esc]`` to switch to normal mode.
@ -28,7 +28,7 @@ in the same way as in vi/vim:
- From normal mode, press ``i`` to switch to insert mode – the one you
use to write messages to your contacts.
Primitivus can be handled either with the mouse, in a very intuitive way, or with the
Libervia TUI can be handled either with the mouse, in a very intuitive way, or with the
keyboard. Below, the keyboard shortcuts are explained.
Keyboard handling
@ -46,8 +46,8 @@ Main keys
``[Tab]`` and/or ``CTRL + up/down arrows``
change focus
``CTRL + X``
quit Primitivus
``CTRL + X``
quit Libervia TUI
``CTRL + F, 1`` or ``CTRL + F, M``
focus on the menu
``CTRL + F, 2`` or ``CTRL + F, B``
@ -128,12 +128,12 @@ The following commands must be typed in command mode (type ``[Esc]`` to switch t
mode, then the ``:`` at the beginning of the command will switch to command mode).
``:quit``
quit Primitivus
quit Libervia TUI
``:messages``
display log messages (see also the logging configuration)
..
FIXME: :presence and :status are currently disabled in Primitivus
FIXME: :presence and :status are currently disabled in Libervia TUI
``:presence [status]``
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:
- ``online``

25
doc/overview.rst
View file

@ -113,24 +113,25 @@ The `official Libervia website`_ is made with Libervia web framework.
.. _Jinja2: http://jinja.pocoo.org/
.. _official Libervia website: https://salut-a-toi.org
Libervia TUI (Primitivus)
-------------------------
Libervia TUI
------------
Libervia TUI (alias ``Primitivus``) is the Terminal User Interface. In other words, it
works in console and is intended for people at ease with it. Its text only interface has
several advantages: you get rid of many distracting things (like images), it works without
graphical environment installed (which is often the case on servers) and it works on
distant shell (like `ssh`_) while staying gentle with your bandwidth.
Libervia TUI is the Terminal User Interface. In other words, it works in console and is
intended for people at ease with it. Its text only interface has several advantages: you
get rid of many distracting things (like images), it works without graphical environment
installed (which is often the case on servers) and it works on distant shell (like `ssh`_)
while staying gentle with your bandwidth.
Primitivus is shipped with the backend, so it should be always available once Libervia is
installed (but some distributions may provide it separately).
Libervia TUI is shipped with the backend, so it should be always available once Libervia
is installed (but some distributions may provide it separately).
You can check :doc:`Libervia TUI documentation <libervia-tui/index>` for more details.
.. The TUI is temporarily on hold and broken, its documentation is not
.. included in the build for the moment.
.. _ssh: https://en.wikipedia.org/wiki/Secure_Shell
Libervia CLI (jp)
-----------------
Libervia CLI
------------
Libervia CLI (alias ``li`` or ``jp``) is the Command Line Interface. It's a
powerful tool which allows to do nearly everything you can do with other frontends.