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.233 by sf-exg, Sat May 24 18:41:29 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
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>.
223 229
230=item B<-mc> I<milliseconds>
231
232Specify the maximum time between multi-click selections.
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>.
228 238
306 316
307=item B<-override-redirect> 317=item B<-override-redirect>
308 318
309Compile I<frills>: Sets override-redirect on the window; resource 319Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>. 320B<override-redirect>.
321
322=item B<-dockapp>
323
324Sets the initial state of the window to WithdrawnState, which makes
325window managers that support this extension treat it as a dockapp.
311 326
312=item B<-sbg> 327=item B<-sbg>
313 328
314Compile I<frills>: Disable the usage of the built-in block graphics/line 329Compile I<frills>: Disable the usage of the built-in block graphics/line
315drawing characters and just rely on what the specified fonts provide. Use 330drawing characters and just rely on what the specified fonts provide. Use
370=item B<-pt> I<style> 385=item B<-pt> I<style>
371 386
372Compile I<XIM>: input style for input method; B<OverTheSpot>, 387Compile I<XIM>: input style for input method; B<OverTheSpot>,
373B<OffTheSpot>, B<Root>; resource B<preeditType>. 388B<OffTheSpot>, B<Root>; resource B<preeditType>.
374 389
390If the perl extension C<xim-onthespot> is used (which is the default),
391then additionally the C<OnTheSpot> preedit type is available.
392
375=item B<-im> I<text> 393=item B<-im> I<text>
376 394
377Compile I<XIM>: input method name. resource B<inputMethod>. 395Compile I<XIM>: input method name. resource B<inputMethod>.
378 396
379=item B<-imlocale> I<string> 397=item B<-imlocale> I<string>
393Change the meaning of triple-click selection with the left mouse 411Change the meaning of triple-click selection with the left mouse
394button. Only effective when the original (non-perl) selection code is 412button. Only effective when the original (non-perl) selection code is
395in-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
396the end of the logical line only. resource B<tripleclickwords>. 414the end of the logical line only. resource B<tripleclickwords>.
397 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
398=item B<-insecure> 426=item B<-insecure>
399 427
400Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
401sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
402info. 430info.
414 442
415=item B<-ssr>|B<+ssr> 443=item B<-ssr>|B<+ssr>
416 444
417Turn on/off secondary screen scroll (default enabled); resource 445Turn on/off secondary screen scroll (default enabled); resource
418B<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>.
419 455
420=item B<-hold>|B<+hold> 456=item B<-hold>|B<+hold>
421 457
422Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 458Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
423will not immediately destroy its window when the program executed within 459will not immediately destroy its window when the program executed within
501 close $pty; 537 close $pty;
502 538
503 # now communicate with rxvt 539 # now communicate with rxvt
504 my $slave = $pty->slave; 540 my $slave = $pty->slave;
505 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";
506 559
507=item B<-pe> I<string> 560=item B<-pe> I<string>
508 561
509Comma-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
510this terminal instance. See resource B<perl-ext> for details. 563this terminal instance. See resource B<perl-ext> for details.
538be used. Command-line arguments can be used to override resource 591be used. Command-line arguments can be used to override resource
539settings. The following resources are supported (you might want to 592settings. The following resources are supported (you might want to
540check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 593check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
541extensions not documented here): 594extensions not documented here):
542 595
543=over 4 596=over
544 597
545=item B<depth:> I<bitdepth> 598=item B<depth:> I<bitdepth>
546 599
547Compile 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;
548option B<-depth>. 601option B<-depth>.
649 702
650B<False>: specify that everything is to be displayed, even 703B<False>: specify that everything is to be displayed, even
651if 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
652monitor to display anything); option B<+ss>. 705monitor to display anything); option B<+ss>.
653 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
654=item B<fading:> I<number> 718=item B<fading:> I<number>
655 719
656Fade 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>.
657 721
658=item B<fadeColor:> I<colour> 722=item B<fadeColor:> I<colour>
781 845
782B<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
783the 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
784[default]; option B<+ls>. 848[default]; option B<+ls>.
785 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
786=item B<utmpInhibit:> I<boolean> 855=item B<utmpInhibit:> I<boolean>
787 856
788B<True>: inhibit writing record into the system log file B<utmp>; 857B<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> 858option B<-ut>. B<False>: write record into the system log file B<utmp>
790[default]; option B<+ut>. 859[default]; option B<+ut>.
853are 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
854bottom when a non-special key is pressed; option B<+sk>. 923bottom when a non-special key is pressed; option B<+sk>.
855 924
856=item B<saveLines:> I<number> 925=item B<saveLines:> I<number>
857 926
858Save I<number> lines in the scrollback buffer [default 64]. This 927Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
859resource is limited on most machines to 65535; option B<-sl>.
860 928
861=item B<internalBorder:> I<number> 929=item B<internalBorder:> I<number>
862 930
863Internal border of I<number> pixels. This resource is limited to 100; 931Internal border of I<number> pixels. This resource is limited to 100;
864option B<-b>. 932option B<-b>.
927 995
928=item B<pointerColor2:> I<colour> 996=item B<pointerColor2:> I<colour>
929 997
930Mouse pointer background colour. 998Mouse pointer background colour.
931 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
932=item B<pointerBlankDelay:> I<number> 1006=item B<pointerBlankDelay:> I<number>
933 1007
934Specifies number of seconds before blanking the pointer [default 2]. Use a 1008Specifies number of seconds before blanking the pointer [default 2]. Use a
935large number (e.g. C<987654321>) to effectively disable the timeout. 1009large number (e.g. C<987654321>) to effectively disable the timeout.
936 1010
962 1036
963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1037B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
964 1038
965=item B<preeditType:> I<style> 1039=item B<preeditType:> I<style>
966 1040
967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1041B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968 1042
969=item B<inputMethod:> I<name> 1043=item B<inputMethod:> I<name>
970 1044
971I<name> of inputMethod to use; option B<-im>. 1045I<name> of inputMethod to use; option B<-im>.
972 1046
990 1064
991Change the meaning of triple-click selection with the left mouse 1065Change the meaning of triple-click selection with the left mouse
992button. 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
993the end of the logical line only; option B<-tcw>. 1067the end of the logical line only; option B<-tcw>.
994 1068
1069=item B<disablePasteBrackets:> I<boolean>
1070
1071Prevent emission of paste bracket sequences; option B<-dpb>.
1072
995=item B<insecure:> I<boolean> 1073=item B<insecure:> I<boolean>
996 1074
997Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1075Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
998echo 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
999abused if somebody gets 8-bit-clean access to your display, whether 1077abused if somebody gets 8-bit-clean access to your display, whether
1000through a mail client displaying mail bodies unfiltered or through 1078through a mail client displaying mail bodies unfiltered or through
1001write(1) or any other means. Therefore, these sequences are disabled by 1079write(1) or any other means. Therefore, these sequences are disabled by
1002default. (Note that many other terminals, including xterm, have these 1080default. (Note that many other terminals, including xterm, have these
1020 1098
1021=item B<secondaryScreen:> I<boolean> 1099=item B<secondaryScreen:> I<boolean>
1022 1100
1023Turn on/off secondary screen (default enabled). 1101Turn on/off secondary screen (default enabled).
1024 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
1025=item B<secondaryScroll:> I<boolean> 1108=item B<secondaryScroll:> I<boolean>
1026 1109
1027Turn on/off secondary screen scroll (default enabled). If this 1110Turn on/off secondary screen scroll (default enabled). If this
1028option is enabled, scrolls on the secondary screen will change the 1111option is enabled, scrolls on the secondary screen will change the
1029scrollback buffer and, when secondaryScreen is off, switching 1112scrollback buffer and, when secondaryScreen is off, switching
1056 1139
1057The 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:
1058 1141
1059 (modifiers-)key 1142 (modifiers-)key
1060 1143
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1144Where 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>, 1145abbreviated modifier names:
1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1146
1064B<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
1065 1163
1066The 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
1067whatever 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
1068keys 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
1069current application keymap mode state. 1167current application keymap mode state.
1092prefixed with C<string:>). 1190prefixed with C<string:>).
1093 1191
1094The following action prefixes are known - extensions can provide 1192The following action prefixes are known - extensions can provide
1095additional prefixes: 1193additional prefixes:
1096 1194
1097=over 4 1195=over
1098 1196
1099=item string:STRING 1197=item string:STRING
1100 1198
1101If 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),
1102then 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
1104string C<echo rm -rf /> followed by a newline: 1202string C<echo rm -rf /> followed by a newline:
1105 1203
1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1204 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107 1205
1108This 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>
1109 1222
1110=item command:STRING 1223=item command:STRING
1111 1224
1112If 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>
1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1226is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1173 1286
1174Similarly, 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
1175clipboard) 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
1176this: 1289this:
1177 1290
1178 URxvt.keysym.C-S-c: builtin-string: 1291 URxvt.keysym.C-M-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string: 1292 URxvt.keysym.C-M-v: builtin-string:
1180 1293
1181=item EXTENSION:STRING 1294=item EXTENSION:STRING
1182 1295
1183An 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
1184extension of the same name. The extension will be loaded automatically if 1297by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1185neccessary. 1298be loaded automatically if necessary.
1186 1299
1187Not all extensions define key actions, but popular extensions that do 1300Not all extensions define actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their 1301include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1302own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively). 1303respectively).
1191 1304
1192From the silly examples department, this will rot13-"encrypt" 1305From the silly examples department, this will rot13-"encrypt"
1195 1308
1196 URxvt.keysym.M-C-c: selection:rot13 1309 URxvt.keysym.M-C-c: selection:rot13
1197 1310
1198=item perl:STRING *DEPRECATED* 1311=item perl:STRING *DEPRECATED*
1199 1312
1200This is a deprecated way of passing key mappings to perl extensions. It is 1313This is a deprecated way of invoking commands provided by perl
1201still supported, but should not be used anymore. 1314extensions. It is still supported, but should not be used anymore.
1202 1315
1203=back 1316=back
1204 1317
1205=item B<perl-ext-common>: I<string> 1318=item B<perl-ext-common>: I<string>
1206 1319
1207=item B<perl-ext>: I<string> 1320=item B<perl-ext>: I<string>
1208 1321
1209Comma-separated list(s) of perl extension scripts (default: C<default>) to 1322Comma-separated list(s) of perl extension scripts (default: C<default>) to
1210use in this terminal instance; option B<-pe>. 1323use in this terminal instance; option B<-pe>.
1211 1324
1212Extension 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
1213them. This can be useful to selectively disable some extensions loaded 1326case they had been specified earlier. This can be useful to selectively
1214by default, or specified via the C<perl-ext-common> resource. For 1327disable some extensions loaded by default, or specified via the
1215example, C<default,-selection> will use all the default extensions except 1328C<perl-ext-common> resource. For example, C<default,-selection> will use
1216C<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.
1217 1338
1218The default set includes the C<selection>, C<option-popup>, 1339The default set includes the C<selection>, C<option-popup>,
1219C<selection-popup> and C<readline> extensions, any extensions that define 1340C<selection-popup>, C<readline>, C<searchable-scrollback> and
1220keybindings via C<BINDING> meta comments, extensions loaded because 1341C<confirm-paste> extensions, as well as any extensions which are mentioned
1221their resources/commandline switches were used, and extensions which are
1222mentioned 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>.
1223 1346
1224Each extension is looked up in the library directories, loaded if 1347Each extension is looked up in the library directories, loaded if
1225necessary, and bound to the current terminal instance. When the library 1348necessary, and bound to the current terminal instance. When the library
1226search path contains multiple extension files of the same name, then the 1349search path contains multiple extension files of the same name, then the
1227first one found will be used. 1350first one found will be used.
1281Turn on/off ISO 14755 (default enabled). 1404Turn on/off ISO 14755 (default enabled).
1282 1405
1283=item B<iso14755_52:> I<boolean> 1406=item B<iso14755_52:> I<boolean>
1284 1407
1285Turn on/off ISO 14755 5.2 mode (default enabled). 1408Turn on/off ISO 14755 5.2 mode (default enabled).
1286
1287=back
1288
1289=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1290
1291=over 4
1292
1293=item B<-pixmap> I<file[;oplist]>
1294
1295=item B<backgroundPixmap:> I<file[;oplist]>
1296
1297Compile I<pixbuf>: Use the specified image file as the window's
1298background and also optionally specify a colon separated list of
1299operations to modify it. Note that you may need to quote the C<;>
1300character when using the command line option, as C<;> is usually a
1301metacharacter in shells. Supported operations are:
1302
1303=over 4
1304
1305=item B<WxH+X+Y>
1306
1307sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1308scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1309scale of 0 disables scaling.
1310
1311=item B<op=tile>
1312
1313enables tiling
1314
1315=item B<op=keep-aspect>
1316
1317maintain the image aspect ratio when scaling
1318
1319=item B<op=root-align>
1320
1321use the position of the terminal window relative to the root window as
1322the image offset, simulating a root window background
1323
1324=back
1325
1326The default scale and position setting is C<100x100+50+50>.
1327Alternatively, a predefined set of templates can be used to achieve
1328the most common setups:
1329
1330=over 4
1331
1332=item B<style=tiled>
1333
1334the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1335
1336=item B<style=aspect-stretched>
1337
1338the image is scaled to fill the whole window maintaining the aspect
1339ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1340
1341=item B<style=stretched>
1342
1343the image is scaled to fill the whole window. Equivalent to 100x100
1344
1345=item B<style=centered>
1346
1347the image is centered with no scaling. Equivalent to 0x0+50+50
1348
1349=item B<style=root-tiled>
1350
1351the image is tiled with no scaling and using 'root' positioning.
1352Equivalent to 0x0:op=tile:op=root-align
1353
1354=back
1355
1356If multiple templates are specified the last one wins. Note that a
1357template overrides all the scale, position and operations settings.
1358
1359If used in conjunction with pseudo-transparency, the specified pixmap
1360will be blended over the transparent background using alpha-blending.
1361
1362=item B<-tr>|B<+tr>
1363
1364=item B<transparent:> I<boolean>
1365
1366Turn on/off pseudo-transparency by using the root pixmap as background.
1367
1368B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1369will be removed in future versions.
1370
1371=item B<-tint> I<colour>
1372
1373=item B<tintColor:> I<colour>
1374
1375Tint the transparent background with the given colour. Note that a
1376black tint yields a completely black image while a white tint yields
1377the image unchanged.
1378
1379=item B<-sh> I<number>
1380
1381=item B<shading:> I<number>
1382
1383Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1384A value of 100 means no shading.
1385
1386=item B<-blr> I<HxV>
1387
1388=item B<blurRadius:> I<HxV>
1389
1390Apply gaussian blur with the specified radius to the transparent
1391background. If a single number is specified, the vertical and
1392horizontal radii are considered to be the same. Setting one of the
1393radii to 1 and the other to a large number creates interesting effects
1394on some backgrounds. The maximum radius value is 128. An horizontal or
1395vertical radius of 0 disables blurring.
1396
1397=item B<path:> I<path>
1398
1399Specify the colon-delimited search path for finding background image files.
1400 1409
1401=back 1410=back
1402 1411
1403=head1 THE SCROLLBAR 1412=head1 THE SCROLLBAR
1404 1413
1428=head1 THE SELECTION: SELECTING AND PASTING TEXT 1437=head1 THE SELECTION: SELECTING AND PASTING TEXT
1429 1438
1430The behaviour of text selection and insertion/pasting mechanism is similar 1439The behaviour of text selection and insertion/pasting mechanism is similar
1431to I<xterm>(1). 1440to I<xterm>(1).
1432 1441
1433=over 4 1442=over
1434 1443
1435=item B<Selecting>: 1444=item B<Selecting>:
1436 1445
1437Left 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
1438and release; Right click to extend the marked region; Left double-click 1447and release; Right click to extend the marked region; Left double-click
1485and character codes using the keyboard. It consists of 4 parts. The 1494and character codes using the keyboard. It consists of 4 parts. The
1486first part is available if rxvt-unicode has been compiled with 1495first part is available if rxvt-unicode has been compiled with
1487C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1496C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1488with C<--enable-iso14755>. 1497with C<--enable-iso14755>.
1489 1498
1490=over 4 1499=over
1491 1500
1492=item * 5.1: Basic method 1501=item * 5.1: Basic method
1493 1502
1494This allows you to enter unicode characters using their hexcode. 1503This allows you to enter unicode characters using their hexcode.
1495 1504
1556In addition to the default foreground and background colours, 1565In addition to the default foreground and background colours,
1557B<@@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
1558high-intensity (potentially bold/blink) versions of the same, and 72 (or 1567high-intensity (potentially bold/blink) versions of the same, and 72 (or
1559240 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
1560cube 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.
1561 1579
1562Here is a list of the ANSI colours with their names. 1580Here is a list of the ANSI colours with their names.
1563 1581
1564=begin table 1582=begin table
1565 1583
1666 1684
1667=head1 ENVIRONMENT 1685=head1 ENVIRONMENT
1668 1686
1669B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1687B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1670 1688
1671=over 4 1689=over
1672 1690
1673=item B<TERM> 1691=item B<TERM>
1674 1692
1675Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1693Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1676resources or on the command line. 1694resources or on the command line.
1747 1765
1748=back 1766=back
1749 1767
1750=head1 FILES 1768=head1 FILES
1751 1769
1752=over 4 1770=over
1753 1771
1754=item B</usr/lib/X11/rgb.txt> 1772=item B</usr/lib/X11/rgb.txt>
1755 1773
1756Colour names. 1774Colour names.
1757 1775
1762@@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),
1763@@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)
1764 1782
1765=head1 CURRENT PROJECT COORDINATOR 1783=head1 CURRENT PROJECT COORDINATOR
1766 1784
1767=over 4 1785=over
1768 1786
1769=item Project Coordinator 1787=item Project Coordinator
1770 1788
1771Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1789Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1772 1790
1774 1792
1775=back 1793=back
1776 1794
1777=head1 AUTHORS 1795=head1 AUTHORS
1778 1796
1779=over 4 1797=over
1780 1798
1781=item John Bovey 1799=item John Bovey
1782 1800
1783University of Kent, 1992, wrote the original Xvt. 1801University of Kent, 1992, wrote the original Xvt.
1784 1802

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines