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.21 by root, Fri Apr 22 02:09:39 2005 UTC vs.
Revision 1.62 by root, Mon Aug 7 16:17:30 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.5, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.9, 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
… …
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
… …
328 The window will not be destroyed when rxvt exits. 371 The window will not be destroyed when rxvt exits.
329 372
330 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
331 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
332 file descriptors to communicate with the programs within the 375 file descriptors to communicate with the programs within the
333 terminal. This works regardless of wether the "-embed" option was 376 terminal. This works regardless of whether the "-embed" option was
334 used or not. 377 used or not.
335 378
336 Here is a short Gtk2-perl snippet that illustrates how this option 379 Here is a short Gtk2-perl snippet that illustrates how this option
337 can be used (a longer example is in doc/embed): 380 can be used (a longer example is in doc/embed):
338 381
… …
340 $rxvt->signal_connect_after (realize => sub { 383 $rxvt->signal_connect_after (realize => sub {
341 my $xid = $_[0]->window->get_xid; 384 my $xid = $_[0]->window->get_xid;
342 system "rxvt -embed $xid &"; 385 system "rxvt -embed $xid &";
343 }); 386 });
344 387
345 -pty-fd *fileno* 388 -pty-fd *file descriptor*
346 Tells rxvt NOT to execute any commands or create a new pty/tty pair 389 Tells rxvt NOT to execute any commands or create a new pty/tty pair
347 but instead use the given filehandle as the tty master. This is 390 but instead use the given file descriptor as the tty master. This is
348 useful if you want to drive rxvt as a generic terminal emulator 391 useful if you want to drive rxvt as a generic terminal emulator
349 without having to run a program within it. 392 without having to run a program within it.
350 393
351 If this switch is given, rxvt will not create any utmp/wtmp entries 394 If this switch is given, rxvt will not create any utmp/wtmp entries
352 and will not tinker with pty/tty permissions - you have to do that 395 and will not tinker with pty/tty permissions - you have to do that
353 yourself if you want that. 396 yourself if you want that.
397
398 As an extremely special case, specifying -1 will completely suppress
399 pty/tty operations.
354 400
355 Here is a example in perl that illustrates how this option can be 401 Here is a example in perl that illustrates how this option can be
356 used (a longer example is in doc/pty-fd): 402 used (a longer example is in doc/pty-fd):
357 403
358 use IO::Pty; 404 use IO::Pty;
… …
365 411
366 # now communicate with rxvt 412 # now communicate with rxvt
367 my $slave = $pty->slave; 413 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" } 414 while (<$slave>) { print $slave "got <$_>\n" }
369 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.
419
370RESOURCES (available also as long-options) 420RESOURCES (available also as long-options)
371 Note: `rxvt --help' gives a list of all resources (long options) 421 Note: `rxvt --help' gives a list of all resources (long options)
372 compiled into your version. 422 compiled into your version.
373 423
374 There are two different methods that rxvt can use to get the Xresource
375 data: using the X libraries (Xrm*-functions) or internal Xresources
376 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
377 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
378 xrdb. Many distribution do also load settings from the ~/.Xresources 425 distribution do also load settings from the ~/.Xresources file when X
379 file when X starts. rxvt will consult the following files/resources in 426 starts. rxvt will consult the following files/resources in order, with
380 order, with later settings overwriting earlier ones: 427 later settings overwriting earlier ones:
381 428
382 1. system-wide app-defaults file, either locale-dependent OR global 429 1. system-wide app-defaults file, either locale-dependent OR global
383 2. app-defaults file in $XAPPLRESDIR 430 2. app-defaults file in $XAPPLRESDIR
384 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 431 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
385 4. SCREEN_RESOURCES for the current screen 432 4. SCREEN_RESOURCES for the current screen
386 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 433 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
387 434
388 If compiled with internal Xresources support (i.e. rxvt -h lists 435 Note that when reading X resources, rxvt recognizes two class names:
389 .Xdefaults) then rxvt accepts application defaults set in 436 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
390 XAPPLOADDIR/URxvt (compile-time defined: usually 437 and the original *rxvt* to be easily configured, while the class name
391 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 438 URxvt allows resources unique to rxvt, to be shared between different
392 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
393 resources, rxvt recognizes two class names: XTerm and URxvt. The class
394 name Rxvt allows resources common to both rxvt and the original *rxvt*
395 to be easily configured, while the class name URxvt allows resources
396 unique to rxvt, notably colours and key-handling, to be shared between
397 different rxvt configurations. If no resources are specified, suitable 439 rxvt configurations. If no resources are specified, suitable defaults
398 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
399 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.
400 448
401 geometry: *geom* 449 geometry: *geom*
402 Create the window with the specified X window geometry [default 450 Create the window with the specified X window geometry [default
403 80x24]; option -geometry. 451 80x24]; option -geometry.
404 452
… …
466 inheritPixmap: *boolean* 514 inheritPixmap: *boolean*
467 True: make the background inherit the parent windows' pixmap, giving 515 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 516 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 517 pixmap.
470 518
519 *Please note that transparency of any kind if completely unsupported
520 by the author. Don't bug him with installation questions!*
521
471 fading: *number* 522 fading: *number*
472 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.
473 529
474 tintColor: *colour* 530 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 531 Tint the transparent background pixmap with the given colour; option
532 -tint.
476 533
477 shading: *number* 534 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 535 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 536 image in addition to tinting it.
480 537
481 scrollColor: *colour* 538 scrollColor: *colour*
482 Use the specified colour for the scrollbar [default #B2B2B2]. 539 Use the specified colour for the scrollbar [default #B2B2B2].
483 540
484 troughColor: *colour* 541 troughColor: *colour*
485 Use the specified colour for the scrollbar's trough area [default 542 Use the specified colour for the scrollbar's trough area [default
486 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 543 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
487 544
488 borderColor: *colour* 545 borderColor: *colour*
489 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
490 scrollbar and the text. 547 scrollbar and the text.
491 548
… …
498 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
499 specifies an integer number of images in that direction. No image 556 specifies an integer number of images in that direction. No image
500 will be magnified beyond 10 times its original size. The maximum 557 will be magnified beyond 10 times its original size. The maximum
501 permitted scale is 1000. [default 0x0+50+50] 558 permitted scale is 1000. [default 0x0+50+50]
502 559
503 menu: *file[;tag]*
504 Read in the specified menu file (note the `.menu' extension is
505 optional) and also optionally specify a starting tag to find. See
506 the reference documentation for details on the syntax for the
507 menuBar.
508
509 path: *path* 560 path: *path*
510 Specify the colon-delimited search path for finding files (XPM and 561 Specify the colon-delimited search path for finding XPM files.
511 menus), in addition to the paths specified by the RXVTPATH and PATH
512 environment variables.
513 562
514 font: *fontlist* 563 font: *fontlist*
515 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
516 names that are used in turn when trying to display Unicode 565 names that are checked in order when trying to find glyphs for
517 characters. The first font defines the cell size for characters; 566 characters. The first font defines the cell size for characters;
518 other fonts might be smaller, but not larger. A reasonable default 567 other fonts might be smaller, but not (in general) larger. A
519 font list is always appended to it. option -fn. 568 (hopefully) reasonable default font list is always appended to it;
569 option -fn.
520 570
521 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
522 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 572 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
523 "xft:". 573 "xft:".
524 574
… …
527 available hint currently is "codeset=codeset-name", and this is only 577 available hint currently is "codeset=codeset-name", and this is only
528 used for Xft fonts. 578 used for Xft fonts.
529 579
530 For example, this font resource 580 For example, this font resource
531 581
532 URxvt*font: 9x15bold,\ 582 URxvt.font: 9x15bold,\
533 -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,\
534 -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, \
535 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 585 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
536 xft:Code2000:antialias=false 586 xft:Code2000:antialias=false
537 587
… …
570 tried. 620 tried.
571 621
572 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
573 normal text font will being used for the given style. 623 normal text font will being used for the given style.
574 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
575 selectstyle: *mode* 632 selectstyle: *mode*
576 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
577 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
578 gives xterm style selection. 635 gives xterm style selection.
579 636
580 scrollstyle: *mode* 637 scrollstyle: *mode*
581 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
582 author's favourite.. 639 author's favourite.
583 640
584 title: *string* 641 title: *string*
585 Set window title string, the default title is the command-line 642 Set window title string, the default title is the command-line
586 specified after the -e option, if any, otherwise the application 643 specified after the -e option, if any, otherwise the application
587 name; option -title. 644 name; option -title.
… …
612 print-pipe: *string* 669 print-pipe: *string*
613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 670 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
614 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
615 Shift-Print to include the scrollback as well. 672 Shift-Print to include the scrollback as well.
616 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
617 scrollBar: *boolean* 683 scrollBar: *boolean*
618 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
619 scrollbar; option +sb. 685 scrollbar; option +sb.
620 686
621 scrollBar_right: *boolean* 687 scrollBar_right: *boolean*
… …
635 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
636 702
637 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
638 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
639 scrollTtyOutput is False); option -sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
640 scrollback buffer when tty recieves new lines; option +sw. 706 scrollback buffer when tty receives new lines; option +sw.
641 707
642 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
643 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
644 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
645 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
… …
660 borderLess: *boolean* 726 borderLess: *boolean*
661 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
662 the WM, the rxvt-unicode window will not have window decorations; 728 the WM, the rxvt-unicode window will not have window decorations;
663 option -bl. 729 option -bl.
664 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
665 termName: *termname* 737 termName: *termname*
666 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
667 variable; option -tn. 739 variable; option -tn.
668 740
669 linespace: *number* 741 linespace: *number*
… …
712 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)
713 is pressed. If unset it will send the sequence traditionally 785 is pressed. If unset it will send the sequence traditionally
714 associated with the Execute key. 786 associated with the Execute key.
715 787
716 cutchars: *string* 788 cutchars: *string*
717 The characters used as delimiters for double-click word selection. 789 The characters used as delimiters for double-click word selection
718 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:
719 800
720 BACKSLASH `"'&()*,;<=>?@[]{|} 801 BACKSLASH `"'&()*,;<=>?@[]{|}
721 802
722 preeditType: *style* 803 preeditType: *style*
723 OverTheSpot, OffTheSpot, Root; option -pt. 804 OverTheSpot, OffTheSpot, Root; option -pt.
… …
727 808
728 imLocale: *name* 809 imLocale: *name*
729 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
730 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
731 the input extension to be able to input japanese characters while 812 the input extension to be able to input japanese characters while
732 staying in another locale. option -imlocale. 813 staying in another locale; option -imlocale.
733 814
734 imFont: *fontset* 815 imFont: *fontset*
735 Specify the font-set used for XIM styles "OverTheSpot" or 816 Specify the font-set used for XIM styles "OverTheSpot" or
736 "OffTheSpot". It must be a standard X font set (XLFD patterns 817 "OffTheSpot". It must be a standard X font set (XLFD patterns
737 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
… …
740 to the base font. option -imfont. 821 to the base font. option -imfont.
741 822
742 tripleclickwords: *boolean* 823 tripleclickwords: *boolean*
743 Change the meaning of triple-click selection with the left mouse 824 Change the meaning of triple-click selection with the left mouse
744 button. Instead of selecting a full line it will extend the 825 button. Instead of selecting a full line it will extend the
745 selection to the end of the logical line only. option -tcw. 826 selection to the end of the logical line only; option -tcw.
746 827
747 insecure: *boolean* 828 insecure: *boolean*
748 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 829 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
749 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
750 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,
751 whether throuh a mail client displaying mail bodies unfiltered or 832 whether through a mail client displaying mail bodies unfiltered or
752 though write(1). Therefore, these sequences are disabled by default. 833 through write(1) or any other means. Therefore, these sequences are
753 (Note that other terminals, including xterm, have these sequences 834 disabled by default. (Note that many other terminals, including
754 enabled by default). You can enable them by setting this boolean 835 xterm, have these sequences enabled by default, which doesn't make
755 resource or specifying -insecure as an option. At the moment, this 836 it safer, though).
756 enabled display-answer, locale, findfont, icon label and window 837
757 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.
758 841
759 modifier: *modifier* 842 modifier: *modifier*
760 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,
761 super, mod1, mod2, mod3, mod4, mod5; option -mod. 844 super, mod1, mod2, mod3, mod4, mod5; option -mod.
762 845
763 answerbackString: *string* 846 answerbackString: *string*
764 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
765 (control-E) character is passed through. It may contain escape 848 (control-E) character is passed through. It may contain escape
766 values as described in the entry on keysym following. 849 values as described in the entry on keysym following.
767 850
768 secondaryScreen: *bool* 851 secondaryScreen: *boolean*
769 Turn on/off secondary screen (default enabled). 852 Turn on/off secondary screen (default enabled).
770 853
771 secondaryScroll: *bool* 854 secondaryScroll: *boolean*
772 Turn on/off secondary screen scroll (default enabled). If the this 855 Turn on/off secondary screen scroll (default enabled). If the this
773 option is enabled, scrolls on the secondary screen will change the 856 option is enabled, scrolls on the secondary screen will change the
774 scrollback buffer and switching to/from the secondary screen will 857 scrollback buffer and switching to/from the secondary screen will
775 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.
776 865
777 keysym.*sym*: *string* 866 keysym.*sym*: *string*
778 Compile *frills*: Associate *string* with keysym *sym*. The 867 Compile *frills*: Associate *string* with keysym *sym*. The
779 intervening resource name keysym. cannot be omitted. 868 intervening resource name keysym. cannot be omitted.
780 869
… …
799 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
800 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
801 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
802 it can start or end with whitespace. 891 it can start or end with whitespace.
803 892
804 Please note that you need to double the "\" when using 893 Please note that you need to double the "\" in resource files, as
805 "--enable-xgetdefault", as X itself does it's own de-escaping (you 894 Xlib itself does its own de-escaping (you can use "\033" instead of
806 can use "\033" instead of "\e" (and so on), which will work with 895 "\e" (and so on), which will work with both Xt and rxvt's own
807 both Xt and rxvt's own processing). 896 processing).
808 897
809 You can define a range of keysyms in one shot by providing a 898 You can define a range of keysyms in one shot by providing a
810 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 899 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
811 `/' should be a character not used by the strings. 900 `/' should be a character not used by the strings.
812 901
813 Its usage can be demonstrated by an example: 902 Its usage can be demonstrated by an example:
814 903
815 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 904 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
824 is interpreted and executed as rxvt's control sequence. For example 913 is interpreted and executed as rxvt's control sequence. For example
825 the following means "change the current locale to "zh_CN.GBK" when 914 the following means "change the current locale to "zh_CN.GBK" when
826 Control-Meta-c is being pressed": 915 Control-Meta-c is being pressed":
827 916
828 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 917 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
918
919 If *string* takes the form "perl:STRING", then the specified STRING
920 is passed to the "on_keyboard_command" perl handler. See the
921 rxvtperl(3) manpage. For example, the selection extension (activated
922 via "rxvt -pe selection") listens for "selection:rot13" events:
923
924 URxvt.keysym.M-C-c: perl:selection:rot13
829 925
830 Due the the large number of modifier combinations, a defined key 926 Due the the large number of modifier combinations, a defined key
831 mapping will match if at *at least* the specified identifiers are 927 mapping will match if at *at least* the specified identifiers are
832 being set, and no other key mappings with those and more bits are 928 being set, and no other key mappings with those and more bits are
833 being defined. That means that defining a key map for "a" will 929 being defined. That means that defining a key map for "a" will
… …
857 info): 953 info):
858 954
859 URxvt.keysym.M-C-3: command:\033[8;25;80t 955 URxvt.keysym.M-C-3: command:\033[8;25;80t
860 URxvt.keysym.M-C-4: command:\033[8;48;110t 956 URxvt.keysym.M-C-4: command:\033[8;48;110t
861 957
958 perl-ext-common: *string*
959 perl-ext: *string*
960 Comma-separated list(s) of perl extension scripts (default:
961 "default") to use in this terminal instance; option -pe.
962
963 Extension names can be prefixed with a "-" sign to prohibit using
964 them. This can be useful to selectively disable some extensions
965 loaded by default, or specified via the "perl-ext-common" resource.
966 For example, "default,-selection" will use all the default extension
967 except "selection".
968
969 Extension names can also be followed by an argument in angle
970 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
971 for searchable scrollback to Alt/Meta-s). Mentioning the same
972 extension multiple times with different arguments will pass multiple
973 arguments to the extension.
974
975 Each extension is looked up in the library directories, loaded if
976 necessary, and bound to the current terminal instance.
977
978 If both of these resources are the empty string, then the perl
979 interpreter will not be initialized. The idea behind two options is
980 that perl-ext-common will be used for extensions that should be
981 available to all instances, while perl-ext is used for specific
982 instances.
983
984 perl-eval: *string*
985 Perl code to be evaluated when all extensions have been registered.
986 See the rxvtperl(3) manpage. Due to security reasons, this resource
987 will be ignored when running setuid/setgid.
988
989 perl-lib: *path*
990 Colon-separated list of additional directories that hold extension
991 scripts. When looking for extensions specified by the "perl"
992 resource, rxvt will first look in these directories and then in
993 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
994 will be ignored when running setuid/setgid.
995
996 See the rxvtperl(3) manpage.
997
998 selection.pattern-*idx*: *perl-regex*
999 Additional selection patterns, see the rxvtperl(3) manpage for
1000 details.
1001
1002 selection-autotransform.*idx*: *perl-transform*
1003 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1004 details.
1005
1006 searchable-scrollback: *keysym*
1007 Sets the hotkey that starts the incremental scrollback buffer search
1008 (default: "M-s").
1009
1010 urlLauncher: *string*
1011 Specifies the program to be started with a URL argument. Used by the
1012 "selection-popup" and "mark-urls" perl extensions.
1013
1014 transient-for: *windowid*
1015 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1016 window id.
1017
1018 override-redirect: *boolean*
1019 Compile *frills*: Sets override-redirect for the terminal window,
1020 making it almost invisible to window managers; option
1021 -override-redirect.
1022
862THE SCROLLBAR 1023THE SCROLLBAR
863 Lines of text that scroll off the top of the rxvt window (resource: 1024 Lines of text that scroll off the top of the rxvt window (resource:
864 saveLines) and can be scrolled back using the scrollbar or by 1025 saveLines) and can be scrolled back using the scrollbar or by
865 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1026 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
866 fairly intuitive. The xterm-scrollbar is without arrows and its 1027 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
892 entire logical line (which can span multiple screen lines), unless 1053 entire logical line (which can span multiple screen lines), unless
893 modified by resource tripleclickwords. 1054 modified by resource tripleclickwords.
894 1055
895 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1056 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
896 (Compile: *frills*) will create a rectangular selection instead of a 1057 (Compile: *frills*) will create a rectangular selection instead of a
897 normal one. 1058 normal one. In this mode, every selected row becomes its own line in
1059 the selection, and trailing whitespace is visually underlined and
1060 removed from the selection.
898 1061
899 Insertion: 1062 Insertion:
900 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1063 Pressing and releasing the Middle mouse button in an rxvt window
901 an rxvt window causes the current text selection to be inserted as 1064 causes the value of the PRIMARY selection (or CLIPBOARD with the
902 if it had been typed on the keyboard. 1065 Meta modifier) to be inserted as if it had been typed on the
1066 keyboard.
1067
1068 Pressing Shift-Insert causes the value of the PRIMARY selection to
1069 be inserted too.
903 1070
904CHANGING FONTS 1071CHANGING FONTS
905 Changing fonts (or font sizes, respectively) via the keypad is not yet 1072 Changing fonts (or font sizes, respectively) via the keypad is not yet
906 supported in rxvt-unicode. Bug me if you need this. 1073 supported in rxvt-unicode. Bug me if you need this.
907 1074
908 You can, however, switch fonts at runtime using escape sequences (and 1075 You can, however, switch fonts at runtime using escape sequences, e.g.:
909 therefore using the menubar), e.g.:
910 1076
911 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1077 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1078
1079 You can use keyboard shortcuts, too:
1080
1081 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1082 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
912 1083
913 rxvt-unicode will automatically re-apply these fonts to the output so 1084 rxvt-unicode will automatically re-apply these fonts to the output so
914 far. 1085 far.
915 1086
916ISO 14755 SUPPORT 1087ISO 14755 SUPPORT
… …
918 character codes using the keyboard. It consists of 4 parts. The first 1089 character codes using the keyboard. It consists of 4 parts. The first
919 part is available rxvt-unicode has been compiled with "--enable-frills", 1090 part is available rxvt-unicode has been compiled with "--enable-frills",
920 the rest is available when rxvt-unicode was compiled with 1091 the rest is available when rxvt-unicode was compiled with
921 "--enable-iso14755". 1092 "--enable-iso14755".
922 1093
923 * 5.1: Basic method 1094 * 5.1: Basic method
1095
924 This allows you to enter unicode characters using their hexcode. 1096 This allows you to enter unicode characters using their hexcode.
925 1097
926 Start by pressing and holding both "Control" and "Shift", then enter 1098 Start by pressing and holding both "Control" and "Shift", then enter
927 hex-digits (between one and six). Releasing "Control" and "Shift" 1099 hex-digits (between one and six). Releasing "Control" and "Shift"
928 will commit the character as if it were typed directly. While 1100 will commit the character as if it were typed directly. While
… …
934 address, which you cannot type. Fortunately, the card has the e-mail 1106 address, which you cannot type. Fortunately, the card has the e-mail
935 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1107 address printed as hexcodes, e.g. "671d 65e5". You can enter this
936 easily by pressing "Control" and "Shift", followed by 1108 easily by pressing "Control" and "Shift", followed by
937 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1109 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
938 1110
939 * 5.2: Keyboard symbols entry method 1111 * 5.2: Keyboard symbols entry method
1112
940 This mode lets you input characters representing the keycap symbols 1113 This mode lets you input characters representing the keycap symbols
941 of your keyboard, if representable in the current locale encoding. 1114 of your keyboard, if representable in the current locale encoding.
942 1115
943 Start by pressing "Control" and "Shift" together, then releasing 1116 Start by pressing "Control" and "Shift" together, then releasing
944 them. The next special key (cursor keys, home etc.) you enter will 1117 them. The next special key (cursor keys, home etc.) you enter will
945 not invoke it's usual function but instead will insert the 1118 not invoke its usual function but instead will insert the
946 corresponding keycap symbol. The symbol will only be entered when 1119 corresponding keycap symbol. The symbol will only be entered when
947 the key has been released, otherwise pressing e.g. "Shift" would 1120 the key has been released, otherwise pressing e.g. "Shift" would
948 enter the symbol for "ISO Level 2 Switch", although your intention 1121 enter the symbol for "ISO Level 2 Switch", although your intention
949 might have been to enter a reverse tab (Shift-Tab). 1122 might have been to enter a reverse tab (Shift-Tab).
950 1123
951 * 5.3: Screen-selection entry method 1124 * 5.3: Screen-selection entry method
1125
952 While this is implemented already (it's basically the selection 1126 While this is implemented already (it's basically the selection
953 mechanism), it could be extended by displaying a unicode character 1127 mechanism), it could be extended by displaying a unicode character
954 map. 1128 map.
955 1129
956 * 5.4: Feedback method for identifying displayed characters for later 1130 * 5.4: Feedback method for identifying displayed characters for later
957 input 1131 input
1132
958 This method lets you display the unicode character code associated 1133 This method lets you display the unicode character code associated
959 with characters already displayed. 1134 with characters already displayed.
960 1135
961 You enter this mode by holding down "Control" and "Shift" together, 1136 You enter this mode by holding down "Control" and "Shift" together,
962 then pressing and holding the left mouse button and moving around. 1137 then pressing and holding the left mouse button and moving around.
… …
979 setgid to root or to some other group on others. 1154 setgid to root or to some other group on others.
980 1155
981COLORS AND GRAPHICS 1156COLORS AND GRAPHICS
982 In addition to the default foreground and background colours, rxvt can 1157 In addition to the default foreground and background colours, rxvt can
983 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1158 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
984 versions of the same). Here is a list of the colours with their rgb.txt 1159 versions of the same). Here is a list of the colours with their names.
985 names.
986 1160
987 color0 (black) = Black 1161 color0 (black) = Black
988 color1 (red) = Red3 1162 color1 (red) = Red3
989 color2 (green) = Green3 1163 color2 (green) = Green3
990 color3 (yellow) = Yellow3 1164 color3 (yellow) = Yellow3
991 color4 (blue) = Blue3 1165 color4 (blue) = Blue3
992 color5 (magenta) = Magenta3 1166 color5 (magenta) = Magenta3
993 color6 (cyan) = Cyan3 1167 color6 (cyan) = Cyan3
994 color7 (white) = AntiqueWhite 1168 color7 (white) = AntiqueWhite
995 color8 (bright black) = Grey25 1169 color8 (bright black) = Grey25
996 color9 (bright red) = Red 1170 color9 (bright red) = Red
997 color10 (bright green) = Green 1171 color10 (bright green) = Green
998 color11 (bright yellow) = Yellow 1172 color11 (bright yellow) = Yellow
999 color12 (bright blue) = Blue 1173 color12 (bright blue) = Blue
1000 color13 (bright magenta) = Magenta 1174 color13 (bright magenta) = Magenta
1001 color14 (bright cyan) = Cyan 1175 color14 (bright cyan) = Cyan
1002 color15 (bright white) = White 1176 color15 (bright white) = White
1003 foreground = Black 1177 foreground = Black
1004 background = White 1178 background = White
1005
1006 It is also possible to specify the colour values of foreground, 1179 It is also possible to specify the colour values of foreground,
1007 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1180 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1008 0-15, as a convenient shorthand to reference the colour name of 1181 0-15, as a convenient shorthand to reference the colour name of
1009 color0-color15. 1182 color0-color15.
1010 1183
1184 In addition to the colours defined above, rxvt offers an additional 72
1185 colours. The first 64 of those (with indices 16 to 79) consist of a
1186 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1187 by 8 additional shades of gray (with indices 80 to 87).
1188
1189 Together, all those colours implement the 88 colour xterm colours. Only
1190 the first 16 can be changed using resources currently, the rest can only
1191 be changed via command sequences ("escape codes").
1192
1011 Note that -rv ("reverseVideo: True") simulates reverse video by always 1193 Note that -rv ("reverseVideo: True") simulates reverse video by always
1012 swapping the foreground/background colours. This is in contrast to 1194 swapping the foreground/background colours. This is in contrast to
1013 *xterm*(1) where the colours are only swapped if they have not otherwise 1195 *xterm*(1) where the colours are only swapped if they have not otherwise
1014 been specified. For example, 1196 been specified. For example,
1015 1197
1016 rxvt -fg Black -bg White -rv 1198 rxvt -fg Black -bg White -rv
1017 would yield White on Black, while on *xterm*(1) it would yield Black 1199 would yield White on Black, while on *xterm*(1) it would yield Black
1018 on White. 1200 on White.
1019 1201
1202 ALPHA CHANNEL SUPPORT
1203 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1204 get their act together, rxvt-unicode will support
1205 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1206 digits/component) colour specifications, in addition to the ones
1207 provided by X, where the additional A component specifies opacity
1208 (alpha) values. The minimum value of 0 is completely transparent). You
1209 can also prefix any color with "[a]", where "a" is on to four hex digits
1210 specifiying the opacity value.
1211
1212 You probably need to specify "-depth 32", too, and have the luck that
1213 your X-server uses ARGB pixel layout, as X is far from just supporting
1214 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1215
1216 For example, the following selects an almost completely transparent red
1217 background, and an almost opaque pink foreground:
1218
1219 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1220
1221 *Please note that transparency of any kind if completely unsupported by
1222 the author. Don't bug him with installation questions!*
1223
1020ENVIRONMENT 1224ENVIRONMENT
1021 rxvt sets and/or uses the following environment variables: 1225 rxvt sets and/or uses the following environment variables:
1022 1226
1023 TERM 1227 TERM
1024 Normally set to "rxvt-unicode", unless overwritten at configure 1228 Normally set to "rxvt-unicode", unless overwritten at configure
1025 time, via resources or on the commandline. 1229 time, via resources or on the command line.
1026 1230
1027 COLORTERM 1231 COLORTERM
1028 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1232 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1029 with XPM support, and optionally with the added extension "-mono" to 1233 with XPM support, and optionally with the added extension "-mono" to
1030 indicate that rxvt-unicode runs on a monochrome screen. 1234 indicate that rxvt-unicode runs on a monochrome screen.
1031 1235
1032 COLORFGBG 1236 COLORFGBG
1033 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1237 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
… …
1047 Set to the terminfo directory iff rxvt was configured with 1251 Set to the terminfo directory iff rxvt was configured with
1048 "--with-terminfo=PATH". 1252 "--with-terminfo=PATH".
1049 1253
1050 DISPLAY 1254 DISPLAY
1051 Used by rxvt to connect to the display and set to the correct 1255 Used by rxvt to connect to the display and set to the correct
1052 display in it's child processes. 1256 display in its child processes.
1053 1257
1054 SHELL 1258 SHELL
1055 The shell to be used for command execution, defaults to "/bin/sh". 1259 The shell to be used for command execution, defaults to "/bin/sh".
1056 1260
1057 RXVTPATH
1058 The path where rxvt looks for support files such as menu and xpm
1059 files.
1060
1061 PATH
1062 Used in the same way as "RXVTPATH".
1063
1064 RXVT_SOCKET 1261 RXVT_SOCKET
1065 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1262 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1066 1263
1067 Default "$HOME/.rxvt-unicode-<nodename". 1264 Default $HOME/.rxvt-unicode-*<nodename*.
1068 1265
1069 HOME 1266 HOME
1070 Used to locate the default directory for the unix domain socket for 1267 Used to locate the default directory for the unix domain socket for
1071 daemon communications and to locate various resource files (such as 1268 daemon communications and to locate various resource files (such as
1072 ".Xdefaults") 1269 ".Xdefaults")
… …
1081FILES 1278FILES
1082 /usr/lib/X11/rgb.txt 1279 /usr/lib/X11/rgb.txt
1083 Color names. 1280 Color names.
1084 1281
1085SEE ALSO 1282SEE ALSO
1086 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1283 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1087 1284 tty(4), utmp(5)
1088BUGS
1089 Check the BUGS file for an up-to-date list.
1090
1091 Cursor change support is not yet implemented.
1092
1093 Click-and-drag doesn't work with X11 mouse report overriding.
1094 1285
1095CURRENT PROJECT COORDINATOR 1286CURRENT PROJECT COORDINATOR
1096 Project Coordinator 1287 Project Coordinator
1097 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1288 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1098 1289
1099 <http://software.schmorp.de/#rxvt-unicode> 1290 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1100 1291
1101AUTHORS 1292AUTHORS
1102 John Bovey 1293 John Bovey
1103 University of Kent, 1992, wrote the original Xvt. 1294 University of Kent, 1992, wrote the original Xvt.
1104 1295
… …
1115 1306
1116 Oezguer Kesim <kesim@math.fu-berlin.de> 1307 Oezguer Kesim <kesim@math.fu-berlin.de>
1117 Project Coordinator (changes.txt 2.21a to 2.4.5) 1308 Project Coordinator (changes.txt 2.21a to 2.4.5)
1118 1309
1119 Geoff Wing <gcw@pobox.com> 1310 Geoff Wing <gcw@pobox.com>
1120 Rewrote screen display and text selection routines. Project 1311 Rewrote screen display and text selection routines.
1312
1121 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1313 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1122 1314
1123 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1315 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1124 Forked rxvt-unicode, rewrote most of the display code and internal 1316 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1125 character handling to store text in unicode, improve xterm 1317 perl extension, random hacks, numerous bugfixes and extensions.
1126 compatibility and apply numerous other bugfixes and extensions.
1127 1318
1128 Project Coordinator (Changes 1.0 -) 1319 Project Coordinator (Changes 1.0 -)
1129 1320
1321 Emanuele Giaquinta <e.giaquinta@glauco.it>
1322 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1323

Diff Legend

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