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.30 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.63 by root, Thu Nov 2 17:37:47 2006 UTC

4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 6.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.0, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. That document is also 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
24 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
25 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
26 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
27 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devenagari. Don't expect pretty output when using
28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29 should work fine, though. A somewhat difficult case are left-to-right 29 should work fine, though. A somewhat difficult case are right-to-left
30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
32 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
33 otherwise), but that might change. 33 otherwise), but that might change.
34 34
35 If you are looking for a terminal that supports more exotic scripts, let 35 If you are looking for a terminal that supports more exotic scripts, let
36 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
37 terminal emulator. In fact, the reason rxvt-unicode was born was solely 37 terminal emulator. In fact, the reason rxvt-unicode was born was solely
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
42 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
43 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
44 able to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 it's predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
48 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot bugs less than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of it's features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
60 It also makes technical information about escape sequences (which have 60 It also makes technical information about escape sequences (which have
61 been extended) easier accessible: see rxvt(7) for technical reference 61 been extended) more accessible: see rxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In
66 keeping with the smaller-is-better philosophy, options may be eliminated 66 keeping with the smaller-is-better philosophy, options may be eliminated
84 -display *displayname* 84 -display *displayname*
85 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88 88
89 -depth *bitdepth*
90 Compile *xft*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
93 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling; resource jumpScroll.
97 101
98 -ip|+ip | -tr|+tr 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.
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)!*
101 109
102 -fade *number* 110 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 111 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 112 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 113 the fade colour; resource fading.
106 114
107 -fadecolor *colour* 115 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 116 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 117 colour is opaque black. resource fadeColor.
110 118
111 -tint *colour* 119 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 120 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 121 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 122 non-tiled backgrounds, currently. See also the -sh option that can
146 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
147 scrollbar and the text; resource borderColor. 155 scrollbar and the text; resource borderColor.
148 156
149 -fn *fontlist* 157 -fn *fontlist*
150 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
151 names that are used in turn when trying to display Unicode 159 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 160 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 161 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 162 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 163 See resource font for more details.
156 164
157 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
158 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
159 with "xft:", e.g.: 167 with "xft:", e.g.:
160 168
161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 169 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 170 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 171
164 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
165 FAQ section of rxvt(7). 173 FAQ section of rxvt(7).
166 174
167 -fb *fontlist* 175 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 176 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 177 characters are to be printed. See resource boldFont for details.
170 178
171 -fi *fontlist* 179 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 180 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 181 characters are to be printed. See resource italicFont for details.
174 182
175 -fbi *fontlist* 183 -fbi *fontlist*
176 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
177 characters are to be printed. See resource boldItalicFont for 185 italic* characters are to be printed. See resource boldItalicFont
178 details. 186 for details.
179 187
180 -is|+is 188 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity 189 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for 190 foreground/background (default). See resource intensityStyles for
183 details. 191 details.
184 192
185 -name *name* 193 -name *name*
186 Specify the application name under which resources are to be 194 Specify the application name under which resources are to be
251 externalBorder. 259 externalBorder.
252 260
253 -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.
254 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
255 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.
256 274
257 -lsp *number* 275 -lsp *number*
258 Compile *frills*: Lines (pixel height) to insert between each row of 276 Compile *frills*: Lines (pixel height) to insert between each row of
259 the display. Useful to work around font rendering problems; resource 277 the display. Useful to work around font rendering problems; resource
260 linespace. 278 linespace.
340 358
341 -keysym.*sym* *string* 359 -keysym.*sym* *string*
342 Remap a key symbol. See resource keysym. 360 Remap a key symbol. See resource keysym.
343 361
344 -embed *windowid* 362 -embed *windowid*
345 Tells rxvt to embed it's windows into an already-existing window, 363 Tells rxvt to embed its windows into an already-existing window,
346 which enables applications to easily embed a terminal. 364 which enables applications to easily embed a terminal.
347 365
348 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
349 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
350 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
353 The window will not be destroyed when rxvt exits. 371 The window will not be destroyed when rxvt exits.
354 372
355 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
356 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
357 file descriptors to communicate with the programs within the 375 file descriptors to communicate with the programs within the
358 terminal. This works regardless of wether the "-embed" option was 376 terminal. This works regardless of whether the "-embed" option was
359 used or not. 377 used or not.
360 378
361 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
362 can be used (a longer example is in doc/embed): 380 can be used (a longer example is in doc/embed):
363 381
365 $rxvt->signal_connect_after (realize => sub { 383 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid; 384 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &"; 385 system "rxvt -embed $xid &";
368 }); 386 });
369 387
370 -pty-fd *fileno* 388 -pty-fd *file descriptor*
371 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
372 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
373 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
374 without having to run a program within it. 392 without having to run a program within it.
375 393
376 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
377 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
378 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.
379 400
380 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
381 used (a longer example is in doc/pty-fd): 402 used (a longer example is in doc/pty-fd):
382 403
383 use IO::Pty; 404 use IO::Pty;
390 411
391 # now communicate with rxvt 412 # now communicate with rxvt
392 my $slave = $pty->slave; 413 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" } 414 while (<$slave>) { print $slave "got <$_>\n" }
394 415
395 -perl *string* 416 -pe *string*
396 Used by perl extension. See resource perl. 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.
397 419
398RESOURCES (available also as long-options) 420RESOURCES (available also as long-options)
399 Note: `rxvt --help' gives a list of all resources (long options) 421 Note: `rxvt --help' gives a list of all resources (long options)
400 compiled into your version. 422 compiled into your version.
401 423
402 There are two different methods that rxvt can use to get the Xresource
403 data: using the X libraries (Xrm*-functions) or internal Xresources
404 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
405 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
406 xrdb. Many distribution do also load settings from the ~/.Xresources 425 distribution do also load settings from the ~/.Xresources file when X
407 file when X starts. rxvt will consult the following files/resources in 426 starts. rxvt will consult the following files/resources in order, with
408 order, with later settings overwriting earlier ones: 427 later settings overwriting earlier ones:
409 428
410 1. system-wide app-defaults file, either locale-dependent OR global 429 1. system-wide app-defaults file, either locale-dependent OR global
411 2. app-defaults file in $XAPPLRESDIR 430 2. app-defaults file in $XAPPLRESDIR
412 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 431 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
413 4. SCREEN_RESOURCES for the current screen 432 4. SCREEN_RESOURCES for the current screen
414 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 433 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
415 434
416 If compiled with internal Xresources support (i.e. rxvt -h lists 435 Note that when reading X resources, rxvt recognizes two class names:
417 .Xdefaults) then rxvt accepts application defaults set in 436 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
418 XAPPLOADDIR/URxvt (compile-time defined: usually 437 and the original *rxvt* to be easily configured, while the class name
419 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 438 URxvt allows resources unique to rxvt, to be shared between different
420 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
421 resources, rxvt recognizes two class names: XTerm and URxvt. The class
422 name Rxvt allows resources common to both rxvt and the original *rxvt*
423 to be easily configured, while the class name URxvt allows resources
424 unique to rxvt, notably colours and key-handling, to be shared between
425 different rxvt configurations. If no resources are specified, suitable 439 rxvt configurations. If no resources are specified, suitable defaults
426 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
427 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.
428 448
429 geometry: *geom* 449 geometry: *geom*
430 Create the window with the specified X window geometry [default 450 Create the window with the specified X window geometry [default
431 80x24]; option -geometry. 451 80x24]; option -geometry.
432 452
493 513
494 inheritPixmap: *boolean* 514 inheritPixmap: *boolean*
495 True: make the background inherit the parent windows' pixmap, giving 515 True: make the background inherit the parent windows' pixmap, giving
496 artificial transparency. False: do not inherit the parent windows' 516 artificial transparency. False: do not inherit the parent windows'
497 pixmap. 517 pixmap.
518
519 *Please note that transparency of any kind if completely unsupported
520 by the author. Don't bug him with installation questions!*
498 521
499 fading: *number* 522 fading: *number*
500 Fade the text by the given percentage when focus is lost; option 523 Fade the text by the given percentage when focus is lost; option
501 -fade. 524 -fade.
502 525
532 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
533 specifies an integer number of images in that direction. No image 556 specifies an integer number of images in that direction. No image
534 will be magnified beyond 10 times its original size. The maximum 557 will be magnified beyond 10 times its original size. The maximum
535 permitted scale is 1000. [default 0x0+50+50] 558 permitted scale is 1000. [default 0x0+50+50]
536 559
537 menu: *file[;tag]*
538 Read in the specified menu file (note the `.menu' extension is
539 optional) and also optionally specify a starting tag to find. See
540 the reference documentation for details on the syntax for the
541 menuBar.
542
543 path: *path* 560 path: *path*
544 Specify the colon-delimited search path for finding files (XPM and 561 Specify the colon-delimited search path for finding XPM files.
545 menus), in addition to the paths specified by the RXVTPATH and PATH
546 environment variables.
547 562
548 font: *fontlist* 563 font: *fontlist*
549 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
550 names that are used in turn when trying to display Unicode 565 names that are checked in order when trying to find glyphs for
551 characters. The first font defines the cell size for characters; 566 characters. The first font defines the cell size for characters;
552 other fonts might be smaller, but not larger. A reasonable default 567 other fonts might be smaller, but not (in general) larger. A
553 font list is always appended to it; option -fn. 568 (hopefully) reasonable default font list is always appended to it;
569 option -fn.
554 570
555 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
556 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 572 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
557 "xft:". 573 "xft:".
558 574
561 available hint currently is "codeset=codeset-name", and this is only 577 available hint currently is "codeset=codeset-name", and this is only
562 used for Xft fonts. 578 used for Xft fonts.
563 579
564 For example, this font resource 580 For example, this font resource
565 581
566 URxvt*font: 9x15bold,\ 582 URxvt.font: 9x15bold,\
567 -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,\
568 -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, \
569 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 585 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
570 xft:Code2000:antialias=false 586 xft:Code2000:antialias=false
571 587
607 normal text font will being used for the given style. 623 normal text font will being used for the given style.
608 624
609 intensityStyles: *boolean* 625 intensityStyles: *boolean*
610 When font styles are not enabled, or this option is enabled (True, 626 When font styles are not enabled, or this option is enabled (True,
611 option -is, the default), bold and italic font styles imply high 627 option -is, the default), bold and italic font styles imply high
612 intensity foreground/backround colours. Disabling this option 628 intensity foreground/background colours. Disabling this option
613 (False, option +is) disables this behaviour, the high intensity 629 (False, option +is) disables this behaviour, the high intensity
614 colours are not reachable. 630 colours are not reachable.
615 631
616 selectstyle: *mode* 632 selectstyle: *mode*
617 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
657 673
658 The string will be interpreted as if typed into the shell as-is. 674 The string will be interpreted as if typed into the shell as-is.
659 675
660 Example: 676 Example:
661 677
662 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 678 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
663 679
664 This creates a new file in your home directory with the screen 680 This creates a new file in your home directory with the screen
665 contents everytime you hit "Print". 681 contents every time you hit "Print".
666 682
667 scrollBar: *boolean* 683 scrollBar: *boolean*
668 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
669 scrollbar; option +sb. 685 scrollbar; option +sb.
670 686
685 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
686 702
687 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
688 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
689 scrollTtyOutput is False); option -sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
690 scrollback buffer when tty recieves new lines; option +sw. 706 scrollback buffer when tty receives new lines; option +sw.
691 707
692 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
693 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
694 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
695 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
710 borderLess: *boolean* 726 borderLess: *boolean*
711 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
712 the WM, the rxvt-unicode window will not have window decorations; 728 the WM, the rxvt-unicode window will not have window decorations;
713 option -bl. 729 option -bl.
714 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
715 termName: *termname* 737 termName: *termname*
716 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
717 variable; option -tn. 739 variable; option -tn.
718 740
719 linespace: *number* 741 linespace: *number*
762 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)
763 is pressed. If unset it will send the sequence traditionally 785 is pressed. If unset it will send the sequence traditionally
764 associated with the Execute key. 786 associated with the Execute key.
765 787
766 cutchars: *string* 788 cutchars: *string*
767 The characters used as delimiters for double-click word selection. 789 The characters used as delimiters for double-click word selection
768 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:
769 800
770 BACKSLASH `"'&()*,;<=>?@[]{|} 801 BACKSLASH `"'&()*,;<=>?@[]{|}
771 802
772 preeditType: *style* 803 preeditType: *style*
773 OverTheSpot, OffTheSpot, Root; option -pt. 804 OverTheSpot, OffTheSpot, Root; option -pt.
804 xterm, have these sequences enabled by default, which doesn't make 835 xterm, have these sequences enabled by default, which doesn't make
805 it safer, though). 836 it safer, though).
806 837
807 You can enable them by setting this boolean resource or specifying 838 You can enable them by setting this boolean resource or specifying
808 -insecure as an option. At the moment, this enables display-answer, 839 -insecure as an option. At the moment, this enables display-answer,
809 locale, findfont, icon label and window title requests as well as 840 locale, findfont, icon label and window title requests.
810 dynamic menubar dispatch.
811 841
812 modifier: *modifier* 842 modifier: *modifier*
813 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,
814 super, mod1, mod2, mod3, mod4, mod5; option -mod. 844 super, mod1, mod2, mod3, mod4, mod5; option -mod.
815 845
816 answerbackString: *string* 846 answerbackString: *string*
817 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
818 (control-E) character is passed through. It may contain escape 848 (control-E) character is passed through. It may contain escape
819 values as described in the entry on keysym following. 849 values as described in the entry on keysym following.
820 850
821 secondaryScreen: *bool* 851 secondaryScreen: *boolean*
822 Turn on/off secondary screen (default enabled). 852 Turn on/off secondary screen (default enabled).
823 853
824 secondaryScroll: *bool* 854 secondaryScroll: *boolean*
825 Turn on/off secondary screen scroll (default enabled). If the this 855 Turn on/off secondary screen scroll (default enabled). If the this
826 option is enabled, scrolls on the secondary screen will change the 856 option is enabled, scrolls on the secondary screen will change the
827 scrollback buffer and switching to/from the secondary screen will 857 scrollback buffer and switching to/from the secondary screen will
828 instead scroll the screen up. 858 instead scroll the screen up.
829 859
830 hold: *bool* 860 hold: *boolean*
831 Turn on/off hold window after exit support. If enabled, rxvt will 861 Turn on/off hold window after exit support. If enabled, rxvt will
832 not immediately destroy its window when the program executed within 862 not immediately destroy its window when the program executed within
833 it exits. Instead, it will wait till it is being killed or closed by 863 it exits. Instead, it will wait till it is being killed or closed by
834 the user. 864 the user.
835 865
856 886
857 *string* may contain escape values ("\a": bell, "\b": backspace, 887 *string* may contain escape values ("\a": bell, "\b": backspace,
858 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
859 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
860 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
861 it can start or end with whitespace. 891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
862 893
863 Please note that you need to double the "\" when using 894 Please note that you need to double the "\" in resource files, as
864 "--enable-xgetdefault", as X itself does it's own de-escaping (you 895 Xlib itself does its own de-escaping (you can use "\033" instead of
865 can use "\033" instead of "\e" (and so on), which will work with 896 "\e" (and so on), which will work with both Xt and rxvt's own
866 both Xt and rxvt's own processing). 897 processing).
867 898
868 You can define a range of keysyms in one shot by providing a 899 You can define a range of keysyms in one shot by providing a
869 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 900 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
870 `/' should be a character not used by the strings. 901 `/' should be a character not used by the strings.
871 902
872 Its usage can be demonstrated by an example: 903 Its usage can be demonstrated by an example:
873 904
874 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 905 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
883 is interpreted and executed as rxvt's control sequence. For example 914 is interpreted and executed as rxvt's control sequence. For example
884 the following means "change the current locale to "zh_CN.GBK" when 915 the following means "change the current locale to "zh_CN.GBK" when
885 Control-Meta-c is being pressed": 916 Control-Meta-c is being pressed":
886 917
887 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 918 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
919
920 If *string* takes the form "perl:STRING", then the specified STRING
921 is passed to the "on_keyboard_command" perl handler. See the
922 rxvtperl(3) manpage. For example, the selection extension (activated
923 via "rxvt -pe selection") listens for "selection:rot13" events:
924
925 URxvt.keysym.M-C-c: perl:selection:rot13
888 926
889 Due the the large number of modifier combinations, a defined key 927 Due the the large number of modifier combinations, a defined key
890 mapping will match if at *at least* the specified identifiers are 928 mapping will match if at *at least* the specified identifiers are
891 being set, and no other key mappings with those and more bits are 929 being set, and no other key mappings with those and more bits are
892 being defined. That means that defining a key map for "a" will 930 being defined. That means that defining a key map for "a" will
916 info): 954 info):
917 955
918 URxvt.keysym.M-C-3: command:\033[8;25;80t 956 URxvt.keysym.M-C-3: command:\033[8;25;80t
919 URxvt.keysym.M-C-4: command:\033[8;48;110t 957 URxvt.keysym.M-C-4: command:\033[8;48;110t
920 958
959 perl-ext-common: *string*
921 perl: *string* 960 perl-ext: *string*
922 Used by perl extension and is free for any use, as it is not 961 Comma-separated list(s) of perl extension scripts (default:
923 interpreted by rxvt-unicode itself; option perl. 962 "default") to use in this terminal instance; option -pe.
963
964 Extension names can be prefixed with a "-" sign to prohibit using
965 them. This can be useful to selectively disable some extensions
966 loaded by default, or specified via the "perl-ext-common" resource.
967 For example, "default,-selection" will use all the default extension
968 except "selection".
969
970 Extension names can also be followed by an argument in angle
971 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
972 for searchable scrollback to Alt/Meta-s). Mentioning the same
973 extension multiple times with different arguments will pass multiple
974 arguments to the extension.
975
976 Each extension is looked up in the library directories, loaded if
977 necessary, and bound to the current terminal instance.
978
979 If both of these resources are the empty string, then the perl
980 interpreter will not be initialized. The idea behind two options is
981 that perl-ext-common will be used for extensions that should be
982 available to all instances, while perl-ext is used for specific
983 instances.
924 984
925 perl-eval: *string* 985 perl-eval: *string*
926 Perl code to be evaluated when all extensions have been loaded. See 986 Perl code to be evaluated when all extensions have been registered.
927 the rxvtperl(3) manpage. 987 See the rxvtperl(3) manpage. Due to security reasons, this resource
988 will be ignored when running setuid/setgid.
928 989
929 perl-lib: *path* 990 perl-lib: *path*
930 Additional directory that holds extension scripts that are loaded 991 Colon-separated list of additional directories that hold extension
931 and enabled for this terminal instance, in addition to scripts 992 scripts. When looking for extensions specified by the "perl"
932 stored in /opt/rxvt/lib/urxvt/perl-ext/, which are global to all 993 resource, rxvt will first look in these directories and then in
933 terminal instances. 994 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
995 will be ignored when running setuid/setgid.
934 996
935 See the rxvtperl(3) manpage. 997 See the rxvtperl(3) manpage.
998
999 selection.pattern-*idx*: *perl-regex*
1000 Additional selection patterns, see the rxvtperl(3) manpage for
1001 details.
1002
1003 selection-autotransform.*idx*: *perl-transform*
1004 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1005 details.
1006
1007 searchable-scrollback: *keysym*
1008 Sets the hotkey that starts the incremental scrollback buffer search
1009 (default: "M-s").
1010
1011 urlLauncher: *string*
1012 Specifies the program to be started with a URL argument. Used by the
1013 "selection-popup" and "mark-urls" perl extensions.
1014
1015 transient-for: *windowid*
1016 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1017 window id.
1018
1019 override-redirect: *boolean*
1020 Compile *frills*: Sets override-redirect for the terminal window,
1021 making it almost invisible to window managers; option
1022 -override-redirect.
936 1023
937THE SCROLLBAR 1024THE SCROLLBAR
938 Lines of text that scroll off the top of the rxvt window (resource: 1025 Lines of text that scroll off the top of the rxvt window (resource:
939 saveLines) and can be scrolled back using the scrollbar or by 1026 saveLines) and can be scrolled back using the scrollbar or by
940 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1027 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
972 normal one. In this mode, every selected row becomes its own line in 1059 normal one. In this mode, every selected row becomes its own line in
973 the selection, and trailing whitespace is visually underlined and 1060 the selection, and trailing whitespace is visually underlined and
974 removed from the selection. 1061 removed from the selection.
975 1062
976 Insertion: 1063 Insertion:
977 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1064 Pressing and releasing the Middle mouse button in an rxvt window
978 an rxvt window causes the current text selection to be inserted as 1065 causes the value of the PRIMARY selection (or CLIPBOARD with the
979 if it had been typed on the keyboard. 1066 Meta modifier) to be inserted as if it had been typed on the
1067 keyboard.
1068
1069 Pressing Shift-Insert causes the value of the PRIMARY selection to
1070 be inserted too.
980 1071
981CHANGING FONTS 1072CHANGING FONTS
982 Changing fonts (or font sizes, respectively) via the keypad is not yet 1073 Changing fonts (or font sizes, respectively) via the keypad is not yet
983 supported in rxvt-unicode. Bug me if you need this. 1074 supported in rxvt-unicode. Bug me if you need this.
984 1075
985 You can, however, switch fonts at runtime using escape sequences (and 1076 You can, however, switch fonts at runtime using escape sequences, e.g.:
986 therefore using the menubar), e.g.:
987 1077
988 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1078 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1079
1080 You can use keyboard shortcuts, too:
1081
1082 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1083 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
989 1084
990 rxvt-unicode will automatically re-apply these fonts to the output so 1085 rxvt-unicode will automatically re-apply these fonts to the output so
991 far. 1086 far.
992 1087
993ISO 14755 SUPPORT 1088ISO 14755 SUPPORT
1017 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1018 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1019 1114
1020 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1021 them. The next special key (cursor keys, home etc.) you enter will 1116 them. The next special key (cursor keys, home etc.) you enter will
1022 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
1023 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1024 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1025 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1026 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1027 1122
1056 setgid to root or to some other group on others. 1151 setgid to root or to some other group on others.
1057 1152
1058COLORS AND GRAPHICS 1153COLORS AND GRAPHICS
1059 In addition to the default foreground and background colours, rxvt can 1154 In addition to the default foreground and background colours, rxvt can
1060 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1155 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1061 versions of the same). Here is a list of the colours with their rgb.txt 1156 versions of the same). Here is a list of the colours with their names.
1062 names.
1063 1157
1064 color0 (black) = Black 1158 color0 (black) = Black
1065 color1 (red) = Red3 1159 color1 (red) = Red3
1066 color2 (green) = Green3 1160 color2 (green) = Green3
1067 color3 (yellow) = Yellow3 1161 color3 (yellow) = Yellow3
1083 It is also possible to specify the colour values of foreground, 1177 It is also possible to specify the colour values of foreground,
1084 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1178 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1085 0-15, as a convenient shorthand to reference the colour name of 1179 0-15, as a convenient shorthand to reference the colour name of
1086 color0-color15. 1180 color0-color15.
1087 1181
1182 In addition to the colours defined above, rxvt offers an additional 72
1183 colours. The first 64 of those (with indices 16 to 79) consist of a
1184 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1185 by 8 additional shades of gray (with indices 80 to 87).
1186
1187 Together, all those colours implement the 88 colour xterm colours. Only
1188 the first 16 can be changed using resources currently, the rest can only
1189 be changed via command sequences ("escape codes").
1190
1088 Note that -rv ("reverseVideo: True") simulates reverse video by always 1191 Note that -rv ("reverseVideo: True") simulates reverse video by always
1089 swapping the foreground/background colours. This is in contrast to 1192 swapping the foreground/background colours. This is in contrast to
1090 *xterm*(1) where the colours are only swapped if they have not otherwise 1193 *xterm*(1) where the colours are only swapped if they have not otherwise
1091 been specified. For example, 1194 been specified. For example,
1092 1195
1093 rxvt -fg Black -bg White -rv 1196 rxvt -fg Black -bg White -rv
1094 would yield White on Black, while on *xterm*(1) it would yield Black 1197 would yield White on Black, while on *xterm*(1) it would yield Black
1095 on White. 1198 on White.
1096 1199
1200 ALPHA CHANNEL SUPPORT
1201 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1202 get their act together, rxvt-unicode will support
1203 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1204 digits/component) colour specifications, in addition to the ones
1205 provided by X, where the additional A component specifies opacity
1206 (alpha) values. The minimum value of 0 is completely transparent). You
1207 can also prefix any color with "[a]", where "a" is on to four hex digits
1208 specifiying the opacity value.
1209
1210 You probably need to specify "-depth 32", too, and have the luck that
1211 your X-server uses ARGB pixel layout, as X is far from just supporting
1212 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1213
1214 For example, the following selects an almost completely transparent red
1215 background, and an almost opaque pink foreground:
1216
1217 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1218
1219 *Please note that transparency of any kind if completely unsupported by
1220 the author. Don't bug him with installation questions!*
1221
1097ENVIRONMENT 1222ENVIRONMENT
1098 rxvt sets and/or uses the following environment variables: 1223 rxvt sets and/or uses the following environment variables:
1099 1224
1100 TERM 1225 TERM
1101 Normally set to "rxvt-unicode", unless overwritten at configure 1226 Normally set to "rxvt-unicode", unless overwritten at configure
1102 time, via resources or on the commandline. 1227 time, via resources or on the command line.
1103 1228
1104 COLORTERM 1229 COLORTERM
1105 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1230 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1106 with XPM support, and optionally with the added extension "-mono" to 1231 with XPM support, and optionally with the added extension "-mono" to
1107 indicate that rxvt-unicode runs on a monochrome screen. 1232 indicate that rxvt-unicode runs on a monochrome screen.
1108 1233
1109 COLORFGBG 1234 COLORFGBG
1110 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1235 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1124 Set to the terminfo directory iff rxvt was configured with 1249 Set to the terminfo directory iff rxvt was configured with
1125 "--with-terminfo=PATH". 1250 "--with-terminfo=PATH".
1126 1251
1127 DISPLAY 1252 DISPLAY
1128 Used by rxvt to connect to the display and set to the correct 1253 Used by rxvt to connect to the display and set to the correct
1129 display in it's child processes. 1254 display in its child processes.
1130 1255
1131 SHELL 1256 SHELL
1132 The shell to be used for command execution, defaults to "/bin/sh". 1257 The shell to be used for command execution, defaults to "/bin/sh".
1133
1134 RXVTPATH
1135 The path where rxvt looks for support files such as menu and xpm
1136 files.
1137
1138 PATH
1139 Used in the same way as "RXVTPATH".
1140 1258
1141 RXVT_SOCKET 1259 RXVT_SOCKET
1142 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1260 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1143 1261
1144 Default $HOME/.rxvt-unicode-*<nodename*. 1262 Default $HOME/.rxvt-unicode-*<nodename*.
1165 1283
1166CURRENT PROJECT COORDINATOR 1284CURRENT PROJECT COORDINATOR
1167 Project Coordinator 1285 Project Coordinator
1168 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1286 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1169 1287
1170 <http://software.schmorp.de/#rxvt-unicode> 1288 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1171 1289
1172AUTHORS 1290AUTHORS
1173 John Bovey 1291 John Bovey
1174 University of Kent, 1992, wrote the original Xvt. 1292 University of Kent, 1992, wrote the original Xvt.
1175 1293
1186 1304
1187 Oezguer Kesim <kesim@math.fu-berlin.de> 1305 Oezguer Kesim <kesim@math.fu-berlin.de>
1188 Project Coordinator (changes.txt 2.21a to 2.4.5) 1306 Project Coordinator (changes.txt 2.21a to 2.4.5)
1189 1307
1190 Geoff Wing <gcw@pobox.com> 1308 Geoff Wing <gcw@pobox.com>
1191 Rewrote screen display and text selection routines. Project 1309 Rewrote screen display and text selection routines.
1310
1192 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1311 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1193 1312
1194 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1313 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1195 Forked rxvt-unicode, rewrote most of the display code and internal 1314 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1196 character handling to store text in unicode, improve xterm 1315 perl extension, random hacks, numerous bugfixes and extensions.
1197 compatibility and apply numerous other bugfixes and extensions.
1198 1316
1199 Project Coordinator (Changes 1.0 -) 1317 Project Coordinator (Changes 1.0 -)
1200 1318
1319 Emanuele Giaquinta <e.giaquinta@glauco.it>
1320 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1321

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines