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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.45 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.63 by root, Thu Nov 2 17:37:47 2006 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 urxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 7.0, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.0, 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 urxvt(7) (try "man 7 urxvt") for a list of frequently asked 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 questions and answer to them and some common problems. That document is 17 and answer to them and some common problems. That document is also
18 also 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 urxvtd(1) (daemon) and urxvtc(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 urxvt(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 urxvt 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
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. `urxvt 68 may not accurately reflect the version installed on your system. `rxvt
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: `urxvt -help' gives a list of all command-line options 72 line. Note: `rxvt -help' gives a list of all command-line options
73 compiled into your version. 73 compiled into your version.
74 74
75 Note that urxvt permits the resource name to be used as a long-option 75 Note that rxvt 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: `urxvt --loginShell --color1 Orange'. 77 than those listed. For example: `rxvt --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.
… …
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
115 be used to brighten or darken the image in addition to tinting it; 123 be used to brighten or darken the image in addition to tinting it;
116 resource *tintColor*. Example: 124 resource *tintColor*. Example:
117 125
118 urxvt -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").
123 131
… …
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 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 169 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 urxvt -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 urxvt(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 176 Compile *font-styles*: The bold font list to use when bold
169 characters are to be printed. See resource boldFont for details. 177 characters are to be printed. See resource boldFont for details.
170 178
… …
252 260
253 -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.
254 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
255 decorations; resource borderLess. 263 decorations; resource borderLess.
256 264
265 -override-redirect
266 Compile *frills*: Sets override-redirect on the window; resource
267 override-redirect.
268
257 -sbg 269 -sbg
258 Compile *frills*: Disable the usage of the built-in block 270 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 271 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its 272 fonts provide. Use this if you have a good font and want to use its
261 block graphic glyphs; resource skipBuiltinGlyphs. 273 block graphic glyphs; resource skipBuiltinGlyphs.
… …
270 TERM environment variable. This terminal type must exist in the 282 TERM environment variable. This terminal type must exist in the
271 *termcap(5)* database and should have *li#* and *co#* entries; 283 *termcap(5)* database and should have *li#* and *co#* entries;
272 resource termName. 284 resource termName.
273 285
274 -e *command [arguments]* 286 -e *command [arguments]*
275 Run the command with its command-line arguments in the urxvt window; 287 Run the command with its command-line arguments in the rxvt window;
276 also sets the window title and icon name to be the basename of the 288 also sets the window title and icon name to be the basename of the
277 program being executed if neither *-title* (*-T*) nor *-n* are given 289 program being executed if neither *-title* (*-T*) nor *-n* are given
278 on the command line. If this option is used, it must be the last on 290 on the command line. If this option is used, it must be the last on
279 the command-line. If there is no -e option then the default is to 291 the command-line. If there is no -e option then the default is to
280 run the program specified by the SHELL environment variable or, 292 run the program specified by the SHELL environment variable or,
… …
282 294
283 Please note that you must specify a program with arguments. If you 295 Please note that you must specify a program with arguments. If you
284 want to run shell commands, you have to specify the shell, like 296 want to run shell commands, you have to specify the shell, like
285 this: 297 this:
286 298
287 urxvt -e sh -c "shell commands" 299 rxvt -e sh -c "shell commands"
288 300
289 -title *text* 301 -title *text*
290 Window title (-T still respected); the default title is the basename 302 Window title (-T still respected); the default title is the basename
291 of the program specified after the -e option, if any, otherwise the 303 of the program specified after the -e option, if any, otherwise the
292 application name; resource title. 304 application name; resource title.
… …
337 -ssr|+ssr 349 -ssr|+ssr
338 Turn on/off secondary screen scroll (default enabled); resource 350 Turn on/off secondary screen scroll (default enabled); resource
339 secondaryScroll. 351 secondaryScroll.
340 352
341 -hold|+hold 353 -hold|+hold
342 Turn on/off hold window after exit support. If enabled, urxvt will 354 Turn on/off hold window after exit support. If enabled, rxvt will
343 not immediately destroy its window when the program executed within 355 not immediately destroy its window when the program executed within
344 it exits. Instead, it will wait till it is being killed or closed by 356 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold. 357 the user; resource hold.
346 358
347 -keysym.*sym* *string* 359 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym. 360 Remap a key symbol. See resource keysym.
349 361
350 -embed *windowid* 362 -embed *windowid*
351 Tells urxvt to embed it's windows into an already-existing window, 363 Tells rxvt to embed its windows into an already-existing window,
352 which enables applications to easily embed a terminal. 364 which enables applications to easily embed a terminal.
353 365
354 Right now, urxvt will first unmap/map the specified window, so it 366 Right now, rxvt will first unmap/map the specified window, so it
355 shouldn't be a top-level window. urxvt will also reconfigure it 367 shouldn't be a top-level window. rxvt will also reconfigure it quite
356 quite a bit, so don't expect it to keep some specific state. It's 368 a bit, so don't expect it to keep some specific state. It's best to
357 best to create an extra subwindow for urxvt and leave it alone. 369 create an extra subwindow for rxvt and leave it alone.
358 370
359 The window will not be destroyed when urxvt exits. 371 The window will not be destroyed when rxvt exits.
360 372
361 It might be useful to know that urxvt will not close file 373 It might be useful to know that rxvt will not close file descriptors
362 descriptors passed to it (except for stdin/out/err, of course), so 374 passed to it (except for stdin/out/err, of course), so you can use
363 you can use file descriptors to communicate with the programs within 375 file descriptors to communicate with the programs within the
364 the terminal. This works regardless of wether the "-embed" option 376 terminal. This works regardless of whether the "-embed" option was
365 was used or not. 377 used or not.
366 378
367 Here is a short Gtk2-perl snippet that illustrates how this option 379 Here is a short Gtk2-perl snippet that illustrates how this option
368 can be used (a longer example is in doc/embed): 380 can be used (a longer example is in doc/embed):
369 381
370 my $rxvt = new Gtk2::Socket; 382 my $rxvt = new Gtk2::Socket;
371 $rxvt->signal_connect_after (realize => sub { 383 $rxvt->signal_connect_after (realize => sub {
372 my $xid = $_[0]->window->get_xid; 384 my $xid = $_[0]->window->get_xid;
373 system "urxvt -embed $xid &"; 385 system "rxvt -embed $xid &";
374 }); 386 });
375 387
376 -pty-fd *file descriptor* 388 -pty-fd *file descriptor*
377 Tells urxvt NOT to execute any commands or create a new pty/tty pair 389 Tells rxvt NOT to execute any commands or create a new pty/tty pair
378 but instead use the given filehandle as the tty master. This is 390 but instead use the given file descriptor as the tty master. This is
379 useful if you want to drive urxvt as a generic terminal emulator 391 useful if you want to drive rxvt as a generic terminal emulator
380 without having to run a program within it. 392 without having to run a program within it.
381 393
382 If this switch is given, urxvt will not create any utmp/wtmp entries 394 If this switch is given, rxvt will not create any utmp/wtmp entries
383 and will not tinker with pty/tty permissions - you have to do that 395 and will not tinker with pty/tty permissions - you have to do that
384 yourself if you want that. 396 yourself if you want that.
385 397
386 As an extremely special case, specifying -1 will completely suppress 398 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations. 399 pty/tty operations.
… …
392 use IO::Pty; 404 use IO::Pty;
393 use Fcntl; 405 use Fcntl;
394 406
395 my $pty = new IO::Pty; 407 my $pty = new IO::Pty;
396 fcntl $pty, F_SETFD, 0; # clear close-on-exec 408 fcntl $pty, F_SETFD, 0; # clear close-on-exec
397 system "urxvt -pty-fd " . (fileno $pty) . "&"; 409 system "rxvt -pty-fd " . (fileno $pty) . "&";
398 close $pty; 410 close $pty;
399 411
400 # now communicate with rxvt 412 # now communicate with rxvt
401 my $slave = $pty->slave; 413 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" } 414 while (<$slave>) { print $slave "got <$_>\n" }
… …
404 -pe *string* 416 -pe *string*
405 Comma-separated list of perl extension scripts to use (or not to 417 Comma-separated list of perl extension scripts to use (or not to
406 use) in this terminal instance. See resource perl-ext for details. 418 use) in this terminal instance. See resource perl-ext for details.
407 419
408RESOURCES (available also as long-options) 420RESOURCES (available also as long-options)
409 Note: `urxvt --help' gives a list of all resources (long options) 421 Note: `rxvt --help' gives a list of all resources (long options)
410 compiled into your version. 422 compiled into your version.
411 423
412 You can set and change the resources using X11 tools like xrdb. Many 424 You can set and change the resources using X11 tools like xrdb. Many
413 distribution do also load settings from the ~/.Xresources file when X 425 distribution do also load settings from the ~/.Xresources file when X
414 starts. urxvt will consult the following files/resources in order, with 426 starts. rxvt will consult the following files/resources in order, with
415 later settings overwriting earlier ones: 427 later settings overwriting earlier ones:
416 428
417 1. system-wide app-defaults file, either locale-dependent OR global 429 1. system-wide app-defaults file, either locale-dependent OR global
418 2. app-defaults file in $XAPPLRESDIR 430 2. app-defaults file in $XAPPLRESDIR
419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 431 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
420 4. SCREEN_RESOURCES for the current screen 432 4. SCREEN_RESOURCES for the current screen
421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 433 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
422 434
423 Note that when reading X resources, urxvt recognizes two class names: 435 Note that when reading X resources, rxvt recognizes two class names:
424 Rxvt and URxvt. The class name Rxvt allows resources common to both 436 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
425 urxvt and the original *rxvt* to be easily configured, while the class 437 and the original *rxvt* to be easily configured, while the class name
426 name URxvt allows resources unique to urxvt, to be shared between 438 URxvt allows resources unique to rxvt, to be shared between different
427 different urxvt configurations. If no resources are specified, suitable 439 rxvt configurations. If no resources are specified, suitable defaults
428 defaults will be used. Command-line arguments can be used to override 440 will be used. Command-line arguments can be used to override resource
429 resource settings. The following resources are supported (you might want 441 settings. The following resources are supported (you might want to check
430 to check the urxvtperl(3) manpage for additional settings by perl 442 the rxvtperl(3) manpage for additional settings by perl extensions not
431 extensions not documented here): 443 documented here):
444
445 depth: *bitdepth*
446 Compile *xft*: Attempt to find a visual with the given bit depth;
447 option -depth.
432 448
433 geometry: *geom* 449 geometry: *geom*
434 Create the window with the specified X window geometry [default 450 Create the window with the specified X window geometry [default
435 80x24]; option -geometry. 451 80x24]; option -geometry.
436 452
… …
450 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but 466 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
451 the actual colour names used are listed in the COLORS AND GRAPHICS 467 the actual colour names used are listed in the COLORS AND GRAPHICS
452 section. 468 section.
453 469
454 Colours higher than 15 cannot be set using resources (yet), but can 470 Colours higher than 15 cannot be set using resources (yet), but can
455 be changed using an escape command (see urxvt(7)). 471 be changed using an escape command (see rxvt(7)).
456 472
457 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm 473 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
458 with 88 colour support). Colours 80-87 are evenly spaces grey steps. 474 with 88 colour support). Colours 80-87 are evenly spaces grey steps.
459 475
460 colorBD: *colour* 476 colorBD: *colour*
… …
497 513
498 inheritPixmap: *boolean* 514 inheritPixmap: *boolean*
499 True: make the background inherit the parent windows' pixmap, giving 515 True: make the background inherit the parent windows' pixmap, giving
500 artificial transparency. False: do not inherit the parent windows' 516 artificial transparency. False: do not inherit the parent windows'
501 pixmap. 517 pixmap.
518
519 *Please note that transparency of any kind if completely unsupported
520 by the author. Don't bug him with installation questions!*
502 521
503 fading: *number* 522 fading: *number*
504 Fade the text by the given percentage when focus is lost; option 523 Fade the text by the given percentage when focus is lost; option
505 -fade. 524 -fade.
506 525
… …
536 scale of 1 displays the image without any scaling. A scale of 2 to 9 555 scale of 1 displays the image without any scaling. A scale of 2 to 9
537 specifies an integer number of images in that direction. No image 556 specifies an integer number of images in that direction. No image
538 will be magnified beyond 10 times its original size. The maximum 557 will be magnified beyond 10 times its original size. The maximum
539 permitted scale is 1000. [default 0x0+50+50] 558 permitted scale is 1000. [default 0x0+50+50]
540 559
541 menu: *file[;tag]*
542 Read in the specified menu file (note the `.menu' extension is
543 optional) and also optionally specify a starting tag to find. See
544 the reference documentation for details on the syntax for the
545 menuBar.
546
547 path: *path* 560 path: *path*
548 Specify the colon-delimited search path for finding files (XPM and 561 Specify the colon-delimited search path for finding XPM files.
549 menus), in addition to the paths specified by the RXVTPATH and PATH
550 environment variables.
551 562
552 font: *fontlist* 563 font: *fontlist*
553 Select the fonts to be used. This is a comma separated list of font 564 Select the fonts to be used. This is a comma separated list of font
554 names that are checked in order when trying to find glyphs for 565 names that are checked in order when trying to find glyphs for
555 characters. The first font defines the cell size for characters; 566 characters. The first font defines the cell size for characters;
… …
566 available hint currently is "codeset=codeset-name", and this is only 577 available hint currently is "codeset=codeset-name", and this is only
567 used for Xft fonts. 578 used for Xft fonts.
568 579
569 For example, this font resource 580 For example, this font resource
570 581
571 URxvt*font: 9x15bold,\ 582 URxvt.font: 9x15bold,\
572 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 583 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
573 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 584 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
574 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 585 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
575 xft:Code2000:antialias=false 586 xft:Code2000:antialias=false
576 587
… …
612 normal text font will being used for the given style. 623 normal text font will being used for the given style.
613 624
614 intensityStyles: *boolean* 625 intensityStyles: *boolean*
615 When font styles are not enabled, or this option is enabled (True, 626 When font styles are not enabled, or this option is enabled (True,
616 option -is, the default), bold and italic font styles imply high 627 option -is, the default), bold and italic font styles imply high
617 intensity foreground/backround colours. Disabling this option 628 intensity foreground/background colours. Disabling this option
618 (False, option +is) disables this behaviour, the high intensity 629 (False, option +is) disables this behaviour, the high intensity
619 colours are not reachable. 630 colours are not reachable.
620 631
621 selectstyle: *mode* 632 selectstyle: *mode*
622 Set mouse selection style to old which is 2.20, oldword which is 633 Set mouse selection style to old which is 2.20, oldword which is
… …
662 673
663 The string will be interpreted as if typed into the shell as-is. 674 The string will be interpreted as if typed into the shell as-is.
664 675
665 Example: 676 Example:
666 677
667 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 678 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
668 679
669 This creates a new file in your home directory with the screen 680 This creates a new file in your home directory with the screen
670 contents everytime you hit "Print". 681 contents every time you hit "Print".
671 682
672 scrollBar: *boolean* 683 scrollBar: *boolean*
673 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
674 scrollbar; option +sb. 685 scrollbar; option +sb.
675 686
… …
690 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
691 702
692 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
693 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
694 scrollTtyOutput is False); option -sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
695 scrollback buffer when tty recieves new lines; option +sw. 706 scrollback buffer when tty receives new lines; option +sw.
696 707
697 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
698 True: scroll to bottom when a non-special key is pressed. Special 709 True: scroll to bottom when a non-special key is pressed. Special
699 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
700 handling and are not passed onto the shell; option -sk. False: do 711 handling and are not passed onto the shell; option -sk. False: do
… …
773 The string to send when the delete key (not the keypad delete key) 784 The string to send when the delete key (not the keypad delete key)
774 is pressed. If unset it will send the sequence traditionally 785 is pressed. If unset it will send the sequence traditionally
775 associated with the Execute key. 786 associated with the Execute key.
776 787
777 cutchars: *string* 788 cutchars: *string*
778 The characters used as delimiters for double-click word selection. 789 The characters used as delimiters for double-click word selection
779 The built-in default: 790 (whitespace delimiting is added automatically if resource is given).
791
792 When the selection extension is in use (the default if compiled in,
793 see the rxvtperl(3) manpage), a suitable regex using these
794 characters will be created (if the resource exists, otherwise, no
795 regex will be created). In this mode, characters outside ISO-8859-1
796 can be used.
797
798 When the selection extension is not used, only ISO-8859-1 characters
799 can be used. If not specified, the built-in default is used:
780 800
781 BACKSLASH `"'&()*,;<=>?@[]{|} 801 BACKSLASH `"'&()*,;<=>?@[]{|}
782 802
783 preeditType: *style* 803 preeditType: *style*
784 OverTheSpot, OffTheSpot, Root; option -pt. 804 OverTheSpot, OffTheSpot, Root; option -pt.
… …
794 814
795 imFont: *fontset* 815 imFont: *fontset*
796 Specify the font-set used for XIM styles "OverTheSpot" or 816 Specify the font-set used for XIM styles "OverTheSpot" or
797 "OffTheSpot". It must be a standard X font set (XLFD patterns 817 "OffTheSpot". It must be a standard X font set (XLFD patterns
798 separated by commas), i.e. it's not in the same format as the other 818 separated by commas), i.e. it's not in the same format as the other
799 font lists used in urxvt. The default will be set-up to chose *any* 819 font lists used in rxvt. The default will be set-up to chose *any*
800 suitable found found, preferably one or two pixels differing in size 820 suitable found found, preferably one or two pixels differing in size
801 to the base font. option -imfont. 821 to the base font. option -imfont.
802 822
803 tripleclickwords: *boolean* 823 tripleclickwords: *boolean*
804 Change the meaning of triple-click selection with the left mouse 824 Change the meaning of triple-click selection with the left mouse
… …
815 xterm, have these sequences enabled by default, which doesn't make 835 xterm, have these sequences enabled by default, which doesn't make
816 it safer, though). 836 it safer, though).
817 837
818 You can enable them by setting this boolean resource or specifying 838 You can enable them by setting this boolean resource or specifying
819 -insecure as an option. At the moment, this enables display-answer, 839 -insecure as an option. At the moment, this enables display-answer,
820 locale, findfont, icon label and window title requests as well as 840 locale, findfont, icon label and window title requests.
821 dynamic menubar dispatch.
822 841
823 modifier: *modifier* 842 modifier: *modifier*
824 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 843 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
825 super, mod1, mod2, mod3, mod4, mod5; option -mod. 844 super, mod1, mod2, mod3, mod4, mod5; option -mod.
826 845
827 answerbackString: *string* 846 answerbackString: *string*
828 Specify the reply rxvt-unicode sends to the shell when an ENQ 847 Specify the reply rxvt-unicode sends to the shell when an ENQ
829 (control-E) character is passed through. It may contain escape 848 (control-E) character is passed through. It may contain escape
830 values as described in the entry on keysym following. 849 values as described in the entry on keysym following.
831 850
832 secondaryScreen: *bool* 851 secondaryScreen: *boolean*
833 Turn on/off secondary screen (default enabled). 852 Turn on/off secondary screen (default enabled).
834 853
835 secondaryScroll: *bool* 854 secondaryScroll: *boolean*
836 Turn on/off secondary screen scroll (default enabled). If the this 855 Turn on/off secondary screen scroll (default enabled). If the this
837 option is enabled, scrolls on the secondary screen will change the 856 option is enabled, scrolls on the secondary screen will change the
838 scrollback buffer and switching to/from the secondary screen will 857 scrollback buffer and switching to/from the secondary screen will
839 instead scroll the screen up. 858 instead scroll the screen up.
840 859
841 hold: *bool* 860 hold: *boolean*
842 Turn on/off hold window after exit support. If enabled, urxvt will 861 Turn on/off hold window after exit support. If enabled, rxvt will
843 not immediately destroy its window when the program executed within 862 not immediately destroy its window when the program executed within
844 it exits. Instead, it will wait till it is being killed or closed by 863 it exits. Instead, it will wait till it is being killed or closed by
845 the user. 864 the user.
846 865
847 keysym.*sym*: *string* 866 keysym.*sym*: *string*
… …
867 886
868 *string* may contain escape values ("\a": bell, "\b": backspace, 887 *string* may contain escape values ("\a": bell, "\b": backspace,
869 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
870 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
871 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
872 it can start or end with whitespace. 891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
873 893
874 Please note that you need to double the "\" in resource files, as 894 Please note that you need to double the "\" in resource files, as
875 Xlib itself does it's own de-escaping (you can use "\033" instead of 895 Xlib itself does its own de-escaping (you can use "\033" instead of
876 "\e" (and so on), which will work with both Xt and urxvt's own 896 "\e" (and so on), which will work with both Xt and rxvt's own
877 processing). 897 processing).
878 898
879 You can define a range of keysyms in one shot by providing a 899 You can define a range of keysyms in one shot by providing a
880 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 900 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
881 `/' should be a character not used by the strings. 901 `/' should be a character not used by the strings.
882 902
883 Its usage can be demonstrated by an example: 903 Its usage can be demonstrated by an example:
884 904
885 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 905 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
889 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 909 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
890 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 910 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
891 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 911 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
892 912
893 If *string* takes the form of "command:STRING", the specified STRING 913 If *string* takes the form of "command:STRING", the specified STRING
894 is interpreted and executed as urxvt's control sequence. For example 914 is interpreted and executed as rxvt's control sequence. For example
895 the following means "change the current locale to "zh_CN.GBK" when 915 the following means "change the current locale to "zh_CN.GBK" when
896 Control-Meta-c is being pressed": 916 Control-Meta-c is being pressed":
897 917
898 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 918 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
899 919
900 If *string* takes the form "perl:STRING", then the specified STRING 920 If *string* takes the form "perl:STRING", then the specified STRING
901 is passed to the "on_keyboard_command" perl handler. See the 921 is passed to the "on_keyboard_command" perl handler. See the
902 urxvtperl(3) manpage. For example, the selection extension 922 rxvtperl(3) manpage. For example, the selection extension (activated
903 (activated via "urxvt -pe selection") listens for "selection:rot13" 923 via "rxvt -pe selection") listens for "selection:rot13" events:
904 events:
905 924
906 URxvt.keysym.M-C-c: perl:selection:rot13 925 URxvt.keysym.M-C-c: perl:selection:rot13
907 926
908 Due the the large number of modifier combinations, a defined key 927 Due the the large number of modifier combinations, a defined key
909 mapping will match if at *at least* the specified identifiers are 928 mapping will match if at *at least* the specified identifiers are
… …
911 being defined. That means that defining a key map for "a" will 930 being defined. That means that defining a key map for "a" will
912 automatically provide definitions for "Meta-a", "Shift-a" and so on, 931 automatically provide definitions for "Meta-a", "Shift-a" and so on,
913 unless some of those are defined mappings themselves. 932 unless some of those are defined mappings themselves.
914 933
915 Unfortunately, this will override built-in key mappings. For example 934 Unfortunately, this will override built-in key mappings. For example
916 if you overwrite the "Insert" key you will disable urxvt's 935 if you overwrite the "Insert" key you will disable rxvt's
917 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into 936 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
918 the user-defined keymap using the "builtin:" replacement: 937 the user-defined keymap using the "builtin:" replacement:
919 938
920 URxvt.keysym.Insert: <my insert key sequence> 939 URxvt.keysym.Insert: <my insert key sequence>
921 URxvt.keysym.S-Insert: builtin: 940 URxvt.keysym.S-Insert: builtin:
… …
929 font-switching at runtime: 948 font-switching at runtime:
930 949
931 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 950 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
932 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 951 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
933 952
934 Other things are possible, e.g. resizing (see urxvt(7) for more 953 Other things are possible, e.g. resizing (see rxvt(7) for more
935 info): 954 info):
936 955
937 URxvt.keysym.M-C-3: command:\033[8;25;80t 956 URxvt.keysym.M-C-3: command:\033[8;25;80t
938 URxvt.keysym.M-C-4: command:\033[8;48;110t 957 URxvt.keysym.M-C-4: command:\033[8;48;110t
939 958
… …
948 For example, "default,-selection" will use all the default extension 967 For example, "default,-selection" will use all the default extension
949 except "selection". 968 except "selection".
950 969
951 Extension names can also be followed by an argument in angle 970 Extension names can also be followed by an argument in angle
952 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey 971 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
953 for searchable scorllback to Alt/Meta-s). Mentioning the same 972 for searchable scrollback to Alt/Meta-s). Mentioning the same
954 extension multiple times with different arguments will pass multiple 973 extension multiple times with different arguments will pass multiple
955 arguments to the extension. 974 arguments to the extension.
956 975
957 Each extension is looked up in the library directories, loaded if 976 Each extension is looked up in the library directories, loaded if
958 necessary, and bound to the current terminal instance. 977 necessary, and bound to the current terminal instance.
… …
963 available to all instances, while perl-ext is used for specific 982 available to all instances, while perl-ext is used for specific
964 instances. 983 instances.
965 984
966 perl-eval: *string* 985 perl-eval: *string*
967 Perl code to be evaluated when all extensions have been registered. 986 Perl code to be evaluated when all extensions have been registered.
968 See the urxvtperl(3) manpage. Due to security reasons, this resource 987 See the rxvtperl(3) manpage. Due to security reasons, this resource
969 will be ignored when running setuid/setgid. 988 will be ignored when running setuid/setgid.
970 989
971 perl-lib: *path* 990 perl-lib: *path*
972 Colon-separated list of additional directories that hold extension 991 Colon-separated list of additional directories that hold extension
973 scripts. When looking for extensions specified by the "perl" 992 scripts. When looking for extensions specified by the "perl"
974 resource, urxvt will first look in these directories and then in 993 resource, rxvt will first look in these directories and then in
975 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource 994 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
976 will be ignored when running setuid/setgid. 995 will be ignored when running setuid/setgid.
977 996
978 See the urxvtperl(3) manpage. 997 See the rxvtperl(3) manpage.
979 998
980 selection.pattern-*idx*: *perl-regex* 999 selection.pattern-*idx*: *perl-regex*
981 Additional selection patterns, see the urxvtperl(3) manpage for 1000 Additional selection patterns, see the rxvtperl(3) manpage for
982 details. 1001 details.
983 1002
984 selection-autotransform.*idx*: *perl-transform* 1003 selection-autotransform.*idx*: *perl-transform*
985 Selection auto-transform patterns, see the urxvtperl(3) manpage for 1004 Selection auto-transform patterns, see the rxvtperl(3) manpage for
986 details. 1005 details.
987 1006
988 searchable-scrollback: *keysym* 1007 searchable-scrollback: *keysym*
989 Sets the hotkey that starts the incremental scrollback buffer search 1008 Sets the hotkey that starts the incremental scrollback buffer search
990 (default: "M-s"). 1009 (default: "M-s").
… …
992 urlLauncher: *string* 1011 urlLauncher: *string*
993 Specifies the program to be started with a URL argument. Used by the 1012 Specifies the program to be started with a URL argument. Used by the
994 "selection-popup" and "mark-urls" perl extensions. 1013 "selection-popup" and "mark-urls" perl extensions.
995 1014
996 transient-for: *windowid* 1015 transient-for: *windowid*
997 Sets the WM_TRANSIENT_FOR property to the given window iw. 1016 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1017 window id.
1018
1019 override-redirect: *boolean*
1020 Compile *frills*: Sets override-redirect for the terminal window,
1021 making it almost invisible to window managers; option
1022 -override-redirect.
998 1023
999THE SCROLLBAR 1024THE SCROLLBAR
1000 Lines of text that scroll off the top of the urxvt window (resource: 1025 Lines of text that scroll off the top of the rxvt window (resource:
1001 saveLines) and can be scrolled back using the scrollbar or by 1026 saveLines) and can be scrolled back using the scrollbar or by
1002 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is 1027 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1003 fairly intuitive. The xterm-scrollbar is without arrows and its 1028 fairly intuitive. The xterm-scrollbar is without arrows and its
1004 behaviour mimics that of *xterm* 1029 behaviour mimics that of *xterm*
1005 1030
1006 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with 1031 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
1007 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1032 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
… …
1034 normal one. In this mode, every selected row becomes its own line in 1059 normal one. In this mode, every selected row becomes its own line in
1035 the selection, and trailing whitespace is visually underlined and 1060 the selection, and trailing whitespace is visually underlined and
1036 removed from the selection. 1061 removed from the selection.
1037 1062
1038 Insertion: 1063 Insertion:
1039 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1064 Pressing and releasing the Middle mouse button in an rxvt window
1040 an urxvt window causes the current text selection to be inserted as 1065 causes the value of the PRIMARY selection (or CLIPBOARD with the
1041 if it had been typed on the keyboard. 1066 Meta modifier) to be inserted as if it had been typed on the
1067 keyboard.
1068
1069 Pressing Shift-Insert causes the value of the PRIMARY selection to
1070 be inserted too.
1042 1071
1043CHANGING FONTS 1072CHANGING FONTS
1044 Changing fonts (or font sizes, respectively) via the keypad is not yet 1073 Changing fonts (or font sizes, respectively) via the keypad is not yet
1045 supported in rxvt-unicode. Bug me if you need this. 1074 supported in rxvt-unicode. Bug me if you need this.
1046 1075
1047 You can, however, switch fonts at runtime using escape sequences (and 1076 You can, however, switch fonts at runtime using escape sequences, e.g.:
1048 therefore using the menubar), e.g.:
1049 1077
1050 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1078 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1079
1080 You can use keyboard shortcuts, too:
1081
1082 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1083 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1051 1084
1052 rxvt-unicode will automatically re-apply these fonts to the output so 1085 rxvt-unicode will automatically re-apply these fonts to the output so
1053 far. 1086 far.
1054 1087
1055ISO 14755 SUPPORT 1088ISO 14755 SUPPORT
… …
1079 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1080 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1081 1114
1082 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1083 them. The next special key (cursor keys, home etc.) you enter will 1116 them. The next special key (cursor keys, home etc.) you enter will
1084 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
1085 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1086 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1087 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1088 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1089 1122
… …
1110 1143
1111 With respect to conformance, rxvt-unicode is supposed to be compliant to 1144 With respect to conformance, rxvt-unicode is supposed to be compliant to
1112 both scenario A and B of ISO 14755, including part 5.2. 1145 both scenario A and B of ISO 14755, including part 5.2.
1113 1146
1114LOGIN STAMP 1147LOGIN STAMP
1115 urxvt tries to write an entry into the *utmp*(5) file so that it can be 1148 rxvt tries to write an entry into the *utmp*(5) file so that it can be
1116 seen via the *who(1)* command, and can accept messages. To allow this 1149 seen via the *who(1)* command, and can accept messages. To allow this
1117 feature, urxvt may need to be installed setuid root on some systems or 1150 feature, rxvt may need to be installed setuid root on some systems or
1118 setgid to root or to some other group on others. 1151 setgid to root or to some other group on others.
1119 1152
1120COLORS AND GRAPHICS 1153COLORS AND GRAPHICS
1121 In addition to the default foreground and background colours, urxvt can 1154 In addition to the default foreground and background colours, rxvt can
1122 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1155 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1123 versions of the same). Here is a list of the colours with their rgb.txt 1156 versions of the same). Here is a list of the colours with their names.
1124 names.
1125 1157
1126 color0 (black) = Black 1158 color0 (black) = Black
1127 color1 (red) = Red3 1159 color1 (red) = Red3
1128 color2 (green) = Green3 1160 color2 (green) = Green3
1129 color3 (yellow) = Yellow3 1161 color3 (yellow) = Yellow3
… …
1145 It is also possible to specify the colour values of foreground, 1177 It is also possible to specify the colour values of foreground,
1146 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1178 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1147 0-15, as a convenient shorthand to reference the colour name of 1179 0-15, as a convenient shorthand to reference the colour name of
1148 color0-color15. 1180 color0-color15.
1149 1181
1182 In addition to the colours defined above, rxvt offers an additional 72
1183 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
1185 by 8 additional shades of gray (with indices 80 to 87).
1186
1187 Together, all those colours implement the 88 colour xterm colours. Only
1188 the first 16 can be changed using resources currently, the rest can only
1189 be changed via command sequences ("escape codes").
1190
1150 Note that -rv ("reverseVideo: True") simulates reverse video by always 1191 Note that -rv ("reverseVideo: True") simulates reverse video by always
1151 swapping the foreground/background colours. This is in contrast to 1192 swapping the foreground/background colours. This is in contrast to
1152 *xterm*(1) where the colours are only swapped if they have not otherwise 1193 *xterm*(1) where the colours are only swapped if they have not otherwise
1153 been specified. For example, 1194 been specified. For example,
1154 1195
1155 urxvt -fg Black -bg White -rv 1196 rxvt -fg Black -bg White -rv
1156 would yield White on Black, while on *xterm*(1) it would yield Black 1197 would yield White on Black, while on *xterm*(1) it would yield Black
1157 on White. 1198 on White.
1158 1199
1200 ALPHA CHANNEL SUPPORT
1201 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
1203 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1204 digits/component) colour specifications, in addition to the ones
1205 provided by X, where the additional A component specifies opacity
1206 (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
1208 specifiying the opacity value.
1209
1210 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
1212 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1213
1214 For example, the following selects an almost completely transparent red
1215 background, and an almost opaque pink foreground:
1216
1217 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1218
1219 *Please note that transparency of any kind if completely unsupported by
1220 the author. Don't bug him with installation questions!*
1221
1159ENVIRONMENT 1222ENVIRONMENT
1160 urxvt sets and/or uses the following environment variables: 1223 rxvt sets and/or uses the following environment variables:
1161 1224
1162 TERM 1225 TERM
1163 Normally set to "rxvt-unicode", unless overwritten at configure 1226 Normally set to "rxvt-unicode", unless overwritten at configure
1164 time, via resources or on the commandline. 1227 time, via resources or on the command line.
1165 1228
1166 COLORTERM 1229 COLORTERM
1167 Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled 1230 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1168 with XPM support, and optionally with the added extension "-mono" to 1231 with XPM support, and optionally with the added extension "-mono" to
1169 indicate that rxvt-unicode runs on a monochrome screen. 1232 indicate that rxvt-unicode runs on a monochrome screen.
1170 1233
1171 COLORFGBG 1234 COLORFGBG
1172 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1235 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1173 the colour code used as default foreground/text colour (or the 1236 the colour code used as default foreground/text colour (or the
1174 string "default" to indicate that the default-colour escape sequence 1237 string "default" to indicate that the default-colour escape sequence
1175 is to be used), "bg" is the colour code used as default background 1238 is to be used), "bg" is the colour code used as default background
1176 colour (or the string "default"), and "xpm" is the string "default" 1239 colour (or the string "default"), and "xpm" is the string "default"
1177 if urxvt was compiled with XPM support. Libraries like "ncurses" and 1240 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1178 "slang" can (and do) use this information to optimize screen output. 1241 "slang" can (and do) use this information to optimize screen output.
1179 1242
1180 WINDOWID 1243 WINDOWID
1181 Set to the (decimal) X Window ID of the urxvt window (the toplevel 1244 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1182 window, which usually has subwindows for the scrollbar, the terminal 1245 window, which usually has subwindows for the scrollbar, the terminal
1183 window and so on). 1246 window and so on).
1184 1247
1185 TERMINFO 1248 TERMINFO
1186 Set to the terminfo directory iff urxvt was configured with 1249 Set to the terminfo directory iff rxvt was configured with
1187 "--with-terminfo=PATH". 1250 "--with-terminfo=PATH".
1188 1251
1189 DISPLAY 1252 DISPLAY
1190 Used by urxvt to connect to the display and set to the correct 1253 Used by rxvt to connect to the display and set to the correct
1191 display in it's child processes. 1254 display in its child processes.
1192 1255
1193 SHELL 1256 SHELL
1194 The shell to be used for command execution, defaults to "/bin/sh". 1257 The shell to be used for command execution, defaults to "/bin/sh".
1195 1258
1196 RXVTPATH
1197 The path where urxvt looks for support files such as menu and xpm
1198 files.
1199
1200 PATH
1201 Used in the same way as "RXVTPATH".
1202
1203 RXVT_SOCKET 1259 RXVT_SOCKET
1204 The unix domain socket path used by urxvtc(1) and urxvtd(1). 1260 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1205 1261
1206 Default $HOME/.rxvt-unicode-*<nodename*. 1262 Default $HOME/.rxvt-unicode-*<nodename*.
1207 1263
1208 HOME 1264 HOME
1209 Used to locate the default directory for the unix domain socket for 1265 Used to locate the default directory for the unix domain socket for
… …
1213 XAPPLRESDIR 1269 XAPPLRESDIR
1214 Directory where various X resource files are being located. 1270 Directory where various X resource files are being located.
1215 1271
1216 XENVIRONMENT 1272 XENVIRONMENT
1217 If set and accessible, gives the name of a X resource file to be 1273 If set and accessible, gives the name of a X resource file to be
1218 loaded by urxvt. 1274 loaded by rxvt.
1219 1275
1220FILES 1276FILES
1221 /usr/lib/X11/rgb.txt 1277 /usr/lib/X11/rgb.txt
1222 Color names. 1278 Color names.
1223 1279
1224SEE ALSO 1280SEE ALSO
1225 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), 1281 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1226 pty(4), tty(4), utmp(5) 1282 tty(4), utmp(5)
1227 1283
1228CURRENT PROJECT COORDINATOR 1284CURRENT PROJECT COORDINATOR
1229 Project Coordinator 1285 Project Coordinator
1230 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1286 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1231 1287
1232 <http://software.schmorp.de/#rxvt-unicode> 1288 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1233 1289
1234AUTHORS 1290AUTHORS
1235 John Bovey 1291 John Bovey
1236 University of Kent, 1992, wrote the original Xvt. 1292 University of Kent, 1992, wrote the original Xvt.
1237 1293
… …
1248 1304
1249 Oezguer Kesim <kesim@math.fu-berlin.de> 1305 Oezguer Kesim <kesim@math.fu-berlin.de>
1250 Project Coordinator (changes.txt 2.21a to 2.4.5) 1306 Project Coordinator (changes.txt 2.21a to 2.4.5)
1251 1307
1252 Geoff Wing <gcw@pobox.com> 1308 Geoff Wing <gcw@pobox.com>
1253 Rewrote screen display and text selection routines. Project 1309 Rewrote screen display and text selection routines.
1310
1254 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1311 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1255 1312
1256 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1313 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1257 Forked rxvt-unicode, rewrote most of the display code and internal 1314 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1258 character handling to store text in unicode, improve xterm 1315 perl extension, random hacks, numerous bugfixes and extensions.
1259 compatibility and apply numerous other bugfixes and extensions.
1260 1316
1261 Project Coordinator (Changes 1.0 -) 1317 Project Coordinator (Changes 1.0 -)
1262 1318
1319 Emanuele Giaquinta <e.giaquinta@glauco.it>
1320 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1321

Diff Legend

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