Mercurial > libervia-backend
comparison doc/jp/avatar.rst @ 3041:72583524cfd3
doc (jp): jp commands are now fully documented:
rel 232
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Tue, 01 Oct 2019 22:49:06 +0200 |
| parents | |
| children | 6cf4bd6972c2 |
comparison
equal
deleted
inserted
replaced
| 3040:fee60f17ebac | 3041:72583524cfd3 |
|---|---|
| 1 =============================== | |
| 2 avatar: retrieve/upload avatars | |
| 3 =============================== | |
| 4 | |
| 5 Avatars are images associated to an XMPP entity. Several XMPP extensions are in use, SàT | |
| 6 tries to hide the technical details so avatar are as easy as possible to manipulate for | |
| 7 end-user. | |
| 8 | |
| 9 get | |
| 10 === | |
| 11 | |
| 12 Retrieve the avatar of the given entity. Entity jid is specified as positional argument. | |
| 13 | |
| 14 If an avatar is found, a path to its cached file is printed. Please note that this is the | |
| 15 cache used by all SàT ecosystem, **do not modify the cached image**. You may use it for | |
| 16 read-only access, or copy it if you want to modify the image. | |
| 17 | |
| 18 You may use the ``-s, --show`` argument to display the found avatar. The software used to | |
| 19 display the image can be specified in SàT configuration (cf. :ref:`configuration`), in the | |
| 20 ``[jp]`` section: the ``image_cmd`` setting let you specify the path to the software. If | |
| 21 ``image_cmd`` is not used, ``jp`` will try some common software, and if none is found, it | |
| 22 will try to open the image in a browser (which may sometimes result in using the default | |
| 23 image software of the platform). | |
| 24 | |
| 25 example | |
| 26 ------- | |
| 27 | |
| 28 Get the avatar of ``louise@example.org`` and display it:: | |
| 29 | |
| 30 $ jp avatar get --show louise@example.org | |
| 31 | |
| 32 | |
| 33 set | |
| 34 === | |
| 35 | |
| 36 Upload and set the given avatar for the profile. The only required argument is the path to | |
| 37 the image to use as avatar. | |
| 38 | |
| 39 example | |
| 40 ------- | |
| 41 | |
| 42 Set the avatar of the default profile:: | |
| 43 | |
| 44 $ jp avatar set ~/photos/some_photo.jpg |