comparison doc/libervia-cli/pubsub.rst @ 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
parents e597dbfbc4c6
children 8b76caa89aa0
comparison
equal deleted inserted replaced
3835:f599e0e36444 3836:e183f1fbfa8d
193 following command:: 193 following command::
194 194
195 $ li pubsub subscriptions --public -s pierre@example.net 195 $ li pubsub subscriptions --public -s pierre@example.net
196 196
197 affiliations 197 affiliations
198 ============= 198 ============
199 199
200 Retrieve affiliations for all nodes at a service. 200 Retrieve affiliations for all nodes at a service.
201 201
202 ``-n NODE, --node NODE`` can be used to request affiliation for a specific node. 202 ``-n NODE, --node NODE`` can be used to request affiliation for a specific node.
203 203
209 $ li pubsub affiliations -s pubsub@example.net 209 $ li pubsub affiliations -s pubsub@example.net
210 210
211 Retrieve affiliation for the ``notes`` node:: 211 Retrieve affiliation for the ``notes`` node::
212 212
213 $ li pubsub affiliations -s pubsub@example.net -n notes 213 $ li pubsub affiliations -s pubsub@example.net -n notes
214
215 reference
216 =========
217
218 Send a reference (e.g. a mention) of a pubsub item to an entity.
219
220 example
221 -------
222
223 Pierre send a reference to Louise to indicate that she has been mentioned in his blog post
224 with ID ``from-paris-to-noumea-abcd``::
225
226 $ li pubsub reference -s pierre@example.net -n urn:xmpp:microblog:0 -i from-paris-to-noumea-abcd louise@example.org
227
214 228
215 search 229 search
216 ====== 230 ======
217 231
218 Search items corresponding to one or more filter(s). 232 Search items corresponding to one or more filter(s).