Mercurial > libervia-backend
diff 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 |
line wrap: on
line diff
--- a/doc/jp/roster.rst Tue Apr 14 21:00:33 2020 +0200 +++ b/doc/jp/roster.rst Tue Apr 14 21:01:04 2020 +0200 @@ -49,6 +49,29 @@ $ jp roster get -O json +set +=== + +Set metadata for a roster entity. Only ``name`` and ``groups`` can be set, ``name`` being +the user chosed name to use with a contact. + +By default, values are appended, i.e. if ``name`` is not set it won't delete existing one, +and ``groups`` are appended to existing one. However, if you use the ``-R, --replace`` +option, former values will be entirely replaced by given ones (i.e. if you don't use ``-n +NAME, --name NAME`` option, the former one will be deleted, and any former group no added +using ``-g GROUP, --group GROUP`` will be removed). + +example +------- + +Set a name used to privately identify your contact Louise:: + + $ jp roster set -n Enjolras louise@example.net + +Replace all groups of Pierre, to add him only to ``friends`` and ``housemates``:: + + $ jp roster set -g friends -g housemates pierre@example.net + stats =====