erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc (cli): documentation for new gateway command:

Browse source 
rel 449
This commit is contained in:
Goffi 2024-09-06 18:03:36 +02:00
commit cf0363a3af
1 changed files with 44 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

44
doc/libervia-cli/gateway.rst Normal file
View file

@ -0,0 +1,44 @@
==========================
gateway: Gateway management
==========================
``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.
list
====
List available gateways on a server. If no server JID is specified, the command will use the server of the current profile.
By default, only available gateways are shown. If you want to see unavailable gateways as well, you can use the ``-v, --verbose`` option.
example
-------
List available gateways on the server of the default profile::
$ li gateway list
register
========
Register to a gateway using the specified gateway JID. This will usually show a
registration form that you'll have to complete.
example
-------
Register to the IRC gateway on a server::
$ li gateway register ap.example.org
unregister
==========
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.
example
-------
Unregister from the SMS gateway on a server without confirmation::
$ li gateway unregister -f irc.example.org