imported irssi.
[silc.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  up, down, left, right   - Arrow keys
17  home, end, prior, next  - prior = Page Up, next = Page Down
18  insert, delete
19
20 The keystroke can contain as many key presses as you want, and you can
21 define names for different key sequences to use them more easily (the
22 keys above are done like that). For example, you may want to manage
23 windows with ^W key, so that ^W^C creates new window, ^W^K kills the
24 active window, etc. you may do it like:
25
26  /BIND ^W^C /WINDOW NEW HIDE
27  /BIND ^W^K /WINDOW KILL
28
29 But maybe you wish to give these binds to other people who want to use
30 some other key than ^W, then it would be better done as:
31
32  /BIND ^W key window
33  /BIND window-^C /WINDOW NEW HIDE
34  /BIND window-^K /WINDOW KILL
35
36
37 Command can be one of:
38
39   command - Run any /COMMAND (you could use /COMMAND directly without
40                               specifying this)
41
42 (Cursor movement)
43   backward_character
44   forward_character
45   backward_word
46   forward_word
47   beginning_of_line
48   end_of_line
49
50 (Scrollback movement)
51   scroll_backward - Previous page
52   scroll_forward - Next page
53   scroll_start - Beginning of the window
54   scroll_end - End of the window
55
56 (Switching windows)
57   change_window
58   previous_window
59   next_window
60   upper_window
61   lower_window
62   active_window - Go to next window with the highest activity
63   next_window_item - Next channel/query. In empty windows change
64                      to next server
65   previous_window_item - Previous channel/query. In empty windows change
66                          to previous server
67
68 (History)
69   backward_history
70   forward_history
71
72 (Deleting text)
73   backspace
74   delete_character
75   delete_character
76   delete_next_word
77   delete_previous_word
78   delete_to_previous_space
79   erase_line
80   erase_to_beg_of_line
81   erase_to_end_of_line
82
83 (Word completion)
84   word_completion
85   check_replaces - Check word replaces
86
87 (Misc)
88   refresh_screen
89   yank_from_cutbuffer - "Undelete" line
90   transpose_characters - Swap current and previous character
91   insert_text - Insert data to entry line, data may contain $variables.
92
93 Examples:
94
95 Clear screen:
96   /BIND meta-c /CLEAR
97
98 People with qwertz layout probably want to swap meta-y and meta-z:
99   /BIND meta-z change_window 16
100   /BIND -delete meta-y