ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs.
Revision 1.233 by sf-exg, Sat May 24 18:41:29 2014 UTC

… …
1055extension might provide. 1055extension might provide.
1056 1056
1057The key combination that triggers the action, I<sym>, has the following format: 1057The key combination that triggers the action, I<sym>, has the following format:
1058 1058
1059 (modifiers-)key 1059 (modifiers-)key
1060 1060
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1062B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, 1062B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1064B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. 1064B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1065 1065
… …
1085As with any resource value, the I<action> string may contain backslash 1085As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal 1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087number), see RESOURCES in C<man 7 X> for further details. 1087number), see RESOURCES in C<man 7 X> for further details.
1088 1088
1089An action starts with an action prefix that selects a certain type 1089An action starts with an action prefix that selects a certain type
1090of action, followed by a colon. An action strings without colons is 1090of action, followed by a colon. An action string without colons is
1091interpreted as a literal string to pass to the tty (as if they were 1091interpreted as a literal string to pass to the tty (as if it was
1092prefixed with C<string:>). 1092prefixed with C<string:>).
1093 1093
1094The following action prefixes are known - extensions can provide 1094The following action prefixes are known - extensions can provide
1095additional prefixes: 1095additional prefixes:
1096 1096
… …
1149 1149
1150The first line defines a mapping for C<Insert> and I<any> combination 1150The first line defines a mapping for C<Insert> and I<any> combination
1151of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1152C<Shift-Insert>. 1152C<Shift-Insert>.
1153 1153
1154=item builtin-string:
1155
1156This action is mainly useful to restore string mappings for keys that
1157have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1158difficult to explain - basically, this action will send the string to the
1159application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1160action for it.
1161
1162An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1163selection when you press C<Shift-Insert>. With the following bindings, it
1164would instead emit the (undocumented, but what applications running in the
1165terminal might expect) sequence C<ESC [ 2 $> instead:
1166
1167 URxvt.keysym.S-Insert: builtin-string:
1168 URxvt.keysym.C-S-Insert: builtin:
1169
1170The first line disables the paste functionality for that key
1171combination, and the second reinstates the default behaviour for
1172C<Control-Shift-Insert>, which would otherwise be overridden.
1173
1174Similarly, to let applications gain access to the C<C-M-c> (copy to
1175clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this:
1177
1178 URxvt.keysym.C-S-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string:
1180
1154=item EXTENSION:STRING 1181=item EXTENSION:STRING
1155 1182
1156An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1157extension of the same name. The extension will be loaded automatically if 1184extension of the same name. The extension will be loaded automatically if
1158neccessary. 1185neccessary.
… …
1166@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC 1193@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1167keyboards: 1194keyboards:
1168 1195
1169 URxvt.keysym.M-C-c: selection:rot13 1196 URxvt.keysym.M-C-c: selection:rot13
1170 1197
1171=item perl:STRING 1198=item perl:STRING *DEPRECATED*
1172 1199
1173This is a deprecated way of passing key mappings to perl extensions. It is 1200This is a deprecated way of passing key mappings to perl extensions. It is
1174still supported, but should not be used anymore. 1201still supported, but should not be used anymore.
1175 1202
1176=back 1203=back
1177
1178In addition, you can define a range of keysyms in one shot by loading
1179the C<keysym-list> perl extension and providing a I<string> with pattern
1180B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1181character not used by the strings.
1182
1183Its usage can be demonstrated by an example:
1184
1185 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1186
1187The above line is equivalent to the following three lines:
1188
1189 URxvt.keysym.Meta-Control-0x61: \033<a>
1190 URxvt.keysym.Meta-Control-0x62: \033<b>
1191 URxvt.keysym.Meta-Control-0x63: \033<c>
1192 1204
1193=item B<perl-ext-common>: I<string> 1205=item B<perl-ext-common>: I<string>
1194 1206
1195=item B<perl-ext>: I<string> 1207=item B<perl-ext>: I<string>
1196 1208
… …
1198use in this terminal instance; option B<-pe>. 1210use in this terminal instance; option B<-pe>.
1199 1211
1200Extension names can be prefixed with a C<-> sign to prohibit using 1212Extension names can be prefixed with a C<-> sign to prohibit using
1201them. This can be useful to selectively disable some extensions loaded 1213them. This can be useful to selectively disable some extensions loaded
1202by default, or specified via the C<perl-ext-common> resource. For 1214by default, or specified via the C<perl-ext-common> resource. For
1203example, C<default,-selection> will use all the default extension except 1215example, C<default,-selection> will use all the default extensions except
1204C<selection>. 1216C<selection>.
1205 1217
1206Extension names can also be followed by an argument in angle brackets 1218The default set includes the C<selection>, C<option-popup>,
1207(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1219C<selection-popup> and C<readline> extensions, any extensions that define
1208searchable scrollback to Alt/Meta-s). Mentioning the same extension 1220keybindings via C<BINDING> meta comments, extensions loaded because
1209multiple times with different arguments will pass multiple arguments to 1221their resources/commandline switches were used, and extensions which are
1210the extension. 1222mentioned in B<keysym> resources.
1211 1223
1212Each extension is looked up in the library directories, loaded if 1224Each extension is looked up in the library directories, loaded if
1213necessary, and bound to the current terminal instance. 1225necessary, and bound to the current terminal instance. When the library
1226search path contains multiple extension files of the same name, then the
1227first one found will be used.
1214 1228
1215If both of these resources are the empty string, then the perl 1229If both of these resources are the empty string, then the perl interpreter
1216interpreter will not be initialized. The idea behind two options is that 1230will not be initialized. The rationale for having two options is that
1217B<perl-ext-common> will be used for extensions that should be available to 1231B<perl-ext-common> will be used for extensions that should be available to
1218all instances, while B<perl-ext> is used for specific instances. 1232all instances, while B<perl-ext> is used for specific instances.
1219 1233
1220=item B<perl-eval>: I<string> 1234=item B<perl-eval>: I<string>
1221 1235
… …
1239=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1253=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1240 1254
1241Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1255Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1242for details. 1256for details.
1243 1257
1244=item B<searchable-scrollback:> I<keysym> 1258=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1245 1259
1246Sets the hotkey that starts the incremental scrollback buffer search 1260This resource is deprecated and will be removed. Use a B<keysym> resource
1247(default: C<M-s>). 1261instead, e.g.:
1262
1263 URxvt.keysym.M-s: searchable-scrollback:start
1248 1264
1249=item B<url-launcher>: I<string> 1265=item B<url-launcher>: I<string>
1250 1266
1251Specifies the program to be started with a URL argument. Used by the 1267Specifies the program to be started with a URL argument. Used by the
1252C<selection-popup> and C<matcher> perl extensions. 1268C<selection-popup> and C<matcher> perl extensions.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines