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.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 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
126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
127 128
128=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
129 130
130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
132
133=item B<-fps> I<number>
134
135Compile I<frills>: Set the refresh interval (in frames per second or
136negative seconds); resource B<refreshRate>.
131 137
132=item B<-fade> I<number> 138=item B<-fade> I<number>
133 139
134Fade the text by the given percentage when focus is lost. Small values 140Fade the text by the given percentage when focus is lost. Small values
135fade a little only, 100 completely replaces all colours by the fade 141fade a little only, 100 completely replaces all colours by the fade
218`.' or `*' characters. Also sets the icon and title name. 224`.' or `*' characters. Also sets the icon and title name.
219 225
220=item B<-ls>|B<+ls> 226=item B<-ls>|B<+ls>
221 227
222Start as a login-shell/sub-shell; resource B<loginShell>. 228Start as a login-shell/sub-shell; resource B<loginShell>.
229
230=item B<-mc> I<milliseconds>
231
232Specify the maximum time between multi-click selections.
223 233
224=item B<-ut>|B<+ut> 234=item B<-ut>|B<+ut>
225 235
226Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 236Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227B<utmpInhibit>. 237B<utmpInhibit>.
375=item B<-pt> I<style> 385=item B<-pt> I<style>
376 386
377Compile I<XIM>: input style for input method; B<OverTheSpot>, 387Compile I<XIM>: input style for input method; B<OverTheSpot>,
378B<OffTheSpot>, B<Root>; resource B<preeditType>. 388B<OffTheSpot>, B<Root>; resource B<preeditType>.
379 389
390If the perl extension C<xim-onthespot> is used (which is the default),
391then additionally the C<OnTheSpot> preedit type is available.
392
380=item B<-im> I<text> 393=item B<-im> I<text>
381 394
382Compile I<XIM>: input method name. resource B<inputMethod>. 395Compile I<XIM>: input method name. resource B<inputMethod>.
383 396
384=item B<-imlocale> I<string> 397=item B<-imlocale> I<string>
398Change the meaning of triple-click selection with the left mouse 411Change the meaning of triple-click selection with the left mouse
399button. Only effective when the original (non-perl) selection code is 412button. Only effective when the original (non-perl) selection code is
400in-use. Instead of selecting a full line it will extend the selection to 413in-use. Instead of selecting a full line it will extend the selection to
401the end of the logical line only. resource B<tripleclickwords>. 414the end of the logical line only. resource B<tripleclickwords>.
402 415
416=item B<-dpb>|B<+dpb>
417
418Compile frills: Disable (or enable) emitting bracketed paste mode
419sequences (default enabled). Bracketed paste mode allows programs
420to detect when something is pasted. Since more and more programs
421abuse this, these sequences can be disabled. The command sequences to
422enable and query paste mode will still work, but the actual bracket
423sequences will no longer be emitted. You can also toggle this from the
424ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
425
403=item B<-insecure> 426=item B<-insecure>
404 427
405Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
406sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
407info. 430info.
419 442
420=item B<-ssr>|B<+ssr> 443=item B<-ssr>|B<+ssr>
421 444
422Turn on/off secondary screen scroll (default enabled); resource 445Turn on/off secondary screen scroll (default enabled); resource
423B<secondaryScroll>. 446B<secondaryScroll>.
447
448=item B<-rm> I<mode>
449
450Compile I<frills>: Sets long line rewrapping behaviour on window resizes
451to one of B<auto> (the default), B<always> or B<never>. The latter two
452modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
453is non-empty, and wings lines (acts like B<never>) otherwise; resource
454B<rewrapMode>.
424 455
425=item B<-hold>|B<+hold> 456=item B<-hold>|B<+hold>
426 457
427Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 458Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
428will not immediately destroy its window when the program executed within 459will not immediately destroy its window when the program executed within
506 close $pty; 537 close $pty;
507 538
508 # now communicate with rxvt 539 # now communicate with rxvt
509 my $slave = $pty->slave; 540 my $slave = $pty->slave;
510 while (<$slave>) { print $slave "got <$_>\n" } 541 while (<$slave>) { print $slave "got <$_>\n" }
542
543Note that, despite what the name might imply, the file descriptor does not
544need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
545domain or tcp socket). While tty operations cannot be done in this case,
546B<@@RXVT_NAME@@> can still be remote controlled with it:
547
548 use Socket;
549 use Fcntl;
550
551 socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
552 fcntl $slave, Fcntl::F_SETFD, 0;
553 system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
554 close $slave;
555
556 syswrite $URXVT, "Type a secret password: ";
557 my $secret = do { local $/ = "\r"; <$URXVT> };
558 print "Not so secret anymore: $secret\n";
511 559
512=item B<-pe> I<string> 560=item B<-pe> I<string>
513 561
514Comma-separated list of perl extension scripts to use (or not to use) in 562Comma-separated list of perl extension scripts to use (or not to use) in
515this terminal instance. See resource B<perl-ext> for details. 563this terminal instance. See resource B<perl-ext> for details.
543be used. Command-line arguments can be used to override resource 591be used. Command-line arguments can be used to override resource
544settings. The following resources are supported (you might want to 592settings. The following resources are supported (you might want to
545check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 593check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
546extensions not documented here): 594extensions not documented here):
547 595
548=over 4 596=over
549 597
550=item B<depth:> I<bitdepth> 598=item B<depth:> I<bitdepth>
551 599
552Compile I<xft>: Attempt to find a visual with the given bit depth; 600Compile I<xft>: Attempt to find a visual with the given bit depth;
553option B<-depth>. 601option B<-depth>.
654 702
655B<False>: specify that everything is to be displayed, even 703B<False>: specify that everything is to be displayed, even
656if the refresh is too fast for the human eye to read anything (or the 704if the refresh is too fast for the human eye to read anything (or the
657monitor to display anything); option B<+ss>. 705monitor to display anything); option B<+ss>.
658 706
707=item B<refreshRate:> I<number>
708
709Compile I<frills>: When positive, sets the maximum refreshes per second
710(the default is C<60>). When zero or negative, sets the minimum interval
711between refreshes, negated. That is, positive numbers limit the number
712of refreshes per second to that number, similar to a fps limiter in
713games. Zero or negative numbers get negated and directly set the minimum
714interval between refreshs, that is, C<10> and C<-0.1> both specify the
715same refresh interval (likewise C<50> and C<0.02>). Fractional values are
716supported; option B<-fps>.
717
659=item B<fading:> I<number> 718=item B<fading:> I<number>
660 719
661Fade the text by the given percentage when focus is lost; option B<-fade>. 720Fade the text by the given percentage when focus is lost; option B<-fade>.
662 721
663=item B<fadeColor:> I<colour> 722=item B<fadeColor:> I<colour>
786 845
787B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 846B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
788the shell; option B<-ls>. B<False>: start as a normal sub-shell 847the shell; option B<-ls>. B<False>: start as a normal sub-shell
789[default]; option B<+ls>. 848[default]; option B<+ls>.
790 849
850=item B<multiClickTime:> I<number>
851
852Specify the maximum time in milliseconds between multi-click select
853events. The default is 500 milliseconds; option B<-mc>.
854
791=item B<utmpInhibit:> I<boolean> 855=item B<utmpInhibit:> I<boolean>
792 856
793B<True>: inhibit writing record into the system log file B<utmp>; 857B<True>: inhibit writing record into the system log file B<utmp>;
794option B<-ut>. B<False>: write record into the system log file B<utmp> 858option B<-ut>. B<False>: write record into the system log file B<utmp>
795[default]; option B<+ut>. 859[default]; option B<+ut>.
858are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 922are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
859bottom when a non-special key is pressed; option B<+sk>. 923bottom when a non-special key is pressed; option B<+sk>.
860 924
861=item B<saveLines:> I<number> 925=item B<saveLines:> I<number>
862 926
863Save I<number> lines in the scrollback buffer [default 64]. This 927Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
864resource is limited on most machines to 65535; option B<-sl>.
865 928
866=item B<internalBorder:> I<number> 929=item B<internalBorder:> I<number>
867 930
868Internal border of I<number> pixels. This resource is limited to 100; 931Internal border of I<number> pixels. This resource is limited to 100;
869option B<-b>. 932option B<-b>.
932 995
933=item B<pointerColor2:> I<colour> 996=item B<pointerColor2:> I<colour>
934 997
935Mouse pointer background colour. 998Mouse pointer background colour.
936 999
1000=item B<pointerShape:> I<string>
1001
1002Compile I<frills>: Specifies the name of the mouse pointer shape
1003[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
1004file for possible values (omit the C<XC_> prefix).
1005
937=item B<pointerBlankDelay:> I<number> 1006=item B<pointerBlankDelay:> I<number>
938 1007
939Specifies number of seconds before blanking the pointer [default 2]. Use a 1008Specifies number of seconds before blanking the pointer [default 2]. Use a
940large number (e.g. C<987654321>) to effectively disable the timeout. 1009large number (e.g. C<987654321>) to effectively disable the timeout.
941 1010
967 1036
968B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1037B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
969 1038
970=item B<preeditType:> I<style> 1039=item B<preeditType:> I<style>
971 1040
972B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1041B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
973 1042
974=item B<inputMethod:> I<name> 1043=item B<inputMethod:> I<name>
975 1044
976I<name> of inputMethod to use; option B<-im>. 1045I<name> of inputMethod to use; option B<-im>.
977 1046
995 1064
996Change the meaning of triple-click selection with the left mouse 1065Change the meaning of triple-click selection with the left mouse
997button. Instead of selecting a full line it will extend the selection to 1066button. Instead of selecting a full line it will extend the selection to
998the end of the logical line only; option B<-tcw>. 1067the end of the logical line only; option B<-tcw>.
999 1068
1069=item B<disablePasteBrackets:> I<boolean>
1070
1071Prevent emission of paste bracket sequences; option B<-dpb>.
1072
1000=item B<insecure:> I<boolean> 1073=item B<insecure:> I<boolean>
1001 1074
1002Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1075Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1003echo arbitrary strings like the icon name or the locale. This could be 1076echo arbitrary strings like the icon name or the locale. This could be
1004abused if somebody gets 8-bit-clean access to your display, whether 1077abused if somebody gets 8-bit-clean access to your display, whether
1005through a mail client displaying mail bodies unfiltered or through 1078through a mail client displaying mail bodies unfiltered or through
1006write(1) or any other means. Therefore, these sequences are disabled by 1079write(1) or any other means. Therefore, these sequences are disabled by
1007default. (Note that many other terminals, including xterm, have these 1080default. (Note that many other terminals, including xterm, have these
1025 1098
1026=item B<secondaryScreen:> I<boolean> 1099=item B<secondaryScreen:> I<boolean>
1027 1100
1028Turn on/off secondary screen (default enabled). 1101Turn on/off secondary screen (default enabled).
1029 1102
1103=item B<rewrapMode:> I<mode>
1104
1105Sets long line rewrap behaviour on window resize to one of B<auto>
1106(default), B<always> or B<never>.
1107
1030=item B<secondaryScroll:> I<boolean> 1108=item B<secondaryScroll:> I<boolean>
1031 1109
1032Turn on/off secondary screen scroll (default enabled). If this 1110Turn on/off secondary screen scroll (default enabled). If this
1033option is enabled, scrolls on the secondary screen will change the 1111option is enabled, scrolls on the secondary screen will change the
1034scrollback buffer and, when secondaryScreen is off, switching 1112scrollback buffer and, when secondaryScreen is off, switching
1061 1139
1062The key combination that triggers the action, I<sym>, has the following format: 1140The key combination that triggers the action, I<sym>, has the following format:
1063 1141
1064 (modifiers-)key 1142 (modifiers-)key
1065 1143
1066Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1144Where I<modifiers> can be any combination of the following full or
1067B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, 1145abbreviated modifier names:
1068B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1146
1069B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. 1147=begin table
1148
1149 B<ISOLevel3> B<I>
1150 B<AppKeypad> B<K>
1151 B<Control> B<C>
1152 B<NumLock> B<N>
1153 B<Shift> B<S>
1154 B<Meta> B<M> I<or> B<A>
1155 B<Lock> B<L>
1156 B<Mod1> B<1>
1157 B<Mod2> B<2>
1158 B<Mod3> B<3>
1159 B<Mod4> B<4>
1160 B<Mod5> B<5>
1161
1162=end table
1070 1163
1071The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1164The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1072whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1165whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1073keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1166keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1074current application keymap mode state. 1167current application keymap mode state.
1097prefixed with C<string:>). 1190prefixed with C<string:>).
1098 1191
1099The following action prefixes are known - extensions can provide 1192The following action prefixes are known - extensions can provide
1100additional prefixes: 1193additional prefixes:
1101 1194
1102=over 4 1195=over
1103 1196
1104=item string:STRING 1197=item string:STRING
1105 1198
1106If the I<action> starts with C<string:> (or otherwise contains no colons), 1199If the I<action> starts with C<string:> (or otherwise contains no colons),
1107then the remaining C<STRING> will be passed to the program running in the 1200then the remaining C<STRING> will be passed to the program running in the
1109string C<echo rm -rf /> followed by a newline: 1202string C<echo rm -rf /> followed by a newline:
1110 1203
1111 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1204 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1112 1205
1113This could in theory be used to completely redefine your keymap. 1206This could in theory be used to completely redefine your keymap.
1207
1208In addition, for actions of this type, you can define a range of
1209keysyms in one shot by loading the C<keysym-list> perl extension and
1210providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1211the delimiter `/' should be a character not used by the strings.
1212
1213Its usage can be demonstrated by an example:
1214
1215 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1216
1217The above line is equivalent to the following three lines:
1218
1219 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1220 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1221 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1114 1222
1115=item command:STRING 1223=item command:STRING
1116 1224
1117If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1225If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1118is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1226is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1178 1286
1179Similarly, to let applications gain access to the C<C-M-c> (copy to 1287Similarly, to let applications gain access to the C<C-M-c> (copy to
1180clipboard) and C<C-M-v> (paste clipboard) key combination, you can do 1288clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181this: 1289this:
1182 1290
1183 URxvt.keysym.C-S-c: builtin-string: 1291 URxvt.keysym.C-M-c: builtin-string:
1184 URxvt.keysym.C-S-v: builtin-string: 1292 URxvt.keysym.C-M-v: builtin-string:
1185 1293
1186=item EXTENSION:STRING 1294=item EXTENSION:STRING
1187 1295
1188An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1296An action of this form invokes the action B<STRING>, if any, provided
1189extension of the same name. The extension will be loaded automatically if 1297by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1190necessary. 1298be loaded automatically if necessary.
1191 1299
1192Not all extensions define key actions, but popular extensions that do 1300Not all extensions define actions, but popular extensions that do
1193include the I<selection> and I<matcher> extensions (documented in their 1301include the I<selection> and I<matcher> extensions (documented in their
1194own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1302own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195respectively). 1303respectively).
1196 1304
1197From the silly examples department, this will rot13-"encrypt" 1305From the silly examples department, this will rot13-"encrypt"
1200 1308
1201 URxvt.keysym.M-C-c: selection:rot13 1309 URxvt.keysym.M-C-c: selection:rot13
1202 1310
1203=item perl:STRING *DEPRECATED* 1311=item perl:STRING *DEPRECATED*
1204 1312
1205This is a deprecated way of passing key mappings to perl extensions. It is 1313This is a deprecated way of invoking commands provided by perl
1206still supported, but should not be used anymore. 1314extensions. It is still supported, but should not be used anymore.
1207 1315
1208=back 1316=back
1209 1317
1210=item B<perl-ext-common>: I<string> 1318=item B<perl-ext-common>: I<string>
1211 1319
1212=item B<perl-ext>: I<string> 1320=item B<perl-ext>: I<string>
1213 1321
1214Comma-separated list(s) of perl extension scripts (default: C<default>) to 1322Comma-separated list(s) of perl extension scripts (default: C<default>) to
1215use in this terminal instance; option B<-pe>. 1323use in this terminal instance; option B<-pe>.
1216 1324
1217Extension names can be prefixed with a C<-> sign to prohibit using 1325Extension names can be prefixed with a C<-> sign to remove them again, in
1218them. This can be useful to selectively disable some extensions loaded 1326case they had been specified earlier. This can be useful to selectively
1219by default, or specified via the C<perl-ext-common> resource. For 1327disable some extensions loaded by default, or specified via the
1220example, C<default,-selection> will use all the default extensions except 1328C<perl-ext-common> resource. For example, C<default,-selection> will use
1221C<selection>. 1329all the default extensions except C<selection>.
1330
1331To prohibit autoloading of extensions, you can prefix them with C</>,
1332which will make urxvt refuse to automatically load them (this can be
1333overridden, however, by specifying the extension name again without a
1334prefix, though). This does not prohibit extensions themselves loading
1335other extensions. For example, C<default,/background> will keep the
1336C<background> extension from being loaded when a background OSC sequence
1337is received.
1222 1338
1223The default set includes the C<selection>, C<option-popup>, 1339The default set includes the C<selection>, C<option-popup>,
1224C<selection-popup> and C<readline> extensions, any extensions that define 1340C<selection-popup>, C<readline>, C<searchable-scrollback> and
1225keybindings via C<BINDING> meta comments, extensions loaded because 1341C<confirm-paste> extensions, as well as any extensions which are mentioned
1226their resources/commandline switches were used, and extensions which are
1227mentioned in B<keysym> resources. 1342in B<keysym> resources.
1343
1344Any extension such that a corresponding resource is given on the
1345command line is automatically appended to B<perl-ext>.
1228 1346
1229Each extension is looked up in the library directories, loaded if 1347Each extension is looked up in the library directories, loaded if
1230necessary, and bound to the current terminal instance. When the library 1348necessary, and bound to the current terminal instance. When the library
1231search path contains multiple extension files of the same name, then the 1349search path contains multiple extension files of the same name, then the
1232first one found will be used. 1350first one found will be used.
1286Turn on/off ISO 14755 (default enabled). 1404Turn on/off ISO 14755 (default enabled).
1287 1405
1288=item B<iso14755_52:> I<boolean> 1406=item B<iso14755_52:> I<boolean>
1289 1407
1290Turn on/off ISO 14755 5.2 mode (default enabled). 1408Turn on/off ISO 14755 5.2 mode (default enabled).
1291
1292=back
1293
1294=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1295
1296=over 4
1297
1298=item B<-pixmap> I<file[;oplist]>
1299
1300=item B<backgroundPixmap:> I<file[;oplist]>
1301
1302Compile I<pixbuf>: Use the specified image file as the window's
1303background and also optionally specify a colon separated list of
1304operations to modify it. Note that you may need to quote the C<;>
1305character when using the command line option, as C<;> is usually a
1306metacharacter in shells. Supported operations are:
1307
1308=over 4
1309
1310=item B<WxH+X+Y>
1311
1312sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1313scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1314scale of 0 disables scaling.
1315
1316=item B<op=tile>
1317
1318enables tiling
1319
1320=item B<op=keep-aspect>
1321
1322maintain the image aspect ratio when scaling
1323
1324=item B<op=root-align>
1325
1326use the position of the terminal window relative to the root window as
1327the image offset, simulating a root window background
1328
1329=back
1330
1331The default scale and position setting is C<100x100+50+50>.
1332Alternatively, a predefined set of templates can be used to achieve
1333the most common setups:
1334
1335=over 4
1336
1337=item B<style=tiled>
1338
1339the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1340
1341=item B<style=aspect-stretched>
1342
1343the image is scaled to fill the whole window maintaining the aspect
1344ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1345
1346=item B<style=stretched>
1347
1348the image is scaled to fill the whole window. Equivalent to 100x100
1349
1350=item B<style=centered>
1351
1352the image is centered with no scaling. Equivalent to 0x0+50+50
1353
1354=item B<style=root-tiled>
1355
1356the image is tiled with no scaling and using 'root' positioning.
1357Equivalent to 0x0:op=tile:op=root-align
1358
1359=back
1360
1361If multiple templates are specified the last one wins. Note that a
1362template overrides all the scale, position and operations settings.
1363
1364If used in conjunction with pseudo-transparency, the specified pixmap
1365will be blended over the transparent background using alpha-blending.
1366
1367=item B<-tr>|B<+tr>
1368
1369=item B<transparent:> I<boolean>
1370
1371Turn on/off pseudo-transparency by using the root pixmap as background.
1372
1373B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1374will be removed in future versions.
1375
1376=item B<-tint> I<colour>
1377
1378=item B<tintColor:> I<colour>
1379
1380Tint the transparent background with the given colour. Note that a
1381black tint yields a completely black image while a white tint yields
1382the image unchanged.
1383
1384=item B<-sh> I<number>
1385
1386=item B<shading:> I<number>
1387
1388Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1389A value of 100 means no shading.
1390
1391=item B<-blr> I<HxV>
1392
1393=item B<blurRadius:> I<HxV>
1394
1395Apply gaussian blur with the specified radius to the transparent
1396background. If a single number is specified, the vertical and
1397horizontal radii are considered to be the same. Setting one of the
1398radii to 1 and the other to a large number creates interesting effects
1399on some backgrounds. The maximum radius value is 128. An horizontal or
1400vertical radius of 0 disables blurring.
1401
1402=item B<path:> I<path>
1403
1404Specify the colon-delimited search path for finding background image files.
1405 1409
1406=back 1410=back
1407 1411
1408=head1 THE SCROLLBAR 1412=head1 THE SCROLLBAR
1409 1413
1433=head1 THE SELECTION: SELECTING AND PASTING TEXT 1437=head1 THE SELECTION: SELECTING AND PASTING TEXT
1434 1438
1435The behaviour of text selection and insertion/pasting mechanism is similar 1439The behaviour of text selection and insertion/pasting mechanism is similar
1436to I<xterm>(1). 1440to I<xterm>(1).
1437 1441
1438=over 4 1442=over
1439 1443
1440=item B<Selecting>: 1444=item B<Selecting>:
1441 1445
1442Left click at the beginning of the region, drag to the end of the region 1446Left click at the beginning of the region, drag to the end of the region
1443and release; Right click to extend the marked region; Left double-click 1447and release; Right click to extend the marked region; Left double-click
1490and character codes using the keyboard. It consists of 4 parts. The 1494and character codes using the keyboard. It consists of 4 parts. The
1491first part is available if rxvt-unicode has been compiled with 1495first part is available if rxvt-unicode has been compiled with
1492C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1496C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1493with C<--enable-iso14755>. 1497with C<--enable-iso14755>.
1494 1498
1495=over 4 1499=over
1496 1500
1497=item * 5.1: Basic method 1501=item * 5.1: Basic method
1498 1502
1499This allows you to enter unicode characters using their hexcode. 1503This allows you to enter unicode characters using their hexcode.
1500 1504
1561In addition to the default foreground and background colours, 1565In addition to the default foreground and background colours,
1562B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1566B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1563high-intensity (potentially bold/blink) versions of the same, and 72 (or 1567high-intensity (potentially bold/blink) versions of the same, and 72 (or
1564240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1568240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1565cube plus a 8 (24) colour greyscale ramp. 1569cube plus a 8 (24) colour greyscale ramp.
1570
1571B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1572C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1573number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1574colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
157524-bit colour space. When indexing collisions happen, the nearest old colour in
1576the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1577use many similar 24-bit colours. It's typically not a problem in common
1578scenarios.
1566 1579
1567Here is a list of the ANSI colours with their names. 1580Here is a list of the ANSI colours with their names.
1568 1581
1569=begin table 1582=begin table
1570 1583
1671 1684
1672=head1 ENVIRONMENT 1685=head1 ENVIRONMENT
1673 1686
1674B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1687B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1675 1688
1676=over 4 1689=over
1677 1690
1678=item B<TERM> 1691=item B<TERM>
1679 1692
1680Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1693Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1681resources or on the command line. 1694resources or on the command line.
1752 1765
1753=back 1766=back
1754 1767
1755=head1 FILES 1768=head1 FILES
1756 1769
1757=over 4 1770=over
1758 1771
1759=item B</usr/lib/X11/rgb.txt> 1772=item B</usr/lib/X11/rgb.txt>
1760 1773
1761Colour names. 1774Colour names.
1762 1775
1767@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), 1780@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1768@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1781@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1769 1782
1770=head1 CURRENT PROJECT COORDINATOR 1783=head1 CURRENT PROJECT COORDINATOR
1771 1784
1772=over 4 1785=over
1773 1786
1774=item Project Coordinator 1787=item Project Coordinator
1775 1788
1776Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1789Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1777 1790
1779 1792
1780=back 1793=back
1781 1794
1782=head1 AUTHORS 1795=head1 AUTHORS
1783 1796
1784=over 4 1797=over
1785 1798
1786=item John Bovey 1799=item John Bovey
1787 1800
1788University of Kent, 1992, wrote the original Xvt. 1801University of Kent, 1992, wrote the original Xvt.
1789 1802

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines