Mercurial > libervia-backend
comparison doc/libervia-cli/info.rst @ 4036:c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
fix 418
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 07 Apr 2023 15:18:39 +0200 |
| parents | c80a0f864b5d |
| children |
comparison
equal
deleted
inserted
replaced
| 4035:9c76678a39e2 | 4036:c4464d7ae97b |
|---|---|
| 6 ``info`` groups subcommands used to retrieve read-only informations. | 6 ``info`` groups subcommands used to retrieve read-only informations. |
| 7 | 7 |
| 8 disco | 8 disco |
| 9 ===== | 9 ===== |
| 10 | 10 |
| 11 Display discovery information (see `XEP-0030`_ for details). This can be used to check | 11 Display discovery information, including external discovery (see `XEP-0030`_ and |
| 12 which features you server or a service is offering, and which items are available (items | 12 `XEP-0215`_ for details). This can be used to check which features you server or a service |
| 13 can be services like chat room, gateways, etc). | 13 is offering, which items are available (items can be services like chat room, gateways, |
| 14 etc), ans which external services (i.e. non-XMPP services) are proposed. | |
| 14 | 15 |
| 15 You only have to specify the jid of the entity to check, and optionally a node. | 16 You only have to specify the jid of the entity to check, and optionally a node. If a node |
| 17 is specified, external services won't be retrieved even if ``all`` is used (as external | |
| 18 services don't have the notion of "node"). | |
| 16 | 19 |
| 17 By default both infos and items are requested, but you can restrict what to request by | 20 By default everything is requested (infos, items and external services), but you can |
| 18 using ``-t {infos,items,both}, --type {infos,items,both}`` | 21 restrict what to request by using ``-t {infos,items,both,external,all}, --type |
| 22 {infos,items,both,external,all}`` where ``both`` means infos and items, and ``all`` mean | |
| 23 than + external services. | |
| 24 | |
| 19 | 25 |
| 20 .. _XEP-0030: https://xmpp.org/extensions/xep-0030.html | 26 .. _XEP-0030: https://xmpp.org/extensions/xep-0030.html |
| 27 .. _XEP-0215: https://xmpp.org/extensions/xep-0215.html | |
| 21 | 28 |
| 22 | 29 |
| 23 example | 30 example |
| 24 ------- | 31 ------- |
| 25 | 32 |
| 26 Request infos and items from a server:: | 33 Request infos, items and external services from a server:: |
| 27 | 34 |
| 28 $ li info disco example.org | 35 $ li info disco example.org |
| 29 | 36 |
| 30 version | 37 version |
| 31 ======= | 38 ======= |