doc (cli): add isolation (-i/--isolation) documentation

This commit is contained in:
Goffi 2026-11-03 20:57:37 +01:00
commit 40fef895ba

View file

@ -37,37 +37,29 @@ After the commands come the options. For instance if you want to send a message,
get the available options with ``--help`` as explained above::
$ li message send --help
usage: li message send [-h] [-p PROFILE] [--pwd PASSWORD] [-c] [-l LANG] [-s]
[-n] [-S SUBJECT] [-L SUBJECT_LANG]
usage: li message send [-h] [-p PROFILE] [--pwd PASSWORD] [-c]
[-t {chat,error,groupchat,headline,normal,auto}]
[-e ALGORITHM] [--encrypt-noreplace] [-x | -r]
[-e ALGORITHM] [--encrypt-noreplace] […]
jid
positional arguments:
jid the destination jid
optional arguments:
options:
-h, --help show this help message and exit
-p PROFILE, --profile PROFILE
-p, --profile PROFILE
Use PROFILE profile key (default: @DEFAULT@)
--pwd PASSWORD Password used to connect profile, if necessary
-c, --connect Connect the profile before doing anything else
-l LANG, --lang LANG language of the message
-s, --separate separate xmpp messages: send one message per line
instead of one message alone.
-n, --new-line add a new line at the beginning of the input (usefull
for ascii art ;))
-S SUBJECT, --subject SUBJECT
subject of the message
-L SUBJECT_LANG, --subject_lang SUBJECT_LANG
language of subject
-t {chat,error,groupchat,headline,normal,auto}, --type {chat,error,groupchat,headline,normal,auto}
-t, --type {chat,error,groupchat,headline,normal,auto}
type of the message
-e ALGORITHM, --encrypt ALGORITHM
-e, --encrypt ALGORITHM
encrypt message using given algorithm
--encrypt-noreplace don't replace encryption algorithm if an other one is
--encrypt-noreplace don't replace encryption algorithm if another one is
already used
-x, --xhtml XHTML body
[…]
The output above has been shortened: use ``--help`` to see the full list of options.
If you want to send a message to, say, ``pierre@example.net``, and encrypt it with OMEMO,
just do the following::
@ -77,6 +69,25 @@ just do the following::
(note that with OMEMO, you need to have previously validated fingerprint of your contact
for this to work).
.. _li_isolation:
Isolation
---------
Several Libervia instances can run side by side, each with its own data, this is called
isolation (see :ref:`configuration_isolation` for details). The instance to work with is
selected with the ``-i/--isolation NAME`` option, which must be used before the command:
.. code-block:: console
$ li -i pubsub profile list
.. note::
If the ``LIBERVIA_ISOLATION`` environment variable is already set, this option is not
needed, unless you want to work with another instance (the option takes priority over
the environment variable).
The different commands are explained in dedicated sections.
.. toctree::