summaryrefslogtreecommitdiff
path: root/docs/help/in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-02 22:35:17 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-02 22:35:17 +0200
commit0a221742649cf39db96da69dead0292fd38c7b66 (patch)
treea691b07affb44a6c066b356c1ae2cc6f158d17f8 /docs/help/in
parent712ef12542a2847a8ab1d6648735f7b5c963a6ed (diff)
downloadirssi-0a221742649cf39db96da69dead0292fd38c7b66.zip
Syntax documentation rewrite for B-commands
Rewrote the syntax documentation for all the commands starting with B.
Diffstat (limited to 'docs/help/in')
-rw-r--r--docs/help/in/ban.in46
-rw-r--r--docs/help/in/beep.in13
-rw-r--r--docs/help/in/bind.in56
3 files changed, 61 insertions, 54 deletions
diff --git a/docs/help/in/ban.in b/docs/help/in/ban.in
index 8d6d02bf..72474dce 100644
--- a/docs/help/in/ban.in
+++ b/docs/help/in/ban.in
@@ -1,27 +1,41 @@
+Syntax:
+
@SYNTAX:ban@
-Bans the specified nick or userhost mask.
+Parameters:
+
+ -normal: Uses the *!*user@*.domain.net format.
+ -user: Uses the *!*user@* format.
+ -host: Uses the *!*@host.domain.net format.
+ -domain: Uses the *!*@*.domain.net 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 nick is given as parameter, the ban type is used to generate the ban
-mask. /SET ban_type specified the default ban type. Ban type is one of
-the following:
+ If no ban format parameter is given, the value of the ban_type setting will
+ be used to generate the hostmask to ban.
- Normal - *!*user@*.domain.net
- User - *!*user@*
- Host - *!*@host.domain.net
- Domain - *!*@*.domain.net
- Custom [nick] [user] [host] [domain]
+Description:
-If no arguments are given the current bans in this channel are displayed.
+ Adds one or more bans to a channel.
+
+Configuring the custom format:
+
+ 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.net format.
Examples:
- /BAN loser - Bans the nick 'loser'
- /BAN -host loser - Bans the host of nick 'loser'
- /BAN *!*@*.org - Bans all the users coming from any .org domain.
- /SET ban_type custom nick domain - nick!*@*.domain.net
- /SET ban_type custom user host - *!user@host.domain.net
+ /BAN mike
+ /BAN -host bob
+ /BAN *!*@*.basement.cat
+ /BAN -domain sarah
+
+ /SET ban_type custom nick domain
+ /SET ban_type custom user host
-See also: KNOCKOUT, KICKBAN
+See also: KICKBAN, KNOCKOUT
diff --git a/docs/help/in/beep.in b/docs/help/in/beep.in
index 12df1ae7..fdb3857a 100644
--- a/docs/help/in/beep.in
+++ b/docs/help/in/beep.in
@@ -1,6 +1,15 @@
+Syntax:
+
@SYNTAX:beep@
-Outputs the bell-character, usually causing
-your terminal beep.
+Description:
+
+ Outputs the bell-character, usually causing your terminal to beep.
+
+Examples:
+
+ /BEEP
+
+See also: CLEAR
diff --git a/docs/help/in/bind.in b/docs/help/in/bind.in
index d48dcd69..5eff4145 100644
--- a/docs/help/in/bind.in
+++ b/docs/help/in/bind.in
@@ -1,48 +1,32 @@
-@SYNTAX:bind@
-
-Bind some action to specified keystroke. Remember that all characters
-in keystrokes are case-sensitive! Uppercase letter usually means that
-you need to keep SHIFT pressed to get the key to work.
-
-Most most commonly used keystrokes are:
-
- ^X - Ctrl-X
- meta-x - Meta-x (Meta is quite often Alt-key in PCs, ESC-x works too)
+Syntax:
-Irssi has by default also defined several other keys which you can use:
-
- return - The return/enter key
- space, backspace - Space / backspace
- up, down, left, right - Arrow keys
- cleft, cright - Ctrl-left/right
- home, end, prior, next - prior = Page Up, next = Page Down
- insert, delete
+@SYNTAX:bind@
-The keystroke can contain as many key presses as you want, and you can
-define names for different key sequences to use them more easily (the
-keys above are done like that). For example, you may want to manage
-windows with ^W key, so that ^W^C creates new window, ^W^K kills the
-active window, etc. you may do it like:
+Parameters:
- /BIND ^W^C /WINDOW NEW HIDE
- /BIND ^W^K /WINDOW KILL
+ -list: Displays a list of all the bindable commands.
+ -delete: Removes the binding,
-But maybe you wish to give these binds to other people who want to use
-some other key than ^W, then it would be better done as:
+ A name of the binding and the command to perform.
- /BIND ^W key window
- /BIND window-^C /WINDOW NEW HIDE
- /BIND window-^K /WINDOW KILL
+Details:
+ Adds or removes a binding. The binding itself is case-sensitive and may
+ contain as many characters as you want.
-To get a list of all bindable commands use /bind -list.
+ Uppercase characters usually indicate that you need to keep the shift-key
+ pressed to use the binding.
Examples:
-Clear screen:
- /BIND meta-c /CLEAR
+ /BIND meta-c /CLEAR
+ /BIND meta-q change_window 16
+ /BIND -delete meta-y
+ /BIND ^W^C /WINDOW NEW HIDE
+ /BIND ^W^K /WINDOW KILL
+ /BIND ^[[11~ command AWAY I'm off for today :)
+ /BIND ^[[12~ command AWAY
+
+See also: ALIAS
-People with qwertz layout probably want to swap meta-y and meta-z:
- /BIND meta-z change_window 16
- /BIND -delete meta-y