Adding upstream version 1.4.5.upstream/1.4.5upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 43 insertions, 0 deletions

diff --git a/docs/help/ban b/docs/help/ban
new file mode 100644
index 0000000..a65c000
--- /dev/null
+++ b/docs/help/ban
@@ -0,0 +1,43 @@
+
+%9Syntax:%9
+
+BAN %|[<channel>] [<nicks>]
+BAN %|[-normal | -user | -host | -domain | -custom <type>] <nicks/masks>
+
+%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
+