summaryrefslogtreecommitdiff
path: root/docs/help/in/unban.in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-08-05 22:00:30 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-08-05 22:00:30 +0200
commitf0aa2d204990636a65de9aaba7c13c0866fcaf83 (patch)
treea28895b766bc1ef61c14eb8c7fc497e951e8ee6f /docs/help/in/unban.in
parentb9f532568b92444488ce00c1734013e035d40f56 (diff)
downloadirssi-f0aa2d204990636a65de9aaba7c13c0866fcaf83.zip
Syntax rewrite of U-Z commands
Rewrote the syntax documentation of U-Z commands.
Diffstat (limited to 'docs/help/in/unban.in')
-rw-r--r--docs/help/in/unban.in48
1 files changed, 40 insertions, 8 deletions
diff --git a/docs/help/in/unban.in b/docs/help/in/unban.in
index 556b08e9..810acf55 100644
--- a/docs/help/in/unban.in
+++ b/docs/help/in/unban.in
@@ -1,13 +1,45 @@
+%9Syntax:%9
+
@SYNTAX:unban@
-Removes the specified ban(s) from the channel.
+%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.
+ -first: Removes the first ban from the list.
+ -last: Removes the last ban from the list.
+
+ A channel and the nicknames, hostnames or ban identifier to unban; if no
+ channel is given, the active channel will be used.
+
+ 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
+
+ Removes one or more bans from 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
+
+ /UNBAN mike
+ /UNBAN -host bob
+ /UNBAN *!*@*.irssi.org
+ /UNBAN *!*@*.users.irssi.org *!*@*.staff.irssi.org
+ /UNBAN -first
+ /UNBAN 5
+
+ /SET ban_type custom nick domain
+ /SET ban_type custom user host
-Examples:
- /UNBAN *!*@*.fi
- /UNBAN larry!*@* *!me@*.mydomain.net
- /UNBAN 3 - removes 3rd ban in list
- /UNBAN -first - removes 1st ban (equal to /UNBAN 1)
- /UNBAN -last - removes last ban in list
-See also: BAN, KNOCKOUT
+%9See also:%9 BAN, DEOP, KICKBAN, KNOCKOUT, OP