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.67 by root, Sun Jun 24 22:12:18 2007 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [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 8.2, 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 rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. That document is also 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
24 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
25 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
26 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
27 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devenagari. Don't expect pretty output when using
28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29 should work fine, though. A somewhat difficult case are left-to-right 29 should work fine, though. A somewhat difficult case are right-to-left
30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
32 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
33 otherwise), but that might change. 33 otherwise), but that might change.
34 34
35 If you are looking for a terminal that supports more exotic scripts, let 35 If you are looking for a terminal that supports more exotic scripts, let
36 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
37 terminal emulator. In fact, the reason rxvt-unicode was born was solely 37 terminal emulator. In fact, the reason rxvt-unicode was born was solely
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
42 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
43 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
44 able to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 it's predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
48 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot bugs less than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of it's features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(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 rxvt(7) for technical reference 61 been extended) more accessible: see rxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The rxvt 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
… …
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.
94 98
95 -j|+j 99 -j|+j
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling (allow multiple lines per refresh);
101 resource jumpScroll.
102
103 -ss|+ss
104 Turn on/off skip scrolling (allow multiple screens per refresh);
105 resource skipScroll.
97 106
98 -ip|+ip | -tr|+tr 107 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 108 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 109 -tr; resource inheritPixmap.
110
111 *Please note that transparency of any kind if completely unsupported
112 by the author. Don't bug him with installation questions! Read the
113 FAQ (man 7 rxvt)!*
101 114
102 -fade *number* 115 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 116 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 117 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 118 the fade colour; resource fading.
106 119
107 -fadecolor *colour* 120 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 121 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 122 colour is opaque black. resource fadeColor.
110 123
111 -tint *colour* 124 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 125 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 126 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 127 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; 128 be used to brighten or darken the image in addition to tinting it;
116 resource *tintColor*. Example: 129 resource *tintColor*. Example:
117 130
118 rxvt -tr -tint blue -sh 40 131 rxvt -tr -tint blue -sh 40
119 132
133 -sh *number*
120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 134 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
121 background image in addition to tinting it (i.e. -tint must be 135 image in addition to (or instead of) tinting it; resource *shading*.
122 specified, too, e.g. "-tint white"). 136
137 -blt *string*
138 Specify background blending type. If background pixmap is specified
139 at the same time as transparency - such pixmap will be blended over
140 transparency image, using method specified. Supported values are :
141 add, alphablend, allanon - color values averaging, colorize, darken,
142 diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
143 value. The default is alpha-blending; resource *blendType*.
144
145 -blr *number*
146 Apply Gaussian Blur with the specified radius to the transparent
147 background image; resource *blurRadius*.
123 148
124 -bg *colour* 149 -bg *colour*
125 Window background colour; resource background. 150 Window background colour; resource background.
126 151
127 -fg *colour* 152 -fg *colour*
128 Window foreground colour; resource foreground. 153 Window foreground colour; resource foreground.
129 154
130 -pixmap *file[;geom]* 155 -pixmap *file[;geom]*
131 Compile *XPM*: Specify XPM file for the background and also 156 Compile *afterimage*: Specify image file for the background and also
132 optionally specify its scaling with a geometry string. Note you may 157 optionally specify its scaling with a geometry string. Note you may
133 need to add quotes to avoid special shell interpretation of the ";" 158 need to add quotes to avoid special shell interpretation of the ";"
134 in the command-line; resource backgroundPixmap. 159 in the command-line; for more details see resource backgroundPixmap.
135 160
136 -cr *colour* 161 -cr *colour*
137 The cursor colour; resource cursorColor. 162 The cursor colour; resource cursorColor.
138 163
139 -pr *colour* 164 -pr *colour*
… …
146 The colour of the border around the text area and between the 171 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 172 scrollbar and the text; resource borderColor.
148 173
149 -fn *fontlist* 174 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 175 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 176 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 177 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 178 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 179 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 180 See resource font for more details.
156 181
157 In short, to specify an X11 core font, just specify it's name or 182 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 183 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 184 with "xft:", e.g.:
160 185
161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 186 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 187 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 188
164 See also the question "How does rxvt-unicode choose fonts?" in the 189 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of rxvt(7). 190 FAQ section of rxvt(7).
166 191
167 -fb *fontlist* 192 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 193 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 194 characters are to be printed. See resource boldFont for details.
170 195
171 -fi *fontlist* 196 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 197 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 198 characters are to be printed. See resource italicFont for details.
174 199
175 -fbi *fontlist* 200 -fbi *fontlist*
176 Compile font-styles: The bold italic font list to use when bold 201 Compile *font-styles*: The bold italic font list to use when *bold
177 characters are to be printed. See resource boldItalicFont for 202 italic* characters are to be printed. See resource boldItalicFont
178 details. 203 for details.
179 204
180 -is|+is 205 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity 206 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for 207 foreground/background (default). See resource intensityStyles for
183 details. 208 details.
184 209
185 -name *name* 210 -name *name*
186 Specify the application name under which resources are to be 211 Specify the application name under which resources are to be
… …
251 externalBorder. 276 externalBorder.
252 277
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 278 -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 279 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 280 decorations; resource borderLess.
281
282 -override-redirect
283 Compile *frills*: Sets override-redirect on the window; resource
284 override-redirect.
285
286 -sbg
287 Compile *frills*: Disable the usage of the built-in block
288 graphics/line drawing characters and just rely on what the specified
289 fonts provide. Use this if you have a good font and want to use its
290 block graphic glyphs; resource skipBuiltinGlyphs.
256 291
257 -lsp *number* 292 -lsp *number*
258 Compile *frills*: Lines (pixel height) to insert between each row of 293 Compile *frills*: Lines (pixel height) to insert between each row of
259 the display. Useful to work around font rendering problems; resource 294 the display. Useful to work around font rendering problems; resource
260 linespace. 295 linespace.
… …
309 Set the font set to use for the X Input Method, see resource imFont 344 Set the font set to use for the X Input Method, see resource imFont
310 for more info. 345 for more info.
311 346
312 -tcw 347 -tcw
313 Change the meaning of triple-click selection with the left mouse 348 Change the meaning of triple-click selection with the left mouse
349 button. Only effective when the original (non-perl) selection code
314 button. Instead of selecting a full line it will extend the 350 is in-use. Instead of selecting a full line it will extend the
315 selection the end of the logical line only. resource 351 selection the end of the logical line only. resource
316 tripleclickwords. 352 tripleclickwords.
317 353
318 -insecure 354 -insecure
319 Enable "insecure" mode, which currently enables most of the escape 355 Enable "insecure" mode, which currently enables most of the escape
… …
340 376
341 -keysym.*sym* *string* 377 -keysym.*sym* *string*
342 Remap a key symbol. See resource keysym. 378 Remap a key symbol. See resource keysym.
343 379
344 -embed *windowid* 380 -embed *windowid*
345 Tells rxvt to embed it's windows into an already-existing window, 381 Tells rxvt to embed its windows into an already-existing window,
346 which enables applications to easily embed a terminal. 382 which enables applications to easily embed a terminal.
347 383
348 Right now, rxvt will first unmap/map the specified window, so it 384 Right now, rxvt will first unmap/map the specified window, so it
349 shouldn't be a top-level window. rxvt will also reconfigure it quite 385 shouldn't be a top-level window. rxvt will also reconfigure it quite
350 a bit, so don't expect it to keep some specific state. It's best to 386 a bit, so don't expect it to keep some specific state. It's best to
… …
353 The window will not be destroyed when rxvt exits. 389 The window will not be destroyed when rxvt exits.
354 390
355 It might be useful to know that rxvt will not close file descriptors 391 It might be useful to know that rxvt will not close file descriptors
356 passed to it (except for stdin/out/err, of course), so you can use 392 passed to it (except for stdin/out/err, of course), so you can use
357 file descriptors to communicate with the programs within the 393 file descriptors to communicate with the programs within the
358 terminal. This works regardless of wether the "-embed" option was 394 terminal. This works regardless of whether the "-embed" option was
359 used or not. 395 used or not.
360 396
361 Here is a short Gtk2-perl snippet that illustrates how this option 397 Here is a short Gtk2-perl snippet that illustrates how this option
362 can be used (a longer example is in doc/embed): 398 can be used (a longer example is in doc/embed):
363 399
… …
365 $rxvt->signal_connect_after (realize => sub { 401 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid; 402 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &"; 403 system "rxvt -embed $xid &";
368 }); 404 });
369 405
370 -pty-fd *fileno* 406 -pty-fd *file descriptor*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair 407 Tells rxvt 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 408 but instead use the given file descriptor as the tty master. This is
373 useful if you want to drive rxvt as a generic terminal emulator 409 useful if you want to drive rxvt as a generic terminal emulator
374 without having to run a program within it. 410 without having to run a program within it.
375 411
376 If this switch is given, rxvt will not create any utmp/wtmp entries 412 If this switch is given, rxvt will not create any utmp/wtmp entries
377 and will not tinker with pty/tty permissions - you have to do that 413 and will not tinker with pty/tty permissions - you have to do that
378 yourself if you want that. 414 yourself if you want that.
415
416 As an extremely special case, specifying -1 will completely suppress
417 pty/tty operations.
379 418
380 Here is a example in perl that illustrates how this option can be 419 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd): 420 used (a longer example is in doc/pty-fd):
382 421
383 use IO::Pty; 422 use IO::Pty;
… …
391 # now communicate with rxvt 430 # now communicate with rxvt
392 my $slave = $pty->slave; 431 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" } 432 while (<$slave>) { print $slave "got <$_>\n" }
394 433
395 -pe *string* 434 -pe *string*
396 Colon-separated list of perl extension scripts to use in this 435 Comma-separated list of perl extension scripts to use (or not to
397 terminal instance. See resource perl-ext. 436 use) in this terminal instance. See resource perl-ext for details.
398 437
399RESOURCES (available also as long-options) 438RESOURCES (available also as long-options)
400 Note: `rxvt --help' gives a list of all resources (long options) 439 Note: `rxvt --help' gives a list of all resources (long options)
401 compiled into your version. 440 compiled into your version.
402 441
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 442 You can set and change the resources using X11 tools like xrdb. Many
407 xrdb. Many distribution do also load settings from the ~/.Xresources 443 distribution do also load settings from the ~/.Xresources file when X
408 file when X starts. rxvt will consult the following files/resources in 444 starts. rxvt will consult the following files/resources in order, with
409 order, with later settings overwriting earlier ones: 445 later settings overwriting earlier ones:
410 446
411 1. system-wide app-defaults file, either locale-dependent OR global 447 1. system-wide app-defaults file, either locale-dependent OR global
412 2. app-defaults file in $XAPPLRESDIR 448 2. app-defaults file in $XAPPLRESDIR
413 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 449 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
414 4. SCREEN_RESOURCES for the current screen 450 4. SCREEN_RESOURCES for the current screen
415 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 451 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
416 452
417 If compiled with internal Xresources support (i.e. rxvt -h lists 453 Note that when reading X resources, rxvt recognizes two class names:
418 .Xdefaults) then rxvt accepts application defaults set in 454 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
419 XAPPLOADDIR/URxvt (compile-time defined: usually 455 and the original *rxvt* to be easily configured, while the class name
420 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 456 URxvt allows resources unique to rxvt, to be shared between different
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 457 rxvt configurations. If no resources are specified, suitable defaults
427 defaults will be used. Command-line arguments can be used to override 458 will be used. Command-line arguments can be used to override resource
428 resource settings. The following resources are allowed: 459 settings. The following resources are supported (you might want to check
460 the rxvtperl(3) manpage for additional settings by perl extensions not
461 documented here):
462
463 depth: *bitdepth*
464 Compile *xft*: Attempt to find a visual with the given bit depth;
465 option -depth.
429 466
430 geometry: *geom* 467 geometry: *geom*
431 Create the window with the specified X window geometry [default 468 Create the window with the specified X window geometry [default
432 80x24]; option -geometry. 469 80x24]; option -geometry.
433 470
… …
465 Use the specified colour to display underlined characters when the 502 Use the specified colour to display underlined characters when the
466 foreground colour is the default. 503 foreground colour is the default.
467 504
468 colorRV: *colour* 505 colorRV: *colour*
469 Use the specified colour as the background for reverse video 506 Use the specified colour as the background for reverse video
470 characters. 507 characters when OPTION_HC is disabled (--disable-frills).
471 508
472 underlineColor: *colour* 509 underlineColor: *colour*
473 If set, use the specified colour as the colour for the underline 510 If set, use the specified colour as the colour for the underline
474 itself. If unset, use the foreground colour. 511 itself. If unset, use the foreground colour.
475 512
… …
486 True: simulate reverse video by foreground and background colours; 523 True: simulate reverse video by foreground and background colours;
487 option -rv. False: regular screen colours [default]; option +rv. See 524 option -rv. False: regular screen colours [default]; option +rv. See
488 note in COLORS AND GRAPHICS section. 525 note in COLORS AND GRAPHICS section.
489 526
490 jumpScroll: *boolean* 527 jumpScroll: *boolean*
491 True: specify that jump scrolling should be used. When scrolling 528 True: specify that jump scrolling should be used. When receiving
492 quickly, fewer screen updates are performed [default]; option -j. 529 lots of lines, rxvt will only scroll once a whole screen height of
530 lines has been read, resulting in fewer updates while still
531 displaying every received line; option -j.
532
493 False: specify that smooth scrolling should be used; option +j. 533 False: specify that smooth scrolling should be used. rxvt will force
534 a screen refresh on each new line it received; option +j.
535
536 skipScroll: *boolean*
537 True: (the default) specify that skip scrolling should be used. When
538 receiving lots of lines, rxvt will only scroll once in a while
539 (around 60 times per second), resulting in far fewer updates. This
540 can result in rxvt not ever displaying some of the lines it
541 receives; option -ss.
542
543 False: specify that everything is to be displayed, even if the
544 refresh is too fast for the human eye to read anything (or the
545 monitor to display anything); option +ss.
494 546
495 inheritPixmap: *boolean* 547 inheritPixmap: *boolean*
496 True: make the background inherit the parent windows' pixmap, giving 548 True: make the background inherit the parent windows' pixmap, giving
497 artificial transparency. False: do not inherit the parent windows' 549 artificial transparency. False: do not inherit the parent windows'
498 pixmap. 550 pixmap.
499 551
552 *Please note that transparency of any kind if completely unsupported
553 by the author. Don't bug him with installation questions!*
554
500 fading: *number* 555 fading: *number*
501 Fade the text by the given percentage when focus is lost; option 556 Fade the text by the given percentage when focus is lost; option
502 -fade. 557 -fade.
503 558
504 fadeColor: *colour* 559 fadeColor: *colour*
… …
509 Tint the transparent background pixmap with the given colour; option 564 Tint the transparent background pixmap with the given colour; option
510 -tint. 565 -tint.
511 566
512 shading: *number* 567 shading: *number*
513 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 568 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
514 image in addition to tinting it. 569 image in addition to tinting it; option -sh.
570
571 blendType: *string*
572 Specify background blending type; option -blt.
573
574 blurRadius: *number*
575 Apply Gaussian Blurr with the specified radius to the transparent
576 background image; option -blr.
515 577
516 scrollColor: *colour* 578 scrollColor: *colour*
517 Use the specified colour for the scrollbar [default #B2B2B2]. 579 Use the specified colour for the scrollbar [default #B2B2B2].
518 580
519 troughColor: *colour* 581 troughColor: *colour*
… …
523 borderColor: *colour* 585 borderColor: *colour*
524 The colour of the border around the text area and between the 586 The colour of the border around the text area and between the
525 scrollbar and the text. 587 scrollbar and the text.
526 588
527 backgroundPixmap: *file[;geom]* 589 backgroundPixmap: *file[;geom]*
528 Use the specified XPM file (note the `.xpm' extension is optional) 590 Use the specified image file for the background and also optionally
529 for the background and also optionally specify its scaling with a 591 specify its scaling with a geometry string WxH+X+Y, in which "W" /
530 geometry string WxH+X+Y, in which "W" / "H" specify the
531 horizontal/vertical scale (percent) and "X" / "Y" locate the image 592 "H" specify the horizontal/vertical scale (percent), and "X" / "Y"
532 centre (percent). A scale of 0 displays the image with tiling. A 593 locate the image centre (percent). A scale of 0 displays the image
533 scale of 1 displays the image without any scaling. A scale of 2 to 9 594 with tiling. A scale of 1 displays the image without any scaling. A
534 specifies an integer number of images in that direction. No image 595 scale of 2 to 9 specifies an integer number of images in that
535 will be magnified beyond 10 times its original size. The maximum 596 direction. No image will be magnified beyond 10 times its original
536 permitted scale is 1000. [default 0x0+50+50] 597 size. The maximum permitted scale is 1000. Special string of "auto"
537 598 used as a geometry will cause image to be automatically scaled to
538 menu: *file[;tag]* 599 match window size. If used in conjunction with -tr option -
539 Read in the specified menu file (note the `.menu' extension is 600 specified pixmap will be blended over transparency image using
540 optional) and also optionally specify a starting tag to find. See 601 either alpha-blending, or any other blending type, specified with
541 the reference documentation for details on the syntax for the 602 -blt "type" option. [default 0x0+50+50]
542 menuBar.
543 603
544 path: *path* 604 path: *path*
545 Specify the colon-delimited search path for finding files (XPM and 605 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 606
549 font: *fontlist* 607 font: *fontlist*
550 Select the fonts to be used. This is a comma separated list of font 608 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 609 names that are checked in order when trying to find glyphs for
552 characters. The first font defines the cell size for characters; 610 characters. The first font defines the cell size for characters;
553 other fonts might be smaller, but not larger. A reasonable default 611 other fonts might be smaller, but not (in general) larger. A
554 font list is always appended to it; option -fn. 612 (hopefully) reasonable default font list is always appended to it;
613 option -fn.
555 614
556 Each font can either be a standard X11 core font (XLFD) name, with 615 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 616 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
558 "xft:". 617 "xft:".
559 618
… …
562 available hint currently is "codeset=codeset-name", and this is only 621 available hint currently is "codeset=codeset-name", and this is only
563 used for Xft fonts. 622 used for Xft fonts.
564 623
565 For example, this font resource 624 For example, this font resource
566 625
567 URxvt*font: 9x15bold,\ 626 URxvt.font: 9x15bold,\
568 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 627 -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, \ 628 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
570 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 629 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
571 xft:Code2000:antialias=false 630 xft:Code2000:antialias=false
572 631
… …
608 normal text font will being used for the given style. 667 normal text font will being used for the given style.
609 668
610 intensityStyles: *boolean* 669 intensityStyles: *boolean*
611 When font styles are not enabled, or this option is enabled (True, 670 When font styles are not enabled, or this option is enabled (True,
612 option -is, the default), bold and italic font styles imply high 671 option -is, the default), bold and italic font styles imply high
613 intensity foreground/backround colours. Disabling this option 672 intensity foreground/background colours. Disabling this option
614 (False, option +is) disables this behaviour, the high intensity 673 (False, option +is) disables this behaviour, the high intensity
615 colours are not reachable. 674 colours are not reachable.
616 675
617 selectstyle: *mode* 676 selectstyle: *mode*
618 Set mouse selection style to old which is 2.20, oldword which is 677 Set mouse selection style to old which is 2.20, oldword which is
619 xterm style with 2.20 old word selection, or anything else which 678 xterm style with 2.20 old word selection, or anything else which
620 gives xterm style selection. 679 gives xterm style selection. Only effective when the original
680 (non-perl) selection code is in use.
621 681
622 scrollstyle: *mode* 682 scrollstyle: *mode*
623 Set scrollbar style to rxvt, plain, next or xterm. plain is the 683 Set scrollbar style to rxvt, plain, next or xterm. plain is the
624 author's favourite. 684 author's favourite.
625 685
… …
635 695
636 mapAlert: *boolean* 696 mapAlert: *boolean*
637 True: de-iconify (map) on receipt of a bell character. False: no 697 True: de-iconify (map) on receipt of a bell character. False: no
638 de-iconify (map) on receipt of a bell character [default]. 698 de-iconify (map) on receipt of a bell character [default].
639 699
700 urgentOnBell: *boolean*
701 True: set the urgency hint for the wm on receipt of a bell
702 character. False: do not set the urgency hint [default].
703
640 visualBell: *boolean* 704 visualBell: *boolean*
641 True: use visual bell on receipt of a bell character; option -vb. 705 True: use visual bell on receipt of a bell character; option -vb.
642 False: no visual bell [default]; option +vb. 706 False: no visual bell [default]; option +vb.
643 707
644 loginShell: *boolean* 708 loginShell: *boolean*
… …
658 722
659 The string will be interpreted as if typed into the shell as-is. 723 The string will be interpreted as if typed into the shell as-is.
660 724
661 Example: 725 Example:
662 726
663 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 727 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
664 728
665 This creates a new file in your home directory with the screen 729 This creates a new file in your home directory with the screen
666 contents everytime you hit "Print". 730 contents every time you hit "Print".
667 731
668 scrollBar: *boolean* 732 scrollBar: *boolean*
669 True: enable the scrollbar [default]; option -sb. False: disable the 733 True: enable the scrollbar [default]; option -sb. False: disable the
670 scrollbar; option +sb. 734 scrollbar; option +sb.
671 735
… …
686 do not scroll to bottom when tty receives output; option +si. 750 do not scroll to bottom when tty receives output; option +si.
687 751
688 scrollWithBuffer: *boolean* 752 scrollWithBuffer: *boolean*
689 True: scroll with scrollback buffer when tty receives new lines (and 753 True: scroll with scrollback buffer when tty receives new lines (and
690 scrollTtyOutput is False); option -sw. False: do not scroll with 754 scrollTtyOutput is False); option -sw. False: do not scroll with
691 scrollback buffer when tty recieves new lines; option +sw. 755 scrollback buffer when tty receives new lines; option +sw.
692 756
693 scrollTtyKeypress: *boolean* 757 scrollTtyKeypress: *boolean*
694 True: scroll to bottom when a non-special key is pressed. Special 758 True: scroll to bottom when a non-special key is pressed. Special
695 keys are those which are intercepted by rxvt-unicode for special 759 keys are those which are intercepted by rxvt-unicode for special
696 handling and are not passed onto the shell; option -sk. False: do 760 handling and are not passed onto the shell; option -sk. False: do
… …
711 borderLess: *boolean* 775 borderLess: *boolean*
712 Set MWM hints to request a borderless window, i.e. if honoured by 776 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; 777 the WM, the rxvt-unicode window will not have window decorations;
714 option -bl. 778 option -bl.
715 779
780 skipBuiltinGlyphs: *boolean*
781 Compile *frills*: Disable the usage of the built-in block
782 graphics/line drawing characters and just rely on what the specified
783 fonts provide. Use this if you have a good font and want to use its
784 block graphic glyphs; option -sbg.
785
716 termName: *termname* 786 termName: *termname*
717 Specifies the terminal type name to be set in the TERM environment 787 Specifies the terminal type name to be set in the TERM environment
718 variable; option -tn. 788 variable; option -tn.
719 789
720 linespace: *number* 790 linespace: *number*
… …
763 The string to send when the delete key (not the keypad delete key) 833 The string to send when the delete key (not the keypad delete key)
764 is pressed. If unset it will send the sequence traditionally 834 is pressed. If unset it will send the sequence traditionally
765 associated with the Execute key. 835 associated with the Execute key.
766 836
767 cutchars: *string* 837 cutchars: *string*
768 The characters used as delimiters for double-click word selection. 838 The characters used as delimiters for double-click word selection
769 The built-in default: 839 (whitespace delimiting is added automatically if resource is given).
840
841 When the perl selection extension is in use (the default if compiled
842 in, see the rxvtperl(3) manpage), a suitable regex using these
843 characters will be created (if the resource exists, otherwise, no
844 regex will be created). In this mode, characters outside ISO-8859-1
845 can be used.
846
847 When the selection extension is not used, only ISO-8859-1 characters
848 can be used. If not specified, the built-in default is used:
770 849
771 BACKSLASH `"'&()*,;<=>?@[]{|} 850 BACKSLASH `"'&()*,;<=>?@[]{|}
772 851
773 preeditType: *style* 852 preeditType: *style*
774 OverTheSpot, OffTheSpot, Root; option -pt. 853 OverTheSpot, OffTheSpot, Root; option -pt.
… …
805 xterm, have these sequences enabled by default, which doesn't make 884 xterm, have these sequences enabled by default, which doesn't make
806 it safer, though). 885 it safer, though).
807 886
808 You can enable them by setting this boolean resource or specifying 887 You can enable them by setting this boolean resource or specifying
809 -insecure as an option. At the moment, this enables display-answer, 888 -insecure as an option. At the moment, this enables display-answer,
810 locale, findfont, icon label and window title requests as well as 889 locale, findfont, icon label and window title requests.
811 dynamic menubar dispatch.
812 890
813 modifier: *modifier* 891 modifier: *modifier*
814 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 892 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
815 super, mod1, mod2, mod3, mod4, mod5; option -mod. 893 super, mod1, mod2, mod3, mod4, mod5; option -mod.
816 894
817 answerbackString: *string* 895 answerbackString: *string*
818 Specify the reply rxvt-unicode sends to the shell when an ENQ 896 Specify the reply rxvt-unicode sends to the shell when an ENQ
819 (control-E) character is passed through. It may contain escape 897 (control-E) character is passed through. It may contain escape
820 values as described in the entry on keysym following. 898 values as described in the entry on keysym following.
821 899
822 secondaryScreen: *bool* 900 secondaryScreen: *boolean*
823 Turn on/off secondary screen (default enabled). 901 Turn on/off secondary screen (default enabled).
824 902
825 secondaryScroll: *bool* 903 secondaryScroll: *boolean*
826 Turn on/off secondary screen scroll (default enabled). If the this 904 Turn on/off secondary screen scroll (default enabled). If this
827 option is enabled, scrolls on the secondary screen will change the 905 option is enabled, scrolls on the secondary screen will change the
828 scrollback buffer and switching to/from the secondary screen will 906 scrollback buffer and switching to/from the secondary screen will
829 instead scroll the screen up. 907 instead scroll the screen up.
830 908
831 hold: *bool* 909 hold: *boolean*
832 Turn on/off hold window after exit support. If enabled, rxvt will 910 Turn on/off hold window after exit support. If enabled, rxvt will
833 not immediately destroy its window when the program executed within 911 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 912 it exits. Instead, it will wait till it is being killed or closed by
835 the user. 913 the user.
836 914
… …
857 935
858 *string* may contain escape values ("\a": bell, "\b": backspace, 936 *string* may contain escape values ("\a": bell, "\b": backspace,
859 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 937 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
860 "\000": octal number) or verbatim control characters ("^?": delete, 938 "\000": octal number) or verbatim control characters ("^?": delete,
861 "^@": null, "^A" ...) and may be enclosed with double quotes so that 939 "^@": null, "^A" ...) and may be enclosed with double quotes so that
862 it can start or end with whitespace. 940 it can start or end with whitespace. This feature is deprecated and
941 will be removed.
863 942
864 Please note that you need to double the "\" when using 943 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 944 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 945 "\e" (and so on), which will work with both Xt and rxvt's own
867 both Xt and rxvt's own processing). 946 processing).
868 947
869 You can define a range of keysyms in one shot by providing a 948 You can define a range of keysyms in one shot by providing a
870 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 949 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
871 `/' should be a character not used by the strings. 950 `/' should be a character not used by the strings.
872 951
873 Its usage can be demonstrated by an example: 952 Its usage can be demonstrated by an example:
874 953
875 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 954 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
924 info): 1003 info):
925 1004
926 URxvt.keysym.M-C-3: command:\033[8;25;80t 1005 URxvt.keysym.M-C-3: command:\033[8;25;80t
927 URxvt.keysym.M-C-4: command:\033[8;48;110t 1006 URxvt.keysym.M-C-4: command:\033[8;48;110t
928 1007
1008 perl-ext-common: *string*
929 perl-ext: *string* 1009 perl-ext: *string*
930 Colon-separated list of perl extension scripts to use in this 1010 Comma-separated list(s) of perl extension scripts (default:
931 terminal instance. Each extension is looked up in the library 1011 "default") to use in this terminal instance; option -pe.
1012
1013 Extension names can be prefixed with a "-" sign to prohibit using
1014 them. This can be useful to selectively disable some extensions
1015 loaded by default, or specified via the "perl-ext-common" resource.
1016 For example, "default,-selection" will use all the default extension
1017 except "selection".
1018
1019 Extension names can also be followed by an argument in angle
1020 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
1021 for searchable scrollback to Alt/Meta-s). Mentioning the same
1022 extension multiple times with different arguments will pass multiple
1023 arguments to the extension.
1024
1025 Each extension is looked up in the library directories, loaded if
932 directories, loaded if necessary, and bound to the current terminal 1026 necessary, and bound to the current terminal instance.
933 instance. If this resource is empty or missing, then the perl 1027
1028 If both of these resources are the empty string, then the perl
934 interpreter will not be initialized; option -pe. 1029 interpreter will not be initialized. The idea behind two options is
1030 that perl-ext-common will be used for extensions that should be
1031 available to all instances, while perl-ext is used for specific
1032 instances.
935 1033
936 perl-eval: *string* 1034 perl-eval: *string*
937 Perl code to be evaluated when all extensions have been registered. 1035 Perl code to be evaluated when all extensions have been registered.
938 See the rxvtperl(3) manpage. 1036 See the rxvtperl(3) manpage. Due to security reasons, this resource
1037 will be ignored when running setuid/setgid.
939 1038
940 perl-lib: *path* 1039 perl-lib: *path*
941 Colon-separated list of additional directories that hold extension 1040 Colon-separated list of additional directories that hold extension
942 scripts. When looking for extensions specified by the "perl" 1041 scripts. When looking for extensions specified by the "perl"
943 resource, rxvt will first look in these directories and then in 1042 resource, rxvt will first look in these directories and then in
944 /opt/rxvt/lib/urxvt/perl/. 1043 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
1044 will be ignored when running setuid/setgid.
945 1045
946 See the rxvtperl(3) manpage. 1046 See the rxvtperl(3) manpage.
1047
1048 selection.pattern-*idx*: *perl-regex*
1049 Additional selection patterns, see the rxvtperl(3) manpage for
1050 details.
1051
1052 selection-autotransform.*idx*: *perl-transform*
1053 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1054 details.
1055
1056 searchable-scrollback: *keysym*
1057 Sets the hotkey that starts the incremental scrollback buffer search
1058 (default: "M-s").
1059
1060 urlLauncher: *string*
1061 Specifies the program to be started with a URL argument. Used by the
1062 "selection-popup" and "matcher" perl extensions.
1063
1064 transient-for: *windowid*
1065 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1066 window id.
1067
1068 override-redirect: *boolean*
1069 Compile *frills*: Sets override-redirect for the terminal window,
1070 making it almost invisible to window managers; option
1071 -override-redirect.
1072
1073 iso14755_52: *boolean*
1074 Turn on/off ISO 14755 5.2 mode (default enabled).
947 1075
948THE SCROLLBAR 1076THE SCROLLBAR
949 Lines of text that scroll off the top of the rxvt window (resource: 1077 Lines of text that scroll off the top of the rxvt window (resource:
950 saveLines) and can be scrolled back using the scrollbar or by 1078 saveLines) and can be scrolled back using the scrollbar or by
951 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1079 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
965 disabled -- on the assumption that we are using a fullscreen 1093 disabled -- on the assumption that we are using a fullscreen
966 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ 1094 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
967 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the 1095 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
968 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. 1096 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
969 1097
970TEXT SELECTION AND INSERTION 1098THE SELECTION: SELECTING AND PASTING TEXT
971 The behaviour of text selection and insertion mechanism is similar to 1099 The behaviour of text selection and insertion/pasting mechanism is
972 *xterm*(1). 1100 similar to *xterm*(1).
973 1101
974 Selection: 1102 Selecting:
975 Left click at the beginning of the region, drag to the end of the 1103 Left click at the beginning of the region, drag to the end of the
976 region and release; Right click to extend the marked region; Left 1104 region and release; Right click to extend the marked region; Left
977 double-click to select a word; Left triple-click to select the 1105 double-click to select a word; Left triple-click to select the
978 entire logical line (which can span multiple screen lines), unless 1106 entire logical line (which can span multiple screen lines), unless
979 modified by resource tripleclickwords. 1107 modified by resource tripleclickwords.
… …
982 (Compile: *frills*) will create a rectangular selection instead of a 1110 (Compile: *frills*) will create a rectangular selection instead of a
983 normal one. In this mode, every selected row becomes its own line in 1111 normal one. In this mode, every selected row becomes its own line in
984 the selection, and trailing whitespace is visually underlined and 1112 the selection, and trailing whitespace is visually underlined and
985 removed from the selection. 1113 removed from the selection.
986 1114
987 Insertion: 1115 Pasting:
988 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1116 Pressing and releasing the Middle mouse button in an rxvt window
989 an rxvt window causes the current text selection to be inserted as 1117 causes the value of the PRIMARY selection (or CLIPBOARD with the
990 if it had been typed on the keyboard. 1118 Meta modifier) to be inserted as if it had been typed on the
1119 keyboard.
1120
1121 Pressing Shift-Insert causes the value of the PRIMARY selection to
1122 be inserted too.
991 1123
992CHANGING FONTS 1124CHANGING FONTS
993 Changing fonts (or font sizes, respectively) via the keypad is not yet 1125 Changing fonts (or font sizes, respectively) via the keypad is not yet
994 supported in rxvt-unicode. Bug me if you need this. 1126 supported in rxvt-unicode. Bug me if you need this.
995 1127
996 You can, however, switch fonts at runtime using escape sequences (and 1128 You can, however, switch fonts at runtime using escape sequences, e.g.:
997 therefore using the menubar), e.g.:
998 1129
999 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1130 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1131
1132 You can use keyboard shortcuts, too:
1133
1134 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1135 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1000 1136
1001 rxvt-unicode will automatically re-apply these fonts to the output so 1137 rxvt-unicode will automatically re-apply these fonts to the output so
1002 far. 1138 far.
1003 1139
1004ISO 14755 SUPPORT 1140ISO 14755 SUPPORT
… …
1028 This mode lets you input characters representing the keycap symbols 1164 This mode lets you input characters representing the keycap symbols
1029 of your keyboard, if representable in the current locale encoding. 1165 of your keyboard, if representable in the current locale encoding.
1030 1166
1031 Start by pressing "Control" and "Shift" together, then releasing 1167 Start by pressing "Control" and "Shift" together, then releasing
1032 them. The next special key (cursor keys, home etc.) you enter will 1168 them. The next special key (cursor keys, home etc.) you enter will
1033 not invoke it's usual function but instead will insert the 1169 not invoke its usual function but instead will insert the
1034 corresponding keycap symbol. The symbol will only be entered when 1170 corresponding keycap symbol. The symbol will only be entered when
1035 the key has been released, otherwise pressing e.g. "Shift" would 1171 the key has been released, otherwise pressing e.g. "Shift" would
1036 enter the symbol for "ISO Level 2 Switch", although your intention 1172 enter the symbol for "ISO Level 2 Switch", although your intention
1037 might have been to enter a reverse tab (Shift-Tab). 1173 might have been to enter a reverse tab (Shift-Tab).
1038 1174
… …
1067 setgid to root or to some other group on others. 1203 setgid to root or to some other group on others.
1068 1204
1069COLORS AND GRAPHICS 1205COLORS AND GRAPHICS
1070 In addition to the default foreground and background colours, rxvt can 1206 In addition to the default foreground and background colours, rxvt can
1071 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1207 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 1208 versions of the same). Here is a list of the colours with their names.
1073 names.
1074 1209
1075 color0 (black) = Black 1210 color0 (black) = Black
1076 color1 (red) = Red3 1211 color1 (red) = Red3
1077 color2 (green) = Green3 1212 color2 (green) = Green3
1078 color3 (yellow) = Yellow3 1213 color3 (yellow) = Yellow3
… …
1094 It is also possible to specify the colour values of foreground, 1229 It is also possible to specify the colour values of foreground,
1095 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1230 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1096 0-15, as a convenient shorthand to reference the colour name of 1231 0-15, as a convenient shorthand to reference the colour name of
1097 color0-color15. 1232 color0-color15.
1098 1233
1234 In addition to the colours defined above, rxvt offers an additional 72
1235 colours. The first 64 of those (with indices 16 to 79) consist of a
1236 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1237 by 8 additional shades of gray (with indices 80 to 87).
1238
1239 Together, all those colours implement the 88 colour xterm colours. Only
1240 the first 16 can be changed using resources currently, the rest can only
1241 be changed via command sequences ("escape codes").
1242
1099 Note that -rv ("reverseVideo: True") simulates reverse video by always 1243 Note that -rv ("reverseVideo: True") simulates reverse video by always
1100 swapping the foreground/background colours. This is in contrast to 1244 swapping the foreground/background colours. This is in contrast to
1101 *xterm*(1) where the colours are only swapped if they have not otherwise 1245 *xterm*(1) where the colours are only swapped if they have not otherwise
1102 been specified. For example, 1246 been specified. For example,
1103 1247
1104 rxvt -fg Black -bg White -rv 1248 rxvt -fg Black -bg White -rv
1105 would yield White on Black, while on *xterm*(1) it would yield Black 1249 would yield White on Black, while on *xterm*(1) it would yield Black
1106 on White. 1250 on White.
1107 1251
1252 ALPHA CHANNEL SUPPORT
1253 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1254 get their act together, rxvt-unicode will support
1255 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1256 digits/component) colour specifications, in addition to the ones
1257 provided by X, where the additional A component specifies opacity
1258 (alpha) values. The minimum value of 0 is completely transparent). You
1259 can also prefix any color with "[percent]", where "percent" is a decimal
1260 percentage (0-100) that specifies the opacity of the color, where 0 is
1261 completely transparent and 100 is completelxy opaque.
1262
1263 You probably need to specify "-depth 32", too, and have the luck that
1264 your X-server uses ARGB pixel layout, as X is far from just supporting
1265 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1266
1267 For example, the following selects an almost completely transparent red
1268 background, and an almost opaque pink foreground:
1269
1270 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1271
1272 *Please note that transparency of any kind if completely unsupported by
1273 the author. Don't bug him with installation questions!*
1274
1108ENVIRONMENT 1275ENVIRONMENT
1109 rxvt sets and/or uses the following environment variables: 1276 rxvt sets and/or uses the following environment variables:
1110 1277
1111 TERM 1278 TERM
1112 Normally set to "rxvt-unicode", unless overwritten at configure 1279 Normally set to "rxvt-unicode", unless overwritten at configure
1113 time, via resources or on the commandline. 1280 time, via resources or on the command line.
1114 1281
1115 COLORTERM 1282 COLORTERM
1116 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1283 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1117 with XPM support, and optionally with the added extension "-mono" to 1284 with XPM support, and optionally with the added extension "-mono" to
1118 indicate that rxvt-unicode runs on a monochrome screen. 1285 indicate that rxvt-unicode runs on a monochrome screen.
1119 1286
1120 COLORFGBG 1287 COLORFGBG
1121 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1288 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
… …
1135 Set to the terminfo directory iff rxvt was configured with 1302 Set to the terminfo directory iff rxvt was configured with
1136 "--with-terminfo=PATH". 1303 "--with-terminfo=PATH".
1137 1304
1138 DISPLAY 1305 DISPLAY
1139 Used by rxvt to connect to the display and set to the correct 1306 Used by rxvt to connect to the display and set to the correct
1140 display in it's child processes. 1307 display in its child processes.
1141 1308
1142 SHELL 1309 SHELL
1143 The shell to be used for command execution, defaults to "/bin/sh". 1310 The shell to be used for command execution, defaults to "/bin/sh".
1144
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 1311
1152 RXVT_SOCKET 1312 RXVT_SOCKET
1153 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1313 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1154 1314
1155 Default $HOME/.rxvt-unicode-*<nodename*. 1315 Default $HOME/.rxvt-unicode-*<nodename*.
… …
1176 1336
1177CURRENT PROJECT COORDINATOR 1337CURRENT PROJECT COORDINATOR
1178 Project Coordinator 1338 Project Coordinator
1179 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1339 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1180 1340
1181 <http://software.schmorp.de/#rxvt-unicode> 1341 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1182 1342
1183AUTHORS 1343AUTHORS
1184 John Bovey 1344 John Bovey
1185 University of Kent, 1992, wrote the original Xvt. 1345 University of Kent, 1992, wrote the original Xvt.
1186 1346
… …
1197 1357
1198 Oezguer Kesim <kesim@math.fu-berlin.de> 1358 Oezguer Kesim <kesim@math.fu-berlin.de>
1199 Project Coordinator (changes.txt 2.21a to 2.4.5) 1359 Project Coordinator (changes.txt 2.21a to 2.4.5)
1200 1360
1201 Geoff Wing <gcw@pobox.com> 1361 Geoff Wing <gcw@pobox.com>
1202 Rewrote screen display and text selection routines. Project 1362 Rewrote screen display and text selection routines.
1363
1203 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1364 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1204 1365
1205 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1366 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1206 Forked rxvt-unicode, rewrote most of the display code and internal 1367 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1207 character handling to store text in unicode, improve xterm 1368 perl extension, random hacks, numerous bugfixes and extensions.
1208 compatibility and apply numerous other bugfixes and extensions.
1209 1369
1210 Project Coordinator (Changes 1.0 -) 1370 Project Coordinator (Changes 1.0 -)
1211 1371
1372 Emanuele Giaquinta <e.giaquinta@glauco.it>
1373 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1374

Diff Legend

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