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.229 by root, Sun Apr 27 20:26:28 2014 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC

… …
307=item B<-override-redirect> 307=item B<-override-redirect>
308 308
309Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>. 310B<override-redirect>.
311 311
312=item B<-dockapp>
313
314Sets the initial state of the window to WithdrawnState, which makes
315window managers that support this extension treat it as a dockapp.
316
312=item B<-sbg> 317=item B<-sbg>
313 318
314Compile I<frills>: Disable the usage of the built-in block graphics/line 319Compile I<frills>: Disable the usage of the built-in block graphics/line
315drawing characters and just rely on what the specified fonts provide. Use 320drawing characters and just rely on what the specified fonts provide. Use
316this if you have a good font and want to use its block graphic glyphs; 321this if you have a good font and want to use its block graphic glyphs;
… …
1055extension might provide. 1060extension might provide.
1056 1061
1057The key combination that triggers the action, I<sym>, has the following format: 1062The key combination that triggers the action, I<sym>, has the following format:
1058 1063
1059 (modifiers-)key 1064 (modifiers-)key
1060 1065
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1066Where 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>, 1067B<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>, 1068B<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>. 1069B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1065 1070
… …
1085As with any resource value, the I<action> string may contain backslash 1090As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal 1091escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087number), see RESOURCES in C<man 7 X> for further details. 1092number), see RESOURCES in C<man 7 X> for further details.
1088 1093
1089An action starts with an action prefix that selects a certain type 1094An action starts with an action prefix that selects a certain type
1090of action, followed by a colon. An action strings without colons is 1095of 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 1096interpreted as a literal string to pass to the tty (as if it was
1092prefixed with C<string:>). 1097prefixed with C<string:>).
1093 1098
1094The following action prefixes are known - extensions can provide 1099The following action prefixes are known - extensions can provide
1095additional prefixes: 1100additional prefixes:
1096 1101
… …
1170The first line disables the paste functionality for that key 1175The first line disables the paste functionality for that key
1171combination, and the second reinstates the default behaviour for 1176combination, and the second reinstates the default behaviour for
1172C<Control-Shift-Insert>, which would otherwise be overridden. 1177C<Control-Shift-Insert>, which would otherwise be overridden.
1173 1178
1174Similarly, to let applications gain access to the C<C-M-c> (copy to 1179Similarly, to let applications gain access to the C<C-M-c> (copy to
1175clipboard) and C<C-M-v> (paste clipboard) key combination, you cna do 1180clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this: 1181this:
1177 1182
1178 URxvt.keysym.C-S-c: builtin-string: 1183 URxvt.keysym.C-S-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string: 1184 URxvt.keysym.C-S-v: builtin-string:
1180 1185
1181=item EXTENSION:STRING 1186=item EXTENSION:STRING
1182 1187
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1188An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1184extension of the same name. The extension will be loaded automatically if 1189extension of the same name. The extension will be loaded automatically if
1185neccessary. 1190necessary.
1186 1191
1187Not all extensions define key actions, but popular extensions that do 1192Not all extensions define key actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their 1193include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1194own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively). 1195respectively).
… …
1193@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC 1198@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1194keyboards: 1199keyboards:
1195 1200
1196 URxvt.keysym.M-C-c: selection:rot13 1201 URxvt.keysym.M-C-c: selection:rot13
1197 1202
1198=item perl:STRING 1203=item perl:STRING *DEPRECATED*
1199 1204
1200This is a deprecated way of passing key mappings to perl extensions. It is 1205This is a deprecated way of passing key mappings to perl extensions. It is
1201still supported, but should not be used anymore. 1206still supported, but should not be used anymore.
1202 1207
1203=back 1208=back
1204
1205In addition, you can define a range of keysyms in one shot by loading
1206the C<keysym-list> perl extension and providing a I<string> with pattern
1207B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1208character not used by the strings.
1209
1210Its usage can be demonstrated by an example:
1211
1212 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1213
1214The above line is equivalent to the following three lines:
1215
1216 URxvt.keysym.Meta-Control-0x61: \033<a>
1217 URxvt.keysym.Meta-Control-0x62: \033<b>
1218 URxvt.keysym.Meta-Control-0x63: \033<c>
1219 1209
1220=item B<perl-ext-common>: I<string> 1210=item B<perl-ext-common>: I<string>
1221 1211
1222=item B<perl-ext>: I<string> 1212=item B<perl-ext>: I<string>
1223 1213
… …
1225use in this terminal instance; option B<-pe>. 1215use in this terminal instance; option B<-pe>.
1226 1216
1227Extension names can be prefixed with a C<-> sign to prohibit using 1217Extension names can be prefixed with a C<-> sign to prohibit using
1228them. This can be useful to selectively disable some extensions loaded 1218them. This can be useful to selectively disable some extensions loaded
1229by default, or specified via the C<perl-ext-common> resource. For 1219by default, or specified via the C<perl-ext-common> resource. For
1230example, C<default,-selection> will use all the default extension except 1220example, C<default,-selection> will use all the default extensions except
1231C<selection>. 1221C<selection>.
1232 1222
1233Extension names can also be followed by an argument in angle brackets 1223The default set includes the C<selection>, C<option-popup>,
1234(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1224C<selection-popup> and C<readline> extensions, any extensions that define
1235searchable scrollback to Alt/Meta-s). Mentioning the same extension 1225keybindings via C<BINDING> meta comments, extensions loaded because
1236multiple times with different arguments will pass multiple arguments to 1226their resources/commandline switches were used, and extensions which are
1237the extension. 1227mentioned in B<keysym> resources.
1238 1228
1239Each extension is looked up in the library directories, loaded if 1229Each extension is looked up in the library directories, loaded if
1240necessary, and bound to the current terminal instance. 1230necessary, and bound to the current terminal instance. When the library
1231search path contains multiple extension files of the same name, then the
1232first one found will be used.
1241 1233
1242If both of these resources are the empty string, then the perl 1234If both of these resources are the empty string, then the perl interpreter
1243interpreter will not be initialized. The idea behind two options is that 1235will not be initialized. The rationale for having two options is that
1244B<perl-ext-common> will be used for extensions that should be available to 1236B<perl-ext-common> will be used for extensions that should be available to
1245all instances, while B<perl-ext> is used for specific instances. 1237all instances, while B<perl-ext> is used for specific instances.
1246 1238
1247=item B<perl-eval>: I<string> 1239=item B<perl-eval>: I<string>
1248 1240
… …
1266=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1258=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1267 1259
1268Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1260Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1269for details. 1261for details.
1270 1262
1271=item B<searchable-scrollback:> I<keysym> 1263=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1272 1264
1273Sets the hotkey that starts the incremental scrollback buffer search 1265This resource is deprecated and will be removed. Use a B<keysym> resource
1274(default: C<M-s>). 1266instead, e.g.:
1267
1268 URxvt.keysym.M-s: searchable-scrollback:start
1275 1269
1276=item B<url-launcher>: I<string> 1270=item B<url-launcher>: I<string>
1277 1271
1278Specifies the program to be started with a URL argument. Used by the 1272Specifies the program to be started with a URL argument. Used by the
1279C<selection-popup> and C<matcher> perl extensions. 1273C<selection-popup> and C<matcher> perl extensions.

Diff Legend

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