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.27 by root, Thu Dec 22 16:44:10 2005 UTC vs.
Revision 1.66 by root, Sat Jun 2 04:58:58 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.0, 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.
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling; resource jumpScroll.
97 101
98 -ip|+ip | -tr|+tr 102 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 103 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 104 -tr; resource inheritPixmap.
105
106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions! Read the
108 FAQ (man 7 rxvt)!*
101 109
102 -fade *number* 110 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 111 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 112 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 113 the fade colour; resource fading.
106 114
107 -fadecolor *colour* 115 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 116 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 117 colour is opaque black. resource fadeColor.
110 118
111 -tint *colour* 119 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 120 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 121 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 122 non-tiled backgrounds, currently. See also the -sh option that can
117 125
118 rxvt -tr -tint blue -sh 40 126 rxvt -tr -tint blue -sh 40
119 127
120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 128 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
121 background image in addition to tinting it (i.e. -tint must be 129 background image in addition to tinting it (i.e. -tint must be
122 specified, too, e.g. "-tint white"). 130 specified, too, e.g. "-tint white"); resource *shading*.
123 131
124 -bg *colour* 132 -bg *colour*
125 Window background colour; resource background. 133 Window background colour; resource background.
126 134
127 -fg *colour* 135 -fg *colour*
146 The colour of the border around the text area and between the 154 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 155 scrollbar and the text; resource borderColor.
148 156
149 -fn *fontlist* 157 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 158 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 159 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 160 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 161 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 162 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 163 See resource font for more details.
156 164
157 In short, to specify an X11 core font, just specify it's name or 165 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 166 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 167 with "xft:", e.g.:
160 168
161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 169 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 170 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 171
164 See also the question "How does rxvt-unicode choose fonts?" in the 172 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of rxvt(7). 173 FAQ section of rxvt(7).
166 174
167 -fb *fontlist* 175 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 176 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 177 characters are to be printed. See resource boldFont for details.
170 178
171 -fi *fontlist* 179 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 180 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 181 characters are to be printed. See resource italicFont for details.
174 182
175 -fbi *fontlist* 183 -fbi *fontlist*
176 Compile font-styles: The bold italic font list to use when bold 184 Compile *font-styles*: The bold italic font list to use when *bold
177 characters are to be printed. See resource boldItalicFont for 185 italic* characters are to be printed. See resource boldItalicFont
186 for details.
187
188 -is|+is
189 Compile *font-styles*: Bold/Italic font styles imply high intensity
190 foreground/background (default). See resource intensityStyles for
178 details. 191 details.
179 192
180 -name *name* 193 -name *name*
181 Specify the application name under which resources are to be 194 Specify the application name under which resources are to be
182 obtained, rather than the default executable file name. Name should 195 obtained, rather than the default executable file name. Name should
246 externalBorder. 259 externalBorder.
247 260
248 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 261 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
249 if honoured by the WM, the rxvt-unicode window will not have window 262 if honoured by the WM, the rxvt-unicode window will not have window
250 decorations; resource borderLess. 263 decorations; resource borderLess.
264
265 -override-redirect
266 Compile *frills*: Sets override-redirect on the window; resource
267 override-redirect.
268
269 -sbg
270 Compile *frills*: Disable the usage of the built-in block
271 graphics/line drawing characters and just rely on what the specified
272 fonts provide. Use this if you have a good font and want to use its
273 block graphic glyphs; resource skipBuiltinGlyphs.
251 274
252 -lsp *number* 275 -lsp *number*
253 Compile *frills*: Lines (pixel height) to insert between each row of 276 Compile *frills*: Lines (pixel height) to insert between each row of
254 the display. Useful to work around font rendering problems; resource 277 the display. Useful to work around font rendering problems; resource
255 linespace. 278 linespace.
304 Set the font set to use for the X Input Method, see resource imFont 327 Set the font set to use for the X Input Method, see resource imFont
305 for more info. 328 for more info.
306 329
307 -tcw 330 -tcw
308 Change the meaning of triple-click selection with the left mouse 331 Change the meaning of triple-click selection with the left mouse
332 button. Only effective when the original (non-perl) selection code
309 button. Instead of selecting a full line it will extend the 333 is in-use. Instead of selecting a full line it will extend the
310 selection the end of the logical line only. resource 334 selection the end of the logical line only. resource
311 tripleclickwords. 335 tripleclickwords.
312 336
313 -insecure 337 -insecure
314 Enable "insecure" mode, which currently enables most of the escape 338 Enable "insecure" mode, which currently enables most of the escape
335 359
336 -keysym.*sym* *string* 360 -keysym.*sym* *string*
337 Remap a key symbol. See resource keysym. 361 Remap a key symbol. See resource keysym.
338 362
339 -embed *windowid* 363 -embed *windowid*
340 Tells rxvt to embed it's windows into an already-existing window, 364 Tells rxvt to embed its windows into an already-existing window,
341 which enables applications to easily embed a terminal. 365 which enables applications to easily embed a terminal.
342 366
343 Right now, rxvt will first unmap/map the specified window, so it 367 Right now, rxvt will first unmap/map the specified window, so it
344 shouldn't be a top-level window. rxvt will also reconfigure it quite 368 shouldn't be a top-level window. rxvt will also reconfigure it quite
345 a bit, so don't expect it to keep some specific state. It's best to 369 a bit, so don't expect it to keep some specific state. It's best to
348 The window will not be destroyed when rxvt exits. 372 The window will not be destroyed when rxvt exits.
349 373
350 It might be useful to know that rxvt will not close file descriptors 374 It might be useful to know that rxvt will not close file descriptors
351 passed to it (except for stdin/out/err, of course), so you can use 375 passed to it (except for stdin/out/err, of course), so you can use
352 file descriptors to communicate with the programs within the 376 file descriptors to communicate with the programs within the
353 terminal. This works regardless of wether the "-embed" option was 377 terminal. This works regardless of whether the "-embed" option was
354 used or not. 378 used or not.
355 379
356 Here is a short Gtk2-perl snippet that illustrates how this option 380 Here is a short Gtk2-perl snippet that illustrates how this option
357 can be used (a longer example is in doc/embed): 381 can be used (a longer example is in doc/embed):
358 382
360 $rxvt->signal_connect_after (realize => sub { 384 $rxvt->signal_connect_after (realize => sub {
361 my $xid = $_[0]->window->get_xid; 385 my $xid = $_[0]->window->get_xid;
362 system "rxvt -embed $xid &"; 386 system "rxvt -embed $xid &";
363 }); 387 });
364 388
365 -pty-fd *fileno* 389 -pty-fd *file descriptor*
366 Tells rxvt NOT to execute any commands or create a new pty/tty pair 390 Tells rxvt NOT to execute any commands or create a new pty/tty pair
367 but instead use the given filehandle as the tty master. This is 391 but instead use the given file descriptor as the tty master. This is
368 useful if you want to drive rxvt as a generic terminal emulator 392 useful if you want to drive rxvt as a generic terminal emulator
369 without having to run a program within it. 393 without having to run a program within it.
370 394
371 If this switch is given, rxvt will not create any utmp/wtmp entries 395 If this switch is given, rxvt will not create any utmp/wtmp entries
372 and will not tinker with pty/tty permissions - you have to do that 396 and will not tinker with pty/tty permissions - you have to do that
373 yourself if you want that. 397 yourself if you want that.
398
399 As an extremely special case, specifying -1 will completely suppress
400 pty/tty operations.
374 401
375 Here is a example in perl that illustrates how this option can be 402 Here is a example in perl that illustrates how this option can be
376 used (a longer example is in doc/pty-fd): 403 used (a longer example is in doc/pty-fd):
377 404
378 use IO::Pty; 405 use IO::Pty;
385 412
386 # now communicate with rxvt 413 # now communicate with rxvt
387 my $slave = $pty->slave; 414 my $slave = $pty->slave;
388 while (<$slave>) { print $slave "got <$_>\n" } 415 while (<$slave>) { print $slave "got <$_>\n" }
389 416
417 -pe *string*
418 Comma-separated list of perl extension scripts to use (or not to
419 use) in this terminal instance. See resource perl-ext for details.
420
390RESOURCES (available also as long-options) 421RESOURCES (available also as long-options)
391 Note: `rxvt --help' gives a list of all resources (long options) 422 Note: `rxvt --help' gives a list of all resources (long options)
392 compiled into your version. 423 compiled into your version.
393 424
394 There are two different methods that rxvt can use to get the Xresource
395 data: using the X libraries (Xrm*-functions) or internal Xresources
396 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
397 XGetDefaults), you can set and change the resources using X11 tools like 425 You can set and change the resources using X11 tools like xrdb. Many
398 xrdb. Many distribution do also load settings from the ~/.Xresources 426 distribution do also load settings from the ~/.Xresources file when X
399 file when X starts. rxvt will consult the following files/resources in 427 starts. rxvt will consult the following files/resources in order, with
400 order, with later settings overwriting earlier ones: 428 later settings overwriting earlier ones:
401 429
402 1. system-wide app-defaults file, either locale-dependent OR global 430 1. system-wide app-defaults file, either locale-dependent OR global
403 2. app-defaults file in $XAPPLRESDIR 431 2. app-defaults file in $XAPPLRESDIR
404 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 432 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
405 4. SCREEN_RESOURCES for the current screen 433 4. SCREEN_RESOURCES for the current screen
406 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 434 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
407 435
408 If compiled with internal Xresources support (i.e. rxvt -h lists 436 Note that when reading X resources, rxvt recognizes two class names:
409 .Xdefaults) then rxvt accepts application defaults set in 437 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
410 XAPPLOADDIR/URxvt (compile-time defined: usually 438 and the original *rxvt* to be easily configured, while the class name
411 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 439 URxvt allows resources unique to rxvt, to be shared between different
412 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
413 resources, rxvt recognizes two class names: XTerm and URxvt. The class
414 name Rxvt allows resources common to both rxvt and the original *rxvt*
415 to be easily configured, while the class name URxvt allows resources
416 unique to rxvt, notably colours and key-handling, to be shared between
417 different rxvt configurations. If no resources are specified, suitable 440 rxvt configurations. If no resources are specified, suitable defaults
418 defaults will be used. Command-line arguments can be used to override 441 will be used. Command-line arguments can be used to override resource
419 resource settings. The following resources are allowed: 442 settings. The following resources are supported (you might want to check
443 the rxvtperl(3) manpage for additional settings by perl extensions not
444 documented here):
445
446 depth: *bitdepth*
447 Compile *xft*: Attempt to find a visual with the given bit depth;
448 option -depth.
420 449
421 geometry: *geom* 450 geometry: *geom*
422 Create the window with the specified X window geometry [default 451 Create the window with the specified X window geometry [default
423 80x24]; option -geometry. 452 80x24]; option -geometry.
424 453
456 Use the specified colour to display underlined characters when the 485 Use the specified colour to display underlined characters when the
457 foreground colour is the default. 486 foreground colour is the default.
458 487
459 colorRV: *colour* 488 colorRV: *colour*
460 Use the specified colour as the background for reverse video 489 Use the specified colour as the background for reverse video
461 characters. 490 characters when OPTION_HC is disabled (--disable-frills).
462 491
463 underlineColor: *colour* 492 underlineColor: *colour*
464 If set, use the specified colour as the colour for the underline 493 If set, use the specified colour as the colour for the underline
465 itself. If unset, use the foreground colour. 494 itself. If unset, use the foreground colour.
466 495
486 inheritPixmap: *boolean* 515 inheritPixmap: *boolean*
487 True: make the background inherit the parent windows' pixmap, giving 516 True: make the background inherit the parent windows' pixmap, giving
488 artificial transparency. False: do not inherit the parent windows' 517 artificial transparency. False: do not inherit the parent windows'
489 pixmap. 518 pixmap.
490 519
520 *Please note that transparency of any kind if completely unsupported
521 by the author. Don't bug him with installation questions!*
522
491 fading: *number* 523 fading: *number*
492 Fade the text by the given percentage when focus is lost; option 524 Fade the text by the given percentage when focus is lost; option
493 -fade. 525 -fade.
494 526
495 fadeColor: *colour* 527 fadeColor: *colour*
500 Tint the transparent background pixmap with the given colour; option 532 Tint the transparent background pixmap with the given colour; option
501 -tint. 533 -tint.
502 534
503 shading: *number* 535 shading: *number*
504 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 536 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
505 image in addition to tinting it. 537 image in addition to tinting it; option -sh.
506 538
507 scrollColor: *colour* 539 scrollColor: *colour*
508 Use the specified colour for the scrollbar [default #B2B2B2]. 540 Use the specified colour for the scrollbar [default #B2B2B2].
509 541
510 troughColor: *colour* 542 troughColor: *colour*
524 scale of 1 displays the image without any scaling. A scale of 2 to 9 556 scale of 1 displays the image without any scaling. A scale of 2 to 9
525 specifies an integer number of images in that direction. No image 557 specifies an integer number of images in that direction. No image
526 will be magnified beyond 10 times its original size. The maximum 558 will be magnified beyond 10 times its original size. The maximum
527 permitted scale is 1000. [default 0x0+50+50] 559 permitted scale is 1000. [default 0x0+50+50]
528 560
529 menu: *file[;tag]*
530 Read in the specified menu file (note the `.menu' extension is
531 optional) and also optionally specify a starting tag to find. See
532 the reference documentation for details on the syntax for the
533 menuBar.
534
535 path: *path* 561 path: *path*
536 Specify the colon-delimited search path for finding files (XPM and 562 Specify the colon-delimited search path for finding XPM files.
537 menus), in addition to the paths specified by the RXVTPATH and PATH
538 environment variables.
539 563
540 font: *fontlist* 564 font: *fontlist*
541 Select the fonts to be used. This is a comma separated list of font 565 Select the fonts to be used. This is a comma separated list of font
542 names that are used in turn when trying to display Unicode 566 names that are checked in order when trying to find glyphs for
543 characters. The first font defines the cell size for characters; 567 characters. The first font defines the cell size for characters;
544 other fonts might be smaller, but not larger. A reasonable default 568 other fonts might be smaller, but not (in general) larger. A
545 font list is always appended to it. option -fn. 569 (hopefully) reasonable default font list is always appended to it;
570 option -fn.
546 571
547 Each font can either be a standard X11 core font (XLFD) name, with 572 Each font can either be a standard X11 core font (XLFD) name, with
548 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 573 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
549 "xft:". 574 "xft:".
550 575
553 available hint currently is "codeset=codeset-name", and this is only 578 available hint currently is "codeset=codeset-name", and this is only
554 used for Xft fonts. 579 used for Xft fonts.
555 580
556 For example, this font resource 581 For example, this font resource
557 582
558 URxvt*font: 9x15bold,\ 583 URxvt.font: 9x15bold,\
559 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 584 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
560 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 585 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
561 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 586 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
562 xft:Code2000:antialias=false 587 xft:Code2000:antialias=false
563 588
596 tried. 621 tried.
597 622
598 If set, but empty, then this specific style is disabled and the 623 If set, but empty, then this specific style is disabled and the
599 normal text font will being used for the given style. 624 normal text font will being used for the given style.
600 625
626 intensityStyles: *boolean*
627 When font styles are not enabled, or this option is enabled (True,
628 option -is, the default), bold and italic font styles imply high
629 intensity foreground/background colours. Disabling this option
630 (False, option +is) disables this behaviour, the high intensity
631 colours are not reachable.
632
601 selectstyle: *mode* 633 selectstyle: *mode*
602 Set mouse selection style to old which is 2.20, oldword which is 634 Set mouse selection style to old which is 2.20, oldword which is
603 xterm style with 2.20 old word selection, or anything else which 635 xterm style with 2.20 old word selection, or anything else which
604 gives xterm style selection. 636 gives xterm style selection. Only effective when the original
637 (non-perl) selection code is in use.
605 638
606 scrollstyle: *mode* 639 scrollstyle: *mode*
607 Set scrollbar style to rxvt, plain, next or xterm. plain is the 640 Set scrollbar style to rxvt, plain, next or xterm. plain is the
608 author's favourite. 641 author's favourite.
609 642
619 652
620 mapAlert: *boolean* 653 mapAlert: *boolean*
621 True: de-iconify (map) on receipt of a bell character. False: no 654 True: de-iconify (map) on receipt of a bell character. False: no
622 de-iconify (map) on receipt of a bell character [default]. 655 de-iconify (map) on receipt of a bell character [default].
623 656
657 urgentOnBell: *boolean*
658 True: set the urgency hint for the wm on receipt of a bell
659 character. False: do not set the urgency hint [default].
660
624 visualBell: *boolean* 661 visualBell: *boolean*
625 True: use visual bell on receipt of a bell character; option -vb. 662 True: use visual bell on receipt of a bell character; option -vb.
626 False: no visual bell [default]; option +vb. 663 False: no visual bell [default]; option +vb.
627 664
628 loginShell: *boolean* 665 loginShell: *boolean*
642 679
643 The string will be interpreted as if typed into the shell as-is. 680 The string will be interpreted as if typed into the shell as-is.
644 681
645 Example: 682 Example:
646 683
647 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 684 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
648 685
649 This creates a new file in your home directory with the screen 686 This creates a new file in your home directory with the screen
650 contents everytime you hit "Print". 687 contents every time you hit "Print".
651 688
652 scrollBar: *boolean* 689 scrollBar: *boolean*
653 True: enable the scrollbar [default]; option -sb. False: disable the 690 True: enable the scrollbar [default]; option -sb. False: disable the
654 scrollbar; option +sb. 691 scrollbar; option +sb.
655 692
670 do not scroll to bottom when tty receives output; option +si. 707 do not scroll to bottom when tty receives output; option +si.
671 708
672 scrollWithBuffer: *boolean* 709 scrollWithBuffer: *boolean*
673 True: scroll with scrollback buffer when tty receives new lines (and 710 True: scroll with scrollback buffer when tty receives new lines (and
674 scrollTtyOutput is False); option -sw. False: do not scroll with 711 scrollTtyOutput is False); option -sw. False: do not scroll with
675 scrollback buffer when tty recieves new lines; option +sw. 712 scrollback buffer when tty receives new lines; option +sw.
676 713
677 scrollTtyKeypress: *boolean* 714 scrollTtyKeypress: *boolean*
678 True: scroll to bottom when a non-special key is pressed. Special 715 True: scroll to bottom when a non-special key is pressed. Special
679 keys are those which are intercepted by rxvt-unicode for special 716 keys are those which are intercepted by rxvt-unicode for special
680 handling and are not passed onto the shell; option -sk. False: do 717 handling and are not passed onto the shell; option -sk. False: do
695 borderLess: *boolean* 732 borderLess: *boolean*
696 Set MWM hints to request a borderless window, i.e. if honoured by 733 Set MWM hints to request a borderless window, i.e. if honoured by
697 the WM, the rxvt-unicode window will not have window decorations; 734 the WM, the rxvt-unicode window will not have window decorations;
698 option -bl. 735 option -bl.
699 736
737 skipBuiltinGlyphs: *boolean*
738 Compile *frills*: Disable the usage of the built-in block
739 graphics/line drawing characters and just rely on what the specified
740 fonts provide. Use this if you have a good font and want to use its
741 block graphic glyphs; option -sbg.
742
700 termName: *termname* 743 termName: *termname*
701 Specifies the terminal type name to be set in the TERM environment 744 Specifies the terminal type name to be set in the TERM environment
702 variable; option -tn. 745 variable; option -tn.
703 746
704 linespace: *number* 747 linespace: *number*
747 The string to send when the delete key (not the keypad delete key) 790 The string to send when the delete key (not the keypad delete key)
748 is pressed. If unset it will send the sequence traditionally 791 is pressed. If unset it will send the sequence traditionally
749 associated with the Execute key. 792 associated with the Execute key.
750 793
751 cutchars: *string* 794 cutchars: *string*
752 The characters used as delimiters for double-click word selection. 795 The characters used as delimiters for double-click word selection
753 The built-in default: 796 (whitespace delimiting is added automatically if resource is given).
797
798 When the perl selection extension is in use (the default if compiled
799 in, see the rxvtperl(3) manpage), a suitable regex using these
800 characters will be created (if the resource exists, otherwise, no
801 regex will be created). In this mode, characters outside ISO-8859-1
802 can be used.
803
804 When the selection extension is not used, only ISO-8859-1 characters
805 can be used. If not specified, the built-in default is used:
754 806
755 BACKSLASH `"'&()*,;<=>?@[]{|} 807 BACKSLASH `"'&()*,;<=>?@[]{|}
756 808
757 preeditType: *style* 809 preeditType: *style*
758 OverTheSpot, OffTheSpot, Root; option -pt. 810 OverTheSpot, OffTheSpot, Root; option -pt.
762 814
763 imLocale: *name* 815 imLocale: *name*
764 The locale to use for opening the IM. You can use an "LC_CTYPE" of 816 The locale to use for opening the IM. You can use an "LC_CTYPE" of
765 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 817 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
766 the input extension to be able to input japanese characters while 818 the input extension to be able to input japanese characters while
767 staying in another locale. option -imlocale. 819 staying in another locale; option -imlocale.
768 820
769 imFont: *fontset* 821 imFont: *fontset*
770 Specify the font-set used for XIM styles "OverTheSpot" or 822 Specify the font-set used for XIM styles "OverTheSpot" or
771 "OffTheSpot". It must be a standard X font set (XLFD patterns 823 "OffTheSpot". It must be a standard X font set (XLFD patterns
772 separated by commas), i.e. it's not in the same format as the other 824 separated by commas), i.e. it's not in the same format as the other
775 to the base font. option -imfont. 827 to the base font. option -imfont.
776 828
777 tripleclickwords: *boolean* 829 tripleclickwords: *boolean*
778 Change the meaning of triple-click selection with the left mouse 830 Change the meaning of triple-click selection with the left mouse
779 button. Instead of selecting a full line it will extend the 831 button. Instead of selecting a full line it will extend the
780 selection to the end of the logical line only. option -tcw. 832 selection to the end of the logical line only; option -tcw.
781 833
782 insecure: *boolean* 834 insecure: *boolean*
783 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 835 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
784 that echo arbitrary strings like the icon name or the locale. This 836 that echo arbitrary strings like the icon name or the locale. This
785 could be abused if somebody gets 8-bit-clean access to your display, 837 could be abused if somebody gets 8-bit-clean access to your display,
789 xterm, have these sequences enabled by default, which doesn't make 841 xterm, have these sequences enabled by default, which doesn't make
790 it safer, though). 842 it safer, though).
791 843
792 You can enable them by setting this boolean resource or specifying 844 You can enable them by setting this boolean resource or specifying
793 -insecure as an option. At the moment, this enables display-answer, 845 -insecure as an option. At the moment, this enables display-answer,
794 locale, findfont, icon label and window title requests as well as 846 locale, findfont, icon label and window title requests.
795 dynamic menubar dispatch.
796 847
797 modifier: *modifier* 848 modifier: *modifier*
798 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 849 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
799 super, mod1, mod2, mod3, mod4, mod5; option -mod. 850 super, mod1, mod2, mod3, mod4, mod5; option -mod.
800 851
801 answerbackString: *string* 852 answerbackString: *string*
802 Specify the reply rxvt-unicode sends to the shell when an ENQ 853 Specify the reply rxvt-unicode sends to the shell when an ENQ
803 (control-E) character is passed through. It may contain escape 854 (control-E) character is passed through. It may contain escape
804 values as described in the entry on keysym following. 855 values as described in the entry on keysym following.
805 856
806 secondaryScreen: *bool* 857 secondaryScreen: *boolean*
807 Turn on/off secondary screen (default enabled). 858 Turn on/off secondary screen (default enabled).
808 859
809 secondaryScroll: *bool* 860 secondaryScroll: *boolean*
810 Turn on/off secondary screen scroll (default enabled). If the this 861 Turn on/off secondary screen scroll (default enabled). If this
811 option is enabled, scrolls on the secondary screen will change the 862 option is enabled, scrolls on the secondary screen will change the
812 scrollback buffer and switching to/from the secondary screen will 863 scrollback buffer and switching to/from the secondary screen will
813 instead scroll the screen up. 864 instead scroll the screen up.
814 865
815 hold: *bool* 866 hold: *boolean*
816 Turn on/off hold window after exit support. If enabled, rxvt will 867 Turn on/off hold window after exit support. If enabled, rxvt will
817 not immediately destroy its window when the program executed within 868 not immediately destroy its window when the program executed within
818 it exits. Instead, it will wait till it is being killed or closed by 869 it exits. Instead, it will wait till it is being killed or closed by
819 the user. 870 the user.
820 871
841 892
842 *string* may contain escape values ("\a": bell, "\b": backspace, 893 *string* may contain escape values ("\a": bell, "\b": backspace,
843 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 894 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
844 "\000": octal number) or verbatim control characters ("^?": delete, 895 "\000": octal number) or verbatim control characters ("^?": delete,
845 "^@": null, "^A" ...) and may be enclosed with double quotes so that 896 "^@": null, "^A" ...) and may be enclosed with double quotes so that
846 it can start or end with whitespace. 897 it can start or end with whitespace. This feature is deprecated and
898 will be removed.
847 899
848 Please note that you need to double the "\" when using 900 Please note that you need to double the "\" in resource files, as
849 "--enable-xgetdefault", as X itself does it's own de-escaping (you 901 Xlib itself does its own de-escaping (you can use "\033" instead of
850 can use "\033" instead of "\e" (and so on), which will work with 902 "\e" (and so on), which will work with both Xt and rxvt's own
851 both Xt and rxvt's own processing). 903 processing).
852 904
853 You can define a range of keysyms in one shot by providing a 905 You can define a range of keysyms in one shot by providing a
854 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 906 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
855 `/' should be a character not used by the strings. 907 `/' should be a character not used by the strings.
856 908
857 Its usage can be demonstrated by an example: 909 Its usage can be demonstrated by an example:
858 910
859 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 911 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
868 is interpreted and executed as rxvt's control sequence. For example 920 is interpreted and executed as rxvt's control sequence. For example
869 the following means "change the current locale to "zh_CN.GBK" when 921 the following means "change the current locale to "zh_CN.GBK" when
870 Control-Meta-c is being pressed": 922 Control-Meta-c is being pressed":
871 923
872 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 924 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
925
926 If *string* takes the form "perl:STRING", then the specified STRING
927 is passed to the "on_keyboard_command" perl handler. See the
928 rxvtperl(3) manpage. For example, the selection extension (activated
929 via "rxvt -pe selection") listens for "selection:rot13" events:
930
931 URxvt.keysym.M-C-c: perl:selection:rot13
873 932
874 Due the the large number of modifier combinations, a defined key 933 Due the the large number of modifier combinations, a defined key
875 mapping will match if at *at least* the specified identifiers are 934 mapping will match if at *at least* the specified identifiers are
876 being set, and no other key mappings with those and more bits are 935 being set, and no other key mappings with those and more bits are
877 being defined. That means that defining a key map for "a" will 936 being defined. That means that defining a key map for "a" will
901 info): 960 info):
902 961
903 URxvt.keysym.M-C-3: command:\033[8;25;80t 962 URxvt.keysym.M-C-3: command:\033[8;25;80t
904 URxvt.keysym.M-C-4: command:\033[8;48;110t 963 URxvt.keysym.M-C-4: command:\033[8;48;110t
905 964
965 perl-ext-common: *string*
966 perl-ext: *string*
967 Comma-separated list(s) of perl extension scripts (default:
968 "default") to use in this terminal instance; option -pe.
969
970 Extension names can be prefixed with a "-" sign to prohibit using
971 them. This can be useful to selectively disable some extensions
972 loaded by default, or specified via the "perl-ext-common" resource.
973 For example, "default,-selection" will use all the default extension
974 except "selection".
975
976 Extension names can also be followed by an argument in angle
977 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
978 for searchable scrollback to Alt/Meta-s). Mentioning the same
979 extension multiple times with different arguments will pass multiple
980 arguments to the extension.
981
982 Each extension is looked up in the library directories, loaded if
983 necessary, and bound to the current terminal instance.
984
985 If both of these resources are the empty string, then the perl
986 interpreter will not be initialized. The idea behind two options is
987 that perl-ext-common will be used for extensions that should be
988 available to all instances, while perl-ext is used for specific
989 instances.
990
991 perl-eval: *string*
992 Perl code to be evaluated when all extensions have been registered.
993 See the rxvtperl(3) manpage. Due to security reasons, this resource
994 will be ignored when running setuid/setgid.
995
996 perl-lib: *path*
997 Colon-separated list of additional directories that hold extension
998 scripts. When looking for extensions specified by the "perl"
999 resource, rxvt will first look in these directories and then in
1000 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
1001 will be ignored when running setuid/setgid.
1002
1003 See the rxvtperl(3) manpage.
1004
1005 selection.pattern-*idx*: *perl-regex*
1006 Additional selection patterns, see the rxvtperl(3) manpage for
1007 details.
1008
1009 selection-autotransform.*idx*: *perl-transform*
1010 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1011 details.
1012
1013 searchable-scrollback: *keysym*
1014 Sets the hotkey that starts the incremental scrollback buffer search
1015 (default: "M-s").
1016
1017 urlLauncher: *string*
1018 Specifies the program to be started with a URL argument. Used by the
1019 "selection-popup" and "matcher" perl extensions.
1020
1021 transient-for: *windowid*
1022 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1023 window id.
1024
1025 override-redirect: *boolean*
1026 Compile *frills*: Sets override-redirect for the terminal window,
1027 making it almost invisible to window managers; option
1028 -override-redirect.
1029
906THE SCROLLBAR 1030THE SCROLLBAR
907 Lines of text that scroll off the top of the rxvt window (resource: 1031 Lines of text that scroll off the top of the rxvt window (resource:
908 saveLines) and can be scrolled back using the scrollbar or by 1032 saveLines) and can be scrolled back using the scrollbar or by
909 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1033 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
910 fairly intuitive. The xterm-scrollbar is without arrows and its 1034 fairly intuitive. The xterm-scrollbar is without arrows and its
923 disabled -- on the assumption that we are using a fullscreen 1047 disabled -- on the assumption that we are using a fullscreen
924 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ 1048 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
925 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the 1049 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
926 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. 1050 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
927 1051
928TEXT SELECTION AND INSERTION 1052THE SELECTION: SELECTING AND PASTING TEXT
929 The behaviour of text selection and insertion mechanism is similar to 1053 The behaviour of text selection and insertion/pasting mechanism is
930 *xterm*(1). 1054 similar to *xterm*(1).
931 1055
932 Selection: 1056 Selecting:
933 Left click at the beginning of the region, drag to the end of the 1057 Left click at the beginning of the region, drag to the end of the
934 region and release; Right click to extend the marked region; Left 1058 region and release; Right click to extend the marked region; Left
935 double-click to select a word; Left triple-click to select the 1059 double-click to select a word; Left triple-click to select the
936 entire logical line (which can span multiple screen lines), unless 1060 entire logical line (which can span multiple screen lines), unless
937 modified by resource tripleclickwords. 1061 modified by resource tripleclickwords.
938 1062
939 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1063 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
940 (Compile: *frills*) will create a rectangular selection instead of a 1064 (Compile: *frills*) will create a rectangular selection instead of a
941 normal one. 1065 normal one. In this mode, every selected row becomes its own line in
1066 the selection, and trailing whitespace is visually underlined and
1067 removed from the selection.
942 1068
943 Insertion: 1069 Pasting:
944 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1070 Pressing and releasing the Middle mouse button in an rxvt window
945 an rxvt window causes the current text selection to be inserted as 1071 causes the value of the PRIMARY selection (or CLIPBOARD with the
946 if it had been typed on the keyboard. 1072 Meta modifier) to be inserted as if it had been typed on the
1073 keyboard.
1074
1075 Pressing Shift-Insert causes the value of the PRIMARY selection to
1076 be inserted too.
947 1077
948CHANGING FONTS 1078CHANGING FONTS
949 Changing fonts (or font sizes, respectively) via the keypad is not yet 1079 Changing fonts (or font sizes, respectively) via the keypad is not yet
950 supported in rxvt-unicode. Bug me if you need this. 1080 supported in rxvt-unicode. Bug me if you need this.
951 1081
952 You can, however, switch fonts at runtime using escape sequences (and 1082 You can, however, switch fonts at runtime using escape sequences, e.g.:
953 therefore using the menubar), e.g.:
954 1083
955 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1084 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1085
1086 You can use keyboard shortcuts, too:
1087
1088 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1089 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
956 1090
957 rxvt-unicode will automatically re-apply these fonts to the output so 1091 rxvt-unicode will automatically re-apply these fonts to the output so
958 far. 1092 far.
959 1093
960ISO 14755 SUPPORT 1094ISO 14755 SUPPORT
984 This mode lets you input characters representing the keycap symbols 1118 This mode lets you input characters representing the keycap symbols
985 of your keyboard, if representable in the current locale encoding. 1119 of your keyboard, if representable in the current locale encoding.
986 1120
987 Start by pressing "Control" and "Shift" together, then releasing 1121 Start by pressing "Control" and "Shift" together, then releasing
988 them. The next special key (cursor keys, home etc.) you enter will 1122 them. The next special key (cursor keys, home etc.) you enter will
989 not invoke it's usual function but instead will insert the 1123 not invoke its usual function but instead will insert the
990 corresponding keycap symbol. The symbol will only be entered when 1124 corresponding keycap symbol. The symbol will only be entered when
991 the key has been released, otherwise pressing e.g. "Shift" would 1125 the key has been released, otherwise pressing e.g. "Shift" would
992 enter the symbol for "ISO Level 2 Switch", although your intention 1126 enter the symbol for "ISO Level 2 Switch", although your intention
993 might have been to enter a reverse tab (Shift-Tab). 1127 might have been to enter a reverse tab (Shift-Tab).
994 1128
1023 setgid to root or to some other group on others. 1157 setgid to root or to some other group on others.
1024 1158
1025COLORS AND GRAPHICS 1159COLORS AND GRAPHICS
1026 In addition to the default foreground and background colours, rxvt can 1160 In addition to the default foreground and background colours, rxvt can
1027 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1161 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1028 versions of the same). Here is a list of the colours with their rgb.txt 1162 versions of the same). Here is a list of the colours with their names.
1029 names.
1030 1163
1031 color0 (black) = Black 1164 color0 (black) = Black
1032 color1 (red) = Red3 1165 color1 (red) = Red3
1033 color2 (green) = Green3 1166 color2 (green) = Green3
1034 color3 (yellow) = Yellow3 1167 color3 (yellow) = Yellow3
1050 It is also possible to specify the colour values of foreground, 1183 It is also possible to specify the colour values of foreground,
1051 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1184 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1052 0-15, as a convenient shorthand to reference the colour name of 1185 0-15, as a convenient shorthand to reference the colour name of
1053 color0-color15. 1186 color0-color15.
1054 1187
1188 In addition to the colours defined above, rxvt offers an additional 72
1189 colours. The first 64 of those (with indices 16 to 79) consist of a
1190 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1191 by 8 additional shades of gray (with indices 80 to 87).
1192
1193 Together, all those colours implement the 88 colour xterm colours. Only
1194 the first 16 can be changed using resources currently, the rest can only
1195 be changed via command sequences ("escape codes").
1196
1055 Note that -rv ("reverseVideo: True") simulates reverse video by always 1197 Note that -rv ("reverseVideo: True") simulates reverse video by always
1056 swapping the foreground/background colours. This is in contrast to 1198 swapping the foreground/background colours. This is in contrast to
1057 *xterm*(1) where the colours are only swapped if they have not otherwise 1199 *xterm*(1) where the colours are only swapped if they have not otherwise
1058 been specified. For example, 1200 been specified. For example,
1059 1201
1060 rxvt -fg Black -bg White -rv 1202 rxvt -fg Black -bg White -rv
1061 would yield White on Black, while on *xterm*(1) it would yield Black 1203 would yield White on Black, while on *xterm*(1) it would yield Black
1062 on White. 1204 on White.
1063 1205
1206 ALPHA CHANNEL SUPPORT
1207 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1208 get their act together, rxvt-unicode will support
1209 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1210 digits/component) colour specifications, in addition to the ones
1211 provided by X, where the additional A component specifies opacity
1212 (alpha) values. The minimum value of 0 is completely transparent). You
1213 can also prefix any color with "[percent]", where "percent" is a decimal
1214 percentage (0-100) that specifies the opacity of the color, where 0 is
1215 completely transparent and 100 is completelxy opaque.
1216
1217 You probably need to specify "-depth 32", too, and have the luck that
1218 your X-server uses ARGB pixel layout, as X is far from just supporting
1219 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1220
1221 For example, the following selects an almost completely transparent red
1222 background, and an almost opaque pink foreground:
1223
1224 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1225
1226 *Please note that transparency of any kind if completely unsupported by
1227 the author. Don't bug him with installation questions!*
1228
1064ENVIRONMENT 1229ENVIRONMENT
1065 rxvt sets and/or uses the following environment variables: 1230 rxvt sets and/or uses the following environment variables:
1066 1231
1067 TERM 1232 TERM
1068 Normally set to "rxvt-unicode", unless overwritten at configure 1233 Normally set to "rxvt-unicode", unless overwritten at configure
1069 time, via resources or on the commandline. 1234 time, via resources or on the command line.
1070 1235
1071 COLORTERM 1236 COLORTERM
1072 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1237 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1073 with XPM support, and optionally with the added extension "-mono" to 1238 with XPM support, and optionally with the added extension "-mono" to
1074 indicate that rxvt-unicode runs on a monochrome screen. 1239 indicate that rxvt-unicode runs on a monochrome screen.
1075 1240
1076 COLORFGBG 1241 COLORFGBG
1077 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1242 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1091 Set to the terminfo directory iff rxvt was configured with 1256 Set to the terminfo directory iff rxvt was configured with
1092 "--with-terminfo=PATH". 1257 "--with-terminfo=PATH".
1093 1258
1094 DISPLAY 1259 DISPLAY
1095 Used by rxvt to connect to the display and set to the correct 1260 Used by rxvt to connect to the display and set to the correct
1096 display in it's child processes. 1261 display in its child processes.
1097 1262
1098 SHELL 1263 SHELL
1099 The shell to be used for command execution, defaults to "/bin/sh". 1264 The shell to be used for command execution, defaults to "/bin/sh".
1100
1101 RXVTPATH
1102 The path where rxvt looks for support files such as menu and xpm
1103 files.
1104
1105 PATH
1106 Used in the same way as "RXVTPATH".
1107 1265
1108 RXVT_SOCKET 1266 RXVT_SOCKET
1109 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1267 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1110 1268
1111 Default $HOME/.rxvt-unicode-*<nodename*. 1269 Default $HOME/.rxvt-unicode-*<nodename*.
1132 1290
1133CURRENT PROJECT COORDINATOR 1291CURRENT PROJECT COORDINATOR
1134 Project Coordinator 1292 Project Coordinator
1135 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1293 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1136 1294
1137 <http://software.schmorp.de/#rxvt-unicode> 1295 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1138 1296
1139AUTHORS 1297AUTHORS
1140 John Bovey 1298 John Bovey
1141 University of Kent, 1992, wrote the original Xvt. 1299 University of Kent, 1992, wrote the original Xvt.
1142 1300
1153 1311
1154 Oezguer Kesim <kesim@math.fu-berlin.de> 1312 Oezguer Kesim <kesim@math.fu-berlin.de>
1155 Project Coordinator (changes.txt 2.21a to 2.4.5) 1313 Project Coordinator (changes.txt 2.21a to 2.4.5)
1156 1314
1157 Geoff Wing <gcw@pobox.com> 1315 Geoff Wing <gcw@pobox.com>
1158 Rewrote screen display and text selection routines. Project 1316 Rewrote screen display and text selection routines.
1317
1159 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1318 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1160 1319
1161 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1320 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1162 Forked rxvt-unicode, rewrote most of the display code and internal 1321 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1163 character handling to store text in unicode, improve xterm 1322 perl extension, random hacks, numerous bugfixes and extensions.
1164 compatibility and apply numerous other bugfixes and extensions.
1165 1323
1166 Project Coordinator (Changes 1.0 -) 1324 Project Coordinator (Changes 1.0 -)
1167 1325
1326 Emanuele Giaquinta <e.giaquinta@glauco.it>
1327 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1328

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines