Mercurial > libervia-backend
comparison doc/libervia-cli/gateway.rst @ 4302:9e7ea54b93ee
doc (cli): documentation for new `gateway` command:
rel 449
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 06 Sep 2024 18:03:36 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 4301:9deb3ddb2921 | 4302:9e7ea54b93ee |
|---|---|
| 1 ========================== | |
| 2 gateway: Gateway management | |
| 3 ========================== | |
| 4 | |
| 5 ``gateway`` command allows you to list, register, and unregister from gateways (usually used to access other networks like ActivityPub or Email) on an XMPP server. | |
| 6 | |
| 7 list | |
| 8 ==== | |
| 9 | |
| 10 List available gateways on a server. If no server JID is specified, the command will use the server of the current profile. | |
| 11 | |
| 12 By default, only available gateways are shown. If you want to see unavailable gateways as well, you can use the ``-v, --verbose`` option. | |
| 13 | |
| 14 example | |
| 15 ------- | |
| 16 | |
| 17 List available gateways on the server of the default profile:: | |
| 18 | |
| 19 $ li gateway list | |
| 20 | |
| 21 register | |
| 22 ======== | |
| 23 | |
| 24 Register to a gateway using the specified gateway JID. This will usually show a | |
| 25 registration form that you'll have to complete. | |
| 26 | |
| 27 example | |
| 28 ------- | |
| 29 | |
| 30 Register to the IRC gateway on a server:: | |
| 31 | |
| 32 $ li gateway register ap.example.org | |
| 33 | |
| 34 unregister | |
| 35 ========== | |
| 36 | |
| 37 Unregister from a gateway using the specified gateway JID. By default, a confirmation is requested before unregistering. You can skip the confirmation by using the ``-f, --force`` option. | |
| 38 | |
| 39 example | |
| 40 ------- | |
| 41 | |
| 42 Unregister from the SMS gateway on a server without confirmation:: | |
| 43 | |
| 44 $ li gateway unregister -f irc.example.org |