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.149 by ayin, Fri Dec 7 13:49:43 2007 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devanagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very user friendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: 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
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
103=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
104 117
105Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
106 119
107=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 127
115=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
116 129
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118
119=item B<-tr>|B<+tr>
120
121Turn on/off illusion of a transparent window background; resource B<transparent>.
122
123B<-ip> is still accepted as an obsolete alias but will be removed in
124future versions.
125
126I<Please address all transparency related issues to Sasha Vasko at
127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
128 131
129=item B<-fade> I<number> 132=item B<-fade> I<number>
130 133
131Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
132fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
135=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
136 139
137Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
138is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
139 142
140=item B<-tint> I<colour> 143=item B<-icon> I<file>
141 144
142Tint the transparent background pixmap with the given colour when 145Compile I<pixbuf>: Use the specified image as application icon. This
143transparency is enabled with B<-tr>. This only works for 146is used by many window managers, taskbars and pagers to represent the
144non-tiled backgrounds, currently. See also the B<-sh> option that can be 147application window; resource I<iconFile>.
145used to brighten or darken the image in addition to tinting it.
146Please note that certain tint colours can be applied on the server-side,
147thus yielding performance gain of two orders of magnitude. These colours are:
148blue, red, green, cyan, magenta, yellow, and those close to them. Also
149pure black and pure white colors essentially mean no tinting; resource
150I<tintColor>. Example:
151
152 @@RXVT_NAME@@ -tr -tint blue -sh 40
153
154=item B<-sh> I<number>
155
156Darken (0 .. 100) or lighten (100 .. 200) the transparent
157background image in addition to (or instead of) tinting it;
158resource I<shading>.
159
160=item B<-blt> I<string>
161
162Specify background blending type. If background pixmap is specified
163at the same time as transparency - such pixmap will be blended over
164transparency image, using method specified. Supported values are :
165B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
166B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
167B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168alpha-blending. Compile I<afterimage>; resource I<blendType>.
169
170=item B<-blr> I<HxV>
171
172Apply Gaussian Blur with the specified radii to the transparent
173background image. If single number is specified - both vertical and
174horizontal radii are considered to be the same. Setting one of the
175radii to 1 and another to a large number creates interesting effects
176on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177resource I<blurRadius>.
178 148
179=item B<-bg> I<colour> 149=item B<-bg> I<colour>
180 150
181Window background colour; resource B<background>. 151Window background colour; resource B<background>.
182 152
183=item B<-fg> I<colour> 153=item B<-fg> I<colour>
184 154
185Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
186
187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
188
189Compile I<afterimage>: Specify image file for the background and also
190optionally specify its scaling with a geometry string. Note you may need to
191add quotes to avoid special shell interpretation of the C<;> in the
192command-line; for more details see resource B<backgroundPixmap>.
193 156
194=item B<-cr> I<colour> 157=item B<-cr> I<colour>
195 158
196The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
197 160
242italic> >> characters are to be printed. See resource B<boldItalicFont> 205italic> >> characters are to be printed. See resource B<boldItalicFont>
243for details. 206for details.
244 207
245=item B<-is>|B<+is> 208=item B<-is>|B<+is>
246 209
247Compile I<font-styles>: Bold/Italic font styles imply high intensity 210Compile I<font-styles>: Bold/Blink font styles imply high intensity
248foreground/background (default). See resource B<intensityStyles> for 211foreground/background (default). See resource B<intensityStyles> for
249details. 212details.
250 213
251=item B<-name> I<name> 214=item B<-name> I<name>
252 215
270 233
271=item B<-sb>|B<+sb> 234=item B<-sb>|B<+sb>
272 235
273Turn on/off scrollbar; resource B<scrollBar>. 236Turn on/off scrollbar; resource B<scrollBar>.
274 237
238=item B<-sr>|B<+sr>
239
240Put scrollbar on right/left; resource B<scrollBar_right>.
241
242=item B<-st>|B<+st>
243
244Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
245resource B<scrollBar_floating>.
246
275=item B<-si>|B<+si> 247=item B<-si>|B<+si>
276 248
277Turn on/off scroll-to-bottom on TTY output inhibit; resource 249Turn on/off scroll-to-bottom on TTY output inhibit; resource
278B<scrollTtyOutput> has opposite effect. 250B<scrollTtyOutput> has opposite effect.
279 251
285=item B<-sw>|B<+sw> 257=item B<-sw>|B<+sw>
286 258
287Turn on/off scrolling with the scrollback buffer as new lines appear. 259Turn on/off scrolling with the scrollback buffer as new lines appear.
288This only takes effect if B<-si> is also given; resource 260This only takes effect if B<-si> is also given; resource
289B<scrollWithBuffer>. 261B<scrollWithBuffer>.
290
291=item B<-sr>|B<+sr>
292
293Put scrollbar on right/left; resource B<scrollBar_right>.
294
295=item B<-st>|B<+st>
296
297Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
298resource B<scrollBar_floating>.
299 262
300=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
301 264
302If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
303actual wide characters in the screen buffer, which makes it possible to 266actual wide characters in the screen buffer, which makes it possible to
307 270
308=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
309 272
310Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
311 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
312=item B<-iconic> 279=item B<-iconic>
313 280
314Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
315Alternative form is B<-ic>. 282Alternative form is B<-ic>.
316 283
332 299
333=item B<-bl> 300=item B<-bl>
334 301
335Compile I<frills>: Set MWM hints to request a borderless window, i.e. 302Compile I<frills>: Set MWM hints to request a borderless window, i.e.
336if honoured by the WM, the rxvt-unicode window will not have window 303if honoured by the WM, the rxvt-unicode window will not have window
337decorations; resource B<borderLess>. 304decorations; resource B<borderLess>. If the window manager does not
305support MWM hints (e.g. kwin), enables override-redirect mode.
338 306
339=item B<-override-redirect> 307=item B<-override-redirect>
340 308
341Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
342B<override-redirect>. 310B<override-redirect>.
311
312=item B<-dockapp>
313
314Sets the initial state of the window to WithdrawnState, which makes
315window managers that support this extension treat it as a dockapp.
343 316
344=item B<-sbg> 317=item B<-sbg>
345 318
346Compile I<frills>: Disable the usage of the built-in block graphics/line 319Compile I<frills>: Disable the usage of the built-in block graphics/line
347drawing characters and just rely on what the specified fonts provide. Use 320drawing characters and just rely on what the specified fonts provide. Use
351=item B<-lsp> I<number> 324=item B<-lsp> I<number>
352 325
353Compile I<frills>: Lines (pixel height) to insert between each row of 326Compile I<frills>: Lines (pixel height) to insert between each row of
354the display. Useful to work around font rendering problems; resource 327the display. Useful to work around font rendering problems; resource
355B<lineSpace>. 328B<lineSpace>.
329
330=item B<-letsp> I<number>
331
332Compile I<frills>: Amount to adjust the computed character width by
333to control overall letter spacing. Negative values will tighten up the
334letter spacing, positive values will space letters out more. Useful to
335work around odd font metrics; resource B<letterSpace>.
356 336
357=item B<-tn> I<termname> 337=item B<-tn> I<termname>
358 338
359This option specifies the name of the terminal type to be set in the 339This option specifies the name of the terminal type to be set in the
360B<TERM> environment variable. This terminal type must exist in the 340B<TERM> environment variable. This terminal type must exist in the
447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 427Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448will not immediately destroy its window when the program executed within 428will not immediately destroy its window when the program executed within
449it exits. Instead, it will wait till it is being killed or closed by the 429it exits. Instead, it will wait till it is being killed or closed by the
450user; resource B<hold>. 430user; resource B<hold>.
451 431
432=item B<-cd> I<path>
433
434Sets the working directory for the shell (or the command specified via
435B<-e>). The I<path> must be an absolute path and it must exist for
436@@RXVT_NAME@@ to start; resource B<chdir>.
437
452=item B<-xrm> I<string> 438=item B<-xrm> I<string>
453 439
454Works like the X Toolkit option of the same name, by adding the I<string> 440Works like the X Toolkit option of the same name, by adding the I<string>
455as if it were specified in a resource file. Resource values specified this 441as if it were specified in a resource file. Resource values specified this
456way take precedence over all other resource specifications. 442way take precedence over all other resource specifications.
503If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 489If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
504entries and will not tinker with pty/tty permissions - you have to do that 490entries and will not tinker with pty/tty permissions - you have to do that
505yourself if you want that. 491yourself if you want that.
506 492
507As an extremely special case, specifying C<-1> will completely suppress 493As an extremely special case, specifying C<-1> will completely suppress
508pty/tty operations. 494pty/tty operations, which is probably only useful in conjunction with some
495perl extension that manages the terminal.
509 496
510Here is a example in perl that illustrates how this option can be used (a 497Here is a example in perl that illustrates how this option can be used (a
511longer example is in F<doc/pty-fd>): 498longer example is in F<doc/pty-fd>):
512 499
513 use IO::Pty; 500 use IO::Pty;
527Comma-separated list of perl extension scripts to use (or not to use) in 514Comma-separated list of perl extension scripts to use (or not to use) in
528this terminal instance. See resource B<perl-ext> for details. 515this terminal instance. See resource B<perl-ext> for details.
529 516
530=back 517=back
531 518
532=head1 RESOURCES (available also as long-options) 519=head1 RESOURCES
533 520
534Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 521Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535options) compiled into your version. 522options) compiled into your version. All resources are also available as
523long-options.
536 524
537You can set and change the resources using X11 tools like B<xrdb>. Many 525You can set and change the resources using X11 tools like B<xrdb>. Many
538distribution do also load settings from the B<~/.Xresources> file when X 526distribution do also load settings from the B<~/.Xresources> file when X
539starts. @@RXVT_NAME@@ will consult the following files/resources in order, 527starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540with later settings overwriting earlier ones: 528with later settings overwriting earlier ones:
541 529
542 1. system-wide app-defaults file, either locale-dependent OR global
543 2. app-defaults file in $XAPPLRESDIR 530 1. app-defaults file in $XAPPLRESDIR
531 2. $HOME/.Xdefaults
544 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 532 3. RESOURCE_MANAGER property on root-window of screen 0
545 4. SCREEN_RESOURCES for the current screen 533 4. SCREEN_RESOURCES property on root-window of the current screen
546 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 534 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547 6. resources specified via -xrm on the commandline 535 6. resources specified via -xrm on the commandline
548 536
549Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
550names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 538names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
562=item B<depth:> I<bitdepth> 550=item B<depth:> I<bitdepth>
563 551
564Compile I<xft>: Attempt to find a visual with the given bit depth; 552Compile I<xft>: Attempt to find a visual with the given bit depth;
565option B<-depth>. 553option B<-depth>.
566 554
555=item B<buffered:> I<boolean>
556
557Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
558On some card/driver combination enabling it slightly decreases
559performance, on most it greatly helps it. The slowdown is small, so it
560should normally be enabled.
561
567=item B<geometry:> I<geom> 562=item B<geometry:> I<geom>
568 563
569Create the window with the specified X window geometry [default 80x24]; 564Create the window with the specified X window geometry [default 80x24];
570option B<-geometry>. 565option B<-geometry>.
571 566
584Use the specified colour for the colour value I<n>, where 0-7 579Use the specified colour for the colour value I<n>, where 0-7
585corresponds to low-intensity (normal) colours and 8-15 corresponds to 580corresponds to low-intensity (normal) colours and 8-15 corresponds to
586high-intensity (bold = bright foreground, blink = bright background) 581high-intensity (bold = bright foreground, blink = bright background)
587colours. The canonical names are as follows: 0=black, 1=red, 2=green, 582colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5883=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5833=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
589names used are listed in the B<COLORS AND GRAPHICS> section. 584names used are listed in the B<COLOURS AND GRAPHICS> section.
590 585
591Colours higher than 15 cannot be set using resources (yet), but can be 586Colours higher than 15 cannot be set using resources (yet), but can be
592changed using an escape command (see @@RXVT_NAME@@(7)). 587changed using an escape command (see @@RXVT_NAME@@(7)).
593 588
594Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 589Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
605=item B<colorUL:> I<colour> 600=item B<colorUL:> I<colour>
606 601
607Use the specified colour to display underlined characters when the 602Use the specified colour to display underlined characters when the
608foreground colour is the default. 603foreground colour is the default.
609 604
610=item B<colorRV:> I<colour>
611
612Use the specified colour as the background for reverse video characters
613when OPTION_HC is disabled (--disable-frills).
614
615=item B<underlineColor:> I<colour> 605=item B<underlineColor:> I<colour>
616 606
617If set, use the specified colour as the colour for the underline 607If set, use the specified colour as the colour for the underline
618itself. If unset, use the foreground colour. 608itself. If unset, use the foreground colour.
609
610=item B<highlightColor:> I<colour>
611
612If set, use the specified colour as the background for highlighted
613characters. If unset, use reverse video.
614
615=item B<highlightTextColor:> I<colour>
616
617If set and highlightColor is set, use the specified colour as the
618foreground for highlighted characters.
619 619
620=item B<cursorColor:> I<colour> 620=item B<cursorColor:> I<colour>
621 621
622Use the specified colour for the cursor. The default is to use the 622Use the specified colour for the cursor. The default is to use the
623foreground colour; option B<-cr>. 623foreground colour; option B<-cr>.
630 630
631=item B<reverseVideo:> I<boolean> 631=item B<reverseVideo:> I<boolean>
632 632
633B<True>: simulate reverse video by foreground and background colours; 633B<True>: simulate reverse video by foreground and background colours;
634option B<-rv>. B<False>: regular screen colours [default]; option 634option B<-rv>. B<False>: regular screen colours [default]; option
635B<+rv>. See note in B<COLORS AND GRAPHICS> section. 635B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
636 636
637=item B<jumpScroll:> I<boolean> 637=item B<jumpScroll:> I<boolean>
638 638
639B<True>: specify that jump scrolling should be used. When receiving lots 639B<True>: specify that jump scrolling should be used. When receiving lots
640of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 640of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
654 654
655B<False>: specify that everything is to be displayed, even 655B<False>: specify that everything is to be displayed, even
656if the refresh is too fast for the human eye to read anything (or the 656if the refresh is too fast for the human eye to read anything (or the
657monitor to display anything); option B<+ss>. 657monitor to display anything); option B<+ss>.
658 658
659=item B<transparent:> I<boolean>
660
661Turn on/off illusion of a transparent window background.
662
663B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
664future versions.
665
666I<Please address all transparency related issues to Sasha Vasko at
667sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
668
669=item B<fading:> I<number> 659=item B<fading:> I<number>
670 660
671Fade the text by the given percentage when focus is lost; option B<-fade>. 661Fade the text by the given percentage when focus is lost; option B<-fade>.
672 662
673=item B<fadeColor:> I<colour> 663=item B<fadeColor:> I<colour>
674 664
675Fade to this colour, when fading is used (see B<fading:>). The default 665Fade to this colour, when fading is used (see B<fading:>). The default
676colour is black; option B<-fadecolor>. 666colour is black; option B<-fadecolor>.
677 667
678=item B<tintColor:> I<colour> 668=item B<iconFile:> I<file>
679 669
680Tint the transparent background pixmap with the given colour; option 670Set the application icon pixmap; option B<-icon>.
681B<-tint>.
682
683=item B<shading:> I<number>
684
685Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
686in addition to tinting it; option B<-sh>.
687
688=item B<blendType:> I<string>
689
690Specify background blending type; option B<-blt>.
691
692=item B<blurRadius:> I<number>
693
694Apply Gaussian Blurr with the specified radius to the transparent
695background image; option B<-blr>.
696 671
697=item B<scrollColor:> I<colour> 672=item B<scrollColor:> I<colour>
698 673
699Use the specified colour for the scrollbar [default #B2B2B2]. 674Use the specified colour for the scrollbar [default #B2B2B2].
700 675
705 680
706=item B<borderColor:> I<colour> 681=item B<borderColor:> I<colour>
707 682
708The colour of the border around the text area and between the scrollbar 683The colour of the border around the text area and between the scrollbar
709and the text. 684and the text.
710
711=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
712
713Use the specified image file for the background and also
714optionally specify its scaling with a geometry string B<WxH+X+Y>,
715(default C<0x0+50+50>) in which B<"W" / "H"> specify the
716horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
717centre (percent). A scale of 0 displays the image with tiling. A scale
718of 1 displays the image without any scaling. A scale of 2 to 9 specifies
719an integer number of images in that direction. No image will be magnified
720beyond 10 times its original size. The maximum permitted scale is 1000.
721Additional operations can be specified after colon B<:op1:op2...>.
722Supported operations are:
723
724 tile force background image to be tiled and not scaled. Equivalent to 0x0,
725 propscale will scale image keeping proportions,
726 auto will scale image to match window size. Equivalent to 100x100;
727 hscale will scale image horizontally to the window size;
728 vscale will scale image vertically to the window size;
729 scale will scale image to match window size;
730 root will tile image as if it was a root window background, auto-adjusting
731 whenever terminal window moves.
732
733If used in conjunction with B<-tr> option, the specified pixmap will be
734blended over transparency image using either alpha-blending, or any
735other blending type, specified with B<-blt "type"> option.
736
737=item B<path:> I<path>
738
739Specify the colon-delimited search path for finding background image files.
740 685
741=item B<font:> I<fontlist> 686=item B<font:> I<fontlist>
742 687
743Select the fonts to be used. This is a comma separated list of font names 688Select the fonts to be used. This is a comma separated list of font names
744that are checked in order when trying to find glyphs for characters. The 689that are checked in order when trying to find glyphs for characters. The
767it is named first) and thus defines the character cell grid to be 9 pixels 712it is named first) and thus defines the character cell grid to be 9 pixels
768wide and 15 pixels high. 713wide and 15 pixels high.
769 714
770The second font is just used to add additional unicode characters not in 715The second font is just used to add additional unicode characters not in
771the base font, likewise the third, which is unfortunately non-bold, but 716the base font, likewise the third, which is unfortunately non-bold, but
772the bold version of the font does contain less characters, so this is a 717the bold version of the font does contain fewer characters, so this is a
773useful supplement. 718useful supplement.
774 719
775The third font is an Xft font with aliasing turned off, and the characters 720The third font is an Xft font with aliasing turned off, and the characters
776are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 721are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
777contains other characters, but we are not interested in them. 722contains other characters, but we are not interested in them.
801text font will being used for the given style. 746text font will being used for the given style.
802 747
803=item B<intensityStyles:> I<boolean> 748=item B<intensityStyles:> I<boolean>
804 749
805When font styles are not enabled, or this option is enabled (B<True>, 750When font styles are not enabled, or this option is enabled (B<True>,
806option B<-is>, the default), bold and italic font styles imply high 751option B<-is>, the default), bold/blink font styles imply high
807intensity foreground/background colours. Disabling this option (B<False>, 752intensity foreground/background colours. Disabling this option (B<False>,
808option B<+is>) disables this behaviour, the high intensity colours are not 753option B<+is>) disables this behaviour, the high intensity colours are not
809reachable. 754reachable.
810 755
811=item B<selectstyle:> I<mode>
812
813Set mouse selection style to B<old> which is 2.20, B<oldword> which
814is xterm style with 2.20 old word selection, or anything else which
815gives xterm style selection. Only effective when the original (non-perl)
816selection code is in use.
817
818=item B<scrollstyle:> I<mode>
819
820Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
821the author's favourite.
822
823=item B<title:> I<string> 756=item B<title:> I<string>
824 757
825Set window title string, the default title is the command-line 758Set window title string, the default title is the command-line
826specified after the B<-e> option, if any, otherwise the application 759specified after the B<-e> option, if any, otherwise the application
827name; option B<-title>. 760name; option B<-title>.
840=item B<urgentOnBell:> I<boolean> 773=item B<urgentOnBell:> I<boolean>
841 774
842B<True>: set the urgency hint for the wm on receipt of a bell character. 775B<True>: set the urgency hint for the wm on receipt of a bell character.
843B<False>: do not set the urgency hint [default]. 776B<False>: do not set the urgency hint [default].
844 777
778@@RXVT_NAME@@ resets the urgency hint on every focus change.
779
845=item B<visualBell:> I<boolean> 780=item B<visualBell:> I<boolean>
846 781
847B<True>: use visual bell on receipt of a bell character; option B<-vb>. 782B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848B<False>: no visual bell [default]; option B<+vb>. 783B<False>: no visual bell [default]; option B<+vb>.
849 784
872 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 807 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873 808
874This creates a new file in your home directory with the screen contents 809This creates a new file in your home directory with the screen contents
875every time you hit C<Print>. 810every time you hit C<Print>.
876 811
812=item B<scrollstyle:> I<mode>
813
814Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
815the author's favourite.
816
817=item B<thickness:> I<number>
818
819Set the scrollbar width in pixels.
820
877=item B<scrollBar:> I<boolean> 821=item B<scrollBar:> I<boolean>
878 822
879B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 823B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880disable the scrollbar; option B<+sb>. 824disable the scrollbar; option B<+sb>.
881 825
900B<False>: do not scroll to bottom when tty receives output; option 844B<False>: do not scroll to bottom when tty receives output; option
901B<+si>. 845B<+si>.
902 846
903=item B<scrollWithBuffer:> I<boolean> 847=item B<scrollWithBuffer:> I<boolean>
904 848
905B<True>: scroll with scrollback buffer when tty receives new lines (and 849B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
906B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 850try to show the same lines) and B<scrollTtyOutput> is False; option
907with scrollback buffer when tty receives new lines; option B<+sw>. 851B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
852new lines; option B<+sw>.
908 853
909=item B<scrollTtyKeypress:> I<boolean> 854=item B<scrollTtyKeypress:> I<boolean>
910 855
911B<True>: scroll to bottom when a non-special key is pressed. Special keys 856B<True>: scroll to bottom when a non-special key is pressed. Special keys
912are those which are intercepted by rxvt-unicode for special handling and 857are those which are intercepted by rxvt-unicode for special handling and
968=item B<cursorBlink:> I<boolean> 913=item B<cursorBlink:> I<boolean>
969 914
970B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 915B<True>: blink the cursor. B<False>: do not blink the cursor [default];
971option B<-bc>. 916option B<-bc>.
972 917
918=item B<cursorUnderline:> I<boolean>
919
920B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
921option B<-uc>.
922
973=item B<pointerBlank:> I<boolean> 923=item B<pointerBlank:> I<boolean>
974 924
975B<True>: blank the pointer when a key is pressed or after a set number 925B<True>: blank the pointer when a key is pressed or after a set number
976of seconds of inactivity. B<False>: the pointer is always visible 926of seconds of inactivity. B<False>: the pointer is always visible
977[default]. 927[default].
990large number (e.g. C<987654321>) to effectively disable the timeout. 940large number (e.g. C<987654321>) to effectively disable the timeout.
991 941
992=item B<backspacekey:> I<string> 942=item B<backspacekey:> I<string>
993 943
994The string to send when the backspace key is pressed. If set to B<DEC> 944The string to send when the backspace key is pressed. If set to B<DEC>
995or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 945or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
996(code 8) - which can be reversed with the appropriate DEC private mode 946(code 8) - which can be reversed with the appropriate DEC private mode
997escape sequence. 947escape sequence.
998 948
999=item B<deletekey:> I<string> 949=item B<deletekey:> I<string>
1000 950
1079 1029
1080=item B<secondaryScroll:> I<boolean> 1030=item B<secondaryScroll:> I<boolean>
1081 1031
1082Turn on/off secondary screen scroll (default enabled). If this 1032Turn on/off secondary screen scroll (default enabled). If this
1083option is enabled, scrolls on the secondary screen will change the 1033option is enabled, scrolls on the secondary screen will change the
1084scrollback buffer and switching to/from the secondary screen will 1034scrollback buffer and, when secondaryScreen is off, switching
1085instead scroll the screen up. 1035to/from the secondary screen will instead scroll the screen up.
1086 1036
1087=item B<hold>: I<boolean> 1037=item B<hold>: I<boolean>
1088 1038
1089Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1039Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090will not immediately destroy its window when the program executed within 1040will not immediately destroy its window when the program executed within
1091it exits. Instead, it will wait till it is being killed or closed by the 1041it exits. Instead, it will wait till it is being killed or closed by the
1092user. 1042user.
1093 1043
1044=item B<chdir>: I<path>
1045
1046Sets the working directory for the shell (or the command specified via
1047B<-e>). The I<path> must be an absolute path and it must exist for
1048@@RXVT_NAME@@ to start. If it isn't specified then the current working
1049directory will be used; option B<-cd>.
1050
1094=item B<keysym.>I<sym>: I<string> 1051=item B<keysym.>I<sym>: I<action>
1095 1052
1096Compile I<frills>: Associate I<string> with keysym I<sym>. The 1053Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1097intervening resource name B<keysym.> cannot be omitted. 1054resource name B<keysym.> cannot be omitted.
1098 1055
1099The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1056Using this resource, you can map key combinations such as
1100any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1057C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1101B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1058string than would normally result from that combination, making the
1102and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1059terminal scroll up or down the way you want it, or any other thing an
1103B<2>, B<3>, B<4>, B<5>. 1060extension might provide.
1061
1062The key combination that triggers the action, I<sym>, has the following format:
1063
1064 (modifiers-)key
1065
1066Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1067B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1068B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1069B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1104 1070
1105The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1071The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1106whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1072whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1107keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1073keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1108current application keymap mode state. 1074current application keymap mode state.
1109 1075
1110The spellings of I<key> can be obtained by using B<xev>(1) command or 1076Due the the large number of modifier combinations, a key mapping will
1111searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1077match if I<at least> the specified identifiers are being set, and no other
1078key mappings with those and more bits are being defined. That means that
1079defining a mapping for C<a> will automatically provide definitions for
1080C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1081themselves. See the C<builtin:> action, below, for a way to work around
1082this when this is a problem.
1083
1084The spelling of I<key> depends on your implementation of X. An easy way to
1085find a key name is to use the B<xev>(1) command. You can find a list by
1086looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1112omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1087the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1113keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1088value (B<0x0000 - 0xFFFF>).
1114performed in an exact manner; however, the closest match is assured.
1115 1089
1116I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1090As with any resource value, the I<action> string may contain backslash
1091escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1117number), see RESOURCES in C<man 7 X> for futher details. 1092number), see RESOURCES in C<man 7 X> for further details.
1118 1093
1119You can define a range of keysyms in one shot by providing a I<string> 1094An action starts with an action prefix that selects a certain type
1120with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1095of action, followed by a colon. An action string without colons is
1121should be a character not used by the strings. 1096interpreted as a literal string to pass to the tty (as if it was
1097prefixed with C<string:>).
1122 1098
1123Its usage can be demonstrated by an example: 1099The following action prefixes are known - extensions can provide
1100additional prefixes:
1124 1101
1125 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1102=over 4
1126 1103
1127The above line is equivalent to the following three lines: 1104=item string:STRING
1128 1105
1129 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1106If the I<action> starts with C<string:> (or otherwise contains no colons),
1130 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1107then the remaining C<STRING> will be passed to the program running in the
1131 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1108terminal. For example, you could replace whatever Shift-Tab outputs by the
1109string C<echo rm -rf /> followed by a newline:
1132 1110
1111 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1112
1113This could in theory be used to completely redefine your keymap.
1114
1115=item command:STRING
1116
1133If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1117If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1134is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1118is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1119the opposite of C<string:> - instead of sending it to the program running
1120in the terminal, it will be treated as if it were program output). This is
1121most useful to feed command sequences into @@RXVT_NAME@@.
1122
1135example the following means "change the current locale to C<zh_CN.GBK> 1123For example the following means "change the current locale to C<zh_CN.GBK>
1136when Control-Meta-c is being pressed": 1124when Control-Meta-c is being pressed":
1137 1125
1138 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1126 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1139 1127
1140If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1128The following example will map Control-Meta-1 and Control-Meta-2 to
1141is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1129the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1142manpage. For example, the F<selection> extension (activated via 1130font-switching at runtime:
1143C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1144 1131
1145 URxvt.keysym.M-C-c: perl:selection:rot13 1132 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1133 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1146 1134
1147Due the the large number of modifier combinations, a defined key mapping 1135Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1148will match if at I<at least> the specified identifiers are being set, and 1136info):
1149no other key mappings with those and more bits are being defined. That
1150means that defining a key map for C<a> will automatically provide
1151definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1152mappings themselves.
1153 1137
1154Unfortunately, this will override built-in key mappings. For example 1138 URxvt.keysym.M-C-3: command:\033[8;25;80t
1139 URxvt.keysym.M-C-4: command:\033[8;48;110t
1140
1141=item builtin:
1142
1143The builtin action is the action that @@RXVT_NAME@@ would execute if no
1144key binding existed for the key combination. The obvious use is to undo
1145the effect of existing bindings. The not so obvious use is to reinstate
1146bindings when another binding overrides too many modifiers.
1147
1155if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1148For example if you overwrite the C<Insert> key you will disable
1156C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1149@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1157user-defined keymap using the C<builtin:> replacement: 1150"holes" into the user-defined keymap using the C<builtin:> replacement:
1158 1151
1159 URxvt.keysym.Insert: <my insert key sequence> 1152 URxvt.keysym.Insert: <my insert key sequence>
1160 URxvt.keysym.S-Insert: builtin: 1153 URxvt.keysym.S-Insert: builtin:
1161 1154
1162The first line defines a mapping for C<Insert> and I<any> combination 1155The first line defines a mapping for C<Insert> and I<any> combination
1163of modifiers. The second line re-establishes the default mapping for 1156of modifiers. The second line re-establishes the default mapping for
1164C<Shift-Insert>. 1157C<Shift-Insert>.
1165 1158
1166The following example will map Control-Meta-1 and Control-Meta-2 to 1159=item builtin-string:
1167the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1168font-switching at runtime:
1169 1160
1170 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1161This action is mainly useful to restore string mappings for keys that
1171 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1162have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1163difficult to explain - basically, this action will send the string to the
1164application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1165action for it.
1172 1166
1173Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1167An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1174info): 1168selection when you press C<Shift-Insert>. With the following bindings, it
1169would instead emit the (undocumented, but what applications running in the
1170terminal might expect) sequence C<ESC [ 2 $> instead:
1175 1171
1176 URxvt.keysym.M-C-3: command:\033[8;25;80t 1172 URxvt.keysym.S-Insert: builtin-string:
1177 URxvt.keysym.M-C-4: command:\033[8;48;110t 1173 URxvt.keysym.C-S-Insert: builtin:
1174
1175The first line disables the paste functionality for that key
1176combination, and the second reinstates the default behaviour for
1177C<Control-Shift-Insert>, which would otherwise be overridden.
1178
1179Similarly, to let applications gain access to the C<C-M-c> (copy to
1180clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181this:
1182
1183 URxvt.keysym.C-S-c: builtin-string:
1184 URxvt.keysym.C-S-v: builtin-string:
1185
1186=item EXTENSION:STRING
1187
1188An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1189extension of the same name. The extension will be loaded automatically if
1190necessary.
1191
1192Not all extensions define key actions, but popular extensions that do
1193include the I<selection> and I<matcher> extensions (documented in their
1194own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195respectively).
1196
1197From the silly examples department, this will rot13-"encrypt"
1198@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1199keyboards:
1200
1201 URxvt.keysym.M-C-c: selection:rot13
1202
1203=item perl:STRING *DEPRECATED*
1204
1205This is a deprecated way of passing key mappings to perl extensions. It is
1206still supported, but should not be used anymore.
1207
1208=back
1178 1209
1179=item B<perl-ext-common>: I<string> 1210=item B<perl-ext-common>: I<string>
1180 1211
1181=item B<perl-ext>: I<string> 1212=item B<perl-ext>: I<string>
1182 1213
1184use in this terminal instance; option B<-pe>. 1215use in this terminal instance; option B<-pe>.
1185 1216
1186Extension names can be prefixed with a C<-> sign to prohibit using 1217Extension names can be prefixed with a C<-> sign to prohibit using
1187them. This can be useful to selectively disable some extensions loaded 1218them. This can be useful to selectively disable some extensions loaded
1188by default, or specified via the C<perl-ext-common> resource. For 1219by default, or specified via the C<perl-ext-common> resource. For
1189example, C<default,-selection> will use all the default extension except 1220example, C<default,-selection> will use all the default extensions except
1190C<selection>. 1221C<selection>.
1191 1222
1192Extension names can also be followed by an argument in angle brackets 1223The default set includes the C<selection>, C<option-popup>,
1193(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1224C<selection-popup> and C<readline> extensions, any extensions that define
1194searchable scrollback to Alt/Meta-s). Mentioning the same extension 1225keybindings via C<BINDING> meta comments, extensions loaded because
1195multiple times with different arguments will pass multiple arguments to 1226their resources/commandline switches were used, and extensions which are
1196the extension. 1227mentioned in B<keysym> resources.
1197 1228
1198Each extension is looked up in the library directories, loaded if 1229Each extension is looked up in the library directories, loaded if
1199necessary, and bound to the current terminal instance. 1230necessary, and bound to the current terminal instance. When the library
1231search path contains multiple extension files of the same name, then the
1232first one found will be used.
1200 1233
1201If both of these resources are the empty string, then the perl 1234If both of these resources are the empty string, then the perl interpreter
1202interpreter will not be initialized. The idea behind two options is that 1235will not be initialized. The rationale for having two options is that
1203B<perl-ext-common> will be used for extensions that should be available to 1236B<perl-ext-common> will be used for extensions that should be available to
1204all instances, while B<perl-ext> is used for specific instances. 1237all instances, while B<perl-ext> is used for specific instances.
1205 1238
1206=item B<perl-eval>: I<string> 1239=item B<perl-eval>: I<string>
1207 1240
1208Perl code to be evaluated when all extensions have been registered. See 1241Perl code to be evaluated when all extensions have been registered. See
1209the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1242the @@RXVT_NAME@@perl(3) manpage.
1210will be ignored when running setuid/setgid.
1211 1243
1212=item B<perl-lib>: I<path> 1244=item B<perl-lib>: I<path>
1213 1245
1214Colon-separated list of additional directories that hold extension 1246Colon-separated list of additional directories that hold extension
1215scripts. When looking for extensions specified by the C<perl> resource, 1247scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1216@@RXVT_NAME@@ will first look in these directories and then in 1248in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1217F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1249lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218will be ignored when running setuid/setgid.
1219 1250
1220See the @@RXVT_NAME@@perl(3) manpage. 1251See the @@RXVT_NAME@@perl(3) manpage.
1221 1252
1222=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1253=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223 1254
1227=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1258=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1228 1259
1229Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1260Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1230for details. 1261for details.
1231 1262
1232=item B<searchable-scrollback:> I<keysym> 1263=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1233 1264
1234Sets the hotkey that starts the incremental scrollback buffer search 1265This resource is deprecated and will be removed. Use a B<keysym> resource
1235(default: C<M-s>). 1266instead, e.g.:
1236 1267
1268 URxvt.keysym.M-s: searchable-scrollback:start
1269
1237=item B<urlLauncher>: I<string> 1270=item B<url-launcher>: I<string>
1238 1271
1239Specifies the program to be started with a URL argument. Used by the 1272Specifies the program to be started with a URL argument. Used by the
1240C<selection-popup> and C<matcher> perl extensions. 1273C<selection-popup> and C<matcher> perl extensions.
1241 1274
1242=item B<transient-for>: I<windowid> 1275=item B<transient-for>: I<windowid>
1246=item B<override-redirect>: I<boolean> 1279=item B<override-redirect>: I<boolean>
1247 1280
1248Compile I<frills>: Sets override-redirect for the terminal window, making 1281Compile I<frills>: Sets override-redirect for the terminal window, making
1249it almost invisible to window managers; option B<-override-redirect>. 1282it almost invisible to window managers; option B<-override-redirect>.
1250 1283
1284=item B<iso14755:> I<boolean>
1285
1286Turn on/off ISO 14755 (default enabled).
1287
1251=item B<iso14755_52:> I<boolean> 1288=item B<iso14755_52:> I<boolean>
1252 1289
1253Turn on/off ISO 14755 5.2 mode (default enabled). 1290Turn on/off ISO 14755 5.2 mode (default enabled).
1291
1292=back
1293
1294=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1295
1296=over 4
1297
1298=item B<-pixmap> I<file[;oplist]>
1299
1300=item B<backgroundPixmap:> I<file[;oplist]>
1301
1302Compile I<pixbuf>: Use the specified image file as the window's
1303background and also optionally specify a colon separated list of
1304operations to modify it. Note that you may need to quote the C<;>
1305character when using the command line option, as C<;> is usually a
1306metacharacter in shells. Supported operations are:
1307
1308=over 4
1309
1310=item B<WxH+X+Y>
1311
1312sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1313scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1314scale of 0 disables scaling.
1315
1316=item B<op=tile>
1317
1318enables tiling
1319
1320=item B<op=keep-aspect>
1321
1322maintain the image aspect ratio when scaling
1323
1324=item B<op=root-align>
1325
1326use the position of the terminal window relative to the root window as
1327the image offset, simulating a root window background
1328
1329=back
1330
1331The default scale and position setting is C<100x100+50+50>.
1332Alternatively, a predefined set of templates can be used to achieve
1333the most common setups:
1334
1335=over 4
1336
1337=item B<style=tiled>
1338
1339the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1340
1341=item B<style=aspect-stretched>
1342
1343the image is scaled to fill the whole window maintaining the aspect
1344ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1345
1346=item B<style=stretched>
1347
1348the image is scaled to fill the whole window. Equivalent to 100x100
1349
1350=item B<style=centered>
1351
1352the image is centered with no scaling. Equivalent to 0x0+50+50
1353
1354=item B<style=root-tiled>
1355
1356the image is tiled with no scaling and using 'root' positioning.
1357Equivalent to 0x0:op=tile:op=root-align
1358
1359=back
1360
1361If multiple templates are specified the last one wins. Note that a
1362template overrides all the scale, position and operations settings.
1363
1364If used in conjunction with pseudo-transparency, the specified pixmap
1365will be blended over the transparent background using alpha-blending.
1366
1367=item B<-tr>|B<+tr>
1368
1369=item B<transparent:> I<boolean>
1370
1371Turn on/off pseudo-transparency by using the root pixmap as background.
1372
1373B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1374will be removed in future versions.
1375
1376=item B<-tint> I<colour>
1377
1378=item B<tintColor:> I<colour>
1379
1380Tint the transparent background with the given colour. Note that a
1381black tint yields a completely black image while a white tint yields
1382the image unchanged.
1383
1384=item B<-sh> I<number>
1385
1386=item B<shading:> I<number>
1387
1388Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1389A value of 100 means no shading.
1390
1391=item B<-blr> I<HxV>
1392
1393=item B<blurRadius:> I<HxV>
1394
1395Apply gaussian blur with the specified radius to the transparent
1396background. If a single number is specified, the vertical and
1397horizontal radii are considered to be the same. Setting one of the
1398radii to 1 and the other to a large number creates interesting effects
1399on some backgrounds. The maximum radius value is 128. An horizontal or
1400vertical radius of 0 disables blurring.
1401
1402=item B<path:> I<path>
1403
1404Specify the colon-delimited search path for finding background image files.
1254 1405
1255=back 1406=back
1256 1407
1257=head1 THE SCROLLBAR 1408=head1 THE SCROLLBAR
1258 1409
1306window causes the value of the PRIMARY selection (or CLIPBOARD with the 1457window causes the value of the PRIMARY selection (or CLIPBOARD with the
1307B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1458B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1308 1459
1309Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1460Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1310inserted too. 1461inserted too.
1462
1463rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1464<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1465binding causes the value of the internal selection to be copied to the
1466CLIPBOARD selection, while the second binding causes the value of the
1467CLIPBOARD selection to be inserted.
1311 1468
1312=back 1469=back
1313 1470
1314=head1 CHANGING FONTS 1471=head1 CHANGING FONTS
1315 1472
1397B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1554B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1398it can be seen via the I<who(1)> command, and can accept messages. To 1555it can be seen via the I<who(1)> command, and can accept messages. To
1399allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1556allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1400on some systems or setgid to root or to some other group on others. 1557on some systems or setgid to root or to some other group on others.
1401 1558
1402=head1 COLORS AND GRAPHICS 1559=head1 COLOURS AND GRAPHICS
1403 1560
1404In addition to the default foreground and background colours, 1561In addition to the default foreground and background colours,
1405B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1562B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1406high-intensity bold/blink versions of the same). Here is a list of the 1563high-intensity (potentially bold/blink) versions of the same, and 72 (or
1407colours with their names. 1564240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1565cube plus a 8 (24) colour greyscale ramp.
1566
1567Here is a list of the ANSI colours with their names.
1408 1568
1409=begin table 1569=begin table
1410 1570
1411 B<color0> (black) = Black 1571 B<color0> (black) = Black
1412 B<color1> (red) = Red3 1572 B<color1> (red) = Red3
1432It is also possible to specify the colour values of B<foreground>, 1592It is also possible to specify the colour values of B<foreground>,
1433B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1593B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1434a number 0-15, as a convenient shorthand to reference the colour name of 1594a number 0-15, as a convenient shorthand to reference the colour name of
1435color0-color15. 1595color0-color15.
1436 1596
1437In addition to the colours defined above, @@RXVT_NAME@@ offers an 1597The following text gives values for the standard 88 colour mode (and
1438additional 72 colours. The first 64 of those (with indices 16 to 79) 1598values for the 256 colour mode in parentheses).
1439consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144016>), followed by 8 additional shades of gray (with indices 80 to 87).
1441 1599
1600The RGB cube uses indices 16..79 (16..231) using the following formulas:
1601
1602 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1603 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1604
1605The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1606steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1607the RGB cube.
1608
1442Together, all those colours implement the 88 colour xterm colours. Only 1609Together, all those colours implement the 88 (256) colour xterm
1443the first 16 can be changed using resources currently, the rest can only 1610colours. Only the first 16 can be changed using resources currently, the
1444be changed via command sequences ("escape codes"). 1611rest can only be changed via command sequences ("escape codes").
1612
1613Applications are advised to use terminfo or command sequences to discover
1614number and RGB values of all colours (yes, you can query this...).
1445 1615
1446Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1616Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1447always swapping the foreground/background colours. This is in contrast to 1617always swapping the foreground/background colours. This is in contrast to
1448I<xterm>(1) where the colours are only swapped if they have not otherwise 1618I<xterm>(1) where the colours are only swapped if they have not otherwise
1449been specified. For example, 1619been specified. For example,
1450 1620
1451=over 4
1452
1453=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1621 @@RXVT_NAME@@ -fg Black -bg White -rv
1454 1622
1455would yield White on Black, while on I<xterm>(1) it would yield Black 1623would yield White on Black, while on I<xterm>(1) it would yield Black on
1456on White. 1624White.
1457
1458=back
1459 1625
1460=head2 ALPHA CHANNEL SUPPORT 1626=head2 ALPHA CHANNEL SUPPORT
1461 1627
1462If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1628If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1463their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1629their act together, rxvt-unicode will do its own alpha channel management:
1464(recommended, but B<MUST> have 4 digits/component) colour specifications, 1630
1465in addition to the ones provided by X, where the additional A component 1631You can prefix any colour with an opaqueness percentage enclosed in
1632brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1633(0-100) that specifies the opacity of the colour, where C<0> is completely
1634transparent and C<100> is completely opaque. For example, C<[50]red> is a
1635half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1636is the recommended format to specify transparency values, and works with
1637all ways to specify a colour.
1638
1639For complete control, rxvt-unicode also supports
1640C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1641specifications, where the additional C<aaaa> component specifies opacity
1466specifies opacity (alpha) values. The minimum value of C<0> is completely 1642(alpha) values. The minimum value of C<0000> is completely transparent,
1467transparent). You can also prefix any color with C<[percent]>, where 1643while C<ffff> is completely opaque). The two example colours from
1468C<percent> is a decimal percentage (0-100) that specifies the opacity of 1644earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1469the color, where C<0> is completely transparent and C<100> is completelxy 1645C<rgba:0000/ff00/0000/f332>.
1470opaque.
1471 1646
1472You probably need to specify B<"-depth 32">, too, and have the luck that 1647You probably need to specify B<"-depth 32">, too, to force a visual with
1473your X-server uses ARGB pixel layout, as X is far from just supporting 1648alpha channels, and have the luck that your X-server uses ARGB pixel
1474ARGB visuals out of the box, and rxvt-unicode just fudges around. 1649layout, as X is far from just supporting ARGB visuals out of the box, and
1650rxvt-unicode just fudges around.
1475 1651
1476For example, the following selects an almost completely transparent red 1652For example, the following selects an almost completely transparent black
1477background, and an almost opaque pink foreground: 1653background, and an almost opaque pink foreground:
1478 1654
1479 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1655 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480 1656
1481I<Please note that transparency of any kind if completely unsupported by 1657When not using a background image, then the interpretation of the
1482the author. Don't bug him with installation questions!> 1658alpha channel is up to your compositing manager (most interpret it as
1659transparency of course).
1660
1661When using a background pixmap or pseudo-transparency, then the background
1662colour will always behave as if it were completely transparent (so the
1663background image shows instead), regardless of how it was specified, while
1664other colours will either be transparent as specified (the background
1665image will show through) on servers supporting the RENDER extension, or
1666fully opaque on servers not supporting the RENDER EXTENSION.
1667
1668Please note that due to bugs in Xft, specifying alpha values might result
1669in garbage being displayed when the X-server does not support the RENDER
1670extension.
1483 1671
1484=head1 ENVIRONMENT 1672=head1 ENVIRONMENT
1485 1673
1486B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1674B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487 1675
1521C<--with-terminfo=PATH>. 1709C<--with-terminfo=PATH>.
1522 1710
1523=item B<DISPLAY> 1711=item B<DISPLAY>
1524 1712
1525Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1713Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526display in its child processes. 1714display in its child processes if C<-display> isn't used to override. It
1715defaults to C<:0> if it doesn't exist.
1527 1716
1528=item B<SHELL> 1717=item B<SHELL>
1529 1718
1530The shell to be used for command execution, defaults to C</bin/sh>. 1719The shell to be used for command execution, defaults to C</bin/sh>.
1531 1720
1532=item B<RXVT_SOCKET> 1721=item B<RXVT_SOCKET> [I<sic>]
1533 1722
1534The unix domain socket path used by @@RXVT_NAME@@c(1) and 1723The unix domain socket path used by @@RXVT_NAME@@c(1) and
1535@@RXVT_NAME@@d(1). 1724@@RXVT_NAME@@d(1).
1536 1725
1537Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1726Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1727
1728=item B<URXVT_PERL_LIB>
1729
1730Additional F<:>-separated library search path for perl extensions. Will be
1731searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1732directory.
1733
1734=item B<URXVT_PERL_VERBOSITY>
1735
1736See L<@@RXVT_NAME@@perl>(3).
1538 1737
1539=item B<HOME> 1738=item B<HOME>
1540 1739
1541Used to locate the default directory for the unix domain socket for 1740Used to locate the default directory for the unix domain socket for
1542daemon communications and to locate various resource files (such as 1741daemon communications and to locate various resource files (such as
1543C<.Xdefaults>) 1742C<.Xdefaults>)
1544 1743
1545=item B<XAPPLRESDIR> 1744=item B<XAPPLRESDIR>
1546 1745
1547Directory where various X resource files are being located. 1746Directory where application-specific X resource files are located.
1548 1747
1549=item B<XENVIRONMENT> 1748=item B<XENVIRONMENT>
1550 1749
1551If set and accessible, gives the name of a X resource file to be loaded by 1750If set and accessible, gives the name of a X resource file to be loaded by
1552@@RXVT_NAME@@. 1751@@RXVT_NAME@@.
1557 1756
1558=over 4 1757=over 4
1559 1758
1560=item B</usr/lib/X11/rgb.txt> 1759=item B</usr/lib/X11/rgb.txt>
1561 1760
1562Color names. 1761Colour names.
1563 1762
1564=back 1763=back
1565 1764
1566=head1 SEE ALSO 1765=head1 SEE ALSO
1567 1766
1767@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1568@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1768@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1569 1769
1570=head1 CURRENT PROJECT COORDINATOR 1770=head1 CURRENT PROJECT COORDINATOR
1571 1771
1572=over 4 1772=over 4
1573 1773
1574=item Project Coordinator 1774=item Project Coordinator
1575 1775
1576Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1776Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1577 1777
1578L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1778L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1579 1779
1580=back 1780=back
1581 1781
1585 1785
1586=item John Bovey 1786=item John Bovey
1587 1787
1588University of Kent, 1992, wrote the original Xvt. 1788University of Kent, 1992, wrote the original Xvt.
1589 1789
1590=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1790=item Rob Nation <nation@rocket.sanders.lockheed.com>
1591 1791
1592very heavily modified Xvt and came up with Rxvt 1792very heavily modified Xvt and came up with Rxvt
1593 1793
1594=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1794=item Angelo Haritsis <ah@doc.ic.ac.uk>
1595 1795
1596wrote the Greek Keyboard Input (no longer in code) 1796wrote the Greek Keyboard Input (no longer in code)
1597 1797
1598=item mj olesen L<< <olesen@me.QueensU.CA> >> 1798=item mj olesen <olesen@me.QueensU.CA>
1599 1799
1600Wrote the menu system. 1800Wrote the menu system.
1601 1801
1602Project Coordinator (changes.txt 2.11 to 2.21) 1802Project Coordinator (changes.txt 2.11 to 2.21)
1603 1803
1604=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1804=item Oezguer Kesim <kesim@math.fu-berlin.de>
1605 1805
1606Project Coordinator (changes.txt 2.21a to 2.4.5) 1806Project Coordinator (changes.txt 2.21a to 2.4.5)
1607 1807
1608=item Geoff Wing L<< <gcw@pobox.com> >> 1808=item Geoff Wing <gcw@pobox.com>
1609 1809
1610Rewrote screen display and text selection routines. 1810Rewrote screen display and text selection routines.
1611 1811
1612Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1812Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1613 1813
1614=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1814=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1615 1815
1616Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1816Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1617extension, random hacks, numerous bugfixes and extensions. 1817extension, random hacks, numerous bugfixes and extensions.
1618 1818
1619Project Coordinator (Changes 1.0 -) 1819Project Coordinator (Changes 1.0 -)
1620 1820
1621=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1821=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1622 1822
1623Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1823pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1624 1824
1625=back 1825=back
1626 1826

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines