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.231 by root, Sat May 17 17:12:29 2014 UTC vs.
Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 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>.
… …
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
… …
1104string C<echo rm -rf /> followed by a newline: 1118string C<echo rm -rf /> followed by a newline:
1105 1119
1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1120 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107 1121
1108This could in theory be used to completely redefine your keymap. 1122This could in theory be used to completely redefine your keymap.
1123
1124In addition, for actions of this type, you can define a range of
1125keysyms in one shot by loading the C<keysym-list> perl extension and
1126providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1127the delimiter `/' should be a character not used by the strings.
1128
1129Its usage can be demonstrated by an example:
1130
1131 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1132
1133The above line is equivalent to the following three lines:
1134
1135 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1136 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1137 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1109 1138
1110=item command:STRING 1139=item command:STRING
1111 1140
1112If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1141If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1142is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
… …
1173 1202
1174Similarly, to let applications gain access to the C<C-M-c> (copy to 1203Similarly, 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 1204clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this: 1205this:
1177 1206
1178 URxvt.keysym.C-S-c: builtin-string: 1207 URxvt.keysym.C-M-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string: 1208 URxvt.keysym.C-M-v: builtin-string:
1180 1209
1181=item EXTENSION:STRING 1210=item EXTENSION:STRING
1182 1211
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1212An action of this form invokes the action B<STRING>, if any, provided
1184extension of the same name. The extension will be loaded automatically if 1213by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1185neccessary. 1214be loaded automatically if necessary.
1186 1215
1187Not all extensions define key actions, but popular extensions that do 1216Not all extensions define actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their 1217include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1218own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively). 1219respectively).
1191 1220
1192From the silly examples department, this will rot13-"encrypt" 1221From the silly examples department, this will rot13-"encrypt"
… …
1195 1224
1196 URxvt.keysym.M-C-c: selection:rot13 1225 URxvt.keysym.M-C-c: selection:rot13
1197 1226
1198=item perl:STRING *DEPRECATED* 1227=item perl:STRING *DEPRECATED*
1199 1228
1200This is a deprecated way of passing key mappings to perl extensions. It is 1229This is a deprecated way of invoking commands provided by perl
1201still supported, but should not be used anymore. 1230extensions. It is still supported, but should not be used anymore.
1202 1231
1203=back 1232=back
1204 1233
1205=item B<perl-ext-common>: I<string> 1234=item B<perl-ext-common>: I<string>
1206 1235
… …
1210use in this terminal instance; option B<-pe>. 1239use in this terminal instance; option B<-pe>.
1211 1240
1212Extension names can be prefixed with a C<-> sign to prohibit using 1241Extension names can be prefixed with a C<-> sign to prohibit using
1213them. This can be useful to selectively disable some extensions loaded 1242them. This can be useful to selectively disable some extensions loaded
1214by default, or specified via the C<perl-ext-common> resource. For 1243by default, or specified via the C<perl-ext-common> resource. For
1215example, C<default,-selection> will use all the default extension except 1244example, C<default,-selection> will use all the default extensions except
1216C<selection>. 1245C<selection>.
1217 1246
1218Some extensions define resources or command line switches, and will 1247The default set includes the C<selection>, C<option-popup>,
1219automatically be used when their resource or switch is specified. 1248C<selection-popup> and C<readline> extensions, any extensions that
1249define keybindings via C<BINDING> meta comments, and extensions which
1250are mentioned in B<keysym> resources.
1251
1252Any extension such that a corresponding resource is given on the
1253command line is automatically appended to B<perl-ext>.
1220 1254
1221Each extension is looked up in the library directories, loaded if 1255Each extension is looked up in the library directories, loaded if
1222necessary, and bound to the current terminal instance. 1256necessary, and bound to the current terminal instance. When the library
1257search path contains multiple extension files of the same name, then the
1258first one found will be used.
1223 1259
1224If both of these resources are the empty string, then the perl interpreter 1260If both of these resources are the empty string, then the perl interpreter
1225will not be initialized. The rationale for having two options is that 1261will not be initialized. The rationale for having two options is that
1226B<perl-ext-common> will be used for extensions that should be available to 1262B<perl-ext-common> will be used for extensions that should be available to
1227all instances, while B<perl-ext> is used for specific instances. 1263all instances, while B<perl-ext> is used for specific instances.

Diff Legend

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