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.255 by root, Sat Jul 24 11:00:58 2021 UTC

84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
85Orange'. 85Orange'.
86 86
87The following options are available: 87The following options are available:
88 88
89=over 4 89=over
90 90
91=item B<-help>, B<--help> 91=item B<-help>, B<--help>
92 92
93Print out a message describing available options. 93Print out a message describing available options.
94 94
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
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>.
374 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
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
379=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
393Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
394button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
395in-use. Instead of selecting a full line it will extend the selection to 408in-use. Instead of selecting a full line it will extend the selection to
396the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
397 410
411=item B<-dpb>|B<+dpb>
412
413Compile frills: Disable (or enable) emitting bracketed paste mode
414sequences (default enabled). Bracketed paste mode allows programs
415to detect when something is pasted. Since more and more programs
416abuse this, these sequences can be disabled. The command sequences to
417enable and query paste mode will still work, but the actual bracket
418sequences will no longer be emitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
420
398=item B<-insecure> 421=item B<-insecure>
399 422
400Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
401sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
402info. 425info.
414 437
415=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
416 439
417Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
418B<secondaryScroll>. 441B<secondaryScroll>.
442
443=item B<-rm> I<mode>
444
445Compile I<frills>: Sets long line rewrapping behaviour on window resizes
446to one of B<auto> (the default), B<always> or B<never>. The latter two
447modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
448is non-empty, and wings lines (acts like B<never>) otherwise; resource
449B<rewrapMode>.
419 450
420=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
421 452
422Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
423will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
538be used. Command-line arguments can be used to override resource 569be used. Command-line arguments can be used to override resource
539settings. The following resources are supported (you might want to 570settings. The following resources are supported (you might want to
540check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 571check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
541extensions not documented here): 572extensions not documented here):
542 573
543=over 4 574=over
544 575
545=item B<depth:> I<bitdepth> 576=item B<depth:> I<bitdepth>
546 577
547Compile I<xft>: Attempt to find a visual with the given bit depth; 578Compile I<xft>: Attempt to find a visual with the given bit depth;
548option B<-depth>. 579option B<-depth>.
781 812
782B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 813B<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 814the shell; option B<-ls>. B<False>: start as a normal sub-shell
784[default]; option B<+ls>. 815[default]; option B<+ls>.
785 816
817=item B<multiClickTime:> I<number>
818
819Specify the maximum time in milliseconds between multi-click select
820events. The default is 500 milliseconds; option B<-mc>.
821
786=item B<utmpInhibit:> I<boolean> 822=item B<utmpInhibit:> I<boolean>
787 823
788B<True>: inhibit writing record into the system log file B<utmp>; 824B<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> 825option B<-ut>. B<False>: write record into the system log file B<utmp>
790[default]; option B<+ut>. 826[default]; option B<+ut>.
853are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 889are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
854bottom when a non-special key is pressed; option B<+sk>. 890bottom when a non-special key is pressed; option B<+sk>.
855 891
856=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
857 893
858Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
859resource is limited on most machines to 65535; option B<-sl>.
860 895
861=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
862 897
863Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
864option B<-b>. 899option B<-b>.
927 962
928=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
929 964
930Mouse pointer background colour. 965Mouse pointer background colour.
931 966
967=item B<pointerShape:> I<string>
968
969Compile I<frills>: Specifies the name of the mouse pointer shape
970[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
971file for possible values (omit the C<XC_> prefix).
972
932=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
933 974
934Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
935large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
936 977
962 1003
963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
964 1005
965=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
966 1007
967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968 1009
969=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
970 1011
971I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
972 1013
990 1031
991Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
992button. Instead of selecting a full line it will extend the selection to 1033button. Instead of selecting a full line it will extend the selection to
993the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
994 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
995=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
996 1041
997Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
998echo arbitrary strings like the icon name or the locale. This could be 1043echo arbitrary strings like the icon name or the locale. This could be
999abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1000through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1001write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1002default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
1020 1065
1021=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1022 1067
1023Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1024 1069
1070=item B<rewrapMode:> I<mode>
1071
1072Sets long line rewrap behaviour on window resize to one of B<auto>
1073(default), B<always> or B<never>.
1074
1025=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1026 1076
1027Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1028option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1029scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
1055extension might provide. 1105extension might provide.
1056 1106
1057The key combination that triggers the action, I<sym>, has the following format: 1107The key combination that triggers the action, I<sym>, has the following format:
1058 1108
1059 (modifiers-)key 1109 (modifiers-)key
1060 1110
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1111Where I<modifiers> can be any combination of the following full or
1062B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, 1112abbreviated modifier names:
1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1113
1064B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. 1114=begin table
1115
1116 B<ISOLevel3> B<I>
1117 B<AppKeypad> B<K>
1118 B<Control> B<C>
1119 B<NumLock> B<N>
1120 B<Shift> B<S>
1121 B<Meta> B<M> I<or> B<A>
1122 B<Lock> B<L>
1123 B<Mod1> B<1>
1124 B<Mod2> B<2>
1125 B<Mod3> B<3>
1126 B<Mod4> B<4>
1127 B<Mod5> B<5>
1128
1129=end table
1065 1130
1066The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1131The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1067whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1132whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1068keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1133keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1069current application keymap mode state. 1134current application keymap mode state.
1085As with any resource value, the I<action> string may contain backslash 1150As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal 1151escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087number), see RESOURCES in C<man 7 X> for further details. 1152number), see RESOURCES in C<man 7 X> for further details.
1088 1153
1089An action starts with an action prefix that selects a certain type 1154An action starts with an action prefix that selects a certain type
1090of action, followed by a colon. An action strings without colons is 1155of 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 1156interpreted as a literal string to pass to the tty (as if it was
1092prefixed with C<string:>). 1157prefixed with C<string:>).
1093 1158
1094The following action prefixes are known - extensions can provide 1159The following action prefixes are known - extensions can provide
1095additional prefixes: 1160additional prefixes:
1096 1161
1097=over 4 1162=over
1098 1163
1099=item string:STRING 1164=item string:STRING
1100 1165
1101If the I<action> starts with C<string:> (or otherwise contains no colons), 1166If the I<action> starts with C<string:> (or otherwise contains no colons),
1102then the remaining C<STRING> will be passed to the program running in the 1167then the remaining C<STRING> will be passed to the program running in the
1104string C<echo rm -rf /> followed by a newline: 1169string C<echo rm -rf /> followed by a newline:
1105 1170
1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1171 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107 1172
1108This could in theory be used to completely redefine your keymap. 1173This could in theory be used to completely redefine your keymap.
1174
1175In addition, for actions of this type, you can define a range of
1176keysyms in one shot by loading the C<keysym-list> perl extension and
1177providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1178the delimiter `/' should be a character not used by the strings.
1179
1180Its usage can be demonstrated by an example:
1181
1182 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1183
1184The above line is equivalent to the following three lines:
1185
1186 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1187 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1188 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1109 1189
1110=item command:STRING 1190=item command:STRING
1111 1191
1112If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1192If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1193is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1170The first line disables the paste functionality for that key 1250The first line disables the paste functionality for that key
1171combination, and the second reinstates the default behaviour for 1251combination, and the second reinstates the default behaviour for
1172C<Control-Shift-Insert>, which would otherwise be overridden. 1252C<Control-Shift-Insert>, which would otherwise be overridden.
1173 1253
1174Similarly, to let applications gain access to the C<C-M-c> (copy to 1254Similarly, 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 1255clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this: 1256this:
1177 1257
1178 URxvt.keysym.C-S-c: builtin-string: 1258 URxvt.keysym.C-M-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string: 1259 URxvt.keysym.C-M-v: builtin-string:
1180 1260
1181=item EXTENSION:STRING 1261=item EXTENSION:STRING
1182 1262
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1263An action of this form invokes the action B<STRING>, if any, provided
1184extension of the same name. The extension will be loaded automatically if 1264by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1185neccessary. 1265be loaded automatically if necessary.
1186 1266
1187Not all extensions define key actions, but popular extensions that do 1267Not all extensions define actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their 1268include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1269own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively). 1270respectively).
1191 1271
1192From the silly examples department, this will rot13-"encrypt" 1272From the silly examples department, this will rot13-"encrypt"
1193@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC 1273@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1194keyboards: 1274keyboards:
1195 1275
1196 URxvt.keysym.M-C-c: selection:rot13 1276 URxvt.keysym.M-C-c: selection:rot13
1197 1277
1198=item perl:STRING 1278=item perl:STRING *DEPRECATED*
1199 1279
1200This is a deprecated way of passing key mappings to perl extensions. It is 1280This is a deprecated way of invoking commands provided by perl
1201still supported, but should not be used anymore. 1281extensions. It is still supported, but should not be used anymore.
1202 1282
1203=back 1283=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 1284
1220=item B<perl-ext-common>: I<string> 1285=item B<perl-ext-common>: I<string>
1221 1286
1222=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1223 1288
1224Comma-separated list(s) of perl extension scripts (default: C<default>) to 1289Comma-separated list(s) of perl extension scripts (default: C<default>) to
1225use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1226 1291
1227Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to remove them again, in
1228them. This can be useful to selectively disable some extensions loaded 1293case they had been specified earlier. This can be useful to selectively
1229by default, or specified via the C<perl-ext-common> resource. For 1294disable some extensions loaded by default, or specified via the
1230example, C<default,-selection> will use all the default extension except 1295C<perl-ext-common> resource. For example, C<default,-selection> will use
1231C<selection>. 1296all the default extensions except C<selection>.
1232 1297
1233Extension names can also be followed by an argument in angle brackets 1298To prohibit autoloading of extensions, you can prefix them with C</>,
1234(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1299which will make urxvt refuse to automatically load them (this can be
1235searchable scrollback to Alt/Meta-s). Mentioning the same extension 1300overriden, however, by specifying the extension name again without a
1236multiple times with different arguments will pass multiple arguments to 1301prefix, though). This does not prohibit extensions themselves loading
1237the extension. 1302other extensions. For example, C<default,/background> will keep the
1303C<background> extension from being loaded when a background OSC sequence
1304is received.
1305
1306The default set includes the C<selection>, C<option-popup>,
1307C<selection-popup>, C<readline>, C<searchable-scrollback> and
1308C<confirm-paste> extensions, as well as any extensions which are mentioned
1309in B<keysym> resources.
1310
1311Any extension such that a corresponding resource is given on the
1312command line is automatically appended to B<perl-ext>.
1238 1313
1239Each extension is looked up in the library directories, loaded if 1314Each extension is looked up in the library directories, loaded if
1240necessary, and bound to the current terminal instance. 1315necessary, and bound to the current terminal instance. When the library
1316search path contains multiple extension files of the same name, then the
1317first one found will be used.
1241 1318
1242If both of these resources are the empty string, then the perl 1319If both of these resources are the empty string, then the perl interpreter
1243interpreter will not be initialized. The idea behind two options is that 1320will 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 1321B<perl-ext-common> will be used for extensions that should be available to
1245all instances, while B<perl-ext> is used for specific instances. 1322all instances, while B<perl-ext> is used for specific instances.
1246 1323
1247=item B<perl-eval>: I<string> 1324=item B<perl-eval>: I<string>
1248 1325
1266=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1343=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1267 1344
1268Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1345Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1269for details. 1346for details.
1270 1347
1271=item B<searchable-scrollback:> I<keysym> 1348=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1272 1349
1273Sets the hotkey that starts the incremental scrollback buffer search 1350This resource is deprecated and will be removed. Use a B<keysym> resource
1274(default: C<M-s>). 1351instead, e.g.:
1352
1353 URxvt.keysym.M-s: searchable-scrollback:start
1275 1354
1276=item B<url-launcher>: I<string> 1355=item B<url-launcher>: I<string>
1277 1356
1278Specifies the program to be started with a URL argument. Used by the 1357Specifies the program to be started with a URL argument. Used by the
1279C<selection-popup> and C<matcher> perl extensions. 1358C<selection-popup> and C<matcher> perl extensions.
1292Turn on/off ISO 14755 (default enabled). 1371Turn on/off ISO 14755 (default enabled).
1293 1372
1294=item B<iso14755_52:> I<boolean> 1373=item B<iso14755_52:> I<boolean>
1295 1374
1296Turn on/off ISO 14755 5.2 mode (default enabled). 1375Turn on/off ISO 14755 5.2 mode (default enabled).
1297
1298=back
1299
1300=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1301
1302=over 4
1303
1304=item B<-pixmap> I<file[;oplist]>
1305
1306=item B<backgroundPixmap:> I<file[;oplist]>
1307
1308Compile I<pixbuf>: Use the specified image file as the window's
1309background and also optionally specify a colon separated list of
1310operations to modify it. Note that you may need to quote the C<;>
1311character when using the command line option, as C<;> is usually a
1312metacharacter in shells. Supported operations are:
1313
1314=over 4
1315
1316=item B<WxH+X+Y>
1317
1318sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1319scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1320scale of 0 disables scaling.
1321
1322=item B<op=tile>
1323
1324enables tiling
1325
1326=item B<op=keep-aspect>
1327
1328maintain the image aspect ratio when scaling
1329
1330=item B<op=root-align>
1331
1332use the position of the terminal window relative to the root window as
1333the image offset, simulating a root window background
1334
1335=back
1336
1337The default scale and position setting is C<100x100+50+50>.
1338Alternatively, a predefined set of templates can be used to achieve
1339the most common setups:
1340
1341=over 4
1342
1343=item B<style=tiled>
1344
1345the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1346
1347=item B<style=aspect-stretched>
1348
1349the image is scaled to fill the whole window maintaining the aspect
1350ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1351
1352=item B<style=stretched>
1353
1354the image is scaled to fill the whole window. Equivalent to 100x100
1355
1356=item B<style=centered>
1357
1358the image is centered with no scaling. Equivalent to 0x0+50+50
1359
1360=item B<style=root-tiled>
1361
1362the image is tiled with no scaling and using 'root' positioning.
1363Equivalent to 0x0:op=tile:op=root-align
1364
1365=back
1366
1367If multiple templates are specified the last one wins. Note that a
1368template overrides all the scale, position and operations settings.
1369
1370If used in conjunction with pseudo-transparency, the specified pixmap
1371will be blended over the transparent background using alpha-blending.
1372
1373=item B<-tr>|B<+tr>
1374
1375=item B<transparent:> I<boolean>
1376
1377Turn on/off pseudo-transparency by using the root pixmap as background.
1378
1379B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1380will be removed in future versions.
1381
1382=item B<-tint> I<colour>
1383
1384=item B<tintColor:> I<colour>
1385
1386Tint the transparent background with the given colour. Note that a
1387black tint yields a completely black image while a white tint yields
1388the image unchanged.
1389
1390=item B<-sh> I<number>
1391
1392=item B<shading:> I<number>
1393
1394Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1395A value of 100 means no shading.
1396
1397=item B<-blr> I<HxV>
1398
1399=item B<blurRadius:> I<HxV>
1400
1401Apply gaussian blur with the specified radius to the transparent
1402background. If a single number is specified, the vertical and
1403horizontal radii are considered to be the same. Setting one of the
1404radii to 1 and the other to a large number creates interesting effects
1405on some backgrounds. The maximum radius value is 128. An horizontal or
1406vertical radius of 0 disables blurring.
1407
1408=item B<path:> I<path>
1409
1410Specify the colon-delimited search path for finding background image files.
1411 1376
1412=back 1377=back
1413 1378
1414=head1 THE SCROLLBAR 1379=head1 THE SCROLLBAR
1415 1380
1439=head1 THE SELECTION: SELECTING AND PASTING TEXT 1404=head1 THE SELECTION: SELECTING AND PASTING TEXT
1440 1405
1441The behaviour of text selection and insertion/pasting mechanism is similar 1406The behaviour of text selection and insertion/pasting mechanism is similar
1442to I<xterm>(1). 1407to I<xterm>(1).
1443 1408
1444=over 4 1409=over
1445 1410
1446=item B<Selecting>: 1411=item B<Selecting>:
1447 1412
1448Left click at the beginning of the region, drag to the end of the region 1413Left click at the beginning of the region, drag to the end of the region
1449and release; Right click to extend the marked region; Left double-click 1414and release; Right click to extend the marked region; Left double-click
1496and character codes using the keyboard. It consists of 4 parts. The 1461and character codes using the keyboard. It consists of 4 parts. The
1497first part is available if rxvt-unicode has been compiled with 1462first part is available if rxvt-unicode has been compiled with
1498C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1463C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1499with C<--enable-iso14755>. 1464with C<--enable-iso14755>.
1500 1465
1501=over 4 1466=over
1502 1467
1503=item * 5.1: Basic method 1468=item * 5.1: Basic method
1504 1469
1505This allows you to enter unicode characters using their hexcode. 1470This allows you to enter unicode characters using their hexcode.
1506 1471
1567In addition to the default foreground and background colours, 1532In addition to the default foreground and background colours,
1568B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1533B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1569high-intensity (potentially bold/blink) versions of the same, and 72 (or 1534high-intensity (potentially bold/blink) versions of the same, and 72 (or
1570240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1535240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1571cube plus a 8 (24) colour greyscale ramp. 1536cube plus a 8 (24) colour greyscale ramp.
1537
1538B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1539C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1540number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1541colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
154224-bit colour space. When indexing collisions happen, the nearest old colour in
1543the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1544use many similar 24-bit colours. It's typically not a problem in common
1545scenarios.
1572 1546
1573Here is a list of the ANSI colours with their names. 1547Here is a list of the ANSI colours with their names.
1574 1548
1575=begin table 1549=begin table
1576 1550
1677 1651
1678=head1 ENVIRONMENT 1652=head1 ENVIRONMENT
1679 1653
1680B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1654B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1681 1655
1682=over 4 1656=over
1683 1657
1684=item B<TERM> 1658=item B<TERM>
1685 1659
1686Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1660Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1687resources or on the command line. 1661resources or on the command line.
1758 1732
1759=back 1733=back
1760 1734
1761=head1 FILES 1735=head1 FILES
1762 1736
1763=over 4 1737=over
1764 1738
1765=item B</usr/lib/X11/rgb.txt> 1739=item B</usr/lib/X11/rgb.txt>
1766 1740
1767Colour names. 1741Colour names.
1768 1742
1773@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), 1747@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1774@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1748@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1775 1749
1776=head1 CURRENT PROJECT COORDINATOR 1750=head1 CURRENT PROJECT COORDINATOR
1777 1751
1778=over 4 1752=over
1779 1753
1780=item Project Coordinator 1754=item Project Coordinator
1781 1755
1782Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1756Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1783 1757
1785 1759
1786=back 1760=back
1787 1761
1788=head1 AUTHORS 1762=head1 AUTHORS
1789 1763
1790=over 4 1764=over
1791 1765
1792=item John Bovey 1766=item John Bovey
1793 1767
1794University of Kent, 1992, wrote the original Xvt. 1768University of Kent, 1992, wrote the original Xvt.
1795 1769

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines