diff doc/jp/identity.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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/jp/identity.rst	Tue Oct 01 22:49:06 2019 +0200
@@ -0,0 +1,34 @@
+=============================
+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 a link to the
+cached avatar.
+
+example
+--------
+
+Get identity information about an entity::
+
+  $ jp identity get somebody@example.org
+
+set
+===
+
+Set identity data to the server, using various XMPP extensions. You set the data to change
+using ``-f KEY VALUE, --field KEY VALUE``, where ``KEY`` can only be ``nick`` at the
+moment.
+
+example
+-------
+
+Set the nickname of default profile::
+
+  $ jp identity set -f nick toto