From f627edaabec6166deff677956152345552a20e38 Mon Sep 17 00:00:00 2001 From: Goffi Date: Wed, 24 Jul 2019 07:51:07 +0200 Subject: [PATCH] doc: some corrections: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - added missing `tls_private_key` value in configuration sample - added a label for `installation` - removed useless repetition of "Salut à Toi" in overview title - changed text for jp and primitivus documentations links - use a better may to indicate keyboard shortcuts in Primitivus --- doc/configuration.rst | 2 +- doc/installation.rst | 2 ++ doc/overview.rst | 10 +++---- doc/primitivus/index.rst | 59 +++++++++++++++++++++------------------- 4 files changed, 39 insertions(+), 34 deletions(-) diff --git a/doc/configuration.rst b/doc/configuration.rst index 3526f7cd..22b95a6e 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -138,7 +138,7 @@ the comments to get the meaning of each option. ; and public certificate combined (PEM format) tls_certificate = libervia.pem ; TLS certificate private key (PEM format) - tls_private_key + tls_private_key = libervia-key.pem ; if true (or 1), HTTP will redirect to HTTPS redirect_to_https = 1 ; passphrase for libervia profile diff --git a/doc/installation.rst b/doc/installation.rst index 7069b121..a2501bae 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -1,3 +1,5 @@ +.. _installation: + ============ Installation ============ diff --git a/doc/overview.rst b/doc/overview.rst index b1f39c97..7f8a6d56 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -1,6 +1,6 @@ -==================== -Salut à Toi Overview -==================== +======== +Overview +======== To have a better understanding of Salut a Toi, this page gives a global view of what it is and what are the important concepts linked to it. You don't need to read this to use it, but you @@ -119,7 +119,7 @@ environment installed (which is often the case on servers) and it works on dista Primitivus is shipped with the backend, so it should be always available once SàT is installed (but some distributions may provide it separately). -You can check :ref:`primitivus-documentation` documentation for more details. +You can check :doc:`Primitivus documentation ` for more details. .. _ssh: https://en.wikipedia.org/wiki/Secure_Shell @@ -130,7 +130,7 @@ Jp is the Command Line Interface (CLI). It's a powerful tool which allows to do everything you can do with other frontends. Particularly useful if you want to check something quickly, or if you want to do some automation. -You can check :ref:`jp-documentation` documentation for more details. +You can check :doc:`jp documentation ` documentation for more details. Glossary diff --git a/doc/primitivus/index.rst b/doc/primitivus/index.rst index 53ab889b..87d241eb 100644 --- a/doc/primitivus/index.rst +++ b/doc/primitivus/index.rst @@ -34,34 +34,37 @@ keyboard. Below, the keyboard shortcuts are explained. Keyboard handling ----------------- -- ``C`` stands for ``Ctrl`` -- ``M`` means *Meta*, on a PC it is usually the ``Alt`` key -- ``S`` stands for ``Shift`` +- ``+`` means that 2 keys must be pressed at the same time. Example: ``CTRL + N`` means that + you must press Control key and ``N`` at the same time +- ``,`` means that a key must be pressed after the previous combination. Example: + ``CTRL + F, M`` means that you must press control key and ``F`` at the same time, release + them, then press ``M`` +- keys with ``SHIFT`` also work without ``SHIFT`` if ``[CapsLock]`` is set. Main keys ~~~~~~~~~ -``[tab]`` and/or ``C-up/down arrows`` +``[Tab]`` and/or ``CTRL + up/down arrows`` change focus -``C-x`` +``CTRL + X`` quit Primitivus -``C-f 1`` or ``C-f m`` +``CTRL + F, 1`` or ``CTRL + F, M`` focus on the menu -``C-f 2`` or ``C-f b`` +``CTRL + F, 2`` or ``CTRL + F, B`` focus on the roster or the chat window -``C-f 3`` or ``C-f e`` +``CTRL + F, 3`` or ``CTRL + F, E`` focus on the edition line -``M-m`` +``ALT + M`` display/hide the menu -``C-n`` +``CTRL + N`` show the next notification -``C-s`` +``CTRL + S`` hide/redisplay a pop-up window temporarily -``C-d`` +``CTRL + D`` enter debug mode (development versions only) ``F2`` hide/display the roster -``C-l`` +``CTRL + L`` refresh the screen Chat rooms @@ -69,37 +72,37 @@ Chat rooms To use those keyboard shortcuts, your cursor must be in a chat room. -``M-j`` +``ALT + J`` join a chat room -``M-p`` +``ALT + P`` hide/display the list of participants -``M-t`` +``ALT + T`` hide/display timestamps -``M-n`` +``ALT + N`` use/don't use short nicks -``M-l`` +``ALT + L`` hide/display frame decorations -``M-s`` +``ALT + S`` change the room's topic appearance by switching between: - one single line (the topic is cut if it's too long) - the full topic - topic hidden -``G`` +``SHIFT + G`` go to the end (bottom) of your history (note that this is UPPERCASE ``G``) Edition line ~~~~~~~~~~~~ -``C-a`` or ``[home]`` +``CTRL + A`` or ``[Home]`` move the cursor at the beginning of the line -``C-e`` or ``[end]`` +``CTRL + E`` or ``[End]`` move the cursor at the end of the line -``C-k`` +``CTRL + K`` erase the line, starting at the cursor's position -``C-w`` +``CTRL + W`` erase the last word -``S-[tab]`` +``S + [Tab]`` invoke completion (dependent on the context) ``up/down arrows`` browse sent messages history @@ -107,15 +110,15 @@ Edition line Contacts ~~~~~~~~ -``M-d`` +``ALT + D`` hide/display offline contacts -``M-s`` +``ALT + S`` hide/display contacts' status messages Card game ~~~~~~~~~ -``space`` +``[space]`` select a card Commands