Mercurial > libervia-backend
changeset 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 | 9c76678a39e2 |
children | 524856bd7b19 |
files | doc/libervia-cli/info.rst |
diffstat | 1 files changed, 14 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/libervia-cli/info.rst Fri Apr 07 15:18:05 2023 +0200 +++ b/doc/libervia-cli/info.rst Fri Apr 07 15:18:39 2023 +0200 @@ -8,22 +8,29 @@ disco ===== -Display discovery information (see `XEP-0030`_ for details). This can be used to check -which features you server or a service is offering, and which items are available (items -can be services like chat room, gateways, etc). +Display discovery information, including external discovery (see `XEP-0030`_ and +`XEP-0215`_ for details). This can be used to check which features you server or a service +is offering, which items are available (items can be services like chat room, gateways, +etc), ans which external services (i.e. non-XMPP services) are proposed. -You only have to specify the jid of the entity to check, and optionally a node. +You only have to specify the jid of the entity to check, and optionally a node. If a node +is specified, external services won't be retrieved even if ``all`` is used (as external +services don't have the notion of "node"). -By default both infos and items are requested, but you can restrict what to request by -using ``-t {infos,items,both}, --type {infos,items,both}`` +By default everything is requested (infos, items and external services), but you can +restrict what to request by using ``-t {infos,items,both,external,all}, --type +{infos,items,both,external,all}`` where ``both`` means infos and items, and ``all`` mean +than + external services. + .. _XEP-0030: https://xmpp.org/extensions/xep-0030.html +.. _XEP-0215: https://xmpp.org/extensions/xep-0215.html example ------- -Request infos and items from a server:: +Request infos, items and external services from a server:: $ li info disco example.org