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.132 by root, Mon Jun 18 13:38:12 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
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>
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
124I<Please note that transparency of any kind if completely unsupported by 131B<-ip> is still accepted as an obsolete alias but will be removed in
125the author. Don't bug him with installation questions! Read the FAQ (man 7 132future versions.
126@@RXVT_NAME@@)!> 133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
127 136
128=item B<-fade> I<number> 137=item B<-fade> I<number>
129 138
130Fade 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
131fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
137is opaque black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
138 147
139=item B<-tint> I<colour> 148=item B<-tint> I<colour>
140 149
141Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
142transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
143non-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
144used 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
145I<tintColor>. Example: 158I<tintColor>. Example:
146 159
147 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
148 161
149=item B<-sh> I<number> 162=item B<-sh> I<number>
150 163
151Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
152background image in addition to (or instead of) tinting it; 165background image in addition to (or instead of) tinting it;
153resource I<shading>. 166resource I<shading>.
154 167
155=item B<-blt> I<string> 168=item B<-blt> I<string>
156 169
157Specify background blending type. If background pixmap is specified 170Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over 171at the same time as transparency - such pixmap will be blended over
159transparency image, using method specified. Supported values are : 172transparency image, using method specified. Supported values are :
160B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<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
163alpha-blending; resource I<blendType>. 176alpha-blending. Compile I<afterimage>; resource I<blendType>.
164 177
165=item B<-blr> I<number> 178=item B<-blr> I<HxV>
166 179
167Apply Gaussian Blur with the specified radius to the transparent 180Apply Gaussian Blur with the specified radii to the transparent
168background image; resource I<blurRadius>. 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>.
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>.
169 192
170=item B<-bg> I<colour> 193=item B<-bg> I<colour>
171 194
172Window background colour; resource B<background>. 195Window background colour; resource B<background>.
173 196
174=item B<-fg> I<colour> 197=item B<-fg> I<colour>
175 198
176Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
177 200
178=item B<-pixmap> I<file[;geom]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
179 202
180Compile I<afterimage>: Specify image file for the background and also 203Compile I<afterimage>: Specify image file for the background and also
181optionally 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
182add quotes to avoid special shell interpretation of the C<;> in the 205add quotes to avoid special shell interpretation of the C<;> in the
183command-line; for more details see resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
184 207
185=item B<-cr> I<colour> 208=item B<-cr> I<colour>
233italic> >> characters are to be printed. See resource B<boldItalicFont> 256italic> >> characters are to be printed. See resource B<boldItalicFont>
234for details. 257for details.
235 258
236=item B<-is>|B<+is> 259=item B<-is>|B<+is>
237 260
238Compile I<font-styles>: Bold/Italic font styles imply high intensity 261Compile I<font-styles>: Bold/Blink font styles imply high intensity
239foreground/background (default). See resource B<intensityStyles> for 262foreground/background (default). See resource B<intensityStyles> for
240details. 263details.
241 264
242=item B<-name> I<name> 265=item B<-name> I<name>
243 266
261 284
262=item B<-sb>|B<+sb> 285=item B<-sb>|B<+sb>
263 286
264Turn on/off scrollbar; resource B<scrollBar>. 287Turn on/off scrollbar; resource B<scrollBar>.
265 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
266=item B<-si>|B<+si> 298=item B<-si>|B<+si>
267 299
268Turn on/off scroll-to-bottom on TTY output inhibit; resource 300Turn on/off scroll-to-bottom on TTY output inhibit; resource
269B<scrollTtyOutput> has opposite effect. 301B<scrollTtyOutput> has opposite effect.
270 302
276=item B<-sw>|B<+sw> 308=item B<-sw>|B<+sw>
277 309
278Turn on/off scrolling with the scrollback buffer as new lines appear. 310Turn on/off scrolling with the scrollback buffer as new lines appear.
279This only takes effect if B<-si> is also given; resource 311This only takes effect if B<-si> is also given; resource
280B<scrollWithBuffer>. 312B<scrollWithBuffer>.
281
282=item B<-sr>|B<+sr>
283
284Put scrollbar on right/left; resource B<scrollBar_right>.
285
286=item B<-st>|B<+st>
287
288Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
289resource B<scrollBar_floating>.
290 313
291=item B<-ptab>|B<+ptab> 314=item B<-ptab>|B<+ptab>
292 315
293If enabled (default), "Horizontal Tab" characters are being stored as 316If enabled (default), "Horizontal Tab" characters are being stored as
294actual wide characters in the screen buffer, which makes it possible to 317actual wide characters in the screen buffer, which makes it possible to
298 321
299=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
300 323
301Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
302 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
329
303=item B<-iconic> 330=item B<-iconic>
304 331
305Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
306Alternative form is B<-ic>. 333Alternative form is B<-ic>.
307 334
323 350
324=item B<-bl> 351=item B<-bl>
325 352
326Compile 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.
327if 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
328decorations; resource B<borderLess>. 355decorations; resource B<borderLess>. If the window manager does not
356support MWM hints (e.g. kwin), enables override-redirect mode.
329 357
330=item B<-override-redirect> 358=item B<-override-redirect>
331 359
332Compile I<frills>: Sets override-redirect on the window; resource 360Compile I<frills>: Sets override-redirect on the window; resource
333B<override-redirect>. 361B<override-redirect>.
341 369
342=item B<-lsp> I<number> 370=item B<-lsp> I<number>
343 371
344Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
345the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
346B<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>.
347 382
348=item B<-tn> I<termname> 383=item B<-tn> I<termname>
349 384
350This 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
351B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
406 441
407=item B<-tcw> 442=item B<-tcw>
408 443
409Change the meaning of triple-click selection with the left mouse 444Change the meaning of triple-click selection with the left mouse
410button. Only effective when the original (non-perl) selection code is 445button. Only effective when the original (non-perl) selection code is
411in-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
412end of the logical line only. resource B<tripleclickwords>. 447the end of the logical line only. resource B<tripleclickwords>.
413 448
414=item B<-insecure> 449=item B<-insecure>
415 450
416Enable "insecure" mode, which currently enables most of the escape 451Enable "insecure" mode, which currently enables most of the escape
417sequences that echo strings. See the resource B<insecure> for more 452sequences that echo strings. See the resource B<insecure> for more
437 472
438Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 473Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
439will not immediately destroy its window when the program executed within 474will not immediately destroy its window when the program executed within
440it 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
441user; 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.
442 496
443=item B<-keysym.>I<sym> I<string> 497=item B<-keysym.>I<sym> I<string>
444 498
445Remap a key symbol. See resource B<keysym>. 499Remap a key symbol. See resource B<keysym>.
446 500
481If 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
482entries 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
483yourself if you want that. 537yourself if you want that.
484 538
485As an extremely special case, specifying C<-1> will completely suppress 539As an extremely special case, specifying C<-1> will completely suppress
486pty/tty operations. 540pty/tty operations, which is probably only useful in conjunction with some
541perl extension that manages the terminal.
487 542
488Here 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
489longer example is in F<doc/pty-fd>): 544longer example is in F<doc/pty-fd>):
490 545
491 use IO::Pty; 546 use IO::Pty;
505Comma-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
506this terminal instance. See resource B<perl-ext> for details. 561this terminal instance. See resource B<perl-ext> for details.
507 562
508=back 563=back
509 564
510=head1 RESOURCES (available also as long-options) 565=head1 RESOURCES
511 566
512Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 567Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
513options) compiled into your version. 568options) compiled into your version. All resources are also available as
569long-options.
514 570
515You 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
516distribution do also load settings from the B<~/.Xresources> file when X 572distribution do also load settings from the B<~/.Xresources> file when X
517starts. @@RXVT_NAME@@ will consult the following files/resources in order, 573starts. @@RXVT_NAME@@ will consult the following files/resources in order,
518with later settings overwriting earlier ones: 574with later settings overwriting earlier ones:
520 1. system-wide app-defaults file, either locale-dependent OR global 576 1. system-wide app-defaults file, either locale-dependent OR global
521 2. app-defaults file in $XAPPLRESDIR 577 2. app-defaults file in $XAPPLRESDIR
522 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
523 4. SCREEN_RESOURCES for the current screen 579 4. SCREEN_RESOURCES for the current screen
524 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline
525 582
526Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
527names: 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
528common 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
529configured, while the class name B<URxvt> allows resources unique to 586configured, while the class name B<URxvt> allows resources unique to
539=item B<depth:> I<bitdepth> 596=item B<depth:> I<bitdepth>
540 597
541Compile 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;
542option B<-depth>. 599option B<-depth>.
543 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
544=item B<geometry:> I<geom> 608=item B<geometry:> I<geom>
545 609
546Create the window with the specified X window geometry [default 80x24]; 610Create the window with the specified X window geometry [default 80x24];
547option B<-geometry>. 611option B<-geometry>.
548 612
631 695
632B<False>: specify that everything is to be displayed, even 696B<False>: specify that everything is to be displayed, even
633if 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
634monitor to display anything); option B<+ss>. 698monitor to display anything); option B<+ss>.
635 699
636=item B<inheritPixmap:> I<boolean> 700=item B<transparent:> I<boolean>
637 701
638B<True>: make the background inherit the parent windows' pixmap, giving 702Turn on/off illusion of a transparent window background.
639artificial transparency. B<False>: do not inherit the parent windows'
640pixmap.
641 703
642I<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
643the 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@@)!>
644 709
645=item B<fading:> I<number> 710=item B<fading:> I<number>
646 711
647Fade 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>.
648 713
665 730
666Specify background blending type; option B<-blt>. 731Specify background blending type; option B<-blt>.
667 732
668=item B<blurRadius:> I<number> 733=item B<blurRadius:> I<number>
669 734
670Apply Gaussian Blurr with the specified radius to the transparent 735Apply gaussian blur with the specified radius to the transparent
671background 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>.
672 741
673=item B<scrollColor:> I<colour> 742=item B<scrollColor:> I<colour>
674 743
675Use the specified colour for the scrollbar [default #B2B2B2]. 744Use the specified colour for the scrollbar [default #B2B2B2].
676 745
682=item B<borderColor:> I<colour> 751=item B<borderColor:> I<colour>
683 752
684The 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
685and the text. 754and the text.
686 755
687=item B<backgroundPixmap:> I<file[;geom]> 756=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
688 757
689Use the specified image file for the background and also optionally 758Use the specified image file for the background and also
690specify its scaling with a geometry string B<WxH+X+Y>, 759optionally specify its scaling with a geometry string B<WxH+X+Y>,
691in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 760(default C<0x0+50+50>) in which B<"W" / "H"> specify the
692and B<"X" / "Y"> locate the image centre (percent). 761horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
693A 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
694image 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
695number of images in that direction. No image will be magnified beyond 764an integer number of images in that direction. No image will be magnified
69610 times its original size. The maximum permitted scale is 1000. 765beyond 10 times its original size. The maximum permitted scale is 1000.
697Special string of B<"auto"> used as a geometry will cause image to be 766Additional operations can be specified after colon B<:op1:op2...>.
698automatically 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
699If used in conjunction with B<-tr> option - specified pixmap will be 778If used in conjunction with B<-tr> option, the specified pixmap will be
700blended over transparency image using either alpha-blending, or any 779blended over transparency image using either alpha-blending, or any
701other blending type, specified with B<-blt "type"> option. 780other blending type, specified with B<-blt "type"> option.
702[default 0x0+50+50]
703 781
704=item B<path:> I<path> 782=item B<path:> I<path>
705 783
706Specify the colon-delimited search path for finding XPM files. 784Specify the colon-delimited search path for finding background image files.
707 785
708=item B<font:> I<fontlist> 786=item B<font:> I<fontlist>
709 787
710Select the fonts to be used. This is a comma separated list of font names 788Select the fonts to be used. This is a comma separated list of font names
711that are checked in order when trying to find glyphs for characters. The 789that are checked in order when trying to find glyphs for characters. The
734it 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
735wide and 15 pixels high. 813wide and 15 pixels high.
736 814
737The 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
738the base font, likewise the third, which is unfortunately non-bold, but 816the base font, likewise the third, which is unfortunately non-bold, but
739the 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
740useful supplement. 818useful supplement.
741 819
742The 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
743are 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
744contains other characters, but we are not interested in them. 822contains other characters, but we are not interested in them.
768text font will being used for the given style. 846text font will being used for the given style.
769 847
770=item B<intensityStyles:> I<boolean> 848=item B<intensityStyles:> I<boolean>
771 849
772When 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>,
773option B<-is>, the default), bold and italic font styles imply high 851option B<-is>, the default), bold/blink font styles imply high
774intensity foreground/background colours. Disabling this option (B<False>, 852intensity foreground/background colours. Disabling this option (B<False>,
775option B<+is>) disables this behaviour, the high intensity colours are not 853option B<+is>) disables this behaviour, the high intensity colours are not
776reachable. 854reachable.
777 855
778=item B<selectstyle:> I<mode>
779
780Set mouse selection style to B<old> which is 2.20, B<oldword> which
781is xterm style with 2.20 old word selection, or anything else which
782gives xterm style selection. Only effective when the original (non-perl)
783selection code is in use.
784
785=item B<scrollstyle:> I<mode>
786
787Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
788the author's favourite.
789
790=item B<title:> I<string> 856=item B<title:> I<string>
791 857
792Set window title string, the default title is the command-line 858Set window title string, the default title is the command-line
793specified after the B<-e> option, if any, otherwise the application 859specified after the B<-e> option, if any, otherwise the application
794name; option B<-title>. 860name; option B<-title>.
807=item B<urgentOnBell:> I<boolean> 873=item B<urgentOnBell:> I<boolean>
808 874
809B<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.
810B<False>: do not set the urgency hint [default]. 876B<False>: do not set the urgency hint [default].
811 877
878@@RXVT_NAME@@ resets the urgency hint on every focus change.
879
812=item B<visualBell:> I<boolean> 880=item B<visualBell:> I<boolean>
813 881
814B<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>.
815B<False>: no visual bell [default]; option B<+vb>. 883B<False>: no visual bell [default]; option B<+vb>.
816 884
838 906
839 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 907 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
840 908
841This 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
842every 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.
843 916
844=item B<scrollBar:> I<boolean> 917=item B<scrollBar:> I<boolean>
845 918
846B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 919B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
847disable the scrollbar; option B<+sb>. 920disable the scrollbar; option B<+sb>.
910=item B<termName:> I<termname> 983=item B<termName:> I<termname>
911 984
912Specifies the terminal type name to be set in the B<TERM> environment 985Specifies the terminal type name to be set in the B<TERM> environment
913variable; option B<-tn>. 986variable; option B<-tn>.
914 987
915=item B<linespace:> I<number> 988=item B<lineSpace:> I<number>
916 989
917Specifies number of lines (pixel height) to insert between each row of 990Specifies number of lines (pixel height) to insert between each row of
918the display [default 0]; option B<-lsp>. 991the display [default 0]; option B<-lsp>.
919 992
920=item B<meta8:> I<boolean> 993=item B<meta8:> I<boolean>
934 1007
935=item B<cursorBlink:> I<boolean> 1008=item B<cursorBlink:> I<boolean>
936 1009
937B<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];
938option B<-bc>. 1011option B<-bc>.
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>.
939 1017
940=item B<pointerBlank:> I<boolean> 1018=item B<pointerBlank:> I<boolean>
941 1019
942B<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
943of seconds of inactivity. B<False>: the pointer is always visible 1021of seconds of inactivity. B<False>: the pointer is always visible
980will 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.
981 1059
982When 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
983be used. If not specified, the built-in default is used: 1061be used. If not specified, the built-in default is used:
984 1062
985B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1063B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
986 1064
987=item B<preeditType:> I<style> 1065=item B<preeditType:> I<style>
988 1066
989B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1067B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
990 1068
1046 1124
1047=item B<secondaryScroll:> I<boolean> 1125=item B<secondaryScroll:> I<boolean>
1048 1126
1049Turn on/off secondary screen scroll (default enabled). If this 1127Turn on/off secondary screen scroll (default enabled). If this
1050option is enabled, scrolls on the secondary screen will change the 1128option is enabled, scrolls on the secondary screen will change the
1051scrollback buffer and switching to/from the secondary screen will 1129scrollback buffer and, when secondaryScreen is off, switching
1052instead scroll the screen up. 1130to/from the secondary screen will instead scroll the screen up.
1053 1131
1054=item B<hold>: I<boolean> 1132=item B<hold>: I<boolean>
1055 1133
1056Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1134Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1057will not immediately destroy its window when the program executed within 1135will not immediately destroy its window when the program executed within
1058it 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
1059user. 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>.
1060 1145
1061=item B<keysym.>I<sym>: I<string> 1146=item B<keysym.>I<sym>: I<string>
1062 1147
1063Compile I<frills>: Associate I<string> with keysym I<sym>. The 1148Compile I<frills>: Associate I<string> with keysym I<sym>. The
1064intervening resource name B<keysym.> cannot be omitted. 1149intervening resource name B<keysym.> cannot be omitted.
1078searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1163searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1079omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1164omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1080keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1165keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1081performed in an exact manner; however, the closest match is assured. 1166performed in an exact manner; however, the closest match is assured.
1082 1167
1083I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1168I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1084C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1169number), see RESOURCES in C<man 7 X> for futher details.
1085C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1086C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1087can start or end with whitespace. B<This feature is deprecated and will
1088be removed>.
1089
1090Please note that you need to double the C<\> in resource files, as
1091Xlib itself does its own de-escaping (you can use C<\033> instead of
1092C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1093processing).
1094 1170
1095You can define a range of keysyms in one shot by providing a I<string> 1171You can define a range of keysyms in one shot by providing a I<string>
1096with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1172with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1097should be a character not used by the strings. 1173should be a character not used by the strings.
1098 1174
1112when Control-Meta-c is being pressed": 1188when Control-Meta-c is being pressed":
1113 1189
1114 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
1115 1191
1116If 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>
1117is 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)
1118manpage. For example, the F<selection> extension (activated via 1194manpage. For example, the F<selection> extension (activated via
1119C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1195C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1120 1196
1121 URxvt.keysym.M-C-c: perl:selection:rot13 1197 URxvt.keysym.M-C-c: perl:selection:rot13
1122 1198
1180all instances, while B<perl-ext> is used for specific instances. 1256all instances, while B<perl-ext> is used for specific instances.
1181 1257
1182=item B<perl-eval>: I<string> 1258=item B<perl-eval>: I<string>
1183 1259
1184Perl code to be evaluated when all extensions have been registered. See 1260Perl code to be evaluated when all extensions have been registered. See
1185the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1261the @@RXVT_NAME@@perl(3) manpage.
1186will be ignored when running setuid/setgid.
1187 1262
1188=item B<perl-lib>: I<path> 1263=item B<perl-lib>: I<path>
1189 1264
1190Colon-separated list of additional directories that hold extension 1265Colon-separated list of additional directories that hold extension
1191scripts. When looking for extensions specified by the C<perl> resource, 1266scripts. When looking for extensions specified by the C<perl> resource,
1192@@RXVT_NAME@@ will first look in these directories and then in 1267@@RXVT_NAME@@ will first look in these directories and then in
1193F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1268F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1194will be ignored when running setuid/setgid.
1195 1269
1196See the @@RXVT_NAME@@perl(3) manpage. 1270See the @@RXVT_NAME@@perl(3) manpage.
1197 1271
1198=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1272=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1199 1273
1221 1295
1222=item B<override-redirect>: I<boolean> 1296=item B<override-redirect>: I<boolean>
1223 1297
1224Compile I<frills>: Sets override-redirect for the terminal window, making 1298Compile I<frills>: Sets override-redirect for the terminal window, making
1225it 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).
1226 1304
1227=item B<iso14755_52:> I<boolean> 1305=item B<iso14755_52:> I<boolean>
1228 1306
1229Turn on/off ISO 14755 5.2 mode (default enabled). 1307Turn on/off ISO 14755 5.2 mode (default enabled).
1230 1308
1305 1383
1306=head1 ISO 14755 SUPPORT 1384=head1 ISO 14755 SUPPORT
1307 1385
1308ISO 14755 is a standard for entering and viewing unicode characters 1386ISO 14755 is a standard for entering and viewing unicode characters
1309and character codes using the keyboard. It consists of 4 parts. The 1387and character codes using the keyboard. It consists of 4 parts. The
1310first part is available rxvt-unicode has been compiled with 1388first part is available if rxvt-unicode has been compiled with
1311C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1389C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1312with C<--enable-iso14755>. 1390with C<--enable-iso14755>.
1313 1391
1314=over 4 1392=over 4
1315 1393
1422Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1500Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1423always swapping the foreground/background colours. This is in contrast to 1501always swapping the foreground/background colours. This is in contrast to
1424I<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
1425been specified. For example, 1503been specified. For example,
1426 1504
1427=over 4
1428
1429=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1505 @@RXVT_NAME@@ -fg Black -bg White -rv
1430 1506
1431would 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
1432on White. 1508White.
1433
1434=back
1435 1509
1436=head2 ALPHA CHANNEL SUPPORT 1510=head2 ALPHA CHANNEL SUPPORT
1437 1511
1438If 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
1439their 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:
1440(recommended, but B<MUST> have 4 digits/component) colour specifications, 1514
1441in 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
1442specifies opacity (alpha) values. The minimum value of C<0> is completely 1526(alpha) values. The minimum value of C<0000> is completely transparent,
1443transparent). You can also prefix any color with C<[percent]>, where 1527while C<ffff> is completely opaque). The two example colours from
1444C<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
1445the color, where C<0> is completely transparent and C<100> is completelxy 1529C<rgba:0000/ff00/0000/f332>.
1446opaque.
1447 1530
1448You 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
1449your 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
1450ARGB 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.
1451 1535
1452For example, the following selects an almost completely transparent red 1536For example, the following selects an almost completely transparent black
1453background, and an almost opaque pink foreground: 1537background, and an almost opaque pink foreground:
1454 1538
1455 @@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"
1456 1540
1457I<Please note that transparency of any kind if completely unsupported by 1541When not using a background image, then the interpretation of the
1458the 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.
1459 1555
1460=head1 ENVIRONMENT 1556=head1 ENVIRONMENT
1461 1557
1462B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1558B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1463 1559
1469resources or on the command line. 1565resources or on the command line.
1470 1566
1471=item B<COLORTERM> 1567=item B<COLORTERM>
1472 1568
1473Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1569Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1474compiled with XPM support, and optionally with the added extension 1570compiled with background image support, and optionally with the added
1475C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1571extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1572screen.
1476 1573
1477=item B<COLORFGBG> 1574=item B<COLORFGBG>
1478 1575
1479Set 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
1480the colour code used as default foreground/text colour (or the string 1577the colour code used as default foreground/text colour (or the string
1481C<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
1482used), 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
1483string 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@@
1484was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1581was compiled with background image support. Libraries like C<ncurses>
1485(and do) use this information to optimize screen output. 1582and C<slang> can (and do) use this information to optimize screen output.
1486 1583
1487=item B<WINDOWID> 1584=item B<WINDOWID>
1488 1585
1489Set 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
1490window, which usually has subwindows for the scrollbar, the terminal 1587window, which usually has subwindows for the scrollbar, the terminal
1496C<--with-terminfo=PATH>. 1593C<--with-terminfo=PATH>.
1497 1594
1498=item B<DISPLAY> 1595=item B<DISPLAY>
1499 1596
1500Used 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
1501display 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.
1502 1600
1503=item B<SHELL> 1601=item B<SHELL>
1504 1602
1505The 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>.
1506 1604
1581Project Coordinator (changes.txt 2.21a to 2.4.5) 1679Project Coordinator (changes.txt 2.21a to 2.4.5)
1582 1680
1583=item Geoff Wing L<< <gcw@pobox.com> >> 1681=item Geoff Wing L<< <gcw@pobox.com> >>
1584 1682
1585Rewrote screen display and text selection routines. 1683Rewrote screen display and text selection routines.
1586 1684
1587Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1685Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1588 1686
1589=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1687=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1590 1688
1591Forked 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