changeset 3836:e183f1fbfa8d

doc (cli/pubsub): add doc for ``reference`` subcommand: rel 369
author Goffi <goffi@goffi.org>
date Sun, 10 Jul 2022 16:15:09 +0200 (2022-07-10)
parents f599e0e36444
children 56720561f45f
files doc/libervia-cli/pubsub.rst
diffstat 1 files changed, 15 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/libervia-cli/pubsub.rst	Sun Jul 10 16:15:09 2022 +0200
+++ b/doc/libervia-cli/pubsub.rst	Sun Jul 10 16:15:09 2022 +0200
@@ -195,7 +195,7 @@
   $ li pubsub subscriptions --public -s pierre@example.net
 
 affiliations
-=============
+============
 
 Retrieve affiliations for all nodes at a service.
 
@@ -212,6 +212,20 @@
 
   $ li pubsub affiliations -s pubsub@example.net -n notes
 
+reference
+=========
+
+Send a reference (e.g. a mention) of a pubsub item to an entity.
+
+example
+-------
+
+Pierre send a reference to Louise to indicate that she has been mentioned in his blog post
+with ID ``from-paris-to-noumea-abcd``::
+
+  $ li pubsub reference -s pierre@example.net -n urn:xmpp:microblog:0 -i from-paris-to-noumea-abcd louise@example.org
+
+
 search
 ======