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.60 by root, Thu Jul 6 19:43:21 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 7.7, 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/*checkout*/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
… …
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 less bugs 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) easier 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!*
101 108
102 -fade *number* 109 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 110 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 111 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 112 the fade colour; resource fading.
106 113
107 -fadecolor *colour* 114 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 115 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 116 colour is opaque black. resource fadeColor.
110 117
111 -tint *colour* 118 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 119 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 120 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 121 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; 122 be used to brighten or darken the image in addition to tinting it;
116 resource *tintColor*. Example: 123 resource *tintColor*. Example:
117 124
118 urxvt -tr -tint blue -sh 40 125 rxvt -tr -tint blue -sh 40
119 126
120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 127 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
121 background image in addition to tinting it (i.e. -tint must be 128 background image in addition to tinting it (i.e. -tint must be
122 specified, too, e.g. "-tint white"). 129 specified, too, e.g. "-tint white").
123 130
… …
152 characters. The first font defines the cell size for characters; 159 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 160 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 161 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 162 See resource font for more details.
156 163
157 In short, to specify an X11 core font, just specify it's name or 164 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 165 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 166 with "xft:", e.g.:
160 167
161 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 168 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 169 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 170
164 See also the question "How does rxvt-unicode choose fonts?" in the 171 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of urxvt(7). 172 FAQ section of rxvt(7).
166 173
167 -fb *fontlist* 174 -fb *fontlist*
168 Compile *font-styles*: The bold font list to use when bold 175 Compile *font-styles*: The bold font list to use when bold
169 characters are to be printed. See resource boldFont for details. 176 characters are to be printed. See resource boldFont for details.
170 177
… …
252 259
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 260 -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 261 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 262 decorations; resource borderLess.
256 263
264 -override-redirect
265 Compile *frills*: Sets override-redirect on the window; resource
266 override-redirect.
267
257 -sbg 268 -sbg
258 Compile *frills*: Disable the usage of the built-in block 269 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 270 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 271 fonts provide. Use this if you have a good font and want to use its
261 block graphic glyphs; resource skipBuiltinGlyphs. 272 block graphic glyphs; resource skipBuiltinGlyphs.
… …
270 TERM environment variable. This terminal type must exist in the 281 TERM environment variable. This terminal type must exist in the
271 *termcap(5)* database and should have *li#* and *co#* entries; 282 *termcap(5)* database and should have *li#* and *co#* entries;
272 resource termName. 283 resource termName.
273 284
274 -e *command [arguments]* 285 -e *command [arguments]*
275 Run the command with its command-line arguments in the urxvt window; 286 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 287 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 288 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 289 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 290 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, 291 run the program specified by the SHELL environment variable or,
… …
282 293
283 Please note that you must specify a program with arguments. If you 294 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 295 want to run shell commands, you have to specify the shell, like
285 this: 296 this:
286 297
287 urxvt -e sh -c "shell commands" 298 rxvt -e sh -c "shell commands"
288 299
289 -title *text* 300 -title *text*
290 Window title (-T still respected); the default title is the basename 301 Window title (-T still respected); the default title is the basename
291 of the program specified after the -e option, if any, otherwise the 302 of the program specified after the -e option, if any, otherwise the
292 application name; resource title. 303 application name; resource title.
… …
337 -ssr|+ssr 348 -ssr|+ssr
338 Turn on/off secondary screen scroll (default enabled); resource 349 Turn on/off secondary screen scroll (default enabled); resource
339 secondaryScroll. 350 secondaryScroll.
340 351
341 -hold|+hold 352 -hold|+hold
342 Turn on/off hold window after exit support. If enabled, urxvt will 353 Turn on/off hold window after exit support. If enabled, rxvt will
343 not immediately destroy its window when the program executed within 354 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 355 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold. 356 the user; resource hold.
346 357
347 -keysym.*sym* *string* 358 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym. 359 Remap a key symbol. See resource keysym.
349 360
350 -embed *windowid* 361 -embed *windowid*
351 Tells urxvt to embed it's windows into an already-existing window, 362 Tells rxvt to embed its windows into an already-existing window,
352 which enables applications to easily embed a terminal. 363 which enables applications to easily embed a terminal.
353 364
354 Right now, urxvt will first unmap/map the specified window, so it 365 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 366 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 367 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. 368 create an extra subwindow for rxvt and leave it alone.
358 369
359 The window will not be destroyed when urxvt exits. 370 The window will not be destroyed when rxvt exits.
360 371
361 It might be useful to know that urxvt will not close file 372 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 373 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 374 file descriptors to communicate with the programs within the
364 the terminal. This works regardless of wether the "-embed" option 375 terminal. This works regardless of wether the "-embed" option was
365 was used or not. 376 used or not.
366 377
367 Here is a short Gtk2-perl snippet that illustrates how this option 378 Here is a short Gtk2-perl snippet that illustrates how this option
368 can be used (a longer example is in doc/embed): 379 can be used (a longer example is in doc/embed):
369 380
370 my $rxvt = new Gtk2::Socket; 381 my $rxvt = new Gtk2::Socket;
371 $rxvt->signal_connect_after (realize => sub { 382 $rxvt->signal_connect_after (realize => sub {
372 my $xid = $_[0]->window->get_xid; 383 my $xid = $_[0]->window->get_xid;
373 system "urxvt -embed $xid &"; 384 system "rxvt -embed $xid &";
374 }); 385 });
375 386
376 -pty-fd *file descriptor* 387 -pty-fd *file descriptor*
377 Tells urxvt NOT to execute any commands or create a new pty/tty pair 388 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 389 but instead use the given filehandle as the tty master. This is
379 useful if you want to drive urxvt as a generic terminal emulator 390 useful if you want to drive rxvt as a generic terminal emulator
380 without having to run a program within it. 391 without having to run a program within it.
381 392
382 If this switch is given, urxvt will not create any utmp/wtmp entries 393 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 394 and will not tinker with pty/tty permissions - you have to do that
384 yourself if you want that. 395 yourself if you want that.
385 396
386 As an extremely special case, specifying -1 will completely suppress 397 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations. 398 pty/tty operations.
… …
392 use IO::Pty; 403 use IO::Pty;
393 use Fcntl; 404 use Fcntl;
394 405
395 my $pty = new IO::Pty; 406 my $pty = new IO::Pty;
396 fcntl $pty, F_SETFD, 0; # clear close-on-exec 407 fcntl $pty, F_SETFD, 0; # clear close-on-exec
397 system "urxvt -pty-fd " . (fileno $pty) . "&"; 408 system "rxvt -pty-fd " . (fileno $pty) . "&";
398 close $pty; 409 close $pty;
399 410
400 # now communicate with rxvt 411 # now communicate with rxvt
401 my $slave = $pty->slave; 412 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" } 413 while (<$slave>) { print $slave "got <$_>\n" }
… …
404 -pe *string* 415 -pe *string*
405 Comma-separated list of perl extension scripts to use (or not to 416 Comma-separated list of perl extension scripts to use (or not to
406 use) in this terminal instance. See resource perl-ext for details. 417 use) in this terminal instance. See resource perl-ext for details.
407 418
408RESOURCES (available also as long-options) 419RESOURCES (available also as long-options)
409 Note: `urxvt --help' gives a list of all resources (long options) 420 Note: `rxvt --help' gives a list of all resources (long options)
410 compiled into your version. 421 compiled into your version.
411 422
412 You can set and change the resources using X11 tools like xrdb. Many 423 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 424 distribution do also load settings from the ~/.Xresources file when X
414 starts. urxvt will consult the following files/resources in order, with 425 starts. rxvt will consult the following files/resources in order, with
415 later settings overwriting earlier ones: 426 later settings overwriting earlier ones:
416 427
417 1. system-wide app-defaults file, either locale-dependent OR global 428 1. system-wide app-defaults file, either locale-dependent OR global
418 2. app-defaults file in $XAPPLRESDIR 429 2. app-defaults file in $XAPPLRESDIR
419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 430 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
420 4. SCREEN_RESOURCES for the current screen 431 4. SCREEN_RESOURCES for the current screen
421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 432 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
422 433
423 Note that when reading X resources, urxvt recognizes two class names: 434 Note that when reading X resources, rxvt recognizes two class names:
424 Rxvt and URxvt. The class name Rxvt allows resources common to both 435 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 436 and the original *rxvt* to be easily configured, while the class name
426 name URxvt allows resources unique to urxvt, to be shared between 437 URxvt allows resources unique to rxvt, to be shared between different
427 different urxvt configurations. If no resources are specified, suitable 438 rxvt configurations. If no resources are specified, suitable defaults
428 defaults will be used. Command-line arguments can be used to override 439 will be used. Command-line arguments can be used to override resource
429 resource settings. The following resources are supported (you might want 440 settings. The following resources are supported (you might want to check
430 to check the urxvtperl(3) manpage for additional settings by perl 441 the rxvtperl(3) manpage for additional settings by perl extensions not
431 extensions not documented here): 442 documented here):
443
444 depth: *bitdepth*
445 Compile *xft*: Attempt to find a visual with the given bit depth;
446 option -depth.
432 447
433 geometry: *geom* 448 geometry: *geom*
434 Create the window with the specified X window geometry [default 449 Create the window with the specified X window geometry [default
435 80x24]; option -geometry. 450 80x24]; option -geometry.
436 451
… …
450 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but 465 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 466 the actual colour names used are listed in the COLORS AND GRAPHICS
452 section. 467 section.
453 468
454 Colours higher than 15 cannot be set using resources (yet), but can 469 Colours higher than 15 cannot be set using resources (yet), but can
455 be changed using an escape command (see urxvt(7)). 470 be changed using an escape command (see rxvt(7)).
456 471
457 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm 472 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. 473 with 88 colour support). Colours 80-87 are evenly spaces grey steps.
459 474
460 colorBD: *colour* 475 colorBD: *colour*
… …
497 512
498 inheritPixmap: *boolean* 513 inheritPixmap: *boolean*
499 True: make the background inherit the parent windows' pixmap, giving 514 True: make the background inherit the parent windows' pixmap, giving
500 artificial transparency. False: do not inherit the parent windows' 515 artificial transparency. False: do not inherit the parent windows'
501 pixmap. 516 pixmap.
517
518 *Please note that transparency of any kind if completely unsupported
519 by the author. Don't bug him with installation questions!*
502 520
503 fading: *number* 521 fading: *number*
504 Fade the text by the given percentage when focus is lost; option 522 Fade the text by the given percentage when focus is lost; option
505 -fade. 523 -fade.
506 524
… …
536 scale of 1 displays the image without any scaling. A scale of 2 to 9 554 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 555 specifies an integer number of images in that direction. No image
538 will be magnified beyond 10 times its original size. The maximum 556 will be magnified beyond 10 times its original size. The maximum
539 permitted scale is 1000. [default 0x0+50+50] 557 permitted scale is 1000. [default 0x0+50+50]
540 558
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* 559 path: *path*
548 Specify the colon-delimited search path for finding files (XPM and 560 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 561
552 font: *fontlist* 562 font: *fontlist*
553 Select the fonts to be used. This is a comma separated list of font 563 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 564 names that are checked in order when trying to find glyphs for
555 characters. The first font defines the cell size for characters; 565 characters. The first font defines the cell size for characters;
… …
566 available hint currently is "codeset=codeset-name", and this is only 576 available hint currently is "codeset=codeset-name", and this is only
567 used for Xft fonts. 577 used for Xft fonts.
568 578
569 For example, this font resource 579 For example, this font resource
570 580
571 URxvt*font: 9x15bold,\ 581 URxvt.font: 9x15bold,\
572 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 582 -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, \ 583 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
574 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 584 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
575 xft:Code2000:antialias=false 585 xft:Code2000:antialias=false
576 586
… …
662 672
663 The string will be interpreted as if typed into the shell as-is. 673 The string will be interpreted as if typed into the shell as-is.
664 674
665 Example: 675 Example:
666 676
667 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 677 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
668 678
669 This creates a new file in your home directory with the screen 679 This creates a new file in your home directory with the screen
670 contents everytime you hit "Print". 680 contents everytime you hit "Print".
671 681
672 scrollBar: *boolean* 682 scrollBar: *boolean*
… …
773 The string to send when the delete key (not the keypad delete key) 783 The string to send when the delete key (not the keypad delete key)
774 is pressed. If unset it will send the sequence traditionally 784 is pressed. If unset it will send the sequence traditionally
775 associated with the Execute key. 785 associated with the Execute key.
776 786
777 cutchars: *string* 787 cutchars: *string*
778 The characters used as delimiters for double-click word selection. 788 The characters used as delimiters for double-click word selection
779 The built-in default: 789 (whitespace delimiting is added automatically if resource is given).
790
791 When the selection extension is in use (the default if compiled in,
792 see the rxvtperl(3) manpage), a suitable regex using these
793 characters will be created (if the resource exists, otherwise, no
794 regex will be created). In this mode, characters outside ISO-8859-1
795 can be used.
796
797 When the selection extension is not used, only ISO-8859-1 characters
798 can be used. If not specified, the built-in default is used:
780 799
781 BACKSLASH `"'&()*,;<=>?@[]{|} 800 BACKSLASH `"'&()*,;<=>?@[]{|}
782 801
783 preeditType: *style* 802 preeditType: *style*
784 OverTheSpot, OffTheSpot, Root; option -pt. 803 OverTheSpot, OffTheSpot, Root; option -pt.
… …
794 813
795 imFont: *fontset* 814 imFont: *fontset*
796 Specify the font-set used for XIM styles "OverTheSpot" or 815 Specify the font-set used for XIM styles "OverTheSpot" or
797 "OffTheSpot". It must be a standard X font set (XLFD patterns 816 "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 817 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* 818 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 819 suitable found found, preferably one or two pixels differing in size
801 to the base font. option -imfont. 820 to the base font. option -imfont.
802 821
803 tripleclickwords: *boolean* 822 tripleclickwords: *boolean*
804 Change the meaning of triple-click selection with the left mouse 823 Change the meaning of triple-click selection with the left mouse
… …
815 xterm, have these sequences enabled by default, which doesn't make 834 xterm, have these sequences enabled by default, which doesn't make
816 it safer, though). 835 it safer, though).
817 836
818 You can enable them by setting this boolean resource or specifying 837 You can enable them by setting this boolean resource or specifying
819 -insecure as an option. At the moment, this enables display-answer, 838 -insecure as an option. At the moment, this enables display-answer,
820 locale, findfont, icon label and window title requests as well as 839 locale, findfont, icon label and window title requests.
821 dynamic menubar dispatch.
822 840
823 modifier: *modifier* 841 modifier: *modifier*
824 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 842 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
825 super, mod1, mod2, mod3, mod4, mod5; option -mod. 843 super, mod1, mod2, mod3, mod4, mod5; option -mod.
826 844
827 answerbackString: *string* 845 answerbackString: *string*
828 Specify the reply rxvt-unicode sends to the shell when an ENQ 846 Specify the reply rxvt-unicode sends to the shell when an ENQ
829 (control-E) character is passed through. It may contain escape 847 (control-E) character is passed through. It may contain escape
830 values as described in the entry on keysym following. 848 values as described in the entry on keysym following.
831 849
832 secondaryScreen: *bool* 850 secondaryScreen: *boolean*
833 Turn on/off secondary screen (default enabled). 851 Turn on/off secondary screen (default enabled).
834 852
835 secondaryScroll: *bool* 853 secondaryScroll: *boolean*
836 Turn on/off secondary screen scroll (default enabled). If the this 854 Turn on/off secondary screen scroll (default enabled). If the this
837 option is enabled, scrolls on the secondary screen will change the 855 option is enabled, scrolls on the secondary screen will change the
838 scrollback buffer and switching to/from the secondary screen will 856 scrollback buffer and switching to/from the secondary screen will
839 instead scroll the screen up. 857 instead scroll the screen up.
840 858
841 hold: *bool* 859 hold: *boolean*
842 Turn on/off hold window after exit support. If enabled, urxvt will 860 Turn on/off hold window after exit support. If enabled, rxvt will
843 not immediately destroy its window when the program executed within 861 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 862 it exits. Instead, it will wait till it is being killed or closed by
845 the user. 863 the user.
846 864
847 keysym.*sym*: *string* 865 keysym.*sym*: *string*
… …
870 "\000": octal number) or verbatim control characters ("^?": delete, 888 "\000": octal number) or verbatim control characters ("^?": delete,
871 "^@": null, "^A" ...) and may be enclosed with double quotes so that 889 "^@": null, "^A" ...) and may be enclosed with double quotes so that
872 it can start or end with whitespace. 890 it can start or end with whitespace.
873 891
874 Please note that you need to double the "\" in resource files, as 892 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 893 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 894 "\e" (and so on), which will work with both Xt and rxvt's own
877 processing). 895 processing).
878 896
879 You can define a range of keysyms in one shot by providing a 897 You can define a range of keysyms in one shot by providing a
880 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
881 `/' should be a character not used by the strings. 899 `/' should be a character not used by the strings.
… …
889 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 907 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
890 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 908 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
891 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 909 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
892 910
893 If *string* takes the form of "command:STRING", the specified STRING 911 If *string* takes the form of "command:STRING", the specified STRING
894 is interpreted and executed as urxvt's control sequence. For example 912 is interpreted and executed as rxvt's control sequence. For example
895 the following means "change the current locale to "zh_CN.GBK" when 913 the following means "change the current locale to "zh_CN.GBK" when
896 Control-Meta-c is being pressed": 914 Control-Meta-c is being pressed":
897 915
898 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 916 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
899 917
900 If *string* takes the form "perl:STRING", then the specified STRING 918 If *string* takes the form "perl:STRING", then the specified STRING
901 is passed to the "on_keyboard_command" perl handler. See the 919 is passed to the "on_keyboard_command" perl handler. See the
902 urxvtperl(3) manpage. For example, the selection extension 920 rxvtperl(3) manpage. For example, the selection extension (activated
903 (activated via "urxvt -pe selection") listens for "selection:rot13" 921 via "rxvt -pe selection") listens for "selection:rot13" events:
904 events:
905 922
906 URxvt.keysym.M-C-c: perl:selection:rot13 923 URxvt.keysym.M-C-c: perl:selection:rot13
907 924
908 Due the the large number of modifier combinations, a defined key 925 Due the the large number of modifier combinations, a defined key
909 mapping will match if at *at least* the specified identifiers are 926 mapping will match if at *at least* the specified identifiers are
… …
911 being defined. That means that defining a key map for "a" will 928 being defined. That means that defining a key map for "a" will
912 automatically provide definitions for "Meta-a", "Shift-a" and so on, 929 automatically provide definitions for "Meta-a", "Shift-a" and so on,
913 unless some of those are defined mappings themselves. 930 unless some of those are defined mappings themselves.
914 931
915 Unfortunately, this will override built-in key mappings. For example 932 Unfortunately, this will override built-in key mappings. For example
916 if you overwrite the "Insert" key you will disable urxvt's 933 if you overwrite the "Insert" key you will disable rxvt's
917 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into 934 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
918 the user-defined keymap using the "builtin:" replacement: 935 the user-defined keymap using the "builtin:" replacement:
919 936
920 URxvt.keysym.Insert: <my insert key sequence> 937 URxvt.keysym.Insert: <my insert key sequence>
921 URxvt.keysym.S-Insert: builtin: 938 URxvt.keysym.S-Insert: builtin:
… …
929 font-switching at runtime: 946 font-switching at runtime:
930 947
931 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 948 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
932 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 949 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
933 950
934 Other things are possible, e.g. resizing (see urxvt(7) for more 951 Other things are possible, e.g. resizing (see rxvt(7) for more
935 info): 952 info):
936 953
937 URxvt.keysym.M-C-3: command:\033[8;25;80t 954 URxvt.keysym.M-C-3: command:\033[8;25;80t
938 URxvt.keysym.M-C-4: command:\033[8;48;110t 955 URxvt.keysym.M-C-4: command:\033[8;48;110t
939 956
… …
963 available to all instances, while perl-ext is used for specific 980 available to all instances, while perl-ext is used for specific
964 instances. 981 instances.
965 982
966 perl-eval: *string* 983 perl-eval: *string*
967 Perl code to be evaluated when all extensions have been registered. 984 Perl code to be evaluated when all extensions have been registered.
968 See the urxvtperl(3) manpage. Due to security reasons, this resource 985 See the rxvtperl(3) manpage. Due to security reasons, this resource
969 will be ignored when running setuid/setgid. 986 will be ignored when running setuid/setgid.
970 987
971 perl-lib: *path* 988 perl-lib: *path*
972 Colon-separated list of additional directories that hold extension 989 Colon-separated list of additional directories that hold extension
973 scripts. When looking for extensions specified by the "perl" 990 scripts. When looking for extensions specified by the "perl"
974 resource, urxvt will first look in these directories and then in 991 resource, rxvt will first look in these directories and then in
975 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource 992 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
976 will be ignored when running setuid/setgid. 993 will be ignored when running setuid/setgid.
977 994
978 See the urxvtperl(3) manpage. 995 See the rxvtperl(3) manpage.
979 996
980 selection.pattern-*idx*: *perl-regex* 997 selection.pattern-*idx*: *perl-regex*
981 Additional selection patterns, see the urxvtperl(3) manpage for 998 Additional selection patterns, see the rxvtperl(3) manpage for
982 details. 999 details.
983 1000
984 selection-autotransform.*idx*: *perl-transform* 1001 selection-autotransform.*idx*: *perl-transform*
985 Selection auto-transform patterns, see the urxvtperl(3) manpage for 1002 Selection auto-transform patterns, see the rxvtperl(3) manpage for
986 details. 1003 details.
987 1004
988 searchable-scrollback: *keysym* 1005 searchable-scrollback: *keysym*
989 Sets the hotkey that starts the incremental scrollback buffer search 1006 Sets the hotkey that starts the incremental scrollback buffer search
990 (default: "M-s"). 1007 (default: "M-s").
… …
992 urlLauncher: *string* 1009 urlLauncher: *string*
993 Specifies the program to be started with a URL argument. Used by the 1010 Specifies the program to be started with a URL argument. Used by the
994 "selection-popup" and "mark-urls" perl extensions. 1011 "selection-popup" and "mark-urls" perl extensions.
995 1012
996 transient-for: *windowid* 1013 transient-for: *windowid*
997 Sets the WM_TRANSIENT_FOR property to the given window iw. 1014 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1015 window id.
1016
1017 override-redirect: *boolean*
1018 Compile *frills*: Sets override-redirect for the terminal window,
1019 making it almost invisible to window managers; option
1020 -override-redirect.
998 1021
999THE SCROLLBAR 1022THE SCROLLBAR
1000 Lines of text that scroll off the top of the urxvt window (resource: 1023 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 1024 saveLines) and can be scrolled back using the scrollbar or by
1002 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is 1025 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1003 fairly intuitive. The xterm-scrollbar is without arrows and its 1026 fairly intuitive. The xterm-scrollbar is without arrows and its
1004 behaviour mimics that of *xterm* 1027 behaviour mimics that of *xterm*
1005 1028
1006 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with 1029 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
1007 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1030 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
… …
1034 normal one. In this mode, every selected row becomes its own line in 1057 normal one. In this mode, every selected row becomes its own line in
1035 the selection, and trailing whitespace is visually underlined and 1058 the selection, and trailing whitespace is visually underlined and
1036 removed from the selection. 1059 removed from the selection.
1037 1060
1038 Insertion: 1061 Insertion:
1039 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1062 Pressing and releasing the Middle mouse button in an rxvt window
1040 an urxvt window causes the current text selection to be inserted as 1063 causes the value of the PRIMARY selection (or CLIPBOARD with the
1041 if it had been typed on the keyboard. 1064 Meta modifier) to be inserted as if it had been typed on the
1065 keyboard.
1066
1067 Pressing Shift-Insert causes the value of the PRIMARY selection to
1068 be inserted too.
1042 1069
1043CHANGING FONTS 1070CHANGING FONTS
1044 Changing fonts (or font sizes, respectively) via the keypad is not yet 1071 Changing fonts (or font sizes, respectively) via the keypad is not yet
1045 supported in rxvt-unicode. Bug me if you need this. 1072 supported in rxvt-unicode. Bug me if you need this.
1046 1073
1047 You can, however, switch fonts at runtime using escape sequences (and 1074 You can, however, switch fonts at runtime using escape sequences, e.g.:
1048 therefore using the menubar), e.g.:
1049 1075
1050 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1076 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1077
1078 You can use keyboard shortcuts, too:
1079
1080 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1081 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1051 1082
1052 rxvt-unicode will automatically re-apply these fonts to the output so 1083 rxvt-unicode will automatically re-apply these fonts to the output so
1053 far. 1084 far.
1054 1085
1055ISO 14755 SUPPORT 1086ISO 14755 SUPPORT
… …
1057 character codes using the keyboard. It consists of 4 parts. The first 1088 character codes using the keyboard. It consists of 4 parts. The first
1058 part is available rxvt-unicode has been compiled with "--enable-frills", 1089 part is available rxvt-unicode has been compiled with "--enable-frills",
1059 the rest is available when rxvt-unicode was compiled with 1090 the rest is available when rxvt-unicode was compiled with
1060 "--enable-iso14755". 1091 "--enable-iso14755".
1061 1092
1062 * 5.1: Basic method 1093 * 5.1: Basic method
1094
1063 This allows you to enter unicode characters using their hexcode. 1095 This allows you to enter unicode characters using their hexcode.
1064 1096
1065 Start by pressing and holding both "Control" and "Shift", then enter 1097 Start by pressing and holding both "Control" and "Shift", then enter
1066 hex-digits (between one and six). Releasing "Control" and "Shift" 1098 hex-digits (between one and six). Releasing "Control" and "Shift"
1067 will commit the character as if it were typed directly. While 1099 will commit the character as if it were typed directly. While
… …
1073 address, which you cannot type. Fortunately, the card has the e-mail 1105 address, which you cannot type. Fortunately, the card has the e-mail
1074 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1106 address printed as hexcodes, e.g. "671d 65e5". You can enter this
1075 easily by pressing "Control" and "Shift", followed by 1107 easily by pressing "Control" and "Shift", followed by
1076 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1108 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1077 1109
1078 * 5.2: Keyboard symbols entry method 1110 * 5.2: Keyboard symbols entry method
1111
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
1090 * 5.3: Screen-selection entry method 1123 * 5.3: Screen-selection entry method
1124
1091 While this is implemented already (it's basically the selection 1125 While this is implemented already (it's basically the selection
1092 mechanism), it could be extended by displaying a unicode character 1126 mechanism), it could be extended by displaying a unicode character
1093 map. 1127 map.
1094 1128
1095 * 5.4: Feedback method for identifying displayed characters for later 1129 * 5.4: Feedback method for identifying displayed characters for later
1096 input 1130 input
1131
1097 This method lets you display the unicode character code associated 1132 This method lets you display the unicode character code associated
1098 with characters already displayed. 1133 with characters already displayed.
1099 1134
1100 You enter this mode by holding down "Control" and "Shift" together, 1135 You enter this mode by holding down "Control" and "Shift" together,
1101 then pressing and holding the left mouse button and moving around. 1136 then pressing and holding the left mouse button and moving around.
… …
1110 1145
1111 With respect to conformance, rxvt-unicode is supposed to be compliant to 1146 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. 1147 both scenario A and B of ISO 14755, including part 5.2.
1113 1148
1114LOGIN STAMP 1149LOGIN STAMP
1115 urxvt tries to write an entry into the *utmp*(5) file so that it can be 1150 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 1151 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 1152 feature, rxvt may need to be installed setuid root on some systems or
1118 setgid to root or to some other group on others. 1153 setgid to root or to some other group on others.
1119 1154
1120COLORS AND GRAPHICS 1155COLORS AND GRAPHICS
1121 In addition to the default foreground and background colours, urxvt can 1156 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 1157 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 1158 versions of the same). Here is a list of the colours with their names.
1124 names.
1125 1159
1126 color0 (black) = Black 1160 color0 (black) = Black
1127 color1 (red) = Red3 1161 color1 (red) = Red3
1128 color2 (green) = Green3 1162 color2 (green) = Green3
1129 color3 (yellow) = Yellow3 1163 color3 (yellow) = Yellow3
1130 color4 (blue) = Blue3 1164 color4 (blue) = Blue3
1131 color5 (magenta) = Magenta3 1165 color5 (magenta) = Magenta3
1132 color6 (cyan) = Cyan3 1166 color6 (cyan) = Cyan3
1133 color7 (white) = AntiqueWhite 1167 color7 (white) = AntiqueWhite
1134 color8 (bright black) = Grey25 1168 color8 (bright black) = Grey25
1135 color9 (bright red) = Red 1169 color9 (bright red) = Red
1136 color10 (bright green) = Green 1170 color10 (bright green) = Green
1137 color11 (bright yellow) = Yellow 1171 color11 (bright yellow) = Yellow
1138 color12 (bright blue) = Blue 1172 color12 (bright blue) = Blue
1139 color13 (bright magenta) = Magenta 1173 color13 (bright magenta) = Magenta
1140 color14 (bright cyan) = Cyan 1174 color14 (bright cyan) = Cyan
1141 color15 (bright white) = White 1175 color15 (bright white) = White
1142 foreground = Black 1176 foreground = Black
1143 background = White 1177 background = White
1144
1145 It is also possible to specify the colour values of foreground, 1178 It is also possible to specify the colour values of foreground,
1146 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1179 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1147 0-15, as a convenient shorthand to reference the colour name of 1180 0-15, as a convenient shorthand to reference the colour name of
1148 color0-color15. 1181 color0-color15.
1149 1182
1183 In addition to the colours defined above, rxvt offers an additional 72
1184 colours. The first 64 of those (with indices 16 to 79) consist of a
1185 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1186 by 8 additional shades of gray (with indices 80 to 87).
1187
1188 Together, all those colours implement the 88 colour xterm colours. Only
1189 the first 16 can be changed using resources currently, the rest can only
1190 be changed via command sequences ("escape codes").
1191
1150 Note that -rv ("reverseVideo: True") simulates reverse video by always 1192 Note that -rv ("reverseVideo: True") simulates reverse video by always
1151 swapping the foreground/background colours. This is in contrast to 1193 swapping the foreground/background colours. This is in contrast to
1152 *xterm*(1) where the colours are only swapped if they have not otherwise 1194 *xterm*(1) where the colours are only swapped if they have not otherwise
1153 been specified. For example, 1195 been specified. For example,
1154 1196
1155 urxvt -fg Black -bg White -rv 1197 rxvt -fg Black -bg White -rv
1156 would yield White on Black, while on *xterm*(1) it would yield Black 1198 would yield White on Black, while on *xterm*(1) it would yield Black
1157 on White. 1199 on White.
1158 1200
1201 ALPHA CHANNEL SUPPORT
1202 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1203 get their act together, rxvt-unicode will support
1204 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1205 digits/component) colour specifications, in addition to the ones
1206 provided by X, where the additional A component specifies opacity
1207 (alpha) values. The minimum value of 0 is completely transparent). You
1208 can also prefix any color with "[a]", where "a" is on to four hex digits
1209 specifiying the opacity value.
1210
1211 You probably need to specify "-depth 32", too, and have the luck that
1212 your X-server uses ARGB pixel layout, as X is far from just supporting
1213 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1214
1215 For example, the following selects an almost completely transparent red
1216 background, and an almost opaque pink foreground:
1217
1218 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1219
1220 *Please note that transparency of any kind if completely unsupported by
1221 the author. Don't bug him with installation questions!*
1222
1159ENVIRONMENT 1223ENVIRONMENT
1160 urxvt sets and/or uses the following environment variables: 1224 rxvt sets and/or uses the following environment variables:
1161 1225
1162 TERM 1226 TERM
1163 Normally set to "rxvt-unicode", unless overwritten at configure 1227 Normally set to "rxvt-unicode", unless overwritten at configure
1164 time, via resources or on the commandline. 1228 time, via resources or on the commandline.
1165 1229
1166 COLORTERM 1230 COLORTERM
1167 Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled 1231 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1168 with XPM support, and optionally with the added extension "-mono" to 1232 with XPM support, and optionally with the added extension "-mono" to
1169 indicate that rxvt-unicode runs on a monochrome screen. 1233 indicate that rxvt-unicode runs on a monochrome screen.
1170 1234
1171 COLORFGBG 1235 COLORFGBG
1172 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1236 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 1237 the colour code used as default foreground/text colour (or the
1174 string "default" to indicate that the default-colour escape sequence 1238 string "default" to indicate that the default-colour escape sequence
1175 is to be used), "bg" is the colour code used as default background 1239 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" 1240 colour (or the string "default"), and "xpm" is the string "default"
1177 if urxvt was compiled with XPM support. Libraries like "ncurses" and 1241 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1178 "slang" can (and do) use this information to optimize screen output. 1242 "slang" can (and do) use this information to optimize screen output.
1179 1243
1180 WINDOWID 1244 WINDOWID
1181 Set to the (decimal) X Window ID of the urxvt window (the toplevel 1245 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1182 window, which usually has subwindows for the scrollbar, the terminal 1246 window, which usually has subwindows for the scrollbar, the terminal
1183 window and so on). 1247 window and so on).
1184 1248
1185 TERMINFO 1249 TERMINFO
1186 Set to the terminfo directory iff urxvt was configured with 1250 Set to the terminfo directory iff rxvt was configured with
1187 "--with-terminfo=PATH". 1251 "--with-terminfo=PATH".
1188 1252
1189 DISPLAY 1253 DISPLAY
1190 Used by urxvt to connect to the display and set to the correct 1254 Used by rxvt to connect to the display and set to the correct
1191 display in it's child processes. 1255 display in its child processes.
1192 1256
1193 SHELL 1257 SHELL
1194 The shell to be used for command execution, defaults to "/bin/sh". 1258 The shell to be used for command execution, defaults to "/bin/sh".
1195 1259
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 1260 RXVT_SOCKET
1204 The unix domain socket path used by urxvtc(1) and urxvtd(1). 1261 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1205 1262
1206 Default $HOME/.rxvt-unicode-*<nodename*. 1263 Default $HOME/.rxvt-unicode-*<nodename*.
1207 1264
1208 HOME 1265 HOME
1209 Used to locate the default directory for the unix domain socket for 1266 Used to locate the default directory for the unix domain socket for
… …
1213 XAPPLRESDIR 1270 XAPPLRESDIR
1214 Directory where various X resource files are being located. 1271 Directory where various X resource files are being located.
1215 1272
1216 XENVIRONMENT 1273 XENVIRONMENT
1217 If set and accessible, gives the name of a X resource file to be 1274 If set and accessible, gives the name of a X resource file to be
1218 loaded by urxvt. 1275 loaded by rxvt.
1219 1276
1220FILES 1277FILES
1221 /usr/lib/X11/rgb.txt 1278 /usr/lib/X11/rgb.txt
1222 Color names. 1279 Color names.
1223 1280
1224SEE ALSO 1281SEE ALSO
1225 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), 1282 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1226 pty(4), tty(4), utmp(5) 1283 tty(4), utmp(5)
1227 1284
1228CURRENT PROJECT COORDINATOR 1285CURRENT PROJECT COORDINATOR
1229 Project Coordinator 1286 Project Coordinator
1230 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1287 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1231 1288
1232 <http://software.schmorp.de/#rxvt-unicode> 1289 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1233 1290
1234AUTHORS 1291AUTHORS
1235 John Bovey 1292 John Bovey
1236 University of Kent, 1992, wrote the original Xvt. 1293 University of Kent, 1992, wrote the original Xvt.
1237 1294
… …
1248 1305
1249 Oezguer Kesim <kesim@math.fu-berlin.de> 1306 Oezguer Kesim <kesim@math.fu-berlin.de>
1250 Project Coordinator (changes.txt 2.21a to 2.4.5) 1307 Project Coordinator (changes.txt 2.21a to 2.4.5)
1251 1308
1252 Geoff Wing <gcw@pobox.com> 1309 Geoff Wing <gcw@pobox.com>
1253 Rewrote screen display and text selection routines. Project 1310 Rewrote screen display and text selection routines.
1311
1254 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1312 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1255 1313
1256 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1314 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1257 Forked rxvt-unicode, rewrote most of the display code and internal 1315 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1258 character handling to store text in unicode, improve xterm 1316 perl extension, random hacks, numerous bugfixes and extensions.
1259 compatibility and apply numerous other bugfixes and extensions.
1260 1317
1261 Project Coordinator (Changes 1.0 -) 1318 Project Coordinator (Changes 1.0 -)
1262 1319
1320 Emanuele Giaquinta <e.giaquinta@glauco.it>
1321 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1322

Diff Legend

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