Mercurial > libervia-backend
annotate doc/libervia-cli/info.rst @ 4294:a0ed5c976bf8 default tip @
component conferences, plugin XEP-0167, XEP-0298: add stream user metadata:
A/V conference now adds user metadata about the stream it is forwarding through XEP-0298.
This is parsed and added to metadata during confirmation on client side.
rel 448
author | Goffi <goffi@goffi.org> |
---|---|
date | Tue, 06 Aug 2024 23:43:11 +0200 |
parents | c4464d7ae97b |
children |
rev | line source |
---|---|
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
1 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 ================================== |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 info: retrieve various information |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 ================================== |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
5 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 ``info`` groups subcommands used to retrieve read-only informations. |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 disco |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 ===== |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 |
4036
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
11 Display discovery information, including external discovery (see `XEP-0030`_ and |
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
12 `XEP-0215`_ for details). This can be used to check which features you server or a service |
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
13 is offering, which items are available (items can be services like chat room, gateways, |
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
14 etc), ans which external services (i.e. non-XMPP services) are proposed. |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 |
4036
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
16 You only have to specify the jid of the entity to check, and optionally a node. If a node |
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
17 is specified, external services won't be retrieved even if ``all`` is used (as external |
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
18 services don't have the notion of "node"). |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 |
4036
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
20 By default everything is requested (infos, items and external services), but you can |
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
21 restrict what to request by using ``-t {infos,items,both,external,all}, --type |
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
22 {infos,items,both,external,all}`` where ``both`` means infos and items, and ``all`` mean |
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
23 than + external services. |
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
24 |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
25 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
26 .. _XEP-0030: https://xmpp.org/extensions/xep-0030.html |
4036
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
27 .. _XEP-0215: https://xmpp.org/extensions/xep-0215.html |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
28 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
29 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
30 example |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
31 ------- |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
32 |
4036
c4464d7ae97b
dpc (cli/info): update "disco" documentation to include new "external services":
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
33 Request infos, items and external services from a server:: |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
34 |
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3206
diff
changeset
|
35 $ li info disco example.org |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
36 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
37 version |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
38 ======= |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
39 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
40 Request software version of an entity. You only need to specify the jid of the entity as |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
41 positional argument. |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
42 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
43 Depending of the software and its configuration, you have software version, software name, |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
44 and the operating system on which the software is running. |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
45 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
46 example |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
47 ------- |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
48 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
49 Check version of a server:: |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
50 |
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3206
diff
changeset
|
51 $ li info version example.org |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
52 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
53 session |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
54 ------- |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
55 |
3072 | 56 Give information about the session of the given profile. You'll get the full jid currently |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
57 used on the server, and the time when the session was started (which may not be the same |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
58 time as when the connection with the XMPP server was started). |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
59 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
60 example |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
61 ------- |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
62 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
63 Get session informations:: |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
64 |
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3206
diff
changeset
|
65 $ li info session |
3206
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
66 |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
67 devices |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
68 ------- |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
69 |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
70 List known devices for an entity. You'll get resource name, and data such as presence |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
71 data, and identities (i.e. name and type of the client used). |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
72 |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
73 If entity's bare jid is not specified, a list of your own devices is returned. |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
74 |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
75 example |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
76 ------- |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
77 |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
78 List known devices of Louise:: |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
79 |
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3206
diff
changeset
|
80 $ li info devices louise@example.org |
3206
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
81 |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
82 Check if we have other devices connected:: |
ae09989e9feb
core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity
Goffi <goffi@goffi.org>
parents:
3072
diff
changeset
|
83 |
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3206
diff
changeset
|
84 $ li info devices |