Mercurial > libervia-backend
comparison doc/libervia-cli/blocking.rst @ 3789:665f060fbecb
doc (cli/blocking): `blocking` command documentation:
rel 367
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 17 Jun 2022 14:15:23 +0200 |
| parents | |
| children | 29380ef68dbe |
comparison
equal
deleted
inserted
replaced
| 3788:12317ba98d99 | 3789:665f060fbecb |
|---|---|
| 1 =========================== | |
| 2 blocking: entities blocking | |
| 3 =========================== | |
| 4 | |
| 5 ``blocking`` are commands to block or unblock users by their JIDs (as specified by | |
| 6 `XEP-0191`_). You server must implement this XEP to use those commands. | |
| 7 | |
| 8 A blocking is usually done using bare JID, however, you may specify a resource if you want | |
| 9 to block only this resource, or a domain if you want to block a whole domain. Please check | |
| 10 `XEP-0191 § JID Matching`_ for details. | |
| 11 | |
| 12 list | |
| 13 ==== | |
| 14 | |
| 15 List already blocked users. | |
| 16 | |
| 17 examples | |
| 18 -------- | |
| 19 | |
| 20 Check who has already been blocked:: | |
| 21 | |
| 22 $ li blocking list | |
| 23 | |
| 24 block | |
| 25 ===== | |
| 26 | |
| 27 Block one or more entities by specifying their JIDs. | |
| 28 | |
| 29 You just need to specify the bare JIDs of users that you want to block as positional | |
| 30 argument, specify only a domain if you want to block a whole domain. | |
| 31 | |
| 32 examples | |
| 33 -------- | |
| 34 | |
| 35 Louise wants to block ``spammer@example.com`` and the whole domain ``spammers.example``:: | |
| 36 | |
| 37 $ li blocking block spammer@example.com spammers.example | |
| 38 | |
| 39 unblock | |
| 40 ======= | |
| 41 | |
| 42 ``unblock`` works the same way as ``block``. | |
| 43 | |
| 44 If you want to unblock all blocked users at once, you can use the ``all`` keyword. In this | |
| 45 case, you'll have to confirm the action. If you don't want to confirm manually, you can | |
| 46 use the ``-f, --force`` flag. | |
| 47 | |
| 48 examples | |
| 49 -------- | |
| 50 | |
| 51 Pierre wants to unblock the domain ``example.com`` that he has blocked earlier:: | |
| 52 | |
| 53 $ li blocking unblock example.com | |
| 54 | |
| 55 Élysée want to unblock all blocked users, without confirmation:: | |
| 56 | |
| 57 $ li blocking unblock -f all | |
| 58 | |
| 59 | |
| 60 .. _XEP-0191: https://xmpp.org/extensions/xep-0191.html | |
| 61 .. _XEP-0191 § JID Matching: https://xmpp.org/extensions/xep-0191.html#matching |