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.13 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.65 by root, Sat Feb 17 20:36:36 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 , is a colour vt102 terminal emulator intended as 9 rxvt-unicode, version 8.2, is a colour vt102 terminal emulator intended
10 an *xterm*(1) replacement for users who do not require features such as 10 as an *xterm*(1) replacement for users who do not require features such
11 Tektronix 4014 emulation and toolkit-style configurability. As a result, 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 rxvt-unicode uses much less swap space -- a significant advantage on a 12 result, rxvt-unicode uses much less swap space -- a significant
13 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; resource jumpScroll.
97 101
98 -ip|+ip 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.
101 105
106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions! Read the
108 FAQ (man 7 rxvt)!*
109
102 -fade *number* 110 -fade *number*
103 Fade the text by the given percentage when focus is lost. resource 111 Fade the text by the given percentage when focus is lost. Small
104 fading. 112 values fade a little only, 100 completely replaces all colours by
113 the fade colour; resource fading.
114
115 -fadecolor *colour*
116 Fade to this colour when fading is used (see -fade). The default
117 colour is opaque black. resource fadeColor.
105 118
106 -tint *colour* 119 -tint *colour*
107 Tint the transparent background pixmap with the given colour when 120 Tint the transparent background pixmap with the given colour when
108 transparency is enabled with -tr or -ip. See also the -sh option 121 transparency is enabled with -tr or -ip. This only works for
122 non-tiled backgrounds, currently. See also the -sh option that can
109 that can be used to brighten or darken the image in addition to 123 be used to brighten or darken the image in addition to tinting it;
110 tinting it. 124 resource *tintColor*. Example:
125
126 rxvt -tr -tint blue -sh 40
111 127
112 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 128 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
113 background image in addition to tinting it (i.e. -tint must be 129 background image in addition to tinting it (i.e. -tint must be
114 specified, too, e.g. "-tint white"). 130 specified, too, e.g. "-tint white"); resource *shading*.
115 131
116 -bg *colour* 132 -bg *colour*
117 Window background colour; resource background. 133 Window background colour; resource background.
118 134
119 -fg *colour* 135 -fg *colour*
… …
138 The colour of the border around the text area and between the 154 The colour of the border around the text area and between the
139 scrollbar and the text; resource borderColor. 155 scrollbar and the text; resource borderColor.
140 156
141 -fn *fontlist* 157 -fn *fontlist*
142 Select the fonts to be used. This is a comma separated list of font 158 Select the fonts to be used. This is a comma separated list of font
143 names that are used in turn when trying to display Unicode 159 names that are checked in order when trying to find glyphs for
144 characters. The first font defines the cell size for characters; 160 characters. The first font defines the cell size for characters;
145 other fonts might be smaller, but not (in general) larger. A 161 other fonts might be smaller, but not (in general) larger. A
146 (hopefully) reasonable default font list is always appended to it. 162 (hopefully) reasonable default font list is always appended to it.
147 See resource font for more details. 163 See resource font for more details.
148 164
149 In short, to specify an X11 core font, just specify it's name or 165 In short, to specify an X11 core font, just specify its name or
150 prefix it with "x:". To specify an XFT-font, you need to prefix it 166 prefix it with "x:". To specify an XFT-font, you need to prefix it
151 with "xft:", e.g.: 167 with "xft:", e.g.:
152 168
153 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 169 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
154 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 170 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
155 171
156 See also the question "How does rxvt-unicode choose fonts?" in the 172 See also the question "How does rxvt-unicode choose fonts?" in the
157 FAQ section of rxvt(7). 173 FAQ section of rxvt(7).
158 174
159 -fb *fontlist* 175 -fb *fontlist*
160 Compile font-styles: The bold font list to use when bold characters 176 Compile *font-styles*: The bold font list to use when bold
161 are to be printed. See resource boldFont for details. 177 characters are to be printed. See resource boldFont for details.
162 178
163 -fi *fontlist* 179 -fi *fontlist*
164 Compile font-styles: The italic font list to use when bold 180 Compile *font-styles*: The italic font list to use when *italic*
165 characters are to be printed. See resource italicFont for details. 181 characters are to be printed. See resource italicFont for details.
166 182
167 -fbi *fontlist* 183 -fbi *fontlist*
168 Compile font-styles: The bold italic font list to use when bold 184 Compile *font-styles*: The bold italic font list to use when *bold
169 characters are to be printed. See resource boldItalicFont for 185 italic* characters are to be printed. See resource boldItalicFont
186 for details.
187
188 -is|+is
189 Compile *font-styles*: Bold/Italic font styles imply high intensity
190 foreground/background (default). See resource intensityStyles for
170 details. 191 details.
171 192
172 -name *name* 193 -name *name*
173 Specify the application name under which resources are to be 194 Specify the application name under which resources are to be
174 obtained, rather than the default executable file name. Name should 195 obtained, rather than the default executable file name. Name should
… …
204 225
205 -sr|+sr 226 -sr|+sr
206 Put scrollbar on right/left; resource scrollBar_right. 227 Put scrollbar on right/left; resource scrollBar_right.
207 228
208 -st|+st 229 -st|+st
209 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 230 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
210 resource scrollBar_floating. 231 resource scrollBar_floating.
211 232
212 -ptab|+ptab 233 -ptab|+ptab
213 If enabled (default), "Horizontal Tab" characters are being stored 234 If enabled (default), "Horizontal Tab" characters are being stored
214 as actual wide characters in the screen buffer, which makes it 235 as actual wide characters in the screen buffer, which makes it
… …
238 externalBorder. 259 externalBorder.
239 260
240 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 261 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
241 if honoured by the WM, the rxvt-unicode window will not have window 262 if honoured by the WM, the rxvt-unicode window will not have window
242 decorations; resource borderLess. 263 decorations; resource borderLess.
264
265 -override-redirect
266 Compile *frills*: Sets override-redirect on the window; resource
267 override-redirect.
268
269 -sbg
270 Compile *frills*: Disable the usage of the built-in block
271 graphics/line drawing characters and just rely on what the specified
272 fonts provide. Use this if you have a good font and want to use its
273 block graphic glyphs; resource skipBuiltinGlyphs.
243 274
244 -lsp *number* 275 -lsp *number*
245 Compile *frills*: Lines (pixel height) to insert between each row of 276 Compile *frills*: Lines (pixel height) to insert between each row of
246 the display. Useful to work around font rendering problems; resource 277 the display. Useful to work around font rendering problems; resource
247 linespace. 278 linespace.
… …
259 on the command line. If this option is used, it must be the last on 290 on the command line. If this option is used, it must be the last on
260 the command-line. If there is no -e option then the default is to 291 the command-line. If there is no -e option then the default is to
261 run the program specified by the SHELL environment variable or, 292 run the program specified by the SHELL environment variable or,
262 failing that, *sh(1)*. 293 failing that, *sh(1)*.
263 294
295 Please note that you must specify a program with arguments. If you
296 want to run shell commands, you have to specify the shell, like
297 this:
298
299 rxvt -e sh -c "shell commands"
300
264 -title *text* 301 -title *text*
265 Window title (-T still respected); the default title is the basename 302 Window title (-T still respected); the default title is the basename
266 of the program specified after the -e option, if any, otherwise the 303 of the program specified after the -e option, if any, otherwise the
267 application name; resource title. 304 application name; resource title.
268 305
… …
311 348
312 -ssr|+ssr 349 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 350 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 351 secondaryScroll.
315 352
353 -hold|+hold
354 Turn on/off hold window after exit support. If enabled, rxvt will
355 not immediately destroy its window when the program executed within
356 it exits. Instead, it will wait till it is being killed or closed by
357 the user; resource hold.
358
316 -keysym.*sym*: *string* 359 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 360 Remap a key symbol. See resource keysym.
318 361
319 -xrm *resourcestring* 362 -embed *windowid*
320 No effect on rxvt-unicode. Simply passes through an argument to be 363 Tells rxvt to embed its windows into an already-existing window,
321 made available in the instance's argument list. Appears in 364 which enables applications to easily embed a terminal.
322 *WM_COMMAND* in some window managers. 365
366 Right now, rxvt will first unmap/map the specified window, so it
367 shouldn't be a top-level window. rxvt will also reconfigure it quite
368 a bit, so don't expect it to keep some specific state. It's best to
369 create an extra subwindow for rxvt and leave it alone.
370
371 The window will not be destroyed when rxvt exits.
372
373 It might be useful to know that rxvt will not close file descriptors
374 passed to it (except for stdin/out/err, of course), so you can use
375 file descriptors to communicate with the programs within the
376 terminal. This works regardless of whether the "-embed" option was
377 used or not.
378
379 Here is a short Gtk2-perl snippet that illustrates how this option
380 can be used (a longer example is in doc/embed):
381
382 my $rxvt = new Gtk2::Socket;
383 $rxvt->signal_connect_after (realize => sub {
384 my $xid = $_[0]->window->get_xid;
385 system "rxvt -embed $xid &";
386 });
387
388 -pty-fd *file descriptor*
389 Tells rxvt NOT to execute any commands or create a new pty/tty pair
390 but instead use the given file descriptor as the tty master. This is
391 useful if you want to drive rxvt as a generic terminal emulator
392 without having to run a program within it.
393
394 If this switch is given, rxvt will not create any utmp/wtmp entries
395 and will not tinker with pty/tty permissions - you have to do that
396 yourself if you want that.
397
398 As an extremely special case, specifying -1 will completely suppress
399 pty/tty operations.
400
401 Here is a example in perl that illustrates how this option can be
402 used (a longer example is in doc/pty-fd):
403
404 use IO::Pty;
405 use Fcntl;
406
407 my $pty = new IO::Pty;
408 fcntl $pty, F_SETFD, 0; # clear close-on-exec
409 system "rxvt -pty-fd " . (fileno $pty) . "&";
410 close $pty;
411
412 # now communicate with rxvt
413 my $slave = $pty->slave;
414 while (<$slave>) { print $slave "got <$_>\n" }
415
416 -pe *string*
417 Comma-separated list of perl extension scripts to use (or not to
418 use) in this terminal instance. See resource perl-ext for details.
323 419
324RESOURCES (available also as long-options) 420RESOURCES (available also as long-options)
325 Note: `rxvt --help' gives a list of all resources (long options) 421 Note: `rxvt --help' gives a list of all resources (long options)
326 compiled into your version. 422 compiled into your version.
327 423
328 There are two different methods that rxvt can use to get the Xresource
329 data: using the X libraries (Xrm*-functions) or internal Xresources
330 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
331 XGetDefaults), you can set and change the resources using X11 tools like 424 You can set and change the resources using X11 tools like xrdb. Many
332 xrdb. Many distribution do also load settings from the ~/.Xresources 425 distribution do also load settings from the ~/.Xresources file when X
333 file when X starts. rxvt will consult the following files/resources in 426 starts. rxvt will consult the following files/resources in order, with
334 order, with later settings overwriting earlier ones: 427 later settings overwriting earlier ones:
335 428
336 1. system-wide app-defaults file, either locale-dependent OR global 429 1. system-wide app-defaults file, either locale-dependent OR global
337 2. app-defaults file in $XAPPLRESDIR 430 2. app-defaults file in $XAPPLRESDIR
338 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 431 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
339 4. SCREEN_RESOURCES for the current screen 432 4. SCREEN_RESOURCES for the current screen
340 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 433 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
341 434
342 If compiled with internal Xresources support (i.e. rxvt -h lists 435 Note that when reading X resources, rxvt recognizes two class names:
343 .Xdefaults) then rxvt accepts application defaults set in 436 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
344 XAPPLOADDIR/URxvt (compile-time defined: usually 437 and the original *rxvt* to be easily configured, while the class name
345 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 438 URxvt allows resources unique to rxvt, to be shared between different
346 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
347 resources, rxvt recognizes two class names: XTerm and URxvt. The class
348 name Rxvt allows resources common to both rxvt and the original *rxvt*
349 to be easily configured, while the class name URxvt allows resources
350 unique to rxvt, notably colours and key-handling, to be shared between
351 different rxvt configurations. If no resources are specified, suitable 439 rxvt configurations. If no resources are specified, suitable defaults
352 defaults will be used. Command-line arguments can be used to override 440 will be used. Command-line arguments can be used to override resource
353 resource settings. The following resources are allowed: 441 settings. The following resources are supported (you might want to check
442 the rxvtperl(3) manpage for additional settings by perl extensions not
443 documented here):
444
445 depth: *bitdepth*
446 Compile *xft*: Attempt to find a visual with the given bit depth;
447 option -depth.
354 448
355 geometry: *geom* 449 geometry: *geom*
356 Create the window with the specified X window geometry [default 450 Create the window with the specified X window geometry [default
357 80x24]; option -geometry. 451 80x24]; option -geometry.
358 452
… …
390 Use the specified colour to display underlined characters when the 484 Use the specified colour to display underlined characters when the
391 foreground colour is the default. 485 foreground colour is the default.
392 486
393 colorRV: *colour* 487 colorRV: *colour*
394 Use the specified colour as the background for reverse video 488 Use the specified colour as the background for reverse video
395 characters. 489 characters when OPTION_HC is disabled (--disable-frills).
396 490
397 underlineColor: *colour* 491 underlineColor: *colour*
398 If set, use the specified colour as the colour for the underline 492 If set, use the specified colour as the colour for the underline
399 itself. If unset, use the foreground colour. 493 itself. If unset, use the foreground colour.
400 494
… …
420 inheritPixmap: *boolean* 514 inheritPixmap: *boolean*
421 True: make the background inherit the parent windows' pixmap, giving 515 True: make the background inherit the parent windows' pixmap, giving
422 artificial transparency. False: do not inherit the parent windows' 516 artificial transparency. False: do not inherit the parent windows'
423 pixmap. 517 pixmap.
424 518
519 *Please note that transparency of any kind if completely unsupported
520 by the author. Don't bug him with installation questions!*
521
425 fading: *number* 522 fading: *number*
426 Fade the text by the given percentage when focus is lost. 523 Fade the text by the given percentage when focus is lost; option
524 -fade.
525
526 fadeColor: *colour*
527 Fade to this colour, when fading is used (see fading:). The default
528 colour is black; option -fadecolor.
427 529
428 tintColor: *colour* 530 tintColor: *colour*
429 Tint the transparent background pixmap with the given colour. 531 Tint the transparent background pixmap with the given colour; option
532 -tint.
430 533
431 shading: *number* 534 shading: *number*
432 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 535 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
433 image in addition to tinting it. 536 image in addition to tinting it; option -sh.
434 537
435 scrollColor: *colour* 538 scrollColor: *colour*
436 Use the specified colour for the scrollbar [default #B2B2B2]. 539 Use the specified colour for the scrollbar [default #B2B2B2].
437 540
438 troughColor: *colour* 541 troughColor: *colour*
439 Use the specified colour for the scrollbar's trough area [default 542 Use the specified colour for the scrollbar's trough area [default
440 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 543 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
441 544
442 borderColor: *colour* 545 borderColor: *colour*
443 The colour of the border around the text area and between the 546 The colour of the border around the text area and between the
444 scrollbar and the text. 547 scrollbar and the text.
445 548
… …
452 scale of 1 displays the image without any scaling. A scale of 2 to 9 555 scale of 1 displays the image without any scaling. A scale of 2 to 9
453 specifies an integer number of images in that direction. No image 556 specifies an integer number of images in that direction. No image
454 will be magnified beyond 10 times its original size. The maximum 557 will be magnified beyond 10 times its original size. The maximum
455 permitted scale is 1000. [default 0x0+50+50] 558 permitted scale is 1000. [default 0x0+50+50]
456 559
457 menu: *file[;tag]*
458 Read in the specified menu file (note the `.menu' extension is
459 optional) and also optionally specify a starting tag to find. See
460 the reference documentation for details on the syntax for the
461 menuBar.
462
463 path: *path* 560 path: *path*
464 Specify the colon-delimited search path for finding files (XPM and 561 Specify the colon-delimited search path for finding XPM files.
465 menus), in addition to the paths specified by the RXVTPATH and PATH
466 environment variables.
467 562
468 font: *fontlist* 563 font: *fontlist*
469 Select the fonts to be used. This is a comma separated list of font 564 Select the fonts to be used. This is a comma separated list of font
470 names that are used in turn when trying to display Unicode 565 names that are checked in order when trying to find glyphs for
471 characters. The first font defines the cell size for characters; 566 characters. The first font defines the cell size for characters;
472 other fonts might be smaller, but not larger. A reasonable default 567 other fonts might be smaller, but not (in general) larger. A
473 font list is always appended to it. option -fn. 568 (hopefully) reasonable default font list is always appended to it;
569 option -fn.
474 570
475 Each font can either be a standard X11 core font (XLFD) name, with 571 Each font can either be a standard X11 core font (XLFD) name, with
476 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 572 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
477 "xft:". 573 "xft:".
478 574
… …
481 available hint currently is "codeset=codeset-name", and this is only 577 available hint currently is "codeset=codeset-name", and this is only
482 used for Xft fonts. 578 used for Xft fonts.
483 579
484 For example, this font resource 580 For example, this font resource
485 581
486 URxvt*font: 9x15bold,\ 582 URxvt.font: 9x15bold,\
487 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 583 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
488 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 584 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
489 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 585 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
490 xft:Code2000:antialias=false 586 xft:Code2000:antialias=false
491 587
… …
524 tried. 620 tried.
525 621
526 If set, but empty, then this specific style is disabled and the 622 If set, but empty, then this specific style is disabled and the
527 normal text font will being used for the given style. 623 normal text font will being used for the given style.
528 624
625 intensityStyles: *boolean*
626 When font styles are not enabled, or this option is enabled (True,
627 option -is, the default), bold and italic font styles imply high
628 intensity foreground/background colours. Disabling this option
629 (False, option +is) disables this behaviour, the high intensity
630 colours are not reachable.
631
529 selectstyle: *mode* 632 selectstyle: *mode*
530 Set mouse selection style to old which is 2.20, oldword which is 633 Set mouse selection style to old which is 2.20, oldword which is
531 xterm style with 2.20 old word selection, or anything else which 634 xterm style with 2.20 old word selection, or anything else which
532 gives xterm style selection. 635 gives xterm style selection.
533 636
534 scrollstyle: *mode* 637 scrollstyle: *mode*
535 Set scrollbar style to rxvt, plain, next or xterm. plain is the 638 Set scrollbar style to rxvt, plain, next or xterm. plain is the
536 author's favourite.. 639 author's favourite.
537 640
538 title: *string* 641 title: *string*
539 Set window title string, the default title is the command-line 642 Set window title string, the default title is the command-line
540 specified after the -e option, if any, otherwise the application 643 specified after the -e option, if any, otherwise the application
541 name; option -title. 644 name; option -title.
… …
566 print-pipe: *string* 669 print-pipe: *string*
567 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 670 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
568 Print to initiate a screen dump to the printer and Ctrl-Print or 671 Print to initiate a screen dump to the printer and Ctrl-Print or
569 Shift-Print to include the scrollback as well. 672 Shift-Print to include the scrollback as well.
570 673
674 The string will be interpreted as if typed into the shell as-is.
675
676 Example:
677
678 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
679
680 This creates a new file in your home directory with the screen
681 contents every time you hit "Print".
682
571 scrollBar: *boolean* 683 scrollBar: *boolean*
572 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
573 scrollbar; option +sb. 685 scrollbar; option +sb.
574 686
575 scrollBar_right: *boolean* 687 scrollBar_right: *boolean*
… …
588 True: scroll to bottom when tty receives output; option -si. False: 700 True: scroll to bottom when tty receives output; option -si. False:
589 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
590 702
591 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
592 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
593 scrollTtyOutput is False); option +sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
594 scrollback buffer when tty recieves new lines; option -sw. 706 scrollback buffer when tty receives new lines; option +sw.
595 707
596 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
597 True: scroll to bottom when a non-special key is pressed. Special 709 True: scroll to bottom when a non-special key is pressed. Special
598 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
599 handling and are not passed onto the shell; option -sk. False: do 711 handling and are not passed onto the shell; option -sk. False: do
… …
614 borderLess: *boolean* 726 borderLess: *boolean*
615 Set MWM hints to request a borderless window, i.e. if honoured by 727 Set MWM hints to request a borderless window, i.e. if honoured by
616 the WM, the rxvt-unicode window will not have window decorations; 728 the WM, the rxvt-unicode window will not have window decorations;
617 option -bl. 729 option -bl.
618 730
731 skipBuiltinGlyphs: *boolean*
732 Compile *frills*: Disable the usage of the built-in block
733 graphics/line drawing characters and just rely on what the specified
734 fonts provide. Use this if you have a good font and want to use its
735 block graphic glyphs; option -sbg.
736
619 termName: *termname* 737 termName: *termname*
620 Specifies the terminal type name to be set in the TERM environment 738 Specifies the terminal type name to be set in the TERM environment
621 variable; option -tn. 739 variable; option -tn.
622 740
623 linespace: *number* 741 linespace: *number*
… …
651 pointerColor2: *colour* 769 pointerColor2: *colour*
652 Mouse pointer background colour. 770 Mouse pointer background colour.
653 771
654 pointerBlankDelay: *number* 772 pointerBlankDelay: *number*
655 Specifies number of seconds before blanking the pointer [default 2]. 773 Specifies number of seconds before blanking the pointer [default 2].
774 Use a large number (e.g. 987654321) to effectively disable the
775 timeout.
656 776
657 backspacekey: *string* 777 backspacekey: *string*
658 The string to send when the backspace key is pressed. If set to DEC 778 The string to send when the backspace key is pressed. If set to DEC
659 or unset it will send Delete (code 127) or, if shifted, Backspace 779 or unset it will send Delete (code 127) or, if shifted, Backspace
660 (code 8) - which can be reversed with the appropriate DEC private 780 (code 8) - which can be reversed with the appropriate DEC private
… …
664 The string to send when the delete key (not the keypad delete key) 784 The string to send when the delete key (not the keypad delete key)
665 is pressed. If unset it will send the sequence traditionally 785 is pressed. If unset it will send the sequence traditionally
666 associated with the Execute key. 786 associated with the Execute key.
667 787
668 cutchars: *string* 788 cutchars: *string*
669 The characters used as delimiters for double-click word selection. 789 The characters used as delimiters for double-click word selection
670 The built-in default: 790 (whitespace delimiting is added automatically if resource is given).
791
792 When the selection extension is in use (the default if compiled in,
793 see the rxvtperl(3) manpage), a suitable regex using these
794 characters will be created (if the resource exists, otherwise, no
795 regex will be created). In this mode, characters outside ISO-8859-1
796 can be used.
797
798 When the selection extension is not used, only ISO-8859-1 characters
799 can be used. If not specified, the built-in default is used:
671 800
672 BACKSLASH `"'&()*,;<=>?@[]{|} 801 BACKSLASH `"'&()*,;<=>?@[]{|}
673 802
674 preeditType: *style* 803 preeditType: *style*
675 OverTheSpot, OffTheSpot, Root; option -pt. 804 OverTheSpot, OffTheSpot, Root; option -pt.
… …
679 808
680 imLocale: *name* 809 imLocale: *name*
681 The locale to use for opening the IM. You can use an "LC_CTYPE" of 810 The locale to use for opening the IM. You can use an "LC_CTYPE" of
682 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 811 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
683 the input extension to be able to input japanese characters while 812 the input extension to be able to input japanese characters while
684 staying in another locale. option -imlocale. 813 staying in another locale; option -imlocale.
685 814
686 imFont: *fontset* 815 imFont: *fontset*
687 Specify the font-set used for XIM styles "OverTheSpot" or 816 Specify the font-set used for XIM styles "OverTheSpot" or
688 "OffTheSpot". It must be a standard X font set (XLFD patterns 817 "OffTheSpot". It must be a standard X font set (XLFD patterns
689 separated by commas), i.e. it's not in the same format as the other 818 separated by commas), i.e. it's not in the same format as the other
… …
692 to the base font. option -imfont. 821 to the base font. option -imfont.
693 822
694 tripleclickwords: *boolean* 823 tripleclickwords: *boolean*
695 Change the meaning of triple-click selection with the left mouse 824 Change the meaning of triple-click selection with the left mouse
696 button. Instead of selecting a full line it will extend the 825 button. Instead of selecting a full line it will extend the
697 selection to the end of the logical line only. option -tcw. 826 selection to the end of the logical line only; option -tcw.
698 827
699 insecure: *boolean* 828 insecure: *boolean*
700 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 829 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
701 that echo arbitrary strings like the icon name or the locale. This 830 that echo arbitrary strings like the icon name or the locale. This
702 could be abused if somebody gets 8-bit-clean access to your display, 831 could be abused if somebody gets 8-bit-clean access to your display,
703 whether throuh a mail client displaying mail bodies unfiltered or 832 whether through a mail client displaying mail bodies unfiltered or
704 though write(1). Therefore, these sequences are disabled by default. 833 through write(1) or any other means. Therefore, these sequences are
705 (Note that other terminals, including xterm, have these sequences 834 disabled by default. (Note that many other terminals, including
706 enabled by default). You can enable them by setting this boolean 835 xterm, have these sequences enabled by default, which doesn't make
707 resource or specifying -insecure as an option. At the moment, this 836 it safer, though).
708 enabled display-answer, locale, findfont, icon label and window 837
709 title requests as well as dynamic menubar dispatch. 838 You can enable them by setting this boolean resource or specifying
839 -insecure as an option. At the moment, this enables display-answer,
840 locale, findfont, icon label and window title requests.
710 841
711 modifier: *modifier* 842 modifier: *modifier*
712 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 843 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
713 super, mod1, mod2, mod3, mod4, mod5; option -mod. 844 super, mod1, mod2, mod3, mod4, mod5; option -mod.
714 845
715 answerbackString: *string* 846 answerbackString: *string*
716 Specify the reply rxvt-unicode sends to the shell when an ENQ 847 Specify the reply rxvt-unicode sends to the shell when an ENQ
717 (control-E) character is passed through. It may contain escape 848 (control-E) character is passed through. It may contain escape
718 values as described in the entry on keysym following. 849 values as described in the entry on keysym following.
719 850
720 secondaryScreen: *bool* 851 secondaryScreen: *boolean*
721 Turn on/off secondary screen (default enabled). 852 Turn on/off secondary screen (default enabled).
722 853
723 secondaryScroll: *bool* 854 secondaryScroll: *boolean*
724 Turn on/off secondary screen scroll (default enabled). If the this 855 Turn on/off secondary screen scroll (default enabled). If the this
725 option is enabled, scrolls on the secondary screen will change the 856 option is enabled, scrolls on the secondary screen will change the
726 scrollback buffer and switching to/from the secondary screen will 857 scrollback buffer and switching to/from the secondary screen will
727 instead scroll the screen up. 858 instead scroll the screen up.
859
860 hold: *boolean*
861 Turn on/off hold window after exit support. If enabled, rxvt will
862 not immediately destroy its window when the program executed within
863 it exits. Instead, it will wait till it is being killed or closed by
864 the user.
728 865
729 keysym.*sym*: *string* 866 keysym.*sym*: *string*
730 Compile *frills*: Associate *string* with keysym *sym*. The 867 Compile *frills*: Associate *string* with keysym *sym*. The
731 intervening resource name keysym. cannot be omitted. 868 intervening resource name keysym. cannot be omitted.
732 869
… …
749 886
750 *string* may contain escape values ("\a": bell, "\b": backspace, 887 *string* may contain escape values ("\a": bell, "\b": backspace,
751 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
752 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
753 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
754 it can start or end with whitespace. 891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
755 893
756 Please note that you need to double the "\" when using 894 Please note that you need to double the "\" in resource files, as
757 "--enable-xgetdefault", as X itself does it's own de-escaping (you 895 Xlib itself does its own de-escaping (you can use "\033" instead of
758 can use "\033" instead of "\e" (and so on), which will work with 896 "\e" (and so on), which will work with both Xt and rxvt's own
759 both Xt and rxvt's own processing). 897 processing).
760 898
761 You can define a range of keysyms in one shot by providing a 899 You can define a range of keysyms in one shot by providing a
762 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 900 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
763 `/' should be a character not used by the strings. 901 `/' should be a character not used by the strings.
764 902
765 Its usage can be demonstrated by an example: 903 Its usage can be demonstrated by an example:
766 904
767 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 905 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
777 the following means "change the current locale to "zh_CN.GBK" when 915 the following means "change the current locale to "zh_CN.GBK" when
778 Control-Meta-c is being pressed": 916 Control-Meta-c is being pressed":
779 917
780 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 918 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
781 919
920 If *string* takes the form "perl:STRING", then the specified STRING
921 is passed to the "on_keyboard_command" perl handler. See the
922 rxvtperl(3) manpage. For example, the selection extension (activated
923 via "rxvt -pe selection") listens for "selection:rot13" events:
924
925 URxvt.keysym.M-C-c: perl:selection:rot13
926
927 Due the the large number of modifier combinations, a defined key
928 mapping will match if at *at least* the specified identifiers are
929 being set, and no other key mappings with those and more bits are
930 being defined. That means that defining a key map for "a" will
931 automatically provide definitions for "Meta-a", "Shift-a" and so on,
932 unless some of those are defined mappings themselves.
933
934 Unfortunately, this will override built-in key mappings. For example
935 if you overwrite the "Insert" key you will disable rxvt's
936 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
937 the user-defined keymap using the "builtin:" replacement:
938
939 URxvt.keysym.Insert: <my insert key sequence>
940 URxvt.keysym.S-Insert: builtin:
941
942 The first line defines a mapping for "Insert" and *any* combination
943 of modifiers. The second line re-establishes the default mapping for
944 "Shift-Insert".
945
782 The following example will map Control-Meta-1 and Control-Meta-2 to 946 The following example will map Control-Meta-1 and Control-Meta-2 to
783 the fonts "suxuseuro" and "9x15bold", so you can have some limited 947 the fonts "suxuseuro" and "9x15bold", so you can have some limited
784 font-switching at runtime: 948 font-switching at runtime:
785 949
786 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 950 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
789 Other things are possible, e.g. resizing (see rxvt(7) for more 953 Other things are possible, e.g. resizing (see rxvt(7) for more
790 info): 954 info):
791 955
792 URxvt.keysym.M-C-3: command:\033[8;25;80t 956 URxvt.keysym.M-C-3: command:\033[8;25;80t
793 URxvt.keysym.M-C-4: command:\033[8;48;110t 957 URxvt.keysym.M-C-4: command:\033[8;48;110t
958
959 perl-ext-common: *string*
960 perl-ext: *string*
961 Comma-separated list(s) of perl extension scripts (default:
962 "default") to use in this terminal instance; option -pe.
963
964 Extension names can be prefixed with a "-" sign to prohibit using
965 them. This can be useful to selectively disable some extensions
966 loaded by default, or specified via the "perl-ext-common" resource.
967 For example, "default,-selection" will use all the default extension
968 except "selection".
969
970 Extension names can also be followed by an argument in angle
971 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
972 for searchable scrollback to Alt/Meta-s). Mentioning the same
973 extension multiple times with different arguments will pass multiple
974 arguments to the extension.
975
976 Each extension is looked up in the library directories, loaded if
977 necessary, and bound to the current terminal instance.
978
979 If both of these resources are the empty string, then the perl
980 interpreter will not be initialized. The idea behind two options is
981 that perl-ext-common will be used for extensions that should be
982 available to all instances, while perl-ext is used for specific
983 instances.
984
985 perl-eval: *string*
986 Perl code to be evaluated when all extensions have been registered.
987 See the rxvtperl(3) manpage. Due to security reasons, this resource
988 will be ignored when running setuid/setgid.
989
990 perl-lib: *path*
991 Colon-separated list of additional directories that hold extension
992 scripts. When looking for extensions specified by the "perl"
993 resource, rxvt will first look in these directories and then in
994 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
995 will be ignored when running setuid/setgid.
996
997 See the rxvtperl(3) manpage.
998
999 selection.pattern-*idx*: *perl-regex*
1000 Additional selection patterns, see the rxvtperl(3) manpage for
1001 details.
1002
1003 selection-autotransform.*idx*: *perl-transform*
1004 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1005 details.
1006
1007 searchable-scrollback: *keysym*
1008 Sets the hotkey that starts the incremental scrollback buffer search
1009 (default: "M-s").
1010
1011 urlLauncher: *string*
1012 Specifies the program to be started with a URL argument. Used by the
1013 "selection-popup" and "matcher" perl extensions.
1014
1015 transient-for: *windowid*
1016 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1017 window id.
1018
1019 override-redirect: *boolean*
1020 Compile *frills*: Sets override-redirect for the terminal window,
1021 making it almost invisible to window managers; option
1022 -override-redirect.
794 1023
795THE SCROLLBAR 1024THE SCROLLBAR
796 Lines of text that scroll off the top of the rxvt window (resource: 1025 Lines of text that scroll off the top of the rxvt window (resource:
797 saveLines) and can be scrolled back using the scrollbar or by 1026 saveLines) and can be scrolled back using the scrollbar or by
798 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1027 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
825 entire logical line (which can span multiple screen lines), unless 1054 entire logical line (which can span multiple screen lines), unless
826 modified by resource tripleclickwords. 1055 modified by resource tripleclickwords.
827 1056
828 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1057 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
829 (Compile: *frills*) will create a rectangular selection instead of a 1058 (Compile: *frills*) will create a rectangular selection instead of a
830 normal one. 1059 normal one. In this mode, every selected row becomes its own line in
1060 the selection, and trailing whitespace is visually underlined and
1061 removed from the selection.
831 1062
832 Insertion: 1063 Insertion:
833 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1064 Pressing and releasing the Middle mouse button in an rxvt window
834 an rxvt window causes the current text selection to be inserted as 1065 causes the value of the PRIMARY selection (or CLIPBOARD with the
835 if it had been typed on the keyboard. 1066 Meta modifier) to be inserted as if it had been typed on the
1067 keyboard.
1068
1069 Pressing Shift-Insert causes the value of the PRIMARY selection to
1070 be inserted too.
836 1071
837CHANGING FONTS 1072CHANGING FONTS
838 Changing fonts (or font sizes, respectively) via the keypad is not yet 1073 Changing fonts (or font sizes, respectively) via the keypad is not yet
839 supported in rxvt-unicode. Bug me if you need this. 1074 supported in rxvt-unicode. Bug me if you need this.
840 1075
841 You can, however, switch fonts at runtime using escape sequences (and 1076 You can, however, switch fonts at runtime using escape sequences, e.g.:
842 therefore using the menubar), e.g.:
843 1077
844 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1078 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1079
1080 You can use keyboard shortcuts, too:
1081
1082 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1083 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
845 1084
846 rxvt-unicode will automatically re-apply these fonts to the output so 1085 rxvt-unicode will automatically re-apply these fonts to the output so
847 far. 1086 far.
848 1087
849ISO 14755 SUPPORT 1088ISO 14755 SUPPORT
… …
873 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
874 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
875 1114
876 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
877 them. The next special key (cursor keys, home etc.) you enter will 1116 them. The next special key (cursor keys, home etc.) you enter will
878 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
879 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
880 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
881 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
882 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
883 1122
… …
912 setgid to root or to some other group on others. 1151 setgid to root or to some other group on others.
913 1152
914COLORS AND GRAPHICS 1153COLORS AND GRAPHICS
915 In addition to the default foreground and background colours, rxvt can 1154 In addition to the default foreground and background colours, rxvt can
916 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1155 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
917 versions of the same). Here is a list of the colours with their rgb.txt 1156 versions of the same). Here is a list of the colours with their names.
918 names.
919 1157
920 color0 (black) = Black 1158 color0 (black) = Black
921 color1 (red) = Red3 1159 color1 (red) = Red3
922 color2 (green) = Green3 1160 color2 (green) = Green3
923 color3 (yellow) = Yellow3 1161 color3 (yellow) = Yellow3
… …
939 It is also possible to specify the colour values of foreground, 1177 It is also possible to specify the colour values of foreground,
940 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1178 background, cursorColor, cursorColor2, colorBD, colorUL as a number
941 0-15, as a convenient shorthand to reference the colour name of 1179 0-15, as a convenient shorthand to reference the colour name of
942 color0-color15. 1180 color0-color15.
943 1181
1182 In addition to the colours defined above, rxvt offers an additional 72
1183 colours. The first 64 of those (with indices 16 to 79) consist of a
1184 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1185 by 8 additional shades of gray (with indices 80 to 87).
1186
1187 Together, all those colours implement the 88 colour xterm colours. Only
1188 the first 16 can be changed using resources currently, the rest can only
1189 be changed via command sequences ("escape codes").
1190
944 Note that -rv ("reverseVideo: True") simulates reverse video by always 1191 Note that -rv ("reverseVideo: True") simulates reverse video by always
945 swapping the foreground/background colours. This is in contrast to 1192 swapping the foreground/background colours. This is in contrast to
946 *xterm*(1) where the colours are only swapped if they have not otherwise 1193 *xterm*(1) where the colours are only swapped if they have not otherwise
947 been specified. For example, 1194 been specified. For example,
948 1195
949 rxvt -fg Black -bg White -rv 1196 rxvt -fg Black -bg White -rv
950 would yield White on Black, while on *xterm*(1) it would yield Black 1197 would yield White on Black, while on *xterm*(1) it would yield Black
951 on White. 1198 on White.
952 1199
1200 ALPHA CHANNEL SUPPORT
1201 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1202 get their act together, rxvt-unicode will support
1203 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1204 digits/component) colour specifications, in addition to the ones
1205 provided by X, where the additional A component specifies opacity
1206 (alpha) values. The minimum value of 0 is completely transparent). You
1207 can also prefix any color with "[percent]", where "percent" is a decimal
1208 percentage (0-100) that specifies the opacity of the color, where 0 is
1209 completely transparent and 100 is completelxy opaque.
1210
1211 You probably need to specify "-depth 32", too, and have the luck that
1212 your X-server uses ARGB pixel layout, as X is far from just supporting
1213 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1214
1215 For example, the following selects an almost completely transparent red
1216 background, and an almost opaque pink foreground:
1217
1218 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1219
1220 *Please note that transparency of any kind if completely unsupported by
1221 the author. Don't bug him with installation questions!*
1222
953ENVIRONMENT 1223ENVIRONMENT
954 rxvt sets and/or uses the following environment variables: 1224 rxvt sets and/or uses the following environment variables:
955 1225
956 TERM 1226 TERM
957 Normally set to "rxvt-unicode", unless overwritten at configure 1227 Normally set to "rxvt-unicode", unless overwritten at configure
958 time, via resources or on the commandline. 1228 time, via resources or on the command line.
959 1229
960 COLORTERM 1230 COLORTERM
961 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1231 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
962 with XPM support, and optionally with the added extension "-mono" to 1232 with XPM support, and optionally with the added extension "-mono" to
963 indicate that rxvt-unicode runs on a monochrome screen. 1233 indicate that rxvt-unicode runs on a monochrome screen.
964 1234
965 COLORFGBG 1235 COLORFGBG
966 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1236 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
… …
980 Set to the terminfo directory iff rxvt was configured with 1250 Set to the terminfo directory iff rxvt was configured with
981 "--with-terminfo=PATH". 1251 "--with-terminfo=PATH".
982 1252
983 DISPLAY 1253 DISPLAY
984 Used by rxvt to connect to the display and set to the correct 1254 Used by rxvt to connect to the display and set to the correct
985 display in it's child processes. 1255 display in its child processes.
986 1256
987 SHELL 1257 SHELL
988 The shell to be used for command execution, defaults to "/bin/sh". 1258 The shell to be used for command execution, defaults to "/bin/sh".
989 1259
990 RXVTPATH
991 The path where rxvt looks for support files such as menu and xpm
992 files.
993
994 PATH
995 Used in the same way as "RXVTPATH".
996
997 RXVT_SOCKET 1260 RXVT_SOCKET
998 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1261 The unix domain socket path used by rxvtc(1) and rxvtd(1).
999 1262
1000 Default "$HOME/.rxvt-unicode-<nodename". 1263 Default $HOME/.rxvt-unicode-*<nodename*.
1001 1264
1002 HOME 1265 HOME
1003 Used to locate the default directory for the unix domain socket for 1266 Used to locate the default directory for the unix domain socket for
1004 daemon communications and to locate various resource files (such as 1267 daemon communications and to locate various resource files (such as
1005 ".Xdefaults") 1268 ".Xdefaults")
… …
1014FILES 1277FILES
1015 /usr/lib/X11/rgb.txt 1278 /usr/lib/X11/rgb.txt
1016 Color names. 1279 Color names.
1017 1280
1018SEE ALSO 1281SEE ALSO
1019 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1282 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1020 1283 tty(4), utmp(5)
1021BUGS
1022 Check the BUGS file for an up-to-date list.
1023
1024 Cursor change support is not yet implemented.
1025
1026 Click-and-drag doesn't work with X11 mouse report overriding.
1027 1284
1028CURRENT PROJECT COORDINATOR 1285CURRENT PROJECT COORDINATOR
1029 Project Coordinator 1286 Project Coordinator
1030 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1287 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1031 1288
1032 <http://software.schmorp.de/#rxvt-unicode> 1289 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1033 1290
1034AUTHORS 1291AUTHORS
1035 John Bovey 1292 John Bovey
1036 University of Kent, 1992, wrote the original Xvt. 1293 University of Kent, 1992, wrote the original Xvt.
1037 1294
… …
1048 1305
1049 Oezguer Kesim <kesim@math.fu-berlin.de> 1306 Oezguer Kesim <kesim@math.fu-berlin.de>
1050 Project Coordinator (changes.txt 2.21a to 2.4.5) 1307 Project Coordinator (changes.txt 2.21a to 2.4.5)
1051 1308
1052 Geoff Wing <gcw@pobox.com> 1309 Geoff Wing <gcw@pobox.com>
1053 Rewrote screen display and text selection routines. Project 1310 Rewrote screen display and text selection routines.
1311
1054 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1312 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1055 1313
1056 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1314 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1057 Forked rxvt-unicode, rewrote most of the display code and internal 1315 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1058 character handling to store text in unicode, improve xterm 1316 perl extension, random hacks, numerous bugfixes and extensions.
1059 compatibility and apply numerous other bugfixes and extensions.
1060 1317
1061 Project Coordinator (Changes 1.0 -) 1318 Project Coordinator (Changes 1.0 -)
1062 1319
1320 Emanuele Giaquinta <e.giaquinta@glauco.it>
1321 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1322

Diff Legend

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