ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.37 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.67 by root, Sun Jun 24 22:12:18 2007 UTC

4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 6.3, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.2, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. That document is also 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
24 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
25 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
26 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
27 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devenagari. Don't expect pretty output when using
28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29 should work fine, though. A somewhat difficult case are left-to-right 29 should work fine, though. A somewhat difficult case are right-to-left
30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
32 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
33 otherwise), but that might change. 33 otherwise), but that might change.
34 34
35 If you are looking for a terminal that supports more exotic scripts, let 35 If you are looking for a terminal that supports more exotic scripts, let
36 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
37 terminal emulator. In fact, the reason rxvt-unicode was born was solely 37 terminal emulator. In fact, the reason rxvt-unicode was born was solely
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
42 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
43 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
44 able to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 it's predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
48 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot bugs less than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of it's features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
60 It also makes technical information about escape sequences (which have 60 It also makes technical information about escape sequences (which have
61 been extended) easier accessible: see rxvt(7) for technical reference 61 been extended) more accessible: see rxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In
66 keeping with the smaller-is-better philosophy, options may be eliminated 66 keeping with the smaller-is-better philosophy, options may be eliminated
84 -display *displayname* 84 -display *displayname*
85 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88 88
89 -depth *bitdepth*
90 Compile *xft*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
93 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
94 98
95 -j|+j 99 -j|+j
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling (allow multiple lines per refresh);
101 resource jumpScroll.
102
103 -ss|+ss
104 Turn on/off skip scrolling (allow multiple screens per refresh);
105 resource skipScroll.
97 106
98 -ip|+ip | -tr|+tr 107 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 108 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 109 -tr; resource inheritPixmap.
110
111 *Please note that transparency of any kind if completely unsupported
112 by the author. Don't bug him with installation questions! Read the
113 FAQ (man 7 rxvt)!*
101 114
102 -fade *number* 115 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 116 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 117 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 118 the fade colour; resource fading.
106 119
107 -fadecolor *colour* 120 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 121 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 122 colour is opaque black. resource fadeColor.
110 123
111 -tint *colour* 124 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 125 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 126 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 127 non-tiled backgrounds, currently. See also the -sh option that can
115 be used to brighten or darken the image in addition to tinting it; 128 be used to brighten or darken the image in addition to tinting it;
116 resource *tintColor*. Example: 129 resource *tintColor*. Example:
117 130
118 rxvt -tr -tint blue -sh 40 131 rxvt -tr -tint blue -sh 40
119 132
133 -sh *number*
120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 134 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
121 background image in addition to tinting it (i.e. -tint must be 135 image in addition to (or instead of) tinting it; resource *shading*.
122 specified, too, e.g. "-tint white"). 136
137 -blt *string*
138 Specify background blending type. If background pixmap is specified
139 at the same time as transparency - such pixmap will be blended over
140 transparency image, using method specified. Supported values are :
141 add, alphablend, allanon - color values averaging, colorize, darken,
142 diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
143 value. The default is alpha-blending; resource *blendType*.
144
145 -blr *number*
146 Apply Gaussian Blur with the specified radius to the transparent
147 background image; resource *blurRadius*.
123 148
124 -bg *colour* 149 -bg *colour*
125 Window background colour; resource background. 150 Window background colour; resource background.
126 151
127 -fg *colour* 152 -fg *colour*
128 Window foreground colour; resource foreground. 153 Window foreground colour; resource foreground.
129 154
130 -pixmap *file[;geom]* 155 -pixmap *file[;geom]*
131 Compile *XPM*: Specify XPM file for the background and also 156 Compile *afterimage*: Specify image file for the background and also
132 optionally specify its scaling with a geometry string. Note you may 157 optionally specify its scaling with a geometry string. Note you may
133 need to add quotes to avoid special shell interpretation of the ";" 158 need to add quotes to avoid special shell interpretation of the ";"
134 in the command-line; resource backgroundPixmap. 159 in the command-line; for more details see resource backgroundPixmap.
135 160
136 -cr *colour* 161 -cr *colour*
137 The cursor colour; resource cursorColor. 162 The cursor colour; resource cursorColor.
138 163
139 -pr *colour* 164 -pr *colour*
146 The colour of the border around the text area and between the 171 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 172 scrollbar and the text; resource borderColor.
148 173
149 -fn *fontlist* 174 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 175 Select the fonts to be used. This is a comma separated list of font
151 names that are used in turn when trying to display Unicode 176 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 177 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 178 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 179 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 180 See resource font for more details.
156 181
157 In short, to specify an X11 core font, just specify it's name or 182 In short, to specify an X11 core font, just specify its name or
158 prefix it with "x:". To specify an XFT-font, you need to prefix it 183 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 184 with "xft:", e.g.:
160 185
161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 186 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 187 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
251 externalBorder. 276 externalBorder.
252 277
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 278 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
254 if honoured by the WM, the rxvt-unicode window will not have window 279 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 280 decorations; resource borderLess.
281
282 -override-redirect
283 Compile *frills*: Sets override-redirect on the window; resource
284 override-redirect.
256 285
257 -sbg 286 -sbg
258 Compile *frills*: Disable the usage of the built-in block 287 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 288 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its 289 fonts provide. Use this if you have a good font and want to use its
315 Set the font set to use for the X Input Method, see resource imFont 344 Set the font set to use for the X Input Method, see resource imFont
316 for more info. 345 for more info.
317 346
318 -tcw 347 -tcw
319 Change the meaning of triple-click selection with the left mouse 348 Change the meaning of triple-click selection with the left mouse
349 button. Only effective when the original (non-perl) selection code
320 button. Instead of selecting a full line it will extend the 350 is in-use. Instead of selecting a full line it will extend the
321 selection the end of the logical line only. resource 351 selection the end of the logical line only. resource
322 tripleclickwords. 352 tripleclickwords.
323 353
324 -insecure 354 -insecure
325 Enable "insecure" mode, which currently enables most of the escape 355 Enable "insecure" mode, which currently enables most of the escape
346 376
347 -keysym.*sym* *string* 377 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym. 378 Remap a key symbol. See resource keysym.
349 379
350 -embed *windowid* 380 -embed *windowid*
351 Tells rxvt to embed it's windows into an already-existing window, 381 Tells rxvt to embed its windows into an already-existing window,
352 which enables applications to easily embed a terminal. 382 which enables applications to easily embed a terminal.
353 383
354 Right now, rxvt will first unmap/map the specified window, so it 384 Right now, rxvt will first unmap/map the specified window, so it
355 shouldn't be a top-level window. rxvt will also reconfigure it quite 385 shouldn't be a top-level window. rxvt will also reconfigure it quite
356 a bit, so don't expect it to keep some specific state. It's best to 386 a bit, so don't expect it to keep some specific state. It's best to
359 The window will not be destroyed when rxvt exits. 389 The window will not be destroyed when rxvt exits.
360 390
361 It might be useful to know that rxvt will not close file descriptors 391 It might be useful to know that rxvt will not close file descriptors
362 passed to it (except for stdin/out/err, of course), so you can use 392 passed to it (except for stdin/out/err, of course), so you can use
363 file descriptors to communicate with the programs within the 393 file descriptors to communicate with the programs within the
364 terminal. This works regardless of wether the "-embed" option was 394 terminal. This works regardless of whether the "-embed" option was
365 used or not. 395 used or not.
366 396
367 Here is a short Gtk2-perl snippet that illustrates how this option 397 Here is a short Gtk2-perl snippet that illustrates how this option
368 can be used (a longer example is in doc/embed): 398 can be used (a longer example is in doc/embed):
369 399
373 system "rxvt -embed $xid &"; 403 system "rxvt -embed $xid &";
374 }); 404 });
375 405
376 -pty-fd *file descriptor* 406 -pty-fd *file descriptor*
377 Tells rxvt NOT to execute any commands or create a new pty/tty pair 407 Tells rxvt NOT to execute any commands or create a new pty/tty pair
378 but instead use the given filehandle as the tty master. This is 408 but instead use the given file descriptor as the tty master. This is
379 useful if you want to drive rxvt as a generic terminal emulator 409 useful if you want to drive rxvt as a generic terminal emulator
380 without having to run a program within it. 410 without having to run a program within it.
381 411
382 If this switch is given, rxvt will not create any utmp/wtmp entries 412 If this switch is given, rxvt will not create any utmp/wtmp entries
383 and will not tinker with pty/tty permissions - you have to do that 413 and will not tinker with pty/tty permissions - you have to do that
400 # now communicate with rxvt 430 # now communicate with rxvt
401 my $slave = $pty->slave; 431 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" } 432 while (<$slave>) { print $slave "got <$_>\n" }
403 433
404 -pe *string* 434 -pe *string*
405 Comma-separated list of perl extension scripts to use in this 435 Comma-separated list of perl extension scripts to use (or not to
406 terminal instance. See resource perl-ext. 436 use) in this terminal instance. See resource perl-ext for details.
407 437
408RESOURCES (available also as long-options) 438RESOURCES (available also as long-options)
409 Note: `rxvt --help' gives a list of all resources (long options) 439 Note: `rxvt --help' gives a list of all resources (long options)
410 compiled into your version. 440 compiled into your version.
411 441
412 There are two different methods that rxvt can use to get the Xresource
413 data: using the X libraries (Xrm*-functions) or internal Xresources
414 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
415 XGetDefaults), you can set and change the resources using X11 tools like 442 You can set and change the resources using X11 tools like xrdb. Many
416 xrdb. Many distribution do also load settings from the ~/.Xresources 443 distribution do also load settings from the ~/.Xresources file when X
417 file when X starts. rxvt will consult the following files/resources in 444 starts. rxvt will consult the following files/resources in order, with
418 order, with later settings overwriting earlier ones: 445 later settings overwriting earlier ones:
419 446
420 1. system-wide app-defaults file, either locale-dependent OR global 447 1. system-wide app-defaults file, either locale-dependent OR global
421 2. app-defaults file in $XAPPLRESDIR 448 2. app-defaults file in $XAPPLRESDIR
422 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 449 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
423 4. SCREEN_RESOURCES for the current screen 450 4. SCREEN_RESOURCES for the current screen
424 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 451 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
425 452
426 If compiled with internal Xresources support (i.e. rxvt -h lists 453 Note that when reading X resources, rxvt recognizes two class names:
427 .Xdefaults) then rxvt accepts application defaults set in 454 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
428 XAPPLOADDIR/URxvt (compile-time defined: usually 455 and the original *rxvt* to be easily configured, while the class name
429 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 456 URxvt allows resources unique to rxvt, to be shared between different
430 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
431 resources, rxvt recognizes two class names: XTerm and URxvt. The class
432 name Rxvt allows resources common to both rxvt and the original *rxvt*
433 to be easily configured, while the class name URxvt allows resources
434 unique to rxvt, notably colours and key-handling, to be shared between
435 different rxvt configurations. If no resources are specified, suitable 457 rxvt configurations. If no resources are specified, suitable defaults
436 defaults will be used. Command-line arguments can be used to override 458 will be used. Command-line arguments can be used to override resource
437 resource settings. The following resources are allowed: 459 settings. The following resources are supported (you might want to check
460 the rxvtperl(3) manpage for additional settings by perl extensions not
461 documented here):
462
463 depth: *bitdepth*
464 Compile *xft*: Attempt to find a visual with the given bit depth;
465 option -depth.
438 466
439 geometry: *geom* 467 geometry: *geom*
440 Create the window with the specified X window geometry [default 468 Create the window with the specified X window geometry [default
441 80x24]; option -geometry. 469 80x24]; option -geometry.
442 470
474 Use the specified colour to display underlined characters when the 502 Use the specified colour to display underlined characters when the
475 foreground colour is the default. 503 foreground colour is the default.
476 504
477 colorRV: *colour* 505 colorRV: *colour*
478 Use the specified colour as the background for reverse video 506 Use the specified colour as the background for reverse video
479 characters. 507 characters when OPTION_HC is disabled (--disable-frills).
480 508
481 underlineColor: *colour* 509 underlineColor: *colour*
482 If set, use the specified colour as the colour for the underline 510 If set, use the specified colour as the colour for the underline
483 itself. If unset, use the foreground colour. 511 itself. If unset, use the foreground colour.
484 512
495 True: simulate reverse video by foreground and background colours; 523 True: simulate reverse video by foreground and background colours;
496 option -rv. False: regular screen colours [default]; option +rv. See 524 option -rv. False: regular screen colours [default]; option +rv. See
497 note in COLORS AND GRAPHICS section. 525 note in COLORS AND GRAPHICS section.
498 526
499 jumpScroll: *boolean* 527 jumpScroll: *boolean*
500 True: specify that jump scrolling should be used. When scrolling 528 True: specify that jump scrolling should be used. When receiving
501 quickly, fewer screen updates are performed [default]; option -j. 529 lots of lines, rxvt will only scroll once a whole screen height of
530 lines has been read, resulting in fewer updates while still
531 displaying every received line; option -j.
532
502 False: specify that smooth scrolling should be used; option +j. 533 False: specify that smooth scrolling should be used. rxvt will force
534 a screen refresh on each new line it received; option +j.
535
536 skipScroll: *boolean*
537 True: (the default) specify that skip scrolling should be used. When
538 receiving lots of lines, rxvt will only scroll once in a while
539 (around 60 times per second), resulting in far fewer updates. This
540 can result in rxvt not ever displaying some of the lines it
541 receives; option -ss.
542
543 False: specify that everything is to be displayed, even if the
544 refresh is too fast for the human eye to read anything (or the
545 monitor to display anything); option +ss.
503 546
504 inheritPixmap: *boolean* 547 inheritPixmap: *boolean*
505 True: make the background inherit the parent windows' pixmap, giving 548 True: make the background inherit the parent windows' pixmap, giving
506 artificial transparency. False: do not inherit the parent windows' 549 artificial transparency. False: do not inherit the parent windows'
507 pixmap. 550 pixmap.
508 551
552 *Please note that transparency of any kind if completely unsupported
553 by the author. Don't bug him with installation questions!*
554
509 fading: *number* 555 fading: *number*
510 Fade the text by the given percentage when focus is lost; option 556 Fade the text by the given percentage when focus is lost; option
511 -fade. 557 -fade.
512 558
513 fadeColor: *colour* 559 fadeColor: *colour*
518 Tint the transparent background pixmap with the given colour; option 564 Tint the transparent background pixmap with the given colour; option
519 -tint. 565 -tint.
520 566
521 shading: *number* 567 shading: *number*
522 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 568 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
523 image in addition to tinting it. 569 image in addition to tinting it; option -sh.
570
571 blendType: *string*
572 Specify background blending type; option -blt.
573
574 blurRadius: *number*
575 Apply Gaussian Blurr with the specified radius to the transparent
576 background image; option -blr.
524 577
525 scrollColor: *colour* 578 scrollColor: *colour*
526 Use the specified colour for the scrollbar [default #B2B2B2]. 579 Use the specified colour for the scrollbar [default #B2B2B2].
527 580
528 troughColor: *colour* 581 troughColor: *colour*
532 borderColor: *colour* 585 borderColor: *colour*
533 The colour of the border around the text area and between the 586 The colour of the border around the text area and between the
534 scrollbar and the text. 587 scrollbar and the text.
535 588
536 backgroundPixmap: *file[;geom]* 589 backgroundPixmap: *file[;geom]*
537 Use the specified XPM file (note the `.xpm' extension is optional) 590 Use the specified image file for the background and also optionally
538 for the background and also optionally specify its scaling with a 591 specify its scaling with a geometry string WxH+X+Y, in which "W" /
539 geometry string WxH+X+Y, in which "W" / "H" specify the
540 horizontal/vertical scale (percent) and "X" / "Y" locate the image 592 "H" specify the horizontal/vertical scale (percent), and "X" / "Y"
541 centre (percent). A scale of 0 displays the image with tiling. A 593 locate the image centre (percent). A scale of 0 displays the image
542 scale of 1 displays the image without any scaling. A scale of 2 to 9 594 with tiling. A scale of 1 displays the image without any scaling. A
543 specifies an integer number of images in that direction. No image 595 scale of 2 to 9 specifies an integer number of images in that
544 will be magnified beyond 10 times its original size. The maximum 596 direction. No image will be magnified beyond 10 times its original
545 permitted scale is 1000. [default 0x0+50+50] 597 size. The maximum permitted scale is 1000. Special string of "auto"
546 598 used as a geometry will cause image to be automatically scaled to
547 menu: *file[;tag]* 599 match window size. If used in conjunction with -tr option -
548 Read in the specified menu file (note the `.menu' extension is 600 specified pixmap will be blended over transparency image using
549 optional) and also optionally specify a starting tag to find. See 601 either alpha-blending, or any other blending type, specified with
550 the reference documentation for details on the syntax for the 602 -blt "type" option. [default 0x0+50+50]
551 menuBar.
552 603
553 path: *path* 604 path: *path*
554 Specify the colon-delimited search path for finding files (XPM and 605 Specify the colon-delimited search path for finding XPM files.
555 menus), in addition to the paths specified by the RXVTPATH and PATH
556 environment variables.
557 606
558 font: *fontlist* 607 font: *fontlist*
559 Select the fonts to be used. This is a comma separated list of font 608 Select the fonts to be used. This is a comma separated list of font
560 names that are used in turn when trying to display Unicode 609 names that are checked in order when trying to find glyphs for
561 characters. The first font defines the cell size for characters; 610 characters. The first font defines the cell size for characters;
562 other fonts might be smaller, but not larger. A reasonable default 611 other fonts might be smaller, but not (in general) larger. A
563 font list is always appended to it; option -fn. 612 (hopefully) reasonable default font list is always appended to it;
613 option -fn.
564 614
565 Each font can either be a standard X11 core font (XLFD) name, with 615 Each font can either be a standard X11 core font (XLFD) name, with
566 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 616 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
567 "xft:". 617 "xft:".
568 618
571 available hint currently is "codeset=codeset-name", and this is only 621 available hint currently is "codeset=codeset-name", and this is only
572 used for Xft fonts. 622 used for Xft fonts.
573 623
574 For example, this font resource 624 For example, this font resource
575 625
576 URxvt*font: 9x15bold,\ 626 URxvt.font: 9x15bold,\
577 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 627 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
578 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 628 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
579 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 629 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
580 xft:Code2000:antialias=false 630 xft:Code2000:antialias=false
581 631
617 normal text font will being used for the given style. 667 normal text font will being used for the given style.
618 668
619 intensityStyles: *boolean* 669 intensityStyles: *boolean*
620 When font styles are not enabled, or this option is enabled (True, 670 When font styles are not enabled, or this option is enabled (True,
621 option -is, the default), bold and italic font styles imply high 671 option -is, the default), bold and italic font styles imply high
622 intensity foreground/backround colours. Disabling this option 672 intensity foreground/background colours. Disabling this option
623 (False, option +is) disables this behaviour, the high intensity 673 (False, option +is) disables this behaviour, the high intensity
624 colours are not reachable. 674 colours are not reachable.
625 675
626 selectstyle: *mode* 676 selectstyle: *mode*
627 Set mouse selection style to old which is 2.20, oldword which is 677 Set mouse selection style to old which is 2.20, oldword which is
628 xterm style with 2.20 old word selection, or anything else which 678 xterm style with 2.20 old word selection, or anything else which
629 gives xterm style selection. 679 gives xterm style selection. Only effective when the original
680 (non-perl) selection code is in use.
630 681
631 scrollstyle: *mode* 682 scrollstyle: *mode*
632 Set scrollbar style to rxvt, plain, next or xterm. plain is the 683 Set scrollbar style to rxvt, plain, next or xterm. plain is the
633 author's favourite. 684 author's favourite.
634 685
644 695
645 mapAlert: *boolean* 696 mapAlert: *boolean*
646 True: de-iconify (map) on receipt of a bell character. False: no 697 True: de-iconify (map) on receipt of a bell character. False: no
647 de-iconify (map) on receipt of a bell character [default]. 698 de-iconify (map) on receipt of a bell character [default].
648 699
700 urgentOnBell: *boolean*
701 True: set the urgency hint for the wm on receipt of a bell
702 character. False: do not set the urgency hint [default].
703
649 visualBell: *boolean* 704 visualBell: *boolean*
650 True: use visual bell on receipt of a bell character; option -vb. 705 True: use visual bell on receipt of a bell character; option -vb.
651 False: no visual bell [default]; option +vb. 706 False: no visual bell [default]; option +vb.
652 707
653 loginShell: *boolean* 708 loginShell: *boolean*
667 722
668 The string will be interpreted as if typed into the shell as-is. 723 The string will be interpreted as if typed into the shell as-is.
669 724
670 Example: 725 Example:
671 726
672 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 727 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
673 728
674 This creates a new file in your home directory with the screen 729 This creates a new file in your home directory with the screen
675 contents everytime you hit "Print". 730 contents every time you hit "Print".
676 731
677 scrollBar: *boolean* 732 scrollBar: *boolean*
678 True: enable the scrollbar [default]; option -sb. False: disable the 733 True: enable the scrollbar [default]; option -sb. False: disable the
679 scrollbar; option +sb. 734 scrollbar; option +sb.
680 735
695 do not scroll to bottom when tty receives output; option +si. 750 do not scroll to bottom when tty receives output; option +si.
696 751
697 scrollWithBuffer: *boolean* 752 scrollWithBuffer: *boolean*
698 True: scroll with scrollback buffer when tty receives new lines (and 753 True: scroll with scrollback buffer when tty receives new lines (and
699 scrollTtyOutput is False); option -sw. False: do not scroll with 754 scrollTtyOutput is False); option -sw. False: do not scroll with
700 scrollback buffer when tty recieves new lines; option +sw. 755 scrollback buffer when tty receives new lines; option +sw.
701 756
702 scrollTtyKeypress: *boolean* 757 scrollTtyKeypress: *boolean*
703 True: scroll to bottom when a non-special key is pressed. Special 758 True: scroll to bottom when a non-special key is pressed. Special
704 keys are those which are intercepted by rxvt-unicode for special 759 keys are those which are intercepted by rxvt-unicode for special
705 handling and are not passed onto the shell; option -sk. False: do 760 handling and are not passed onto the shell; option -sk. False: do
778 The string to send when the delete key (not the keypad delete key) 833 The string to send when the delete key (not the keypad delete key)
779 is pressed. If unset it will send the sequence traditionally 834 is pressed. If unset it will send the sequence traditionally
780 associated with the Execute key. 835 associated with the Execute key.
781 836
782 cutchars: *string* 837 cutchars: *string*
783 The characters used as delimiters for double-click word selection. 838 The characters used as delimiters for double-click word selection
784 The built-in default: 839 (whitespace delimiting is added automatically if resource is given).
840
841 When the perl selection extension is in use (the default if compiled
842 in, see the rxvtperl(3) manpage), a suitable regex using these
843 characters will be created (if the resource exists, otherwise, no
844 regex will be created). In this mode, characters outside ISO-8859-1
845 can be used.
846
847 When the selection extension is not used, only ISO-8859-1 characters
848 can be used. If not specified, the built-in default is used:
785 849
786 BACKSLASH `"'&()*,;<=>?@[]{|} 850 BACKSLASH `"'&()*,;<=>?@[]{|}
787 851
788 preeditType: *style* 852 preeditType: *style*
789 OverTheSpot, OffTheSpot, Root; option -pt. 853 OverTheSpot, OffTheSpot, Root; option -pt.
820 xterm, have these sequences enabled by default, which doesn't make 884 xterm, have these sequences enabled by default, which doesn't make
821 it safer, though). 885 it safer, though).
822 886
823 You can enable them by setting this boolean resource or specifying 887 You can enable them by setting this boolean resource or specifying
824 -insecure as an option. At the moment, this enables display-answer, 888 -insecure as an option. At the moment, this enables display-answer,
825 locale, findfont, icon label and window title requests as well as 889 locale, findfont, icon label and window title requests.
826 dynamic menubar dispatch.
827 890
828 modifier: *modifier* 891 modifier: *modifier*
829 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 892 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
830 super, mod1, mod2, mod3, mod4, mod5; option -mod. 893 super, mod1, mod2, mod3, mod4, mod5; option -mod.
831 894
832 answerbackString: *string* 895 answerbackString: *string*
833 Specify the reply rxvt-unicode sends to the shell when an ENQ 896 Specify the reply rxvt-unicode sends to the shell when an ENQ
834 (control-E) character is passed through. It may contain escape 897 (control-E) character is passed through. It may contain escape
835 values as described in the entry on keysym following. 898 values as described in the entry on keysym following.
836 899
837 secondaryScreen: *bool* 900 secondaryScreen: *boolean*
838 Turn on/off secondary screen (default enabled). 901 Turn on/off secondary screen (default enabled).
839 902
840 secondaryScroll: *bool* 903 secondaryScroll: *boolean*
841 Turn on/off secondary screen scroll (default enabled). If the this 904 Turn on/off secondary screen scroll (default enabled). If this
842 option is enabled, scrolls on the secondary screen will change the 905 option is enabled, scrolls on the secondary screen will change the
843 scrollback buffer and switching to/from the secondary screen will 906 scrollback buffer and switching to/from the secondary screen will
844 instead scroll the screen up. 907 instead scroll the screen up.
845 908
846 hold: *bool* 909 hold: *boolean*
847 Turn on/off hold window after exit support. If enabled, rxvt will 910 Turn on/off hold window after exit support. If enabled, rxvt will
848 not immediately destroy its window when the program executed within 911 not immediately destroy its window when the program executed within
849 it exits. Instead, it will wait till it is being killed or closed by 912 it exits. Instead, it will wait till it is being killed or closed by
850 the user. 913 the user.
851 914
872 935
873 *string* may contain escape values ("\a": bell, "\b": backspace, 936 *string* may contain escape values ("\a": bell, "\b": backspace,
874 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 937 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
875 "\000": octal number) or verbatim control characters ("^?": delete, 938 "\000": octal number) or verbatim control characters ("^?": delete,
876 "^@": null, "^A" ...) and may be enclosed with double quotes so that 939 "^@": null, "^A" ...) and may be enclosed with double quotes so that
877 it can start or end with whitespace. 940 it can start or end with whitespace. This feature is deprecated and
941 will be removed.
878 942
879 Please note that you need to double the "\" when using 943 Please note that you need to double the "\" in resource files, as
880 "--enable-xgetdefault", as X itself does it's own de-escaping (you 944 Xlib itself does its own de-escaping (you can use "\033" instead of
881 can use "\033" instead of "\e" (and so on), which will work with 945 "\e" (and so on), which will work with both Xt and rxvt's own
882 both Xt and rxvt's own processing). 946 processing).
883 947
884 You can define a range of keysyms in one shot by providing a 948 You can define a range of keysyms in one shot by providing a
885 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 949 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
886 `/' should be a character not used by the strings. 950 `/' should be a character not used by the strings.
887 951
888 Its usage can be demonstrated by an example: 952 Its usage can be demonstrated by an example:
889 953
890 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 954 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
941 URxvt.keysym.M-C-3: command:\033[8;25;80t 1005 URxvt.keysym.M-C-3: command:\033[8;25;80t
942 URxvt.keysym.M-C-4: command:\033[8;48;110t 1006 URxvt.keysym.M-C-4: command:\033[8;48;110t
943 1007
944 perl-ext-common: *string* 1008 perl-ext-common: *string*
945 perl-ext: *string* 1009 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts to use in this 1010 Comma-separated list(s) of perl extension scripts (default:
947 terminal instance. Each extension is looked up in the library 1011 "default") to use in this terminal instance; option -pe.
1012
1013 Extension names can be prefixed with a "-" sign to prohibit using
1014 them. This can be useful to selectively disable some extensions
1015 loaded by default, or specified via the "perl-ext-common" resource.
1016 For example, "default,-selection" will use all the default extension
1017 except "selection".
1018
1019 Extension names can also be followed by an argument in angle
1020 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
1021 for searchable scrollback to Alt/Meta-s). Mentioning the same
1022 extension multiple times with different arguments will pass multiple
1023 arguments to the extension.
1024
1025 Each extension is looked up in the library directories, loaded if
948 directories, loaded if necessary, and bound to the current terminal 1026 necessary, and bound to the current terminal instance.
949 instance. If this resource is empty or missing, then the perl 1027
1028 If both of these resources are the empty string, then the perl
950 interpreter will not be initialized. The idea behind two options is 1029 interpreter will not be initialized. The idea behind two options is
951 that perl-ext-common will be used for extensions that should be 1030 that perl-ext-common will be used for extensions that should be
952 available to all instances, while perl-ext is used for specific 1031 available to all instances, while perl-ext is used for specific
953 instances; option -pe. 1032 instances.
954 1033
955 perl-eval: *string* 1034 perl-eval: *string*
956 Perl code to be evaluated when all extensions have been registered. 1035 Perl code to be evaluated when all extensions have been registered.
957 See the rxvtperl(3) manpage. 1036 See the rxvtperl(3) manpage. Due to security reasons, this resource
1037 will be ignored when running setuid/setgid.
958 1038
959 perl-lib: *path* 1039 perl-lib: *path*
960 Colon-separated list of additional directories that hold extension 1040 Colon-separated list of additional directories that hold extension
961 scripts. When looking for extensions specified by the "perl" 1041 scripts. When looking for extensions specified by the "perl"
962 resource, rxvt will first look in these directories and then in 1042 resource, rxvt will first look in these directories and then in
963 /opt/rxvt/lib/urxvt/perl/. 1043 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
1044 will be ignored when running setuid/setgid.
964 1045
965 See the rxvtperl(3) manpage. 1046 See the rxvtperl(3) manpage.
1047
1048 selection.pattern-*idx*: *perl-regex*
1049 Additional selection patterns, see the rxvtperl(3) manpage for
1050 details.
1051
1052 selection-autotransform.*idx*: *perl-transform*
1053 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1054 details.
1055
1056 searchable-scrollback: *keysym*
1057 Sets the hotkey that starts the incremental scrollback buffer search
1058 (default: "M-s").
1059
1060 urlLauncher: *string*
1061 Specifies the program to be started with a URL argument. Used by the
1062 "selection-popup" and "matcher" perl extensions.
1063
1064 transient-for: *windowid*
1065 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1066 window id.
1067
1068 override-redirect: *boolean*
1069 Compile *frills*: Sets override-redirect for the terminal window,
1070 making it almost invisible to window managers; option
1071 -override-redirect.
1072
1073 iso14755_52: *boolean*
1074 Turn on/off ISO 14755 5.2 mode (default enabled).
966 1075
967THE SCROLLBAR 1076THE SCROLLBAR
968 Lines of text that scroll off the top of the rxvt window (resource: 1077 Lines of text that scroll off the top of the rxvt window (resource:
969 saveLines) and can be scrolled back using the scrollbar or by 1078 saveLines) and can be scrolled back using the scrollbar or by
970 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1079 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
984 disabled -- on the assumption that we are using a fullscreen 1093 disabled -- on the assumption that we are using a fullscreen
985 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ 1094 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
986 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the 1095 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
987 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. 1096 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
988 1097
989TEXT SELECTION AND INSERTION 1098THE SELECTION: SELECTING AND PASTING TEXT
990 The behaviour of text selection and insertion mechanism is similar to 1099 The behaviour of text selection and insertion/pasting mechanism is
991 *xterm*(1). 1100 similar to *xterm*(1).
992 1101
993 Selection: 1102 Selecting:
994 Left click at the beginning of the region, drag to the end of the 1103 Left click at the beginning of the region, drag to the end of the
995 region and release; Right click to extend the marked region; Left 1104 region and release; Right click to extend the marked region; Left
996 double-click to select a word; Left triple-click to select the 1105 double-click to select a word; Left triple-click to select the
997 entire logical line (which can span multiple screen lines), unless 1106 entire logical line (which can span multiple screen lines), unless
998 modified by resource tripleclickwords. 1107 modified by resource tripleclickwords.
1001 (Compile: *frills*) will create a rectangular selection instead of a 1110 (Compile: *frills*) will create a rectangular selection instead of a
1002 normal one. In this mode, every selected row becomes its own line in 1111 normal one. In this mode, every selected row becomes its own line in
1003 the selection, and trailing whitespace is visually underlined and 1112 the selection, and trailing whitespace is visually underlined and
1004 removed from the selection. 1113 removed from the selection.
1005 1114
1006 Insertion: 1115 Pasting:
1007 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1116 Pressing and releasing the Middle mouse button in an rxvt window
1008 an rxvt window causes the current text selection to be inserted as 1117 causes the value of the PRIMARY selection (or CLIPBOARD with the
1009 if it had been typed on the keyboard. 1118 Meta modifier) to be inserted as if it had been typed on the
1119 keyboard.
1120
1121 Pressing Shift-Insert causes the value of the PRIMARY selection to
1122 be inserted too.
1010 1123
1011CHANGING FONTS 1124CHANGING FONTS
1012 Changing fonts (or font sizes, respectively) via the keypad is not yet 1125 Changing fonts (or font sizes, respectively) via the keypad is not yet
1013 supported in rxvt-unicode. Bug me if you need this. 1126 supported in rxvt-unicode. Bug me if you need this.
1014 1127
1015 You can, however, switch fonts at runtime using escape sequences (and 1128 You can, however, switch fonts at runtime using escape sequences, e.g.:
1016 therefore using the menubar), e.g.:
1017 1129
1018 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1130 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1131
1132 You can use keyboard shortcuts, too:
1133
1134 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1135 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1019 1136
1020 rxvt-unicode will automatically re-apply these fonts to the output so 1137 rxvt-unicode will automatically re-apply these fonts to the output so
1021 far. 1138 far.
1022 1139
1023ISO 14755 SUPPORT 1140ISO 14755 SUPPORT
1047 This mode lets you input characters representing the keycap symbols 1164 This mode lets you input characters representing the keycap symbols
1048 of your keyboard, if representable in the current locale encoding. 1165 of your keyboard, if representable in the current locale encoding.
1049 1166
1050 Start by pressing "Control" and "Shift" together, then releasing 1167 Start by pressing "Control" and "Shift" together, then releasing
1051 them. The next special key (cursor keys, home etc.) you enter will 1168 them. The next special key (cursor keys, home etc.) you enter will
1052 not invoke it's usual function but instead will insert the 1169 not invoke its usual function but instead will insert the
1053 corresponding keycap symbol. The symbol will only be entered when 1170 corresponding keycap symbol. The symbol will only be entered when
1054 the key has been released, otherwise pressing e.g. "Shift" would 1171 the key has been released, otherwise pressing e.g. "Shift" would
1055 enter the symbol for "ISO Level 2 Switch", although your intention 1172 enter the symbol for "ISO Level 2 Switch", although your intention
1056 might have been to enter a reverse tab (Shift-Tab). 1173 might have been to enter a reverse tab (Shift-Tab).
1057 1174
1086 setgid to root or to some other group on others. 1203 setgid to root or to some other group on others.
1087 1204
1088COLORS AND GRAPHICS 1205COLORS AND GRAPHICS
1089 In addition to the default foreground and background colours, rxvt can 1206 In addition to the default foreground and background colours, rxvt can
1090 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1207 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1091 versions of the same). Here is a list of the colours with their rgb.txt 1208 versions of the same). Here is a list of the colours with their names.
1092 names.
1093 1209
1094 color0 (black) = Black 1210 color0 (black) = Black
1095 color1 (red) = Red3 1211 color1 (red) = Red3
1096 color2 (green) = Green3 1212 color2 (green) = Green3
1097 color3 (yellow) = Yellow3 1213 color3 (yellow) = Yellow3
1113 It is also possible to specify the colour values of foreground, 1229 It is also possible to specify the colour values of foreground,
1114 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1230 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1115 0-15, as a convenient shorthand to reference the colour name of 1231 0-15, as a convenient shorthand to reference the colour name of
1116 color0-color15. 1232 color0-color15.
1117 1233
1234 In addition to the colours defined above, rxvt offers an additional 72
1235 colours. The first 64 of those (with indices 16 to 79) consist of a
1236 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1237 by 8 additional shades of gray (with indices 80 to 87).
1238
1239 Together, all those colours implement the 88 colour xterm colours. Only
1240 the first 16 can be changed using resources currently, the rest can only
1241 be changed via command sequences ("escape codes").
1242
1118 Note that -rv ("reverseVideo: True") simulates reverse video by always 1243 Note that -rv ("reverseVideo: True") simulates reverse video by always
1119 swapping the foreground/background colours. This is in contrast to 1244 swapping the foreground/background colours. This is in contrast to
1120 *xterm*(1) where the colours are only swapped if they have not otherwise 1245 *xterm*(1) where the colours are only swapped if they have not otherwise
1121 been specified. For example, 1246 been specified. For example,
1122 1247
1123 rxvt -fg Black -bg White -rv 1248 rxvt -fg Black -bg White -rv
1124 would yield White on Black, while on *xterm*(1) it would yield Black 1249 would yield White on Black, while on *xterm*(1) it would yield Black
1125 on White. 1250 on White.
1126 1251
1252 ALPHA CHANNEL SUPPORT
1253 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1254 get their act together, rxvt-unicode will support
1255 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1256 digits/component) colour specifications, in addition to the ones
1257 provided by X, where the additional A component specifies opacity
1258 (alpha) values. The minimum value of 0 is completely transparent). You
1259 can also prefix any color with "[percent]", where "percent" is a decimal
1260 percentage (0-100) that specifies the opacity of the color, where 0 is
1261 completely transparent and 100 is completelxy opaque.
1262
1263 You probably need to specify "-depth 32", too, and have the luck that
1264 your X-server uses ARGB pixel layout, as X is far from just supporting
1265 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1266
1267 For example, the following selects an almost completely transparent red
1268 background, and an almost opaque pink foreground:
1269
1270 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1271
1272 *Please note that transparency of any kind if completely unsupported by
1273 the author. Don't bug him with installation questions!*
1274
1127ENVIRONMENT 1275ENVIRONMENT
1128 rxvt sets and/or uses the following environment variables: 1276 rxvt sets and/or uses the following environment variables:
1129 1277
1130 TERM 1278 TERM
1131 Normally set to "rxvt-unicode", unless overwritten at configure 1279 Normally set to "rxvt-unicode", unless overwritten at configure
1132 time, via resources or on the commandline. 1280 time, via resources or on the command line.
1133 1281
1134 COLORTERM 1282 COLORTERM
1135 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1283 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1136 with XPM support, and optionally with the added extension "-mono" to 1284 with XPM support, and optionally with the added extension "-mono" to
1137 indicate that rxvt-unicode runs on a monochrome screen. 1285 indicate that rxvt-unicode runs on a monochrome screen.
1138 1286
1139 COLORFGBG 1287 COLORFGBG
1140 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1288 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1154 Set to the terminfo directory iff rxvt was configured with 1302 Set to the terminfo directory iff rxvt was configured with
1155 "--with-terminfo=PATH". 1303 "--with-terminfo=PATH".
1156 1304
1157 DISPLAY 1305 DISPLAY
1158 Used by rxvt to connect to the display and set to the correct 1306 Used by rxvt to connect to the display and set to the correct
1159 display in it's child processes. 1307 display in its child processes.
1160 1308
1161 SHELL 1309 SHELL
1162 The shell to be used for command execution, defaults to "/bin/sh". 1310 The shell to be used for command execution, defaults to "/bin/sh".
1163
1164 RXVTPATH
1165 The path where rxvt looks for support files such as menu and xpm
1166 files.
1167
1168 PATH
1169 Used in the same way as "RXVTPATH".
1170 1311
1171 RXVT_SOCKET 1312 RXVT_SOCKET
1172 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1313 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1173 1314
1174 Default $HOME/.rxvt-unicode-*<nodename*. 1315 Default $HOME/.rxvt-unicode-*<nodename*.
1195 1336
1196CURRENT PROJECT COORDINATOR 1337CURRENT PROJECT COORDINATOR
1197 Project Coordinator 1338 Project Coordinator
1198 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1339 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1199 1340
1200 <http://software.schmorp.de/#rxvt-unicode> 1341 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1201 1342
1202AUTHORS 1343AUTHORS
1203 John Bovey 1344 John Bovey
1204 University of Kent, 1992, wrote the original Xvt. 1345 University of Kent, 1992, wrote the original Xvt.
1205 1346
1216 1357
1217 Oezguer Kesim <kesim@math.fu-berlin.de> 1358 Oezguer Kesim <kesim@math.fu-berlin.de>
1218 Project Coordinator (changes.txt 2.21a to 2.4.5) 1359 Project Coordinator (changes.txt 2.21a to 2.4.5)
1219 1360
1220 Geoff Wing <gcw@pobox.com> 1361 Geoff Wing <gcw@pobox.com>
1221 Rewrote screen display and text selection routines. Project 1362 Rewrote screen display and text selection routines.
1363
1222 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1364 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1223 1365
1224 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1366 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1225 Forked rxvt-unicode, rewrote most of the display code and internal 1367 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1226 character handling to store text in unicode, improve xterm 1368 perl extension, random hacks, numerous bugfixes and extensions.
1227 compatibility and apply numerous other bugfixes and extensions.
1228 1369
1229 Project Coordinator (Changes 1.0 -) 1370 Project Coordinator (Changes 1.0 -)
1230 1371
1372 Emanuele Giaquinta <e.giaquinta@glauco.it>
1373 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1374

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines