changeset 3608:6d03e8ebf1a6

doc (cli/common): explain the new `-C, --no-cache` option
author Goffi <goffi@goffi.org>
date Thu, 29 Jul 2021 22:51:01 +0200 (2021-07-29)
parents bc043afedbac
children 256faf6e951f
files doc/libervia-cli/common_arguments.rst
diffstat 1 files changed, 7 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/doc/libervia-cli/common_arguments.rst	Thu Jul 29 22:51:01 2021 +0200
+++ b/doc/libervia-cli/common_arguments.rst	Thu Jul 29 22:51:01 2021 +0200
@@ -88,6 +88,11 @@
   this case the ``-m, --max`` argument should be prefered. See below for RSM common
   arguments.
 
+``-C, --no-cache``
+  skip pubsub cache. By default, internal pubsub cache is used automatically if requested
+  items are available there. With this option set, a request to the pubsub service will
+  always be done, regardless of presence of node items in internal cache.
+
 result set management
 =====================
 
@@ -191,7 +196,7 @@
 manipulated by a script, or if you want only a specific element of the result.
 
 ``-O {…}, --output {…}``
-  specifiy the output to use. Available options depends of the command you are using,
+  specify the output to use. Available options depends of the command you are using,
   check ``li [your command] --help`` to know them.
 
   e.g.::
@@ -209,6 +214,6 @@
 
   Some options expect parameters, in this case they can be specified using ``=``.
 
-  e.g. specifiying a template to use::
+  e.g. specifying a template to use::
 
     $ li blog get -O template --oo browser --oo template=/tmp/my_template.html