1
0
mirror of https://github.com/irssi/irssi.git synced 2024-09-01 04: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 2014-07-02 22:35:17 +02:00
parent 712ef12542
commit 0a22174264
3 changed files with 61 additions and 54 deletions

View File

@ -1,27 +1,41 @@
Syntax:
@SYNTAX:ban@ @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 -normal: Uses the *!*user@*.domain.net format.
mask. /SET ban_type specified the default ban type. Ban type is one of -user: Uses the *!*user@* format.
the following: -host: Uses the *!*@host.domain.net format.
-domain: Uses the *!*@*.domain.net format.
-custom: Uses the custom format.
Normal - *!*user@*.domain.net A channel and the nicknames or hostnames to ban. If no arguments are given
User - *!*user@* the bans in the active channel are displayed.
Host - *!*@host.domain.net
Domain - *!*@*.domain.net
Custom [nick] [user] [host] [domain]
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: 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 /BAN mike
/SET ban_type custom user host - *!user@host.domain.net /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

View File

@ -1,6 +1,15 @@
Syntax:
@SYNTAX:beep@ @SYNTAX:beep@
Outputs the bell-character, usually causing Description:
your terminal beep.
Outputs the bell-character, usually causing your terminal to beep.
Examples:
/BEEP
See also: CLEAR

View File

@ -1,48 +1,32 @@
Syntax:
@SYNTAX:bind@ @SYNTAX:bind@
Bind some action to specified keystroke. Remember that all characters Parameters:
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: -list: Displays a list of all the bindable commands.
-delete: Removes the binding,
^X - Ctrl-X A name of the binding and the command to perform.
meta-x - Meta-x (Meta is quite often Alt-key in PCs, ESC-x works too)
Irssi has by default also defined several other keys which you can use: Details:
return - The return/enter key Adds or removes a binding. The binding itself is case-sensitive and may
space, backspace - Space / backspace contain as many characters as you want.
up, down, left, right - Arrow keys
cleft, cright - Ctrl-left/right
home, end, prior, next - prior = Page Up, next = Page Down
insert, delete
The keystroke can contain as many key presses as you want, and you can Uppercase characters usually indicate that you need to keep the shift-key
define names for different key sequences to use them more easily (the pressed to use the binding.
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.
Examples: 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