Mercurial > libervia-backend

annotate doc/libervia-cli/blocking.rst @ 3789:665f060fbecb

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