Mercurial > libervia-backend
comparison doc/libervia-cli/ping.rst @ 3488:c80a0f864b5d
doc: updated doc following global renaming
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sun, 21 Mar 2021 18:23:58 +0100 |
| parents | doc/jp/ping.rst@72583524cfd3 |
| children |
comparison
equal
deleted
inserted
replaced
| 3487:75427f0a5445 | 3488:c80a0f864b5d |
|---|---|
| 1 ========================================= | |
| 2 ping: get response time of an XMPP entity | |
| 3 ========================================= | |
| 4 | |
| 5 ``ping`` is more or less the equivalent of the command of the same name on most OSes, but | |
| 6 for XMPP. It send a `XEP-0199`_ PING and wait for the answer. When (and if) received, the | |
| 7 time to receive the answer is shown, else the time to receive the error message is shown. | |
| 8 This can be helpful to quickly test the connection with the server or a device. | |
| 9 | |
| 10 If you need to get only the response time (without text around), you may use ``-d, | |
| 11 --delay-only``. | |
| 12 | |
| 13 .. _XEP-0199: https://xmpp.org/extensions/xep-0199.html | |
| 14 | |
| 15 example | |
| 16 ------- | |
| 17 | |
| 18 Get reponse time of a server:: | |
| 19 | |
| 20 $ li ping example.org |