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.22 by root, Sat Jun 18 11:01:41 2005 UTC vs.
Revision 1.66 by root, Sat Jun 2 04:58:58 2007 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 5.5, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.2, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. That document is also 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
24 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
25 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
26 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
27 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devenagari. Don't expect pretty output when using
28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29 should work fine, though. A somewhat difficult case are left-to-right 29 should work fine, though. A somewhat difficult case are right-to-left
30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
32 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
33 otherwise), but that might change. 33 otherwise), but that might change.
34 34
35 If you are looking for a terminal that supports more exotic scripts, let 35 If you are looking for a terminal that supports more exotic scripts, let
36 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
37 terminal emulator. In fact, the reason rxvt-unicode was born was solely 37 terminal emulator. In fact, the reason rxvt-unicode was born was solely
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
42 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
43 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
44 able to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 it's predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
48 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot bugs less than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of it's features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
60 It also makes technical information about escape sequences (which have 60 It also makes technical information about escape sequences (which have
61 been extended) easier accessible: see rxvt(7) for technical reference 61 been extended) more accessible: see rxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In
66 keeping with the smaller-is-better philosophy, options may be eliminated 66 keeping with the smaller-is-better philosophy, options may be eliminated
… …
84 -display *displayname* 84 -display *displayname*
85 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88 88
89 -depth *bitdepth*
90 Compile *xft*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
93 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
94 98
95 -j|+j 99 -j|+j
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling; resource jumpScroll.
97 101
98 -ip|+ip 102 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 103 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 104 -tr; resource inheritPixmap.
101 105
106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions! Read the
108 FAQ (man 7 rxvt)!*
109
102 -fade *number* 110 -fade *number*
103 Fade the text by the given percentage when focus is lost. resource 111 Fade the text by the given percentage when focus is lost. Small
104 fading. 112 values fade a little only, 100 completely replaces all colours by
113 the fade colour; resource fading.
114
115 -fadecolor *colour*
116 Fade to this colour when fading is used (see -fade). The default
117 colour is opaque black. resource fadeColor.
105 118
106 -tint *colour* 119 -tint *colour*
107 Tint the transparent background pixmap with the given colour when 120 Tint the transparent background pixmap with the given colour when
108 transparency is enabled with -tr or -ip. See also the -sh option 121 transparency is enabled with -tr or -ip. This only works for
122 non-tiled backgrounds, currently. See also the -sh option that can
109 that can be used to brighten or darken the image in addition to 123 be used to brighten or darken the image in addition to tinting it;
110 tinting it. 124 resource *tintColor*. Example:
125
126 rxvt -tr -tint blue -sh 40
111 127
112 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 128 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
113 background image in addition to tinting it (i.e. -tint must be 129 background image in addition to tinting it (i.e. -tint must be
114 specified, too, e.g. "-tint white"). 130 specified, too, e.g. "-tint white"); resource *shading*.
115 131
116 -bg *colour* 132 -bg *colour*
117 Window background colour; resource background. 133 Window background colour; resource background.
118 134
119 -fg *colour* 135 -fg *colour*
… …
138 The colour of the border around the text area and between the 154 The colour of the border around the text area and between the
139 scrollbar and the text; resource borderColor. 155 scrollbar and the text; resource borderColor.
140 156
141 -fn *fontlist* 157 -fn *fontlist*
142 Select the fonts to be used. This is a comma separated list of font 158 Select the fonts to be used. This is a comma separated list of font
143 names that are used in turn when trying to display Unicode 159 names that are checked in order when trying to find glyphs for
144 characters. The first font defines the cell size for characters; 160 characters. The first font defines the cell size for characters;
145 other fonts might be smaller, but not (in general) larger. A 161 other fonts might be smaller, but not (in general) larger. A
146 (hopefully) reasonable default font list is always appended to it. 162 (hopefully) reasonable default font list is always appended to it.
147 See resource font for more details. 163 See resource font for more details.
148 164
149 In short, to specify an X11 core font, just specify it's name or 165 In short, to specify an X11 core font, just specify its name or
150 prefix it with "x:". To specify an XFT-font, you need to prefix it 166 prefix it with "x:". To specify an XFT-font, you need to prefix it
151 with "xft:", e.g.: 167 with "xft:", e.g.:
152 168
153 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 169 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
154 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 170 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
155 171
156 See also the question "How does rxvt-unicode choose fonts?" in the 172 See also the question "How does rxvt-unicode choose fonts?" in the
157 FAQ section of rxvt(7). 173 FAQ section of rxvt(7).
158 174
159 -fb *fontlist* 175 -fb *fontlist*
160 Compile font-styles: The bold font list to use when bold characters 176 Compile *font-styles*: The bold font list to use when bold
161 are to be printed. See resource boldFont for details. 177 characters are to be printed. See resource boldFont for details.
162 178
163 -fi *fontlist* 179 -fi *fontlist*
164 Compile font-styles: The italic font list to use when bold 180 Compile *font-styles*: The italic font list to use when *italic*
165 characters are to be printed. See resource italicFont for details. 181 characters are to be printed. See resource italicFont for details.
166 182
167 -fbi *fontlist* 183 -fbi *fontlist*
168 Compile font-styles: The bold italic font list to use when bold 184 Compile *font-styles*: The bold italic font list to use when *bold
169 characters are to be printed. See resource boldItalicFont for 185 italic* characters are to be printed. See resource boldItalicFont
186 for details.
187
188 -is|+is
189 Compile *font-styles*: Bold/Italic font styles imply high intensity
190 foreground/background (default). See resource intensityStyles for
170 details. 191 details.
171 192
172 -name *name* 193 -name *name*
173 Specify the application name under which resources are to be 194 Specify the application name under which resources are to be
174 obtained, rather than the default executable file name. Name should 195 obtained, rather than the default executable file name. Name should
… …
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
… …
290 Set the font set to use for the X Input Method, see resource imFont 327 Set the font set to use for the X Input Method, see resource imFont
291 for more info. 328 for more info.
292 329
293 -tcw 330 -tcw
294 Change the meaning of triple-click selection with the left mouse 331 Change the meaning of triple-click selection with the left mouse
332 button. Only effective when the original (non-perl) selection code
295 button. Instead of selecting a full line it will extend the 333 is in-use. Instead of selecting a full line it will extend the
296 selection the end of the logical line only. resource 334 selection the end of the logical line only. resource
297 tripleclickwords. 335 tripleclickwords.
298 336
299 -insecure 337 -insecure
300 Enable "insecure" mode, which currently enables most of the escape 338 Enable "insecure" mode, which currently enables most of the escape
… …
311 349
312 -ssr|+ssr 350 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 351 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 352 secondaryScroll.
315 353
354 -hold|+hold
355 Turn on/off hold window after exit support. If enabled, rxvt will
356 not immediately destroy its window when the program executed within
357 it exits. Instead, it will wait till it is being killed or closed by
358 the user; resource hold.
359
316 -keysym.*sym* *string* 360 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 361 Remap a key symbol. See resource keysym.
318 362
319 -embed *windowid* 363 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window, 364 Tells rxvt to embed its windows into an already-existing window,
321 which enables applications to easily embed a terminal. 365 which enables applications to easily embed a terminal.
322 366
323 Right now, rxvt will first unmap/map the specified window, so it 367 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 368 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 369 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. 372 The window will not be destroyed when rxvt exits.
329 373
330 It might be useful to know that rxvt will not close file descriptors 374 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 375 passed to it (except for stdin/out/err, of course), so you can use
332 file descriptors to communicate with the programs within the 376 file descriptors to communicate with the programs within the
333 terminal. This works regardless of wether the "-embed" option was 377 terminal. This works regardless of whether the "-embed" option was
334 used or not. 378 used or not.
335 379
336 Here is a short Gtk2-perl snippet that illustrates how this option 380 Here is a short Gtk2-perl snippet that illustrates how this option
337 can be used (a longer example is in doc/embed): 381 can be used (a longer example is in doc/embed):
338 382
… …
340 $rxvt->signal_connect_after (realize => sub { 384 $rxvt->signal_connect_after (realize => sub {
341 my $xid = $_[0]->window->get_xid; 385 my $xid = $_[0]->window->get_xid;
342 system "rxvt -embed $xid &"; 386 system "rxvt -embed $xid &";
343 }); 387 });
344 388
345 -pty-fd *fileno* 389 -pty-fd *file descriptor*
346 Tells rxvt NOT to execute any commands or create a new pty/tty pair 390 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 391 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 392 useful if you want to drive rxvt as a generic terminal emulator
349 without having to run a program within it. 393 without having to run a program within it.
350 394
351 If this switch is given, rxvt will not create any utmp/wtmp entries 395 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 396 and will not tinker with pty/tty permissions - you have to do that
353 yourself if you want that. 397 yourself if you want that.
398
399 As an extremely special case, specifying -1 will completely suppress
400 pty/tty operations.
354 401
355 Here is a example in perl that illustrates how this option can be 402 Here is a example in perl that illustrates how this option can be
356 used (a longer example is in doc/pty-fd): 403 used (a longer example is in doc/pty-fd):
357 404
358 use IO::Pty; 405 use IO::Pty;
… …
365 412
366 # now communicate with rxvt 413 # now communicate with rxvt
367 my $slave = $pty->slave; 414 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" } 415 while (<$slave>) { print $slave "got <$_>\n" }
369 416
417 -pe *string*
418 Comma-separated list of perl extension scripts to use (or not to
419 use) in this terminal instance. See resource perl-ext for details.
420
370RESOURCES (available also as long-options) 421RESOURCES (available also as long-options)
371 Note: `rxvt --help' gives a list of all resources (long options) 422 Note: `rxvt --help' gives a list of all resources (long options)
372 compiled into your version. 423 compiled into your version.
373 424
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 425 You can set and change the resources using X11 tools like xrdb. Many
378 xrdb. Many distribution do also load settings from the ~/.Xresources 426 distribution do also load settings from the ~/.Xresources file when X
379 file when X starts. rxvt will consult the following files/resources in 427 starts. rxvt will consult the following files/resources in order, with
380 order, with later settings overwriting earlier ones: 428 later settings overwriting earlier ones:
381 429
382 1. system-wide app-defaults file, either locale-dependent OR global 430 1. system-wide app-defaults file, either locale-dependent OR global
383 2. app-defaults file in $XAPPLRESDIR 431 2. app-defaults file in $XAPPLRESDIR
384 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 432 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
385 4. SCREEN_RESOURCES for the current screen 433 4. SCREEN_RESOURCES for the current screen
386 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 434 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
387 435
388 If compiled with internal Xresources support (i.e. rxvt -h lists 436 Note that when reading X resources, rxvt recognizes two class names:
389 .Xdefaults) then rxvt accepts application defaults set in 437 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
390 XAPPLOADDIR/URxvt (compile-time defined: usually 438 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 439 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 440 rxvt configurations. If no resources are specified, suitable defaults
398 defaults will be used. Command-line arguments can be used to override 441 will be used. Command-line arguments can be used to override resource
399 resource settings. The following resources are allowed: 442 settings. The following resources are supported (you might want to check
443 the rxvtperl(3) manpage for additional settings by perl extensions not
444 documented here):
445
446 depth: *bitdepth*
447 Compile *xft*: Attempt to find a visual with the given bit depth;
448 option -depth.
400 449
401 geometry: *geom* 450 geometry: *geom*
402 Create the window with the specified X window geometry [default 451 Create the window with the specified X window geometry [default
403 80x24]; option -geometry. 452 80x24]; option -geometry.
404 453
… …
436 Use the specified colour to display underlined characters when the 485 Use the specified colour to display underlined characters when the
437 foreground colour is the default. 486 foreground colour is the default.
438 487
439 colorRV: *colour* 488 colorRV: *colour*
440 Use the specified colour as the background for reverse video 489 Use the specified colour as the background for reverse video
441 characters. 490 characters when OPTION_HC is disabled (--disable-frills).
442 491
443 underlineColor: *colour* 492 underlineColor: *colour*
444 If set, use the specified colour as the colour for the underline 493 If set, use the specified colour as the colour for the underline
445 itself. If unset, use the foreground colour. 494 itself. If unset, use the foreground colour.
446 495
… …
466 inheritPixmap: *boolean* 515 inheritPixmap: *boolean*
467 True: make the background inherit the parent windows' pixmap, giving 516 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 517 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 518 pixmap.
470 519
520 *Please note that transparency of any kind if completely unsupported
521 by the author. Don't bug him with installation questions!*
522
471 fading: *number* 523 fading: *number*
472 Fade the text by the given percentage when focus is lost. 524 Fade the text by the given percentage when focus is lost; option
525 -fade.
526
527 fadeColor: *colour*
528 Fade to this colour, when fading is used (see fading:). The default
529 colour is black; option -fadecolor.
473 530
474 tintColor: *colour* 531 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 532 Tint the transparent background pixmap with the given colour; option
533 -tint.
476 534
477 shading: *number* 535 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 536 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 537 image in addition to tinting it; option -sh.
480 538
481 scrollColor: *colour* 539 scrollColor: *colour*
482 Use the specified colour for the scrollbar [default #B2B2B2]. 540 Use the specified colour for the scrollbar [default #B2B2B2].
483 541
484 troughColor: *colour* 542 troughColor: *colour*
… …
498 scale of 1 displays the image without any scaling. A scale of 2 to 9 556 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 557 specifies an integer number of images in that direction. No image
500 will be magnified beyond 10 times its original size. The maximum 558 will be magnified beyond 10 times its original size. The maximum
501 permitted scale is 1000. [default 0x0+50+50] 559 permitted scale is 1000. [default 0x0+50+50]
502 560
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* 561 path: *path*
510 Specify the colon-delimited search path for finding files (XPM and 562 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 563
514 font: *fontlist* 564 font: *fontlist*
515 Select the fonts to be used. This is a comma separated list of font 565 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 566 names that are checked in order when trying to find glyphs for
517 characters. The first font defines the cell size for characters; 567 characters. The first font defines the cell size for characters;
518 other fonts might be smaller, but not larger. A reasonable default 568 other fonts might be smaller, but not (in general) larger. A
519 font list is always appended to it. option -fn. 569 (hopefully) reasonable default font list is always appended to it;
570 option -fn.
520 571
521 Each font can either be a standard X11 core font (XLFD) name, with 572 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 573 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
523 "xft:". 574 "xft:".
524 575
… …
527 available hint currently is "codeset=codeset-name", and this is only 578 available hint currently is "codeset=codeset-name", and this is only
528 used for Xft fonts. 579 used for Xft fonts.
529 580
530 For example, this font resource 581 For example, this font resource
531 582
532 URxvt*font: 9x15bold,\ 583 URxvt.font: 9x15bold,\
533 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 584 -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, \ 585 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
535 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 586 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
536 xft:Code2000:antialias=false 587 xft:Code2000:antialias=false
537 588
… …
570 tried. 621 tried.
571 622
572 If set, but empty, then this specific style is disabled and the 623 If set, but empty, then this specific style is disabled and the
573 normal text font will being used for the given style. 624 normal text font will being used for the given style.
574 625
626 intensityStyles: *boolean*
627 When font styles are not enabled, or this option is enabled (True,
628 option -is, the default), bold and italic font styles imply high
629 intensity foreground/background colours. Disabling this option
630 (False, option +is) disables this behaviour, the high intensity
631 colours are not reachable.
632
575 selectstyle: *mode* 633 selectstyle: *mode*
576 Set mouse selection style to old which is 2.20, oldword which is 634 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 635 xterm style with 2.20 old word selection, or anything else which
578 gives xterm style selection. 636 gives xterm style selection. Only effective when the original
637 (non-perl) selection code is in use.
579 638
580 scrollstyle: *mode* 639 scrollstyle: *mode*
581 Set scrollbar style to rxvt, plain, next or xterm. plain is the 640 Set scrollbar style to rxvt, plain, next or xterm. plain is the
582 author's favourite. 641 author's favourite.
583 642
… …
593 652
594 mapAlert: *boolean* 653 mapAlert: *boolean*
595 True: de-iconify (map) on receipt of a bell character. False: no 654 True: de-iconify (map) on receipt of a bell character. False: no
596 de-iconify (map) on receipt of a bell character [default]. 655 de-iconify (map) on receipt of a bell character [default].
597 656
657 urgentOnBell: *boolean*
658 True: set the urgency hint for the wm on receipt of a bell
659 character. False: do not set the urgency hint [default].
660
598 visualBell: *boolean* 661 visualBell: *boolean*
599 True: use visual bell on receipt of a bell character; option -vb. 662 True: use visual bell on receipt of a bell character; option -vb.
600 False: no visual bell [default]; option +vb. 663 False: no visual bell [default]; option +vb.
601 664
602 loginShell: *boolean* 665 loginShell: *boolean*
… …
612 print-pipe: *string* 675 print-pipe: *string*
613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 676 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 677 Print to initiate a screen dump to the printer and Ctrl-Print or
615 Shift-Print to include the scrollback as well. 678 Shift-Print to include the scrollback as well.
616 679
680 The string will be interpreted as if typed into the shell as-is.
681
682 Example:
683
684 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
685
686 This creates a new file in your home directory with the screen
687 contents every time you hit "Print".
688
617 scrollBar: *boolean* 689 scrollBar: *boolean*
618 True: enable the scrollbar [default]; option -sb. False: disable the 690 True: enable the scrollbar [default]; option -sb. False: disable the
619 scrollbar; option +sb. 691 scrollbar; option +sb.
620 692
621 scrollBar_right: *boolean* 693 scrollBar_right: *boolean*
… …
635 do not scroll to bottom when tty receives output; option +si. 707 do not scroll to bottom when tty receives output; option +si.
636 708
637 scrollWithBuffer: *boolean* 709 scrollWithBuffer: *boolean*
638 True: scroll with scrollback buffer when tty receives new lines (and 710 True: scroll with scrollback buffer when tty receives new lines (and
639 scrollTtyOutput is False); option -sw. False: do not scroll with 711 scrollTtyOutput is False); option -sw. False: do not scroll with
640 scrollback buffer when tty recieves new lines; option +sw. 712 scrollback buffer when tty receives new lines; option +sw.
641 713
642 scrollTtyKeypress: *boolean* 714 scrollTtyKeypress: *boolean*
643 True: scroll to bottom when a non-special key is pressed. Special 715 True: scroll to bottom when a non-special key is pressed. Special
644 keys are those which are intercepted by rxvt-unicode for special 716 keys are those which are intercepted by rxvt-unicode for special
645 handling and are not passed onto the shell; option -sk. False: do 717 handling and are not passed onto the shell; option -sk. False: do
… …
660 borderLess: *boolean* 732 borderLess: *boolean*
661 Set MWM hints to request a borderless window, i.e. if honoured by 733 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; 734 the WM, the rxvt-unicode window will not have window decorations;
663 option -bl. 735 option -bl.
664 736
737 skipBuiltinGlyphs: *boolean*
738 Compile *frills*: Disable the usage of the built-in block
739 graphics/line drawing characters and just rely on what the specified
740 fonts provide. Use this if you have a good font and want to use its
741 block graphic glyphs; option -sbg.
742
665 termName: *termname* 743 termName: *termname*
666 Specifies the terminal type name to be set in the TERM environment 744 Specifies the terminal type name to be set in the TERM environment
667 variable; option -tn. 745 variable; option -tn.
668 746
669 linespace: *number* 747 linespace: *number*
… …
712 The string to send when the delete key (not the keypad delete key) 790 The string to send when the delete key (not the keypad delete key)
713 is pressed. If unset it will send the sequence traditionally 791 is pressed. If unset it will send the sequence traditionally
714 associated with the Execute key. 792 associated with the Execute key.
715 793
716 cutchars: *string* 794 cutchars: *string*
717 The characters used as delimiters for double-click word selection. 795 The characters used as delimiters for double-click word selection
718 The built-in default: 796 (whitespace delimiting is added automatically if resource is given).
797
798 When the perl selection extension is in use (the default if compiled
799 in, see the rxvtperl(3) manpage), a suitable regex using these
800 characters will be created (if the resource exists, otherwise, no
801 regex will be created). In this mode, characters outside ISO-8859-1
802 can be used.
803
804 When the selection extension is not used, only ISO-8859-1 characters
805 can be used. If not specified, the built-in default is used:
719 806
720 BACKSLASH `"'&()*,;<=>?@[]{|} 807 BACKSLASH `"'&()*,;<=>?@[]{|}
721 808
722 preeditType: *style* 809 preeditType: *style*
723 OverTheSpot, OffTheSpot, Root; option -pt. 810 OverTheSpot, OffTheSpot, Root; option -pt.
… …
727 814
728 imLocale: *name* 815 imLocale: *name*
729 The locale to use for opening the IM. You can use an "LC_CTYPE" of 816 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 817 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 818 the input extension to be able to input japanese characters while
732 staying in another locale. option -imlocale. 819 staying in another locale; option -imlocale.
733 820
734 imFont: *fontset* 821 imFont: *fontset*
735 Specify the font-set used for XIM styles "OverTheSpot" or 822 Specify the font-set used for XIM styles "OverTheSpot" or
736 "OffTheSpot". It must be a standard X font set (XLFD patterns 823 "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 824 separated by commas), i.e. it's not in the same format as the other
… …
740 to the base font. option -imfont. 827 to the base font. option -imfont.
741 828
742 tripleclickwords: *boolean* 829 tripleclickwords: *boolean*
743 Change the meaning of triple-click selection with the left mouse 830 Change the meaning of triple-click selection with the left mouse
744 button. Instead of selecting a full line it will extend the 831 button. Instead of selecting a full line it will extend the
745 selection to the end of the logical line only. option -tcw. 832 selection to the end of the logical line only; option -tcw.
746 833
747 insecure: *boolean* 834 insecure: *boolean*
748 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 835 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
749 that echo arbitrary strings like the icon name or the locale. This 836 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, 837 could be abused if somebody gets 8-bit-clean access to your display,
751 whether throuh a mail client displaying mail bodies unfiltered or 838 whether through a mail client displaying mail bodies unfiltered or
752 though write(1). Therefore, these sequences are disabled by default. 839 through write(1) or any other means. Therefore, these sequences are
753 (Note that other terminals, including xterm, have these sequences 840 disabled by default. (Note that many other terminals, including
754 enabled by default). You can enable them by setting this boolean 841 xterm, have these sequences enabled by default, which doesn't make
755 resource or specifying -insecure as an option. At the moment, this 842 it safer, though).
756 enabled display-answer, locale, findfont, icon label and window 843
757 title requests as well as dynamic menubar dispatch. 844 You can enable them by setting this boolean resource or specifying
845 -insecure as an option. At the moment, this enables display-answer,
846 locale, findfont, icon label and window title requests.
758 847
759 modifier: *modifier* 848 modifier: *modifier*
760 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 849 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
761 super, mod1, mod2, mod3, mod4, mod5; option -mod. 850 super, mod1, mod2, mod3, mod4, mod5; option -mod.
762 851
763 answerbackString: *string* 852 answerbackString: *string*
764 Specify the reply rxvt-unicode sends to the shell when an ENQ 853 Specify the reply rxvt-unicode sends to the shell when an ENQ
765 (control-E) character is passed through. It may contain escape 854 (control-E) character is passed through. It may contain escape
766 values as described in the entry on keysym following. 855 values as described in the entry on keysym following.
767 856
768 secondaryScreen: *bool* 857 secondaryScreen: *boolean*
769 Turn on/off secondary screen (default enabled). 858 Turn on/off secondary screen (default enabled).
770 859
771 secondaryScroll: *bool* 860 secondaryScroll: *boolean*
772 Turn on/off secondary screen scroll (default enabled). If the this 861 Turn on/off secondary screen scroll (default enabled). If this
773 option is enabled, scrolls on the secondary screen will change the 862 option is enabled, scrolls on the secondary screen will change the
774 scrollback buffer and switching to/from the secondary screen will 863 scrollback buffer and switching to/from the secondary screen will
775 instead scroll the screen up. 864 instead scroll the screen up.
865
866 hold: *boolean*
867 Turn on/off hold window after exit support. If enabled, rxvt will
868 not immediately destroy its window when the program executed within
869 it exits. Instead, it will wait till it is being killed or closed by
870 the user.
776 871
777 keysym.*sym*: *string* 872 keysym.*sym*: *string*
778 Compile *frills*: Associate *string* with keysym *sym*. The 873 Compile *frills*: Associate *string* with keysym *sym*. The
779 intervening resource name keysym. cannot be omitted. 874 intervening resource name keysym. cannot be omitted.
780 875
… …
797 892
798 *string* may contain escape values ("\a": bell, "\b": backspace, 893 *string* may contain escape values ("\a": bell, "\b": backspace,
799 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 894 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
800 "\000": octal number) or verbatim control characters ("^?": delete, 895 "\000": octal number) or verbatim control characters ("^?": delete,
801 "^@": null, "^A" ...) and may be enclosed with double quotes so that 896 "^@": null, "^A" ...) and may be enclosed with double quotes so that
802 it can start or end with whitespace. 897 it can start or end with whitespace. This feature is deprecated and
898 will be removed.
803 899
804 Please note that you need to double the "\" when using 900 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 901 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 902 "\e" (and so on), which will work with both Xt and rxvt's own
807 both Xt and rxvt's own processing). 903 processing).
808 904
809 You can define a range of keysyms in one shot by providing a 905 You can define a range of keysyms in one shot by providing a
810 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 906 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
811 `/' should be a character not used by the strings. 907 `/' should be a character not used by the strings.
812 908
813 Its usage can be demonstrated by an example: 909 Its usage can be demonstrated by an example:
814 910
815 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 911 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
824 is interpreted and executed as rxvt's control sequence. For example 920 is interpreted and executed as rxvt's control sequence. For example
825 the following means "change the current locale to "zh_CN.GBK" when 921 the following means "change the current locale to "zh_CN.GBK" when
826 Control-Meta-c is being pressed": 922 Control-Meta-c is being pressed":
827 923
828 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 924 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
925
926 If *string* takes the form "perl:STRING", then the specified STRING
927 is passed to the "on_keyboard_command" perl handler. See the
928 rxvtperl(3) manpage. For example, the selection extension (activated
929 via "rxvt -pe selection") listens for "selection:rot13" events:
930
931 URxvt.keysym.M-C-c: perl:selection:rot13
829 932
830 Due the the large number of modifier combinations, a defined key 933 Due the the large number of modifier combinations, a defined key
831 mapping will match if at *at least* the specified identifiers are 934 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 935 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 936 being defined. That means that defining a key map for "a" will
… …
857 info): 960 info):
858 961
859 URxvt.keysym.M-C-3: command:\033[8;25;80t 962 URxvt.keysym.M-C-3: command:\033[8;25;80t
860 URxvt.keysym.M-C-4: command:\033[8;48;110t 963 URxvt.keysym.M-C-4: command:\033[8;48;110t
861 964
965 perl-ext-common: *string*
966 perl-ext: *string*
967 Comma-separated list(s) of perl extension scripts (default:
968 "default") to use in this terminal instance; option -pe.
969
970 Extension names can be prefixed with a "-" sign to prohibit using
971 them. This can be useful to selectively disable some extensions
972 loaded by default, or specified via the "perl-ext-common" resource.
973 For example, "default,-selection" will use all the default extension
974 except "selection".
975
976 Extension names can also be followed by an argument in angle
977 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
978 for searchable scrollback to Alt/Meta-s). Mentioning the same
979 extension multiple times with different arguments will pass multiple
980 arguments to the extension.
981
982 Each extension is looked up in the library directories, loaded if
983 necessary, and bound to the current terminal instance.
984
985 If both of these resources are the empty string, then the perl
986 interpreter will not be initialized. The idea behind two options is
987 that perl-ext-common will be used for extensions that should be
988 available to all instances, while perl-ext is used for specific
989 instances.
990
991 perl-eval: *string*
992 Perl code to be evaluated when all extensions have been registered.
993 See the rxvtperl(3) manpage. Due to security reasons, this resource
994 will be ignored when running setuid/setgid.
995
996 perl-lib: *path*
997 Colon-separated list of additional directories that hold extension
998 scripts. When looking for extensions specified by the "perl"
999 resource, rxvt will first look in these directories and then in
1000 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
1001 will be ignored when running setuid/setgid.
1002
1003 See the rxvtperl(3) manpage.
1004
1005 selection.pattern-*idx*: *perl-regex*
1006 Additional selection patterns, see the rxvtperl(3) manpage for
1007 details.
1008
1009 selection-autotransform.*idx*: *perl-transform*
1010 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1011 details.
1012
1013 searchable-scrollback: *keysym*
1014 Sets the hotkey that starts the incremental scrollback buffer search
1015 (default: "M-s").
1016
1017 urlLauncher: *string*
1018 Specifies the program to be started with a URL argument. Used by the
1019 "selection-popup" and "matcher" perl extensions.
1020
1021 transient-for: *windowid*
1022 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1023 window id.
1024
1025 override-redirect: *boolean*
1026 Compile *frills*: Sets override-redirect for the terminal window,
1027 making it almost invisible to window managers; option
1028 -override-redirect.
1029
862THE SCROLLBAR 1030THE SCROLLBAR
863 Lines of text that scroll off the top of the rxvt window (resource: 1031 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 1032 saveLines) and can be scrolled back using the scrollbar or by
865 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1033 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
866 fairly intuitive. The xterm-scrollbar is without arrows and its 1034 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
879 disabled -- on the assumption that we are using a fullscreen 1047 disabled -- on the assumption that we are using a fullscreen
880 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ 1048 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
881 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the 1049 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
882 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. 1050 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
883 1051
884TEXT SELECTION AND INSERTION 1052THE SELECTION: SELECTING AND PASTING TEXT
885 The behaviour of text selection and insertion mechanism is similar to 1053 The behaviour of text selection and insertion/pasting mechanism is
886 *xterm*(1). 1054 similar to *xterm*(1).
887 1055
888 Selection: 1056 Selecting:
889 Left click at the beginning of the region, drag to the end of the 1057 Left click at the beginning of the region, drag to the end of the
890 region and release; Right click to extend the marked region; Left 1058 region and release; Right click to extend the marked region; Left
891 double-click to select a word; Left triple-click to select the 1059 double-click to select a word; Left triple-click to select the
892 entire logical line (which can span multiple screen lines), unless 1060 entire logical line (which can span multiple screen lines), unless
893 modified by resource tripleclickwords. 1061 modified by resource tripleclickwords.
894 1062
895 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1063 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
896 (Compile: *frills*) will create a rectangular selection instead of a 1064 (Compile: *frills*) will create a rectangular selection instead of a
897 normal one. 1065 normal one. In this mode, every selected row becomes its own line in
1066 the selection, and trailing whitespace is visually underlined and
1067 removed from the selection.
898 1068
899 Insertion: 1069 Pasting:
900 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1070 Pressing and releasing the Middle mouse button in an rxvt window
901 an rxvt window causes the current text selection to be inserted as 1071 causes the value of the PRIMARY selection (or CLIPBOARD with the
902 if it had been typed on the keyboard. 1072 Meta modifier) to be inserted as if it had been typed on the
1073 keyboard.
1074
1075 Pressing Shift-Insert causes the value of the PRIMARY selection to
1076 be inserted too.
903 1077
904CHANGING FONTS 1078CHANGING FONTS
905 Changing fonts (or font sizes, respectively) via the keypad is not yet 1079 Changing fonts (or font sizes, respectively) via the keypad is not yet
906 supported in rxvt-unicode. Bug me if you need this. 1080 supported in rxvt-unicode. Bug me if you need this.
907 1081
908 You can, however, switch fonts at runtime using escape sequences (and 1082 You can, however, switch fonts at runtime using escape sequences, e.g.:
909 therefore using the menubar), e.g.:
910 1083
911 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1084 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1085
1086 You can use keyboard shortcuts, too:
1087
1088 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1089 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
912 1090
913 rxvt-unicode will automatically re-apply these fonts to the output so 1091 rxvt-unicode will automatically re-apply these fonts to the output so
914 far. 1092 far.
915 1093
916ISO 14755 SUPPORT 1094ISO 14755 SUPPORT
… …
940 This mode lets you input characters representing the keycap symbols 1118 This mode lets you input characters representing the keycap symbols
941 of your keyboard, if representable in the current locale encoding. 1119 of your keyboard, if representable in the current locale encoding.
942 1120
943 Start by pressing "Control" and "Shift" together, then releasing 1121 Start by pressing "Control" and "Shift" together, then releasing
944 them. The next special key (cursor keys, home etc.) you enter will 1122 them. The next special key (cursor keys, home etc.) you enter will
945 not invoke it's usual function but instead will insert the 1123 not invoke its usual function but instead will insert the
946 corresponding keycap symbol. The symbol will only be entered when 1124 corresponding keycap symbol. The symbol will only be entered when
947 the key has been released, otherwise pressing e.g. "Shift" would 1125 the key has been released, otherwise pressing e.g. "Shift" would
948 enter the symbol for "ISO Level 2 Switch", although your intention 1126 enter the symbol for "ISO Level 2 Switch", although your intention
949 might have been to enter a reverse tab (Shift-Tab). 1127 might have been to enter a reverse tab (Shift-Tab).
950 1128
… …
979 setgid to root or to some other group on others. 1157 setgid to root or to some other group on others.
980 1158
981COLORS AND GRAPHICS 1159COLORS AND GRAPHICS
982 In addition to the default foreground and background colours, rxvt can 1160 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 1161 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 1162 versions of the same). Here is a list of the colours with their names.
985 names.
986 1163
987 color0 (black) = Black 1164 color0 (black) = Black
988 color1 (red) = Red3 1165 color1 (red) = Red3
989 color2 (green) = Green3 1166 color2 (green) = Green3
990 color3 (yellow) = Yellow3 1167 color3 (yellow) = Yellow3
… …
1006 It is also possible to specify the colour values of foreground, 1183 It is also possible to specify the colour values of foreground,
1007 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1184 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1008 0-15, as a convenient shorthand to reference the colour name of 1185 0-15, as a convenient shorthand to reference the colour name of
1009 color0-color15. 1186 color0-color15.
1010 1187
1188 In addition to the colours defined above, rxvt offers an additional 72
1189 colours. The first 64 of those (with indices 16 to 79) consist of a
1190 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1191 by 8 additional shades of gray (with indices 80 to 87).
1192
1193 Together, all those colours implement the 88 colour xterm colours. Only
1194 the first 16 can be changed using resources currently, the rest can only
1195 be changed via command sequences ("escape codes").
1196
1011 Note that -rv ("reverseVideo: True") simulates reverse video by always 1197 Note that -rv ("reverseVideo: True") simulates reverse video by always
1012 swapping the foreground/background colours. This is in contrast to 1198 swapping the foreground/background colours. This is in contrast to
1013 *xterm*(1) where the colours are only swapped if they have not otherwise 1199 *xterm*(1) where the colours are only swapped if they have not otherwise
1014 been specified. For example, 1200 been specified. For example,
1015 1201
1016 rxvt -fg Black -bg White -rv 1202 rxvt -fg Black -bg White -rv
1017 would yield White on Black, while on *xterm*(1) it would yield Black 1203 would yield White on Black, while on *xterm*(1) it would yield Black
1018 on White. 1204 on White.
1019 1205
1206 ALPHA CHANNEL SUPPORT
1207 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1208 get their act together, rxvt-unicode will support
1209 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1210 digits/component) colour specifications, in addition to the ones
1211 provided by X, where the additional A component specifies opacity
1212 (alpha) values. The minimum value of 0 is completely transparent). You
1213 can also prefix any color with "[percent]", where "percent" is a decimal
1214 percentage (0-100) that specifies the opacity of the color, where 0 is
1215 completely transparent and 100 is completelxy opaque.
1216
1217 You probably need to specify "-depth 32", too, and have the luck that
1218 your X-server uses ARGB pixel layout, as X is far from just supporting
1219 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1220
1221 For example, the following selects an almost completely transparent red
1222 background, and an almost opaque pink foreground:
1223
1224 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1225
1226 *Please note that transparency of any kind if completely unsupported by
1227 the author. Don't bug him with installation questions!*
1228
1020ENVIRONMENT 1229ENVIRONMENT
1021 rxvt sets and/or uses the following environment variables: 1230 rxvt sets and/or uses the following environment variables:
1022 1231
1023 TERM 1232 TERM
1024 Normally set to "rxvt-unicode", unless overwritten at configure 1233 Normally set to "rxvt-unicode", unless overwritten at configure
1025 time, via resources or on the commandline. 1234 time, via resources or on the command line.
1026 1235
1027 COLORTERM 1236 COLORTERM
1028 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1237 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1029 with XPM support, and optionally with the added extension "-mono" to 1238 with XPM support, and optionally with the added extension "-mono" to
1030 indicate that rxvt-unicode runs on a monochrome screen. 1239 indicate that rxvt-unicode runs on a monochrome screen.
1031 1240
1032 COLORFGBG 1241 COLORFGBG
1033 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1242 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 1256 Set to the terminfo directory iff rxvt was configured with
1048 "--with-terminfo=PATH". 1257 "--with-terminfo=PATH".
1049 1258
1050 DISPLAY 1259 DISPLAY
1051 Used by rxvt to connect to the display and set to the correct 1260 Used by rxvt to connect to the display and set to the correct
1052 display in it's child processes. 1261 display in its child processes.
1053 1262
1054 SHELL 1263 SHELL
1055 The shell to be used for command execution, defaults to "/bin/sh". 1264 The shell to be used for command execution, defaults to "/bin/sh".
1056 1265
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 1266 RXVT_SOCKET
1065 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1267 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1066 1268
1067 Default "$HOME/.rxvt-unicode-<nodename". 1269 Default $HOME/.rxvt-unicode-*<nodename*.
1068 1270
1069 HOME 1271 HOME
1070 Used to locate the default directory for the unix domain socket for 1272 Used to locate the default directory for the unix domain socket for
1071 daemon communications and to locate various resource files (such as 1273 daemon communications and to locate various resource files (such as
1072 ".Xdefaults") 1274 ".Xdefaults")
… …
1081FILES 1283FILES
1082 /usr/lib/X11/rgb.txt 1284 /usr/lib/X11/rgb.txt
1083 Color names. 1285 Color names.
1084 1286
1085SEE ALSO 1287SEE ALSO
1086 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1288 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1087 1289 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 1290
1095CURRENT PROJECT COORDINATOR 1291CURRENT PROJECT COORDINATOR
1096 Project Coordinator 1292 Project Coordinator
1097 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1293 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1098 1294
1099 <http://software.schmorp.de/#rxvt-unicode> 1295 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1100 1296
1101AUTHORS 1297AUTHORS
1102 John Bovey 1298 John Bovey
1103 University of Kent, 1992, wrote the original Xvt. 1299 University of Kent, 1992, wrote the original Xvt.
1104 1300
… …
1115 1311
1116 Oezguer Kesim <kesim@math.fu-berlin.de> 1312 Oezguer Kesim <kesim@math.fu-berlin.de>
1117 Project Coordinator (changes.txt 2.21a to 2.4.5) 1313 Project Coordinator (changes.txt 2.21a to 2.4.5)
1118 1314
1119 Geoff Wing <gcw@pobox.com> 1315 Geoff Wing <gcw@pobox.com>
1120 Rewrote screen display and text selection routines. Project 1316 Rewrote screen display and text selection routines.
1317
1121 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1318 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1122 1319
1123 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1320 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1124 Forked rxvt-unicode, rewrote most of the display code and internal 1321 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1125 character handling to store text in unicode, improve xterm 1322 perl extension, random hacks, numerous bugfixes and extensions.
1126 compatibility and apply numerous other bugfixes and extensions.
1127 1323
1128 Project Coordinator (Changes 1.0 -) 1324 Project Coordinator (Changes 1.0 -)
1129 1325
1326 Emanuele Giaquinta <e.giaquinta@glauco.it>
1327 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1328

Diff Legend

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