diff doc/libervia-cli/pubsub.rst @ 3563:267e4987b58b

doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
author Goffi <goffi@goffi.org>
date Fri, 11 Jun 2021 09:21:41 +0200
parents 4705f80b6e23
children 7c4fcef5b561 7acf19bdca2f
line wrap: on
line diff
--- a/doc/libervia-cli/pubsub.rst	Fri Jun 11 09:19:43 2021 +0200
+++ b/doc/libervia-cli/pubsub.rst	Fri Jun 11 09:21:41 2021 +0200
@@ -45,6 +45,8 @@
 
   $ li pubsub get -n notes -m 5
 
+.. _li_pubsub_delete:
+
 delete
 ======
 
@@ -77,6 +79,25 @@
 
   $ li pubsub edit -n notes -L
 
+.. _li-pubsub_rename:
+
+rename
+======
+
+Move a item to a new ID. As there is currently no "rename" or "move" operation in XMPP
+PubSub, this is done by republishing the item with the new ID, then deleting the old item
+if the publication succeed.
+
+This is notably useful when user friendly URL based on ID are used, and one need to fix a
+typo or something else.
+
+example
+-------
+
+Rename a PubSub item with ID ``123`` to ``456``::
+
+  $ li pubsub rename -n some_node -i 123 456
+
 subscribe
 =========
 
@@ -292,7 +313,7 @@
 
 If you have to modify the ``publisher`` of an item, you need specific privileges. The
 ``--admin`` allows you do to that, but it must be supported by your PubSub service
-(currently only ``SàT PubSub`` supports this non standard feature).
+(currently only ``Libervia PubSub`` supports this non standard feature).
 
 To modify all items of a node, use the ``-A, --all`` option. This will use `RSM`_
 repetitively until all items are treated. Of course that means that your PubSub service