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.68 by root, Wed Aug 1 18:38:15 2007 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.3, 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.
… …
102 102
103 -ss|+ss 103 -ss|+ss
104 Turn on/off skip scrolling (allow multiple screens per refresh); 104 Turn on/off skip scrolling (allow multiple screens per refresh);
105 resource skipScroll. 105 resource skipScroll.
106 106
107 -ip|+ip | -tr|+tr 107 -tr|+tr
108 Turn on/off inheriting parent window's pixmap. Alternative form is 108 Turn on/off illusion of a transparent window background. Obsolete
109 -tr; resource inheritPixmap. 109 form of it is -ip and it should not be used anymore; resource
110 transparent.
110 111
111 *Please note that transparency of any kind if completely unsupported 112 *Please note that old resource name of inheritPixmap is obsolete and
112 by the author. Don't bug him with installation questions! Read the 113 should be changed to transparent. Backwards compatibility support
113 FAQ (man 7 rxvt)!* 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)!*
114 118
115 -fade *number* 119 -fade *number*
116 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
117 values fade a little only, 100 completely replaces all colours by 121 values fade a little only, 100 completely replaces all colours by
118 the fade colour; resource fading. 122 the fade colour; resource fading.
… …
121 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
122 colour is opaque black. resource fadeColor. 126 colour is opaque black. resource fadeColor.
123 127
124 -tint *colour* 128 -tint *colour*
125 Tint the transparent background pixmap with the given colour when 129 Tint the transparent background pixmap with the given colour when
126 transparency is enabled with -tr or -ip. This only works for 130 transparency is enabled with -tr. This only works for non-tiled
127 non-tiled backgrounds, currently. See also the -sh option that can 131 backgrounds, currently. See also the -sh option that can be used to
128 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
129 Please note that certain tint colours can be applied on the 133 that certain tint colours can be applied on the server-side, thus
130 server-side, thus yielding performance gain of two orders of 134 yielding performance gain of two orders of magnitude. These colours
131 magnitude. These colours are: blue, red, green, cyan, magenta, 135 are: blue, red, green, cyan, magenta, yellow, and those close to
132 yellow, and those close to them; resource *tintColor*. Example: 136 them; resource *tintColor*. Example:
133 137
134 rxvt -tr -tint blue -sh 40 138 urxvt -tr -tint blue -sh 40
135 139
136 -sh *number* 140 -sh *number*
137 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 141 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
138 image in addition to (or instead of) tinting it; resource *shading*. 142 image in addition to (or instead of) tinting it; resource *shading*.
139 143
… …
141 Specify background blending type. If background pixmap is specified 145 Specify background blending type. If background pixmap is specified
142 at the same time as transparency - such pixmap will be blended over 146 at the same time as transparency - such pixmap will be blended over
143 transparency image, using method specified. Supported values are : 147 transparency image, using method specified. Supported values are :
144 add, alphablend, allanon - color values averaging, colorize, darken, 148 add, alphablend, allanon - color values averaging, colorize, darken,
145 diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint, 149 diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
146 value. The default is alpha-blending; resource *blendType*. 150 value. The default is alpha-blending. Compile *afterimage*; resource
151 *blendType*.
147 152
148 -blr *HxV* 153 -blr *HxV*
149 Apply Gaussian Blur with the specified radii to the transparent 154 Apply Gaussian Blur with the specified radii to the transparent
150 background image. If single number is specified - both vertical and 155 background image. If single number is specified - both vertical and
151 horizontal radii are considered to be the same. Setting one of the 156 horizontal radii are considered to be the same. Setting one of the
152 radii to 1 and another to a large number creates interesting effects 157 radii to 1 and another to a large number creates interesting effects
153 on some backgrounds. Maximum radius value is 128; resource 158 on some backgrounds. Maximum radius value is 128. Compile
154 *blurRadius*. 159 *afterimage*; resource *blurRadius*.
155 160
156 -bg *colour* 161 -bg *colour*
157 Window background colour; resource background. 162 Window background colour; resource background.
158 163
159 -fg *colour* 164 -fg *colour*
… …
188 193
189 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
190 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
191 with "xft:", e.g.: 196 with "xft:", e.g.:
192 197
193 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 198 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
194 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 199 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
195 200
196 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
197 FAQ section of rxvt(7). 202 FAQ section of urxvt(7).
198 203
199 -fb *fontlist* 204 -fb *fontlist*
200 Compile *font-styles*: The bold font list to use when bold 205 Compile *font-styles*: The bold font list to use when bold
201 characters are to be printed. See resource boldFont for details. 206 characters are to be printed. See resource boldFont for details.
202 207
… …
297 block graphic glyphs; resource skipBuiltinGlyphs. 302 block graphic glyphs; resource skipBuiltinGlyphs.
298 303
299 -lsp *number* 304 -lsp *number*
300 Compile *frills*: Lines (pixel height) to insert between each row of 305 Compile *frills*: Lines (pixel height) to insert between each row of
301 the display. Useful to work around font rendering problems; resource 306 the display. Useful to work around font rendering problems; resource
302 linespace. 307 lineSpace.
303 308
304 -tn *termname* 309 -tn *termname*
305 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
306 TERM environment variable. This terminal type must exist in the 311 TERM environment variable. This terminal type must exist in the
307 *termcap(5)* database and should have *li#* and *co#* entries; 312 *termcap(5)* database and should have *li#* and *co#* entries;
308 resource termName. 313 resource termName.
309 314
310 -e *command [arguments]* 315 -e *command [arguments]*
311 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;
312 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
313 program being executed if neither *-title* (*-T*) nor *-n* are given 318 program being executed if neither *-title* (*-T*) nor *-n* are given
314 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
315 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
316 run the program specified by the SHELL environment variable or, 321 run the program specified by the SHELL environment variable or,
… …
318 323
319 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
320 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
321 this: 326 this:
322 327
323 rxvt -e sh -c "shell commands" 328 urxvt -e sh -c "shell commands"
324 329
325 -title *text* 330 -title *text*
326 Window title (-T still respected); the default title is the basename 331 Window title (-T still respected); the default title is the basename
327 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
328 application name; resource title. 333 application name; resource title.
… …
374 -ssr|+ssr 379 -ssr|+ssr
375 Turn on/off secondary screen scroll (default enabled); resource 380 Turn on/off secondary screen scroll (default enabled); resource
376 secondaryScroll. 381 secondaryScroll.
377 382
378 -hold|+hold 383 -hold|+hold
379 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
380 not immediately destroy its window when the program executed within 385 not immediately destroy its window when the program executed within
381 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
382 the user; resource hold. 387 the user; resource hold.
383 388
384 -keysym.*sym* *string* 389 -keysym.*sym* *string*
385 Remap a key symbol. See resource keysym. 390 Remap a key symbol. See resource keysym.
386 391
387 -embed *windowid* 392 -embed *windowid*
388 Tells rxvt to embed its windows into an already-existing window, 393 Tells urxvt to embed its windows into an already-existing window,
389 which enables applications to easily embed a terminal. 394 which enables applications to easily embed a terminal.
390 395
391 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
392 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
393 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
394 create an extra subwindow for rxvt and leave it alone. 399 best to create an extra subwindow for urxvt and leave it alone.
395 400
396 The window will not be destroyed when rxvt exits. 401 The window will not be destroyed when urxvt exits.
397 402
398 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
399 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
400 file descriptors to communicate with the programs within the 405 you can use file descriptors to communicate with the programs within
401 terminal. This works regardless of whether the "-embed" option was 406 the terminal. This works regardless of whether the "-embed" option
402 used or not. 407 was used or not.
403 408
404 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
405 can be used (a longer example is in doc/embed): 410 can be used (a longer example is in doc/embed):
406 411
407 my $rxvt = new Gtk2::Socket; 412 my $rxvt = new Gtk2::Socket;
408 $rxvt->signal_connect_after (realize => sub { 413 $rxvt->signal_connect_after (realize => sub {
409 my $xid = $_[0]->window->get_xid; 414 my $xid = $_[0]->window->get_xid;
410 system "rxvt -embed $xid &"; 415 system "urxvt -embed $xid &";
411 }); 416 });
412 417
413 -pty-fd *file descriptor* 418 -pty-fd *file descriptor*
414 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
415 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
416 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
417 without having to run a program within it. 422 without having to run a program within it.
418 423
419 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
420 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
421 yourself if you want that. 426 yourself if you want that.
422 427
423 As an extremely special case, specifying -1 will completely suppress 428 As an extremely special case, specifying -1 will completely suppress
424 pty/tty operations. 429 pty/tty operations.
… …
429 use IO::Pty; 434 use IO::Pty;
430 use Fcntl; 435 use Fcntl;
431 436
432 my $pty = new IO::Pty; 437 my $pty = new IO::Pty;
433 fcntl $pty, F_SETFD, 0; # clear close-on-exec 438 fcntl $pty, F_SETFD, 0; # clear close-on-exec
434 system "rxvt -pty-fd " . (fileno $pty) . "&"; 439 system "urxvt -pty-fd " . (fileno $pty) . "&";
435 close $pty; 440 close $pty;
436 441
437 # now communicate with rxvt 442 # now communicate with rxvt
438 my $slave = $pty->slave; 443 my $slave = $pty->slave;
439 while (<$slave>) { print $slave "got <$_>\n" } 444 while (<$slave>) { print $slave "got <$_>\n" }
… …
441 -pe *string* 446 -pe *string*
442 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
443 use) in this terminal instance. See resource perl-ext for details. 448 use) in this terminal instance. See resource perl-ext for details.
444 449
445RESOURCES (available also as long-options) 450RESOURCES (available also as long-options)
446 Note: `rxvt --help' gives a list of all resources (long options) 451 Note: `urxvt --help' gives a list of all resources (long options)
447 compiled into your version. 452 compiled into your version.
448 453
449 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
450 distribution do also load settings from the ~/.Xresources file when X 455 distribution do also load settings from the ~/.Xresources file when X
451 starts. rxvt will consult the following files/resources in order, with 456 starts. urxvt will consult the following files/resources in order, with
452 later settings overwriting earlier ones: 457 later settings overwriting earlier ones:
453 458
454 1. system-wide app-defaults file, either locale-dependent OR global 459 1. system-wide app-defaults file, either locale-dependent OR global
455 2. app-defaults file in $XAPPLRESDIR 460 2. app-defaults file in $XAPPLRESDIR
456 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 461 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
457 4. SCREEN_RESOURCES for the current screen 462 4. SCREEN_RESOURCES for the current screen
458 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 463 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
459 464
460 Note that when reading X resources, rxvt recognizes two class names: 465 Note that when reading X resources, urxvt recognizes two class names:
461 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
462 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
463 URxvt allows resources unique to rxvt, to be shared between different 468 name URxvt allows resources unique to urxvt, to be shared between
464 rxvt configurations. If no resources are specified, suitable defaults 469 different urxvt configurations. If no resources are specified, suitable
465 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
466 settings. The following resources are supported (you might want to check 471 resource settings. The following resources are supported (you might want
467 the rxvtperl(3) manpage for additional settings by perl extensions not 472 to check the urxvtperl(3) manpage for additional settings by perl
468 documented here): 473 extensions not documented here):
469 474
470 depth: *bitdepth* 475 depth: *bitdepth*
471 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;
472 option -depth. 477 option -depth.
473 478
… …
491 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
492 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
493 section. 498 section.
494 499
495 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
496 be changed using an escape command (see rxvt(7)). 501 be changed using an escape command (see urxvt(7)).
497 502
498 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
499 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.
500 505
501 colorBD: *colour* 506 colorBD: *colour*
… …
531 option -rv. False: regular screen colours [default]; option +rv. See 536 option -rv. False: regular screen colours [default]; option +rv. See
532 note in COLORS AND GRAPHICS section. 537 note in COLORS AND GRAPHICS section.
533 538
534 jumpScroll: *boolean* 539 jumpScroll: *boolean*
535 True: specify that jump scrolling should be used. When receiving 540 True: specify that jump scrolling should be used. When receiving
536 lots of lines, rxvt will only scroll once a whole screen height of 541 lots of lines, urxvt will only scroll once a whole screen height of
537 lines has been read, resulting in fewer updates while still 542 lines has been read, resulting in fewer updates while still
538 displaying every received line; option -j. 543 displaying every received line; option -j.
539 544
540 False: specify that smooth scrolling should be used. rxvt will force 545 False: specify that smooth scrolling should be used. urxvt will
541 a screen refresh on each new line it received; option +j. 546 force a screen refresh on each new line it received; option +j.
542 547
543 skipScroll: *boolean* 548 skipScroll: *boolean*
544 True: (the default) specify that skip scrolling should be used. When 549 True: (the default) specify that skip scrolling should be used. When
545 receiving lots of lines, rxvt will only scroll once in a while 550 receiving lots of lines, urxvt will only scroll once in a while
546 (around 60 times per second), resulting in far fewer updates. This 551 (around 60 times per second), resulting in far fewer updates. This
547 can result in rxvt not ever displaying some of the lines it 552 can result in urxvt not ever displaying some of the lines it
548 receives; option -ss. 553 receives; option -ss.
549 554
550 False: specify that everything is to be displayed, even if the 555 False: specify that everything is to be displayed, even if the
551 refresh is too fast for the human eye to read anything (or the 556 refresh is too fast for the human eye to read anything (or the
552 monitor to display anything); option +ss. 557 monitor to display anything); option +ss.
… …
607 specified pixmap will be blended over transparency image using 612 specified pixmap will be blended over transparency image using
608 either alpha-blending, or any other blending type, specified with 613 either alpha-blending, or any other blending type, specified with
609 -blt "type" option. [default 0x0+50+50] 614 -blt "type" option. [default 0x0+50+50]
610 615
611 path: *path* 616 path: *path*
612 Specify the colon-delimited search path for finding XPM files. 617 Specify the colon-delimited search path for finding background image
618 files.
613 619
614 font: *fontlist* 620 font: *fontlist*
615 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
616 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
617 characters. The first font defines the cell size for characters; 623 characters. The first font defines the cell size for characters;
… …
792 798
793 termName: *termname* 799 termName: *termname*
794 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
795 variable; option -tn. 801 variable; option -tn.
796 802
797 linespace: *number* 803 lineSpace: *number*
798 Specifies number of lines (pixel height) to insert between each row 804 Specifies number of lines (pixel height) to insert between each row
799 of the display [default 0]; option -lsp. 805 of the display [default 0]; option -lsp.
800 806
801 meta8: *boolean* 807 meta8: *boolean*
802 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
… …
844 cutchars: *string* 850 cutchars: *string*
845 The characters used as delimiters for double-click word selection 851 The characters used as delimiters for double-click word selection
846 (whitespace delimiting is added automatically if resource is given). 852 (whitespace delimiting is added automatically if resource is given).
847 853
848 When the perl selection extension is in use (the default if compiled 854 When the perl selection extension is in use (the default if compiled
849 in, see the rxvtperl(3) manpage), a suitable regex using these 855 in, see the urxvtperl(3) manpage), a suitable regex using these
850 characters will be created (if the resource exists, otherwise, no 856 characters will be created (if the resource exists, otherwise, no
851 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
852 can be used. 858 can be used.
853 859
854 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
… …
870 876
871 imFont: *fontset* 877 imFont: *fontset*
872 Specify the font-set used for XIM styles "OverTheSpot" or 878 Specify the font-set used for XIM styles "OverTheSpot" or
873 "OffTheSpot". It must be a standard X font set (XLFD patterns 879 "OffTheSpot". It must be a standard X font set (XLFD patterns
874 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
875 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*
876 suitable found found, preferably one or two pixels differing in size 882 suitable found found, preferably one or two pixels differing in size
877 to the base font. option -imfont. 883 to the base font. option -imfont.
878 884
879 tripleclickwords: *boolean* 885 tripleclickwords: *boolean*
880 Change the meaning of triple-click selection with the left mouse 886 Change the meaning of triple-click selection with the left mouse
… …
912 option is enabled, scrolls on the secondary screen will change the 918 option is enabled, scrolls on the secondary screen will change the
913 scrollback buffer and switching to/from the secondary screen will 919 scrollback buffer and switching to/from the secondary screen will
914 instead scroll the screen up. 920 instead scroll the screen up.
915 921
916 hold: *boolean* 922 hold: *boolean*
917 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
918 not immediately destroy its window when the program executed within 924 not immediately destroy its window when the program executed within
919 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
920 the user. 926 the user.
921 927
922 keysym.*sym*: *string* 928 keysym.*sym*: *string*
… …
938 omitting the prefix XK_. Alternatively you can specify *key* by its 944 omitting the prefix XK_. Alternatively you can specify *key* by its
939 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
940 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
941 assured. 947 assured.
942 948
943 *string* may contain escape values ("\a": bell, "\b": backspace, 949 *string* may contain escape values ("\n": newline, "\000": octal
944 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 950 number), see RESOURCES in "man 7 X" for futher details.
945 "\000": octal number) or verbatim control characters ("^?": delete,
946 "^@": null, "^A" ...) and may be enclosed with double quotes so that
947 it can start or end with whitespace. This feature is deprecated and
948 will be removed.
949
950 Please note that you need to double the "\" in resource files, as
951 Xlib itself does its own de-escaping (you can use "\033" instead of
952 "\e" (and so on), which will work with both Xt and rxvt's own
953 processing).
954 951
955 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
956 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter 953 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
957 `/' should be a character not used by the strings. 954 `/' should be a character not used by the strings.
958 955
… …
965 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 962 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
966 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 963 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
967 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 964 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
968 965
969 If *string* takes the form of "command:STRING", the specified STRING 966 If *string* takes the form of "command:STRING", the specified STRING
970 is interpreted and executed as rxvt's control sequence. For example 967 is interpreted and executed as urxvt's control sequence. For example
971 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
972 Control-Meta-c is being pressed": 969 Control-Meta-c is being pressed":
973 970
974 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
975 972
976 If *string* takes the form "perl:STRING", then the specified STRING 973 If *string* takes the form "perl:STRING", then the specified STRING
977 is passed to the "on_keyboard_command" perl handler. See the 974 is passed to the "on_keyboard_command" perl handler. See the
978 rxvtperl(3) manpage. For example, the selection extension (activated 975 urxvtperl(3) manpage. For example, the selection extension
979 via "rxvt -pe selection") listens for "selection:rot13" events: 976 (activated via "urxvt -pe selection") listens for "selection:rot13"
977 events:
980 978
981 URxvt.keysym.M-C-c: perl:selection:rot13 979 URxvt.keysym.M-C-c: perl:selection:rot13
982 980
983 Due the the large number of modifier combinations, a defined key 981 Due the the large number of modifier combinations, a defined key
984 mapping will match if at *at least* the specified identifiers are 982 mapping will match if at *at least* the specified identifiers are
… …
986 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
987 automatically provide definitions for "Meta-a", "Shift-a" and so on, 985 automatically provide definitions for "Meta-a", "Shift-a" and so on,
988 unless some of those are defined mappings themselves. 986 unless some of those are defined mappings themselves.
989 987
990 Unfortunately, this will override built-in key mappings. For example 988 Unfortunately, this will override built-in key mappings. For example
991 if you overwrite the "Insert" key you will disable rxvt's 989 if you overwrite the "Insert" key you will disable urxvt's
992 "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
993 the user-defined keymap using the "builtin:" replacement: 991 the user-defined keymap using the "builtin:" replacement:
994 992
995 URxvt.keysym.Insert: <my insert key sequence> 993 URxvt.keysym.Insert: <my insert key sequence>
996 URxvt.keysym.S-Insert: builtin: 994 URxvt.keysym.S-Insert: builtin:
… …
1004 font-switching at runtime: 1002 font-switching at runtime:
1005 1003
1006 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1004 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1007 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1005 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1008 1006
1009 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
1010 info): 1008 info):
1011 1009
1012 URxvt.keysym.M-C-3: command:\033[8;25;80t 1010 URxvt.keysym.M-C-3: command:\033[8;25;80t
1013 URxvt.keysym.M-C-4: command:\033[8;48;110t 1011 URxvt.keysym.M-C-4: command:\033[8;48;110t
1014 1012
… …
1038 available to all instances, while perl-ext is used for specific 1036 available to all instances, while perl-ext is used for specific
1039 instances. 1037 instances.
1040 1038
1041 perl-eval: *string* 1039 perl-eval: *string*
1042 Perl code to be evaluated when all extensions have been registered. 1040 Perl code to be evaluated when all extensions have been registered.
1043 See the rxvtperl(3) manpage. Due to security reasons, this resource 1041 See the urxvtperl(3) manpage. Due to security reasons, this resource
1044 will be ignored when running setuid/setgid. 1042 will be ignored when running setuid/setgid.
1045 1043
1046 perl-lib: *path* 1044 perl-lib: *path*
1047 Colon-separated list of additional directories that hold extension 1045 Colon-separated list of additional directories that hold extension
1048 scripts. When looking for extensions specified by the "perl" 1046 scripts. When looking for extensions specified by the "perl"
1049 resource, rxvt will first look in these directories and then in 1047 resource, urxvt will first look in these directories and then in
1050 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource 1048 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource
1051 will be ignored when running setuid/setgid. 1049 will be ignored when running setuid/setgid.
1052 1050
1053 See the rxvtperl(3) manpage. 1051 See the urxvtperl(3) manpage.
1054 1052
1055 selection.pattern-*idx*: *perl-regex* 1053 selection.pattern-*idx*: *perl-regex*
1056 Additional selection patterns, see the rxvtperl(3) manpage for 1054 Additional selection patterns, see the urxvtperl(3) manpage for
1057 details. 1055 details.
1058 1056
1059 selection-autotransform.*idx*: *perl-transform* 1057 selection-autotransform.*idx*: *perl-transform*
1060 Selection auto-transform patterns, see the rxvtperl(3) manpage for 1058 Selection auto-transform patterns, see the urxvtperl(3) manpage for
1061 details. 1059 details.
1062 1060
1063 searchable-scrollback: *keysym* 1061 searchable-scrollback: *keysym*
1064 Sets the hotkey that starts the incremental scrollback buffer search 1062 Sets the hotkey that starts the incremental scrollback buffer search
1065 (default: "M-s"). 1063 (default: "M-s").
… …
1079 1077
1080 iso14755_52: *boolean* 1078 iso14755_52: *boolean*
1081 Turn on/off ISO 14755 5.2 mode (default enabled). 1079 Turn on/off ISO 14755 5.2 mode (default enabled).
1082 1080
1083THE SCROLLBAR 1081THE SCROLLBAR
1084 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:
1085 saveLines) and can be scrolled back using the scrollbar or by 1083 saveLines) and can be scrolled back using the scrollbar or by
1086 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1084 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
1087 fairly intuitive. The xterm-scrollbar is without arrows and its 1085 fairly intuitive. The xterm-scrollbar is without arrows and its
1088 behaviour mimics that of *xterm* 1086 behaviour mimics that of *xterm*
1089 1087
1090 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
1091 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1089 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
… …
1118 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
1119 the selection, and trailing whitespace is visually underlined and 1117 the selection, and trailing whitespace is visually underlined and
1120 removed from the selection. 1118 removed from the selection.
1121 1119
1122 Pasting: 1120 Pasting:
1123 Pressing and releasing the Middle mouse button in an rxvt window 1121 Pressing and releasing the Middle mouse button in an urxvt window
1124 causes the value of the PRIMARY selection (or CLIPBOARD with the 1122 causes the value of the PRIMARY selection (or CLIPBOARD with the
1125 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
1126 keyboard. 1124 keyboard.
1127 1125
1128 Pressing Shift-Insert causes the value of the PRIMARY selection to 1126 Pressing Shift-Insert causes the value of the PRIMARY selection to
… …
1202 1200
1203 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
1204 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.
1205 1203
1206LOGIN STAMP 1204LOGIN STAMP
1207 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
1208 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
1209 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
1210 setgid to root or to some other group on others. 1208 setgid to root or to some other group on others.
1211 1209
1212COLORS AND GRAPHICS 1210COLORS AND GRAPHICS
1213 In addition to the default foreground and background colours, rxvt can 1211 In addition to the default foreground and background colours, urxvt can
1214 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
1215 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.
1216 1214
1217 color0 (black) = Black 1215 color0 (black) = Black
1218 color1 (red) = Red3 1216 color1 (red) = Red3
… …
1236 It is also possible to specify the colour values of foreground, 1234 It is also possible to specify the colour values of foreground,
1237 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1235 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1238 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
1239 color0-color15. 1237 color0-color15.
1240 1238
1241 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
1242 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
1243 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
1244 by 8 additional shades of gray (with indices 80 to 87). 1242 by 8 additional shades of gray (with indices 80 to 87).
1245 1243
1246 Together, all those colours implement the 88 colour xterm colours. Only 1244 Together, all those colours implement the 88 colour xterm colours. Only
… …
1250 Note that -rv ("reverseVideo: True") simulates reverse video by always 1248 Note that -rv ("reverseVideo: True") simulates reverse video by always
1251 swapping the foreground/background colours. This is in contrast to 1249 swapping the foreground/background colours. This is in contrast to
1252 *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
1253 been specified. For example, 1251 been specified. For example,
1254 1252
1255 rxvt -fg Black -bg White -rv 1253 urxvt -fg Black -bg White -rv
1256 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
1257 on White. 1255 on White.
1258 1256
1259 ALPHA CHANNEL SUPPORT 1257 ALPHA CHANNEL SUPPORT
1260 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
… …
1272 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.
1273 1271
1274 For example, the following selects an almost completely transparent red 1272 For example, the following selects an almost completely transparent red
1275 background, and an almost opaque pink foreground: 1273 background, and an almost opaque pink foreground:
1276 1274
1277 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1275 urxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1278 1276
1279 *Please note that transparency of any kind if completely unsupported by 1277 *Please note that transparency of any kind if completely unsupported by
1280 the author. Don't bug him with installation questions!* 1278 the author. Don't bug him with installation questions!*
1281 1279
1282ENVIRONMENT 1280ENVIRONMENT
1283 rxvt sets and/or uses the following environment variables: 1281 urxvt sets and/or uses the following environment variables:
1284 1282
1285 TERM 1283 TERM
1286 Normally set to "rxvt-unicode", unless overwritten at configure 1284 Normally set to "rxvt-unicode", unless overwritten at configure
1287 time, via resources or on the command line. 1285 time, via resources or on the command line.
1288 1286
1289 COLORTERM 1287 COLORTERM
1290 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled 1288 Either "rxvt", "rxvt-xpm", depending on whether urxvt was compiled
1291 with XPM support, and optionally with the added extension "-mono" to 1289 with background image support, and optionally with the added
1292 indicate that rxvt-unicode runs on a monochrome screen. 1290 extension "-mono" to indicate that rxvt-unicode runs on a monochrome
1291 screen.
1293 1292
1294 COLORFGBG 1293 COLORFGBG
1295 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
1296 the colour code used as default foreground/text colour (or the 1295 the colour code used as default foreground/text colour (or the
1297 string "default" to indicate that the default-colour escape sequence 1296 string "default" to indicate that the default-colour escape sequence
1298 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
1299 colour (or the string "default"), and "xpm" is the string "default" 1298 colour (or the string "default"), and "xpm" is the string "default"
1300 if rxvt was compiled with XPM support. Libraries like "ncurses" and 1299 if urxvt was compiled with background image support. Libraries like
1301 "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.
1302 1302
1303 WINDOWID 1303 WINDOWID
1304 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
1305 window, which usually has subwindows for the scrollbar, the terminal 1305 window, which usually has subwindows for the scrollbar, the terminal
1306 window and so on). 1306 window and so on).
1307 1307
1308 TERMINFO 1308 TERMINFO
1309 Set to the terminfo directory iff rxvt was configured with 1309 Set to the terminfo directory iff urxvt was configured with
1310 "--with-terminfo=PATH". 1310 "--with-terminfo=PATH".
1311 1311
1312 DISPLAY 1312 DISPLAY
1313 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
1314 display in its child processes. 1314 display in its child processes.
1315 1315
1316 SHELL 1316 SHELL
1317 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".
1318 1318
1319 RXVT_SOCKET 1319 RXVT_SOCKET
1320 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).
1321 1321
1322 Default $HOME/.rxvt-unicode-*<nodename*. 1322 Default $HOME/.rxvt-unicode-*<nodename*.
1323 1323
1324 HOME 1324 HOME
1325 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
… …
1329 XAPPLRESDIR 1329 XAPPLRESDIR
1330 Directory where various X resource files are being located. 1330 Directory where various X resource files are being located.
1331 1331
1332 XENVIRONMENT 1332 XENVIRONMENT
1333 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
1334 loaded by rxvt. 1334 loaded by urxvt.
1335 1335
1336FILES 1336FILES
1337 /usr/lib/X11/rgb.txt 1337 /usr/lib/X11/rgb.txt
1338 Color names. 1338 Color names.
1339 1339
1340SEE ALSO 1340SEE ALSO
1341 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),
1342 tty(4), utmp(5) 1342 pty(4), tty(4), utmp(5)
1343 1343
1344CURRENT PROJECT COORDINATOR 1344CURRENT PROJECT COORDINATOR
1345 Project Coordinator 1345 Project Coordinator
1346 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1346 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1347 1347

Diff Legend

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