diff doc/libervia-cli/pubsub.rst @ 3951:4b8776eb6826

doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling: fix 380
author Goffi <goffi@goffi.org>
date Sat, 15 Oct 2022 20:38:33 +0200
parents 8b76caa89aa0
children 9f85369294f3
line wrap: on
line diff
--- a/doc/libervia-cli/pubsub.rst	Sat Oct 15 20:38:33 2022 +0200
+++ b/doc/libervia-cli/pubsub.rst	Sat Oct 15 20:38:33 2022 +0200
@@ -24,6 +24,8 @@
 In the same way as for :ref:`libervia-cli_pubsub_node_create`, ``-F, --full-prefix`` can be used if
 you need to specify the full option name.
 
+|e2e_arg|
+
 .. _XEP-0060 ยง7.1.5: https://xmpp.org/extensions/xep-0060.html#publisher-publish-options
 
 example
@@ -40,6 +42,10 @@
 
 Retrieve items from specified node. Default output is prettified and highlighted XML.
 
+If the node is end-to-end encrypted, items will be automatically and transparently
+decrypted if the shared secrets are known. If you want to avoid this behaviour and get the
+items undecrypted, you can use the ``--no-decrypt`` flag.
+
 example
 -------
 
@@ -75,6 +81,8 @@
 
 :ref:`draft_common` commands can be used.
 
+|e2e_arg|
+
 example
 -------
 
@@ -450,6 +458,11 @@
 Subcommands to add or remove data attached to pubsub items. Please check
 :ref:`libervia-cli_pubsub_attachments`.
 
+secret
+======
+
+Subcommands for pubsub node shared secrets management. Please check :ref:`libervia-cli_pubsub_secret`.
+
 hook
 ====