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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.33 by root, Tue Jan 3 21:15:22 2006 UTC vs.
Revision 1.61 by root, Mon Jul 17 19:20:29 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 rxvt [options] [-e command [ args ]] 6 urxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 6.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.8, 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/*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 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) easier accessible: see rxvt(7) for technical reference 61 been extended) easier 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.
… …
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 rxvt -tr -tint blue -sh 40 125 urxvt -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
… …
146 The colour of the border around the text area and between the 153 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 154 scrollbar and the text; resource borderColor.
148 155
149 -fn *fontlist* 156 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 157 Select the fonts to be used. This is a comma separated list of font
151 names that are used in turn when trying to display Unicode 158 names that are checked in order when trying to find glyphs for
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 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 168 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 169 urxvt -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 rxvt(7). 172 FAQ section of urxvt(7).
166 173
167 -fb *fontlist* 174 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 175 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 176 characters are to be printed. See resource boldFont for details.
170 177
171 -fi *fontlist* 178 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 179 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 180 characters are to be printed. See resource italicFont for details.
174 181
175 -fbi *fontlist* 182 -fbi *fontlist*
176 Compile font-styles: The bold italic font list to use when bold 183 Compile *font-styles*: The bold italic font list to use when *bold
177 characters are to be printed. See resource boldItalicFont for 184 italic* characters are to be printed. See resource boldItalicFont
178 details. 185 for details.
179 186
180 -is|+is 187 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity 188 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for 189 foreground/background (default). See resource intensityStyles for
183 details. 190 details.
184 191
185 -name *name* 192 -name *name*
186 Specify the application name under which resources are to be 193 Specify the application name under which resources are to be
… …
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
268 -sbg
269 Compile *frills*: Disable the usage of the built-in block
270 graphics/line drawing characters and just rely on what the specified
271 fonts provide. Use this if you have a good font and want to use its
272 block graphic glyphs; resource skipBuiltinGlyphs.
273
257 -lsp *number* 274 -lsp *number*
258 Compile *frills*: Lines (pixel height) to insert between each row of 275 Compile *frills*: Lines (pixel height) to insert between each row of
259 the display. Useful to work around font rendering problems; resource 276 the display. Useful to work around font rendering problems; resource
260 linespace. 277 linespace.
261 278
… …
264 TERM environment variable. This terminal type must exist in the 281 TERM environment variable. This terminal type must exist in the
265 *termcap(5)* database and should have *li#* and *co#* entries; 282 *termcap(5)* database and should have *li#* and *co#* entries;
266 resource termName. 283 resource termName.
267 284
268 -e *command [arguments]* 285 -e *command [arguments]*
269 Run the command with its command-line arguments in the rxvt window; 286 Run the command with its command-line arguments in the urxvt window;
270 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
271 program being executed if neither *-title* (*-T*) nor *-n* are given 288 program being executed if neither *-title* (*-T*) nor *-n* are given
272 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
273 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
274 run the program specified by the SHELL environment variable or, 291 run the program specified by the SHELL environment variable or,
… …
276 293
277 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
278 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
279 this: 296 this:
280 297
281 rxvt -e sh -c "shell commands" 298 urxvt -e sh -c "shell commands"
282 299
283 -title *text* 300 -title *text*
284 Window title (-T still respected); the default title is the basename 301 Window title (-T still respected); the default title is the basename
285 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
286 application name; resource title. 303 application name; resource title.
… …
331 -ssr|+ssr 348 -ssr|+ssr
332 Turn on/off secondary screen scroll (default enabled); resource 349 Turn on/off secondary screen scroll (default enabled); resource
333 secondaryScroll. 350 secondaryScroll.
334 351
335 -hold|+hold 352 -hold|+hold
336 Turn on/off hold window after exit support. If enabled, rxvt will 353 Turn on/off hold window after exit support. If enabled, urxvt will
337 not immediately destroy its window when the program executed within 354 not immediately destroy its window when the program executed within
338 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
339 the user; resource hold. 356 the user; resource hold.
340 357
341 -keysym.*sym* *string* 358 -keysym.*sym* *string*
342 Remap a key symbol. See resource keysym. 359 Remap a key symbol. See resource keysym.
343 360
344 -embed *windowid* 361 -embed *windowid*
345 Tells rxvt to embed it's windows into an already-existing window, 362 Tells urxvt to embed its windows into an already-existing window,
346 which enables applications to easily embed a terminal. 363 which enables applications to easily embed a terminal.
347 364
348 Right now, rxvt will first unmap/map the specified window, so it 365 Right now, urxvt will first unmap/map the specified window, so it
349 shouldn't be a top-level window. rxvt will also reconfigure it quite 366 shouldn't be a top-level window. urxvt will also reconfigure it
350 a bit, so don't expect it to keep some specific state. It's best to 367 quite a bit, so don't expect it to keep some specific state. It's
351 create an extra subwindow for rxvt and leave it alone. 368 best to create an extra subwindow for urxvt and leave it alone.
352 369
353 The window will not be destroyed when rxvt exits. 370 The window will not be destroyed when urxvt exits.
354 371
355 It might be useful to know that rxvt will not close file descriptors 372 It might be useful to know that urxvt will not close file
356 passed to it (except for stdin/out/err, of course), so you can use 373 descriptors passed to it (except for stdin/out/err, of course), so
357 file descriptors to communicate with the programs within the 374 you can use file descriptors to communicate with the programs within
358 terminal. This works regardless of wether the "-embed" option was 375 the terminal. This works regardless of wether the "-embed" option
359 used or not. 376 was used or not.
360 377
361 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
362 can be used (a longer example is in doc/embed): 379 can be used (a longer example is in doc/embed):
363 380
364 my $rxvt = new Gtk2::Socket; 381 my $rxvt = new Gtk2::Socket;
365 $rxvt->signal_connect_after (realize => sub { 382 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid; 383 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &"; 384 system "urxvt -embed $xid &";
368 }); 385 });
369 386
370 -pty-fd *fileno* 387 -pty-fd *file descriptor*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair 388 Tells urxvt NOT to execute any commands or create a new pty/tty pair
372 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
373 useful if you want to drive rxvt as a generic terminal emulator 390 useful if you want to drive urxvt as a generic terminal emulator
374 without having to run a program within it. 391 without having to run a program within it.
375 392
376 If this switch is given, rxvt will not create any utmp/wtmp entries 393 If this switch is given, urxvt will not create any utmp/wtmp entries
377 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
378 yourself if you want that. 395 yourself if you want that.
379 396
397 As an extremely special case, specifying -1 will completely suppress
398 pty/tty operations.
399
380 Here is a example in perl that illustrates how this option can be 400 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd): 401 used (a longer example is in doc/pty-fd):
382 402
383 use IO::Pty; 403 use IO::Pty;
384 use Fcntl; 404 use Fcntl;
385 405
386 my $pty = new IO::Pty; 406 my $pty = new IO::Pty;
387 fcntl $pty, F_SETFD, 0; # clear close-on-exec 407 fcntl $pty, F_SETFD, 0; # clear close-on-exec
388 system "rxvt -pty-fd " . (fileno $pty) . "&"; 408 system "urxvt -pty-fd " . (fileno $pty) . "&";
389 close $pty; 409 close $pty;
390 410
391 # now communicate with rxvt 411 # now communicate with rxvt
392 my $slave = $pty->slave; 412 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" } 413 while (<$slave>) { print $slave "got <$_>\n" }
394 414
395 -pe *string* 415 -pe *string*
396 Colon-separated list of perl extension scripts to use in this 416 Comma-separated list of perl extension scripts to use (or not to
397 terminal instance. See resource perl-ext. 417 use) in this terminal instance. See resource perl-ext for details.
398 418
399RESOURCES (available also as long-options) 419RESOURCES (available also as long-options)
400 Note: `rxvt --help' gives a list of all resources (long options) 420 Note: `urxvt --help' gives a list of all resources (long options)
401 compiled into your version. 421 compiled into your version.
402 422
403 There are two different methods that rxvt can use to get the Xresource
404 data: using the X libraries (Xrm*-functions) or internal Xresources
405 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
406 XGetDefaults), you can set and change the resources using X11 tools like 423 You can set and change the resources using X11 tools like xrdb. Many
407 xrdb. Many distribution do also load settings from the ~/.Xresources 424 distribution do also load settings from the ~/.Xresources file when X
408 file when X starts. rxvt will consult the following files/resources in 425 starts. urxvt will consult the following files/resources in order, with
409 order, with later settings overwriting earlier ones: 426 later settings overwriting earlier ones:
410 427
411 1. system-wide app-defaults file, either locale-dependent OR global 428 1. system-wide app-defaults file, either locale-dependent OR global
412 2. app-defaults file in $XAPPLRESDIR 429 2. app-defaults file in $XAPPLRESDIR
413 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 430 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
414 4. SCREEN_RESOURCES for the current screen 431 4. SCREEN_RESOURCES for the current screen
415 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 432 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
416 433
417 If compiled with internal Xresources support (i.e. rxvt -h lists 434 Note that when reading X resources, urxvt recognizes two class names:
418 .Xdefaults) then rxvt accepts application defaults set in 435 Rxvt and URxvt. The class name Rxvt allows resources common to both
419 XAPPLOADDIR/URxvt (compile-time defined: usually 436 urxvt and the original *rxvt* to be easily configured, while the class
420 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 437 name URxvt allows resources unique to urxvt, to be shared between
421 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
422 resources, rxvt recognizes two class names: XTerm and URxvt. The class
423 name Rxvt allows resources common to both rxvt and the original *rxvt*
424 to be easily configured, while the class name URxvt allows resources
425 unique to rxvt, notably colours and key-handling, to be shared between
426 different rxvt configurations. If no resources are specified, suitable 438 different urxvt configurations. If no resources are specified, suitable
427 defaults will be used. Command-line arguments can be used to override 439 defaults will be used. Command-line arguments can be used to override
428 resource settings. The following resources are allowed: 440 resource settings. The following resources are supported (you might want
441 to check the urxvtperl(3) manpage for additional settings by perl
442 extensions not documented here):
443
444 depth: *bitdepth*
445 Compile *xft*: Attempt to find a visual with the given bit depth;
446 option -depth.
429 447
430 geometry: *geom* 448 geometry: *geom*
431 Create the window with the specified X window geometry [default 449 Create the window with the specified X window geometry [default
432 80x24]; option -geometry. 450 80x24]; option -geometry.
433 451
… …
447 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
448 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
449 section. 467 section.
450 468
451 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
452 be changed using an escape command (see rxvt(7)). 470 be changed using an escape command (see urxvt(7)).
453 471
454 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
455 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.
456 474
457 colorBD: *colour* 475 colorBD: *colour*
… …
494 512
495 inheritPixmap: *boolean* 513 inheritPixmap: *boolean*
496 True: make the background inherit the parent windows' pixmap, giving 514 True: make the background inherit the parent windows' pixmap, giving
497 artificial transparency. False: do not inherit the parent windows' 515 artificial transparency. False: do not inherit the parent windows'
498 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!*
499 520
500 fading: *number* 521 fading: *number*
501 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
502 -fade. 523 -fade.
503 524
… …
533 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
534 specifies an integer number of images in that direction. No image 555 specifies an integer number of images in that direction. No image
535 will be magnified beyond 10 times its original size. The maximum 556 will be magnified beyond 10 times its original size. The maximum
536 permitted scale is 1000. [default 0x0+50+50] 557 permitted scale is 1000. [default 0x0+50+50]
537 558
538 menu: *file[;tag]*
539 Read in the specified menu file (note the `.menu' extension is
540 optional) and also optionally specify a starting tag to find. See
541 the reference documentation for details on the syntax for the
542 menuBar.
543
544 path: *path* 559 path: *path*
545 Specify the colon-delimited search path for finding files (XPM and 560 Specify the colon-delimited search path for finding XPM files.
546 menus), in addition to the paths specified by the RXVTPATH and PATH
547 environment variables.
548 561
549 font: *fontlist* 562 font: *fontlist*
550 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
551 names that are used in turn when trying to display Unicode 564 names that are checked in order when trying to find glyphs for
552 characters. The first font defines the cell size for characters; 565 characters. The first font defines the cell size for characters;
553 other fonts might be smaller, but not larger. A reasonable default 566 other fonts might be smaller, but not (in general) larger. A
554 font list is always appended to it; option -fn. 567 (hopefully) reasonable default font list is always appended to it;
568 option -fn.
555 569
556 Each font can either be a standard X11 core font (XLFD) name, with 570 Each font can either be a standard X11 core font (XLFD) name, with
557 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 571 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
558 "xft:". 572 "xft:".
559 573
… …
562 available hint currently is "codeset=codeset-name", and this is only 576 available hint currently is "codeset=codeset-name", and this is only
563 used for Xft fonts. 577 used for Xft fonts.
564 578
565 For example, this font resource 579 For example, this font resource
566 580
567 URxvt*font: 9x15bold,\ 581 URxvt.font: 9x15bold,\
568 -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,\
569 -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, \
570 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 584 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
571 xft:Code2000:antialias=false 585 xft:Code2000:antialias=false
572 586
… …
658 672
659 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.
660 674
661 Example: 675 Example:
662 676
663 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 677 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
664 678
665 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
666 contents everytime you hit "Print". 680 contents everytime you hit "Print".
667 681
668 scrollBar: *boolean* 682 scrollBar: *boolean*
… …
711 borderLess: *boolean* 725 borderLess: *boolean*
712 Set MWM hints to request a borderless window, i.e. if honoured by 726 Set MWM hints to request a borderless window, i.e. if honoured by
713 the WM, the rxvt-unicode window will not have window decorations; 727 the WM, the rxvt-unicode window will not have window decorations;
714 option -bl. 728 option -bl.
715 729
730 skipBuiltinGlyphs: *boolean*
731 Compile *frills*: Disable the usage of the built-in block
732 graphics/line drawing characters and just rely on what the specified
733 fonts provide. Use this if you have a good font and want to use its
734 block graphic glyphs; option -sbg.
735
716 termName: *termname* 736 termName: *termname*
717 Specifies the terminal type name to be set in the TERM environment 737 Specifies the terminal type name to be set in the TERM environment
718 variable; option -tn. 738 variable; option -tn.
719 739
720 linespace: *number* 740 linespace: *number*
… …
763 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)
764 is pressed. If unset it will send the sequence traditionally 784 is pressed. If unset it will send the sequence traditionally
765 associated with the Execute key. 785 associated with the Execute key.
766 786
767 cutchars: *string* 787 cutchars: *string*
768 The characters used as delimiters for double-click word selection. 788 The characters used as delimiters for double-click word selection
769 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 urxvtperl(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:
770 799
771 BACKSLASH `"'&()*,;<=>?@[]{|} 800 BACKSLASH `"'&()*,;<=>?@[]{|}
772 801
773 preeditType: *style* 802 preeditType: *style*
774 OverTheSpot, OffTheSpot, Root; option -pt. 803 OverTheSpot, OffTheSpot, Root; option -pt.
… …
784 813
785 imFont: *fontset* 814 imFont: *fontset*
786 Specify the font-set used for XIM styles "OverTheSpot" or 815 Specify the font-set used for XIM styles "OverTheSpot" or
787 "OffTheSpot". It must be a standard X font set (XLFD patterns 816 "OffTheSpot". It must be a standard X font set (XLFD patterns
788 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
789 font lists used in rxvt. The default will be set-up to chose *any* 818 font lists used in urxvt. The default will be set-up to chose *any*
790 suitable found found, preferably one or two pixels differing in size 819 suitable found found, preferably one or two pixels differing in size
791 to the base font. option -imfont. 820 to the base font. option -imfont.
792 821
793 tripleclickwords: *boolean* 822 tripleclickwords: *boolean*
794 Change the meaning of triple-click selection with the left mouse 823 Change the meaning of triple-click selection with the left mouse
… …
805 xterm, have these sequences enabled by default, which doesn't make 834 xterm, have these sequences enabled by default, which doesn't make
806 it safer, though). 835 it safer, though).
807 836
808 You can enable them by setting this boolean resource or specifying 837 You can enable them by setting this boolean resource or specifying
809 -insecure as an option. At the moment, this enables display-answer, 838 -insecure as an option. At the moment, this enables display-answer,
810 locale, findfont, icon label and window title requests as well as 839 locale, findfont, icon label and window title requests.
811 dynamic menubar dispatch.
812 840
813 modifier: *modifier* 841 modifier: *modifier*
814 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,
815 super, mod1, mod2, mod3, mod4, mod5; option -mod. 843 super, mod1, mod2, mod3, mod4, mod5; option -mod.
816 844
817 answerbackString: *string* 845 answerbackString: *string*
818 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
819 (control-E) character is passed through. It may contain escape 847 (control-E) character is passed through. It may contain escape
820 values as described in the entry on keysym following. 848 values as described in the entry on keysym following.
821 849
822 secondaryScreen: *bool* 850 secondaryScreen: *boolean*
823 Turn on/off secondary screen (default enabled). 851 Turn on/off secondary screen (default enabled).
824 852
825 secondaryScroll: *bool* 853 secondaryScroll: *boolean*
826 Turn on/off secondary screen scroll (default enabled). If the this 854 Turn on/off secondary screen scroll (default enabled). If the this
827 option is enabled, scrolls on the secondary screen will change the 855 option is enabled, scrolls on the secondary screen will change the
828 scrollback buffer and switching to/from the secondary screen will 856 scrollback buffer and switching to/from the secondary screen will
829 instead scroll the screen up. 857 instead scroll the screen up.
830 858
831 hold: *bool* 859 hold: *boolean*
832 Turn on/off hold window after exit support. If enabled, rxvt will 860 Turn on/off hold window after exit support. If enabled, urxvt will
833 not immediately destroy its window when the program executed within 861 not immediately destroy its window when the program executed within
834 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
835 the user. 863 the user.
836 864
837 keysym.*sym*: *string* 865 keysym.*sym*: *string*
… …
859 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 887 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
860 "\000": octal number) or verbatim control characters ("^?": delete, 888 "\000": octal number) or verbatim control characters ("^?": delete,
861 "^@": null, "^A" ...) and may be enclosed with double quotes so that 889 "^@": null, "^A" ...) and may be enclosed with double quotes so that
862 it can start or end with whitespace. 890 it can start or end with whitespace.
863 891
864 Please note that you need to double the "\" when using 892 Please note that you need to double the "\" in resource files, as
865 "--enable-xgetdefault", as X itself does it's own de-escaping (you 893 Xlib itself does its own de-escaping (you can use "\033" instead of
866 can use "\033" instead of "\e" (and so on), which will work with 894 "\e" (and so on), which will work with both Xt and urxvt's own
867 both Xt and rxvt's own processing). 895 processing).
868 896
869 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
870 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
871 `/' should be a character not used by the strings. 899 `/' should be a character not used by the strings.
872 900
… …
879 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 907 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
880 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 908 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
881 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 909 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
882 910
883 If *string* takes the form of "command:STRING", the specified STRING 911 If *string* takes the form of "command:STRING", the specified STRING
884 is interpreted and executed as rxvt's control sequence. For example 912 is interpreted and executed as urxvt's control sequence. For example
885 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
886 Control-Meta-c is being pressed": 914 Control-Meta-c is being pressed":
887 915
888 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
889 917
890 If *string* takes the form "perl:STRING", then the specified STRING 918 If *string* takes the form "perl:STRING", then the specified STRING
891 is passed to the "on_keyboard_command" perl handler. See the 919 is passed to the "on_keyboard_command" perl handler. See the
892 rxvtperl(3) manpage. For example, the selection extension (activated 920 urxvtperl(3) manpage. For example, the selection extension
893 via "rxvt -pe selection") listens for "selection:rot13" events: 921 (activated via "urxvt -pe selection") listens for "selection:rot13"
922 events:
894 923
895 URxvt.keysym.M-C-c: perl:selection:rot13 924 URxvt.keysym.M-C-c: perl:selection:rot13
896 925
897 Due the the large number of modifier combinations, a defined key 926 Due the the large number of modifier combinations, a defined key
898 mapping will match if at *at least* the specified identifiers are 927 mapping will match if at *at least* the specified identifiers are
… …
900 being defined. That means that defining a key map for "a" will 929 being defined. That means that defining a key map for "a" will
901 automatically provide definitions for "Meta-a", "Shift-a" and so on, 930 automatically provide definitions for "Meta-a", "Shift-a" and so on,
902 unless some of those are defined mappings themselves. 931 unless some of those are defined mappings themselves.
903 932
904 Unfortunately, this will override built-in key mappings. For example 933 Unfortunately, this will override built-in key mappings. For example
905 if you overwrite the "Insert" key you will disable rxvt's 934 if you overwrite the "Insert" key you will disable urxvt's
906 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into 935 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
907 the user-defined keymap using the "builtin:" replacement: 936 the user-defined keymap using the "builtin:" replacement:
908 937
909 URxvt.keysym.Insert: <my insert key sequence> 938 URxvt.keysym.Insert: <my insert key sequence>
910 URxvt.keysym.S-Insert: builtin: 939 URxvt.keysym.S-Insert: builtin:
… …
918 font-switching at runtime: 947 font-switching at runtime:
919 948
920 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 949 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
921 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 950 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
922 951
923 Other things are possible, e.g. resizing (see rxvt(7) for more 952 Other things are possible, e.g. resizing (see urxvt(7) for more
924 info): 953 info):
925 954
926 URxvt.keysym.M-C-3: command:\033[8;25;80t 955 URxvt.keysym.M-C-3: command:\033[8;25;80t
927 URxvt.keysym.M-C-4: command:\033[8;48;110t 956 URxvt.keysym.M-C-4: command:\033[8;48;110t
928 957
958 perl-ext-common: *string*
929 perl-ext: *string* 959 perl-ext: *string*
930 Colon-separated list of perl extension scripts to use in this 960 Comma-separated list(s) of perl extension scripts (default:
931 terminal instance. Each extension is looked up in the library 961 "default") to use in this terminal instance; option -pe.
962
963 Extension names can be prefixed with a "-" sign to prohibit using
964 them. This can be useful to selectively disable some extensions
965 loaded by default, or specified via the "perl-ext-common" resource.
966 For example, "default,-selection" will use all the default extension
967 except "selection".
968
969 Extension names can also be followed by an argument in angle
970 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
971 for searchable scorllback to Alt/Meta-s). Mentioning the same
972 extension multiple times with different arguments will pass multiple
973 arguments to the extension.
974
975 Each extension is looked up in the library directories, loaded if
932 directories, loaded if necessary, and bound to the current terminal 976 necessary, and bound to the current terminal instance.
933 instance. If this resource is empty or missing, then the perl 977
978 If both of these resources are the empty string, then the perl
934 interpreter will not be initialized; option -pe. 979 interpreter will not be initialized. The idea behind two options is
980 that perl-ext-common will be used for extensions that should be
981 available to all instances, while perl-ext is used for specific
982 instances.
935 983
936 perl-eval: *string* 984 perl-eval: *string*
937 Perl code to be evaluated when all extensions have been registered. 985 Perl code to be evaluated when all extensions have been registered.
938 See the rxvtperl(3) manpage. 986 See the urxvtperl(3) manpage. Due to security reasons, this resource
987 will be ignored when running setuid/setgid.
939 988
940 perl-lib: *path* 989 perl-lib: *path*
941 Colon-separated list of additional directories that hold extension 990 Colon-separated list of additional directories that hold extension
942 scripts. When looking for extensions specified by the "perl" 991 scripts. When looking for extensions specified by the "perl"
943 resource, rxvt will first look in these directories and then in 992 resource, urxvt will first look in these directories and then in
944 /opt/rxvt/lib/urxvt/perl/. 993 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource
994 will be ignored when running setuid/setgid.
945 995
946 See the rxvtperl(3) manpage. 996 See the urxvtperl(3) manpage.
997
998 selection.pattern-*idx*: *perl-regex*
999 Additional selection patterns, see the urxvtperl(3) manpage for
1000 details.
1001
1002 selection-autotransform.*idx*: *perl-transform*
1003 Selection auto-transform patterns, see the urxvtperl(3) manpage for
1004 details.
1005
1006 searchable-scrollback: *keysym*
1007 Sets the hotkey that starts the incremental scrollback buffer search
1008 (default: "M-s").
1009
1010 urlLauncher: *string*
1011 Specifies the program to be started with a URL argument. Used by the
1012 "selection-popup" and "mark-urls" perl extensions.
1013
1014 transient-for: *windowid*
1015 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1016 window id.
1017
1018 override-redirect: *boolean*
1019 Compile *frills*: Sets override-redirect for the terminal window,
1020 making it almost invisible to window managers; option
1021 -override-redirect.
947 1022
948THE SCROLLBAR 1023THE SCROLLBAR
949 Lines of text that scroll off the top of the rxvt window (resource: 1024 Lines of text that scroll off the top of the urxvt window (resource:
950 saveLines) and can be scrolled back using the scrollbar or by 1025 saveLines) and can be scrolled back using the scrollbar or by
951 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1026 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
952 fairly intuitive. The xterm-scrollbar is without arrows and its 1027 fairly intuitive. The xterm-scrollbar is without arrows and its
953 behaviour mimics that of *xterm* 1028 behaviour mimics that of *xterm*
954 1029
955 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with 1030 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
956 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1031 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
… …
983 normal one. In this mode, every selected row becomes its own line in 1058 normal one. In this mode, every selected row becomes its own line in
984 the selection, and trailing whitespace is visually underlined and 1059 the selection, and trailing whitespace is visually underlined and
985 removed from the selection. 1060 removed from the selection.
986 1061
987 Insertion: 1062 Insertion:
988 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1063 Pressing and releasing the Middle mouse button in an urxvt window
989 an rxvt window causes the current text selection to be inserted as 1064 causes the value of the PRIMARY selection (or CLIPBOARD with the
990 if it had been typed on the keyboard. 1065 Meta modifier) to be inserted as if it had been typed on the
1066 keyboard.
1067
1068 Pressing Shift-Insert causes the value of the PRIMARY selection to
1069 be inserted too.
991 1070
992CHANGING FONTS 1071CHANGING FONTS
993 Changing fonts (or font sizes, respectively) via the keypad is not yet 1072 Changing fonts (or font sizes, respectively) via the keypad is not yet
994 supported in rxvt-unicode. Bug me if you need this. 1073 supported in rxvt-unicode. Bug me if you need this.
995 1074
996 You can, however, switch fonts at runtime using escape sequences (and 1075 You can, however, switch fonts at runtime using escape sequences, e.g.:
997 therefore using the menubar), e.g.:
998 1076
999 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1077 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1078
1079 You can use keyboard shortcuts, too:
1080
1081 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1082 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1000 1083
1001 rxvt-unicode will automatically re-apply these fonts to the output so 1084 rxvt-unicode will automatically re-apply these fonts to the output so
1002 far. 1085 far.
1003 1086
1004ISO 14755 SUPPORT 1087ISO 14755 SUPPORT
… …
1006 character codes using the keyboard. It consists of 4 parts. The first 1089 character codes using the keyboard. It consists of 4 parts. The first
1007 part is available rxvt-unicode has been compiled with "--enable-frills", 1090 part is available rxvt-unicode has been compiled with "--enable-frills",
1008 the rest is available when rxvt-unicode was compiled with 1091 the rest is available when rxvt-unicode was compiled with
1009 "--enable-iso14755". 1092 "--enable-iso14755".
1010 1093
1011 * 5.1: Basic method 1094 * 5.1: Basic method
1095
1012 This allows you to enter unicode characters using their hexcode. 1096 This allows you to enter unicode characters using their hexcode.
1013 1097
1014 Start by pressing and holding both "Control" and "Shift", then enter 1098 Start by pressing and holding both "Control" and "Shift", then enter
1015 hex-digits (between one and six). Releasing "Control" and "Shift" 1099 hex-digits (between one and six). Releasing "Control" and "Shift"
1016 will commit the character as if it were typed directly. While 1100 will commit the character as if it were typed directly. While
… …
1022 address, which you cannot type. Fortunately, the card has the e-mail 1106 address, which you cannot type. Fortunately, the card has the e-mail
1023 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1107 address printed as hexcodes, e.g. "671d 65e5". You can enter this
1024 easily by pressing "Control" and "Shift", followed by 1108 easily by pressing "Control" and "Shift", followed by
1025 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1109 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1026 1110
1027 * 5.2: Keyboard symbols entry method 1111 * 5.2: Keyboard symbols entry method
1112
1028 This mode lets you input characters representing the keycap symbols 1113 This mode lets you input characters representing the keycap symbols
1029 of your keyboard, if representable in the current locale encoding. 1114 of your keyboard, if representable in the current locale encoding.
1030 1115
1031 Start by pressing "Control" and "Shift" together, then releasing 1116 Start by pressing "Control" and "Shift" together, then releasing
1032 them. The next special key (cursor keys, home etc.) you enter will 1117 them. The next special key (cursor keys, home etc.) you enter will
1033 not invoke it's usual function but instead will insert the 1118 not invoke its usual function but instead will insert the
1034 corresponding keycap symbol. The symbol will only be entered when 1119 corresponding keycap symbol. The symbol will only be entered when
1035 the key has been released, otherwise pressing e.g. "Shift" would 1120 the key has been released, otherwise pressing e.g. "Shift" would
1036 enter the symbol for "ISO Level 2 Switch", although your intention 1121 enter the symbol for "ISO Level 2 Switch", although your intention
1037 might have been to enter a reverse tab (Shift-Tab). 1122 might have been to enter a reverse tab (Shift-Tab).
1038 1123
1039 * 5.3: Screen-selection entry method 1124 * 5.3: Screen-selection entry method
1125
1040 While this is implemented already (it's basically the selection 1126 While this is implemented already (it's basically the selection
1041 mechanism), it could be extended by displaying a unicode character 1127 mechanism), it could be extended by displaying a unicode character
1042 map. 1128 map.
1043 1129
1044 * 5.4: Feedback method for identifying displayed characters for later 1130 * 5.4: Feedback method for identifying displayed characters for later
1045 input 1131 input
1132
1046 This method lets you display the unicode character code associated 1133 This method lets you display the unicode character code associated
1047 with characters already displayed. 1134 with characters already displayed.
1048 1135
1049 You enter this mode by holding down "Control" and "Shift" together, 1136 You enter this mode by holding down "Control" and "Shift" together,
1050 then pressing and holding the left mouse button and moving around. 1137 then pressing and holding the left mouse button and moving around.
… …
1059 1146
1060 With respect to conformance, rxvt-unicode is supposed to be compliant to 1147 With respect to conformance, rxvt-unicode is supposed to be compliant to
1061 both scenario A and B of ISO 14755, including part 5.2. 1148 both scenario A and B of ISO 14755, including part 5.2.
1062 1149
1063LOGIN STAMP 1150LOGIN STAMP
1064 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1151 urxvt tries to write an entry into the *utmp*(5) file so that it can be
1065 seen via the *who(1)* command, and can accept messages. To allow this 1152 seen via the *who(1)* command, and can accept messages. To allow this
1066 feature, rxvt may need to be installed setuid root on some systems or 1153 feature, urxvt may need to be installed setuid root on some systems or
1067 setgid to root or to some other group on others. 1154 setgid to root or to some other group on others.
1068 1155
1069COLORS AND GRAPHICS 1156COLORS AND GRAPHICS
1070 In addition to the default foreground and background colours, rxvt can 1157 In addition to the default foreground and background colours, urxvt can
1071 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1158 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1072 versions of the same). Here is a list of the colours with their rgb.txt 1159 versions of the same). Here is a list of the colours with their names.
1073 names.
1074 1160
1075 color0 (black) = Black 1161 color0 (black) = Black
1076 color1 (red) = Red3 1162 color1 (red) = Red3
1077 color2 (green) = Green3 1163 color2 (green) = Green3
1078 color3 (yellow) = Yellow3 1164 color3 (yellow) = Yellow3
1079 color4 (blue) = Blue3 1165 color4 (blue) = Blue3
1080 color5 (magenta) = Magenta3 1166 color5 (magenta) = Magenta3
1081 color6 (cyan) = Cyan3 1167 color6 (cyan) = Cyan3
1082 color7 (white) = AntiqueWhite 1168 color7 (white) = AntiqueWhite
1083 color8 (bright black) = Grey25 1169 color8 (bright black) = Grey25
1084 color9 (bright red) = Red 1170 color9 (bright red) = Red
1085 color10 (bright green) = Green 1171 color10 (bright green) = Green
1086 color11 (bright yellow) = Yellow 1172 color11 (bright yellow) = Yellow
1087 color12 (bright blue) = Blue 1173 color12 (bright blue) = Blue
1088 color13 (bright magenta) = Magenta 1174 color13 (bright magenta) = Magenta
1089 color14 (bright cyan) = Cyan 1175 color14 (bright cyan) = Cyan
1090 color15 (bright white) = White 1176 color15 (bright white) = White
1091 foreground = Black 1177 foreground = Black
1092 background = White 1178 background = White
1093
1094 It is also possible to specify the colour values of foreground, 1179 It is also possible to specify the colour values of foreground,
1095 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1180 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1096 0-15, as a convenient shorthand to reference the colour name of 1181 0-15, as a convenient shorthand to reference the colour name of
1097 color0-color15. 1182 color0-color15.
1098 1183
1184 In addition to the colours defined above, urxvt offers an additional 72
1185 colours. The first 64 of those (with indices 16 to 79) consist of a
1186 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1187 by 8 additional shades of gray (with indices 80 to 87).
1188
1189 Together, all those colours implement the 88 colour xterm colours. Only
1190 the first 16 can be changed using resources currently, the rest can only
1191 be changed via command sequences ("escape codes").
1192
1099 Note that -rv ("reverseVideo: True") simulates reverse video by always 1193 Note that -rv ("reverseVideo: True") simulates reverse video by always
1100 swapping the foreground/background colours. This is in contrast to 1194 swapping the foreground/background colours. This is in contrast to
1101 *xterm*(1) where the colours are only swapped if they have not otherwise 1195 *xterm*(1) where the colours are only swapped if they have not otherwise
1102 been specified. For example, 1196 been specified. For example,
1103 1197
1104 rxvt -fg Black -bg White -rv 1198 urxvt -fg Black -bg White -rv
1105 would yield White on Black, while on *xterm*(1) it would yield Black 1199 would yield White on Black, while on *xterm*(1) it would yield Black
1106 on White. 1200 on White.
1107 1201
1202 ALPHA CHANNEL SUPPORT
1203 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1204 get their act together, rxvt-unicode will support
1205 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1206 digits/component) colour specifications, in addition to the ones
1207 provided by X, where the additional A component specifies opacity
1208 (alpha) values. The minimum value of 0 is completely transparent). You
1209 can also prefix any color with "[a]", where "a" is on to four hex digits
1210 specifiying the opacity value.
1211
1212 You probably need to specify "-depth 32", too, and have the luck that
1213 your X-server uses ARGB pixel layout, as X is far from just supporting
1214 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1215
1216 For example, the following selects an almost completely transparent red
1217 background, and an almost opaque pink foreground:
1218
1219 urxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1220
1221 *Please note that transparency of any kind if completely unsupported by
1222 the author. Don't bug him with installation questions!*
1223
1108ENVIRONMENT 1224ENVIRONMENT
1109 rxvt sets and/or uses the following environment variables: 1225 urxvt sets and/or uses the following environment variables:
1110 1226
1111 TERM 1227 TERM
1112 Normally set to "rxvt-unicode", unless overwritten at configure 1228 Normally set to "rxvt-unicode", unless overwritten at configure
1113 time, via resources or on the commandline. 1229 time, via resources or on the commandline.
1114 1230
1115 COLORTERM 1231 COLORTERM
1116 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1232 Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled
1117 with XPM support, and optionally with the added extension "-mono" to 1233 with XPM support, and optionally with the added extension "-mono" to
1118 indicate that rxvt-unicode runs on a monochrome screen. 1234 indicate that rxvt-unicode runs on a monochrome screen.
1119 1235
1120 COLORFGBG 1236 COLORFGBG
1121 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1237 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1122 the colour code used as default foreground/text colour (or the 1238 the colour code used as default foreground/text colour (or the
1123 string "default" to indicate that the default-colour escape sequence 1239 string "default" to indicate that the default-colour escape sequence
1124 is to be used), "bg" is the colour code used as default background 1240 is to be used), "bg" is the colour code used as default background
1125 colour (or the string "default"), and "xpm" is the string "default" 1241 colour (or the string "default"), and "xpm" is the string "default"
1126 if rxvt was compiled with XPM support. Libraries like "ncurses" and 1242 if urxvt was compiled with XPM support. Libraries like "ncurses" and
1127 "slang" can (and do) use this information to optimize screen output. 1243 "slang" can (and do) use this information to optimize screen output.
1128 1244
1129 WINDOWID 1245 WINDOWID
1130 Set to the (decimal) X Window ID of the rxvt window (the toplevel 1246 Set to the (decimal) X Window ID of the urxvt window (the toplevel
1131 window, which usually has subwindows for the scrollbar, the terminal 1247 window, which usually has subwindows for the scrollbar, the terminal
1132 window and so on). 1248 window and so on).
1133 1249
1134 TERMINFO 1250 TERMINFO
1135 Set to the terminfo directory iff rxvt was configured with 1251 Set to the terminfo directory iff urxvt was configured with
1136 "--with-terminfo=PATH". 1252 "--with-terminfo=PATH".
1137 1253
1138 DISPLAY 1254 DISPLAY
1139 Used by rxvt to connect to the display and set to the correct 1255 Used by urxvt to connect to the display and set to the correct
1140 display in it's child processes. 1256 display in its child processes.
1141 1257
1142 SHELL 1258 SHELL
1143 The shell to be used for command execution, defaults to "/bin/sh". 1259 The shell to be used for command execution, defaults to "/bin/sh".
1144 1260
1145 RXVTPATH
1146 The path where rxvt looks for support files such as menu and xpm
1147 files.
1148
1149 PATH
1150 Used in the same way as "RXVTPATH".
1151
1152 RXVT_SOCKET 1261 RXVT_SOCKET
1153 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1262 The unix domain socket path used by urxvtc(1) and urxvtd(1).
1154 1263
1155 Default $HOME/.rxvt-unicode-*<nodename*. 1264 Default $HOME/.rxvt-unicode-*<nodename*.
1156 1265
1157 HOME 1266 HOME
1158 Used to locate the default directory for the unix domain socket for 1267 Used to locate the default directory for the unix domain socket for
… …
1162 XAPPLRESDIR 1271 XAPPLRESDIR
1163 Directory where various X resource files are being located. 1272 Directory where various X resource files are being located.
1164 1273
1165 XENVIRONMENT 1274 XENVIRONMENT
1166 If set and accessible, gives the name of a X resource file to be 1275 If set and accessible, gives the name of a X resource file to be
1167 loaded by rxvt. 1276 loaded by urxvt.
1168 1277
1169FILES 1278FILES
1170 /usr/lib/X11/rgb.txt 1279 /usr/lib/X11/rgb.txt
1171 Color names. 1280 Color names.
1172 1281
1173SEE ALSO 1282SEE ALSO
1174 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1283 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1),
1175 tty(4), utmp(5) 1284 pty(4), tty(4), utmp(5)
1176 1285
1177CURRENT PROJECT COORDINATOR 1286CURRENT PROJECT COORDINATOR
1178 Project Coordinator 1287 Project Coordinator
1179 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1288 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1180 1289
1181 <http://software.schmorp.de/#rxvt-unicode> 1290 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1182 1291
1183AUTHORS 1292AUTHORS
1184 John Bovey 1293 John Bovey
1185 University of Kent, 1992, wrote the original Xvt. 1294 University of Kent, 1992, wrote the original Xvt.
1186 1295
… …
1197 1306
1198 Oezguer Kesim <kesim@math.fu-berlin.de> 1307 Oezguer Kesim <kesim@math.fu-berlin.de>
1199 Project Coordinator (changes.txt 2.21a to 2.4.5) 1308 Project Coordinator (changes.txt 2.21a to 2.4.5)
1200 1309
1201 Geoff Wing <gcw@pobox.com> 1310 Geoff Wing <gcw@pobox.com>
1202 Rewrote screen display and text selection routines. Project 1311 Rewrote screen display and text selection routines.
1312
1203 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1313 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1204 1314
1205 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1315 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1206 Forked rxvt-unicode, rewrote most of the display code and internal 1316 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1207 character handling to store text in unicode, improve xterm 1317 perl extension, random hacks, numerous bugfixes and extensions.
1208 compatibility and apply numerous other bugfixes and extensions.
1209 1318
1210 Project Coordinator (Changes 1.0 -) 1319 Project Coordinator (Changes 1.0 -)
1211 1320
1321 Emanuele Giaquinta <e.giaquinta@glauco.it>
1322 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1323

Diff Legend

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