Mercurial > libervia-backend
comparison doc/libervia-cli/common_arguments.rst @ 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 |
parents | c80a0f864b5d |
children | 256faf6e951f |
comparison
equal
deleted
inserted
replaced
3607:bc043afedbac | 3608:6d03e8ebf1a6 |
---|---|
85 Note that this is using the pubsub max (i.e. defined in | 85 Note that this is using the pubsub max (i.e. defined in |
86 `XEP-0060 <https://xmpp.org/extensions/xep-0060.html>`_). Modern pubsub services should | 86 `XEP-0060 <https://xmpp.org/extensions/xep-0060.html>`_). Modern pubsub services should |
87 implement `Result Set Management <https://xmpp.org/extensions/xep-0059.html>`_ (RSM) and in | 87 implement `Result Set Management <https://xmpp.org/extensions/xep-0059.html>`_ (RSM) and in |
88 this case the ``-m, --max`` argument should be prefered. See below for RSM common | 88 this case the ``-m, --max`` argument should be prefered. See below for RSM common |
89 arguments. | 89 arguments. |
90 | |
91 ``-C, --no-cache`` | |
92 skip pubsub cache. By default, internal pubsub cache is used automatically if requested | |
93 items are available there. With this option set, a request to the pubsub service will | |
94 always be done, regardless of presence of node items in internal cache. | |
90 | 95 |
91 result set management | 96 result set management |
92 ===================== | 97 ===================== |
93 | 98 |
94 Result Set Management (RSM) common arguments are used to navigate into pages of results | 99 Result Set Management (RSM) common arguments are used to navigate into pages of results |
189 Output is used when you want to get the result of the command in a specific way. It may be | 194 Output is used when you want to get the result of the command in a specific way. It may be |
190 used, for instance, to retrieve the result formatted in JSON so the data can be easily | 195 used, for instance, to retrieve the result formatted in JSON so the data can be easily |
191 manipulated by a script, or if you want only a specific element of the result. | 196 manipulated by a script, or if you want only a specific element of the result. |
192 | 197 |
193 ``-O {…}, --output {…}`` | 198 ``-O {…}, --output {…}`` |
194 specifiy the output to use. Available options depends of the command you are using, | 199 specify the output to use. Available options depends of the command you are using, |
195 check ``li [your command] --help`` to know them. | 200 check ``li [your command] --help`` to know them. |
196 | 201 |
197 e.g.:: | 202 e.g.:: |
198 | 203 |
199 $ li blog get -O json | 204 $ li blog get -O json |
207 | 212 |
208 $ li blog | 213 $ li blog |
209 | 214 |
210 Some options expect parameters, in this case they can be specified using ``=``. | 215 Some options expect parameters, in this case they can be specified using ``=``. |
211 | 216 |
212 e.g. specifiying a template to use:: | 217 e.g. specifying a template to use:: |
213 | 218 |
214 $ li blog get -O template --oo browser --oo template=/tmp/my_template.html | 219 $ li blog get -O template --oo browser --oo template=/tmp/my_template.html |