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.241 by root, Wed Dec 17 15:22:10 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
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
116
103=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
104 118
105Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
106 120
107=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 128
115=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
116 130
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn 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 132
129=item B<-fade> I<number> 133=item B<-fade> I<number>
130 134
131Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
132fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
135=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
136 140
137Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
138is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
139 143
140=item B<-tint> I<colour> 144=item B<-icon> I<file>
141 145
142Tint the transparent background pixmap with the given colour when 146Compile I<pixbuf>: Use the specified image as application icon. This
143transparency is enabled with B<-tr>. This only works for 147is used by many window managers, taskbars and pagers to represent the
144non-tiled backgrounds, currently. See also the B<-sh> option that can be 148application 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 149
179=item B<-bg> I<colour> 150=item B<-bg> I<colour>
180 151
181Window background colour; resource B<background>. 152Window background colour; resource B<background>.
182 153
183=item B<-fg> I<colour> 154=item B<-fg> I<colour>
184 155
185Window foreground colour; resource B<foreground>. 156Window 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 157
194=item B<-cr> I<colour> 158=item B<-cr> I<colour>
195 159
196The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
197 161
242italic> >> characters are to be printed. See resource B<boldItalicFont> 206italic> >> characters are to be printed. See resource B<boldItalicFont>
243for details. 207for details.
244 208
245=item B<-is>|B<+is> 209=item B<-is>|B<+is>
246 210
247Compile I<font-styles>: Bold/Italic font styles imply high intensity 211Compile I<font-styles>: Bold/Blink font styles imply high intensity
248foreground/background (default). See resource B<intensityStyles> for 212foreground/background (default). See resource B<intensityStyles> for
249details. 213details.
250 214
251=item B<-name> I<name> 215=item B<-name> I<name>
252 216
256 220
257=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
258 222
259Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
260 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
261=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
262 230
263Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
264B<utmpInhibit>. 232B<utmpInhibit>.
265 233
269B<visualBell>. 237B<visualBell>.
270 238
271=item B<-sb>|B<+sb> 239=item B<-sb>|B<+sb>
272 240
273Turn on/off scrollbar; resource B<scrollBar>. 241Turn on/off scrollbar; resource B<scrollBar>.
242
243=item B<-sr>|B<+sr>
244
245Put scrollbar on right/left; resource B<scrollBar_right>.
246
247=item B<-st>|B<+st>
248
249Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
250resource B<scrollBar_floating>.
274 251
275=item B<-si>|B<+si> 252=item B<-si>|B<+si>
276 253
277Turn on/off scroll-to-bottom on TTY output inhibit; resource 254Turn on/off scroll-to-bottom on TTY output inhibit; resource
278B<scrollTtyOutput> has opposite effect. 255B<scrollTtyOutput> has opposite effect.
285=item B<-sw>|B<+sw> 262=item B<-sw>|B<+sw>
286 263
287Turn on/off scrolling with the scrollback buffer as new lines appear. 264Turn on/off scrolling with the scrollback buffer as new lines appear.
288This only takes effect if B<-si> is also given; resource 265This only takes effect if B<-si> is also given; resource
289B<scrollWithBuffer>. 266B<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 267
300=item B<-ptab>|B<+ptab> 268=item B<-ptab>|B<+ptab>
301 269
302If enabled (default), "Horizontal Tab" characters are being stored as 270If enabled (default), "Horizontal Tab" characters are being stored as
303actual wide characters in the screen buffer, which makes it possible to 271actual wide characters in the screen buffer, which makes it possible to
307 275
308=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
309 277
310Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
311 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
312=item B<-iconic> 284=item B<-iconic>
313 285
314Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
315Alternative form is B<-ic>. 287Alternative form is B<-ic>.
316 288
332 304
333=item B<-bl> 305=item B<-bl>
334 306
335Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile 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 308if honoured by the WM, the rxvt-unicode window will not have window
337decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
338 311
339=item B<-override-redirect> 312=item B<-override-redirect>
340 313
341Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
342B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
343 321
344=item B<-sbg> 322=item B<-sbg>
345 323
346Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
347drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
351=item B<-lsp> I<number> 329=item B<-lsp> I<number>
352 330
353Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
354the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
355B<lineSpace>. 333B<lineSpace>.
334
335=item B<-letsp> I<number>
336
337Compile I<frills>: Amount to adjust the computed character width by
338to control overall letter spacing. Negative values will tighten up the
339letter spacing, positive values will space letters out more. Useful to
340work around odd font metrics; resource B<letterSpace>.
356 341
357=item B<-tn> I<termname> 342=item B<-tn> I<termname>
358 343
359This option specifies the name of the terminal type to be set in the 344This option specifies the name of the terminal type to be set in the
360B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 432Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448will not immediately destroy its window when the program executed within 433will 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 434it exits. Instead, it will wait till it is being killed or closed by the
450user; resource B<hold>. 435user; resource B<hold>.
451 436
437=item B<-cd> I<path>
438
439Sets the working directory for the shell (or the command specified via
440B<-e>). The I<path> must be an absolute path and it must exist for
441@@RXVT_NAME@@ to start; resource B<chdir>.
442
452=item B<-xrm> I<string> 443=item B<-xrm> I<string>
453 444
454Works like the X Toolkit option of the same name, by adding the I<string> 445Works 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 446as if it were specified in a resource file. Resource values specified this
456way take precedence over all other resource specifications. 447way take precedence over all other resource specifications.
503If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 494If 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 495entries and will not tinker with pty/tty permissions - you have to do that
505yourself if you want that. 496yourself if you want that.
506 497
507As an extremely special case, specifying C<-1> will completely suppress 498As an extremely special case, specifying C<-1> will completely suppress
508pty/tty operations. 499pty/tty operations, which is probably only useful in conjunction with some
500perl extension that manages the terminal.
509 501
510Here is a example in perl that illustrates how this option can be used (a 502Here is a example in perl that illustrates how this option can be used (a
511longer example is in F<doc/pty-fd>): 503longer example is in F<doc/pty-fd>):
512 504
513 use IO::Pty; 505 use IO::Pty;
527Comma-separated list of perl extension scripts to use (or not to use) in 519Comma-separated list of perl extension scripts to use (or not to use) in
528this terminal instance. See resource B<perl-ext> for details. 520this terminal instance. See resource B<perl-ext> for details.
529 521
530=back 522=back
531 523
532=head1 RESOURCES (available also as long-options) 524=head1 RESOURCES
533 525
534Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 526Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535options) compiled into your version. 527options) compiled into your version. All resources are also available as
528long-options.
536 529
537You can set and change the resources using X11 tools like B<xrdb>. Many 530You 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 531distribution do also load settings from the B<~/.Xresources> file when X
539starts. @@RXVT_NAME@@ will consult the following files/resources in order, 532starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540with later settings overwriting earlier ones: 533with later settings overwriting earlier ones:
541 534
542 1. system-wide app-defaults file, either locale-dependent OR global
543 2. app-defaults file in $XAPPLRESDIR 535 1. app-defaults file in $XAPPLRESDIR
536 2. $HOME/.Xdefaults
544 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 537 3. RESOURCE_MANAGER property on root-window of screen 0
545 4. SCREEN_RESOURCES for the current screen 538 4. SCREEN_RESOURCES property on root-window of the current screen
546 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 539 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547 6. resources specified via -xrm on the commandline 540 6. resources specified via -xrm on the commandline
548 541
549Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 542Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
550names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 543names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
562=item B<depth:> I<bitdepth> 555=item B<depth:> I<bitdepth>
563 556
564Compile I<xft>: Attempt to find a visual with the given bit depth; 557Compile I<xft>: Attempt to find a visual with the given bit depth;
565option B<-depth>. 558option B<-depth>.
566 559
560=item B<buffered:> I<boolean>
561
562Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
563On some card/driver combination enabling it slightly decreases
564performance, on most it greatly helps it. The slowdown is small, so it
565should normally be enabled.
566
567=item B<geometry:> I<geom> 567=item B<geometry:> I<geom>
568 568
569Create the window with the specified X window geometry [default 80x24]; 569Create the window with the specified X window geometry [default 80x24];
570option B<-geometry>. 570option B<-geometry>.
571 571
584Use the specified colour for the colour value I<n>, where 0-7 584Use the specified colour for the colour value I<n>, where 0-7
585corresponds to low-intensity (normal) colours and 8-15 corresponds to 585corresponds to low-intensity (normal) colours and 8-15 corresponds to
586high-intensity (bold = bright foreground, blink = bright background) 586high-intensity (bold = bright foreground, blink = bright background)
587colours. The canonical names are as follows: 0=black, 1=red, 2=green, 587colours. 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 5883=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
589names used are listed in the B<COLORS AND GRAPHICS> section. 589names used are listed in the B<COLOURS AND GRAPHICS> section.
590 590
591Colours higher than 15 cannot be set using resources (yet), but can be 591Colours higher than 15 cannot be set using resources (yet), but can be
592changed using an escape command (see @@RXVT_NAME@@(7)). 592changed using an escape command (see @@RXVT_NAME@@(7)).
593 593
594Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 594Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
605=item B<colorUL:> I<colour> 605=item B<colorUL:> I<colour>
606 606
607Use the specified colour to display underlined characters when the 607Use the specified colour to display underlined characters when the
608foreground colour is the default. 608foreground colour is the default.
609 609
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> 610=item B<underlineColor:> I<colour>
616 611
617If set, use the specified colour as the colour for the underline 612If set, use the specified colour as the colour for the underline
618itself. If unset, use the foreground colour. 613itself. If unset, use the foreground colour.
614
615=item B<highlightColor:> I<colour>
616
617If set, use the specified colour as the background for highlighted
618characters. If unset, use reverse video.
619
620=item B<highlightTextColor:> I<colour>
621
622If set and highlightColor is set, use the specified colour as the
623foreground for highlighted characters.
619 624
620=item B<cursorColor:> I<colour> 625=item B<cursorColor:> I<colour>
621 626
622Use the specified colour for the cursor. The default is to use the 627Use the specified colour for the cursor. The default is to use the
623foreground colour; option B<-cr>. 628foreground colour; option B<-cr>.
630 635
631=item B<reverseVideo:> I<boolean> 636=item B<reverseVideo:> I<boolean>
632 637
633B<True>: simulate reverse video by foreground and background colours; 638B<True>: simulate reverse video by foreground and background colours;
634option B<-rv>. B<False>: regular screen colours [default]; option 639option B<-rv>. B<False>: regular screen colours [default]; option
635B<+rv>. See note in B<COLORS AND GRAPHICS> section. 640B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
636 641
637=item B<jumpScroll:> I<boolean> 642=item B<jumpScroll:> I<boolean>
638 643
639B<True>: specify that jump scrolling should be used. When receiving lots 644B<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 645of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
654 659
655B<False>: specify that everything is to be displayed, even 660B<False>: specify that everything is to be displayed, even
656if the refresh is too fast for the human eye to read anything (or the 661if the refresh is too fast for the human eye to read anything (or the
657monitor to display anything); option B<+ss>. 662monitor to display anything); option B<+ss>.
658 663
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> 664=item B<fading:> I<number>
670 665
671Fade the text by the given percentage when focus is lost; option B<-fade>. 666Fade the text by the given percentage when focus is lost; option B<-fade>.
672 667
673=item B<fadeColor:> I<colour> 668=item B<fadeColor:> I<colour>
674 669
675Fade to this colour, when fading is used (see B<fading:>). The default 670Fade to this colour, when fading is used (see B<fading:>). The default
676colour is black; option B<-fadecolor>. 671colour is black; option B<-fadecolor>.
677 672
678=item B<tintColor:> I<colour> 673=item B<iconFile:> I<file>
679 674
680Tint the transparent background pixmap with the given colour; option 675Set 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 676
697=item B<scrollColor:> I<colour> 677=item B<scrollColor:> I<colour>
698 678
699Use the specified colour for the scrollbar [default #B2B2B2]. 679Use the specified colour for the scrollbar [default #B2B2B2].
700 680
705 685
706=item B<borderColor:> I<colour> 686=item B<borderColor:> I<colour>
707 687
708The colour of the border around the text area and between the scrollbar 688The colour of the border around the text area and between the scrollbar
709and the text. 689and 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 690
741=item B<font:> I<fontlist> 691=item B<font:> I<fontlist>
742 692
743Select the fonts to be used. This is a comma separated list of font names 693Select 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 694that 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 717it is named first) and thus defines the character cell grid to be 9 pixels
768wide and 15 pixels high. 718wide and 15 pixels high.
769 719
770The second font is just used to add additional unicode characters not in 720The second font is just used to add additional unicode characters not in
771the base font, likewise the third, which is unfortunately non-bold, but 721the 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 722the bold version of the font does contain fewer characters, so this is a
773useful supplement. 723useful supplement.
774 724
775The third font is an Xft font with aliasing turned off, and the characters 725The 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 726are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
777contains other characters, but we are not interested in them. 727contains other characters, but we are not interested in them.
801text font will being used for the given style. 751text font will being used for the given style.
802 752
803=item B<intensityStyles:> I<boolean> 753=item B<intensityStyles:> I<boolean>
804 754
805When font styles are not enabled, or this option is enabled (B<True>, 755When font styles are not enabled, or this option is enabled (B<True>,
806option B<-is>, the default), bold and italic font styles imply high 756option B<-is>, the default), bold/blink font styles imply high
807intensity foreground/background colours. Disabling this option (B<False>, 757intensity foreground/background colours. Disabling this option (B<False>,
808option B<+is>) disables this behaviour, the high intensity colours are not 758option B<+is>) disables this behaviour, the high intensity colours are not
809reachable. 759reachable.
810 760
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> 761=item B<title:> I<string>
824 762
825Set window title string, the default title is the command-line 763Set window title string, the default title is the command-line
826specified after the B<-e> option, if any, otherwise the application 764specified after the B<-e> option, if any, otherwise the application
827name; option B<-title>. 765name; option B<-title>.
840=item B<urgentOnBell:> I<boolean> 778=item B<urgentOnBell:> I<boolean>
841 779
842B<True>: set the urgency hint for the wm on receipt of a bell character. 780B<True>: set the urgency hint for the wm on receipt of a bell character.
843B<False>: do not set the urgency hint [default]. 781B<False>: do not set the urgency hint [default].
844 782
783@@RXVT_NAME@@ resets the urgency hint on every focus change.
784
845=item B<visualBell:> I<boolean> 785=item B<visualBell:> I<boolean>
846 786
847B<True>: use visual bell on receipt of a bell character; option B<-vb>. 787B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848B<False>: no visual bell [default]; option B<+vb>. 788B<False>: no visual bell [default]; option B<+vb>.
849 789
851 791
852B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 792B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
853the shell; option B<-ls>. B<False>: start as a normal sub-shell 793the shell; option B<-ls>. B<False>: start as a normal sub-shell
854[default]; option B<+ls>. 794[default]; option B<+ls>.
855 795
796=item B<multiClickTime:> I<number>
797
798Specify the maximum time in milliseconds between multi-click select
799events. The default is 500 milliseconds; option B<-mc>.
800
856=item B<utmpInhibit:> I<boolean> 801=item B<utmpInhibit:> I<boolean>
857 802
858B<True>: inhibit writing record into the system log file B<utmp>; 803B<True>: inhibit writing record into the system log file B<utmp>;
859option B<-ut>. B<False>: write record into the system log file B<utmp> 804option B<-ut>. B<False>: write record into the system log file B<utmp>
860[default]; option B<+ut>. 805[default]; option B<+ut>.
872 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 817 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873 818
874This creates a new file in your home directory with the screen contents 819This creates a new file in your home directory with the screen contents
875every time you hit C<Print>. 820every time you hit C<Print>.
876 821
822=item B<scrollstyle:> I<mode>
823
824Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
825the author's favourite.
826
827=item B<thickness:> I<number>
828
829Set the scrollbar width in pixels.
830
877=item B<scrollBar:> I<boolean> 831=item B<scrollBar:> I<boolean>
878 832
879B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 833B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880disable the scrollbar; option B<+sb>. 834disable the scrollbar; option B<+sb>.
881 835
900B<False>: do not scroll to bottom when tty receives output; option 854B<False>: do not scroll to bottom when tty receives output; option
901B<+si>. 855B<+si>.
902 856
903=item B<scrollWithBuffer:> I<boolean> 857=item B<scrollWithBuffer:> I<boolean>
904 858
905B<True>: scroll with scrollback buffer when tty receives new lines (and 859B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
906B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 860try to show the same lines) and B<scrollTtyOutput> is False; option
907with scrollback buffer when tty receives new lines; option B<+sw>. 861B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
862new lines; option B<+sw>.
908 863
909=item B<scrollTtyKeypress:> I<boolean> 864=item B<scrollTtyKeypress:> I<boolean>
910 865
911B<True>: scroll to bottom when a non-special key is pressed. Special keys 866B<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 867are those which are intercepted by rxvt-unicode for special handling and
968=item B<cursorBlink:> I<boolean> 923=item B<cursorBlink:> I<boolean>
969 924
970B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 925B<True>: blink the cursor. B<False>: do not blink the cursor [default];
971option B<-bc>. 926option B<-bc>.
972 927
928=item B<cursorUnderline:> I<boolean>
929
930B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
931option B<-uc>.
932
973=item B<pointerBlank:> I<boolean> 933=item B<pointerBlank:> I<boolean>
974 934
975B<True>: blank the pointer when a key is pressed or after a set number 935B<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 936of seconds of inactivity. B<False>: the pointer is always visible
977[default]. 937[default].
990large number (e.g. C<987654321>) to effectively disable the timeout. 950large number (e.g. C<987654321>) to effectively disable the timeout.
991 951
992=item B<backspacekey:> I<string> 952=item B<backspacekey:> I<string>
993 953
994The string to send when the backspace key is pressed. If set to B<DEC> 954The 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> 955or 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 956(code 8) - which can be reversed with the appropriate DEC private mode
997escape sequence. 957escape sequence.
998 958
999=item B<deletekey:> I<string> 959=item B<deletekey:> I<string>
1000 960
1079 1039
1080=item B<secondaryScroll:> I<boolean> 1040=item B<secondaryScroll:> I<boolean>
1081 1041
1082Turn on/off secondary screen scroll (default enabled). If this 1042Turn on/off secondary screen scroll (default enabled). If this
1083option is enabled, scrolls on the secondary screen will change the 1043option is enabled, scrolls on the secondary screen will change the
1084scrollback buffer and switching to/from the secondary screen will 1044scrollback buffer and, when secondaryScreen is off, switching
1085instead scroll the screen up. 1045to/from the secondary screen will instead scroll the screen up.
1086 1046
1087=item B<hold>: I<boolean> 1047=item B<hold>: I<boolean>
1088 1048
1089Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1049Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090will not immediately destroy its window when the program executed within 1050will 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 1051it exits. Instead, it will wait till it is being killed or closed by the
1092user. 1052user.
1093 1053
1054=item B<chdir>: I<path>
1055
1056Sets the working directory for the shell (or the command specified via
1057B<-e>). The I<path> must be an absolute path and it must exist for
1058@@RXVT_NAME@@ to start. If it isn't specified then the current working
1059directory will be used; option B<-cd>.
1060
1094=item B<keysym.>I<sym>: I<string> 1061=item B<keysym.>I<sym>: I<action>
1095 1062
1096Compile I<frills>: Associate I<string> with keysym I<sym>. The 1063Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1097intervening resource name B<keysym.> cannot be omitted. 1064resource name B<keysym.> cannot be omitted.
1098 1065
1099The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1066Using this resource, you can map key combinations such as
1100any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1067C<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>, 1068string 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>, 1069terminal scroll up or down the way you want it, or any other thing an
1103B<2>, B<3>, B<4>, B<5>. 1070extension might provide.
1071
1072The key combination that triggers the action, I<sym>, has the following format:
1073
1074 (modifiers-)key
1075
1076Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1077B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1078B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1079B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1104 1080
1105The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1081The 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 1082whatever 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 1083keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1108current application keymap mode state. 1084current application keymap mode state.
1109 1085
1110The spellings of I<key> can be obtained by using B<xev>(1) command or 1086Due the the large number of modifier combinations, a key mapping will
1111searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1087match if I<at least> the specified identifiers are being set, and no other
1088key mappings with those and more bits are being defined. That means that
1089defining a mapping for C<a> will automatically provide definitions for
1090C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1091themselves. See the C<builtin:> action, below, for a way to work around
1092this when this is a problem.
1093
1094The spelling of I<key> depends on your implementation of X. An easy way to
1095find a key name is to use the B<xev>(1) command. You can find a list by
1096looking 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 1097the 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 1098value (B<0x0000 - 0xFFFF>).
1114performed in an exact manner; however, the closest match is assured.
1115 1099
1116I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1100As with any resource value, the I<action> string may contain backslash
1101escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1117number), see RESOURCES in C<man 7 X> for futher details. 1102number), see RESOURCES in C<man 7 X> for further details.
1118 1103
1119You can define a range of keysyms in one shot by providing a I<string> 1104An action starts with an action prefix that selects a certain type
1120with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1105of action, followed by a colon. An action string without colons is
1106interpreted as a literal string to pass to the tty (as if it was
1107prefixed with C<string:>).
1108
1109The following action prefixes are known - extensions can provide
1110additional prefixes:
1111
1112=over 4
1113
1114=item string:STRING
1115
1116If the I<action> starts with C<string:> (or otherwise contains no colons),
1117then the remaining C<STRING> will be passed to the program running in the
1118terminal. For example, you could replace whatever Shift-Tab outputs by the
1119string C<echo rm -rf /> followed by a newline:
1120
1121 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1122
1123This could in theory be used to completely redefine your keymap.
1124
1125In addition, for actions of this type, you can define a range of
1126keysyms in one shot by loading the C<keysym-list> perl extension and
1127providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1121should be a character not used by the strings. 1128the delimiter `/' should be a character not used by the strings.
1122 1129
1123Its usage can be demonstrated by an example: 1130Its usage can be demonstrated by an example:
1124 1131
1125 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1132 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1126 1133
1127The above line is equivalent to the following three lines: 1134The above line is equivalent to the following three lines:
1128 1135
1129 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1136 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1130 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1137 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1131 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1138 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1132 1139
1140=item command:STRING
1141
1133If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1142If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1134is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1143is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1144the opposite of C<string:> - instead of sending it to the program running
1145in the terminal, it will be treated as if it were program output). This is
1146most useful to feed command sequences into @@RXVT_NAME@@.
1147
1135example the following means "change the current locale to C<zh_CN.GBK> 1148For example the following means "change the current locale to C<zh_CN.GBK>
1136when Control-Meta-c is being pressed": 1149when Control-Meta-c is being pressed":
1137 1150
1138 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1151 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1139 1152
1140If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1153The 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) 1154the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1142manpage. For example, the F<selection> extension (activated via 1155font-switching at runtime:
1143C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1144 1156
1145 URxvt.keysym.M-C-c: perl:selection:rot13 1157 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1158 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1146 1159
1147Due the the large number of modifier combinations, a defined key mapping 1160Other 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 1161info):
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 1162
1154Unfortunately, this will override built-in key mappings. For example 1163 URxvt.keysym.M-C-3: command:\033[8;25;80t
1164 URxvt.keysym.M-C-4: command:\033[8;48;110t
1165
1166=item builtin:
1167
1168The builtin action is the action that @@RXVT_NAME@@ would execute if no
1169key binding existed for the key combination. The obvious use is to undo
1170the effect of existing bindings. The not so obvious use is to reinstate
1171bindings when another binding overrides too many modifiers.
1172
1155if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1173For 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 1174@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1157user-defined keymap using the C<builtin:> replacement: 1175"holes" into the user-defined keymap using the C<builtin:> replacement:
1158 1176
1159 URxvt.keysym.Insert: <my insert key sequence> 1177 URxvt.keysym.Insert: <my insert key sequence>
1160 URxvt.keysym.S-Insert: builtin: 1178 URxvt.keysym.S-Insert: builtin:
1161 1179
1162The first line defines a mapping for C<Insert> and I<any> combination 1180The first line defines a mapping for C<Insert> and I<any> combination
1163of modifiers. The second line re-establishes the default mapping for 1181of modifiers. The second line re-establishes the default mapping for
1164C<Shift-Insert>. 1182C<Shift-Insert>.
1165 1183
1166The following example will map Control-Meta-1 and Control-Meta-2 to 1184=item builtin-string:
1167the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1168font-switching at runtime:
1169 1185
1170 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1186This action is mainly useful to restore string mappings for keys that
1171 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1187have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1188difficult to explain - basically, this action will send the string to the
1189application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1190action for it.
1172 1191
1173Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1192An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1174info): 1193selection when you press C<Shift-Insert>. With the following bindings, it
1194would instead emit the (undocumented, but what applications running in the
1195terminal might expect) sequence C<ESC [ 2 $> instead:
1175 1196
1176 URxvt.keysym.M-C-3: command:\033[8;25;80t 1197 URxvt.keysym.S-Insert: builtin-string:
1177 URxvt.keysym.M-C-4: command:\033[8;48;110t 1198 URxvt.keysym.C-S-Insert: builtin:
1199
1200The first line disables the paste functionality for that key
1201combination, and the second reinstates the default behaviour for
1202C<Control-Shift-Insert>, which would otherwise be overridden.
1203
1204Similarly, to let applications gain access to the C<C-M-c> (copy to
1205clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1206this:
1207
1208 URxvt.keysym.C-M-c: builtin-string:
1209 URxvt.keysym.C-M-v: builtin-string:
1210
1211=item EXTENSION:STRING
1212
1213An action of this form invokes the action B<STRING>, if any, provided
1214by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1215be loaded automatically if necessary.
1216
1217Not all extensions define actions, but popular extensions that do
1218include the I<selection> and I<matcher> extensions (documented in their
1219own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1220respectively).
1221
1222From the silly examples department, this will rot13-"encrypt"
1223@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1224keyboards:
1225
1226 URxvt.keysym.M-C-c: selection:rot13
1227
1228=item perl:STRING *DEPRECATED*
1229
1230This is a deprecated way of invoking commands provided by perl
1231extensions. It is still supported, but should not be used anymore.
1232
1233=back
1178 1234
1179=item B<perl-ext-common>: I<string> 1235=item B<perl-ext-common>: I<string>
1180 1236
1181=item B<perl-ext>: I<string> 1237=item B<perl-ext>: I<string>
1182 1238
1184use in this terminal instance; option B<-pe>. 1240use in this terminal instance; option B<-pe>.
1185 1241
1186Extension names can be prefixed with a C<-> sign to prohibit using 1242Extension names can be prefixed with a C<-> sign to prohibit using
1187them. This can be useful to selectively disable some extensions loaded 1243them. This can be useful to selectively disable some extensions loaded
1188by default, or specified via the C<perl-ext-common> resource. For 1244by default, or specified via the C<perl-ext-common> resource. For
1189example, C<default,-selection> will use all the default extension except 1245example, C<default,-selection> will use all the default extensions except
1190C<selection>. 1246C<selection>.
1191 1247
1192Extension names can also be followed by an argument in angle brackets 1248The default set includes the C<selection>, C<option-popup>,
1193(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1249C<selection-popup> and C<readline> extensions, any extensions that
1194searchable scrollback to Alt/Meta-s). Mentioning the same extension 1250define keybindings via C<BINDING> meta comments, and extensions which
1195multiple times with different arguments will pass multiple arguments to 1251are mentioned in B<keysym> resources.
1196the extension. 1252
1253Any extension such that a corresponding resource is given on the
1254command line is automatically appended to B<perl-ext>.
1197 1255
1198Each extension is looked up in the library directories, loaded if 1256Each extension is looked up in the library directories, loaded if
1199necessary, and bound to the current terminal instance. 1257necessary, and bound to the current terminal instance. When the library
1258search path contains multiple extension files of the same name, then the
1259first one found will be used.
1200 1260
1201If both of these resources are the empty string, then the perl 1261If both of these resources are the empty string, then the perl interpreter
1202interpreter will not be initialized. The idea behind two options is that 1262will 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 1263B<perl-ext-common> will be used for extensions that should be available to
1204all instances, while B<perl-ext> is used for specific instances. 1264all instances, while B<perl-ext> is used for specific instances.
1205 1265
1206=item B<perl-eval>: I<string> 1266=item B<perl-eval>: I<string>
1207 1267
1208Perl code to be evaluated when all extensions have been registered. See 1268Perl code to be evaluated when all extensions have been registered. See
1209the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1269the @@RXVT_NAME@@perl(3) manpage.
1210will be ignored when running setuid/setgid.
1211 1270
1212=item B<perl-lib>: I<path> 1271=item B<perl-lib>: I<path>
1213 1272
1214Colon-separated list of additional directories that hold extension 1273Colon-separated list of additional directories that hold extension
1215scripts. When looking for extensions specified by the C<perl> resource, 1274scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1216@@RXVT_NAME@@ will first look in these directories and then in 1275in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1217F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1276lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218will be ignored when running setuid/setgid.
1219 1277
1220See the @@RXVT_NAME@@perl(3) manpage. 1278See the @@RXVT_NAME@@perl(3) manpage.
1221 1279
1222=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1280=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223 1281
1227=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1285=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1228 1286
1229Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1287Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1230for details. 1288for details.
1231 1289
1232=item B<searchable-scrollback:> I<keysym> 1290=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1233 1291
1234Sets the hotkey that starts the incremental scrollback buffer search 1292This resource is deprecated and will be removed. Use a B<keysym> resource
1235(default: C<M-s>). 1293instead, e.g.:
1236 1294
1295 URxvt.keysym.M-s: searchable-scrollback:start
1296
1237=item B<urlLauncher>: I<string> 1297=item B<url-launcher>: I<string>
1238 1298
1239Specifies the program to be started with a URL argument. Used by the 1299Specifies the program to be started with a URL argument. Used by the
1240C<selection-popup> and C<matcher> perl extensions. 1300C<selection-popup> and C<matcher> perl extensions.
1241 1301
1242=item B<transient-for>: I<windowid> 1302=item B<transient-for>: I<windowid>
1246=item B<override-redirect>: I<boolean> 1306=item B<override-redirect>: I<boolean>
1247 1307
1248Compile I<frills>: Sets override-redirect for the terminal window, making 1308Compile I<frills>: Sets override-redirect for the terminal window, making
1249it almost invisible to window managers; option B<-override-redirect>. 1309it almost invisible to window managers; option B<-override-redirect>.
1250 1310
1311=item B<iso14755:> I<boolean>
1312
1313Turn on/off ISO 14755 (default enabled).
1314
1251=item B<iso14755_52:> I<boolean> 1315=item B<iso14755_52:> I<boolean>
1252 1316
1253Turn on/off ISO 14755 5.2 mode (default enabled). 1317Turn on/off ISO 14755 5.2 mode (default enabled).
1318
1319=back
1320
1321=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1322
1323=over 4
1324
1325=item B<-pixmap> I<file[;oplist]>
1326
1327=item B<backgroundPixmap:> I<file[;oplist]>
1328
1329Compile I<pixbuf>: Use the specified image file as the window's
1330background and also optionally specify a colon separated list of
1331operations to modify it. Note that you may need to quote the C<;>
1332character when using the command line option, as C<;> is usually a
1333metacharacter in shells. Supported operations are:
1334
1335=over 4
1336
1337=item B<WxH+X+Y>
1338
1339sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1340scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1341scale of 0 disables scaling.
1342
1343=item B<op=tile>
1344
1345enables tiling
1346
1347=item B<op=keep-aspect>
1348
1349maintain the image aspect ratio when scaling
1350
1351=item B<op=root-align>
1352
1353use the position of the terminal window relative to the root window as
1354the image offset, simulating a root window background
1355
1356=back
1357
1358The default scale and position setting is C<100x100+50+50>.
1359Alternatively, a predefined set of templates can be used to achieve
1360the most common setups:
1361
1362=over 4
1363
1364=item B<style=tiled>
1365
1366the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1367
1368=item B<style=aspect-stretched>
1369
1370the image is scaled to fill the whole window maintaining the aspect
1371ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1372
1373=item B<style=stretched>
1374
1375the image is scaled to fill the whole window. Equivalent to 100x100
1376
1377=item B<style=centered>
1378
1379the image is centered with no scaling. Equivalent to 0x0+50+50
1380
1381=item B<style=root-tiled>
1382
1383the image is tiled with no scaling and using 'root' positioning.
1384Equivalent to 0x0:op=tile:op=root-align
1385
1386=back
1387
1388If multiple templates are specified the last one wins. Note that a
1389template overrides all the scale, position and operations settings.
1390
1391If used in conjunction with pseudo-transparency, the specified pixmap
1392will be blended over the transparent background using alpha-blending.
1393
1394=item B<-tr>|B<+tr>
1395
1396=item B<transparent:> I<boolean>
1397
1398Turn on/off pseudo-transparency by using the root pixmap as background.
1399
1400B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1401will be removed in future versions.
1402
1403=item B<-tint> I<colour>
1404
1405=item B<tintColor:> I<colour>
1406
1407Tint the transparent background with the given colour. Note that a
1408black tint yields a completely black image while a white tint yields
1409the image unchanged.
1410
1411=item B<-sh> I<number>
1412
1413=item B<shading:> I<number>
1414
1415Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1416A value of 100 means no shading.
1417
1418=item B<-blr> I<HxV>
1419
1420=item B<blurRadius:> I<HxV>
1421
1422Apply gaussian blur with the specified radius to the transparent
1423background. If a single number is specified, the vertical and
1424horizontal radii are considered to be the same. Setting one of the
1425radii to 1 and the other to a large number creates interesting effects
1426on some backgrounds. The maximum radius value is 128. An horizontal or
1427vertical radius of 0 disables blurring.
1428
1429=item B<path:> I<path>
1430
1431Specify the colon-delimited search path for finding background image files.
1254 1432
1255=back 1433=back
1256 1434
1257=head1 THE SCROLLBAR 1435=head1 THE SCROLLBAR
1258 1436
1306window causes the value of the PRIMARY selection (or CLIPBOARD with the 1484window 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. 1485B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1308 1486
1309Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1487Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1310inserted too. 1488inserted too.
1489
1490rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1491<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1492binding causes the value of the internal selection to be copied to the
1493CLIPBOARD selection, while the second binding causes the value of the
1494CLIPBOARD selection to be inserted.
1311 1495
1312=back 1496=back
1313 1497
1314=head1 CHANGING FONTS 1498=head1 CHANGING FONTS
1315 1499
1397B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1581B<@@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 1582it 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 1583allow 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. 1584on some systems or setgid to root or to some other group on others.
1401 1585
1402=head1 COLORS AND GRAPHICS 1586=head1 COLOURS AND GRAPHICS
1403 1587
1404In addition to the default foreground and background colours, 1588In addition to the default foreground and background colours,
1405B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1589B<@@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 1590high-intensity (potentially bold/blink) versions of the same, and 72 (or
1407colours with their names. 1591240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1592cube plus a 8 (24) colour greyscale ramp.
1593
1594Here is a list of the ANSI colours with their names.
1408 1595
1409=begin table 1596=begin table
1410 1597
1411 B<color0> (black) = Black 1598 B<color0> (black) = Black
1412 B<color1> (red) = Red3 1599 B<color1> (red) = Red3
1432It is also possible to specify the colour values of B<foreground>, 1619It is also possible to specify the colour values of B<foreground>,
1433B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1620B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1434a number 0-15, as a convenient shorthand to reference the colour name of 1621a number 0-15, as a convenient shorthand to reference the colour name of
1435color0-color15. 1622color0-color15.
1436 1623
1437In addition to the colours defined above, @@RXVT_NAME@@ offers an 1624The following text gives values for the standard 88 colour mode (and
1438additional 72 colours. The first 64 of those (with indices 16 to 79) 1625values 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 1626
1627The RGB cube uses indices 16..79 (16..231) using the following formulas:
1628
1629 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1630 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1631
1632The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1633steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1634the RGB cube.
1635
1442Together, all those colours implement the 88 colour xterm colours. Only 1636Together, all those colours implement the 88 (256) colour xterm
1443the first 16 can be changed using resources currently, the rest can only 1637colours. Only the first 16 can be changed using resources currently, the
1444be changed via command sequences ("escape codes"). 1638rest can only be changed via command sequences ("escape codes").
1639
1640Applications are advised to use terminfo or command sequences to discover
1641number and RGB values of all colours (yes, you can query this...).
1445 1642
1446Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1643Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1447always swapping the foreground/background colours. This is in contrast to 1644always swapping the foreground/background colours. This is in contrast to
1448I<xterm>(1) where the colours are only swapped if they have not otherwise 1645I<xterm>(1) where the colours are only swapped if they have not otherwise
1449been specified. For example, 1646been specified. For example,
1450 1647
1451=over 4
1452
1453=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1648 @@RXVT_NAME@@ -fg Black -bg White -rv
1454 1649
1455would yield White on Black, while on I<xterm>(1) it would yield Black 1650would yield White on Black, while on I<xterm>(1) it would yield Black on
1456on White. 1651White.
1457
1458=back
1459 1652
1460=head2 ALPHA CHANNEL SUPPORT 1653=head2 ALPHA CHANNEL SUPPORT
1461 1654
1462If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1655If 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> 1656their act together, rxvt-unicode will do its own alpha channel management:
1464(recommended, but B<MUST> have 4 digits/component) colour specifications, 1657
1465in addition to the ones provided by X, where the additional A component 1658You can prefix any colour with an opaqueness percentage enclosed in
1659brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1660(0-100) that specifies the opacity of the colour, where C<0> is completely
1661transparent and C<100> is completely opaque. For example, C<[50]red> is a
1662half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1663is the recommended format to specify transparency values, and works with
1664all ways to specify a colour.
1665
1666For complete control, rxvt-unicode also supports
1667C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1668specifications, where the additional C<aaaa> component specifies opacity
1466specifies opacity (alpha) values. The minimum value of C<0> is completely 1669(alpha) values. The minimum value of C<0000> is completely transparent,
1467transparent). You can also prefix any color with C<[percent]>, where 1670while C<ffff> is completely opaque). The two example colours from
1468C<percent> is a decimal percentage (0-100) that specifies the opacity of 1671earlier 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 1672C<rgba:0000/ff00/0000/f332>.
1470opaque.
1471 1673
1472You probably need to specify B<"-depth 32">, too, and have the luck that 1674You 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 1675alpha channels, and have the luck that your X-server uses ARGB pixel
1474ARGB visuals out of the box, and rxvt-unicode just fudges around. 1676layout, as X is far from just supporting ARGB visuals out of the box, and
1677rxvt-unicode just fudges around.
1475 1678
1476For example, the following selects an almost completely transparent red 1679For example, the following selects an almost completely transparent black
1477background, and an almost opaque pink foreground: 1680background, and an almost opaque pink foreground:
1478 1681
1479 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1682 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480 1683
1481I<Please note that transparency of any kind if completely unsupported by 1684When not using a background image, then the interpretation of the
1482the author. Don't bug him with installation questions!> 1685alpha channel is up to your compositing manager (most interpret it as
1686transparency of course).
1687
1688When using a background pixmap or pseudo-transparency, then the background
1689colour will always behave as if it were completely transparent (so the
1690background image shows instead), regardless of how it was specified, while
1691other colours will either be transparent as specified (the background
1692image will show through) on servers supporting the RENDER extension, or
1693fully opaque on servers not supporting the RENDER EXTENSION.
1694
1695Please note that due to bugs in Xft, specifying alpha values might result
1696in garbage being displayed when the X-server does not support the RENDER
1697extension.
1483 1698
1484=head1 ENVIRONMENT 1699=head1 ENVIRONMENT
1485 1700
1486B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1701B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487 1702
1521C<--with-terminfo=PATH>. 1736C<--with-terminfo=PATH>.
1522 1737
1523=item B<DISPLAY> 1738=item B<DISPLAY>
1524 1739
1525Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1740Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526display in its child processes. 1741display in its child processes if C<-display> isn't used to override. It
1742defaults to C<:0> if it doesn't exist.
1527 1743
1528=item B<SHELL> 1744=item B<SHELL>
1529 1745
1530The shell to be used for command execution, defaults to C</bin/sh>. 1746The shell to be used for command execution, defaults to C</bin/sh>.
1531 1747
1532=item B<RXVT_SOCKET> 1748=item B<RXVT_SOCKET> [I<sic>]
1533 1749
1534The unix domain socket path used by @@RXVT_NAME@@c(1) and 1750The unix domain socket path used by @@RXVT_NAME@@c(1) and
1535@@RXVT_NAME@@d(1). 1751@@RXVT_NAME@@d(1).
1536 1752
1537Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1753Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1754
1755=item B<URXVT_PERL_LIB>
1756
1757Additional F<:>-separated library search path for perl extensions. Will be
1758searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1759directory.
1760
1761=item B<URXVT_PERL_VERBOSITY>
1762
1763See L<@@RXVT_NAME@@perl>(3).
1538 1764
1539=item B<HOME> 1765=item B<HOME>
1540 1766
1541Used to locate the default directory for the unix domain socket for 1767Used to locate the default directory for the unix domain socket for
1542daemon communications and to locate various resource files (such as 1768daemon communications and to locate various resource files (such as
1543C<.Xdefaults>) 1769C<.Xdefaults>)
1544 1770
1545=item B<XAPPLRESDIR> 1771=item B<XAPPLRESDIR>
1546 1772
1547Directory where various X resource files are being located. 1773Directory where application-specific X resource files are located.
1548 1774
1549=item B<XENVIRONMENT> 1775=item B<XENVIRONMENT>
1550 1776
1551If set and accessible, gives the name of a X resource file to be loaded by 1777If set and accessible, gives the name of a X resource file to be loaded by
1552@@RXVT_NAME@@. 1778@@RXVT_NAME@@.
1557 1783
1558=over 4 1784=over 4
1559 1785
1560=item B</usr/lib/X11/rgb.txt> 1786=item B</usr/lib/X11/rgb.txt>
1561 1787
1562Color names. 1788Colour names.
1563 1789
1564=back 1790=back
1565 1791
1566=head1 SEE ALSO 1792=head1 SEE ALSO
1567 1793
1794@@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) 1795@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1569 1796
1570=head1 CURRENT PROJECT COORDINATOR 1797=head1 CURRENT PROJECT COORDINATOR
1571 1798
1572=over 4 1799=over 4
1573 1800
1574=item Project Coordinator 1801=item Project Coordinator
1575 1802
1576Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1803Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1577 1804
1578L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1805L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1579 1806
1580=back 1807=back
1581 1808
1585 1812
1586=item John Bovey 1813=item John Bovey
1587 1814
1588University of Kent, 1992, wrote the original Xvt. 1815University of Kent, 1992, wrote the original Xvt.
1589 1816
1590=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1817=item Rob Nation <nation@rocket.sanders.lockheed.com>
1591 1818
1592very heavily modified Xvt and came up with Rxvt 1819very heavily modified Xvt and came up with Rxvt
1593 1820
1594=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1821=item Angelo Haritsis <ah@doc.ic.ac.uk>
1595 1822
1596wrote the Greek Keyboard Input (no longer in code) 1823wrote the Greek Keyboard Input (no longer in code)
1597 1824
1598=item mj olesen L<< <olesen@me.QueensU.CA> >> 1825=item mj olesen <olesen@me.QueensU.CA>
1599 1826
1600Wrote the menu system. 1827Wrote the menu system.
1601 1828
1602Project Coordinator (changes.txt 2.11 to 2.21) 1829Project Coordinator (changes.txt 2.11 to 2.21)
1603 1830
1604=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1831=item Oezguer Kesim <kesim@math.fu-berlin.de>
1605 1832
1606Project Coordinator (changes.txt 2.21a to 2.4.5) 1833Project Coordinator (changes.txt 2.21a to 2.4.5)
1607 1834
1608=item Geoff Wing L<< <gcw@pobox.com> >> 1835=item Geoff Wing <gcw@pobox.com>
1609 1836
1610Rewrote screen display and text selection routines. 1837Rewrote screen display and text selection routines.
1611 1838
1612Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1839Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1613 1840
1614=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1841=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1615 1842
1616Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1843Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1617extension, random hacks, numerous bugfixes and extensions. 1844extension, random hacks, numerous bugfixes and extensions.
1618 1845
1619Project Coordinator (Changes 1.0 -) 1846Project Coordinator (Changes 1.0 -)
1620 1847
1621=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1848=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1622 1849
1623Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1850pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1624 1851
1625=back 1852=back
1626 1853

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines