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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines