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.43 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.65 by root, Sat Feb 17 20:36:36 2007 UTC

4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 7.0, 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.
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
117 125
118 rxvt -tr -tint blue -sh 40 126 rxvt -tr -tint blue -sh 40
119 127
120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 128 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
121 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
122 specified, too, e.g. "-tint white"). 130 specified, too, e.g. "-tint white"); resource *shading*.
123 131
124 -bg *colour* 132 -bg *colour*
125 Window background colour; resource background. 133 Window background colour; resource background.
126 134
127 -fg *colour* 135 -fg *colour*
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"
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.
256 268
257 -sbg 269 -sbg
258 Compile *frills*: Disable the usage of the built-in block 270 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 271 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its 272 fonts provide. Use this if you have a good font and want to use its
346 358
347 -keysym.*sym* *string* 359 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym. 360 Remap a key symbol. See resource keysym.
349 361
350 -embed *windowid* 362 -embed *windowid*
351 Tells rxvt to embed it's windows into an already-existing window, 363 Tells rxvt to embed its windows into an already-existing window,
352 which enables applications to easily embed a terminal. 364 which enables applications to easily embed a terminal.
353 365
354 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
355 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
356 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
359 The window will not be destroyed when rxvt exits. 371 The window will not be destroyed when rxvt exits.
360 372
361 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
362 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
363 file descriptors to communicate with the programs within the 375 file descriptors to communicate with the programs within the
364 terminal. This works regardless of wether the "-embed" option was 376 terminal. This works regardless of whether the "-embed" option was
365 used or not. 377 used or not.
366 378
367 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
368 can be used (a longer example is in doc/embed): 380 can be used (a longer example is in doc/embed):
369 381
373 system "rxvt -embed $xid &"; 385 system "rxvt -embed $xid &";
374 }); 386 });
375 387
376 -pty-fd *file descriptor* 388 -pty-fd *file descriptor*
377 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
378 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
379 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
380 without having to run a program within it. 392 without having to run a program within it.
381 393
382 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
383 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
428 will be used. Command-line arguments can be used to override resource 440 will be used. Command-line arguments can be used to override resource
429 settings. The following resources are supported (you might want to check 441 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not 442 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here): 443 documented here):
432 444
445 depth: *bitdepth*
446 Compile *xft*: Attempt to find a visual with the given bit depth;
447 option -depth.
448
433 geometry: *geom* 449 geometry: *geom*
434 Create the window with the specified X window geometry [default 450 Create the window with the specified X window geometry [default
435 80x24]; option -geometry. 451 80x24]; option -geometry.
436 452
437 background: *colour* 453 background: *colour*
468 Use the specified colour to display underlined characters when the 484 Use the specified colour to display underlined characters when the
469 foreground colour is the default. 485 foreground colour is the default.
470 486
471 colorRV: *colour* 487 colorRV: *colour*
472 Use the specified colour as the background for reverse video 488 Use the specified colour as the background for reverse video
473 characters. 489 characters when OPTION_HC is disabled (--disable-frills).
474 490
475 underlineColor: *colour* 491 underlineColor: *colour*
476 If set, use the specified colour as the colour for the underline 492 If set, use the specified colour as the colour for the underline
477 itself. If unset, use the foreground colour. 493 itself. If unset, use the foreground colour.
478 494
498 inheritPixmap: *boolean* 514 inheritPixmap: *boolean*
499 True: make the background inherit the parent windows' pixmap, giving 515 True: make the background inherit the parent windows' pixmap, giving
500 artificial transparency. False: do not inherit the parent windows' 516 artificial transparency. False: do not inherit the parent windows'
501 pixmap. 517 pixmap.
502 518
519 *Please note that transparency of any kind if completely unsupported
520 by the author. Don't bug him with installation questions!*
521
503 fading: *number* 522 fading: *number*
504 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
505 -fade. 524 -fade.
506 525
507 fadeColor: *colour* 526 fadeColor: *colour*
512 Tint the transparent background pixmap with the given colour; option 531 Tint the transparent background pixmap with the given colour; option
513 -tint. 532 -tint.
514 533
515 shading: *number* 534 shading: *number*
516 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 535 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
517 image in addition to tinting it. 536 image in addition to tinting it; option -sh.
518 537
519 scrollColor: *colour* 538 scrollColor: *colour*
520 Use the specified colour for the scrollbar [default #B2B2B2]. 539 Use the specified colour for the scrollbar [default #B2B2B2].
521 540
522 troughColor: *colour* 541 troughColor: *colour*
536 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
537 specifies an integer number of images in that direction. No image 556 specifies an integer number of images in that direction. No image
538 will be magnified beyond 10 times its original size. The maximum 557 will be magnified beyond 10 times its original size. The maximum
539 permitted scale is 1000. [default 0x0+50+50] 558 permitted scale is 1000. [default 0x0+50+50]
540 559
541 menu: *file[;tag]*
542 Read in the specified menu file (note the `.menu' extension is
543 optional) and also optionally specify a starting tag to find. See
544 the reference documentation for details on the syntax for the
545 menuBar.
546
547 path: *path* 560 path: *path*
548 Specify the colon-delimited search path for finding files (XPM and 561 Specify the colon-delimited search path for finding XPM files.
549 menus), in addition to the paths specified by the RXVTPATH and PATH
550 environment variables.
551 562
552 font: *fontlist* 563 font: *fontlist*
553 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
554 names that are used in turn when trying to display Unicode 565 names that are checked in order when trying to find glyphs for
555 characters. The first font defines the cell size for characters; 566 characters. The first font defines the cell size for characters;
556 other fonts might be smaller, but not larger. A reasonable default 567 other fonts might be smaller, but not (in general) larger. A
557 font list is always appended to it; option -fn. 568 (hopefully) reasonable default font list is always appended to it;
569 option -fn.
558 570
559 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
560 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 572 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
561 "xft:". 573 "xft:".
562 574
565 available hint currently is "codeset=codeset-name", and this is only 577 available hint currently is "codeset=codeset-name", and this is only
566 used for Xft fonts. 578 used for Xft fonts.
567 579
568 For example, this font resource 580 For example, this font resource
569 581
570 URxvt*font: 9x15bold,\ 582 URxvt.font: 9x15bold,\
571 -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,\
572 -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, \
573 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 585 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
574 xft:Code2000:antialias=false 586 xft:Code2000:antialias=false
575 587
611 normal text font will being used for the given style. 623 normal text font will being used for the given style.
612 624
613 intensityStyles: *boolean* 625 intensityStyles: *boolean*
614 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,
615 option -is, the default), bold and italic font styles imply high 627 option -is, the default), bold and italic font styles imply high
616 intensity foreground/backround colours. Disabling this option 628 intensity foreground/background colours. Disabling this option
617 (False, option +is) disables this behaviour, the high intensity 629 (False, option +is) disables this behaviour, the high intensity
618 colours are not reachable. 630 colours are not reachable.
619 631
620 selectstyle: *mode* 632 selectstyle: *mode*
621 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
661 673
662 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.
663 675
664 Example: 676 Example:
665 677
666 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 678 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
667 679
668 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
669 contents everytime you hit "Print". 681 contents every time you hit "Print".
670 682
671 scrollBar: *boolean* 683 scrollBar: *boolean*
672 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
673 scrollbar; option +sb. 685 scrollbar; option +sb.
674 686
689 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
690 702
691 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
692 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
693 scrollTtyOutput is False); option -sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
694 scrollback buffer when tty recieves new lines; option +sw. 706 scrollback buffer when tty receives new lines; option +sw.
695 707
696 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
697 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
698 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
699 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
772 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)
773 is pressed. If unset it will send the sequence traditionally 785 is pressed. If unset it will send the sequence traditionally
774 associated with the Execute key. 786 associated with the Execute key.
775 787
776 cutchars: *string* 788 cutchars: *string*
777 The characters used as delimiters for double-click word selection. 789 The characters used as delimiters for double-click word selection
778 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:
779 800
780 BACKSLASH `"'&()*,;<=>?@[]{|} 801 BACKSLASH `"'&()*,;<=>?@[]{|}
781 802
782 preeditType: *style* 803 preeditType: *style*
783 OverTheSpot, OffTheSpot, Root; option -pt. 804 OverTheSpot, OffTheSpot, Root; option -pt.
814 xterm, have these sequences enabled by default, which doesn't make 835 xterm, have these sequences enabled by default, which doesn't make
815 it safer, though). 836 it safer, though).
816 837
817 You can enable them by setting this boolean resource or specifying 838 You can enable them by setting this boolean resource or specifying
818 -insecure as an option. At the moment, this enables display-answer, 839 -insecure as an option. At the moment, this enables display-answer,
819 locale, findfont, icon label and window title requests as well as 840 locale, findfont, icon label and window title requests.
820 dynamic menubar dispatch.
821 841
822 modifier: *modifier* 842 modifier: *modifier*
823 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,
824 super, mod1, mod2, mod3, mod4, mod5; option -mod. 844 super, mod1, mod2, mod3, mod4, mod5; option -mod.
825 845
826 answerbackString: *string* 846 answerbackString: *string*
827 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
828 (control-E) character is passed through. It may contain escape 848 (control-E) character is passed through. It may contain escape
829 values as described in the entry on keysym following. 849 values as described in the entry on keysym following.
830 850
831 secondaryScreen: *bool* 851 secondaryScreen: *boolean*
832 Turn on/off secondary screen (default enabled). 852 Turn on/off secondary screen (default enabled).
833 853
834 secondaryScroll: *bool* 854 secondaryScroll: *boolean*
835 Turn on/off secondary screen scroll (default enabled). If the this 855 Turn on/off secondary screen scroll (default enabled). If the this
836 option is enabled, scrolls on the secondary screen will change the 856 option is enabled, scrolls on the secondary screen will change the
837 scrollback buffer and switching to/from the secondary screen will 857 scrollback buffer and switching to/from the secondary screen will
838 instead scroll the screen up. 858 instead scroll the screen up.
839 859
840 hold: *bool* 860 hold: *boolean*
841 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
842 not immediately destroy its window when the program executed within 862 not immediately destroy its window when the program executed within
843 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
844 the user. 864 the user.
845 865
866 886
867 *string* may contain escape values ("\a": bell, "\b": backspace, 887 *string* may contain escape values ("\a": bell, "\b": backspace,
868 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
869 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
870 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
871 it can start or end with whitespace. 891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
872 893
873 Please note that you need to double the "\" in resource files, as 894 Please note that you need to double the "\" in resource files, as
874 Xlib itself does it's own de-escaping (you can use "\033" instead of 895 Xlib itself does its own de-escaping (you can use "\033" instead of
875 "\e" (and so on), which will work with both Xt and rxvt's own 896 "\e" (and so on), which will work with both Xt and rxvt's own
876 processing). 897 processing).
877 898
878 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
879 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 900 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
880 `/' should be a character not used by the strings. 901 `/' should be a character not used by the strings.
881 902
882 Its usage can be demonstrated by an example: 903 Its usage can be demonstrated by an example:
883 904
884 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 905 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
946 For example, "default,-selection" will use all the default extension 967 For example, "default,-selection" will use all the default extension
947 except "selection". 968 except "selection".
948 969
949 Extension names can also be followed by an argument in angle 970 Extension names can also be followed by an argument in angle
950 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey 971 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
951 for searchable scorllback to Alt/Meta-s). Mentioning the same 972 for searchable scrollback to Alt/Meta-s). Mentioning the same
952 extension multiple times with different arguments will pass multiple 973 extension multiple times with different arguments will pass multiple
953 arguments to the extension. 974 arguments to the extension.
954 975
955 Each extension is looked up in the library directories, loaded if 976 Each extension is looked up in the library directories, loaded if
956 necessary, and bound to the current terminal instance. 977 necessary, and bound to the current terminal instance.
973 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource 994 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
974 will be ignored when running setuid/setgid. 995 will be ignored when running setuid/setgid.
975 996
976 See the rxvtperl(3) manpage. 997 See the rxvtperl(3) manpage.
977 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
978 searchable-scrollback: *keysym* 1007 searchable-scrollback: *keysym*
979 Sets the hotkey that starts the incremental scrollback buffer search 1008 Sets the hotkey that starts the incremental scrollback buffer search
980 (default: "M-s"). 1009 (default: "M-s").
981 1010
982 urlLauncher: *string* 1011 urlLauncher: *string*
983 Specifies the program to be started with a URL argument. Used by the 1012 Specifies the program to be started with a URL argument. Used by the
984 "selection-popup" and "mark-urls" perl extensions. 1013 "selection-popup" and "matcher" perl extensions.
985 1014
986 transient-for: *windowid* 1015 transient-for: *windowid*
987 Sets the WM_TRANSIENT_FOR property to the given window iw. 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.
988 1023
989THE SCROLLBAR 1024THE SCROLLBAR
990 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:
991 saveLines) and can be scrolled back using the scrollbar or by 1026 saveLines) and can be scrolled back using the scrollbar or by
992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1027 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1024 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
1025 the selection, and trailing whitespace is visually underlined and 1060 the selection, and trailing whitespace is visually underlined and
1026 removed from the selection. 1061 removed from the selection.
1027 1062
1028 Insertion: 1063 Insertion:
1029 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1064 Pressing and releasing the Middle mouse button in an rxvt window
1030 an rxvt window causes the current text selection to be inserted as 1065 causes the value of the PRIMARY selection (or CLIPBOARD with the
1031 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.
1032 1071
1033CHANGING FONTS 1072CHANGING FONTS
1034 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
1035 supported in rxvt-unicode. Bug me if you need this. 1074 supported in rxvt-unicode. Bug me if you need this.
1036 1075
1037 You can, however, switch fonts at runtime using escape sequences (and 1076 You can, however, switch fonts at runtime using escape sequences, e.g.:
1038 therefore using the menubar), e.g.:
1039 1077
1040 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
1041 1084
1042 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
1043 far. 1086 far.
1044 1087
1045ISO 14755 SUPPORT 1088ISO 14755 SUPPORT
1069 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1070 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1071 1114
1072 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1073 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
1074 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
1075 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1076 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1077 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1078 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1079 1122
1108 setgid to root or to some other group on others. 1151 setgid to root or to some other group on others.
1109 1152
1110COLORS AND GRAPHICS 1153COLORS AND GRAPHICS
1111 In addition to the default foreground and background colours, rxvt can 1154 In addition to the default foreground and background colours, rxvt can
1112 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
1113 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.
1114 names.
1115 1157
1116 color0 (black) = Black 1158 color0 (black) = Black
1117 color1 (red) = Red3 1159 color1 (red) = Red3
1118 color2 (green) = Green3 1160 color2 (green) = Green3
1119 color3 (yellow) = Yellow3 1161 color3 (yellow) = Yellow3
1135 It is also possible to specify the colour values of foreground, 1177 It is also possible to specify the colour values of foreground,
1136 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1178 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1137 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
1138 color0-color15. 1180 color0-color15.
1139 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
1140 Note that -rv ("reverseVideo: True") simulates reverse video by always 1191 Note that -rv ("reverseVideo: True") simulates reverse video by always
1141 swapping the foreground/background colours. This is in contrast to 1192 swapping the foreground/background colours. This is in contrast to
1142 *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
1143 been specified. For example, 1194 been specified. For example,
1144 1195
1145 rxvt -fg Black -bg White -rv 1196 rxvt -fg Black -bg White -rv
1146 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
1147 on White. 1198 on White.
1148 1199
1200 ALPHA CHANNEL SUPPORT
1201 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1202 get their act together, rxvt-unicode will support
1203 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1204 digits/component) colour specifications, in addition to the ones
1205 provided by X, where the additional A component specifies opacity
1206 (alpha) values. The minimum value of 0 is completely transparent). You
1207 can also prefix any color with "[percent]", where "percent" is a decimal
1208 percentage (0-100) that specifies the opacity of the color, where 0 is
1209 completely transparent and 100 is completelxy opaque.
1210
1211 You probably need to specify "-depth 32", too, and have the luck that
1212 your X-server uses ARGB pixel layout, as X is far from just supporting
1213 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1214
1215 For example, the following selects an almost completely transparent red
1216 background, and an almost opaque pink foreground:
1217
1218 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1219
1220 *Please note that transparency of any kind if completely unsupported by
1221 the author. Don't bug him with installation questions!*
1222
1149ENVIRONMENT 1223ENVIRONMENT
1150 rxvt sets and/or uses the following environment variables: 1224 rxvt sets and/or uses the following environment variables:
1151 1225
1152 TERM 1226 TERM
1153 Normally set to "rxvt-unicode", unless overwritten at configure 1227 Normally set to "rxvt-unicode", unless overwritten at configure
1154 time, via resources or on the commandline. 1228 time, via resources or on the command line.
1155 1229
1156 COLORTERM 1230 COLORTERM
1157 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1231 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1158 with XPM support, and optionally with the added extension "-mono" to 1232 with XPM support, and optionally with the added extension "-mono" to
1159 indicate that rxvt-unicode runs on a monochrome screen. 1233 indicate that rxvt-unicode runs on a monochrome screen.
1160 1234
1161 COLORFGBG 1235 COLORFGBG
1162 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1236 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1176 Set to the terminfo directory iff rxvt was configured with 1250 Set to the terminfo directory iff rxvt was configured with
1177 "--with-terminfo=PATH". 1251 "--with-terminfo=PATH".
1178 1252
1179 DISPLAY 1253 DISPLAY
1180 Used by rxvt to connect to the display and set to the correct 1254 Used by rxvt to connect to the display and set to the correct
1181 display in it's child processes. 1255 display in its child processes.
1182 1256
1183 SHELL 1257 SHELL
1184 The shell to be used for command execution, defaults to "/bin/sh". 1258 The shell to be used for command execution, defaults to "/bin/sh".
1185
1186 RXVTPATH
1187 The path where rxvt looks for support files such as menu and xpm
1188 files.
1189
1190 PATH
1191 Used in the same way as "RXVTPATH".
1192 1259
1193 RXVT_SOCKET 1260 RXVT_SOCKET
1194 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1261 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1195 1262
1196 Default $HOME/.rxvt-unicode-*<nodename*. 1263 Default $HOME/.rxvt-unicode-*<nodename*.
1217 1284
1218CURRENT PROJECT COORDINATOR 1285CURRENT PROJECT COORDINATOR
1219 Project Coordinator 1286 Project Coordinator
1220 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1287 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1221 1288
1222 <http://software.schmorp.de/#rxvt-unicode> 1289 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1223 1290
1224AUTHORS 1291AUTHORS
1225 John Bovey 1292 John Bovey
1226 University of Kent, 1992, wrote the original Xvt. 1293 University of Kent, 1992, wrote the original Xvt.
1227 1294
1238 1305
1239 Oezguer Kesim <kesim@math.fu-berlin.de> 1306 Oezguer Kesim <kesim@math.fu-berlin.de>
1240 Project Coordinator (changes.txt 2.21a to 2.4.5) 1307 Project Coordinator (changes.txt 2.21a to 2.4.5)
1241 1308
1242 Geoff Wing <gcw@pobox.com> 1309 Geoff Wing <gcw@pobox.com>
1243 Rewrote screen display and text selection routines. Project 1310 Rewrote screen display and text selection routines.
1311
1244 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1312 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1245 1313
1246 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1314 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1247 Forked rxvt-unicode, rewrote most of the display code and internal 1315 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1248 character handling to store text in unicode, improve xterm 1316 perl extension, random hacks, numerous bugfixes and extensions.
1249 compatibility and apply numerous other bugfixes and extensions.
1250 1317
1251 Project Coordinator (Changes 1.0 -) 1318 Project Coordinator (Changes 1.0 -)
1252 1319
1320 Emanuele Giaquinta <e.giaquinta@glauco.it>
1321 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1322

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines