diff doc/jp/pubsub.rst @ 3100:cea52c9ddfd9

plugin XEP-0060, jp (pubsub/set): publish-options implementation: - publishing options (XEP-0060 §7.1.5) implementation. - jp pubsub/set can specify publish-options using `-f` and `-F` - doc has been updated to explain that - psItemSend and psItemsSend now use serialisation for "extra" - publish-options can be specified in extra['publish-options'] with those methods
author Goffi <goffi@goffi.org>
date Sat, 28 Dec 2019 20:02:18 +0100
parents 72583524cfd3
children
line wrap: on
line diff
--- a/doc/jp/pubsub.rst	Fri Dec 27 13:30:20 2019 +0100
+++ b/doc/jp/pubsub.rst	Sat Dec 28 20:02:18 2019 +0100
@@ -17,6 +17,15 @@
 
 ``stdin`` is used to get the raw XML of the payload of the item to publish.
 
+``-f KEY VALUE, --field KEY VALUE`` can be used to specify publish options, i.e. option
+which must be set if the node already exists, or used if the node is to be created, see
+`XEP-0060 §7.1.5`_ for details.
+
+In the same way as for :ref:`jp-pubsub_node_create`, ``-F, --full-prefix`` can be used if
+you need to specify the full option name.
+
+.. _XEP-0060 §7.1.5: https://xmpp.org/extensions/xep-0060.html#publisher-publish-options
+
 example
 -------