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.259 by sf-exg, Sun Dec 19 20:48:21 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
501 close $pty; 532 close $pty;
502 533
503 # now communicate with rxvt 534 # now communicate with rxvt
504 my $slave = $pty->slave; 535 my $slave = $pty->slave;
505 while (<$slave>) { print $slave "got <$_>\n" } 536 while (<$slave>) { print $slave "got <$_>\n" }
537
538Note that, despite what the name might imply, the file descriptor does not
539need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
540domain or tcp socket). While tty operations cannot be done in this case,
541B<@@RXVT_NAME@@> can still be remote controlled with it:
542
543 use Socket;
544 use Fcntl;
545
546 socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
547 fcntl $slave, Fcntl::F_SETFD, 0;
548 system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
549 close $slave;
550
551 syswrite $URXVT, "Type a secret password: ";
552 my $secret = do { local $/ = "\r"; <$URXVT> };
553 print "Not so secret anymore: $secret\n";
506 554
507=item B<-pe> I<string> 555=item B<-pe> I<string>
508 556
509Comma-separated list of perl extension scripts to use (or not to use) in 557Comma-separated list of perl extension scripts to use (or not to use) in
510this terminal instance. See resource B<perl-ext> for details. 558this terminal instance. See resource B<perl-ext> for details.
538be used. Command-line arguments can be used to override resource 586be used. Command-line arguments can be used to override resource
539settings. The following resources are supported (you might want to 587settings. The following resources are supported (you might want to
540check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 588check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
541extensions not documented here): 589extensions not documented here):
542 590
543=over 4 591=over
544 592
545=item B<depth:> I<bitdepth> 593=item B<depth:> I<bitdepth>
546 594
547Compile I<xft>: Attempt to find a visual with the given bit depth; 595Compile I<xft>: Attempt to find a visual with the given bit depth;
548option B<-depth>. 596option B<-depth>.
781 829
782B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 830B<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 831the shell; option B<-ls>. B<False>: start as a normal sub-shell
784[default]; option B<+ls>. 832[default]; option B<+ls>.
785 833
834=item B<multiClickTime:> I<number>
835
836Specify the maximum time in milliseconds between multi-click select
837events. The default is 500 milliseconds; option B<-mc>.
838
786=item B<utmpInhibit:> I<boolean> 839=item B<utmpInhibit:> I<boolean>
787 840
788B<True>: inhibit writing record into the system log file B<utmp>; 841B<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> 842option B<-ut>. B<False>: write record into the system log file B<utmp>
790[default]; option B<+ut>. 843[default]; option B<+ut>.
853are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 906are 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>. 907bottom when a non-special key is pressed; option B<+sk>.
855 908
856=item B<saveLines:> I<number> 909=item B<saveLines:> I<number>
857 910
858Save I<number> lines in the scrollback buffer [default 64]. This 911Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
859resource is limited on most machines to 65535; option B<-sl>.
860 912
861=item B<internalBorder:> I<number> 913=item B<internalBorder:> I<number>
862 914
863Internal border of I<number> pixels. This resource is limited to 100; 915Internal border of I<number> pixels. This resource is limited to 100;
864option B<-b>. 916option B<-b>.
927 979
928=item B<pointerColor2:> I<colour> 980=item B<pointerColor2:> I<colour>
929 981
930Mouse pointer background colour. 982Mouse pointer background colour.
931 983
984=item B<pointerShape:> I<string>
985
986Compile I<frills>: Specifies the name of the mouse pointer shape
987[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
988file for possible values (omit the C<XC_> prefix).
989
932=item B<pointerBlankDelay:> I<number> 990=item B<pointerBlankDelay:> I<number>
933 991
934Specifies number of seconds before blanking the pointer [default 2]. Use a 992Specifies number of seconds before blanking the pointer [default 2]. Use a
935large number (e.g. C<987654321>) to effectively disable the timeout. 993large number (e.g. C<987654321>) to effectively disable the timeout.
936 994
962 1020
963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1021B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
964 1022
965=item B<preeditType:> I<style> 1023=item B<preeditType:> I<style>
966 1024
967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1025B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968 1026
969=item B<inputMethod:> I<name> 1027=item B<inputMethod:> I<name>
970 1028
971I<name> of inputMethod to use; option B<-im>. 1029I<name> of inputMethod to use; option B<-im>.
972 1030
990 1048
991Change the meaning of triple-click selection with the left mouse 1049Change the meaning of triple-click selection with the left mouse
992button. Instead of selecting a full line it will extend the selection to 1050button. Instead of selecting a full line it will extend the selection to
993the end of the logical line only; option B<-tcw>. 1051the end of the logical line only; option B<-tcw>.
994 1052
1053=item B<disablePasteBrackets:> I<boolean>
1054
1055Prevent emission of paste bracket sequences; option B<-dpb>.
1056
995=item B<insecure:> I<boolean> 1057=item B<insecure:> I<boolean>
996 1058
997Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1059Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
998echo arbitrary strings like the icon name or the locale. This could be 1060echo arbitrary strings like the icon name or the locale. This could be
999abused if somebody gets 8-bit-clean access to your display, whether 1061abused if somebody gets 8-bit-clean access to your display, whether
1000through a mail client displaying mail bodies unfiltered or through 1062through a mail client displaying mail bodies unfiltered or through
1001write(1) or any other means. Therefore, these sequences are disabled by 1063write(1) or any other means. Therefore, these sequences are disabled by
1002default. (Note that many other terminals, including xterm, have these 1064default. (Note that many other terminals, including xterm, have these
1020 1082
1021=item B<secondaryScreen:> I<boolean> 1083=item B<secondaryScreen:> I<boolean>
1022 1084
1023Turn on/off secondary screen (default enabled). 1085Turn on/off secondary screen (default enabled).
1024 1086
1087=item B<rewrapMode:> I<mode>
1088
1089Sets long line rewrap behaviour on window resize to one of B<auto>
1090(default), B<always> or B<never>.
1091
1025=item B<secondaryScroll:> I<boolean> 1092=item B<secondaryScroll:> I<boolean>
1026 1093
1027Turn on/off secondary screen scroll (default enabled). If this 1094Turn on/off secondary screen scroll (default enabled). If this
1028option is enabled, scrolls on the secondary screen will change the 1095option is enabled, scrolls on the secondary screen will change the
1029scrollback buffer and, when secondaryScreen is off, switching 1096scrollback buffer and, when secondaryScreen is off, switching
1056 1123
1057The key combination that triggers the action, I<sym>, has the following format: 1124The key combination that triggers the action, I<sym>, has the following format:
1058 1125
1059 (modifiers-)key 1126 (modifiers-)key
1060 1127
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1128Where 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>, 1129abbreviated modifier names:
1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1130
1064B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. 1131=begin table
1132
1133 B<ISOLevel3> B<I>
1134 B<AppKeypad> B<K>
1135 B<Control> B<C>
1136 B<NumLock> B<N>
1137 B<Shift> B<S>
1138 B<Meta> B<M> I<or> B<A>
1139 B<Lock> B<L>
1140 B<Mod1> B<1>
1141 B<Mod2> B<2>
1142 B<Mod3> B<3>
1143 B<Mod4> B<4>
1144 B<Mod5> B<5>
1145
1146=end table
1065 1147
1066The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1148The 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 1149whatever 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 1150keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1069current application keymap mode state. 1151current application keymap mode state.
1085As with any resource value, the I<action> string may contain backslash 1167As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal 1168escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087number), see RESOURCES in C<man 7 X> for further details. 1169number), see RESOURCES in C<man 7 X> for further details.
1088 1170
1089An action starts with an action prefix that selects a certain type 1171An action starts with an action prefix that selects a certain type
1090of action, followed by a colon. An action strings without colons is 1172of 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 1173interpreted as a literal string to pass to the tty (as if it was
1092prefixed with C<string:>). 1174prefixed with C<string:>).
1093 1175
1094The following action prefixes are known - extensions can provide 1176The following action prefixes are known - extensions can provide
1095additional prefixes: 1177additional prefixes:
1096 1178
1097=over 4 1179=over
1098 1180
1099=item string:STRING 1181=item string:STRING
1100 1182
1101If the I<action> starts with C<string:> (or otherwise contains no colons), 1183If 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 1184then the remaining C<STRING> will be passed to the program running in the
1104string C<echo rm -rf /> followed by a newline: 1186string C<echo rm -rf /> followed by a newline:
1105 1187
1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1188 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107 1189
1108This could in theory be used to completely redefine your keymap. 1190This could in theory be used to completely redefine your keymap.
1191
1192In addition, for actions of this type, you can define a range of
1193keysyms in one shot by loading the C<keysym-list> perl extension and
1194providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1195the delimiter `/' should be a character not used by the strings.
1196
1197Its usage can be demonstrated by an example:
1198
1199 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1200
1201The above line is equivalent to the following three lines:
1202
1203 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1204 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1205 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1109 1206
1110=item command:STRING 1207=item command:STRING
1111 1208
1112If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1209If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1210is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1173 1270
1174Similarly, to let applications gain access to the C<C-M-c> (copy to 1271Similarly, 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 1272clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this: 1273this:
1177 1274
1178 URxvt.keysym.C-S-c: builtin-string: 1275 URxvt.keysym.C-M-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string: 1276 URxvt.keysym.C-M-v: builtin-string:
1180 1277
1181=item EXTENSION:STRING 1278=item EXTENSION:STRING
1182 1279
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1280An action of this form invokes the action B<STRING>, if any, provided
1184extension of the same name. The extension will be loaded automatically if 1281by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1185neccessary. 1282be loaded automatically if necessary.
1186 1283
1187Not all extensions define key actions, but popular extensions that do 1284Not all extensions define actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their 1285include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1286own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively). 1287respectively).
1191 1288
1192From the silly examples department, this will rot13-"encrypt" 1289From the silly examples department, this will rot13-"encrypt"
1195 1292
1196 URxvt.keysym.M-C-c: selection:rot13 1293 URxvt.keysym.M-C-c: selection:rot13
1197 1294
1198=item perl:STRING *DEPRECATED* 1295=item perl:STRING *DEPRECATED*
1199 1296
1200This is a deprecated way of passing key mappings to perl extensions. It is 1297This is a deprecated way of invoking commands provided by perl
1201still supported, but should not be used anymore. 1298extensions. It is still supported, but should not be used anymore.
1202 1299
1203=back 1300=back
1204 1301
1205=item B<perl-ext-common>: I<string> 1302=item B<perl-ext-common>: I<string>
1206 1303
1207=item B<perl-ext>: I<string> 1304=item B<perl-ext>: I<string>
1208 1305
1209Comma-separated list(s) of perl extension scripts (default: C<default>) to 1306Comma-separated list(s) of perl extension scripts (default: C<default>) to
1210use in this terminal instance; option B<-pe>. 1307use in this terminal instance; option B<-pe>.
1211 1308
1212Extension names can be prefixed with a C<-> sign to prohibit using 1309Extension names can be prefixed with a C<-> sign to remove them again, in
1213them. This can be useful to selectively disable some extensions loaded 1310case they had been specified earlier. This can be useful to selectively
1214by default, or specified via the C<perl-ext-common> resource. For 1311disable some extensions loaded by default, or specified via the
1215example, C<default,-selection> will use all the default extension except 1312C<perl-ext-common> resource. For example, C<default,-selection> will use
1216C<selection>. 1313all the default extensions except C<selection>.
1217 1314
1218Some extensions define resources or command line switches, and will 1315To prohibit autoloading of extensions, you can prefix them with C</>,
1219automatically be used when their resource or switch is specified. 1316which will make urxvt refuse to automatically load them (this can be
1317overridden, however, by specifying the extension name again without a
1318prefix, though). This does not prohibit extensions themselves loading
1319other extensions. For example, C<default,/background> will keep the
1320C<background> extension from being loaded when a background OSC sequence
1321is received.
1322
1323The default set includes the C<selection>, C<option-popup>,
1324C<selection-popup>, C<readline>, C<searchable-scrollback> and
1325C<confirm-paste> extensions, as well as any extensions which are mentioned
1326in B<keysym> resources.
1327
1328Any extension such that a corresponding resource is given on the
1329command line is automatically appended to B<perl-ext>.
1220 1330
1221Each extension is looked up in the library directories, loaded if 1331Each extension is looked up in the library directories, loaded if
1222necessary, and bound to the current terminal instance. 1332necessary, and bound to the current terminal instance. When the library
1333search path contains multiple extension files of the same name, then the
1334first one found will be used.
1223 1335
1224If both of these resources are the empty string, then the perl interpreter 1336If both of these resources are the empty string, then the perl interpreter
1225will not be initialized. The rationale for having two options is that 1337will 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 1338B<perl-ext-common> will be used for extensions that should be available to
1227all instances, while B<perl-ext> is used for specific instances. 1339all instances, while B<perl-ext> is used for specific instances.
1276Turn on/off ISO 14755 (default enabled). 1388Turn on/off ISO 14755 (default enabled).
1277 1389
1278=item B<iso14755_52:> I<boolean> 1390=item B<iso14755_52:> I<boolean>
1279 1391
1280Turn on/off ISO 14755 5.2 mode (default enabled). 1392Turn on/off ISO 14755 5.2 mode (default enabled).
1281
1282=back
1283
1284=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1285
1286=over 4
1287
1288=item B<-pixmap> I<file[;oplist]>
1289
1290=item B<backgroundPixmap:> I<file[;oplist]>
1291
1292Compile I<pixbuf>: Use the specified image file as the window's
1293background and also optionally specify a colon separated list of
1294operations to modify it. Note that you may need to quote the C<;>
1295character when using the command line option, as C<;> is usually a
1296metacharacter in shells. Supported operations are:
1297
1298=over 4
1299
1300=item B<WxH+X+Y>
1301
1302sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1303scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1304scale of 0 disables scaling.
1305
1306=item B<op=tile>
1307
1308enables tiling
1309
1310=item B<op=keep-aspect>
1311
1312maintain the image aspect ratio when scaling
1313
1314=item B<op=root-align>
1315
1316use the position of the terminal window relative to the root window as
1317the image offset, simulating a root window background
1318
1319=back
1320
1321The default scale and position setting is C<100x100+50+50>.
1322Alternatively, a predefined set of templates can be used to achieve
1323the most common setups:
1324
1325=over 4
1326
1327=item B<style=tiled>
1328
1329the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1330
1331=item B<style=aspect-stretched>
1332
1333the image is scaled to fill the whole window maintaining the aspect
1334ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1335
1336=item B<style=stretched>
1337
1338the image is scaled to fill the whole window. Equivalent to 100x100
1339
1340=item B<style=centered>
1341
1342the image is centered with no scaling. Equivalent to 0x0+50+50
1343
1344=item B<style=root-tiled>
1345
1346the image is tiled with no scaling and using 'root' positioning.
1347Equivalent to 0x0:op=tile:op=root-align
1348
1349=back
1350
1351If multiple templates are specified the last one wins. Note that a
1352template overrides all the scale, position and operations settings.
1353
1354If used in conjunction with pseudo-transparency, the specified pixmap
1355will be blended over the transparent background using alpha-blending.
1356
1357=item B<-tr>|B<+tr>
1358
1359=item B<transparent:> I<boolean>
1360
1361Turn on/off pseudo-transparency by using the root pixmap as background.
1362
1363B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1364will be removed in future versions.
1365
1366=item B<-tint> I<colour>
1367
1368=item B<tintColor:> I<colour>
1369
1370Tint the transparent background with the given colour. Note that a
1371black tint yields a completely black image while a white tint yields
1372the image unchanged.
1373
1374=item B<-sh> I<number>
1375
1376=item B<shading:> I<number>
1377
1378Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1379A value of 100 means no shading.
1380
1381=item B<-blr> I<HxV>
1382
1383=item B<blurRadius:> I<HxV>
1384
1385Apply gaussian blur with the specified radius to the transparent
1386background. If a single number is specified, the vertical and
1387horizontal radii are considered to be the same. Setting one of the
1388radii to 1 and the other to a large number creates interesting effects
1389on some backgrounds. The maximum radius value is 128. An horizontal or
1390vertical radius of 0 disables blurring.
1391
1392=item B<path:> I<path>
1393
1394Specify the colon-delimited search path for finding background image files.
1395 1393
1396=back 1394=back
1397 1395
1398=head1 THE SCROLLBAR 1396=head1 THE SCROLLBAR
1399 1397
1423=head1 THE SELECTION: SELECTING AND PASTING TEXT 1421=head1 THE SELECTION: SELECTING AND PASTING TEXT
1424 1422
1425The behaviour of text selection and insertion/pasting mechanism is similar 1423The behaviour of text selection and insertion/pasting mechanism is similar
1426to I<xterm>(1). 1424to I<xterm>(1).
1427 1425
1428=over 4 1426=over
1429 1427
1430=item B<Selecting>: 1428=item B<Selecting>:
1431 1429
1432Left click at the beginning of the region, drag to the end of the region 1430Left click at the beginning of the region, drag to the end of the region
1433and release; Right click to extend the marked region; Left double-click 1431and release; Right click to extend the marked region; Left double-click
1480and character codes using the keyboard. It consists of 4 parts. The 1478and character codes using the keyboard. It consists of 4 parts. The
1481first part is available if rxvt-unicode has been compiled with 1479first part is available if rxvt-unicode has been compiled with
1482C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1480C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1483with C<--enable-iso14755>. 1481with C<--enable-iso14755>.
1484 1482
1485=over 4 1483=over
1486 1484
1487=item * 5.1: Basic method 1485=item * 5.1: Basic method
1488 1486
1489This allows you to enter unicode characters using their hexcode. 1487This allows you to enter unicode characters using their hexcode.
1490 1488
1551In addition to the default foreground and background colours, 1549In addition to the default foreground and background colours,
1552B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1550B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1553high-intensity (potentially bold/blink) versions of the same, and 72 (or 1551high-intensity (potentially bold/blink) versions of the same, and 72 (or
1554240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1552240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1555cube plus a 8 (24) colour greyscale ramp. 1553cube plus a 8 (24) colour greyscale ramp.
1554
1555B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1556C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1557number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1558colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
155924-bit colour space. When indexing collisions happen, the nearest old colour in
1560the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1561use many similar 24-bit colours. It's typically not a problem in common
1562scenarios.
1556 1563
1557Here is a list of the ANSI colours with their names. 1564Here is a list of the ANSI colours with their names.
1558 1565
1559=begin table 1566=begin table
1560 1567
1661 1668
1662=head1 ENVIRONMENT 1669=head1 ENVIRONMENT
1663 1670
1664B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1671B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1665 1672
1666=over 4 1673=over
1667 1674
1668=item B<TERM> 1675=item B<TERM>
1669 1676
1670Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1677Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1671resources or on the command line. 1678resources or on the command line.
1742 1749
1743=back 1750=back
1744 1751
1745=head1 FILES 1752=head1 FILES
1746 1753
1747=over 4 1754=over
1748 1755
1749=item B</usr/lib/X11/rgb.txt> 1756=item B</usr/lib/X11/rgb.txt>
1750 1757
1751Colour names. 1758Colour names.
1752 1759
1757@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), 1764@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1758@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1765@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1759 1766
1760=head1 CURRENT PROJECT COORDINATOR 1767=head1 CURRENT PROJECT COORDINATOR
1761 1768
1762=over 4 1769=over
1763 1770
1764=item Project Coordinator 1771=item Project Coordinator
1765 1772
1766Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1773Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1767 1774
1769 1776
1770=back 1777=back
1771 1778
1772=head1 AUTHORS 1779=head1 AUTHORS
1773 1780
1774=over 4 1781=over
1775 1782
1776=item John Bovey 1783=item John Bovey
1777 1784
1778University of Kent, 1992, wrote the original Xvt. 1785University of Kent, 1992, wrote the original Xvt.
1779 1786

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines