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.63 by root, Thu Nov 2 17:37:47 2006 UTC vs.
Revision 1.69 by root, Sat Oct 27 12:09:02 2007 UTC

1NAME 1NAME
2 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window 2 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
3 system) 3 system)
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 urxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 8.0, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.4, 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 urxvt(7) (try "man 7 urxvt") for a list of frequently asked
17 and answer to them and some common problems. That document is also 17 questions and answer to them and some common problems. That document is
18 accessible on the World-Wide-Web at 18 also accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/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 devanagari. 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 right-to-left 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
… …
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 its 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 urxvtd(1) (daemon) and urxvtc(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) more accessible: see rxvt(7) for technical reference 61 been extended) more accessible: see urxvt(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 urxvt 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
67 or default values chosen at compile-time, so options and defaults listed 67 or default values chosen at compile-time, so options and defaults listed
68 may not accurately reflect the version installed on your system. `rxvt 68 may not accurately reflect the version installed on your system. `urxvt
69 -h' gives a list of major compile-time options on the *Options* line. 69 -h' gives a list of major compile-time options on the *Options* line.
70 Option descriptions may be prefixed with which compile option each is 70 Option descriptions may be prefixed with which compile option each is
71 dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options* 71 dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options*
72 line. Note: `rxvt -help' gives a list of all command-line options 72 line. Note: `urxvt -help' gives a list of all command-line options
73 compiled into your version. 73 compiled into your version.
74 74
75 Note that rxvt permits the resource name to be used as a long-option 75 Note that urxvt permits the resource name to be used as a long-option
76 (--/++ option) so the potential command-line options are far greater 76 (--/++ option) so the potential command-line options are far greater
77 than those listed. For example: `rxvt --loginShell --color1 Orange'. 77 than those listed. For example: `urxvt --loginShell --color1 Orange'.
78 78
79 The following options are available: 79 The following options are available:
80 80
81 -help, --help 81 -help, --help
82 Print out a message describing available options. 82 Print out a message describing available options.
… …
95 95
96 -rv|+rv 96 -rv|+rv
97 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
98 98
99 -j|+j 99 -j|+j
100 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling (allow multiple lines per refresh);
101 resource jumpScroll.
101 102
102 -ip|+ip | -tr|+tr 103 -ss|+ss
103 Turn on/off inheriting parent window's pixmap. Alternative form is 104 Turn on/off skip scrolling (allow multiple screens per refresh);
104 -tr; resource inheritPixmap. 105 resource skipScroll.
105 106
106 *Please note that transparency of any kind if completely unsupported 107 -tr|+tr
107 by the author. Don't bug him with installation questions! Read the 108 Turn on/off illusion of a transparent window background. Obsolete
108 FAQ (man 7 rxvt)!* 109 form of it is -ip and it should not be used anymore; resource
110 transparent.
111
112 *Please note that old resource name of inheritPixmap is obsolete and
113 should be changed to transparent. Backwards compatibility support
114 for inheritPixmap will be phased out in future versions of rxvt!*
115
116 *Please address all transparency related issues to Sasha Vasko at
117 sasha@aftercode.net. Read the FAQ (man 7 urxvt)!*
109 118
110 -fade *number* 119 -fade *number*
111 Fade the text by the given percentage when focus is lost. Small 120 Fade the text by the given percentage when focus is lost. Small
112 values fade a little only, 100 completely replaces all colours by 121 values fade a little only, 100 completely replaces all colours by
113 the fade colour; resource fading. 122 the fade colour; resource fading.
… …
116 Fade to this colour when fading is used (see -fade). The default 125 Fade to this colour when fading is used (see -fade). The default
117 colour is opaque black. resource fadeColor. 126 colour is opaque black. resource fadeColor.
118 127
119 -tint *colour* 128 -tint *colour*
120 Tint the transparent background pixmap with the given colour when 129 Tint the transparent background pixmap with the given colour when
121 transparency is enabled with -tr or -ip. This only works for 130 transparency is enabled with -tr. This only works for non-tiled
122 non-tiled backgrounds, currently. See also the -sh option that can 131 backgrounds, currently. See also the -sh option that can be used to
123 be used to brighten or darken the image in addition to tinting it; 132 brighten or darken the image in addition to tinting it. Please note
133 that certain tint colours can be applied on the server-side, thus
134 yielding performance gain of two orders of magnitude. These colours
135 are: blue, red, green, cyan, magenta, yellow, and those close to
124 resource *tintColor*. Example: 136 them; resource *tintColor*. Example:
125 137
126 rxvt -tr -tint blue -sh 40 138 urxvt -tr -tint blue -sh 40
127 139
140 -sh *number*
128 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 141 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
129 background image in addition to tinting it (i.e. -tint must be 142 image in addition to (or instead of) tinting it; resource *shading*.
130 specified, too, e.g. "-tint white"). 143
144 -blt *string*
145 Specify background blending type. If background pixmap is specified
146 at the same time as transparency - such pixmap will be blended over
147 transparency image, using method specified. Supported values are :
148 add, alphablend, allanon - color values averaging, colorize, darken,
149 diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
150 value. The default is alpha-blending. Compile *afterimage*; resource
151 *blendType*.
152
153 -blr *HxV*
154 Apply Gaussian Blur with the specified radii to the transparent
155 background image. If single number is specified - both vertical and
156 horizontal radii are considered to be the same. Setting one of the
157 radii to 1 and another to a large number creates interesting effects
158 on some backgrounds. Maximum radius value is 128. Compile
159 *afterimage*; resource *blurRadius*.
131 160
132 -bg *colour* 161 -bg *colour*
133 Window background colour; resource background. 162 Window background colour; resource background.
134 163
135 -fg *colour* 164 -fg *colour*
136 Window foreground colour; resource foreground. 165 Window foreground colour; resource foreground.
137 166
138 -pixmap *file[;geom]* 167 -pixmap *file[;geom]*
139 Compile *XPM*: Specify XPM file for the background and also 168 Compile *afterimage*: Specify image file for the background and also
140 optionally specify its scaling with a geometry string. Note you may 169 optionally specify its scaling with a geometry string. Note you may
141 need to add quotes to avoid special shell interpretation of the ";" 170 need to add quotes to avoid special shell interpretation of the ";"
142 in the command-line; resource backgroundPixmap. 171 in the command-line; for more details see resource backgroundPixmap.
143 172
144 -cr *colour* 173 -cr *colour*
145 The cursor colour; resource cursorColor. 174 The cursor colour; resource cursorColor.
146 175
147 -pr *colour* 176 -pr *colour*
… …
164 193
165 In short, to specify an X11 core font, just specify its name or 194 In short, to specify an X11 core font, just specify its name or
166 prefix it with "x:". To specify an XFT-font, you need to prefix it 195 prefix it with "x:". To specify an XFT-font, you need to prefix it
167 with "xft:", e.g.: 196 with "xft:", e.g.:
168 197
169 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 198 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
170 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 199 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
171 200
172 See also the question "How does rxvt-unicode choose fonts?" in the 201 See also the question "How does rxvt-unicode choose fonts?" in the
173 FAQ section of rxvt(7). 202 FAQ section of urxvt(7).
174 203
175 -fb *fontlist* 204 -fb *fontlist*
176 Compile *font-styles*: The bold font list to use when bold 205 Compile *font-styles*: The bold font list to use when bold
177 characters are to be printed. See resource boldFont for details. 206 characters are to be printed. See resource boldFont for details.
178 207
… …
273 block graphic glyphs; resource skipBuiltinGlyphs. 302 block graphic glyphs; resource skipBuiltinGlyphs.
274 303
275 -lsp *number* 304 -lsp *number*
276 Compile *frills*: Lines (pixel height) to insert between each row of 305 Compile *frills*: Lines (pixel height) to insert between each row of
277 the display. Useful to work around font rendering problems; resource 306 the display. Useful to work around font rendering problems; resource
278 linespace. 307 lineSpace.
279 308
280 -tn *termname* 309 -tn *termname*
281 This option specifies the name of the terminal type to be set in the 310 This option specifies the name of the terminal type to be set in the
282 TERM environment variable. This terminal type must exist in the 311 TERM environment variable. This terminal type must exist in the
283 *termcap(5)* database and should have *li#* and *co#* entries; 312 *termcap(5)* database and should have *li#* and *co#* entries;
284 resource termName. 313 resource termName.
285 314
286 -e *command [arguments]* 315 -e *command [arguments]*
287 Run the command with its command-line arguments in the rxvt window; 316 Run the command with its command-line arguments in the urxvt window;
288 also sets the window title and icon name to be the basename of the 317 also sets the window title and icon name to be the basename of the
289 program being executed if neither *-title* (*-T*) nor *-n* are given 318 program being executed if neither *-title* (*-T*) nor *-n* are given
290 on the command line. If this option is used, it must be the last on 319 on the command line. If this option is used, it must be the last on
291 the command-line. If there is no -e option then the default is to 320 the command-line. If there is no -e option then the default is to
292 run the program specified by the SHELL environment variable or, 321 run the program specified by the SHELL environment variable or,
… …
294 323
295 Please note that you must specify a program with arguments. If you 324 Please note that you must specify a program with arguments. If you
296 want to run shell commands, you have to specify the shell, like 325 want to run shell commands, you have to specify the shell, like
297 this: 326 this:
298 327
299 rxvt -e sh -c "shell commands" 328 urxvt -e sh -c "shell commands"
300 329
301 -title *text* 330 -title *text*
302 Window title (-T still respected); the default title is the basename 331 Window title (-T still respected); the default title is the basename
303 of the program specified after the -e option, if any, otherwise the 332 of the program specified after the -e option, if any, otherwise the
304 application name; resource title. 333 application name; resource title.
… …
327 Set the font set to use for the X Input Method, see resource imFont 356 Set the font set to use for the X Input Method, see resource imFont
328 for more info. 357 for more info.
329 358
330 -tcw 359 -tcw
331 Change the meaning of triple-click selection with the left mouse 360 Change the meaning of triple-click selection with the left mouse
361 button. Only effective when the original (non-perl) selection code
332 button. Instead of selecting a full line it will extend the 362 is in-use. Instead of selecting a full line it will extend the
333 selection the end of the logical line only. resource 363 selection the end of the logical line only. resource
334 tripleclickwords. 364 tripleclickwords.
335 365
336 -insecure 366 -insecure
337 Enable "insecure" mode, which currently enables most of the escape 367 Enable "insecure" mode, which currently enables most of the escape
… …
349 -ssr|+ssr 379 -ssr|+ssr
350 Turn on/off secondary screen scroll (default enabled); resource 380 Turn on/off secondary screen scroll (default enabled); resource
351 secondaryScroll. 381 secondaryScroll.
352 382
353 -hold|+hold 383 -hold|+hold
354 Turn on/off hold window after exit support. If enabled, rxvt will 384 Turn on/off hold window after exit support. If enabled, urxvt will
355 not immediately destroy its window when the program executed within 385 not immediately destroy its window when the program executed within
356 it exits. Instead, it will wait till it is being killed or closed by 386 it exits. Instead, it will wait till it is being killed or closed by
357 the user; resource hold. 387 the user; resource hold.
358 388
359 -keysym.*sym* *string* 389 -keysym.*sym* *string*
360 Remap a key symbol. See resource keysym. 390 Remap a key symbol. See resource keysym.
361 391
362 -embed *windowid* 392 -embed *windowid*
363 Tells rxvt to embed its windows into an already-existing window, 393 Tells urxvt to embed its windows into an already-existing window,
364 which enables applications to easily embed a terminal. 394 which enables applications to easily embed a terminal.
365 395
366 Right now, rxvt will first unmap/map the specified window, so it 396 Right now, urxvt will first unmap/map the specified window, so it
367 shouldn't be a top-level window. rxvt will also reconfigure it quite 397 shouldn't be a top-level window. urxvt will also reconfigure it
368 a bit, so don't expect it to keep some specific state. It's best to 398 quite a bit, so don't expect it to keep some specific state. It's
369 create an extra subwindow for rxvt and leave it alone. 399 best to create an extra subwindow for urxvt and leave it alone.
370 400
371 The window will not be destroyed when rxvt exits. 401 The window will not be destroyed when urxvt exits.
372 402
373 It might be useful to know that rxvt will not close file descriptors 403 It might be useful to know that urxvt will not close file
374 passed to it (except for stdin/out/err, of course), so you can use 404 descriptors passed to it (except for stdin/out/err, of course), so
375 file descriptors to communicate with the programs within the 405 you can use file descriptors to communicate with the programs within
376 terminal. This works regardless of whether the "-embed" option was 406 the terminal. This works regardless of whether the "-embed" option
377 used or not. 407 was used or not.
378 408
379 Here is a short Gtk2-perl snippet that illustrates how this option 409 Here is a short Gtk2-perl snippet that illustrates how this option
380 can be used (a longer example is in doc/embed): 410 can be used (a longer example is in doc/embed):
381 411
382 my $rxvt = new Gtk2::Socket; 412 my $rxvt = new Gtk2::Socket;
383 $rxvt->signal_connect_after (realize => sub { 413 $rxvt->signal_connect_after (realize => sub {
384 my $xid = $_[0]->window->get_xid; 414 my $xid = $_[0]->window->get_xid;
385 system "rxvt -embed $xid &"; 415 system "urxvt -embed $xid &";
386 }); 416 });
387 417
388 -pty-fd *file descriptor* 418 -pty-fd *file descriptor*
389 Tells rxvt NOT to execute any commands or create a new pty/tty pair 419 Tells urxvt NOT to execute any commands or create a new pty/tty pair
390 but instead use the given file descriptor as the tty master. This is 420 but instead use the given file descriptor as the tty master. This is
391 useful if you want to drive rxvt as a generic terminal emulator 421 useful if you want to drive urxvt as a generic terminal emulator
392 without having to run a program within it. 422 without having to run a program within it.
393 423
394 If this switch is given, rxvt will not create any utmp/wtmp entries 424 If this switch is given, urxvt will not create any utmp/wtmp entries
395 and will not tinker with pty/tty permissions - you have to do that 425 and will not tinker with pty/tty permissions - you have to do that
396 yourself if you want that. 426 yourself if you want that.
397 427
398 As an extremely special case, specifying -1 will completely suppress 428 As an extremely special case, specifying -1 will completely suppress
399 pty/tty operations. 429 pty/tty operations.
… …
404 use IO::Pty; 434 use IO::Pty;
405 use Fcntl; 435 use Fcntl;
406 436
407 my $pty = new IO::Pty; 437 my $pty = new IO::Pty;
408 fcntl $pty, F_SETFD, 0; # clear close-on-exec 438 fcntl $pty, F_SETFD, 0; # clear close-on-exec
409 system "rxvt -pty-fd " . (fileno $pty) . "&"; 439 system "urxvt -pty-fd " . (fileno $pty) . "&";
410 close $pty; 440 close $pty;
411 441
412 # now communicate with rxvt 442 # now communicate with rxvt
413 my $slave = $pty->slave; 443 my $slave = $pty->slave;
414 while (<$slave>) { print $slave "got <$_>\n" } 444 while (<$slave>) { print $slave "got <$_>\n" }
… …
416 -pe *string* 446 -pe *string*
417 Comma-separated list of perl extension scripts to use (or not to 447 Comma-separated list of perl extension scripts to use (or not to
418 use) in this terminal instance. See resource perl-ext for details. 448 use) in this terminal instance. See resource perl-ext for details.
419 449
420RESOURCES (available also as long-options) 450RESOURCES (available also as long-options)
421 Note: `rxvt --help' gives a list of all resources (long options) 451 Note: `urxvt --help' gives a list of all resources (long options)
422 compiled into your version. 452 compiled into your version.
423 453
424 You can set and change the resources using X11 tools like xrdb. Many 454 You can set and change the resources using X11 tools like xrdb. Many
425 distribution do also load settings from the ~/.Xresources file when X 455 distribution do also load settings from the ~/.Xresources file when X
426 starts. rxvt will consult the following files/resources in order, with 456 starts. urxvt will consult the following files/resources in order, with
427 later settings overwriting earlier ones: 457 later settings overwriting earlier ones:
428 458
429 1. system-wide app-defaults file, either locale-dependent OR global 459 1. system-wide app-defaults file, either locale-dependent OR global
430 2. app-defaults file in $XAPPLRESDIR 460 2. app-defaults file in $XAPPLRESDIR
431 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 461 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
432 4. SCREEN_RESOURCES for the current screen 462 4. SCREEN_RESOURCES for the current screen
433 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 463 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
434 464
435 Note that when reading X resources, rxvt recognizes two class names: 465 Note that when reading X resources, urxvt recognizes two class names:
436 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt 466 Rxvt and URxvt. The class name Rxvt allows resources common to both
437 and the original *rxvt* to be easily configured, while the class name 467 urxvt and the original *rxvt* to be easily configured, while the class
438 URxvt allows resources unique to rxvt, to be shared between different 468 name URxvt allows resources unique to urxvt, to be shared between
439 rxvt configurations. If no resources are specified, suitable defaults 469 different urxvt configurations. If no resources are specified, suitable
440 will be used. Command-line arguments can be used to override resource 470 defaults will be used. Command-line arguments can be used to override
441 settings. The following resources are supported (you might want to check 471 resource settings. The following resources are supported (you might want
442 the rxvtperl(3) manpage for additional settings by perl extensions not 472 to check the urxvtperl(3) manpage for additional settings by perl
443 documented here): 473 extensions not documented here):
444 474
445 depth: *bitdepth* 475 depth: *bitdepth*
446 Compile *xft*: Attempt to find a visual with the given bit depth; 476 Compile *xft*: Attempt to find a visual with the given bit depth;
447 option -depth. 477 option -depth.
448 478
… …
466 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but 496 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
467 the actual colour names used are listed in the COLORS AND GRAPHICS 497 the actual colour names used are listed in the COLORS AND GRAPHICS
468 section. 498 section.
469 499
470 Colours higher than 15 cannot be set using resources (yet), but can 500 Colours higher than 15 cannot be set using resources (yet), but can
471 be changed using an escape command (see rxvt(7)). 501 be changed using an escape command (see urxvt(7)).
472 502
473 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm 503 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
474 with 88 colour support). Colours 80-87 are evenly spaces grey steps. 504 with 88 colour support). Colours 80-87 are evenly spaces grey steps.
475 505
476 colorBD: *colour* 506 colorBD: *colour*
… …
484 Use the specified colour to display underlined characters when the 514 Use the specified colour to display underlined characters when the
485 foreground colour is the default. 515 foreground colour is the default.
486 516
487 colorRV: *colour* 517 colorRV: *colour*
488 Use the specified colour as the background for reverse video 518 Use the specified colour as the background for reverse video
489 characters. 519 characters when OPTION_HC is disabled (--disable-frills).
490 520
491 underlineColor: *colour* 521 underlineColor: *colour*
492 If set, use the specified colour as the colour for the underline 522 If set, use the specified colour as the colour for the underline
493 itself. If unset, use the foreground colour. 523 itself. If unset, use the foreground colour.
494 524
… …
505 True: simulate reverse video by foreground and background colours; 535 True: simulate reverse video by foreground and background colours;
506 option -rv. False: regular screen colours [default]; option +rv. See 536 option -rv. False: regular screen colours [default]; option +rv. See
507 note in COLORS AND GRAPHICS section. 537 note in COLORS AND GRAPHICS section.
508 538
509 jumpScroll: *boolean* 539 jumpScroll: *boolean*
510 True: specify that jump scrolling should be used. When scrolling 540 True: specify that jump scrolling should be used. When receiving
511 quickly, fewer screen updates are performed [default]; option -j. 541 lots of lines, urxvt will only scroll once a whole screen height of
542 lines has been read, resulting in fewer updates while still
543 displaying every received line; option -j.
544
512 False: specify that smooth scrolling should be used; option +j. 545 False: specify that smooth scrolling should be used. urxvt will
546 force a screen refresh on each new line it received; option +j.
547
548 skipScroll: *boolean*
549 True: (the default) specify that skip scrolling should be used. When
550 receiving lots of lines, urxvt will only scroll once in a while
551 (around 60 times per second), resulting in far fewer updates. This
552 can result in urxvt not ever displaying some of the lines it
553 receives; option -ss.
554
555 False: specify that everything is to be displayed, even if the
556 refresh is too fast for the human eye to read anything (or the
557 monitor to display anything); option +ss.
513 558
514 inheritPixmap: *boolean* 559 inheritPixmap: *boolean*
515 True: make the background inherit the parent windows' pixmap, giving 560 True: make the background inherit the parent windows' pixmap, giving
516 artificial transparency. False: do not inherit the parent windows' 561 artificial transparency. False: do not inherit the parent windows'
517 pixmap. 562 pixmap.
… …
531 Tint the transparent background pixmap with the given colour; option 576 Tint the transparent background pixmap with the given colour; option
532 -tint. 577 -tint.
533 578
534 shading: *number* 579 shading: *number*
535 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 580 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
536 image in addition to tinting it. 581 image in addition to tinting it; option -sh.
582
583 blendType: *string*
584 Specify background blending type; option -blt.
585
586 blurRadius: *number*
587 Apply Gaussian Blurr with the specified radius to the transparent
588 background image; option -blr.
537 589
538 scrollColor: *colour* 590 scrollColor: *colour*
539 Use the specified colour for the scrollbar [default #B2B2B2]. 591 Use the specified colour for the scrollbar [default #B2B2B2].
540 592
541 troughColor: *colour* 593 troughColor: *colour*
… …
545 borderColor: *colour* 597 borderColor: *colour*
546 The colour of the border around the text area and between the 598 The colour of the border around the text area and between the
547 scrollbar and the text. 599 scrollbar and the text.
548 600
549 backgroundPixmap: *file[;geom]* 601 backgroundPixmap: *file[;geom]*
550 Use the specified XPM file (note the `.xpm' extension is optional) 602 Use the specified image file for the background and also optionally
551 for the background and also optionally specify its scaling with a 603 specify its scaling with a geometry string WxH+X+Y, in which "W" /
552 geometry string WxH+X+Y, in which "W" / "H" specify the
553 horizontal/vertical scale (percent) and "X" / "Y" locate the image 604 "H" specify the horizontal/vertical scale (percent), and "X" / "Y"
554 centre (percent). A scale of 0 displays the image with tiling. A 605 locate the image centre (percent). A scale of 0 displays the image
555 scale of 1 displays the image without any scaling. A scale of 2 to 9 606 with tiling. A scale of 1 displays the image without any scaling. A
556 specifies an integer number of images in that direction. No image 607 scale of 2 to 9 specifies an integer number of images in that
557 will be magnified beyond 10 times its original size. The maximum 608 direction. No image will be magnified beyond 10 times its original
558 permitted scale is 1000. [default 0x0+50+50] 609 size. The maximum permitted scale is 1000. Special string of "auto"
610 used as a geometry will cause image to be automatically scaled to
611 match window size. If used in conjunction with -tr option -
612 specified pixmap will be blended over transparency image using
613 either alpha-blending, or any other blending type, specified with
614 -blt "type" option. [default 0x0+50+50]
559 615
560 path: *path* 616 path: *path*
561 Specify the colon-delimited search path for finding XPM files. 617 Specify the colon-delimited search path for finding background image
618 files.
562 619
563 font: *fontlist* 620 font: *fontlist*
564 Select the fonts to be used. This is a comma separated list of font 621 Select the fonts to be used. This is a comma separated list of font
565 names that are checked in order when trying to find glyphs for 622 names that are checked in order when trying to find glyphs for
566 characters. The first font defines the cell size for characters; 623 characters. The first font defines the cell size for characters;
… …
630 colours are not reachable. 687 colours are not reachable.
631 688
632 selectstyle: *mode* 689 selectstyle: *mode*
633 Set mouse selection style to old which is 2.20, oldword which is 690 Set mouse selection style to old which is 2.20, oldword which is
634 xterm style with 2.20 old word selection, or anything else which 691 xterm style with 2.20 old word selection, or anything else which
635 gives xterm style selection. 692 gives xterm style selection. Only effective when the original
693 (non-perl) selection code is in use.
636 694
637 scrollstyle: *mode* 695 scrollstyle: *mode*
638 Set scrollbar style to rxvt, plain, next or xterm. plain is the 696 Set scrollbar style to rxvt, plain, next or xterm. plain is the
639 author's favourite. 697 author's favourite.
640 698
… …
649 explicitly set; option -n. 707 explicitly set; option -n.
650 708
651 mapAlert: *boolean* 709 mapAlert: *boolean*
652 True: de-iconify (map) on receipt of a bell character. False: no 710 True: de-iconify (map) on receipt of a bell character. False: no
653 de-iconify (map) on receipt of a bell character [default]. 711 de-iconify (map) on receipt of a bell character [default].
712
713 urgentOnBell: *boolean*
714 True: set the urgency hint for the wm on receipt of a bell
715 character. False: do not set the urgency hint [default].
654 716
655 visualBell: *boolean* 717 visualBell: *boolean*
656 True: use visual bell on receipt of a bell character; option -vb. 718 True: use visual bell on receipt of a bell character; option -vb.
657 False: no visual bell [default]; option +vb. 719 False: no visual bell [default]; option +vb.
658 720
… …
736 798
737 termName: *termname* 799 termName: *termname*
738 Specifies the terminal type name to be set in the TERM environment 800 Specifies the terminal type name to be set in the TERM environment
739 variable; option -tn. 801 variable; option -tn.
740 802
741 linespace: *number* 803 lineSpace: *number*
742 Specifies number of lines (pixel height) to insert between each row 804 Specifies number of lines (pixel height) to insert between each row
743 of the display [default 0]; option -lsp. 805 of the display [default 0]; option -lsp.
744 806
745 meta8: *boolean* 807 meta8: *boolean*
746 True: handle Meta (Alt) + keypress to set the 8th bit. False: handle 808 True: handle Meta (Alt) + keypress to set the 8th bit. False: handle
… …
787 849
788 cutchars: *string* 850 cutchars: *string*
789 The characters used as delimiters for double-click word selection 851 The characters used as delimiters for double-click word selection
790 (whitespace delimiting is added automatically if resource is given). 852 (whitespace delimiting is added automatically if resource is given).
791 853
792 When the selection extension is in use (the default if compiled in, 854 When the perl selection extension is in use (the default if compiled
793 see the rxvtperl(3) manpage), a suitable regex using these 855 in, see the urxvtperl(3) manpage), a suitable regex using these
794 characters will be created (if the resource exists, otherwise, no 856 characters will be created (if the resource exists, otherwise, no
795 regex will be created). In this mode, characters outside ISO-8859-1 857 regex will be created). In this mode, characters outside ISO-8859-1
796 can be used. 858 can be used.
797 859
798 When the selection extension is not used, only ISO-8859-1 characters 860 When the selection extension is not used, only ISO-8859-1 characters
… …
814 876
815 imFont: *fontset* 877 imFont: *fontset*
816 Specify the font-set used for XIM styles "OverTheSpot" or 878 Specify the font-set used for XIM styles "OverTheSpot" or
817 "OffTheSpot". It must be a standard X font set (XLFD patterns 879 "OffTheSpot". It must be a standard X font set (XLFD patterns
818 separated by commas), i.e. it's not in the same format as the other 880 separated by commas), i.e. it's not in the same format as the other
819 font lists used in rxvt. The default will be set-up to chose *any* 881 font lists used in urxvt. The default will be set-up to chose *any*
820 suitable found found, preferably one or two pixels differing in size 882 suitable found found, preferably one or two pixels differing in size
821 to the base font. option -imfont. 883 to the base font. option -imfont.
822 884
823 tripleclickwords: *boolean* 885 tripleclickwords: *boolean*
824 Change the meaning of triple-click selection with the left mouse 886 Change the meaning of triple-click selection with the left mouse
… …
850 912
851 secondaryScreen: *boolean* 913 secondaryScreen: *boolean*
852 Turn on/off secondary screen (default enabled). 914 Turn on/off secondary screen (default enabled).
853 915
854 secondaryScroll: *boolean* 916 secondaryScroll: *boolean*
855 Turn on/off secondary screen scroll (default enabled). If the this 917 Turn on/off secondary screen scroll (default enabled). If this
856 option is enabled, scrolls on the secondary screen will change the 918 option is enabled, scrolls on the secondary screen will change the
857 scrollback buffer and switching to/from the secondary screen will 919 scrollback buffer and switching to/from the secondary screen will
858 instead scroll the screen up. 920 instead scroll the screen up.
859 921
860 hold: *boolean* 922 hold: *boolean*
861 Turn on/off hold window after exit support. If enabled, rxvt will 923 Turn on/off hold window after exit support. If enabled, urxvt will
862 not immediately destroy its window when the program executed within 924 not immediately destroy its window when the program executed within
863 it exits. Instead, it will wait till it is being killed or closed by 925 it exits. Instead, it will wait till it is being killed or closed by
864 the user. 926 the user.
865 927
866 keysym.*sym*: *string* 928 keysym.*sym*: *string*
… …
882 omitting the prefix XK_. Alternatively you can specify *key* by its 944 omitting the prefix XK_. Alternatively you can specify *key* by its
883 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s 945 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
884 is not performed in an exact manner; however, the closest match is 946 is not performed in an exact manner; however, the closest match is
885 assured. 947 assured.
886 948
887 *string* may contain escape values ("\a": bell, "\b": backspace, 949 *string* may contain escape values ("\n": newline, "\000": octal
888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 950 number), see RESOURCES in "man 7 X" for futher details.
889 "\000": octal number) or verbatim control characters ("^?": delete,
890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
893
894 Please note that you need to double the "\" in resource files, as
895 Xlib itself does its own de-escaping (you can use "\033" instead of
896 "\e" (and so on), which will work with both Xt and rxvt's own
897 processing).
898 951
899 You can define a range of keysyms in one shot by providing a 952 You can define a range of keysyms in one shot by providing a
900 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter 953 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
901 `/' should be a character not used by the strings. 954 `/' should be a character not used by the strings.
902 955
… …
909 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 962 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
910 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 963 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
911 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 964 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
912 965
913 If *string* takes the form of "command:STRING", the specified STRING 966 If *string* takes the form of "command:STRING", the specified STRING
914 is interpreted and executed as rxvt's control sequence. For example 967 is interpreted and executed as urxvt's control sequence. For example
915 the following means "change the current locale to "zh_CN.GBK" when 968 the following means "change the current locale to "zh_CN.GBK" when
916 Control-Meta-c is being pressed": 969 Control-Meta-c is being pressed":
917 970
918 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 971 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
919 972
920 If *string* takes the form "perl:STRING", then the specified STRING 973 If *string* takes the form "perl:STRING", then the specified STRING
921 is passed to the "on_keyboard_command" perl handler. See the 974 is passed to the "on_keyboard_command" perl handler. See the
922 rxvtperl(3) manpage. For example, the selection extension (activated 975 urxvtperl(3) manpage. For example, the selection extension
923 via "rxvt -pe selection") listens for "selection:rot13" events: 976 (activated via "urxvt -pe selection") listens for "selection:rot13"
977 events:
924 978
925 URxvt.keysym.M-C-c: perl:selection:rot13 979 URxvt.keysym.M-C-c: perl:selection:rot13
926 980
927 Due the the large number of modifier combinations, a defined key 981 Due the the large number of modifier combinations, a defined key
928 mapping will match if at *at least* the specified identifiers are 982 mapping will match if at *at least* the specified identifiers are
… …
930 being defined. That means that defining a key map for "a" will 984 being defined. That means that defining a key map for "a" will
931 automatically provide definitions for "Meta-a", "Shift-a" and so on, 985 automatically provide definitions for "Meta-a", "Shift-a" and so on,
932 unless some of those are defined mappings themselves. 986 unless some of those are defined mappings themselves.
933 987
934 Unfortunately, this will override built-in key mappings. For example 988 Unfortunately, this will override built-in key mappings. For example
935 if you overwrite the "Insert" key you will disable rxvt's 989 if you overwrite the "Insert" key you will disable urxvt's
936 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into 990 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
937 the user-defined keymap using the "builtin:" replacement: 991 the user-defined keymap using the "builtin:" replacement:
938 992
939 URxvt.keysym.Insert: <my insert key sequence> 993 URxvt.keysym.Insert: <my insert key sequence>
940 URxvt.keysym.S-Insert: builtin: 994 URxvt.keysym.S-Insert: builtin:
… …
948 font-switching at runtime: 1002 font-switching at runtime:
949 1003
950 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1004 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
951 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1005 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
952 1006
953 Other things are possible, e.g. resizing (see rxvt(7) for more 1007 Other things are possible, e.g. resizing (see urxvt(7) for more
954 info): 1008 info):
955 1009
956 URxvt.keysym.M-C-3: command:\033[8;25;80t 1010 URxvt.keysym.M-C-3: command:\033[8;25;80t
957 URxvt.keysym.M-C-4: command:\033[8;48;110t 1011 URxvt.keysym.M-C-4: command:\033[8;48;110t
958 1012
… …
982 available to all instances, while perl-ext is used for specific 1036 available to all instances, while perl-ext is used for specific
983 instances. 1037 instances.
984 1038
985 perl-eval: *string* 1039 perl-eval: *string*
986 Perl code to be evaluated when all extensions have been registered. 1040 Perl code to be evaluated when all extensions have been registered.
987 See the rxvtperl(3) manpage. Due to security reasons, this resource 1041 See the urxvtperl(3) manpage. Due to security reasons, this resource
988 will be ignored when running setuid/setgid. 1042 will be ignored when running setuid/setgid.
989 1043
990 perl-lib: *path* 1044 perl-lib: *path*
991 Colon-separated list of additional directories that hold extension 1045 Colon-separated list of additional directories that hold extension
992 scripts. When looking for extensions specified by the "perl" 1046 scripts. When looking for extensions specified by the "perl"
993 resource, rxvt will first look in these directories and then in 1047 resource, urxvt will first look in these directories and then in
994 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource 1048 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource
995 will be ignored when running setuid/setgid. 1049 will be ignored when running setuid/setgid.
996 1050
997 See the rxvtperl(3) manpage. 1051 See the urxvtperl(3) manpage.
998 1052
999 selection.pattern-*idx*: *perl-regex* 1053 selection.pattern-*idx*: *perl-regex*
1000 Additional selection patterns, see the rxvtperl(3) manpage for 1054 Additional selection patterns, see the urxvtperl(3) manpage for
1001 details. 1055 details.
1002 1056
1003 selection-autotransform.*idx*: *perl-transform* 1057 selection-autotransform.*idx*: *perl-transform*
1004 Selection auto-transform patterns, see the rxvtperl(3) manpage for 1058 Selection auto-transform patterns, see the urxvtperl(3) manpage for
1005 details. 1059 details.
1006 1060
1007 searchable-scrollback: *keysym* 1061 searchable-scrollback: *keysym*
1008 Sets the hotkey that starts the incremental scrollback buffer search 1062 Sets the hotkey that starts the incremental scrollback buffer search
1009 (default: "M-s"). 1063 (default: "M-s").
1010 1064
1011 urlLauncher: *string* 1065 urlLauncher: *string*
1012 Specifies the program to be started with a URL argument. Used by the 1066 Specifies the program to be started with a URL argument. Used by the
1013 "selection-popup" and "mark-urls" perl extensions. 1067 "selection-popup" and "matcher" perl extensions.
1014 1068
1015 transient-for: *windowid* 1069 transient-for: *windowid*
1016 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given 1070 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1017 window id. 1071 window id.
1018 1072
1019 override-redirect: *boolean* 1073 override-redirect: *boolean*
1020 Compile *frills*: Sets override-redirect for the terminal window, 1074 Compile *frills*: Sets override-redirect for the terminal window,
1021 making it almost invisible to window managers; option 1075 making it almost invisible to window managers; option
1022 -override-redirect. 1076 -override-redirect.
1023 1077
1078 iso14755_52: *boolean*
1079 Turn on/off ISO 14755 5.2 mode (default enabled).
1080
1024THE SCROLLBAR 1081THE SCROLLBAR
1025 Lines of text that scroll off the top of the rxvt window (resource: 1082 Lines of text that scroll off the top of the urxvt window (resource:
1026 saveLines) and can be scrolled back using the scrollbar or by 1083 saveLines) and can be scrolled back using the scrollbar or by
1027 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1084 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
1028 fairly intuitive. The xterm-scrollbar is without arrows and its 1085 fairly intuitive. The xterm-scrollbar is without arrows and its
1029 behaviour mimics that of *xterm* 1086 behaviour mimics that of *xterm*
1030 1087
1031 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with 1088 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
1032 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1089 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
… …
1041 disabled -- on the assumption that we are using a fullscreen 1098 disabled -- on the assumption that we are using a fullscreen
1042 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ 1099 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
1043 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the 1100 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
1044 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. 1101 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
1045 1102
1046TEXT SELECTION AND INSERTION 1103THE SELECTION: SELECTING AND PASTING TEXT
1047 The behaviour of text selection and insertion mechanism is similar to 1104 The behaviour of text selection and insertion/pasting mechanism is
1048 *xterm*(1). 1105 similar to *xterm*(1).
1049 1106
1050 Selection: 1107 Selecting:
1051 Left click at the beginning of the region, drag to the end of the 1108 Left click at the beginning of the region, drag to the end of the
1052 region and release; Right click to extend the marked region; Left 1109 region and release; Right click to extend the marked region; Left
1053 double-click to select a word; Left triple-click to select the 1110 double-click to select a word; Left triple-click to select the
1054 entire logical line (which can span multiple screen lines), unless 1111 entire logical line (which can span multiple screen lines), unless
1055 modified by resource tripleclickwords. 1112 modified by resource tripleclickwords.
… …
1058 (Compile: *frills*) will create a rectangular selection instead of a 1115 (Compile: *frills*) will create a rectangular selection instead of a
1059 normal one. In this mode, every selected row becomes its own line in 1116 normal one. In this mode, every selected row becomes its own line in
1060 the selection, and trailing whitespace is visually underlined and 1117 the selection, and trailing whitespace is visually underlined and
1061 removed from the selection. 1118 removed from the selection.
1062 1119
1063 Insertion: 1120 Pasting:
1064 Pressing and releasing the Middle mouse button in an rxvt window 1121 Pressing and releasing the Middle mouse button in an urxvt window
1065 causes the value of the PRIMARY selection (or CLIPBOARD with the 1122 causes the value of the PRIMARY selection (or CLIPBOARD with the
1066 Meta modifier) to be inserted as if it had been typed on the 1123 Meta modifier) to be inserted as if it had been typed on the
1067 keyboard. 1124 keyboard.
1068 1125
1069 Pressing Shift-Insert causes the value of the PRIMARY selection to 1126 Pressing Shift-Insert causes the value of the PRIMARY selection to
… …
1086 far. 1143 far.
1087 1144
1088ISO 14755 SUPPORT 1145ISO 14755 SUPPORT
1089 ISO 14755 is a standard for entering and viewing unicode characters and 1146 ISO 14755 is a standard for entering and viewing unicode characters and
1090 character codes using the keyboard. It consists of 4 parts. The first 1147 character codes using the keyboard. It consists of 4 parts. The first
1091 part is available rxvt-unicode has been compiled with "--enable-frills", 1148 part is available if rxvt-unicode has been compiled with
1092 the rest is available when rxvt-unicode was compiled with 1149 "--enable-frills", the rest is available when rxvt-unicode was compiled
1093 "--enable-iso14755". 1150 with "--enable-iso14755".
1094 1151
1095 * 5.1: Basic method 1152 * 5.1: Basic method
1096 This allows you to enter unicode characters using their hexcode. 1153 This allows you to enter unicode characters using their hexcode.
1097 1154
1098 Start by pressing and holding both "Control" and "Shift", then enter 1155 Start by pressing and holding both "Control" and "Shift", then enter
… …
1143 1200
1144 With respect to conformance, rxvt-unicode is supposed to be compliant to 1201 With respect to conformance, rxvt-unicode is supposed to be compliant to
1145 both scenario A and B of ISO 14755, including part 5.2. 1202 both scenario A and B of ISO 14755, including part 5.2.
1146 1203
1147LOGIN STAMP 1204LOGIN STAMP
1148 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1205 urxvt tries to write an entry into the *utmp*(5) file so that it can be
1149 seen via the *who(1)* command, and can accept messages. To allow this 1206 seen via the *who(1)* command, and can accept messages. To allow this
1150 feature, rxvt may need to be installed setuid root on some systems or 1207 feature, urxvt may need to be installed setuid root on some systems or
1151 setgid to root or to some other group on others. 1208 setgid to root or to some other group on others.
1152 1209
1153COLORS AND GRAPHICS 1210COLORS AND GRAPHICS
1154 In addition to the default foreground and background colours, rxvt can 1211 In addition to the default foreground and background colours, urxvt can
1155 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1212 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1156 versions of the same). Here is a list of the colours with their names. 1213 versions of the same). Here is a list of the colours with their names.
1157 1214
1158 color0 (black) = Black 1215 color0 (black) = Black
1159 color1 (red) = Red3 1216 color1 (red) = Red3
… …
1177 It is also possible to specify the colour values of foreground, 1234 It is also possible to specify the colour values of foreground,
1178 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1235 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1179 0-15, as a convenient shorthand to reference the colour name of 1236 0-15, as a convenient shorthand to reference the colour name of
1180 color0-color15. 1237 color0-color15.
1181 1238
1182 In addition to the colours defined above, rxvt offers an additional 72 1239 In addition to the colours defined above, urxvt offers an additional 72
1183 colours. The first 64 of those (with indices 16 to 79) consist of a 1240 colours. The first 64 of those (with indices 16 to 79) consist of a
1184 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed 1241 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1185 by 8 additional shades of gray (with indices 80 to 87). 1242 by 8 additional shades of gray (with indices 80 to 87).
1186 1243
1187 Together, all those colours implement the 88 colour xterm colours. Only 1244 Together, all those colours implement the 88 colour xterm colours. Only
… …
1191 Note that -rv ("reverseVideo: True") simulates reverse video by always 1248 Note that -rv ("reverseVideo: True") simulates reverse video by always
1192 swapping the foreground/background colours. This is in contrast to 1249 swapping the foreground/background colours. This is in contrast to
1193 *xterm*(1) where the colours are only swapped if they have not otherwise 1250 *xterm*(1) where the colours are only swapped if they have not otherwise
1194 been specified. For example, 1251 been specified. For example,
1195 1252
1196 rxvt -fg Black -bg White -rv 1253 urxvt -fg Black -bg White -rv
1197 would yield White on Black, while on *xterm*(1) it would yield Black 1254 would yield White on Black, while on *xterm*(1) it would yield Black
1198 on White. 1255 on White.
1199 1256
1200 ALPHA CHANNEL SUPPORT 1257 ALPHA CHANNEL SUPPORT
1201 If Xft support has been compiled in and as long as Xft/Xrender/X don't 1258 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1202 get their act together, rxvt-unicode will support 1259 get their act together, rxvt-unicode will support
1203 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 1260 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1204 digits/component) colour specifications, in addition to the ones 1261 digits/component) colour specifications, in addition to the ones
1205 provided by X, where the additional A component specifies opacity 1262 provided by X, where the additional A component specifies opacity
1206 (alpha) values. The minimum value of 0 is completely transparent). You 1263 (alpha) values. The minimum value of 0 is completely transparent). You
1207 can also prefix any color with "[a]", where "a" is on to four hex digits 1264 can also prefix any color with "[percent]", where "percent" is a decimal
1208 specifiying the opacity value. 1265 percentage (0-100) that specifies the opacity of the color, where 0 is
1266 completely transparent and 100 is completelxy opaque.
1209 1267
1210 You probably need to specify "-depth 32", too, and have the luck that 1268 You probably need to specify "-depth 32", too, and have the luck that
1211 your X-server uses ARGB pixel layout, as X is far from just supporting 1269 your X-server uses ARGB pixel layout, as X is far from just supporting
1212 ARGB visuals out of the box, and rxvt-unicode just fudges around. 1270 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1213 1271
1214 For example, the following selects an almost completely transparent red 1272 For example, the following selects an almost completely transparent red
1215 background, and an almost opaque pink foreground: 1273 background, and an almost opaque pink foreground:
1216 1274
1217 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1275 urxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1218 1276
1219 *Please note that transparency of any kind if completely unsupported by 1277 *Please note that transparency of any kind if completely unsupported by
1220 the author. Don't bug him with installation questions!* 1278 the author. Don't bug him with installation questions!*
1221 1279
1222ENVIRONMENT 1280ENVIRONMENT
1223 rxvt sets and/or uses the following environment variables: 1281 urxvt sets and/or uses the following environment variables:
1224 1282
1225 TERM 1283 TERM
1226 Normally set to "rxvt-unicode", unless overwritten at configure 1284 Normally set to "rxvt-unicode", unless overwritten at configure
1227 time, via resources or on the command line. 1285 time, via resources or on the command line.
1228 1286
1229 COLORTERM 1287 COLORTERM
1230 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled 1288 Either "rxvt", "rxvt-xpm", depending on whether urxvt was compiled
1231 with XPM support, and optionally with the added extension "-mono" to 1289 with background image support, and optionally with the added
1232 indicate that rxvt-unicode runs on a monochrome screen. 1290 extension "-mono" to indicate that rxvt-unicode runs on a monochrome
1291 screen.
1233 1292
1234 COLORFGBG 1293 COLORFGBG
1235 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1294 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1236 the colour code used as default foreground/text colour (or the 1295 the colour code used as default foreground/text colour (or the
1237 string "default" to indicate that the default-colour escape sequence 1296 string "default" to indicate that the default-colour escape sequence
1238 is to be used), "bg" is the colour code used as default background 1297 is to be used), "bg" is the colour code used as default background
1239 colour (or the string "default"), and "xpm" is the string "default" 1298 colour (or the string "default"), and "xpm" is the string "default"
1240 if rxvt was compiled with XPM support. Libraries like "ncurses" and 1299 if urxvt was compiled with background image support. Libraries like
1241 "slang" can (and do) use this information to optimize screen output. 1300 "ncurses" and "slang" can (and do) use this information to optimize
1301 screen output.
1242 1302
1243 WINDOWID 1303 WINDOWID
1244 Set to the (decimal) X Window ID of the rxvt window (the toplevel 1304 Set to the (decimal) X Window ID of the urxvt window (the toplevel
1245 window, which usually has subwindows for the scrollbar, the terminal 1305 window, which usually has subwindows for the scrollbar, the terminal
1246 window and so on). 1306 window and so on).
1247 1307
1248 TERMINFO 1308 TERMINFO
1249 Set to the terminfo directory iff rxvt was configured with 1309 Set to the terminfo directory iff urxvt was configured with
1250 "--with-terminfo=PATH". 1310 "--with-terminfo=PATH".
1251 1311
1252 DISPLAY 1312 DISPLAY
1253 Used by rxvt to connect to the display and set to the correct 1313 Used by urxvt to connect to the display and set to the correct
1254 display in its child processes. 1314 display in its child processes.
1255 1315
1256 SHELL 1316 SHELL
1257 The shell to be used for command execution, defaults to "/bin/sh". 1317 The shell to be used for command execution, defaults to "/bin/sh".
1258 1318
1259 RXVT_SOCKET 1319 RXVT_SOCKET
1260 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1320 The unix domain socket path used by urxvtc(1) and urxvtd(1).
1261 1321
1262 Default $HOME/.rxvt-unicode-*<nodename*. 1322 Default $HOME/.rxvt-unicode-*<nodename*.
1263 1323
1264 HOME 1324 HOME
1265 Used to locate the default directory for the unix domain socket for 1325 Used to locate the default directory for the unix domain socket for
… …
1269 XAPPLRESDIR 1329 XAPPLRESDIR
1270 Directory where various X resource files are being located. 1330 Directory where various X resource files are being located.
1271 1331
1272 XENVIRONMENT 1332 XENVIRONMENT
1273 If set and accessible, gives the name of a X resource file to be 1333 If set and accessible, gives the name of a X resource file to be
1274 loaded by rxvt. 1334 loaded by urxvt.
1275 1335
1276FILES 1336FILES
1277 /usr/lib/X11/rgb.txt 1337 /usr/lib/X11/rgb.txt
1278 Color names. 1338 Color names.
1279 1339
1280SEE ALSO 1340SEE ALSO
1281 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1341 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1),
1282 tty(4), utmp(5) 1342 pty(4), tty(4), utmp(5)
1283 1343
1284CURRENT PROJECT COORDINATOR 1344CURRENT PROJECT COORDINATOR
1285 Project Coordinator 1345 Project Coordinator
1286 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1346 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1287 1347

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines