mirror of
https://github.com/irssi/irssi.git
synced 2024-07-21 03:14:16 -04:00
Syntax documentation rewrite for B-commands
Rewrote the syntax documentation for all the commands starting with B.
This commit is contained in:
Geert Hauwaerts
parent
712ef12542
commit
0a22174264
@ -1,27 +1,41 @@
|
||||
|
||||
Syntax:
|
||||
|
||||
@SYNTAX:ban@
|
||||
|
||||
Bans the specified nick or userhost mask.
|
||||
Parameters:
|
||||
|
||||
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:
|
||||
-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.
|
||||
|
||||
Normal - *!*user@*.domain.net
|
||||
User - *!*user@*
|
||||
Host - *!*@host.domain.net
|
||||
Domain - *!*@*.domain.net
|
||||
Custom [nick] [user] [host] [domain]
|
||||
A channel and the nicknames or hostnames to ban. If no arguments are given
|
||||
the bans in the active channel are displayed.
|
||||
|
||||
If no arguments are given the current bans in this 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.
|
||||
|
||||
Description:
|
||||
|
||||
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
|
||||
|
||||
See also: KNOCKOUT, KICKBAN
|
||||
/SET ban_type custom nick domain
|
||||
/SET ban_type custom user host
|
||||
|
||||
See also: KICKBAN, KNOCKOUT
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -1,48 +1,32 @@
|
||||
|
||||
Syntax:
|
||||
|
||||
@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.
|
||||
Parameters:
|
||||
|
||||
Most most commonly used keystrokes are:
|
||||
-list: Displays a list of all the bindable commands.
|
||||
-delete: Removes the binding,
|
||||
|
||||
^X - Ctrl-X
|
||||
meta-x - Meta-x (Meta is quite often Alt-key in PCs, ESC-x works too)
|
||||
A name of the binding and the command to perform.
|
||||
|
||||
Irssi has by default also defined several other keys which you can use:
|
||||
Details:
|
||||
|
||||
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
|
||||
Adds or removes a binding. The binding itself is case-sensitive and may
|
||||
contain as many characters as you want.
|
||||
|
||||
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:
|
||||
|
||||
/BIND ^W^C /WINDOW NEW HIDE
|
||||
/BIND ^W^K /WINDOW KILL
|
||||
|
||||
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:
|
||||
|
||||
/BIND ^W key window
|
||||
/BIND window-^C /WINDOW NEW HIDE
|
||||
/BIND window-^K /WINDOW KILL
|
||||
|
||||
|
||||
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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user