Mercurial > libervia-backend
comparison doc/jp/roster.rst @ 3255:012e89fb2dd1
jp (roster): new roster/set command
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Tue, 14 Apr 2020 21:01:04 +0200 |
| parents | 72583524cfd3 |
| children | 7b58b15bd121 |
comparison
equal
deleted
inserted
replaced
| 3254:6cf4bd6972c2 | 3255:012e89fb2dd1 |
|---|---|
| 46 $ jp roster get -vv | 46 $ jp roster get -vv |
| 47 | 47 |
| 48 Get roster or default profile and show the result in JSON:: | 48 Get roster or default profile and show the result in JSON:: |
| 49 | 49 |
| 50 $ jp roster get -O json | 50 $ jp roster get -O json |
| 51 | |
| 52 set | |
| 53 === | |
| 54 | |
| 55 Set metadata for a roster entity. Only ``name`` and ``groups`` can be set, ``name`` being | |
| 56 the user chosed name to use with a contact. | |
| 57 | |
| 58 By default, values are appended, i.e. if ``name`` is not set it won't delete existing one, | |
| 59 and ``groups`` are appended to existing one. However, if you use the ``-R, --replace`` | |
| 60 option, former values will be entirely replaced by given ones (i.e. if you don't use ``-n | |
| 61 NAME, --name NAME`` option, the former one will be deleted, and any former group no added | |
| 62 using ``-g GROUP, --group GROUP`` will be removed). | |
| 63 | |
| 64 example | |
| 65 ------- | |
| 66 | |
| 67 Set a name used to privately identify your contact Louise:: | |
| 68 | |
| 69 $ jp roster set -n Enjolras louise@example.net | |
| 70 | |
| 71 Replace all groups of Pierre, to add him only to ``friends`` and ``housemates``:: | |
| 72 | |
| 73 $ jp roster set -g friends -g housemates pierre@example.net | |
| 51 | 74 |
| 52 stats | 75 stats |
| 53 ===== | 76 ===== |
| 54 | 77 |
| 55 Show some statistics about the profile roster. The number of contacts per server is shown, | 78 Show some statistics about the profile roster. The number of contacts per server is shown, |