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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines