Added SILC Thread Queue API
[crypto.git] / apps / irssi / docs / help / in / bind.in
1
2 @SYNTAX:bind@
3
4 Bind some action to specified keystroke. Remember that all characters
5 in keystrokes are case-sensitive! Uppercase letter usually means that
6 you need to keep SHIFT pressed to get the key to work.
7
8 Most most commonly used keystrokes are:
9
10  ^X - Ctrl-X
11  meta-x - Meta-x (Meta is quite often Alt-key in PCs, ESC-x works too)
12
13 Irssi has by default also defined several other keys which you can use:
14
15  return                  - The return/enter key
16  space, backspace        - Space / backspace
17  up, down, left, right   - Arrow keys
18  cleft, cright           - Ctrl-left/right
19  home, end, prior, next  - prior = Page Up, next = Page Down
20  insert, delete
21
22 The keystroke can contain as many key presses as you want, and you can
23 define names for different key sequences to use them more easily (the
24 keys above are done like that). For example, you may want to manage
25 windows with ^W key, so that ^W^C creates new window, ^W^K kills the
26 active window, etc. you may do it like:
27
28  /BIND ^W^C /WINDOW NEW HIDE
29  /BIND ^W^K /WINDOW KILL
30
31 But maybe you wish to give these binds to other people who want to use
32 some other key than ^W, then it would be better done as:
33
34  /BIND ^W key window
35  /BIND window-^C /WINDOW NEW HIDE
36  /BIND window-^K /WINDOW KILL
37
38
39 Command can be one of:
40
41   command - Run any /COMMAND (you could use /COMMAND directly without
42                               specifying this)
43
44 (Cursor movement)
45   backward_character
46   forward_character
47   backward_word
48   forward_word
49   beginning_of_line
50   end_of_line
51
52 (Scrollback movement)
53   scroll_backward - Previous page
54   scroll_forward - Next page
55   scroll_start - Beginning of the window
56   scroll_end - End of the window
57
58 (Switching windows)
59   change_window
60   previous_window
61   next_window
62   upper_window
63   lower_window
64   active_window - Go to next window with the highest activity
65   next_window_item - Next channel/query. In empty windows change
66                      to next server
67   previous_window_item - Previous channel/query. In empty windows change
68                          to previous server
69
70 (History)
71   backward_history
72   forward_history
73
74 (Deleting text)
75   backspace
76   delete_character
77   delete_character
78   delete_next_word
79   delete_previous_word
80   delete_to_next_space
81   delete_to_previous_space
82   erase_line
83   erase_to_beg_of_line
84   erase_to_end_of_line
85
86 (Word completion)
87   word_completion
88   erase_completion
89   check_replaces - Check word replaces
90
91 (Misc)
92   nothing - use this to disable a built-in key
93   refresh_screen
94   yank_from_cutbuffer - "Undelete" line
95   transpose_characters - Swap current and previous character
96   escape_char - Insert the next character exactly as-is to input line
97   insert_text - Insert data to entry line, data may contain $variables.
98   stop_irc - Send SIGSTOP to client (^Z)
99
100 Examples:
101
102 Clear screen:
103   /BIND meta-c /CLEAR
104
105 People with qwertz layout probably want to swap meta-y and meta-z:
106   /BIND meta-z change_window 16
107   /BIND -delete meta-y