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.125 by root, Fri Jan 19 23:45:03 2007 UTC vs.
Revision 1.168 by root, Tue Nov 4 11:03:29 2008 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very user friendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>. 104resource B<depth>.
102 105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
103=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
104 112
105Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
106 114
107=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
108 116
109Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
110 118
111=item B<-j>|B<+j> 119=item B<-j>|B<+j>
112 120
113Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 122
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
116 124
117Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119 126
120I<Please note that transparency of any kind if completely unsupported by 127=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions! Read the FAQ (man 7 128
122@@RXVT_NAME@@)!> 129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123 136
124=item B<-fade> I<number> 137=item B<-fade> I<number>
125 138
126Fade the text by the given percentage when focus is lost. Small values 139Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
133is opaque black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
134 147
135=item B<-tint> I<colour> 148=item B<-tint> I<colour>
136 149
137Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
140used to brighten or darken the image in addition to tinting it; resource 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
141I<tintColor>. Example: 158I<tintColor>. Example:
142 159
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 161
145=item B<-sh> 162=item B<-sh> I<number>
146 163
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>); resource I<shading>. 166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
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
191appliation window; resource I<iconFile>.
150 192
151=item B<-bg> I<colour> 193=item B<-bg> I<colour>
152 194
153Window background colour; resource B<background>. 195Window background colour; resource B<background>.
154 196
155=item B<-fg> I<colour> 197=item B<-fg> I<colour>
156 198
157Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
158 200
159=item B<-pixmap> I<file[;geom]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160 202
161Compile I<XPM>: Specify XPM file for the background and also optionally 203Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 204optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 205add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
165 207
166=item B<-cr> I<colour> 208=item B<-cr> I<colour>
167 209
168The cursor colour; resource B<cursorColor>. 210The cursor colour; resource B<cursorColor>.
169 211
214italic> >> characters are to be printed. See resource B<boldItalicFont> 256italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details. 257for details.
216 258
217=item B<-is>|B<+is> 259=item B<-is>|B<+is>
218 260
219Compile I<font-styles>: Bold/Italic font styles imply high intensity 261Compile I<font-styles>: Bold/Blink font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for 262foreground/background (default). See resource B<intensityStyles> for
221details. 263details.
222 264
223=item B<-name> I<name> 265=item B<-name> I<name>
224 266
242 284
243=item B<-sb>|B<+sb> 285=item B<-sb>|B<+sb>
244 286
245Turn on/off scrollbar; resource B<scrollBar>. 287Turn on/off scrollbar; resource B<scrollBar>.
246 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
247=item B<-si>|B<+si> 298=item B<-si>|B<+si>
248 299
249Turn on/off scroll-to-bottom on TTY output inhibit; resource 300Turn on/off scroll-to-bottom on TTY output inhibit; resource
250B<scrollTtyOutput> has opposite effect. 301B<scrollTtyOutput> has opposite effect.
251 302
257=item B<-sw>|B<+sw> 308=item B<-sw>|B<+sw>
258 309
259Turn on/off scrolling with the scrollback buffer as new lines appear. 310Turn on/off scrolling with the scrollback buffer as new lines appear.
260This only takes effect if B<-si> is also given; resource 311This only takes effect if B<-si> is also given; resource
261B<scrollWithBuffer>. 312B<scrollWithBuffer>.
262
263=item B<-sr>|B<+sr>
264
265Put scrollbar on right/left; resource B<scrollBar_right>.
266
267=item B<-st>|B<+st>
268
269Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270resource B<scrollBar_floating>.
271 313
272=item B<-ptab>|B<+ptab> 314=item B<-ptab>|B<+ptab>
273 315
274If enabled (default), "Horizontal Tab" characters are being stored as 316If enabled (default), "Horizontal Tab" characters are being stored as
275actual wide characters in the screen buffer, which makes it possible to 317actual wide characters in the screen buffer, which makes it possible to
304 346
305=item B<-bl> 347=item B<-bl>
306 348
307Compile I<frills>: Set MWM hints to request a borderless window, i.e. 349Compile I<frills>: Set MWM hints to request a borderless window, i.e.
308if honoured by the WM, the rxvt-unicode window will not have window 350if honoured by the WM, the rxvt-unicode window will not have window
309decorations; resource B<borderLess>. 351decorations; resource B<borderLess>. If the window manager does not
352support MWM hints (e.g. kwin), enables override-redirect mode.
310 353
311=item B<-override-redirect> 354=item B<-override-redirect>
312 355
313Compile I<frills>: Sets override-redirect on the window; resource 356Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>. 357B<override-redirect>.
322 365
323=item B<-lsp> I<number> 366=item B<-lsp> I<number>
324 367
325Compile I<frills>: Lines (pixel height) to insert between each row of 368Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 369the display. Useful to work around font rendering problems; resource
327B<linespace>. 370B<lineSpace>.
328 371
329=item B<-tn> I<termname> 372=item B<-tn> I<termname>
330 373
331This option specifies the name of the terminal type to be set in the 374This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 375B<TERM> environment variable. This terminal type must exist in the
386for more info. 429for more info.
387 430
388=item B<-tcw> 431=item B<-tcw>
389 432
390Change the meaning of triple-click selection with the left mouse 433Change the meaning of triple-click selection with the left mouse
434button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 435in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 436the end of the logical line only. resource B<tripleclickwords>.
393 437
394=item B<-insecure> 438=item B<-insecure>
395 439
396Enable "insecure" mode, which currently enables most of the escape 440Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 441sequences that echo strings. See the resource B<insecure> for more
417 461
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 462Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 463will not immediately destroy its window when the program executed within
420it exits. Instead, it will wait till it is being killed or closed by the 464it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 465user; resource B<hold>.
466
467=item B<-cd> I<path>
468
469Sets the working directory for the shell (or the command specified via
470B<-e>). The I<path> must be an absolute path and it must exist for
471@@RXVT_NAME@@ to start; resource B<chdir>.
472
473=item B<-xrm> I<string>
474
475Works like the X Toolkit option of the same name, by adding the I<string>
476as if it were specified in a resource file. Resource values specified this
477way take precedence over all other resource specifications.
478
479Note that you need to use the I<same> syntax as in the .Xdefaults file,
480e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
481options can be specified as long-options on the commandline, so use
482of B<-xrm> is mostly limited to cases where you want to specify other
483resources (e.g. for input methods) or for compatibility with other
484programs.
422 485
423=item B<-keysym.>I<sym> I<string> 486=item B<-keysym.>I<sym> I<string>
424 487
425Remap a key symbol. See resource B<keysym>. 488Remap a key symbol. See resource B<keysym>.
426 489
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 524If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462entries and will not tinker with pty/tty permissions - you have to do that 525entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 526yourself if you want that.
464 527
465As an extremely special case, specifying C<-1> will completely suppress 528As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 529pty/tty operations, which is probably only useful in conjunction with some
530perl extension that manages the terminal.
467 531
468Here is a example in perl that illustrates how this option can be used (a 532Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 533longer example is in F<doc/pty-fd>):
470 534
471 use IO::Pty; 535 use IO::Pty;
485Comma-separated list of perl extension scripts to use (or not to use) in 549Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 550this terminal instance. See resource B<perl-ext> for details.
487 551
488=back 552=back
489 553
490=head1 RESOURCES (available also as long-options) 554=head1 RESOURCES
491 555
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 556Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 557options) compiled into your version. All resources are also available as
558long-options.
494 559
495You can set and change the resources using X11 tools like B<xrdb>. Many 560You can set and change the resources using X11 tools like B<xrdb>. Many
496distribution do also load settings from the B<~/.Xresources> file when X 561distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 562starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 563with later settings overwriting earlier ones:
500 1. system-wide app-defaults file, either locale-dependent OR global 565 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 566 2. app-defaults file in $XAPPLRESDIR
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 567 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503 4. SCREEN_RESOURCES for the current screen 568 4. SCREEN_RESOURCES for the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 569 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
570 6. resources specified via -xrm on the commandline
505 571
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 572Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 573names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 574common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 575configured, while the class name B<URxvt> allows resources unique to
519=item B<depth:> I<bitdepth> 585=item B<depth:> I<bitdepth>
520 586
521Compile I<xft>: Attempt to find a visual with the given bit depth; 587Compile I<xft>: Attempt to find a visual with the given bit depth;
522option B<-depth>. 588option B<-depth>.
523 589
590=item B<buffered:> I<boolean>
591
592Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
593On some card/driver combination enabling it slightly decreases
594performance, on most it greatly helps it. The slowdown is small, so it
595should normally be enabled.
596
524=item B<geometry:> I<geom> 597=item B<geometry:> I<geom>
525 598
526Create the window with the specified X window geometry [default 80x24]; 599Create the window with the specified X window geometry [default 80x24];
527option B<-geometry>. 600option B<-geometry>.
528 601
591option B<-rv>. B<False>: regular screen colours [default]; option 664option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 665B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 666
594=item B<jumpScroll:> I<boolean> 667=item B<jumpScroll:> I<boolean>
595 668
596B<True>: specify that jump scrolling should be used. When scrolling 669B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 670of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
671has been read, resulting in fewer updates while still displaying every
672received line; option B<-j>.
673
598B<False>: specify that smooth scrolling should be used; option B<+j>. 674B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
675force a screen refresh on each new line it received; option B<+j>.
599 676
600=item B<inheritPixmap:> I<boolean> 677=item B<skipScroll:> I<boolean>
601 678
602B<True>: make the background inherit the parent windows' pixmap, giving 679B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 680receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 681(around 60 times per second), resulting in far fewer updates. This can
682result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
683option B<-ss>.
605 684
606I<Please note that transparency of any kind if completely unsupported by 685B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 686if the refresh is too fast for the human eye to read anything (or the
687monitor to display anything); option B<+ss>.
688
689=item B<transparent:> I<boolean>
690
691Turn on/off illusion of a transparent window background.
692
693B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
694future versions.
695
696I<Please address all transparency related issues to Sasha Vasko at
697sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
608 698
609=item B<fading:> I<number> 699=item B<fading:> I<number>
610 700
611Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
612 702
623=item B<shading:> I<number> 713=item B<shading:> I<number>
624 714
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 715Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626in addition to tinting it; option B<-sh>. 716in addition to tinting it; option B<-sh>.
627 717
718=item B<blendType:> I<string>
719
720Specify background blending type; option B<-blt>.
721
722=item B<blurRadius:> I<number>
723
724Apply gaussian blur with the specified radius to the transparent
725background image; option B<-blr>.
726
727=item B<iconFile:> I<file>
728
729Set the application icon pixmap; option B<-icon>.
730
628=item B<scrollColor:> I<colour> 731=item B<scrollColor:> I<colour>
629 732
630Use the specified colour for the scrollbar [default #B2B2B2]. 733Use the specified colour for the scrollbar [default #B2B2B2].
631 734
632=item B<troughColor:> I<colour> 735=item B<troughColor:> I<colour>
637=item B<borderColor:> I<colour> 740=item B<borderColor:> I<colour>
638 741
639The colour of the border around the text area and between the scrollbar 742The colour of the border around the text area and between the scrollbar
640and the text. 743and the text.
641 744
642=item B<backgroundPixmap:> I<file[;geom]> 745=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643 746
644Use the specified XPM file (note the `.xpm' extension is optional) for 747Use the specified image file for the background and also
645the background and also optionally specify its scaling with a geometry 748optionally specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 749(default C<0x0+50+50>) in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 750horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale 751centre (percent). A scale of 0 displays the image with tiling. A scale
649of 1 displays the image without any scaling. A scale of 2 to 9 752of 1 displays the image without any scaling. A scale of 2 to 9 specifies
650specifies an integer number of images in that direction. No image will 753an integer number of images in that direction. No image will be magnified
651be magnified beyond 10 times its original size. The maximum permitted 754beyond 10 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 755Additional operations can be specified after colon B<:op1:op2...>.
756Supported operations are:
757
758 tile force background image to be tiled and not scaled. Equivalent to 0x0
759 propscale will scale image keeping proportions
760 auto will scale image to match window size. Equivalent to 100x100
761 hscale will scale image horizontally to the window size
762 vscale will scale image vertically to the window size
763 scale will scale image to match window size
764 root will tile image as if it was a root window background, auto-adjusting
765 whenever terminal window moves
766
767If used in conjunction with B<-tr> option, the specified pixmap will be
768blended over transparency image using either alpha-blending, or any
769other blending type, specified with B<-blt "type"> option.
653 770
654=item B<path:> I<path> 771=item B<path:> I<path>
655 772
656Specify the colon-delimited search path for finding XPM files. 773Specify the colon-delimited search path for finding background image files.
657 774
658=item B<font:> I<fontlist> 775=item B<font:> I<fontlist>
659 776
660Select the fonts to be used. This is a comma separated list of font names 777Select the fonts to be used. This is a comma separated list of font names
661that are checked in order when trying to find glyphs for characters. The 778that are checked in order when trying to find glyphs for characters. The
718text font will being used for the given style. 835text font will being used for the given style.
719 836
720=item B<intensityStyles:> I<boolean> 837=item B<intensityStyles:> I<boolean>
721 838
722When font styles are not enabled, or this option is enabled (B<True>, 839When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 840option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 841intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 842option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 843reachable.
727 844
728=item B<selectstyle:> I<mode>
729
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731xterm style with 2.20 old word selection, or anything else which gives
732xterm style selection.
733
734=item B<scrollstyle:> I<mode>
735
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite.
738
739=item B<title:> I<string> 845=item B<title:> I<string>
740 846
741Set window title string, the default title is the command-line 847Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 848specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 849name; option B<-title>.
751=item B<mapAlert:> I<boolean> 857=item B<mapAlert:> I<boolean>
752 858
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 859B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 860de-iconify (map) on receipt of a bell character [default].
755 861
862=item B<urgentOnBell:> I<boolean>
863
864B<True>: set the urgency hint for the wm on receipt of a bell character.
865B<False>: do not set the urgency hint [default].
866
867@@RXVT_NAME@@ resets the urgency hint on every focus change.
868
756=item B<visualBell:> I<boolean> 869=item B<visualBell:> I<boolean>
757 870
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 871B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 872B<False>: no visual bell [default]; option B<+vb>.
760 873
782 895
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 896 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 897
785This creates a new file in your home directory with the screen contents 898This creates a new file in your home directory with the screen contents
786every time you hit C<Print>. 899every time you hit C<Print>.
900
901=item B<scrollstyle:> I<mode>
902
903Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
904the author's favourite.
787 905
788=item B<scrollBar:> I<boolean> 906=item B<scrollBar:> I<boolean>
789 907
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 908B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 909disable the scrollbar; option B<+sb>.
854=item B<termName:> I<termname> 972=item B<termName:> I<termname>
855 973
856Specifies the terminal type name to be set in the B<TERM> environment 974Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 975variable; option B<-tn>.
858 976
859=item B<linespace:> I<number> 977=item B<lineSpace:> I<number>
860 978
861Specifies number of lines (pixel height) to insert between each row of 979Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 980the display [default 0]; option B<-lsp>.
863 981
864=item B<meta8:> I<boolean> 982=item B<meta8:> I<boolean>
916=item B<cutchars:> I<string> 1034=item B<cutchars:> I<string>
917 1035
918The characters used as delimiters for double-click word selection 1036The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 1037(whitespace delimiting is added automatically if resource is given).
920 1038
921When the selection extension is in use (the default if compiled in, see 1039When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1040in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 1041characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 1042will be created). In this mode, characters outside ISO-8859-1 can be used.
925 1043
926When the selection extension is not used, only ISO-8859-1 characters can 1044When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 1045be used. If not specified, the built-in default is used:
928 1046
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1047B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 1048
931=item B<preeditType:> I<style> 1049=item B<preeditType:> I<style>
932 1050
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1051B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 1052
988 1106
989Turn on/off secondary screen (default enabled). 1107Turn on/off secondary screen (default enabled).
990 1108
991=item B<secondaryScroll:> I<boolean> 1109=item B<secondaryScroll:> I<boolean>
992 1110
993Turn on/off secondary screen scroll (default enabled). If the this 1111Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1112option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1113scrollback buffer and, when secondaryScreen is off, switching
996instead scroll the screen up. 1114to/from the secondary screen will instead scroll the screen up.
997 1115
998=item B<hold>: I<boolean> 1116=item B<hold>: I<boolean>
999 1117
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1118Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within 1119will not immediately destroy its window when the program executed within
1002it exits. Instead, it will wait till it is being killed or closed by the 1120it exits. Instead, it will wait till it is being killed or closed by the
1003user. 1121user.
1122
1123=item B<chdir>: I<path>
1124
1125Sets the working directory for the shell (or the command specified via
1126B<-e>). The I<path> must be an absolute path and it must exist for
1127@@RXVT_NAME@@ to start. If it isn't specified then the current working
1128directory will be used; option B<-cd>.
1004 1129
1005=item B<keysym.>I<sym>: I<string> 1130=item B<keysym.>I<sym>: I<string>
1006 1131
1007Compile I<frills>: Associate I<string> with keysym I<sym>. The 1132Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008intervening resource name B<keysym.> cannot be omitted. 1133intervening resource name B<keysym.> cannot be omitted.
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1147searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1023omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1148omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1024keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1149keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1025performed in an exact manner; however, the closest match is assured. 1150performed in an exact manner; however, the closest match is assured.
1026 1151
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1152I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1153number), see RESOURCES in C<man 7 X> for futher details.
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031can start or end with whitespace. B<This feature is deprecated and will
1032be removed>.
1033
1034Please note that you need to double the C<\> in resource files, as
1035Xlib itself does its own de-escaping (you can use C<\033> instead of
1036C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1037processing).
1038 1154
1039You can define a range of keysyms in one shot by providing a I<string> 1155You can define a range of keysyms in one shot by providing a I<string>
1040with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1156with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1041should be a character not used by the strings. 1157should be a character not used by the strings.
1042 1158
1124all instances, while B<perl-ext> is used for specific instances. 1240all instances, while B<perl-ext> is used for specific instances.
1125 1241
1126=item B<perl-eval>: I<string> 1242=item B<perl-eval>: I<string>
1127 1243
1128Perl code to be evaluated when all extensions have been registered. See 1244Perl code to be evaluated when all extensions have been registered. See
1129the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1245the @@RXVT_NAME@@perl(3) manpage.
1130will be ignored when running setuid/setgid.
1131 1246
1132=item B<perl-lib>: I<path> 1247=item B<perl-lib>: I<path>
1133 1248
1134Colon-separated list of additional directories that hold extension 1249Colon-separated list of additional directories that hold extension
1135scripts. When looking for extensions specified by the C<perl> resource, 1250scripts. When looking for extensions specified by the C<perl> resource,
1136@@RXVT_NAME@@ will first look in these directories and then in 1251@@RXVT_NAME@@ will first look in these directories and then in
1137F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1252F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1138will be ignored when running setuid/setgid.
1139 1253
1140See the @@RXVT_NAME@@perl(3) manpage. 1254See the @@RXVT_NAME@@perl(3) manpage.
1141 1255
1142=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1256=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1143 1257
1165 1279
1166=item B<override-redirect>: I<boolean> 1280=item B<override-redirect>: I<boolean>
1167 1281
1168Compile I<frills>: Sets override-redirect for the terminal window, making 1282Compile I<frills>: Sets override-redirect for the terminal window, making
1169it almost invisible to window managers; option B<-override-redirect>. 1283it almost invisible to window managers; option B<-override-redirect>.
1284
1285=item B<iso14755_52:> I<boolean>
1286
1287Turn on/off ISO 14755 5.2 mode (default enabled).
1170 1288
1171=back 1289=back
1172 1290
1173=head1 THE SCROLLBAR 1291=head1 THE SCROLLBAR
1174 1292
1193application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1311application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1194(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1312(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1195up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1313up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1196respectively. 1314respectively.
1197 1315
1198=head1 TEXT SELECTION AND INSERTION 1316=head1 THE SELECTION: SELECTING AND PASTING TEXT
1199 1317
1200The behaviour of text selection and insertion mechanism is similar to 1318The behaviour of text selection and insertion/pasting mechanism is similar
1201I<xterm>(1). 1319to I<xterm>(1).
1202 1320
1203=over 4 1321=over 4
1204 1322
1205=item B<Selection>: 1323=item B<Selecting>:
1206 1324
1207Left click at the beginning of the region, drag to the end of the region 1325Left click at the beginning of the region, drag to the end of the region
1208and release; Right click to extend the marked region; Left double-click 1326and release; Right click to extend the marked region; Left double-click
1209to select a word; Left triple-click to select the entire logical line 1327to select a word; Left triple-click to select the entire logical line
1210(which can span multiple screen lines), unless modified by resource 1328(which can span multiple screen lines), unless modified by resource
1214(Compile: I<frills>) will create a rectangular selection instead of a 1332(Compile: I<frills>) will create a rectangular selection instead of a
1215normal one. In this mode, every selected row becomes its own line in the 1333normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from 1334selection, and trailing whitespace is visually underlined and removed from
1217the selection. 1335the selection.
1218 1336
1219=item B<Insertion>: 1337=item B<Pasting>:
1220 1338
1221Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1339Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1222window causes the value of the PRIMARY selection (or CLIPBOARD with the 1340window causes the value of the PRIMARY selection (or CLIPBOARD with the
1223Meta modifier) to be inserted as if it had been typed on the keyboard. 1341B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1224 1342
1225Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1343Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1226inserted too. 1344inserted too.
1227 1345
1228=back 1346=back
1245 1363
1246=head1 ISO 14755 SUPPORT 1364=head1 ISO 14755 SUPPORT
1247 1365
1248ISO 14755 is a standard for entering and viewing unicode characters 1366ISO 14755 is a standard for entering and viewing unicode characters
1249and character codes using the keyboard. It consists of 4 parts. The 1367and character codes using the keyboard. It consists of 4 parts. The
1250first part is available rxvt-unicode has been compiled with 1368first part is available if rxvt-unicode has been compiled with
1251C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1369C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1252with C<--enable-iso14755>. 1370with C<--enable-iso14755>.
1253 1371
1254=over 4 1372=over 4
1255 1373
1374=back 1492=back
1375 1493
1376=head2 ALPHA CHANNEL SUPPORT 1494=head2 ALPHA CHANNEL SUPPORT
1377 1495
1378If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1496If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1379their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1497their act together, rxvt-unicode will do it's own alpha channel management:
1380(recommended, but B<MUST> have 4 digits/component) colour specifications, 1498
1381in addition to the ones provided by X, where the additional A component 1499You can prefix any color with an opaquenes percentage enclosed in
1500brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1501(0-100) that specifies the opacity of the color, where C<0> is completely
1502transparent and C<100> is completely opaque. For example, C<[50]red> is a
1503half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1504is the recommended format to specify transparency values, and works with
1505all ways to specify a colour.
1506
1507For complete control, rxvt-unicode also supports
1508C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1509specifications, where the additional C<aaaa> component specifies opacity
1382specifies opacity (alpha) values. The minimum value of C<0> is completely 1510(alpha) values. The minimum value of C<0000> is completely transparent,
1383transparent). You can also prefix any color with C<[percent]>, where 1511while C<ffff> is completely opaque). The two example colours from
1384C<percent> is a decimal percentage (0-100) that specifies the opacity of 1512earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1385the color, where C<0> is completely transparent and C<100> is completelxy 1513C<rgba:0000/ff00/0000/f332>.
1386opaque.
1387 1514
1388You probably need to specify B<"-depth 32">, too, and have the luck that 1515You probably need to specify B<"-depth 32">, too, to force a visual with
1389your X-server uses ARGB pixel layout, as X is far from just supporting 1516alpha channels, and have the luck that your X-server uses ARGB pixel
1390ARGB visuals out of the box, and rxvt-unicode just fudges around. 1517layout, as X is far from just supporting ARGB visuals out of the box, and
1518rxvt-unicode just fudges around.
1391 1519
1392For example, the following selects an almost completely transparent red 1520For example, the following selects an almost completely transparent black
1393background, and an almost opaque pink foreground: 1521background, and an almost opaque pink foreground:
1394 1522
1395 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1523 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1396 1524
1397I<Please note that transparency of any kind if completely unsupported by 1525When not using a background image, then the interpretation of the
1398the author. Don't bug him with installation questions!> 1526alpha channel is up to your compositing manager (most interpret it as
1527transparency of course).
1528
1529When using a background pixmap or pseudo-transparency, then the background
1530colour will always behave as if it were completely transparent (so the
1531background image shows instead), regardless of how it was specified, while
1532other colours will either be transparent as specified (the background
1533image will show through) on servers supporting the RENDER extension, or
1534fully opaque on servers not supporting the RENDER EXTENSION.
1535
1536Please note that due to bugs in Xft, specifying alpha values might result
1537in garbage being displayed when the X-server does not support the RENDER
1538extension.
1399 1539
1400=head1 ENVIRONMENT 1540=head1 ENVIRONMENT
1401 1541
1402B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1542B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1403 1543
1409resources or on the command line. 1549resources or on the command line.
1410 1550
1411=item B<COLORTERM> 1551=item B<COLORTERM>
1412 1552
1413Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1553Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1414compiled with XPM support, and optionally with the added extension 1554compiled with background image support, and optionally with the added
1415C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1555extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1556screen.
1416 1557
1417=item B<COLORFGBG> 1558=item B<COLORFGBG>
1418 1559
1419Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1560Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1420the colour code used as default foreground/text colour (or the string 1561the colour code used as default foreground/text colour (or the string
1421C<default> to indicate that the default-colour escape sequence is to be 1562C<default> to indicate that the default-colour escape sequence is to be
1422used), C<bg> is the colour code used as default background colour (or the 1563used), C<bg> is the colour code used as default background colour (or the
1423string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1564string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1424was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1565was compiled with background image support. Libraries like C<ncurses>
1425(and do) use this information to optimize screen output. 1566and C<slang> can (and do) use this information to optimize screen output.
1426 1567
1427=item B<WINDOWID> 1568=item B<WINDOWID>
1428 1569
1429Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1570Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1430window, which usually has subwindows for the scrollbar, the terminal 1571window, which usually has subwindows for the scrollbar, the terminal
1436C<--with-terminfo=PATH>. 1577C<--with-terminfo=PATH>.
1437 1578
1438=item B<DISPLAY> 1579=item B<DISPLAY>
1439 1580
1440Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1581Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1441display in its child processes. 1582display in its child processes if C<-display> isn't used to override. It
1583defaults to C<:0> if it doesn't exist.
1442 1584
1443=item B<SHELL> 1585=item B<SHELL>
1444 1586
1445The shell to be used for command execution, defaults to C</bin/sh>. 1587The shell to be used for command execution, defaults to C</bin/sh>.
1446 1588
1521Project Coordinator (changes.txt 2.21a to 2.4.5) 1663Project Coordinator (changes.txt 2.21a to 2.4.5)
1522 1664
1523=item Geoff Wing L<< <gcw@pobox.com> >> 1665=item Geoff Wing L<< <gcw@pobox.com> >>
1524 1666
1525Rewrote screen display and text selection routines. 1667Rewrote screen display and text selection routines.
1526 1668
1527Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1669Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1528 1670
1529=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1671=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1530 1672
1531Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1673Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines