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.170 by root, Sat May 30 08:51:23 2009 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
191application 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>.
371
372=item B<-letsp> I<number>
373
374Compile I<frills>: Amount to adjust the computed character width by
375to control overall letter spacing. Negative values will tighten up the
376letter spacing, positive values will space letters out more. Useful to
377work around odd font metrics; resource B<letterSpace>.
328 378
329=item B<-tn> I<termname> 379=item B<-tn> I<termname>
330 380
331This option specifies the name of the terminal type to be set in the 381This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 382B<TERM> environment variable. This terminal type must exist in the
386for more info. 436for more info.
387 437
388=item B<-tcw> 438=item B<-tcw>
389 439
390Change the meaning of triple-click selection with the left mouse 440Change the meaning of triple-click selection with the left mouse
441button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 442in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 443the end of the logical line only. resource B<tripleclickwords>.
393 444
394=item B<-insecure> 445=item B<-insecure>
395 446
396Enable "insecure" mode, which currently enables most of the escape 447Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 448sequences that echo strings. See the resource B<insecure> for more
417 468
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 469Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 470will 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 471it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 472user; resource B<hold>.
473
474=item B<-cd> I<path>
475
476Sets the working directory for the shell (or the command specified via
477B<-e>). The I<path> must be an absolute path and it must exist for
478@@RXVT_NAME@@ to start; resource B<chdir>.
479
480=item B<-xrm> I<string>
481
482Works like the X Toolkit option of the same name, by adding the I<string>
483as if it were specified in a resource file. Resource values specified this
484way take precedence over all other resource specifications.
485
486Note that you need to use the I<same> syntax as in the .Xdefaults file,
487e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
488options can be specified as long-options on the commandline, so use
489of B<-xrm> is mostly limited to cases where you want to specify other
490resources (e.g. for input methods) or for compatibility with other
491programs.
422 492
423=item B<-keysym.>I<sym> I<string> 493=item B<-keysym.>I<sym> I<string>
424 494
425Remap a key symbol. See resource B<keysym>. 495Remap a key symbol. See resource B<keysym>.
426 496
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 531If 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 532entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 533yourself if you want that.
464 534
465As an extremely special case, specifying C<-1> will completely suppress 535As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 536pty/tty operations, which is probably only useful in conjunction with some
537perl extension that manages the terminal.
467 538
468Here is a example in perl that illustrates how this option can be used (a 539Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 540longer example is in F<doc/pty-fd>):
470 541
471 use IO::Pty; 542 use IO::Pty;
485Comma-separated list of perl extension scripts to use (or not to use) in 556Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 557this terminal instance. See resource B<perl-ext> for details.
487 558
488=back 559=back
489 560
490=head1 RESOURCES (available also as long-options) 561=head1 RESOURCES
491 562
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 563Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 564options) compiled into your version. All resources are also available as
565long-options.
494 566
495You can set and change the resources using X11 tools like B<xrdb>. Many 567You 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 568distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 569starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 570with later settings overwriting earlier ones:
500 1. system-wide app-defaults file, either locale-dependent OR global 572 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 573 2. app-defaults file in $XAPPLRESDIR
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 574 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503 4. SCREEN_RESOURCES for the current screen 575 4. SCREEN_RESOURCES for the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 576 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
577 6. resources specified via -xrm on the commandline
505 578
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 579Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 580names: 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 581common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 582configured, while the class name B<URxvt> allows resources unique to
519=item B<depth:> I<bitdepth> 592=item B<depth:> I<bitdepth>
520 593
521Compile I<xft>: Attempt to find a visual with the given bit depth; 594Compile I<xft>: Attempt to find a visual with the given bit depth;
522option B<-depth>. 595option B<-depth>.
523 596
597=item B<buffered:> I<boolean>
598
599Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
600On some card/driver combination enabling it slightly decreases
601performance, on most it greatly helps it. The slowdown is small, so it
602should normally be enabled.
603
524=item B<geometry:> I<geom> 604=item B<geometry:> I<geom>
525 605
526Create the window with the specified X window geometry [default 80x24]; 606Create the window with the specified X window geometry [default 80x24];
527option B<-geometry>. 607option B<-geometry>.
528 608
591option B<-rv>. B<False>: regular screen colours [default]; option 671option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 672B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 673
594=item B<jumpScroll:> I<boolean> 674=item B<jumpScroll:> I<boolean>
595 675
596B<True>: specify that jump scrolling should be used. When scrolling 676B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 677of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
678has been read, resulting in fewer updates while still displaying every
679received line; option B<-j>.
680
598B<False>: specify that smooth scrolling should be used; option B<+j>. 681B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
682force a screen refresh on each new line it received; option B<+j>.
599 683
600=item B<inheritPixmap:> I<boolean> 684=item B<skipScroll:> I<boolean>
601 685
602B<True>: make the background inherit the parent windows' pixmap, giving 686B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 687receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 688(around 60 times per second), resulting in far fewer updates. This can
689result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
690option B<-ss>.
605 691
606I<Please note that transparency of any kind if completely unsupported by 692B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 693if the refresh is too fast for the human eye to read anything (or the
694monitor to display anything); option B<+ss>.
695
696=item B<transparent:> I<boolean>
697
698Turn on/off illusion of a transparent window background.
699
700B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
701future versions.
702
703I<Please address all transparency related issues to Sasha Vasko at
704sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
608 705
609=item B<fading:> I<number> 706=item B<fading:> I<number>
610 707
611Fade the text by the given percentage when focus is lost; option B<-fade>. 708Fade the text by the given percentage when focus is lost; option B<-fade>.
612 709
623=item B<shading:> I<number> 720=item B<shading:> I<number>
624 721
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 722Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626in addition to tinting it; option B<-sh>. 723in addition to tinting it; option B<-sh>.
627 724
725=item B<blendType:> I<string>
726
727Specify background blending type; option B<-blt>.
728
729=item B<blurRadius:> I<number>
730
731Apply gaussian blur with the specified radius to the transparent
732background image; option B<-blr>.
733
734=item B<iconFile:> I<file>
735
736Set the application icon pixmap; option B<-icon>.
737
628=item B<scrollColor:> I<colour> 738=item B<scrollColor:> I<colour>
629 739
630Use the specified colour for the scrollbar [default #B2B2B2]. 740Use the specified colour for the scrollbar [default #B2B2B2].
631 741
632=item B<troughColor:> I<colour> 742=item B<troughColor:> I<colour>
637=item B<borderColor:> I<colour> 747=item B<borderColor:> I<colour>
638 748
639The colour of the border around the text area and between the scrollbar 749The colour of the border around the text area and between the scrollbar
640and the text. 750and the text.
641 751
642=item B<backgroundPixmap:> I<file[;geom]> 752=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643 753
644Use the specified XPM file (note the `.xpm' extension is optional) for 754Use the specified image file for the background and also
645the background and also optionally specify its scaling with a geometry 755optionally specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 756(default C<0x0+50+50>) in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 757horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale 758centre (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 759of 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 760an integer number of images in that direction. No image will be magnified
651be magnified beyond 10 times its original size. The maximum permitted 761beyond 10 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 762Additional operations can be specified after colon B<:op1:op2...>.
763Supported operations are:
764
765 tile force background image to be tiled and not scaled. Equivalent to 0x0
766 propscale will scale image keeping proportions
767 auto will scale image to match window size. Equivalent to 100x100
768 hscale will scale image horizontally to the window size
769 vscale will scale image vertically to the window size
770 scale will scale image to match window size
771 root will tile image as if it was a root window background, auto-adjusting
772 whenever terminal window moves
773
774If used in conjunction with B<-tr> option, the specified pixmap will be
775blended over transparency image using either alpha-blending, or any
776other blending type, specified with B<-blt "type"> option.
653 777
654=item B<path:> I<path> 778=item B<path:> I<path>
655 779
656Specify the colon-delimited search path for finding XPM files. 780Specify the colon-delimited search path for finding background image files.
657 781
658=item B<font:> I<fontlist> 782=item B<font:> I<fontlist>
659 783
660Select the fonts to be used. This is a comma separated list of font names 784Select 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 785that are checked in order when trying to find glyphs for characters. The
718text font will being used for the given style. 842text font will being used for the given style.
719 843
720=item B<intensityStyles:> I<boolean> 844=item B<intensityStyles:> I<boolean>
721 845
722When font styles are not enabled, or this option is enabled (B<True>, 846When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 847option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 848intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 849option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 850reachable.
727 851
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> 852=item B<title:> I<string>
740 853
741Set window title string, the default title is the command-line 854Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 855specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 856name; option B<-title>.
751=item B<mapAlert:> I<boolean> 864=item B<mapAlert:> I<boolean>
752 865
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 866B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 867de-iconify (map) on receipt of a bell character [default].
755 868
869=item B<urgentOnBell:> I<boolean>
870
871B<True>: set the urgency hint for the wm on receipt of a bell character.
872B<False>: do not set the urgency hint [default].
873
874@@RXVT_NAME@@ resets the urgency hint on every focus change.
875
756=item B<visualBell:> I<boolean> 876=item B<visualBell:> I<boolean>
757 877
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 878B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 879B<False>: no visual bell [default]; option B<+vb>.
760 880
782 902
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 903 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 904
785This creates a new file in your home directory with the screen contents 905This creates a new file in your home directory with the screen contents
786every time you hit C<Print>. 906every time you hit C<Print>.
907
908=item B<scrollstyle:> I<mode>
909
910Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
911the author's favourite.
787 912
788=item B<scrollBar:> I<boolean> 913=item B<scrollBar:> I<boolean>
789 914
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 915B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 916disable the scrollbar; option B<+sb>.
854=item B<termName:> I<termname> 979=item B<termName:> I<termname>
855 980
856Specifies the terminal type name to be set in the B<TERM> environment 981Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 982variable; option B<-tn>.
858 983
859=item B<linespace:> I<number> 984=item B<lineSpace:> I<number>
860 985
861Specifies number of lines (pixel height) to insert between each row of 986Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 987the display [default 0]; option B<-lsp>.
863 988
864=item B<meta8:> I<boolean> 989=item B<meta8:> I<boolean>
916=item B<cutchars:> I<string> 1041=item B<cutchars:> I<string>
917 1042
918The characters used as delimiters for double-click word selection 1043The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 1044(whitespace delimiting is added automatically if resource is given).
920 1045
921When the selection extension is in use (the default if compiled in, see 1046When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1047in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 1048characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 1049will be created). In this mode, characters outside ISO-8859-1 can be used.
925 1050
926When the selection extension is not used, only ISO-8859-1 characters can 1051When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 1052be used. If not specified, the built-in default is used:
928 1053
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1054B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 1055
931=item B<preeditType:> I<style> 1056=item B<preeditType:> I<style>
932 1057
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1058B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 1059
988 1113
989Turn on/off secondary screen (default enabled). 1114Turn on/off secondary screen (default enabled).
990 1115
991=item B<secondaryScroll:> I<boolean> 1116=item B<secondaryScroll:> I<boolean>
992 1117
993Turn on/off secondary screen scroll (default enabled). If the this 1118Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1119option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1120scrollback buffer and, when secondaryScreen is off, switching
996instead scroll the screen up. 1121to/from the secondary screen will instead scroll the screen up.
997 1122
998=item B<hold>: I<boolean> 1123=item B<hold>: I<boolean>
999 1124
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1125Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within 1126will 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 1127it exits. Instead, it will wait till it is being killed or closed by the
1003user. 1128user.
1129
1130=item B<chdir>: I<path>
1131
1132Sets the working directory for the shell (or the command specified via
1133B<-e>). The I<path> must be an absolute path and it must exist for
1134@@RXVT_NAME@@ to start. If it isn't specified then the current working
1135directory will be used; option B<-cd>.
1004 1136
1005=item B<keysym.>I<sym>: I<string> 1137=item B<keysym.>I<sym>: I<string>
1006 1138
1007Compile I<frills>: Associate I<string> with keysym I<sym>. The 1139Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008intervening resource name B<keysym.> cannot be omitted. 1140intervening resource name B<keysym.> cannot be omitted.
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1154searching 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 1155omitting 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 1156keysym 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. 1157performed in an exact manner; however, the closest match is assured.
1026 1158
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1159I<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, 1160number), 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 1161
1039You can define a range of keysyms in one shot by providing a I<string> 1162You can define a range of keysyms in one shot by providing a I<string>
1040with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1041should be a character not used by the strings. 1164should be a character not used by the strings.
1042 1165
1124all instances, while B<perl-ext> is used for specific instances. 1247all instances, while B<perl-ext> is used for specific instances.
1125 1248
1126=item B<perl-eval>: I<string> 1249=item B<perl-eval>: I<string>
1127 1250
1128Perl code to be evaluated when all extensions have been registered. See 1251Perl code to be evaluated when all extensions have been registered. See
1129the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1252the @@RXVT_NAME@@perl(3) manpage.
1130will be ignored when running setuid/setgid.
1131 1253
1132=item B<perl-lib>: I<path> 1254=item B<perl-lib>: I<path>
1133 1255
1134Colon-separated list of additional directories that hold extension 1256Colon-separated list of additional directories that hold extension
1135scripts. When looking for extensions specified by the C<perl> resource, 1257scripts. When looking for extensions specified by the C<perl> resource,
1136@@RXVT_NAME@@ will first look in these directories and then in 1258@@RXVT_NAME@@ will first look in these directories and then in
1137F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1259F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1138will be ignored when running setuid/setgid.
1139 1260
1140See the @@RXVT_NAME@@perl(3) manpage. 1261See the @@RXVT_NAME@@perl(3) manpage.
1141 1262
1142=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1263=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1143 1264
1165 1286
1166=item B<override-redirect>: I<boolean> 1287=item B<override-redirect>: I<boolean>
1167 1288
1168Compile I<frills>: Sets override-redirect for the terminal window, making 1289Compile I<frills>: Sets override-redirect for the terminal window, making
1169it almost invisible to window managers; option B<-override-redirect>. 1290it almost invisible to window managers; option B<-override-redirect>.
1291
1292=item B<iso14755_52:> I<boolean>
1293
1294Turn on/off ISO 14755 5.2 mode (default enabled).
1170 1295
1171=back 1296=back
1172 1297
1173=head1 THE SCROLLBAR 1298=head1 THE SCROLLBAR
1174 1299
1193application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1318application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1194(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1319(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), 1320up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1196respectively. 1321respectively.
1197 1322
1198=head1 TEXT SELECTION AND INSERTION 1323=head1 THE SELECTION: SELECTING AND PASTING TEXT
1199 1324
1200The behaviour of text selection and insertion mechanism is similar to 1325The behaviour of text selection and insertion/pasting mechanism is similar
1201I<xterm>(1). 1326to I<xterm>(1).
1202 1327
1203=over 4 1328=over 4
1204 1329
1205=item B<Selection>: 1330=item B<Selecting>:
1206 1331
1207Left click at the beginning of the region, drag to the end of the region 1332Left 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 1333and release; Right click to extend the marked region; Left double-click
1209to select a word; Left triple-click to select the entire logical line 1334to select a word; Left triple-click to select the entire logical line
1210(which can span multiple screen lines), unless modified by resource 1335(which can span multiple screen lines), unless modified by resource
1214(Compile: I<frills>) will create a rectangular selection instead of a 1339(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 1340normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from 1341selection, and trailing whitespace is visually underlined and removed from
1217the selection. 1342the selection.
1218 1343
1219=item B<Insertion>: 1344=item B<Pasting>:
1220 1345
1221Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1346Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1222window causes the value of the PRIMARY selection (or CLIPBOARD with the 1347window 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. 1348B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1224 1349
1225Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1350Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1226inserted too. 1351inserted too.
1227 1352
1228=back 1353=back
1245 1370
1246=head1 ISO 14755 SUPPORT 1371=head1 ISO 14755 SUPPORT
1247 1372
1248ISO 14755 is a standard for entering and viewing unicode characters 1373ISO 14755 is a standard for entering and viewing unicode characters
1249and character codes using the keyboard. It consists of 4 parts. The 1374and character codes using the keyboard. It consists of 4 parts. The
1250first part is available rxvt-unicode has been compiled with 1375first part is available if rxvt-unicode has been compiled with
1251C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1376C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1252with C<--enable-iso14755>. 1377with C<--enable-iso14755>.
1253 1378
1254=over 4 1379=over 4
1255 1380
1374=back 1499=back
1375 1500
1376=head2 ALPHA CHANNEL SUPPORT 1501=head2 ALPHA CHANNEL SUPPORT
1377 1502
1378If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1503If 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> 1504their act together, rxvt-unicode will do it's own alpha channel management:
1380(recommended, but B<MUST> have 4 digits/component) colour specifications, 1505
1381in addition to the ones provided by X, where the additional A component 1506You can prefix any color with an opaquenes percentage enclosed in
1507brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1508(0-100) that specifies the opacity of the color, where C<0> is completely
1509transparent and C<100> is completely opaque. For example, C<[50]red> is a
1510half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1511is the recommended format to specify transparency values, and works with
1512all ways to specify a colour.
1513
1514For complete control, rxvt-unicode also supports
1515C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1516specifications, where the additional C<aaaa> component specifies opacity
1382specifies opacity (alpha) values. The minimum value of C<0> is completely 1517(alpha) values. The minimum value of C<0000> is completely transparent,
1383transparent). You can also prefix any color with C<[percent]>, where 1518while C<ffff> is completely opaque). The two example colours from
1384C<percent> is a decimal percentage (0-100) that specifies the opacity of 1519earlier 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 1520C<rgba:0000/ff00/0000/f332>.
1386opaque.
1387 1521
1388You probably need to specify B<"-depth 32">, too, and have the luck that 1522You 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 1523alpha channels, and have the luck that your X-server uses ARGB pixel
1390ARGB visuals out of the box, and rxvt-unicode just fudges around. 1524layout, as X is far from just supporting ARGB visuals out of the box, and
1525rxvt-unicode just fudges around.
1391 1526
1392For example, the following selects an almost completely transparent red 1527For example, the following selects an almost completely transparent black
1393background, and an almost opaque pink foreground: 1528background, and an almost opaque pink foreground:
1394 1529
1395 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1530 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1396 1531
1397I<Please note that transparency of any kind if completely unsupported by 1532When not using a background image, then the interpretation of the
1398the author. Don't bug him with installation questions!> 1533alpha channel is up to your compositing manager (most interpret it as
1534transparency of course).
1535
1536When using a background pixmap or pseudo-transparency, then the background
1537colour will always behave as if it were completely transparent (so the
1538background image shows instead), regardless of how it was specified, while
1539other colours will either be transparent as specified (the background
1540image will show through) on servers supporting the RENDER extension, or
1541fully opaque on servers not supporting the RENDER EXTENSION.
1542
1543Please note that due to bugs in Xft, specifying alpha values might result
1544in garbage being displayed when the X-server does not support the RENDER
1545extension.
1399 1546
1400=head1 ENVIRONMENT 1547=head1 ENVIRONMENT
1401 1548
1402B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1549B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1403 1550
1409resources or on the command line. 1556resources or on the command line.
1410 1557
1411=item B<COLORTERM> 1558=item B<COLORTERM>
1412 1559
1413Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1560Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1414compiled with XPM support, and optionally with the added extension 1561compiled with background image support, and optionally with the added
1415C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1562extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1563screen.
1416 1564
1417=item B<COLORFGBG> 1565=item B<COLORFGBG>
1418 1566
1419Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1567Set 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 1568the colour code used as default foreground/text colour (or the string
1421C<default> to indicate that the default-colour escape sequence is to be 1569C<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 1570used), 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@@ 1571string 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 1572was compiled with background image support. Libraries like C<ncurses>
1425(and do) use this information to optimize screen output. 1573and C<slang> can (and do) use this information to optimize screen output.
1426 1574
1427=item B<WINDOWID> 1575=item B<WINDOWID>
1428 1576
1429Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1577Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1430window, which usually has subwindows for the scrollbar, the terminal 1578window, which usually has subwindows for the scrollbar, the terminal
1436C<--with-terminfo=PATH>. 1584C<--with-terminfo=PATH>.
1437 1585
1438=item B<DISPLAY> 1586=item B<DISPLAY>
1439 1587
1440Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1588Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1441display in its child processes. 1589display in its child processes if C<-display> isn't used to override. It
1590defaults to C<:0> if it doesn't exist.
1442 1591
1443=item B<SHELL> 1592=item B<SHELL>
1444 1593
1445The shell to be used for command execution, defaults to C</bin/sh>. 1594The shell to be used for command execution, defaults to C</bin/sh>.
1446 1595
1521Project Coordinator (changes.txt 2.21a to 2.4.5) 1670Project Coordinator (changes.txt 2.21a to 2.4.5)
1522 1671
1523=item Geoff Wing L<< <gcw@pobox.com> >> 1672=item Geoff Wing L<< <gcw@pobox.com> >>
1524 1673
1525Rewrote screen display and text selection routines. 1674Rewrote screen display and text selection routines.
1526 1675
1527Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1676Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1528 1677
1529=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1678=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1530 1679
1531Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1680Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines