diff doc/libervia-cli/avatar.rst @ 3488:c80a0f864b5d

doc: updated doc following global renaming
author Goffi <goffi@goffi.org>
date Sun, 21 Mar 2021 18:23:58 +0100
parents doc/jp/avatar.rst@6cf4bd6972c2
children 267e4987b58b
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libervia-cli/avatar.rst	Sun Mar 21 18:23:58 2021 +0100
@@ -0,0 +1,47 @@
+===============================
+avatar: retrieve/upload avatars
+===============================
+
+Avatars are images associated to an XMPP entity. Several XMPP extensions are in use, SàT
+tries to hide the technical details so avatar are as easy as possible to manipulate for
+end-user.
+
+get
+===
+
+Retrieve the avatar of the given entity. Entity jid is specified as positional argument.
+
+If an avatar is found, a path to its cached file is printed. Please note that this is the
+cache used by all SàT ecosystem, **do not modify the cached image**. You may use it for
+read-only access, or copy it if you want to modify the image.
+
+You may use the ``-s, --show`` argument to display the found avatar. The software used to
+display the image can be specified in SàT configuration (cf. :ref:`configuration`), in the
+``[li]`` section: the ``image_cmd`` setting let you specify the path to the software. If
+``image_cmd`` is not used, ``li`` will try some common software, and if none is found, it
+will try to open the image in a browser (which may sometimes result in using the default
+image software of the platform).
+
+When available, cached avatar is returned by defaut. If you want to ignore the cache, use
+the ``--no-cache`` option (of course this can result in more network requests).
+
+example
+-------
+
+Get the avatar of ``louise@example.org`` and display it::
+
+  $ li avatar get --show louise@example.org
+
+
+set
+===
+
+Upload and set the given avatar for the profile. The only required argument is the path to
+the image to use as avatar.
+
+example
+-------
+
+Set the avatar of the default profile::
+
+  $ li avatar set ~/photos/some_photo.jpg