Mercurial > libervia-backend
diff doc/libervia-cli/pubsub_node_subscriptions.rst @ 3771:e597dbfbc4c6
doc (cli/pubsub): document new `--public` flags:
`--public` option is documented for `subscribe`, `subscriptions` and `node subscriptions
get`, with examples. A warning has been added to show explicitely the privacy implication
of using `--public` with `subscribe`.
rel 365
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 13 May 2022 19:32:06 +0200 |
| parents | c80a0f864b5d |
| children |
line wrap: on
line diff
--- a/doc/libervia-cli/pubsub_node_subscriptions.rst Fri May 13 19:29:17 2022 +0200 +++ b/doc/libervia-cli/pubsub_node_subscriptions.rst Fri May 13 19:32:06 2022 +0200 @@ -13,6 +13,13 @@ Retrieve subscriptions to a node. +If ``--public`` is used, only public subscriptions are retrieved (if target service +supports `XEP-0465 Public Pubsub Subscriptions`). Public subscriptions are accessible to +anybody, thus you can use this on a node even if you are not an owner of it (and thus +would not normally be allowed to retrieve subscriptions). + +.. _XEP-0465 Public Pubsub Subscriptions: https://xmpp.org/extensions/inbox/pubsub-public-subscriptions.html + example ------- @@ -20,6 +27,10 @@ $ li pubsub node subscriptions get -n some_node +Retrieve public subscribers to the blog of Louise:: + + $ li pubsub node subscriptions get --public -s louise@example.org -n urn:xmpp:microblog:0 + set ===