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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.14 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.63 by root, Thu Nov 2 17:37:47 2006 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 5.1, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.0, 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; 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").
115 131
… …
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 -embed: *windowid* 362 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window, 363 Tells rxvt to embed its windows into an already-existing window,
321 which enables applications to easily embed a terminal. 364 which enables applications to easily embed a terminal.
322 365
323 Right now, rxvt will first unmap/map the specified window, so it 366 Right now, rxvt will first unmap/map the specified window, so it
324 shouldn't be a top-level window. rxvt will also reconfigure it quite 367 shouldn't be a top-level window. rxvt will also reconfigure it quite
325 a bit, so don't expect it to keep some specific state. It's best to 368 a bit, so don't expect it to keep some specific state. It's best to
326 create an extra subwindow for rxvt and leave it alone. 369 create an extra subwindow for rxvt and leave it alone.
327 370
371 The window will not be destroyed when rxvt exits.
372
328 It might be useful to know that rxvt will not close file descriptors 373 It might be useful to know that rxvt will not close file descriptors
329 passed to it (except for stdin/out/err, of course), so you can use 374 passed to it (except for stdin/out/err, of course), so you can use
330 file descriptors to communicate with the programs within the 375 file descriptors to communicate with the programs within the
331 terminal. This works regardless of wether the "-embed" option was 376 terminal. This works regardless of whether the "-embed" option was
332 used or not. 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.
333 419
334RESOURCES (available also as long-options) 420RESOURCES (available also as long-options)
335 Note: `rxvt --help' gives a list of all resources (long options) 421 Note: `rxvt --help' gives a list of all resources (long options)
336 compiled into your version. 422 compiled into your version.
337 423
338 There are two different methods that rxvt can use to get the Xresource
339 data: using the X libraries (Xrm*-functions) or internal Xresources
340 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
341 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
342 xrdb. Many distribution do also load settings from the ~/.Xresources 425 distribution do also load settings from the ~/.Xresources file when X
343 file when X starts. rxvt will consult the following files/resources in 426 starts. rxvt will consult the following files/resources in order, with
344 order, with later settings overwriting earlier ones: 427 later settings overwriting earlier ones:
345 428
346 1. system-wide app-defaults file, either locale-dependent OR global 429 1. system-wide app-defaults file, either locale-dependent OR global
347 2. app-defaults file in $XAPPLRESDIR 430 2. app-defaults file in $XAPPLRESDIR
348 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 431 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
349 4. SCREEN_RESOURCES for the current screen 432 4. SCREEN_RESOURCES for the current screen
350 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 433 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
351 434
352 If compiled with internal Xresources support (i.e. rxvt -h lists 435 Note that when reading X resources, rxvt recognizes two class names:
353 .Xdefaults) then rxvt accepts application defaults set in 436 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
354 XAPPLOADDIR/URxvt (compile-time defined: usually 437 and the original *rxvt* to be easily configured, while the class name
355 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 438 URxvt allows resources unique to rxvt, to be shared between different
356 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
357 resources, rxvt recognizes two class names: XTerm and URxvt. The class
358 name Rxvt allows resources common to both rxvt and the original *rxvt*
359 to be easily configured, while the class name URxvt allows resources
360 unique to rxvt, notably colours and key-handling, to be shared between
361 different rxvt configurations. If no resources are specified, suitable 439 rxvt configurations. If no resources are specified, suitable defaults
362 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
363 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.
364 448
365 geometry: *geom* 449 geometry: *geom*
366 Create the window with the specified X window geometry [default 450 Create the window with the specified X window geometry [default
367 80x24]; option -geometry. 451 80x24]; option -geometry.
368 452
… …
430 inheritPixmap: *boolean* 514 inheritPixmap: *boolean*
431 True: make the background inherit the parent windows' pixmap, giving 515 True: make the background inherit the parent windows' pixmap, giving
432 artificial transparency. False: do not inherit the parent windows' 516 artificial transparency. False: do not inherit the parent windows'
433 pixmap. 517 pixmap.
434 518
519 *Please note that transparency of any kind if completely unsupported
520 by the author. Don't bug him with installation questions!*
521
435 fading: *number* 522 fading: *number*
436 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.
437 529
438 tintColor: *colour* 530 tintColor: *colour*
439 Tint the transparent background pixmap with the given colour. 531 Tint the transparent background pixmap with the given colour; option
532 -tint.
440 533
441 shading: *number* 534 shading: *number*
442 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 535 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
443 image in addition to tinting it. 536 image in addition to tinting it.
444 537
445 scrollColor: *colour* 538 scrollColor: *colour*
446 Use the specified colour for the scrollbar [default #B2B2B2]. 539 Use the specified colour for the scrollbar [default #B2B2B2].
447 540
448 troughColor: *colour* 541 troughColor: *colour*
449 Use the specified colour for the scrollbar's trough area [default 542 Use the specified colour for the scrollbar's trough area [default
450 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 543 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
451 544
452 borderColor: *colour* 545 borderColor: *colour*
453 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
454 scrollbar and the text. 547 scrollbar and the text.
455 548
… …
462 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
463 specifies an integer number of images in that direction. No image 556 specifies an integer number of images in that direction. No image
464 will be magnified beyond 10 times its original size. The maximum 557 will be magnified beyond 10 times its original size. The maximum
465 permitted scale is 1000. [default 0x0+50+50] 558 permitted scale is 1000. [default 0x0+50+50]
466 559
467 menu: *file[;tag]*
468 Read in the specified menu file (note the `.menu' extension is
469 optional) and also optionally specify a starting tag to find. See
470 the reference documentation for details on the syntax for the
471 menuBar.
472
473 path: *path* 560 path: *path*
474 Specify the colon-delimited search path for finding files (XPM and 561 Specify the colon-delimited search path for finding XPM files.
475 menus), in addition to the paths specified by the RXVTPATH and PATH
476 environment variables.
477 562
478 font: *fontlist* 563 font: *fontlist*
479 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
480 names that are used in turn when trying to display Unicode 565 names that are checked in order when trying to find glyphs for
481 characters. The first font defines the cell size for characters; 566 characters. The first font defines the cell size for characters;
482 other fonts might be smaller, but not larger. A reasonable default 567 other fonts might be smaller, but not (in general) larger. A
483 font list is always appended to it. option -fn. 568 (hopefully) reasonable default font list is always appended to it;
569 option -fn.
484 570
485 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
486 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 572 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
487 "xft:". 573 "xft:".
488 574
… …
491 available hint currently is "codeset=codeset-name", and this is only 577 available hint currently is "codeset=codeset-name", and this is only
492 used for Xft fonts. 578 used for Xft fonts.
493 579
494 For example, this font resource 580 For example, this font resource
495 581
496 URxvt*font: 9x15bold,\ 582 URxvt.font: 9x15bold,\
497 -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,\
498 -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, \
499 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 585 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
500 xft:Code2000:antialias=false 586 xft:Code2000:antialias=false
501 587
… …
534 tried. 620 tried.
535 621
536 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
537 normal text font will being used for the given style. 623 normal text font will being used for the given style.
538 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
539 selectstyle: *mode* 632 selectstyle: *mode*
540 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
541 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
542 gives xterm style selection. 635 gives xterm style selection.
543 636
544 scrollstyle: *mode* 637 scrollstyle: *mode*
545 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
546 author's favourite.. 639 author's favourite.
547 640
548 title: *string* 641 title: *string*
549 Set window title string, the default title is the command-line 642 Set window title string, the default title is the command-line
550 specified after the -e option, if any, otherwise the application 643 specified after the -e option, if any, otherwise the application
551 name; option -title. 644 name; option -title.
… …
576 print-pipe: *string* 669 print-pipe: *string*
577 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 670 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
578 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
579 Shift-Print to include the scrollback as well. 672 Shift-Print to include the scrollback as well.
580 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
581 scrollBar: *boolean* 683 scrollBar: *boolean*
582 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
583 scrollbar; option +sb. 685 scrollbar; option +sb.
584 686
585 scrollBar_right: *boolean* 687 scrollBar_right: *boolean*
… …
598 True: scroll to bottom when tty receives output; option -si. False: 700 True: scroll to bottom when tty receives output; option -si. False:
599 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
600 702
601 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
602 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
603 scrollTtyOutput is False); option +sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
604 scrollback buffer when tty recieves new lines; option -sw. 706 scrollback buffer when tty receives new lines; option +sw.
605 707
606 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
607 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
608 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
609 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
… …
624 borderLess: *boolean* 726 borderLess: *boolean*
625 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
626 the WM, the rxvt-unicode window will not have window decorations; 728 the WM, the rxvt-unicode window will not have window decorations;
627 option -bl. 729 option -bl.
628 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
629 termName: *termname* 737 termName: *termname*
630 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
631 variable; option -tn. 739 variable; option -tn.
632 740
633 linespace: *number* 741 linespace: *number*
… …
661 pointerColor2: *colour* 769 pointerColor2: *colour*
662 Mouse pointer background colour. 770 Mouse pointer background colour.
663 771
664 pointerBlankDelay: *number* 772 pointerBlankDelay: *number*
665 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.
666 776
667 backspacekey: *string* 777 backspacekey: *string*
668 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
669 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
670 (code 8) - which can be reversed with the appropriate DEC private 780 (code 8) - which can be reversed with the appropriate DEC private
… …
674 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)
675 is pressed. If unset it will send the sequence traditionally 785 is pressed. If unset it will send the sequence traditionally
676 associated with the Execute key. 786 associated with the Execute key.
677 787
678 cutchars: *string* 788 cutchars: *string*
679 The characters used as delimiters for double-click word selection. 789 The characters used as delimiters for double-click word selection
680 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:
681 800
682 BACKSLASH `"'&()*,;<=>?@[]{|} 801 BACKSLASH `"'&()*,;<=>?@[]{|}
683 802
684 preeditType: *style* 803 preeditType: *style*
685 OverTheSpot, OffTheSpot, Root; option -pt. 804 OverTheSpot, OffTheSpot, Root; option -pt.
… …
689 808
690 imLocale: *name* 809 imLocale: *name*
691 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
692 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
693 the input extension to be able to input japanese characters while 812 the input extension to be able to input japanese characters while
694 staying in another locale. option -imlocale. 813 staying in another locale; option -imlocale.
695 814
696 imFont: *fontset* 815 imFont: *fontset*
697 Specify the font-set used for XIM styles "OverTheSpot" or 816 Specify the font-set used for XIM styles "OverTheSpot" or
698 "OffTheSpot". It must be a standard X font set (XLFD patterns 817 "OffTheSpot". It must be a standard X font set (XLFD patterns
699 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
… …
702 to the base font. option -imfont. 821 to the base font. option -imfont.
703 822
704 tripleclickwords: *boolean* 823 tripleclickwords: *boolean*
705 Change the meaning of triple-click selection with the left mouse 824 Change the meaning of triple-click selection with the left mouse
706 button. Instead of selecting a full line it will extend the 825 button. Instead of selecting a full line it will extend the
707 selection to the end of the logical line only. option -tcw. 826 selection to the end of the logical line only; option -tcw.
708 827
709 insecure: *boolean* 828 insecure: *boolean*
710 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 829 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
711 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
712 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,
713 whether throuh a mail client displaying mail bodies unfiltered or 832 whether through a mail client displaying mail bodies unfiltered or
714 though write(1). Therefore, these sequences are disabled by default. 833 through write(1) or any other means. Therefore, these sequences are
715 (Note that other terminals, including xterm, have these sequences 834 disabled by default. (Note that many other terminals, including
716 enabled by default). You can enable them by setting this boolean 835 xterm, have these sequences enabled by default, which doesn't make
717 resource or specifying -insecure as an option. At the moment, this 836 it safer, though).
718 enabled display-answer, locale, findfont, icon label and window 837
719 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.
720 841
721 modifier: *modifier* 842 modifier: *modifier*
722 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,
723 super, mod1, mod2, mod3, mod4, mod5; option -mod. 844 super, mod1, mod2, mod3, mod4, mod5; option -mod.
724 845
725 answerbackString: *string* 846 answerbackString: *string*
726 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
727 (control-E) character is passed through. It may contain escape 848 (control-E) character is passed through. It may contain escape
728 values as described in the entry on keysym following. 849 values as described in the entry on keysym following.
729 850
730 secondaryScreen: *bool* 851 secondaryScreen: *boolean*
731 Turn on/off secondary screen (default enabled). 852 Turn on/off secondary screen (default enabled).
732 853
733 secondaryScroll: *bool* 854 secondaryScroll: *boolean*
734 Turn on/off secondary screen scroll (default enabled). If the this 855 Turn on/off secondary screen scroll (default enabled). If the this
735 option is enabled, scrolls on the secondary screen will change the 856 option is enabled, scrolls on the secondary screen will change the
736 scrollback buffer and switching to/from the secondary screen will 857 scrollback buffer and switching to/from the secondary screen will
737 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.
738 865
739 keysym.*sym*: *string* 866 keysym.*sym*: *string*
740 Compile *frills*: Associate *string* with keysym *sym*. The 867 Compile *frills*: Associate *string* with keysym *sym*. The
741 intervening resource name keysym. cannot be omitted. 868 intervening resource name keysym. cannot be omitted.
742 869
… …
759 886
760 *string* may contain escape values ("\a": bell, "\b": backspace, 887 *string* may contain escape values ("\a": bell, "\b": backspace,
761 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
762 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
763 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
764 it can start or end with whitespace. 891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
765 893
766 Please note that you need to double the "\" when using 894 Please note that you need to double the "\" in resource files, as
767 "--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
768 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
769 both Xt and rxvt's own processing). 897 processing).
770 898
771 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
772 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 900 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
773 `/' should be a character not used by the strings. 901 `/' should be a character not used by the strings.
774 902
775 Its usage can be demonstrated by an example: 903 Its usage can be demonstrated by an example:
776 904
777 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 905 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
787 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
788 Control-Meta-c is being pressed": 916 Control-Meta-c is being pressed":
789 917
790 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
791 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
792 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
793 the fonts "suxuseuro" and "9x15bold", so you can have some limited 947 the fonts "suxuseuro" and "9x15bold", so you can have some limited
794 font-switching at runtime: 948 font-switching at runtime:
795 949
796 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 950 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
799 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
800 info): 954 info):
801 955
802 URxvt.keysym.M-C-3: command:\033[8;25;80t 956 URxvt.keysym.M-C-3: command:\033[8;25;80t
803 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 "mark-urls" 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.
804 1023
805THE SCROLLBAR 1024THE SCROLLBAR
806 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:
807 saveLines) and can be scrolled back using the scrollbar or by 1026 saveLines) and can be scrolled back using the scrollbar or by
808 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1027 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
835 entire logical line (which can span multiple screen lines), unless 1054 entire logical line (which can span multiple screen lines), unless
836 modified by resource tripleclickwords. 1055 modified by resource tripleclickwords.
837 1056
838 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)
839 (Compile: *frills*) will create a rectangular selection instead of a 1058 (Compile: *frills*) will create a rectangular selection instead of a
840 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.
841 1062
842 Insertion: 1063 Insertion:
843 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1064 Pressing and releasing the Middle mouse button in an rxvt window
844 an rxvt window causes the current text selection to be inserted as 1065 causes the value of the PRIMARY selection (or CLIPBOARD with the
845 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.
846 1071
847CHANGING FONTS 1072CHANGING FONTS
848 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
849 supported in rxvt-unicode. Bug me if you need this. 1074 supported in rxvt-unicode. Bug me if you need this.
850 1075
851 You can, however, switch fonts at runtime using escape sequences (and 1076 You can, however, switch fonts at runtime using escape sequences, e.g.:
852 therefore using the menubar), e.g.:
853 1077
854 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
855 1084
856 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
857 far. 1086 far.
858 1087
859ISO 14755 SUPPORT 1088ISO 14755 SUPPORT
… …
883 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
884 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
885 1114
886 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
887 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
888 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
889 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
890 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
891 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
892 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
893 1122
… …
922 setgid to root or to some other group on others. 1151 setgid to root or to some other group on others.
923 1152
924COLORS AND GRAPHICS 1153COLORS AND GRAPHICS
925 In addition to the default foreground and background colours, rxvt can 1154 In addition to the default foreground and background colours, rxvt can
926 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
927 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.
928 names.
929 1157
930 color0 (black) = Black 1158 color0 (black) = Black
931 color1 (red) = Red3 1159 color1 (red) = Red3
932 color2 (green) = Green3 1160 color2 (green) = Green3
933 color3 (yellow) = Yellow3 1161 color3 (yellow) = Yellow3
… …
949 It is also possible to specify the colour values of foreground, 1177 It is also possible to specify the colour values of foreground,
950 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1178 background, cursorColor, cursorColor2, colorBD, colorUL as a number
951 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
952 color0-color15. 1180 color0-color15.
953 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
954 Note that -rv ("reverseVideo: True") simulates reverse video by always 1191 Note that -rv ("reverseVideo: True") simulates reverse video by always
955 swapping the foreground/background colours. This is in contrast to 1192 swapping the foreground/background colours. This is in contrast to
956 *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
957 been specified. For example, 1194 been specified. For example,
958 1195
959 rxvt -fg Black -bg White -rv 1196 rxvt -fg Black -bg White -rv
960 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
961 on White. 1198 on White.
962 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 "[a]", where "a" is on to four hex digits
1208 specifiying the opacity value.
1209
1210 You probably need to specify "-depth 32", too, and have the luck that
1211 your X-server uses ARGB pixel layout, as X is far from just supporting
1212 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1213
1214 For example, the following selects an almost completely transparent red
1215 background, and an almost opaque pink foreground:
1216
1217 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1218
1219 *Please note that transparency of any kind if completely unsupported by
1220 the author. Don't bug him with installation questions!*
1221
963ENVIRONMENT 1222ENVIRONMENT
964 rxvt sets and/or uses the following environment variables: 1223 rxvt sets and/or uses the following environment variables:
965 1224
966 TERM 1225 TERM
967 Normally set to "rxvt-unicode", unless overwritten at configure 1226 Normally set to "rxvt-unicode", unless overwritten at configure
968 time, via resources or on the commandline. 1227 time, via resources or on the command line.
969 1228
970 COLORTERM 1229 COLORTERM
971 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1230 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
972 with XPM support, and optionally with the added extension "-mono" to 1231 with XPM support, and optionally with the added extension "-mono" to
973 indicate that rxvt-unicode runs on a monochrome screen. 1232 indicate that rxvt-unicode runs on a monochrome screen.
974 1233
975 COLORFGBG 1234 COLORFGBG
976 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1235 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
… …
990 Set to the terminfo directory iff rxvt was configured with 1249 Set to the terminfo directory iff rxvt was configured with
991 "--with-terminfo=PATH". 1250 "--with-terminfo=PATH".
992 1251
993 DISPLAY 1252 DISPLAY
994 Used by rxvt to connect to the display and set to the correct 1253 Used by rxvt to connect to the display and set to the correct
995 display in it's child processes. 1254 display in its child processes.
996 1255
997 SHELL 1256 SHELL
998 The shell to be used for command execution, defaults to "/bin/sh". 1257 The shell to be used for command execution, defaults to "/bin/sh".
999 1258
1000 RXVTPATH
1001 The path where rxvt looks for support files such as menu and xpm
1002 files.
1003
1004 PATH
1005 Used in the same way as "RXVTPATH".
1006
1007 RXVT_SOCKET 1259 RXVT_SOCKET
1008 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1260 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1009 1261
1010 Default "$HOME/.rxvt-unicode-<nodename". 1262 Default $HOME/.rxvt-unicode-*<nodename*.
1011 1263
1012 HOME 1264 HOME
1013 Used to locate the default directory for the unix domain socket for 1265 Used to locate the default directory for the unix domain socket for
1014 daemon communications and to locate various resource files (such as 1266 daemon communications and to locate various resource files (such as
1015 ".Xdefaults") 1267 ".Xdefaults")
… …
1024FILES 1276FILES
1025 /usr/lib/X11/rgb.txt 1277 /usr/lib/X11/rgb.txt
1026 Color names. 1278 Color names.
1027 1279
1028SEE ALSO 1280SEE ALSO
1029 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1281 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1030 1282 tty(4), utmp(5)
1031BUGS
1032 Check the BUGS file for an up-to-date list.
1033
1034 Cursor change support is not yet implemented.
1035
1036 Click-and-drag doesn't work with X11 mouse report overriding.
1037 1283
1038CURRENT PROJECT COORDINATOR 1284CURRENT PROJECT COORDINATOR
1039 Project Coordinator 1285 Project Coordinator
1040 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1286 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1041 1287
1042 <http://software.schmorp.de/#rxvt-unicode> 1288 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1043 1289
1044AUTHORS 1290AUTHORS
1045 John Bovey 1291 John Bovey
1046 University of Kent, 1992, wrote the original Xvt. 1292 University of Kent, 1992, wrote the original Xvt.
1047 1293
… …
1058 1304
1059 Oezguer Kesim <kesim@math.fu-berlin.de> 1305 Oezguer Kesim <kesim@math.fu-berlin.de>
1060 Project Coordinator (changes.txt 2.21a to 2.4.5) 1306 Project Coordinator (changes.txt 2.21a to 2.4.5)
1061 1307
1062 Geoff Wing <gcw@pobox.com> 1308 Geoff Wing <gcw@pobox.com>
1063 Rewrote screen display and text selection routines. Project 1309 Rewrote screen display and text selection routines.
1310
1064 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1311 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1065 1312
1066 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1313 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1067 Forked rxvt-unicode, rewrote most of the display code and internal 1314 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1068 character handling to store text in unicode, improve xterm 1315 perl extension, random hacks, numerous bugfixes and extensions.
1069 compatibility and apply numerous other bugfixes and extensions.
1070 1316
1071 Project Coordinator (Changes 1.0 -) 1317 Project Coordinator (Changes 1.0 -)
1072 1318
1319 Emanuele Giaquinta <e.giaquinta@glauco.it>
1320 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1321

Diff Legend

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