summaryrefslogtreecommitdiff
path: root/docs/help/in/ban.in
blob: 724815a06226fb7717b1b9b8c4c42f735393c750 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

%9Syntax:%9

@SYNTAX:ban@

%9Parameters:%9

    -normal:    Uses the *!*user@*.domain.tld format.
    -user:      Uses the *!*user@* format.
    -host:      Uses the *!*@host.domain.tld format.
    -domain:    Uses the *!*@*.domain.tld format.
    -custom:    Uses the custom format.

    A channel and the nicknames or hostnames to ban; if no arguments are given
    the bans in the active channel are displayed.

    If no ban format parameter is given, the value of the ban_type setting will
    be used to generate the hostmask to ban.

%9Description:%9

    Adds one or more bans to a channel.

%9Configuring the custom format:%9

    You must set the custom ban_type to the format you would like to use. For
    example, if you set the custom ban_type to 'nick domain', it will generate
    a ban based on the nick!*@*.domain.tld format.

%9Examples:%9

    /BAN
    /BAN mike
    /BAN -host bob
    /BAN *!*@*.irssi.org
    /BAN -domain sarah

    /SET ban_type custom nick domain
    /SET ban_type custom user host

%9See also:%9 DEOP, KICKBAN, KNOCKOUT, OP, UNBAN