summaryrefslogtreecommitdiffstats
path: root/docs/help/in/ban.in
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/help/in/ban.in42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/help/in/ban.in b/docs/help/in/ban.in
new file mode 100644
index 0000000..724815a
--- /dev/null
+++ b/docs/help/in/ban.in
@@ -0,0 +1,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
+