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.140 by sasha, Fri Oct 26 18:27:29 2007 UTC vs.
Revision 1.230 by sf-exg, Mon Apr 28 16:00:34 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; resource
151I<tintColor>. Example:
152
153 @@RXVT_NAME@@ -tr -tint blue -sh 40
154
155=item B<-sh> I<number>
156
157Darken (0 .. 100) or lighten (-1 .. -100) the transparent
158background image in addition to (or instead of) tinting it;
159resource I<shading>.
160
161=item B<-blt> I<string>
162
163Specify background blending type. If background pixmap is specified
164at the same time as transparency - such pixmap will be blended over
165transparency image, using method specified. Supported values are :
166B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
167B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
168B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
169alpha-blending. Compile I<afterimage>; resource I<blendType>.
170
171=item B<-blr> I<HxV>
172
173Apply Gaussian Blur with the specified radii to the transparent
174background image. If single number is specified - both vertical and
175horizontal radii are considered to be the same. Setting one of the
176radii to 1 and another to a large number creates interesting effects
177on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
178resource I<blurRadius>.
179 148
180=item B<-bg> I<colour> 149=item B<-bg> I<colour>
181 150
182Window background colour; resource B<background>. 151Window background colour; resource B<background>.
183 152
184=item B<-fg> I<colour> 153=item B<-fg> I<colour>
185 154
186Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
187
188=item B<-pixmap> I<file[;geom]>
189
190Compile I<afterimage>: Specify image file for the background and also
191optionally specify its scaling with a geometry string. Note you may need to
192add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>.
194 156
195=item B<-cr> I<colour> 157=item B<-cr> I<colour>
196 158
197The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
198 160
243italic> >> characters are to be printed. See resource B<boldItalicFont> 205italic> >> characters are to be printed. See resource B<boldItalicFont>
244for details. 206for details.
245 207
246=item B<-is>|B<+is> 208=item B<-is>|B<+is>
247 209
248Compile I<font-styles>: Bold/Italic font styles imply high intensity 210Compile I<font-styles>: Bold/Blink font styles imply high intensity
249foreground/background (default). See resource B<intensityStyles> for 211foreground/background (default). See resource B<intensityStyles> for
250details. 212details.
251 213
252=item B<-name> I<name> 214=item B<-name> I<name>
253 215
271 233
272=item B<-sb>|B<+sb> 234=item B<-sb>|B<+sb>
273 235
274Turn on/off scrollbar; resource B<scrollBar>. 236Turn on/off scrollbar; resource B<scrollBar>.
275 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
276=item B<-si>|B<+si> 247=item B<-si>|B<+si>
277 248
278Turn on/off scroll-to-bottom on TTY output inhibit; resource 249Turn on/off scroll-to-bottom on TTY output inhibit; resource
279B<scrollTtyOutput> has opposite effect. 250B<scrollTtyOutput> has opposite effect.
280 251
286=item B<-sw>|B<+sw> 257=item B<-sw>|B<+sw>
287 258
288Turn on/off scrolling with the scrollback buffer as new lines appear. 259Turn on/off scrolling with the scrollback buffer as new lines appear.
289This only takes effect if B<-si> is also given; resource 260This only takes effect if B<-si> is also given; resource
290B<scrollWithBuffer>. 261B<scrollWithBuffer>.
291
292=item B<-sr>|B<+sr>
293
294Put scrollbar on right/left; resource B<scrollBar_right>.
295
296=item B<-st>|B<+st>
297
298Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
299resource B<scrollBar_floating>.
300 262
301=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
302 264
303If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
304actual wide characters in the screen buffer, which makes it possible to 266actual wide characters in the screen buffer, which makes it possible to
308 270
309=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
310 272
311Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
312 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
313=item B<-iconic> 279=item B<-iconic>
314 280
315Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
316Alternative form is B<-ic>. 282Alternative form is B<-ic>.
317 283
333 299
334=item B<-bl> 300=item B<-bl>
335 301
336Compile 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.
337if 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
338decorations; resource B<borderLess>. 304decorations; resource B<borderLess>. If the window manager does not
305support MWM hints (e.g. kwin), enables override-redirect mode.
339 306
340=item B<-override-redirect> 307=item B<-override-redirect>
341 308
342Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
343B<override-redirect>. 310B<override-redirect>.
352=item B<-lsp> I<number> 319=item B<-lsp> I<number>
353 320
354Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
355the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
356B<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>.
357 331
358=item B<-tn> I<termname> 332=item B<-tn> I<termname>
359 333
360This 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
361B<TERM> environment variable. This terminal type must exist in the 335B<TERM> environment variable. This terminal type must exist in the
416 390
417=item B<-tcw> 391=item B<-tcw>
418 392
419Change the meaning of triple-click selection with the left mouse 393Change the meaning of triple-click selection with the left mouse
420button. Only effective when the original (non-perl) selection code is 394button. Only effective when the original (non-perl) selection code is
421in-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
422end of the logical line only. resource B<tripleclickwords>. 396the end of the logical line only. resource B<tripleclickwords>.
423 397
424=item B<-insecure> 398=item B<-insecure>
425 399
426Enable "insecure" mode, which currently enables most of the escape 400Enable "insecure" mode, which currently enables most of the escape
427sequences that echo strings. See the resource B<insecure> for more 401sequences that echo strings. See the resource B<insecure> for more
447 421
448Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 422Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
449will not immediately destroy its window when the program executed within 423will not immediately destroy its window when the program executed within
450it 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
451user; 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.
452 445
453=item B<-keysym.>I<sym> I<string> 446=item B<-keysym.>I<sym> I<string>
454 447
455Remap a key symbol. See resource B<keysym>. 448Remap a key symbol. See resource B<keysym>.
456 449
491If 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
492entries 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
493yourself if you want that. 486yourself if you want that.
494 487
495As an extremely special case, specifying C<-1> will completely suppress 488As an extremely special case, specifying C<-1> will completely suppress
496pty/tty operations. 489pty/tty operations, which is probably only useful in conjunction with some
490perl extension that manages the terminal.
497 491
498Here 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
499longer example is in F<doc/pty-fd>): 493longer example is in F<doc/pty-fd>):
500 494
501 use IO::Pty; 495 use IO::Pty;
515Comma-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
516this terminal instance. See resource B<perl-ext> for details. 510this terminal instance. See resource B<perl-ext> for details.
517 511
518=back 512=back
519 513
520=head1 RESOURCES (available also as long-options) 514=head1 RESOURCES
521 515
522Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 516Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
523options) compiled into your version. 517options) compiled into your version. All resources are also available as
518long-options.
524 519
525You 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
526distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
527starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
528with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
529 524
530 1. system-wide app-defaults file, either locale-dependent OR global
531 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
532 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
533 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
534 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
530 6. resources specified via -xrm on the commandline
535 531
536Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
537names: 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
538common 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
539configured, while the class name B<URxvt> allows resources unique to 535configured, while the class name B<URxvt> allows resources unique to
549=item B<depth:> I<bitdepth> 545=item B<depth:> I<bitdepth>
550 546
551Compile 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;
552option B<-depth>. 548option B<-depth>.
553 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
554=item B<geometry:> I<geom> 557=item B<geometry:> I<geom>
555 558
556Create the window with the specified X window geometry [default 80x24]; 559Create the window with the specified X window geometry [default 80x24];
557option B<-geometry>. 560option B<-geometry>.
558 561
571Use 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
572corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
573high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
574colours. 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,
5753=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
576names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
577 580
578Colours 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
579changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
580 583
581Colours 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
592=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
593 596
594Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
595foreground colour is the default. 598foreground colour is the default.
596 599
597=item B<colorRV:> I<colour>
598
599Use the specified colour as the background for reverse video characters
600when OPTION_HC is disabled (--disable-frills).
601
602=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
603 601
604If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
605itself. 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.
606 614
607=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
608 616
609Use 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
610foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
617 625
618=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
619 627
620B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
621option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
622B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
623 631
624=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
625 633
626B<True>: specify that jump scrolling should be used. When receiving lots 634B<True>: specify that jump scrolling should be used. When receiving lots
627of 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
641 649
642B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
643if 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
644monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
645 653
646=item B<inheritPixmap:> I<boolean>
647
648B<True>: make the background inherit the parent windows' pixmap, giving
649artificial transparency. B<False>: do not inherit the parent windows'
650pixmap.
651
652I<Please note that transparency of any kind if completely unsupported by
653the author. Don't bug him with installation questions!>
654
655=item B<fading:> I<number> 654=item B<fading:> I<number>
656 655
657Fade 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>.
658 657
659=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
660 659
661Fade 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
662colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
663 662
664=item B<tintColor:> I<colour> 663=item B<iconFile:> I<file>
665 664
666Tint the transparent background pixmap with the given colour; option 665Set the application icon pixmap; option B<-icon>.
667B<-tint>.
668
669=item B<shading:> I<number>
670
671Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
672in addition to tinting it; option B<-sh>.
673
674=item B<blendType:> I<string>
675
676Specify background blending type; option B<-blt>.
677
678=item B<blurRadius:> I<number>
679
680Apply Gaussian Blurr with the specified radius to the transparent
681background image; option B<-blr>.
682 666
683=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
684 668
685Use the specified colour for the scrollbar [default #B2B2B2]. 669Use the specified colour for the scrollbar [default #B2B2B2].
686 670
691 675
692=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
693 677
694The 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
695and the text. 679and the text.
696
697=item B<backgroundPixmap:> I<file[;geom]>
698
699Use the specified image file for the background and also optionally
700specify its scaling with a geometry string B<WxH+X+Y>,
701in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
702and B<"X" / "Y"> locate the image centre (percent).
703A scale of 0 displays the image with tiling. A scale of 1 displays the
704image without any scaling. A scale of 2 to 9 specifies an integer
705number of images in that direction. No image will be magnified beyond
70610 times its original size. The maximum permitted scale is 1000.
707Special string of B<"auto"> used as a geometry will cause image to be
708automatically scaled to match window size.
709If used in conjunction with B<-tr> option - specified pixmap will be
710blended over transparency image using either alpha-blending, or any
711other blending type, specified with B<-blt "type"> option.
712[default 0x0+50+50]
713
714=item B<path:> I<path>
715
716Specify the colon-delimited search path for finding background image files.
717 680
718=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
719 682
720Select 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
721that 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
744it 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
745wide and 15 pixels high. 708wide and 15 pixels high.
746 709
747The 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
748the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
749the 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
750useful supplement. 713useful supplement.
751 714
752The 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
753are 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
754contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
778text font will being used for the given style. 741text font will being used for the given style.
779 742
780=item B<intensityStyles:> I<boolean> 743=item B<intensityStyles:> I<boolean>
781 744
782When 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>,
783option B<-is>, the default), bold and italic font styles imply high 746option B<-is>, the default), bold/blink font styles imply high
784intensity foreground/background colours. Disabling this option (B<False>, 747intensity foreground/background colours. Disabling this option (B<False>,
785option B<+is>) disables this behaviour, the high intensity colours are not 748option B<+is>) disables this behaviour, the high intensity colours are not
786reachable. 749reachable.
787 750
788=item B<selectstyle:> I<mode>
789
790Set mouse selection style to B<old> which is 2.20, B<oldword> which
791is xterm style with 2.20 old word selection, or anything else which
792gives xterm style selection. Only effective when the original (non-perl)
793selection code is in use.
794
795=item B<scrollstyle:> I<mode>
796
797Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
798the author's favourite.
799
800=item B<title:> I<string> 751=item B<title:> I<string>
801 752
802Set window title string, the default title is the command-line 753Set window title string, the default title is the command-line
803specified after the B<-e> option, if any, otherwise the application 754specified after the B<-e> option, if any, otherwise the application
804name; option B<-title>. 755name; option B<-title>.
817=item B<urgentOnBell:> I<boolean> 768=item B<urgentOnBell:> I<boolean>
818 769
819B<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.
820B<False>: do not set the urgency hint [default]. 771B<False>: do not set the urgency hint [default].
821 772
773@@RXVT_NAME@@ resets the urgency hint on every focus change.
774
822=item B<visualBell:> I<boolean> 775=item B<visualBell:> I<boolean>
823 776
824B<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>.
825B<False>: no visual bell [default]; option B<+vb>. 778B<False>: no visual bell [default]; option B<+vb>.
826 779
849 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 802 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
850 803
851This 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
852every time you hit C<Print>. 805every time you hit C<Print>.
853 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
854=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
855 817
856B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
857disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
858 820
877B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
878B<+si>. 840B<+si>.
879 841
880=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
881 843
882B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
883B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
884with 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>.
885 848
886=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
887 850
888B<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
889are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
945=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
946 909
947B<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];
948option B<-bc>. 911option B<-bc>.
949 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
950=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
951 919
952B<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
953of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
954[default]. 922[default].
967large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
968 936
969=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
970 938
971The 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>
972or 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>
973(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
974escape sequence. 942escape sequence.
975 943
976=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
977 945
990will 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.
991 959
992When 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
993be used. If not specified, the built-in default is used: 961be used. If not specified, the built-in default is used:
994 962
995B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
996 964
997=item B<preeditType:> I<style> 965=item B<preeditType:> I<style>
998 966
999B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1000 968
1056 1024
1057=item B<secondaryScroll:> I<boolean> 1025=item B<secondaryScroll:> I<boolean>
1058 1026
1059Turn on/off secondary screen scroll (default enabled). If this 1027Turn on/off secondary screen scroll (default enabled). If this
1060option is enabled, scrolls on the secondary screen will change the 1028option is enabled, scrolls on the secondary screen will change the
1061scrollback buffer and switching to/from the secondary screen will 1029scrollback buffer and, when secondaryScreen is off, switching
1062instead scroll the screen up. 1030to/from the secondary screen will instead scroll the screen up.
1063 1031
1064=item B<hold>: I<boolean> 1032=item B<hold>: I<boolean>
1065 1033
1066Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1034Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1067will not immediately destroy its window when the program executed within 1035will not immediately destroy its window when the program executed within
1068it 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
1069user. 1037user.
1070 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
1071=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1072 1047
1073Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1074intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1075 1050
1076The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1077any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1078B<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
1079and 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
1080B<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>.
1081 1065
1082The 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
1083whatever 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
1084keys 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
1085current application keymap mode state. 1069current application keymap mode state.
1086 1070
1087The 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
1088searching 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
1089omitting 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
1090keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1091performed in an exact manner; however, the closest match is assured.
1092 1084
1093I<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
1094number), see RESOURCES in C<man 7 X> for futher details. 1087number), see RESOURCES in C<man 7 X> for further details.
1095 1088
1096You 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
1097with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1090of action, followed by a colon. An action strings without colons is
1098should be a character not used by the strings. 1091interpreted as a literal string to pass to the tty (as if they were
1092prefixed with C<string:>).
1099 1093
1100Its usage can be demonstrated by an example: 1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1101 1096
1102 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1097=over 4
1103 1098
1104The above line is equivalent to the following three lines: 1099=item string:STRING
1105 1100
1106 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1107 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1102then the remaining C<STRING> will be passed to the program running in the
1108 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:
1109 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
1110If 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>
1111is 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
1112example 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>
1113when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1114 1120
1115 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
1116 1122
1117If 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
1118is 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
1119manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1120C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1121 1126
1122 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
1123 1129
1124Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1125will match if at I<at least> the specified identifiers are being set, and 1131info):
1126no other key mappings with those and more bits are being defined. That
1127means that defining a key map for C<a> will automatically provide
1128definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1129mappings themselves.
1130 1132
1131Unfortunately, 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
1132if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1133C<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
1134user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1135 1146
1136 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1137 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1138 1149
1139The 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
1140of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1141C<Shift-Insert>. 1152C<Shift-Insert>.
1142 1153
1143The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item builtin-string:
1144the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1145font-switching at runtime:
1146 1155
1147 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1156This action is mainly useful to restore string mappings for keys that
1148 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.
1149 1161
1150Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1162An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1151info): 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:
1152 1166
1153 URxvt.keysym.M-C-3: command:\033[8;25;80t 1167 URxvt.keysym.S-Insert: builtin-string:
1154 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
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
1204
1205In addition, you can define a range of keysyms in one shot by loading
1206the C<keysym-list> perl extension and providing a I<string> with pattern
1207B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1208character not used by the strings.
1209
1210Its usage can be demonstrated by an example:
1211
1212 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1213
1214The above line is equivalent to the following three lines:
1215
1216 URxvt.keysym.Meta-Control-0x61: \033<a>
1217 URxvt.keysym.Meta-Control-0x62: \033<b>
1218 URxvt.keysym.Meta-Control-0x63: \033<c>
1155 1219
1156=item B<perl-ext-common>: I<string> 1220=item B<perl-ext-common>: I<string>
1157 1221
1158=item B<perl-ext>: I<string> 1222=item B<perl-ext>: I<string>
1159 1223
1181all instances, while B<perl-ext> is used for specific instances. 1245all instances, while B<perl-ext> is used for specific instances.
1182 1246
1183=item B<perl-eval>: I<string> 1247=item B<perl-eval>: I<string>
1184 1248
1185Perl code to be evaluated when all extensions have been registered. See 1249Perl code to be evaluated when all extensions have been registered. See
1186the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1250the @@RXVT_NAME@@perl(3) manpage.
1187will be ignored when running setuid/setgid.
1188 1251
1189=item B<perl-lib>: I<path> 1252=item B<perl-lib>: I<path>
1190 1253
1191Colon-separated list of additional directories that hold extension 1254Colon-separated list of additional directories that hold extension
1192scripts. When looking for extensions specified by the C<perl> resource, 1255scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1193@@RXVT_NAME@@ will first look in these directories and then in 1256in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1194F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1257lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1195will be ignored when running setuid/setgid.
1196 1258
1197See the @@RXVT_NAME@@perl(3) manpage. 1259See the @@RXVT_NAME@@perl(3) manpage.
1198 1260
1199=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1261=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1200 1262
1209=item B<searchable-scrollback:> I<keysym> 1271=item B<searchable-scrollback:> I<keysym>
1210 1272
1211Sets the hotkey that starts the incremental scrollback buffer search 1273Sets the hotkey that starts the incremental scrollback buffer search
1212(default: C<M-s>). 1274(default: C<M-s>).
1213 1275
1214=item B<urlLauncher>: I<string> 1276=item B<url-launcher>: I<string>
1215 1277
1216Specifies the program to be started with a URL argument. Used by the 1278Specifies the program to be started with a URL argument. Used by the
1217C<selection-popup> and C<matcher> perl extensions. 1279C<selection-popup> and C<matcher> perl extensions.
1218 1280
1219=item B<transient-for>: I<windowid> 1281=item B<transient-for>: I<windowid>
1223=item B<override-redirect>: I<boolean> 1285=item B<override-redirect>: I<boolean>
1224 1286
1225Compile I<frills>: Sets override-redirect for the terminal window, making 1287Compile I<frills>: Sets override-redirect for the terminal window, making
1226it almost invisible to window managers; option B<-override-redirect>. 1288it almost invisible to window managers; option B<-override-redirect>.
1227 1289
1290=item B<iso14755:> I<boolean>
1291
1292Turn on/off ISO 14755 (default enabled).
1293
1228=item B<iso14755_52:> I<boolean> 1294=item B<iso14755_52:> I<boolean>
1229 1295
1230Turn on/off ISO 14755 5.2 mode (default enabled). 1296Turn on/off ISO 14755 5.2 mode (default enabled).
1297
1298=back
1299
1300=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1301
1302=over 4
1303
1304=item B<-pixmap> I<file[;oplist]>
1305
1306=item B<backgroundPixmap:> I<file[;oplist]>
1307
1308Compile I<pixbuf>: Use the specified image file as the window's
1309background and also optionally specify a colon separated list of
1310operations to modify it. Note that you may need to quote the C<;>
1311character when using the command line option, as C<;> is usually a
1312metacharacter in shells. Supported operations are:
1313
1314=over 4
1315
1316=item B<WxH+X+Y>
1317
1318sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1319scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1320scale of 0 disables scaling.
1321
1322=item B<op=tile>
1323
1324enables tiling
1325
1326=item B<op=keep-aspect>
1327
1328maintain the image aspect ratio when scaling
1329
1330=item B<op=root-align>
1331
1332use the position of the terminal window relative to the root window as
1333the image offset, simulating a root window background
1334
1335=back
1336
1337The default scale and position setting is C<100x100+50+50>.
1338Alternatively, a predefined set of templates can be used to achieve
1339the most common setups:
1340
1341=over 4
1342
1343=item B<style=tiled>
1344
1345the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1346
1347=item B<style=aspect-stretched>
1348
1349the image is scaled to fill the whole window maintaining the aspect
1350ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1351
1352=item B<style=stretched>
1353
1354the image is scaled to fill the whole window. Equivalent to 100x100
1355
1356=item B<style=centered>
1357
1358the image is centered with no scaling. Equivalent to 0x0+50+50
1359
1360=item B<style=root-tiled>
1361
1362the image is tiled with no scaling and using 'root' positioning.
1363Equivalent to 0x0:op=tile:op=root-align
1364
1365=back
1366
1367If multiple templates are specified the last one wins. Note that a
1368template overrides all the scale, position and operations settings.
1369
1370If used in conjunction with pseudo-transparency, the specified pixmap
1371will be blended over the transparent background using alpha-blending.
1372
1373=item B<-tr>|B<+tr>
1374
1375=item B<transparent:> I<boolean>
1376
1377Turn on/off pseudo-transparency by using the root pixmap as background.
1378
1379B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1380will be removed in future versions.
1381
1382=item B<-tint> I<colour>
1383
1384=item B<tintColor:> I<colour>
1385
1386Tint the transparent background with the given colour. Note that a
1387black tint yields a completely black image while a white tint yields
1388the image unchanged.
1389
1390=item B<-sh> I<number>
1391
1392=item B<shading:> I<number>
1393
1394Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1395A value of 100 means no shading.
1396
1397=item B<-blr> I<HxV>
1398
1399=item B<blurRadius:> I<HxV>
1400
1401Apply gaussian blur with the specified radius to the transparent
1402background. If a single number is specified, the vertical and
1403horizontal radii are considered to be the same. Setting one of the
1404radii to 1 and the other to a large number creates interesting effects
1405on some backgrounds. The maximum radius value is 128. An horizontal or
1406vertical radius of 0 disables blurring.
1407
1408=item B<path:> I<path>
1409
1410Specify the colon-delimited search path for finding background image files.
1231 1411
1232=back 1412=back
1233 1413
1234=head1 THE SCROLLBAR 1414=head1 THE SCROLLBAR
1235 1415
1283window causes the value of the PRIMARY selection (or CLIPBOARD with the 1463window causes the value of the PRIMARY selection (or CLIPBOARD with the
1284B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1464B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1285 1465
1286Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1466Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1287inserted too. 1467inserted too.
1468
1469rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1470<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1471binding causes the value of the internal selection to be copied to the
1472CLIPBOARD selection, while the second binding causes the value of the
1473CLIPBOARD selection to be inserted.
1288 1474
1289=back 1475=back
1290 1476
1291=head1 CHANGING FONTS 1477=head1 CHANGING FONTS
1292 1478
1374B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1560B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1375it can be seen via the I<who(1)> command, and can accept messages. To 1561it can be seen via the I<who(1)> command, and can accept messages. To
1376allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1562allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1377on some systems or setgid to root or to some other group on others. 1563on some systems or setgid to root or to some other group on others.
1378 1564
1379=head1 COLORS AND GRAPHICS 1565=head1 COLOURS AND GRAPHICS
1380 1566
1381In addition to the default foreground and background colours, 1567In addition to the default foreground and background colours,
1382B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1568B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1383high-intensity bold/blink versions of the same). Here is a list of the 1569high-intensity (potentially bold/blink) versions of the same, and 72 (or
1384colours with their names. 1570240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1571cube plus a 8 (24) colour greyscale ramp.
1572
1573Here is a list of the ANSI colours with their names.
1385 1574
1386=begin table 1575=begin table
1387 1576
1388 B<color0> (black) = Black 1577 B<color0> (black) = Black
1389 B<color1> (red) = Red3 1578 B<color1> (red) = Red3
1409It is also possible to specify the colour values of B<foreground>, 1598It is also possible to specify the colour values of B<foreground>,
1410B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1599B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1411a number 0-15, as a convenient shorthand to reference the colour name of 1600a number 0-15, as a convenient shorthand to reference the colour name of
1412color0-color15. 1601color0-color15.
1413 1602
1414In addition to the colours defined above, @@RXVT_NAME@@ offers an 1603The following text gives values for the standard 88 colour mode (and
1415additional 72 colours. The first 64 of those (with indices 16 to 79) 1604values for the 256 colour mode in parentheses).
1416consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141716>), followed by 8 additional shades of gray (with indices 80 to 87).
1418 1605
1606The RGB cube uses indices 16..79 (16..231) using the following formulas:
1607
1608 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1609 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1610
1611The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1612steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1613the RGB cube.
1614
1419Together, all those colours implement the 88 colour xterm colours. Only 1615Together, all those colours implement the 88 (256) colour xterm
1420the first 16 can be changed using resources currently, the rest can only 1616colours. Only the first 16 can be changed using resources currently, the
1421be changed via command sequences ("escape codes"). 1617rest can only be changed via command sequences ("escape codes").
1618
1619Applications are advised to use terminfo or command sequences to discover
1620number and RGB values of all colours (yes, you can query this...).
1422 1621
1423Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1622Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1424always swapping the foreground/background colours. This is in contrast to 1623always swapping the foreground/background colours. This is in contrast to
1425I<xterm>(1) where the colours are only swapped if they have not otherwise 1624I<xterm>(1) where the colours are only swapped if they have not otherwise
1426been specified. For example, 1625been specified. For example,
1427 1626
1428=over 4
1429
1430=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1627 @@RXVT_NAME@@ -fg Black -bg White -rv
1431 1628
1432would yield White on Black, while on I<xterm>(1) it would yield Black 1629would yield White on Black, while on I<xterm>(1) it would yield Black on
1433on White. 1630White.
1434
1435=back
1436 1631
1437=head2 ALPHA CHANNEL SUPPORT 1632=head2 ALPHA CHANNEL SUPPORT
1438 1633
1439If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1634If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1440their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1635their act together, rxvt-unicode will do its own alpha channel management:
1441(recommended, but B<MUST> have 4 digits/component) colour specifications, 1636
1442in addition to the ones provided by X, where the additional A component 1637You can prefix any colour with an opaqueness percentage enclosed in
1638brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1639(0-100) that specifies the opacity of the colour, where C<0> is completely
1640transparent and C<100> is completely opaque. For example, C<[50]red> is a
1641half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1642is the recommended format to specify transparency values, and works with
1643all ways to specify a colour.
1644
1645For complete control, rxvt-unicode also supports
1646C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1647specifications, where the additional C<aaaa> component specifies opacity
1443specifies opacity (alpha) values. The minimum value of C<0> is completely 1648(alpha) values. The minimum value of C<0000> is completely transparent,
1444transparent). You can also prefix any color with C<[percent]>, where 1649while C<ffff> is completely opaque). The two example colours from
1445C<percent> is a decimal percentage (0-100) that specifies the opacity of 1650earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1446the color, where C<0> is completely transparent and C<100> is completelxy 1651C<rgba:0000/ff00/0000/f332>.
1447opaque.
1448 1652
1449You probably need to specify B<"-depth 32">, too, and have the luck that 1653You probably need to specify B<"-depth 32">, too, to force a visual with
1450your X-server uses ARGB pixel layout, as X is far from just supporting 1654alpha channels, and have the luck that your X-server uses ARGB pixel
1451ARGB visuals out of the box, and rxvt-unicode just fudges around. 1655layout, as X is far from just supporting ARGB visuals out of the box, and
1656rxvt-unicode just fudges around.
1452 1657
1453For example, the following selects an almost completely transparent red 1658For example, the following selects an almost completely transparent black
1454background, and an almost opaque pink foreground: 1659background, and an almost opaque pink foreground:
1455 1660
1456 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1661 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1457 1662
1458I<Please note that transparency of any kind if completely unsupported by 1663When not using a background image, then the interpretation of the
1459the author. Don't bug him with installation questions!> 1664alpha channel is up to your compositing manager (most interpret it as
1665transparency of course).
1666
1667When using a background pixmap or pseudo-transparency, then the background
1668colour will always behave as if it were completely transparent (so the
1669background image shows instead), regardless of how it was specified, while
1670other colours will either be transparent as specified (the background
1671image will show through) on servers supporting the RENDER extension, or
1672fully opaque on servers not supporting the RENDER EXTENSION.
1673
1674Please note that due to bugs in Xft, specifying alpha values might result
1675in garbage being displayed when the X-server does not support the RENDER
1676extension.
1460 1677
1461=head1 ENVIRONMENT 1678=head1 ENVIRONMENT
1462 1679
1463B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1680B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1464 1681
1470resources or on the command line. 1687resources or on the command line.
1471 1688
1472=item B<COLORTERM> 1689=item B<COLORTERM>
1473 1690
1474Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1691Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1475compiled with background image support, and optionally with the added 1692compiled with background image support, and optionally with the added
1476extension C<-mono> to indicate that rxvt-unicode runs on a monochrome 1693extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477screen. 1694screen.
1478 1695
1479=item B<COLORFGBG> 1696=item B<COLORFGBG>
1480 1697
1481Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1698Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1482the colour code used as default foreground/text colour (or the string 1699the colour code used as default foreground/text colour (or the string
1483C<default> to indicate that the default-colour escape sequence is to be 1700C<default> to indicate that the default-colour escape sequence is to be
1484used), C<bg> is the colour code used as default background colour (or the 1701used), C<bg> is the colour code used as default background colour (or the
1485string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1702string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1486was compiled with background image support. Libraries like C<ncurses> 1703was compiled with background image support. Libraries like C<ncurses>
1487and C<slang> can (and do) use this information to optimize screen output. 1704and C<slang> can (and do) use this information to optimize screen output.
1488 1705
1489=item B<WINDOWID> 1706=item B<WINDOWID>
1490 1707
1491Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1708Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1498C<--with-terminfo=PATH>. 1715C<--with-terminfo=PATH>.
1499 1716
1500=item B<DISPLAY> 1717=item B<DISPLAY>
1501 1718
1502Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1719Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1503display in its child processes. 1720display in its child processes if C<-display> isn't used to override. It
1721defaults to C<:0> if it doesn't exist.
1504 1722
1505=item B<SHELL> 1723=item B<SHELL>
1506 1724
1507The shell to be used for command execution, defaults to C</bin/sh>. 1725The shell to be used for command execution, defaults to C</bin/sh>.
1508 1726
1509=item B<RXVT_SOCKET> 1727=item B<RXVT_SOCKET> [I<sic>]
1510 1728
1511The unix domain socket path used by @@RXVT_NAME@@c(1) and 1729The unix domain socket path used by @@RXVT_NAME@@c(1) and
1512@@RXVT_NAME@@d(1). 1730@@RXVT_NAME@@d(1).
1513 1731
1514Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1732Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1733
1734=item B<URXVT_PERL_LIB>
1735
1736Additional F<:>-separated library search path for perl extensions. Will be
1737searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1738directory.
1739
1740=item B<URXVT_PERL_VERBOSITY>
1741
1742See L<@@RXVT_NAME@@perl>(3).
1515 1743
1516=item B<HOME> 1744=item B<HOME>
1517 1745
1518Used to locate the default directory for the unix domain socket for 1746Used to locate the default directory for the unix domain socket for
1519daemon communications and to locate various resource files (such as 1747daemon communications and to locate various resource files (such as
1520C<.Xdefaults>) 1748C<.Xdefaults>)
1521 1749
1522=item B<XAPPLRESDIR> 1750=item B<XAPPLRESDIR>
1523 1751
1524Directory where various X resource files are being located. 1752Directory where application-specific X resource files are located.
1525 1753
1526=item B<XENVIRONMENT> 1754=item B<XENVIRONMENT>
1527 1755
1528If set and accessible, gives the name of a X resource file to be loaded by 1756If set and accessible, gives the name of a X resource file to be loaded by
1529@@RXVT_NAME@@. 1757@@RXVT_NAME@@.
1534 1762
1535=over 4 1763=over 4
1536 1764
1537=item B</usr/lib/X11/rgb.txt> 1765=item B</usr/lib/X11/rgb.txt>
1538 1766
1539Color names. 1767Colour names.
1540 1768
1541=back 1769=back
1542 1770
1543=head1 SEE ALSO 1771=head1 SEE ALSO
1544 1772
1773@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1545@@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) 1774@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1546 1775
1547=head1 CURRENT PROJECT COORDINATOR 1776=head1 CURRENT PROJECT COORDINATOR
1548 1777
1549=over 4 1778=over 4
1550 1779
1551=item Project Coordinator 1780=item Project Coordinator
1552 1781
1553Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1782Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1554 1783
1555L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1784L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1556 1785
1557=back 1786=back
1558 1787
1562 1791
1563=item John Bovey 1792=item John Bovey
1564 1793
1565University of Kent, 1992, wrote the original Xvt. 1794University of Kent, 1992, wrote the original Xvt.
1566 1795
1567=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1796=item Rob Nation <nation@rocket.sanders.lockheed.com>
1568 1797
1569very heavily modified Xvt and came up with Rxvt 1798very heavily modified Xvt and came up with Rxvt
1570 1799
1571=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1800=item Angelo Haritsis <ah@doc.ic.ac.uk>
1572 1801
1573wrote the Greek Keyboard Input (no longer in code) 1802wrote the Greek Keyboard Input (no longer in code)
1574 1803
1575=item mj olesen L<< <olesen@me.QueensU.CA> >> 1804=item mj olesen <olesen@me.QueensU.CA>
1576 1805
1577Wrote the menu system. 1806Wrote the menu system.
1578 1807
1579Project Coordinator (changes.txt 2.11 to 2.21) 1808Project Coordinator (changes.txt 2.11 to 2.21)
1580 1809
1581=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1810=item Oezguer Kesim <kesim@math.fu-berlin.de>
1582 1811
1583Project Coordinator (changes.txt 2.21a to 2.4.5) 1812Project Coordinator (changes.txt 2.21a to 2.4.5)
1584 1813
1585=item Geoff Wing L<< <gcw@pobox.com> >> 1814=item Geoff Wing <gcw@pobox.com>
1586 1815
1587Rewrote screen display and text selection routines. 1816Rewrote screen display and text selection routines.
1588 1817
1589Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1818Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1590 1819
1591=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1820=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1592 1821
1593Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1822Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1594extension, random hacks, numerous bugfixes and extensions. 1823extension, random hacks, numerous bugfixes and extensions.
1595 1824
1596Project Coordinator (Changes 1.0 -) 1825Project Coordinator (Changes 1.0 -)
1597 1826
1598=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1827=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1599 1828
1600Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1829pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1601 1830
1602=back 1831=back
1603 1832

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines