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.121 by root, Sun Aug 20 02:47:26 2006 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very user friendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>. 104resource B<depth>.
102 105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
103=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
104 112
105Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
106 114
107=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
108 116
109Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
110 118
111=item B<-j>|B<+j> 119=item B<-j>|B<+j>
112 120
113Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 122
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
116 124
117Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119 126
120I<Please note that transparency of any kind if completely unsupported by 127=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions! Read the FAQ (man 7 128
122@@RXVT_NAME@@)!> 129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123 136
124=item B<-fade> I<number> 137=item B<-fade> I<number>
125 138
126Fade the text by the given percentage when focus is lost. Small values 139Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
133is opaque black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
134 147
135=item B<-tint> I<colour> 148=item B<-tint> I<colour>
136 149
137Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
140used to brighten or darken the image in addition to tinting it; resource 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
141I<tintColor>. Example: 158I<tintColor>. Example:
142 159
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 161
145=item B<-sh> 162=item B<-sh> I<number>
146 163
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>). 166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
150 186
151=item B<-bg> I<colour> 187=item B<-bg> I<colour>
152 188
153Window background colour; resource B<background>. 189Window background colour; resource B<background>.
154 190
155=item B<-fg> I<colour> 191=item B<-fg> I<colour>
156 192
157Window foreground colour; resource B<foreground>. 193Window foreground colour; resource B<foreground>.
158 194
159=item B<-pixmap> I<file[;geom]> 195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160 196
161Compile I<XPM>: Specify XPM file for the background and also optionally 197Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 198optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 199add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 200command-line; for more details see resource B<backgroundPixmap>.
165 201
166=item B<-cr> I<colour> 202=item B<-cr> I<colour>
167 203
168The cursor colour; resource B<cursorColor>. 204The cursor colour; resource B<cursorColor>.
169 205
214italic> >> characters are to be printed. See resource B<boldItalicFont> 250italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details. 251for details.
216 252
217=item B<-is>|B<+is> 253=item B<-is>|B<+is>
218 254
219Compile I<font-styles>: Bold/Italic font styles imply high intensity 255Compile I<font-styles>: Bold/Blink font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for 256foreground/background (default). See resource B<intensityStyles> for
221details. 257details.
222 258
223=item B<-name> I<name> 259=item B<-name> I<name>
224 260
242 278
243=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
244 280
245Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
246 282
283=item B<-sr>|B<+sr>
284
285Put scrollbar on right/left; resource B<scrollBar_right>.
286
287=item B<-st>|B<+st>
288
289Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
290resource B<scrollBar_floating>.
291
247=item B<-si>|B<+si> 292=item B<-si>|B<+si>
248 293
249Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
250B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
251 296
257=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
258 303
259Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
260This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
261B<scrollWithBuffer>. 306B<scrollWithBuffer>.
262
263=item B<-sr>|B<+sr>
264
265Put scrollbar on right/left; resource B<scrollBar_right>.
266
267=item B<-st>|B<+st>
268
269Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270resource B<scrollBar_floating>.
271 307
272=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
273 309
274If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
275actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
322 358
323=item B<-lsp> I<number> 359=item B<-lsp> I<number>
324 360
325Compile I<frills>: Lines (pixel height) to insert between each row of 361Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 362the display. Useful to work around font rendering problems; resource
327B<linespace>. 363B<lineSpace>.
328 364
329=item B<-tn> I<termname> 365=item B<-tn> I<termname>
330 366
331This option specifies the name of the terminal type to be set in the 367This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 368B<TERM> environment variable. This terminal type must exist in the
386for more info. 422for more info.
387 423
388=item B<-tcw> 424=item B<-tcw>
389 425
390Change the meaning of triple-click selection with the left mouse 426Change the meaning of triple-click selection with the left mouse
427button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 428in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 429the end of the logical line only. resource B<tripleclickwords>.
393 430
394=item B<-insecure> 431=item B<-insecure>
395 432
396Enable "insecure" mode, which currently enables most of the escape 433Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 434sequences that echo strings. See the resource B<insecure> for more
417 454
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 456will not immediately destroy its window when the program executed within
420it exits. Instead, it will wait till it is being killed or closed by the 457it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 458user; resource B<hold>.
459
460=item B<-cd> I<path>
461
462Sets the working directory for the shell (or the command specified via
463B<-e>). The I<path> must be an absolute path and it must exist for
464@@RXVT_NAME@@ to start; resource B<chdir>.
465
466=item B<-xrm> I<string>
467
468Works like the X Toolkit option of the same name, by adding the I<string>
469as if it were specified in a resource file. Resource values specified this
470way take precedence over all other resource specifications.
471
472Note that you need to use the I<same> syntax as in the .Xdefaults file,
473e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
474options can be specified as long-options on the commandline, so use
475of B<-xrm> is mostly limited to cases where you want to specify other
476resources (e.g. for input methods) or for compatibility with other
477programs.
422 478
423=item B<-keysym.>I<sym> I<string> 479=item B<-keysym.>I<sym> I<string>
424 480
425Remap a key symbol. See resource B<keysym>. 481Remap a key symbol. See resource B<keysym>.
426 482
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 517If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462entries and will not tinker with pty/tty permissions - you have to do that 518entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 519yourself if you want that.
464 520
465As an extremely special case, specifying C<-1> will completely suppress 521As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 522pty/tty operations, which is probably only useful in conjunction with some
523perl extension that manages the terminal.
467 524
468Here is a example in perl that illustrates how this option can be used (a 525Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 526longer example is in F<doc/pty-fd>):
470 527
471 use IO::Pty; 528 use IO::Pty;
485Comma-separated list of perl extension scripts to use (or not to use) in 542Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 543this terminal instance. See resource B<perl-ext> for details.
487 544
488=back 545=back
489 546
490=head1 RESOURCES (available also as long-options) 547=head1 RESOURCES
491 548
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 549Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 550options) compiled into your version. All resources are also available as
551long-options.
494 552
495You can set and change the resources using X11 tools like B<xrdb>. Many 553You can set and change the resources using X11 tools like B<xrdb>. Many
496distribution do also load settings from the B<~/.Xresources> file when X 554distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 555starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 556with later settings overwriting earlier ones:
500 1. system-wide app-defaults file, either locale-dependent OR global 558 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 559 2. app-defaults file in $XAPPLRESDIR
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 560 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503 4. SCREEN_RESOURCES for the current screen 561 4. SCREEN_RESOURCES for the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 562 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
563 6. resources specified via -xrm on the commandline
505 564
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 565Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 566names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 567common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 568configured, while the class name B<URxvt> allows resources unique to
519=item B<depth:> I<bitdepth> 578=item B<depth:> I<bitdepth>
520 579
521Compile I<xft>: Attempt to find a visual with the given bit depth; 580Compile I<xft>: Attempt to find a visual with the given bit depth;
522option B<-depth>. 581option B<-depth>.
523 582
583=item B<buffered:> I<boolean>
584
585Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
586On some card/driver combination enabling it slightly decreases
587performance, on most it greatly helps it. The slowdown is small, so it
588should normally be enabled.
589
524=item B<geometry:> I<geom> 590=item B<geometry:> I<geom>
525 591
526Create the window with the specified X window geometry [default 80x24]; 592Create the window with the specified X window geometry [default 80x24];
527option B<-geometry>. 593option B<-geometry>.
528 594
564Use the specified colour to display underlined characters when the 630Use the specified colour to display underlined characters when the
565foreground colour is the default. 631foreground colour is the default.
566 632
567=item B<colorRV:> I<colour> 633=item B<colorRV:> I<colour>
568 634
569Use the specified colour as the background for reverse video 635Use the specified colour as the background for reverse video characters
570characters. 636when OPTION_HC is disabled (--disable-frills).
571 637
572=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
573 639
574If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
591option B<-rv>. B<False>: regular screen colours [default]; option 657option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 658B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 659
594=item B<jumpScroll:> I<boolean> 660=item B<jumpScroll:> I<boolean>
595 661
596B<True>: specify that jump scrolling should be used. When scrolling 662B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 663of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
664has been read, resulting in fewer updates while still displaying every
665received line; option B<-j>.
666
598B<False>: specify that smooth scrolling should be used; option B<+j>. 667B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
668force a screen refresh on each new line it received; option B<+j>.
599 669
600=item B<inheritPixmap:> I<boolean> 670=item B<skipScroll:> I<boolean>
601 671
602B<True>: make the background inherit the parent windows' pixmap, giving 672B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 673receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 674(around 60 times per second), resulting in far fewer updates. This can
675result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
676option B<-ss>.
605 677
606I<Please note that transparency of any kind if completely unsupported by 678B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 679if the refresh is too fast for the human eye to read anything (or the
680monitor to display anything); option B<+ss>.
681
682=item B<transparent:> I<boolean>
683
684Turn on/off illusion of a transparent window background.
685
686B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
687future versions.
688
689I<Please address all transparency related issues to Sasha Vasko at
690sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
608 691
609=item B<fading:> I<number> 692=item B<fading:> I<number>
610 693
611Fade the text by the given percentage when focus is lost; option B<-fade>. 694Fade the text by the given percentage when focus is lost; option B<-fade>.
612 695
620Tint the transparent background pixmap with the given colour; option 703Tint the transparent background pixmap with the given colour; option
621B<-tint>. 704B<-tint>.
622 705
623=item B<shading:> I<number> 706=item B<shading:> I<number>
624 707
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 708Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626image in addition to tinting it. 709in addition to tinting it; option B<-sh>.
710
711=item B<blendType:> I<string>
712
713Specify background blending type; option B<-blt>.
714
715=item B<blurRadius:> I<number>
716
717Apply Gaussian Blurr with the specified radius to the transparent
718background image; option B<-blr>.
627 719
628=item B<scrollColor:> I<colour> 720=item B<scrollColor:> I<colour>
629 721
630Use the specified colour for the scrollbar [default #B2B2B2]. 722Use the specified colour for the scrollbar [default #B2B2B2].
631 723
637=item B<borderColor:> I<colour> 729=item B<borderColor:> I<colour>
638 730
639The colour of the border around the text area and between the scrollbar 731The colour of the border around the text area and between the scrollbar
640and the text. 732and the text.
641 733
642=item B<backgroundPixmap:> I<file[;geom]> 734=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643 735
644Use the specified XPM file (note the `.xpm' extension is optional) for 736Use the specified image file for the background and also
645the background and also optionally specify its scaling with a geometry 737optionally specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 738(default C<0x0+50+50>) in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 739horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale 740centre (percent). A scale of 0 displays the image with tiling. A scale
649of 1 displays the image without any scaling. A scale of 2 to 9 741of 1 displays the image without any scaling. A scale of 2 to 9 specifies
650specifies an integer number of images in that direction. No image will 742an integer number of images in that direction. No image will be magnified
651be magnified beyond 10 times its original size. The maximum permitted 743beyond 10 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 744Additional operations can be specified after colon B<:op1:op2...>.
745Supported operations are:
746
747 tile force background image to be tiled and not scaled. Equivalent to 0x0
748 propscale will scale image keeping proportions
749 auto will scale image to match window size. Equivalent to 100x100
750 hscale will scale image horizontally to the window size
751 vscale will scale image vertically to the window size
752 scale will scale image to match window size
753 root will tile image as if it was a root window background, auto-adjusting
754 whenever terminal window moves
755
756If used in conjunction with B<-tr> option, the specified pixmap will be
757blended over transparency image using either alpha-blending, or any
758other blending type, specified with B<-blt "type"> option.
653 759
654=item B<path:> I<path> 760=item B<path:> I<path>
655 761
656Specify the colon-delimited search path for finding XPM files. 762Specify the colon-delimited search path for finding background image files.
657 763
658=item B<font:> I<fontlist> 764=item B<font:> I<fontlist>
659 765
660Select the fonts to be used. This is a comma separated list of font names 766Select the fonts to be used. This is a comma separated list of font names
661that are checked in order when trying to find glyphs for characters. The 767that are checked in order when trying to find glyphs for characters. The
718text font will being used for the given style. 824text font will being used for the given style.
719 825
720=item B<intensityStyles:> I<boolean> 826=item B<intensityStyles:> I<boolean>
721 827
722When font styles are not enabled, or this option is enabled (B<True>, 828When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 829option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 830intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 831option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 832reachable.
727 833
728=item B<selectstyle:> I<mode>
729
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731xterm style with 2.20 old word selection, or anything else which gives
732xterm style selection.
733
734=item B<scrollstyle:> I<mode>
735
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite.
738
739=item B<title:> I<string> 834=item B<title:> I<string>
740 835
741Set window title string, the default title is the command-line 836Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 837specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 838name; option B<-title>.
751=item B<mapAlert:> I<boolean> 846=item B<mapAlert:> I<boolean>
752 847
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 848B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 849de-iconify (map) on receipt of a bell character [default].
755 850
851=item B<urgentOnBell:> I<boolean>
852
853B<True>: set the urgency hint for the wm on receipt of a bell character.
854B<False>: do not set the urgency hint [default].
855
756=item B<visualBell:> I<boolean> 856=item B<visualBell:> I<boolean>
757 857
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 858B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 859B<False>: no visual bell [default]; option B<+vb>.
760 860
782 882
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 883 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 884
785This creates a new file in your home directory with the screen contents 885This creates a new file in your home directory with the screen contents
786every time you hit C<Print>. 886every time you hit C<Print>.
887
888=item B<scrollstyle:> I<mode>
889
890Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
891the author's favourite.
787 892
788=item B<scrollBar:> I<boolean> 893=item B<scrollBar:> I<boolean>
789 894
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 895B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 896disable the scrollbar; option B<+sb>.
854=item B<termName:> I<termname> 959=item B<termName:> I<termname>
855 960
856Specifies the terminal type name to be set in the B<TERM> environment 961Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 962variable; option B<-tn>.
858 963
859=item B<linespace:> I<number> 964=item B<lineSpace:> I<number>
860 965
861Specifies number of lines (pixel height) to insert between each row of 966Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 967the display [default 0]; option B<-lsp>.
863 968
864=item B<meta8:> I<boolean> 969=item B<meta8:> I<boolean>
916=item B<cutchars:> I<string> 1021=item B<cutchars:> I<string>
917 1022
918The characters used as delimiters for double-click word selection 1023The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 1024(whitespace delimiting is added automatically if resource is given).
920 1025
921When the selection extension is in use (the default if compiled in, see 1026When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1027in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 1028characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 1029will be created). In this mode, characters outside ISO-8859-1 can be used.
925 1030
926When the selection extension is not used, only ISO-8859-1 characters can 1031When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 1032be used. If not specified, the built-in default is used:
928 1033
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1034B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 1035
931=item B<preeditType:> I<style> 1036=item B<preeditType:> I<style>
932 1037
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1038B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 1039
988 1093
989Turn on/off secondary screen (default enabled). 1094Turn on/off secondary screen (default enabled).
990 1095
991=item B<secondaryScroll:> I<boolean> 1096=item B<secondaryScroll:> I<boolean>
992 1097
993Turn on/off secondary screen scroll (default enabled). If the this 1098Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1099option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1100scrollback buffer and, when secondaryScreen is off, switching
996instead scroll the screen up. 1101to/from the secondary screen will instead scroll the screen up.
997 1102
998=item B<hold>: I<boolean> 1103=item B<hold>: I<boolean>
999 1104
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1105Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within 1106will not immediately destroy its window when the program executed within
1002it exits. Instead, it will wait till it is being killed or closed by the 1107it exits. Instead, it will wait till it is being killed or closed by the
1003user. 1108user.
1109
1110=item B<chdir>: I<path>
1111
1112Sets the working directory for the shell (or the command specified via
1113B<-e>). The I<path> must be an absolute path and it must exist for
1114@@RXVT_NAME@@ to start. If it isn't specified then the current working
1115directory will be used; option B<-cd>.
1004 1116
1005=item B<keysym.>I<sym>: I<string> 1117=item B<keysym.>I<sym>: I<string>
1006 1118
1007Compile I<frills>: Associate I<string> with keysym I<sym>. The 1119Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008intervening resource name B<keysym.> cannot be omitted. 1120intervening resource name B<keysym.> cannot be omitted.
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1134searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1023omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1135omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1024keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1136keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1025performed in an exact manner; however, the closest match is assured. 1137performed in an exact manner; however, the closest match is assured.
1026 1138
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1139I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1140number), see RESOURCES in C<man 7 X> for futher details.
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031can start or end with whitespace. B<This feature is deprecated and will
1032be removed>.
1033
1034Please note that you need to double the C<\> in resource files, as
1035Xlib itself does its own de-escaping (you can use C<\033> instead of
1036C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1037processing).
1038 1141
1039You can define a range of keysyms in one shot by providing a I<string> 1142You can define a range of keysyms in one shot by providing a I<string>
1040with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1143with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1041should be a character not used by the strings. 1144should be a character not used by the strings.
1042 1145
1155(default: C<M-s>). 1258(default: C<M-s>).
1156 1259
1157=item B<urlLauncher>: I<string> 1260=item B<urlLauncher>: I<string>
1158 1261
1159Specifies the program to be started with a URL argument. Used by the 1262Specifies the program to be started with a URL argument. Used by the
1160C<selection-popup> and C<mark-urls> perl extensions. 1263C<selection-popup> and C<matcher> perl extensions.
1161 1264
1162=item B<transient-for>: I<windowid> 1265=item B<transient-for>: I<windowid>
1163 1266
1164Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1267Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1165 1268
1166=item B<override-redirect>: I<boolean> 1269=item B<override-redirect>: I<boolean>
1167 1270
1168Compile I<frills>: Sets override-redirect for the terminal window, making 1271Compile I<frills>: Sets override-redirect for the terminal window, making
1169it almost invisible to window managers; option B<-override-redirect>. 1272it almost invisible to window managers; option B<-override-redirect>.
1273
1274=item B<iso14755_52:> I<boolean>
1275
1276Turn on/off ISO 14755 5.2 mode (default enabled).
1170 1277
1171=back 1278=back
1172 1279
1173=head1 THE SCROLLBAR 1280=head1 THE SCROLLBAR
1174 1281
1193application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1300application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1194(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1301(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1195up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1302up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1196respectively. 1303respectively.
1197 1304
1198=head1 TEXT SELECTION AND INSERTION 1305=head1 THE SELECTION: SELECTING AND PASTING TEXT
1199 1306
1200The behaviour of text selection and insertion mechanism is similar to 1307The behaviour of text selection and insertion/pasting mechanism is similar
1201I<xterm>(1). 1308to I<xterm>(1).
1202 1309
1203=over 4 1310=over 4
1204 1311
1205=item B<Selection>: 1312=item B<Selecting>:
1206 1313
1207Left click at the beginning of the region, drag to the end of the region 1314Left click at the beginning of the region, drag to the end of the region
1208and release; Right click to extend the marked region; Left double-click 1315and release; Right click to extend the marked region; Left double-click
1209to select a word; Left triple-click to select the entire logical line 1316to select a word; Left triple-click to select the entire logical line
1210(which can span multiple screen lines), unless modified by resource 1317(which can span multiple screen lines), unless modified by resource
1214(Compile: I<frills>) will create a rectangular selection instead of a 1321(Compile: I<frills>) will create a rectangular selection instead of a
1215normal one. In this mode, every selected row becomes its own line in the 1322normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from 1323selection, and trailing whitespace is visually underlined and removed from
1217the selection. 1324the selection.
1218 1325
1219=item B<Insertion>: 1326=item B<Pasting>:
1220 1327
1221Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1328Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1222window causes the value of the PRIMARY selection (or CLIPBOARD with the 1329window causes the value of the PRIMARY selection (or CLIPBOARD with the
1223Meta modifier) to be inserted as if it had been typed on the keyboard. 1330B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1224 1331
1225Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1332Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1226inserted too. 1333inserted too.
1227 1334
1228=back 1335=back
1245 1352
1246=head1 ISO 14755 SUPPORT 1353=head1 ISO 14755 SUPPORT
1247 1354
1248ISO 14755 is a standard for entering and viewing unicode characters 1355ISO 14755 is a standard for entering and viewing unicode characters
1249and character codes using the keyboard. It consists of 4 parts. The 1356and character codes using the keyboard. It consists of 4 parts. The
1250first part is available rxvt-unicode has been compiled with 1357first part is available if rxvt-unicode has been compiled with
1251C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1358C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1252with C<--enable-iso14755>. 1359with C<--enable-iso14755>.
1253 1360
1254=over 4 1361=over 4
1255 1362
1374=back 1481=back
1375 1482
1376=head2 ALPHA CHANNEL SUPPORT 1483=head2 ALPHA CHANNEL SUPPORT
1377 1484
1378If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1485If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1379their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1486their act together, rxvt-unicode will do it's own alpha channel management:
1380(recommended, but B<MUST> have 4 digits/component) colour specifications, 1487
1381in addition to the ones provided by X, where the additional A component 1488You can prefix any color with an opaquenes percentage enclosed in
1489brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1490(0-100) that specifies the opacity of the color, where C<0> is completely
1491transparent and C<100> is completely opaque. For example, C<[50]red> is a
1492half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1493is the recommended format to specify transparency values, and works with
1494all ways to specify a colour.
1495
1496For complete control, rxvt-unicode also supports
1497C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1498specifications, where the additional C<aaaa> component specifies opacity
1382specifies opacity (alpha) values. The minimum value of C<0> is completely 1499(alpha) values. The minimum value of C<0000> is completely transparent,
1383transparent). You can also prefix any color with C<[a]>, where C<a> is on 1500while C<ffff> is completely opaque). The two example colours from
1384to four hex digits specifiying the opacity value. 1501earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1502C<rgba:0000/ff00/0000/f332>.
1385 1503
1386You probably need to specify B<"-depth 32">, too, and have the luck that 1504You probably need to specify B<"-depth 32">, too, to force a visual with
1387your X-server uses ARGB pixel layout, as X is far from just supporting 1505alpha channels, and have the luck that your X-server uses ARGB pixel
1388ARGB visuals out of the box, and rxvt-unicode just fudges around. 1506layout, as X is far from just supporting ARGB visuals out of the box, and
1507rxvt-unicode just fudges around.
1389 1508
1390For example, the following selects an almost completely transparent red 1509For example, the following selects an almost completely transparent black
1391background, and an almost opaque pink foreground: 1510background, and an almost opaque pink foreground:
1392 1511
1393 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1512 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1394 1513
1395I<Please note that transparency of any kind if completely unsupported by 1514When not using a background image, then the interpretation of the
1396the author. Don't bug him with installation questions!> 1515alpha channel is up to your compositing manager (most interpret it as
1516transparency of course).
1517
1518When using a background pixmap or pseudo-transparency, then the background
1519colour will always behave as if it were completely transparent (so the
1520background image shows instead), regardless of how it was specified, while
1521other colours will either be transparent as specified (the background
1522image will show through) on servers supporting the RENDER extension, or
1523fully opaque on servers not supporting the RENDER EXTENSION.
1524
1525Please note that due to bugs in Xft, specifying alpha values might result
1526in garbage being displayed when the X-server does not support the RENDER
1527extension.
1397 1528
1398=head1 ENVIRONMENT 1529=head1 ENVIRONMENT
1399 1530
1400B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1531B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1401 1532
1407resources or on the command line. 1538resources or on the command line.
1408 1539
1409=item B<COLORTERM> 1540=item B<COLORTERM>
1410 1541
1411Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1542Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1412compiled with XPM support, and optionally with the added extension 1543compiled with background image support, and optionally with the added
1413C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1544extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1545screen.
1414 1546
1415=item B<COLORFGBG> 1547=item B<COLORFGBG>
1416 1548
1417Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1549Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1418the colour code used as default foreground/text colour (or the string 1550the colour code used as default foreground/text colour (or the string
1419C<default> to indicate that the default-colour escape sequence is to be 1551C<default> to indicate that the default-colour escape sequence is to be
1420used), C<bg> is the colour code used as default background colour (or the 1552used), C<bg> is the colour code used as default background colour (or the
1421string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1553string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1422was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1554was compiled with background image support. Libraries like C<ncurses>
1423(and do) use this information to optimize screen output. 1555and C<slang> can (and do) use this information to optimize screen output.
1424 1556
1425=item B<WINDOWID> 1557=item B<WINDOWID>
1426 1558
1427Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1559Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1428window, which usually has subwindows for the scrollbar, the terminal 1560window, which usually has subwindows for the scrollbar, the terminal
1434C<--with-terminfo=PATH>. 1566C<--with-terminfo=PATH>.
1435 1567
1436=item B<DISPLAY> 1568=item B<DISPLAY>
1437 1569
1438Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1570Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1439display in its child processes. 1571display in its child processes if C<-display> isn't used to override. It
1572defaults to C<:0> if it doesn't exist.
1440 1573
1441=item B<SHELL> 1574=item B<SHELL>
1442 1575
1443The shell to be used for command execution, defaults to C</bin/sh>. 1576The shell to be used for command execution, defaults to C</bin/sh>.
1444 1577
1519Project Coordinator (changes.txt 2.21a to 2.4.5) 1652Project Coordinator (changes.txt 2.21a to 2.4.5)
1520 1653
1521=item Geoff Wing L<< <gcw@pobox.com> >> 1654=item Geoff Wing L<< <gcw@pobox.com> >>
1522 1655
1523Rewrote screen display and text selection routines. 1656Rewrote screen display and text selection routines.
1524 1657
1525Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1658Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1526 1659
1527=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1660=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1528 1661
1529Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1662Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines