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.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs.
Revision 1.175 by root, Mon Apr 12 17:06:55 2010 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
… …
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devanagari. 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>
… …
114 122
115=item B<-ss>|B<+ss> 123=item B<-ss>|B<+ss>
116 124
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118 126
119=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
120 128
121Turn on/off inheriting parent window's pixmap. Alternative form is 129Turn on/off illusion of a transparent window background; resource B<transparent>.
122B<-tr>; resource B<inheritPixmap>.
123 130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
124I<Please address all transparency related issues to Sasha Vasko at 134I<Please address all transparency related issues to Sasha Vasko at
125sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> 135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
126 136
127=item B<-fade> I<number> 137=item B<-fade> I<number>
128 138
129Fade 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
… …
136is opaque black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
137 147
138=item B<-tint> I<colour> 148=item B<-tint> I<colour>
139 149
140Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
141transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
142non-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
143used to brighten or darken the image in addition to tinting it. 153used to brighten or darken the image in addition to tinting it.
144Please note that certain tint colours can be applied on the server-side, 154Please note that certain tint colours can be applied on the server-side,
145thus yielding performance gain of two orders of magnitude. These colours are: 155thus yielding performance gain of two orders of magnitude. These colours are:
146blue, red, green, cyan, magenta, yellow, and those close to them; resource 156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
147I<tintColor>. Example: 158I<tintColor>. Example:
148 159
149 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
150 161
151=item B<-sh> I<number> 162=item B<-sh> I<number>
152 163
153Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
154background image in addition to (or instead of) tinting it; 165background image in addition to (or instead of) tinting it;
155resource I<shading>. 166resource I<shading>.
156 167
157=item B<-blt> I<string> 168=item B<-blt> I<string>
158 169
… …
160at the same time as transparency - such pixmap will be blended over 171at the same time as transparency - such pixmap will be blended over
161transparency image, using method specified. Supported values are : 172transparency image, using method specified. Supported values are :
162B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
164B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
165alpha-blending; resource I<blendType>. 176alpha-blending. Compile I<afterimage>; resource I<blendType>.
166 177
167=item B<-blr> I<HxV> 178=item B<-blr> I<HxV>
168 179
169Apply Gaussian Blur with the specified radii to the transparent 180Apply Gaussian Blur with the specified radii to the transparent
170background image. If single number is specified - both vertical and 181background image. If single number is specified - both vertical and
171horizontal radii are considered to be the same. Setting one of the 182horizontal radii are considered to be the same. Setting one of the
172radii to 1 and another to a large number creates interesting effects 183radii to 1 and another to a large number creates interesting effects
173on some backgrounds. Maximum radius value is 128; resource I<blurRadius>. 184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file>
188
189Compile I<afterimage>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>.
174 192
175=item B<-bg> I<colour> 193=item B<-bg> I<colour>
176 194
177Window background colour; resource B<background>. 195Window background colour; resource B<background>.
178 196
179=item B<-fg> I<colour> 197=item B<-fg> I<colour>
180 198
181Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
182 200
183=item B<-pixmap> I<file[;geom]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
184 202
185Compile I<afterimage>: Specify image file for the background and also 203Compile I<afterimage>: Specify image file for the background and also
186optionally specify its scaling with a geometry string. Note you may need to 204optionally specify its scaling with a geometry string. Note you may need to
187add quotes to avoid special shell interpretation of the C<;> in the 205add quotes to avoid special shell interpretation of the C<;> in the
188command-line; for more details see resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
189 207
190=item B<-cr> I<colour> 208=item B<-cr> I<colour>
… …
238italic> >> characters are to be printed. See resource B<boldItalicFont> 256italic> >> characters are to be printed. See resource B<boldItalicFont>
239for details. 257for details.
240 258
241=item B<-is>|B<+is> 259=item B<-is>|B<+is>
242 260
243Compile I<font-styles>: Bold/Italic font styles imply high intensity 261Compile I<font-styles>: Bold/Blink font styles imply high intensity
244foreground/background (default). See resource B<intensityStyles> for 262foreground/background (default). See resource B<intensityStyles> for
245details. 263details.
246 264
247=item B<-name> I<name> 265=item B<-name> I<name>
248 266
… …
266 284
267=item B<-sb>|B<+sb> 285=item B<-sb>|B<+sb>
268 286
269Turn on/off scrollbar; resource B<scrollBar>. 287Turn on/off scrollbar; resource B<scrollBar>.
270 288
289=item B<-sr>|B<+sr>
290
291Put scrollbar on right/left; resource B<scrollBar_right>.
292
293=item B<-st>|B<+st>
294
295Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
296resource B<scrollBar_floating>.
297
271=item B<-si>|B<+si> 298=item B<-si>|B<+si>
272 299
273Turn on/off scroll-to-bottom on TTY output inhibit; resource 300Turn on/off scroll-to-bottom on TTY output inhibit; resource
274B<scrollTtyOutput> has opposite effect. 301B<scrollTtyOutput> has opposite effect.
275 302
… …
281=item B<-sw>|B<+sw> 308=item B<-sw>|B<+sw>
282 309
283Turn on/off scrolling with the scrollback buffer as new lines appear. 310Turn on/off scrolling with the scrollback buffer as new lines appear.
284This only takes effect if B<-si> is also given; resource 311This only takes effect if B<-si> is also given; resource
285B<scrollWithBuffer>. 312B<scrollWithBuffer>.
286
287=item B<-sr>|B<+sr>
288
289Put scrollbar on right/left; resource B<scrollBar_right>.
290
291=item B<-st>|B<+st>
292
293Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
294resource B<scrollBar_floating>.
295 313
296=item B<-ptab>|B<+ptab> 314=item B<-ptab>|B<+ptab>
297 315
298If enabled (default), "Horizontal Tab" characters are being stored as 316If enabled (default), "Horizontal Tab" characters are being stored as
299actual wide characters in the screen buffer, which makes it possible to 317actual wide characters in the screen buffer, which makes it possible to
… …
303 321
304=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
305 323
306Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
307 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
329
308=item B<-iconic> 330=item B<-iconic>
309 331
310Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
311Alternative form is B<-ic>. 333Alternative form is B<-ic>.
312 334
… …
328 350
329=item B<-bl> 351=item B<-bl>
330 352
331Compile I<frills>: Set MWM hints to request a borderless window, i.e. 353Compile I<frills>: Set MWM hints to request a borderless window, i.e.
332if honoured by the WM, the rxvt-unicode window will not have window 354if honoured by the WM, the rxvt-unicode window will not have window
333decorations; resource B<borderLess>. 355decorations; resource B<borderLess>. If the window manager does not
356support MWM hints (e.g. kwin), enables override-redirect mode.
334 357
335=item B<-override-redirect> 358=item B<-override-redirect>
336 359
337Compile I<frills>: Sets override-redirect on the window; resource 360Compile I<frills>: Sets override-redirect on the window; resource
338B<override-redirect>. 361B<override-redirect>.
… …
347=item B<-lsp> I<number> 370=item B<-lsp> I<number>
348 371
349Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
350the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
351B<lineSpace>. 374B<lineSpace>.
375
376=item B<-letsp> I<number>
377
378Compile I<frills>: Amount to adjust the computed character width by
379to control overall letter spacing. Negative values will tighten up the
380letter spacing, positive values will space letters out more. Useful to
381work around odd font metrics; resource B<letterSpace>.
352 382
353=item B<-tn> I<termname> 383=item B<-tn> I<termname>
354 384
355This option specifies the name of the terminal type to be set in the 385This option specifies the name of the terminal type to be set in the
356B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
… …
411 441
412=item B<-tcw> 442=item B<-tcw>
413 443
414Change the meaning of triple-click selection with the left mouse 444Change the meaning of triple-click selection with the left mouse
415button. Only effective when the original (non-perl) selection code is 445button. Only effective when the original (non-perl) selection code is
416in-use. Instead of selecting a full line it will extend the selection the 446in-use. Instead of selecting a full line it will extend the selection to
417end of the logical line only. resource B<tripleclickwords>. 447the end of the logical line only. resource B<tripleclickwords>.
418 448
419=item B<-insecure> 449=item B<-insecure>
420 450
421Enable "insecure" mode, which currently enables most of the escape 451Enable "insecure" mode, which currently enables most of the escape
422sequences that echo strings. See the resource B<insecure> for more 452sequences that echo strings. See the resource B<insecure> for more
… …
442 472
443Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 473Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
444will not immediately destroy its window when the program executed within 474will not immediately destroy its window when the program executed within
445it exits. Instead, it will wait till it is being killed or closed by the 475it exits. Instead, it will wait till it is being killed or closed by the
446user; resource B<hold>. 476user; resource B<hold>.
477
478=item B<-cd> I<path>
479
480Sets the working directory for the shell (or the command specified via
481B<-e>). The I<path> must be an absolute path and it must exist for
482@@RXVT_NAME@@ to start; resource B<chdir>.
483
484=item B<-xrm> I<string>
485
486Works like the X Toolkit option of the same name, by adding the I<string>
487as if it were specified in a resource file. Resource values specified this
488way take precedence over all other resource specifications.
489
490Note that you need to use the I<same> syntax as in the .Xdefaults file,
491e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
492options can be specified as long-options on the commandline, so use
493of B<-xrm> is mostly limited to cases where you want to specify other
494resources (e.g. for input methods) or for compatibility with other
495programs.
447 496
448=item B<-keysym.>I<sym> I<string> 497=item B<-keysym.>I<sym> I<string>
449 498
450Remap a key symbol. See resource B<keysym>. 499Remap a key symbol. See resource B<keysym>.
451 500
… …
486If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 535If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
487entries and will not tinker with pty/tty permissions - you have to do that 536entries and will not tinker with pty/tty permissions - you have to do that
488yourself if you want that. 537yourself if you want that.
489 538
490As an extremely special case, specifying C<-1> will completely suppress 539As an extremely special case, specifying C<-1> will completely suppress
491pty/tty operations. 540pty/tty operations, which is probably only useful in conjunction with some
541perl extension that manages the terminal.
492 542
493Here is a example in perl that illustrates how this option can be used (a 543Here is a example in perl that illustrates how this option can be used (a
494longer example is in F<doc/pty-fd>): 544longer example is in F<doc/pty-fd>):
495 545
496 use IO::Pty; 546 use IO::Pty;
… …
510Comma-separated list of perl extension scripts to use (or not to use) in 560Comma-separated list of perl extension scripts to use (or not to use) in
511this terminal instance. See resource B<perl-ext> for details. 561this terminal instance. See resource B<perl-ext> for details.
512 562
513=back 563=back
514 564
515=head1 RESOURCES (available also as long-options) 565=head1 RESOURCES
516 566
517Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 567Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
518options) compiled into your version. 568options) compiled into your version. All resources are also available as
569long-options.
519 570
520You can set and change the resources using X11 tools like B<xrdb>. Many 571You can set and change the resources using X11 tools like B<xrdb>. Many
521distribution do also load settings from the B<~/.Xresources> file when X 572distribution do also load settings from the B<~/.Xresources> file when X
522starts. @@RXVT_NAME@@ will consult the following files/resources in order, 573starts. @@RXVT_NAME@@ will consult the following files/resources in order,
523with later settings overwriting earlier ones: 574with later settings overwriting earlier ones:
… …
525 1. system-wide app-defaults file, either locale-dependent OR global 576 1. system-wide app-defaults file, either locale-dependent OR global
526 2. app-defaults file in $XAPPLRESDIR 577 2. app-defaults file in $XAPPLRESDIR
527 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
528 4. SCREEN_RESOURCES for the current screen 579 4. SCREEN_RESOURCES for the current screen
529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline
530 582
531Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
532names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
533common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 585common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
534configured, while the class name B<URxvt> allows resources unique to 586configured, while the class name B<URxvt> allows resources unique to
… …
544=item B<depth:> I<bitdepth> 596=item B<depth:> I<bitdepth>
545 597
546Compile I<xft>: Attempt to find a visual with the given bit depth; 598Compile I<xft>: Attempt to find a visual with the given bit depth;
547option B<-depth>. 599option B<-depth>.
548 600
601=item B<buffered:> I<boolean>
602
603Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
604On some card/driver combination enabling it slightly decreases
605performance, on most it greatly helps it. The slowdown is small, so it
606should normally be enabled.
607
549=item B<geometry:> I<geom> 608=item B<geometry:> I<geom>
550 609
551Create the window with the specified X window geometry [default 80x24]; 610Create the window with the specified X window geometry [default 80x24];
552option B<-geometry>. 611option B<-geometry>.
553 612
… …
636 695
637B<False>: specify that everything is to be displayed, even 696B<False>: specify that everything is to be displayed, even
638if the refresh is too fast for the human eye to read anything (or the 697if the refresh is too fast for the human eye to read anything (or the
639monitor to display anything); option B<+ss>. 698monitor to display anything); option B<+ss>.
640 699
641=item B<inheritPixmap:> I<boolean> 700=item B<transparent:> I<boolean>
642 701
643B<True>: make the background inherit the parent windows' pixmap, giving 702Turn on/off illusion of a transparent window background.
644artificial transparency. B<False>: do not inherit the parent windows'
645pixmap.
646 703
647I<Please note that transparency of any kind if completely unsupported by 704B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
648the author. Don't bug him with installation questions!> 705future versions.
706
707I<Please address all transparency related issues to Sasha Vasko at
708sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
649 709
650=item B<fading:> I<number> 710=item B<fading:> I<number>
651 711
652Fade the text by the given percentage when focus is lost; option B<-fade>. 712Fade the text by the given percentage when focus is lost; option B<-fade>.
653 713
… …
670 730
671Specify background blending type; option B<-blt>. 731Specify background blending type; option B<-blt>.
672 732
673=item B<blurRadius:> I<number> 733=item B<blurRadius:> I<number>
674 734
675Apply Gaussian Blurr with the specified radius to the transparent 735Apply gaussian blur with the specified radius to the transparent
676background image; option B<-blr>. 736background image; option B<-blr>.
737
738=item B<iconFile:> I<file>
739
740Set the application icon pixmap; option B<-icon>.
677 741
678=item B<scrollColor:> I<colour> 742=item B<scrollColor:> I<colour>
679 743
680Use the specified colour for the scrollbar [default #B2B2B2]. 744Use the specified colour for the scrollbar [default #B2B2B2].
681 745
… …
687=item B<borderColor:> I<colour> 751=item B<borderColor:> I<colour>
688 752
689The colour of the border around the text area and between the scrollbar 753The colour of the border around the text area and between the scrollbar
690and the text. 754and the text.
691 755
692=item B<backgroundPixmap:> I<file[;geom]> 756=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
693 757
694Use the specified image file for the background and also optionally 758Use the specified image file for the background and also
695specify its scaling with a geometry string B<WxH+X+Y>, 759optionally specify its scaling with a geometry string B<WxH+X+Y>,
696in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 760(default C<0x0+50+50>) in which B<"W" / "H"> specify the
697and B<"X" / "Y"> locate the image centre (percent). 761horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
698A scale of 0 displays the image with tiling. A scale of 1 displays the 762centre (percent). A scale of 0 displays the image with tiling. A scale
699image without any scaling. A scale of 2 to 9 specifies an integer 763of 1 displays the image without any scaling. A scale of 2 to 9 specifies
700number of images in that direction. No image will be magnified beyond 764an integer number of images in that direction. No image will be magnified
70110 times its original size. The maximum permitted scale is 1000. 765beyond 10 times its original size. The maximum permitted scale is 1000.
702Special string of B<"auto"> used as a geometry will cause image to be 766Additional operations can be specified after colon B<:op1:op2...>.
703automatically scaled to match window size. 767Supported operations are:
768
769 tile force background image to be tiled and not scaled. Equivalent to 0x0
770 propscale will scale image keeping proportions
771 auto will scale image to match window size. Equivalent to 100x100
772 hscale will scale image horizontally to the window size
773 vscale will scale image vertically to the window size
774 scale will scale image to match window size
775 root will tile image as if it was a root window background, auto-adjusting
776 whenever terminal window moves
777
704If used in conjunction with B<-tr> option - specified pixmap will be 778If used in conjunction with B<-tr> option, the specified pixmap will be
705blended over transparency image using either alpha-blending, or any 779blended over transparency image using either alpha-blending, or any
706other blending type, specified with B<-blt "type"> option. 780other blending type, specified with B<-blt "type"> option.
707[default 0x0+50+50]
708 781
709=item B<path:> I<path> 782=item B<path:> I<path>
710 783
711Specify the colon-delimited search path for finding background image files. 784Specify the colon-delimited search path for finding background image files.
712 785
… …
739it is named first) and thus defines the character cell grid to be 9 pixels 812it is named first) and thus defines the character cell grid to be 9 pixels
740wide and 15 pixels high. 813wide and 15 pixels high.
741 814
742The second font is just used to add additional unicode characters not in 815The second font is just used to add additional unicode characters not in
743the base font, likewise the third, which is unfortunately non-bold, but 816the base font, likewise the third, which is unfortunately non-bold, but
744the bold version of the font does contain less characters, so this is a 817the bold version of the font does contain fewer characters, so this is a
745useful supplement. 818useful supplement.
746 819
747The third font is an Xft font with aliasing turned off, and the characters 820The third font is an Xft font with aliasing turned off, and the characters
748are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 821are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
749contains other characters, but we are not interested in them. 822contains other characters, but we are not interested in them.
… …
773text font will being used for the given style. 846text font will being used for the given style.
774 847
775=item B<intensityStyles:> I<boolean> 848=item B<intensityStyles:> I<boolean>
776 849
777When font styles are not enabled, or this option is enabled (B<True>, 850When font styles are not enabled, or this option is enabled (B<True>,
778option B<-is>, the default), bold and italic font styles imply high 851option B<-is>, the default), bold/blink font styles imply high
779intensity foreground/background colours. Disabling this option (B<False>, 852intensity foreground/background colours. Disabling this option (B<False>,
780option B<+is>) disables this behaviour, the high intensity colours are not 853option B<+is>) disables this behaviour, the high intensity colours are not
781reachable. 854reachable.
782 855
783=item B<selectstyle:> I<mode>
784
785Set mouse selection style to B<old> which is 2.20, B<oldword> which
786is xterm style with 2.20 old word selection, or anything else which
787gives xterm style selection. Only effective when the original (non-perl)
788selection code is in use.
789
790=item B<scrollstyle:> I<mode>
791
792Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
793the author's favourite.
794
795=item B<title:> I<string> 856=item B<title:> I<string>
796 857
797Set window title string, the default title is the command-line 858Set window title string, the default title is the command-line
798specified after the B<-e> option, if any, otherwise the application 859specified after the B<-e> option, if any, otherwise the application
799name; option B<-title>. 860name; option B<-title>.
… …
812=item B<urgentOnBell:> I<boolean> 873=item B<urgentOnBell:> I<boolean>
813 874
814B<True>: set the urgency hint for the wm on receipt of a bell character. 875B<True>: set the urgency hint for the wm on receipt of a bell character.
815B<False>: do not set the urgency hint [default]. 876B<False>: do not set the urgency hint [default].
816 877
878@@RXVT_NAME@@ resets the urgency hint on every focus change.
879
817=item B<visualBell:> I<boolean> 880=item B<visualBell:> I<boolean>
818 881
819B<True>: use visual bell on receipt of a bell character; option B<-vb>. 882B<True>: use visual bell on receipt of a bell character; option B<-vb>.
820B<False>: no visual bell [default]; option B<+vb>. 883B<False>: no visual bell [default]; option B<+vb>.
821 884
… …
843 906
844 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 907 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
845 908
846This creates a new file in your home directory with the screen contents 909This creates a new file in your home directory with the screen contents
847every time you hit C<Print>. 910every time you hit C<Print>.
911
912=item B<scrollstyle:> I<mode>
913
914Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
915the author's favourite.
848 916
849=item B<scrollBar:> I<boolean> 917=item B<scrollBar:> I<boolean>
850 918
851B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 919B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
852disable the scrollbar; option B<+sb>. 920disable the scrollbar; option B<+sb>.
… …
940=item B<cursorBlink:> I<boolean> 1008=item B<cursorBlink:> I<boolean>
941 1009
942B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1010B<True>: blink the cursor. B<False>: do not blink the cursor [default];
943option B<-bc>. 1011option B<-bc>.
944 1012
1013=item B<cursorUnderline:> I<boolean>
1014
1015B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1016option B<-uc>.
1017
945=item B<pointerBlank:> I<boolean> 1018=item B<pointerBlank:> I<boolean>
946 1019
947B<True>: blank the pointer when a key is pressed or after a set number 1020B<True>: blank the pointer when a key is pressed or after a set number
948of seconds of inactivity. B<False>: the pointer is always visible 1021of seconds of inactivity. B<False>: the pointer is always visible
949[default]. 1022[default].
… …
985will be created). In this mode, characters outside ISO-8859-1 can be used. 1058will be created). In this mode, characters outside ISO-8859-1 can be used.
986 1059
987When the selection extension is not used, only ISO-8859-1 characters can 1060When the selection extension is not used, only ISO-8859-1 characters can
988be used. If not specified, the built-in default is used: 1061be used. If not specified, the built-in default is used:
989 1062
990B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1063B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
991 1064
992=item B<preeditType:> I<style> 1065=item B<preeditType:> I<style>
993 1066
994B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1067B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
995 1068
… …
1051 1124
1052=item B<secondaryScroll:> I<boolean> 1125=item B<secondaryScroll:> I<boolean>
1053 1126
1054Turn on/off secondary screen scroll (default enabled). If this 1127Turn on/off secondary screen scroll (default enabled). If this
1055option is enabled, scrolls on the secondary screen will change the 1128option is enabled, scrolls on the secondary screen will change the
1056scrollback buffer and switching to/from the secondary screen will 1129scrollback buffer and, when secondaryScreen is off, switching
1057instead scroll the screen up. 1130to/from the secondary screen will instead scroll the screen up.
1058 1131
1059=item B<hold>: I<boolean> 1132=item B<hold>: I<boolean>
1060 1133
1061Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1134Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1062will not immediately destroy its window when the program executed within 1135will not immediately destroy its window when the program executed within
1063it exits. Instead, it will wait till it is being killed or closed by the 1136it exits. Instead, it will wait till it is being killed or closed by the
1064user. 1137user.
1138
1139=item B<chdir>: I<path>
1140
1141Sets the working directory for the shell (or the command specified via
1142B<-e>). The I<path> must be an absolute path and it must exist for
1143@@RXVT_NAME@@ to start. If it isn't specified then the current working
1144directory will be used; option B<-cd>.
1065 1145
1066=item B<keysym.>I<sym>: I<string> 1146=item B<keysym.>I<sym>: I<string>
1067 1147
1068Compile I<frills>: Associate I<string> with keysym I<sym>. The 1148Compile I<frills>: Associate I<string> with keysym I<sym>. The
1069intervening resource name B<keysym.> cannot be omitted. 1149intervening resource name B<keysym.> cannot be omitted.
… …
1108when Control-Meta-c is being pressed": 1188when Control-Meta-c is being pressed":
1109 1189
1110 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1190 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1111 1191
1112If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1192If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1113is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1193is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1114manpage. For example, the F<selection> extension (activated via 1194manpage. For example, the F<selection> extension (activated via
1115C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1195C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1116 1196
1117 URxvt.keysym.M-C-c: perl:selection:rot13 1197 URxvt.keysym.M-C-c: perl:selection:rot13
1118 1198
… …
1176all instances, while B<perl-ext> is used for specific instances. 1256all instances, while B<perl-ext> is used for specific instances.
1177 1257
1178=item B<perl-eval>: I<string> 1258=item B<perl-eval>: I<string>
1179 1259
1180Perl code to be evaluated when all extensions have been registered. See 1260Perl code to be evaluated when all extensions have been registered. See
1181the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1261the @@RXVT_NAME@@perl(3) manpage.
1182will be ignored when running setuid/setgid.
1183 1262
1184=item B<perl-lib>: I<path> 1263=item B<perl-lib>: I<path>
1185 1264
1186Colon-separated list of additional directories that hold extension 1265Colon-separated list of additional directories that hold extension
1187scripts. When looking for extensions specified by the C<perl> resource, 1266scripts. When looking for extensions specified by the C<perl> resource,
1188@@RXVT_NAME@@ will first look in these directories and then in 1267@@RXVT_NAME@@ will first look in these directories and then in
1189F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1268F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1190will be ignored when running setuid/setgid.
1191 1269
1192See the @@RXVT_NAME@@perl(3) manpage. 1270See the @@RXVT_NAME@@perl(3) manpage.
1193 1271
1194=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1272=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1195 1273
… …
1217 1295
1218=item B<override-redirect>: I<boolean> 1296=item B<override-redirect>: I<boolean>
1219 1297
1220Compile I<frills>: Sets override-redirect for the terminal window, making 1298Compile I<frills>: Sets override-redirect for the terminal window, making
1221it almost invisible to window managers; option B<-override-redirect>. 1299it almost invisible to window managers; option B<-override-redirect>.
1300
1301=item B<iso14755:> I<boolean>
1302
1303Turn on/off ISO 14755 (default enabled).
1222 1304
1223=item B<iso14755_52:> I<boolean> 1305=item B<iso14755_52:> I<boolean>
1224 1306
1225Turn on/off ISO 14755 5.2 mode (default enabled). 1307Turn on/off ISO 14755 5.2 mode (default enabled).
1226 1308
… …
1418Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1500Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1419always swapping the foreground/background colours. This is in contrast to 1501always swapping the foreground/background colours. This is in contrast to
1420I<xterm>(1) where the colours are only swapped if they have not otherwise 1502I<xterm>(1) where the colours are only swapped if they have not otherwise
1421been specified. For example, 1503been specified. For example,
1422 1504
1423=over 4
1424
1425=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1505 @@RXVT_NAME@@ -fg Black -bg White -rv
1426 1506
1427would yield White on Black, while on I<xterm>(1) it would yield Black 1507would yield White on Black, while on I<xterm>(1) it would yield Black on
1428on White. 1508White.
1429
1430=back
1431 1509
1432=head2 ALPHA CHANNEL SUPPORT 1510=head2 ALPHA CHANNEL SUPPORT
1433 1511
1434If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1512If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1435their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1513their act together, rxvt-unicode will do it's own alpha channel management:
1436(recommended, but B<MUST> have 4 digits/component) colour specifications, 1514
1437in addition to the ones provided by X, where the additional A component 1515You can prefix any color with an opaquenes percentage enclosed in
1516brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1517(0-100) that specifies the opacity of the color, where C<0> is completely
1518transparent and C<100> is completely opaque. For example, C<[50]red> is a
1519half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1520is the recommended format to specify transparency values, and works with
1521all ways to specify a colour.
1522
1523For complete control, rxvt-unicode also supports
1524C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1525specifications, where the additional C<aaaa> component specifies opacity
1438specifies opacity (alpha) values. The minimum value of C<0> is completely 1526(alpha) values. The minimum value of C<0000> is completely transparent,
1439transparent). You can also prefix any color with C<[percent]>, where 1527while C<ffff> is completely opaque). The two example colours from
1440C<percent> is a decimal percentage (0-100) that specifies the opacity of 1528earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1441the color, where C<0> is completely transparent and C<100> is completelxy 1529C<rgba:0000/ff00/0000/f332>.
1442opaque.
1443 1530
1444You probably need to specify B<"-depth 32">, too, and have the luck that 1531You probably need to specify B<"-depth 32">, too, to force a visual with
1445your X-server uses ARGB pixel layout, as X is far from just supporting 1532alpha channels, and have the luck that your X-server uses ARGB pixel
1446ARGB visuals out of the box, and rxvt-unicode just fudges around. 1533layout, as X is far from just supporting ARGB visuals out of the box, and
1534rxvt-unicode just fudges around.
1447 1535
1448For example, the following selects an almost completely transparent red 1536For example, the following selects an almost completely transparent black
1449background, and an almost opaque pink foreground: 1537background, and an almost opaque pink foreground:
1450 1538
1451 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1539 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1452 1540
1453I<Please note that transparency of any kind if completely unsupported by 1541When not using a background image, then the interpretation of the
1454the author. Don't bug him with installation questions!> 1542alpha channel is up to your compositing manager (most interpret it as
1543transparency of course).
1544
1545When using a background pixmap or pseudo-transparency, then the background
1546colour will always behave as if it were completely transparent (so the
1547background image shows instead), regardless of how it was specified, while
1548other colours will either be transparent as specified (the background
1549image will show through) on servers supporting the RENDER extension, or
1550fully opaque on servers not supporting the RENDER EXTENSION.
1551
1552Please note that due to bugs in Xft, specifying alpha values might result
1553in garbage being displayed when the X-server does not support the RENDER
1554extension.
1455 1555
1456=head1 ENVIRONMENT 1556=head1 ENVIRONMENT
1457 1557
1458B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1558B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1459 1559
… …
1465resources or on the command line. 1565resources or on the command line.
1466 1566
1467=item B<COLORTERM> 1567=item B<COLORTERM>
1468 1568
1469Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1569Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1470compiled with background image support, and optionally with the added 1570compiled with background image support, and optionally with the added
1471extension C<-mono> to indicate that rxvt-unicode runs on a monochrome 1571extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1472screen. 1572screen.
1473 1573
1474=item B<COLORFGBG> 1574=item B<COLORFGBG>
1475 1575
1476Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1576Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1477the colour code used as default foreground/text colour (or the string 1577the colour code used as default foreground/text colour (or the string
1478C<default> to indicate that the default-colour escape sequence is to be 1578C<default> to indicate that the default-colour escape sequence is to be
1479used), C<bg> is the colour code used as default background colour (or the 1579used), C<bg> is the colour code used as default background colour (or the
1480string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1580string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1481was compiled with background image support. Libraries like C<ncurses> 1581was compiled with background image support. Libraries like C<ncurses>
1482and C<slang> can (and do) use this information to optimize screen output. 1582and C<slang> can (and do) use this information to optimize screen output.
1483 1583
1484=item B<WINDOWID> 1584=item B<WINDOWID>
1485 1585
1486Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1586Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
… …
1493C<--with-terminfo=PATH>. 1593C<--with-terminfo=PATH>.
1494 1594
1495=item B<DISPLAY> 1595=item B<DISPLAY>
1496 1596
1497Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1597Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1498display in its child processes. 1598display in its child processes if C<-display> isn't used to override. It
1599defaults to C<:0> if it doesn't exist.
1499 1600
1500=item B<SHELL> 1601=item B<SHELL>
1501 1602
1502The shell to be used for command execution, defaults to C</bin/sh>. 1603The shell to be used for command execution, defaults to C</bin/sh>.
1503 1604
… …
1578Project Coordinator (changes.txt 2.21a to 2.4.5) 1679Project Coordinator (changes.txt 2.21a to 2.4.5)
1579 1680
1580=item Geoff Wing L<< <gcw@pobox.com> >> 1681=item Geoff Wing L<< <gcw@pobox.com> >>
1581 1682
1582Rewrote screen display and text selection routines. 1683Rewrote screen display and text selection routines.
1583 1684
1584Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1685Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1585 1686
1586=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1687=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1587 1688
1588Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1689Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines