diff doc/libervia-cli/identity.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/identity.rst@6cf4bd6972c2
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libervia-cli/identity.rst	Sun Mar 21 18:23:58 2021 +0100
@@ -0,0 +1,36 @@
+=============================
+identity: identity management
+=============================
+
+Identity use several XMPP extensions (like vcards) to retrieve or set informations about
+an entity. For now it's really basic and only nickname and avatar are managed.
+
+get
+===
+
+Retrieve informations about the identity behind an XMPP entity. You only have to specify
+the jid of the entity, and you'll get (if set) his/her/its nickname and data about the
+avatar.
+
+When available, cached values are 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 identity information about an entity::
+
+  $ li identity get somebody@example.org
+
+set
+===
+
+Set identity data to the server, using various XMPP extensions. So far, you can only
+change the nickname of an entity using ``-n, --nick`` or or more times
+
+example
+-------
+
+Set 2 nicknames for default profile::
+
+  $ li identity set -n toto -n titi