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.238 by sf-exg, Sat Oct 11 22:02:50 2014 UTC

219 219
220=item B<-ls>|B<+ls> 220=item B<-ls>|B<+ls>
221 221
222Start as a login-shell/sub-shell; resource B<loginShell>. 222Start as a login-shell/sub-shell; resource B<loginShell>.
223 223
224=item B<-mc> I<milliseconds>
225
226Specify the maximum time between multi-click selections.
227
224=item B<-ut>|B<+ut> 228=item B<-ut>|B<+ut>
225 229
226Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 230Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227B<utmpInhibit>. 231B<utmpInhibit>.
228 232
306 310
307=item B<-override-redirect> 311=item B<-override-redirect>
308 312
309Compile I<frills>: Sets override-redirect on the window; resource 313Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>. 314B<override-redirect>.
315
316=item B<-dockapp>
317
318Sets the initial state of the window to WithdrawnState, which makes
319window managers that support this extension treat it as a dockapp.
311 320
312=item B<-sbg> 321=item B<-sbg>
313 322
314Compile I<frills>: Disable the usage of the built-in block graphics/line 323Compile I<frills>: Disable the usage of the built-in block graphics/line
315drawing characters and just rely on what the specified fonts provide. Use 324drawing characters and just rely on what the specified fonts provide. Use
781 790
782B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 791B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
783the shell; option B<-ls>. B<False>: start as a normal sub-shell 792the shell; option B<-ls>. B<False>: start as a normal sub-shell
784[default]; option B<+ls>. 793[default]; option B<+ls>.
785 794
795=item B<multiClickTime:> I<number>
796
797Specify the maximum time in milliseconds between multi-click select
798events. The default is 500 milliseconds; option B<-mc>.
799
786=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
787 801
788B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
789option B<-ut>. B<False>: write record into the system log file B<utmp> 803option B<-ut>. B<False>: write record into the system log file B<utmp>
790[default]; option B<+ut>. 804[default]; option B<+ut>.
1055extension might provide. 1069extension might provide.
1056 1070
1057The key combination that triggers the action, I<sym>, has the following format: 1071The key combination that triggers the action, I<sym>, has the following format:
1058 1072
1059 (modifiers-)key 1073 (modifiers-)key
1060 1074
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1075Where 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>, 1076B<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>, 1077B<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>. 1078B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1065 1079
1085As with any resource value, the I<action> string may contain backslash 1099As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal 1100escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087number), see RESOURCES in C<man 7 X> for further details. 1101number), see RESOURCES in C<man 7 X> for further details.
1088 1102
1089An action starts with an action prefix that selects a certain type 1103An action starts with an action prefix that selects a certain type
1090of action, followed by a colon. An action strings without colons is 1104of 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 1105interpreted as a literal string to pass to the tty (as if it was
1092prefixed with C<string:>). 1106prefixed with C<string:>).
1093 1107
1094The following action prefixes are known - extensions can provide 1108The following action prefixes are known - extensions can provide
1095additional prefixes: 1109additional prefixes:
1096 1110
1170The first line disables the paste functionality for that key 1184The first line disables the paste functionality for that key
1171combination, and the second reinstates the default behaviour for 1185combination, and the second reinstates the default behaviour for
1172C<Control-Shift-Insert>, which would otherwise be overridden. 1186C<Control-Shift-Insert>, which would otherwise be overridden.
1173 1187
1174Similarly, to let applications gain access to the C<C-M-c> (copy to 1188Similarly, 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 1189clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this: 1190this:
1177 1191
1178 URxvt.keysym.C-S-c: builtin-string: 1192 URxvt.keysym.C-M-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string: 1193 URxvt.keysym.C-M-v: builtin-string:
1180 1194
1181=item EXTENSION:STRING 1195=item EXTENSION:STRING
1182 1196
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1197An 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 1198extension of the same name. The extension will be loaded automatically if
1185neccessary. 1199necessary.
1186 1200
1187Not all extensions define key actions, but popular extensions that do 1201Not all extensions define key actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their 1202include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1203own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively). 1204respectively).
1193@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC 1207@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1194keyboards: 1208keyboards:
1195 1209
1196 URxvt.keysym.M-C-c: selection:rot13 1210 URxvt.keysym.M-C-c: selection:rot13
1197 1211
1198=item perl:STRING 1212=item perl:STRING *DEPRECATED*
1199 1213
1200This is a deprecated way of passing key mappings to perl extensions. It is 1214This is a deprecated way of passing key mappings to perl extensions. It is
1201still supported, but should not be used anymore. 1215still supported, but should not be used anymore.
1202 1216
1203=back 1217=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 1218
1220=item B<perl-ext-common>: I<string> 1219=item B<perl-ext-common>: I<string>
1221 1220
1222=item B<perl-ext>: I<string> 1221=item B<perl-ext>: I<string>
1223 1222
1225use in this terminal instance; option B<-pe>. 1224use in this terminal instance; option B<-pe>.
1226 1225
1227Extension names can be prefixed with a C<-> sign to prohibit using 1226Extension names can be prefixed with a C<-> sign to prohibit using
1228them. This can be useful to selectively disable some extensions loaded 1227them. This can be useful to selectively disable some extensions loaded
1229by default, or specified via the C<perl-ext-common> resource. For 1228by default, or specified via the C<perl-ext-common> resource. For
1230example, C<default,-selection> will use all the default extension except 1229example, C<default,-selection> will use all the default extensions except
1231C<selection>. 1230C<selection>.
1232 1231
1233Extension names can also be followed by an argument in angle brackets 1232The default set includes the C<selection>, C<option-popup>,
1234(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1233C<selection-popup> and C<readline> extensions, any extensions that
1235searchable scrollback to Alt/Meta-s). Mentioning the same extension 1234define keybindings via C<BINDING> meta comments, and extensions which
1236multiple times with different arguments will pass multiple arguments to 1235are mentioned in B<keysym> resources.
1237the extension. 1236
1237Any extension such that a corresponding resource is given on the
1238command line is automatically appended to B<perl-ext>.
1238 1239
1239Each extension is looked up in the library directories, loaded if 1240Each extension is looked up in the library directories, loaded if
1240necessary, and bound to the current terminal instance. 1241necessary, and bound to the current terminal instance. When the library
1242search path contains multiple extension files of the same name, then the
1243first one found will be used.
1241 1244
1242If both of these resources are the empty string, then the perl 1245If both of these resources are the empty string, then the perl interpreter
1243interpreter will not be initialized. The idea behind two options is that 1246will 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 1247B<perl-ext-common> will be used for extensions that should be available to
1245all instances, while B<perl-ext> is used for specific instances. 1248all instances, while B<perl-ext> is used for specific instances.
1246 1249
1247=item B<perl-eval>: I<string> 1250=item B<perl-eval>: I<string>
1248 1251
1266=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1269=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1267 1270
1268Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1271Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1269for details. 1272for details.
1270 1273
1271=item B<searchable-scrollback:> I<keysym> 1274=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1272 1275
1273Sets the hotkey that starts the incremental scrollback buffer search 1276This resource is deprecated and will be removed. Use a B<keysym> resource
1274(default: C<M-s>). 1277instead, e.g.:
1278
1279 URxvt.keysym.M-s: searchable-scrollback:start
1275 1280
1276=item B<url-launcher>: I<string> 1281=item B<url-launcher>: I<string>
1277 1282
1278Specifies the program to be started with a URL argument. Used by the 1283Specifies the program to be started with a URL argument. Used by the
1279C<selection-popup> and C<matcher> perl extensions. 1284C<selection-popup> and C<matcher> perl extensions.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines