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.243 by root, Sat May 30 21:02:05 2015 UTC

108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID> 111=item B<-visual> I<visualID>
112 112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible 113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114visual ids). 114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
115 116
116=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
117 118
118Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
119 120
219 220
220=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
221 222
222Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
223 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
224=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
225 230
226Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227B<utmpInhibit>. 232B<utmpInhibit>.
228 233
306 311
307=item B<-override-redirect> 312=item B<-override-redirect>
308 313
309Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
311 321
312=item B<-sbg> 322=item B<-sbg>
313 323
314Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
315drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
369 379
370=item B<-pt> I<style> 380=item B<-pt> I<style>
371 381
372Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
373B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
374 387
375=item B<-im> I<text> 388=item B<-im> I<text>
376 389
377Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
378 391
781 794
782B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 795B<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 796the shell; option B<-ls>. B<False>: start as a normal sub-shell
784[default]; option B<+ls>. 797[default]; option B<+ls>.
785 798
799=item B<multiClickTime:> I<number>
800
801Specify the maximum time in milliseconds between multi-click select
802events. The default is 500 milliseconds; option B<-mc>.
803
786=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
787 805
788B<True>: inhibit writing record into the system log file B<utmp>; 806B<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> 807option B<-ut>. B<False>: write record into the system log file B<utmp>
790[default]; option B<+ut>. 808[default]; option B<+ut>.
962 980
963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 981B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
964 982
965=item B<preeditType:> I<style> 983=item B<preeditType:> I<style>
966 984
967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 985B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968 986
969=item B<inputMethod:> I<name> 987=item B<inputMethod:> I<name>
970 988
971I<name> of inputMethod to use; option B<-im>. 989I<name> of inputMethod to use; option B<-im>.
972 990
1055extension might provide. 1073extension might provide.
1056 1074
1057The key combination that triggers the action, I<sym>, has the following format: 1075The key combination that triggers the action, I<sym>, has the following format:
1058 1076
1059 (modifiers-)key 1077 (modifiers-)key
1060 1078
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1079Where 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>, 1080B<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>, 1081B<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>. 1082B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1065 1083
1085As with any resource value, the I<action> string may contain backslash 1103As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal 1104escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087number), see RESOURCES in C<man 7 X> for further details. 1105number), see RESOURCES in C<man 7 X> for further details.
1088 1106
1089An action starts with an action prefix that selects a certain type 1107An action starts with an action prefix that selects a certain type
1090of action, followed by a colon. An action strings without colons is 1108of 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 1109interpreted as a literal string to pass to the tty (as if it was
1092prefixed with C<string:>). 1110prefixed with C<string:>).
1093 1111
1094The following action prefixes are known - extensions can provide 1112The following action prefixes are known - extensions can provide
1095additional prefixes: 1113additional prefixes:
1096 1114
1104string C<echo rm -rf /> followed by a newline: 1122string C<echo rm -rf /> followed by a newline:
1105 1123
1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1124 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107 1125
1108This could in theory be used to completely redefine your keymap. 1126This could in theory be used to completely redefine your keymap.
1127
1128In addition, for actions of this type, you can define a range of
1129keysyms in one shot by loading the C<keysym-list> perl extension and
1130providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1131the delimiter `/' should be a character not used by the strings.
1132
1133Its usage can be demonstrated by an example:
1134
1135 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1136
1137The above line is equivalent to the following three lines:
1138
1139 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1140 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1141 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1109 1142
1110=item command:STRING 1143=item command:STRING
1111 1144
1112If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1145If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1146is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1170The first line disables the paste functionality for that key 1203The first line disables the paste functionality for that key
1171combination, and the second reinstates the default behaviour for 1204combination, and the second reinstates the default behaviour for
1172C<Control-Shift-Insert>, which would otherwise be overridden. 1205C<Control-Shift-Insert>, which would otherwise be overridden.
1173 1206
1174Similarly, to let applications gain access to the C<C-M-c> (copy to 1207Similarly, 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 1208clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this: 1209this:
1177 1210
1178 URxvt.keysym.C-S-c: builtin-string: 1211 URxvt.keysym.C-M-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string: 1212 URxvt.keysym.C-M-v: builtin-string:
1180 1213
1181=item EXTENSION:STRING 1214=item EXTENSION:STRING
1182 1215
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1216An action of this form invokes the action B<STRING>, if any, provided
1184extension of the same name. The extension will be loaded automatically if 1217by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1185neccessary. 1218be loaded automatically if necessary.
1186 1219
1187Not all extensions define key actions, but popular extensions that do 1220Not all extensions define actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their 1221include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1222own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively). 1223respectively).
1191 1224
1192From the silly examples department, this will rot13-"encrypt" 1225From the silly examples department, this will rot13-"encrypt"
1193@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC 1226@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1194keyboards: 1227keyboards:
1195 1228
1196 URxvt.keysym.M-C-c: selection:rot13 1229 URxvt.keysym.M-C-c: selection:rot13
1197 1230
1198=item perl:STRING 1231=item perl:STRING *DEPRECATED*
1199 1232
1200This is a deprecated way of passing key mappings to perl extensions. It is 1233This is a deprecated way of invoking commands provided by perl
1201still supported, but should not be used anymore. 1234extensions. It is still supported, but should not be used anymore.
1202 1235
1203=back 1236=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 1237
1220=item B<perl-ext-common>: I<string> 1238=item B<perl-ext-common>: I<string>
1221 1239
1222=item B<perl-ext>: I<string> 1240=item B<perl-ext>: I<string>
1223 1241
1225use in this terminal instance; option B<-pe>. 1243use in this terminal instance; option B<-pe>.
1226 1244
1227Extension names can be prefixed with a C<-> sign to prohibit using 1245Extension names can be prefixed with a C<-> sign to prohibit using
1228them. This can be useful to selectively disable some extensions loaded 1246them. This can be useful to selectively disable some extensions loaded
1229by default, or specified via the C<perl-ext-common> resource. For 1247by default, or specified via the C<perl-ext-common> resource. For
1230example, C<default,-selection> will use all the default extension except 1248example, C<default,-selection> will use all the default extensions except
1231C<selection>. 1249C<selection>.
1232 1250
1233Extension names can also be followed by an argument in angle brackets 1251The default set includes the C<selection>, C<option-popup>,
1234(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1252C<selection-popup>, C<readline> and C<searchable-scrollback>
1235searchable scrollback to Alt/Meta-s). Mentioning the same extension 1253extensions, and extensions which are mentioned in B<keysym> resources.
1236multiple times with different arguments will pass multiple arguments to 1254
1237the extension. 1255Any extension such that a corresponding resource is given on the
1256command line is automatically appended to B<perl-ext>.
1238 1257
1239Each extension is looked up in the library directories, loaded if 1258Each extension is looked up in the library directories, loaded if
1240necessary, and bound to the current terminal instance. 1259necessary, and bound to the current terminal instance. When the library
1260search path contains multiple extension files of the same name, then the
1261first one found will be used.
1241 1262
1242If both of these resources are the empty string, then the perl 1263If both of these resources are the empty string, then the perl interpreter
1243interpreter will not be initialized. The idea behind two options is that 1264will 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 1265B<perl-ext-common> will be used for extensions that should be available to
1245all instances, while B<perl-ext> is used for specific instances. 1266all instances, while B<perl-ext> is used for specific instances.
1246 1267
1247=item B<perl-eval>: I<string> 1268=item B<perl-eval>: I<string>
1248 1269
1266=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1287=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1267 1288
1268Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1289Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1269for details. 1290for details.
1270 1291
1271=item B<searchable-scrollback:> I<keysym> 1292=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1272 1293
1273Sets the hotkey that starts the incremental scrollback buffer search 1294This resource is deprecated and will be removed. Use a B<keysym> resource
1274(default: C<M-s>). 1295instead, e.g.:
1296
1297 URxvt.keysym.M-s: searchable-scrollback:start
1275 1298
1276=item B<url-launcher>: I<string> 1299=item B<url-launcher>: I<string>
1277 1300
1278Specifies the program to be started with a URL argument. Used by the 1301Specifies the program to be started with a URL argument. Used by the
1279C<selection-popup> and C<matcher> perl extensions. 1302C<selection-popup> and C<matcher> perl extensions.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines