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.53 by root, Thu Jan 26 00:09:47 2006 UTC vs.
Revision 1.67 by root, Sun Jun 24 22:12:18 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.3a, 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
… …
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* 89 -depth *bitdepth*
90 Compile *frills*: Attempt to find a visual with the given bit depth; 90 Compile *xft*: Attempt to find a visual with the given bit depth;
91 resource depth. 91 resource depth.
92 92
93 -geometry *geom* 93 -geometry *geom*
94 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
95 95
96 -rv|+rv 96 -rv|+rv
97 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
98 98
99 -j|+j 99 -j|+j
100 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling (allow multiple lines per refresh);
101 resource jumpScroll.
102
103 -ss|+ss
104 Turn on/off skip scrolling (allow multiple screens per refresh);
105 resource skipScroll.
101 106
102 -ip|+ip | -tr|+tr 107 -ip|+ip | -tr|+tr
103 Turn on/off inheriting parent window's pixmap. Alternative form is 108 Turn on/off inheriting parent window's pixmap. Alternative form is
104 -tr; resource inheritPixmap. 109 -tr; resource inheritPixmap.
110
111 *Please note that transparency of any kind if completely unsupported
112 by the author. Don't bug him with installation questions! Read the
113 FAQ (man 7 rxvt)!*
105 114
106 -fade *number* 115 -fade *number*
107 Fade the text by the given percentage when focus is lost. Small 116 Fade the text by the given percentage when focus is lost. Small
108 values fade a little only, 100 completely replaces all colours by 117 values fade a little only, 100 completely replaces all colours by
109 the fade colour; resource fading. 118 the fade colour; resource fading.
110 119
111 -fadecolor *colour* 120 -fadecolor *colour*
112 Fade to this colour when fading is used (see -fade). The default 121 Fade to this colour when fading is used (see -fade). The default
113 colour is black. resource fadeColor. 122 colour is opaque black. resource fadeColor.
114 123
115 -tint *colour* 124 -tint *colour*
116 Tint the transparent background pixmap with the given colour when 125 Tint the transparent background pixmap with the given colour when
117 transparency is enabled with -tr or -ip. This only works for 126 transparency is enabled with -tr or -ip. This only works for
118 non-tiled backgrounds, currently. See also the -sh option that can 127 non-tiled backgrounds, currently. See also the -sh option that can
119 be used to brighten or darken the image in addition to tinting it; 128 be used to brighten or darken the image in addition to tinting it;
120 resource *tintColor*. Example: 129 resource *tintColor*. Example:
121 130
122 rxvt -tr -tint blue -sh 40 131 rxvt -tr -tint blue -sh 40
123 132
133 -sh *number*
124 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 134 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
125 background image in addition to tinting it (i.e. -tint must be 135 image in addition to (or instead of) tinting it; resource *shading*.
126 specified, too, e.g. "-tint white"). 136
137 -blt *string*
138 Specify background blending type. If background pixmap is specified
139 at the same time as transparency - such pixmap will be blended over
140 transparency image, using method specified. Supported values are :
141 add, alphablend, allanon - color values averaging, colorize, darken,
142 diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
143 value. The default is alpha-blending; resource *blendType*.
144
145 -blr *number*
146 Apply Gaussian Blur with the specified radius to the transparent
147 background image; resource *blurRadius*.
127 148
128 -bg *colour* 149 -bg *colour*
129 Window background colour; resource background. 150 Window background colour; resource background.
130 151
131 -fg *colour* 152 -fg *colour*
132 Window foreground colour; resource foreground. 153 Window foreground colour; resource foreground.
133 154
134 -pixmap *file[;geom]* 155 -pixmap *file[;geom]*
135 Compile *XPM*: Specify XPM file for the background and also 156 Compile *afterimage*: Specify image file for the background and also
136 optionally specify its scaling with a geometry string. Note you may 157 optionally specify its scaling with a geometry string. Note you may
137 need to add quotes to avoid special shell interpretation of the ";" 158 need to add quotes to avoid special shell interpretation of the ";"
138 in the command-line; resource backgroundPixmap. 159 in the command-line; for more details see resource backgroundPixmap.
139 160
140 -cr *colour* 161 -cr *colour*
141 The cursor colour; resource cursorColor. 162 The cursor colour; resource cursorColor.
142 163
143 -pr *colour* 164 -pr *colour*
… …
156 characters. The first font defines the cell size for characters; 177 characters. The first font defines the cell size for characters;
157 other fonts might be smaller, but not (in general) larger. A 178 other fonts might be smaller, but not (in general) larger. A
158 (hopefully) reasonable default font list is always appended to it. 179 (hopefully) reasonable default font list is always appended to it.
159 See resource font for more details. 180 See resource font for more details.
160 181
161 In short, to specify an X11 core font, just specify it's name or 182 In short, to specify an X11 core font, just specify its name or
162 prefix it with "x:". To specify an XFT-font, you need to prefix it 183 prefix it with "x:". To specify an XFT-font, you need to prefix it
163 with "xft:", e.g.: 184 with "xft:", e.g.:
164 185
165 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 186 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
166 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 187 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
… …
323 Set the font set to use for the X Input Method, see resource imFont 344 Set the font set to use for the X Input Method, see resource imFont
324 for more info. 345 for more info.
325 346
326 -tcw 347 -tcw
327 Change the meaning of triple-click selection with the left mouse 348 Change the meaning of triple-click selection with the left mouse
349 button. Only effective when the original (non-perl) selection code
328 button. Instead of selecting a full line it will extend the 350 is in-use. Instead of selecting a full line it will extend the
329 selection the end of the logical line only. resource 351 selection the end of the logical line only. resource
330 tripleclickwords. 352 tripleclickwords.
331 353
332 -insecure 354 -insecure
333 Enable "insecure" mode, which currently enables most of the escape 355 Enable "insecure" mode, which currently enables most of the escape
… …
354 376
355 -keysym.*sym* *string* 377 -keysym.*sym* *string*
356 Remap a key symbol. See resource keysym. 378 Remap a key symbol. See resource keysym.
357 379
358 -embed *windowid* 380 -embed *windowid*
359 Tells rxvt to embed it's windows into an already-existing window, 381 Tells rxvt to embed its windows into an already-existing window,
360 which enables applications to easily embed a terminal. 382 which enables applications to easily embed a terminal.
361 383
362 Right now, rxvt will first unmap/map the specified window, so it 384 Right now, rxvt will first unmap/map the specified window, so it
363 shouldn't be a top-level window. rxvt will also reconfigure it quite 385 shouldn't be a top-level window. rxvt will also reconfigure it quite
364 a bit, so don't expect it to keep some specific state. It's best to 386 a bit, so don't expect it to keep some specific state. It's best to
… …
367 The window will not be destroyed when rxvt exits. 389 The window will not be destroyed when rxvt exits.
368 390
369 It might be useful to know that rxvt will not close file descriptors 391 It might be useful to know that rxvt will not close file descriptors
370 passed to it (except for stdin/out/err, of course), so you can use 392 passed to it (except for stdin/out/err, of course), so you can use
371 file descriptors to communicate with the programs within the 393 file descriptors to communicate with the programs within the
372 terminal. This works regardless of wether the "-embed" option was 394 terminal. This works regardless of whether the "-embed" option was
373 used or not. 395 used or not.
374 396
375 Here is a short Gtk2-perl snippet that illustrates how this option 397 Here is a short Gtk2-perl snippet that illustrates how this option
376 can be used (a longer example is in doc/embed): 398 can be used (a longer example is in doc/embed):
377 399
… …
381 system "rxvt -embed $xid &"; 403 system "rxvt -embed $xid &";
382 }); 404 });
383 405
384 -pty-fd *file descriptor* 406 -pty-fd *file descriptor*
385 Tells rxvt NOT to execute any commands or create a new pty/tty pair 407 Tells rxvt NOT to execute any commands or create a new pty/tty pair
386 but instead use the given filehandle as the tty master. This is 408 but instead use the given file descriptor as the tty master. This is
387 useful if you want to drive rxvt as a generic terminal emulator 409 useful if you want to drive rxvt as a generic terminal emulator
388 without having to run a program within it. 410 without having to run a program within it.
389 411
390 If this switch is given, rxvt will not create any utmp/wtmp entries 412 If this switch is given, rxvt will not create any utmp/wtmp entries
391 and will not tinker with pty/tty permissions - you have to do that 413 and will not tinker with pty/tty permissions - you have to do that
… …
437 settings. The following resources are supported (you might want to check 459 settings. The following resources are supported (you might want to check
438 the rxvtperl(3) manpage for additional settings by perl extensions not 460 the rxvtperl(3) manpage for additional settings by perl extensions not
439 documented here): 461 documented here):
440 462
441 depth: *bitdepth* 463 depth: *bitdepth*
442 Compile *frills*: Attempt to find a visual with the given bit depth; 464 Compile *xft*: Attempt to find a visual with the given bit depth;
443 option -depth. 465 option -depth.
444 466
445 geometry: *geom* 467 geometry: *geom*
446 Create the window with the specified X window geometry [default 468 Create the window with the specified X window geometry [default
447 80x24]; option -geometry. 469 80x24]; option -geometry.
… …
480 Use the specified colour to display underlined characters when the 502 Use the specified colour to display underlined characters when the
481 foreground colour is the default. 503 foreground colour is the default.
482 504
483 colorRV: *colour* 505 colorRV: *colour*
484 Use the specified colour as the background for reverse video 506 Use the specified colour as the background for reverse video
485 characters. 507 characters when OPTION_HC is disabled (--disable-frills).
486 508
487 underlineColor: *colour* 509 underlineColor: *colour*
488 If set, use the specified colour as the colour for the underline 510 If set, use the specified colour as the colour for the underline
489 itself. If unset, use the foreground colour. 511 itself. If unset, use the foreground colour.
490 512
… …
501 True: simulate reverse video by foreground and background colours; 523 True: simulate reverse video by foreground and background colours;
502 option -rv. False: regular screen colours [default]; option +rv. See 524 option -rv. False: regular screen colours [default]; option +rv. See
503 note in COLORS AND GRAPHICS section. 525 note in COLORS AND GRAPHICS section.
504 526
505 jumpScroll: *boolean* 527 jumpScroll: *boolean*
506 True: specify that jump scrolling should be used. When scrolling 528 True: specify that jump scrolling should be used. When receiving
507 quickly, fewer screen updates are performed [default]; option -j. 529 lots of lines, rxvt will only scroll once a whole screen height of
530 lines has been read, resulting in fewer updates while still
531 displaying every received line; option -j.
532
508 False: specify that smooth scrolling should be used; option +j. 533 False: specify that smooth scrolling should be used. rxvt will force
534 a screen refresh on each new line it received; option +j.
535
536 skipScroll: *boolean*
537 True: (the default) specify that skip scrolling should be used. When
538 receiving lots of lines, rxvt will only scroll once in a while
539 (around 60 times per second), resulting in far fewer updates. This
540 can result in rxvt not ever displaying some of the lines it
541 receives; option -ss.
542
543 False: specify that everything is to be displayed, even if the
544 refresh is too fast for the human eye to read anything (or the
545 monitor to display anything); option +ss.
509 546
510 inheritPixmap: *boolean* 547 inheritPixmap: *boolean*
511 True: make the background inherit the parent windows' pixmap, giving 548 True: make the background inherit the parent windows' pixmap, giving
512 artificial transparency. False: do not inherit the parent windows' 549 artificial transparency. False: do not inherit the parent windows'
513 pixmap. 550 pixmap.
514 551
552 *Please note that transparency of any kind if completely unsupported
553 by the author. Don't bug him with installation questions!*
554
515 fading: *number* 555 fading: *number*
516 Fade the text by the given percentage when focus is lost; option 556 Fade the text by the given percentage when focus is lost; option
517 -fade. 557 -fade.
518 558
519 fadeColor: *colour* 559 fadeColor: *colour*
… …
524 Tint the transparent background pixmap with the given colour; option 564 Tint the transparent background pixmap with the given colour; option
525 -tint. 565 -tint.
526 566
527 shading: *number* 567 shading: *number*
528 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 568 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
529 image in addition to tinting it. 569 image in addition to tinting it; option -sh.
570
571 blendType: *string*
572 Specify background blending type; option -blt.
573
574 blurRadius: *number*
575 Apply Gaussian Blurr with the specified radius to the transparent
576 background image; option -blr.
530 577
531 scrollColor: *colour* 578 scrollColor: *colour*
532 Use the specified colour for the scrollbar [default #B2B2B2]. 579 Use the specified colour for the scrollbar [default #B2B2B2].
533 580
534 troughColor: *colour* 581 troughColor: *colour*
… …
538 borderColor: *colour* 585 borderColor: *colour*
539 The colour of the border around the text area and between the 586 The colour of the border around the text area and between the
540 scrollbar and the text. 587 scrollbar and the text.
541 588
542 backgroundPixmap: *file[;geom]* 589 backgroundPixmap: *file[;geom]*
543 Use the specified XPM file (note the `.xpm' extension is optional) 590 Use the specified image file for the background and also optionally
544 for the background and also optionally specify its scaling with a 591 specify its scaling with a geometry string WxH+X+Y, in which "W" /
545 geometry string WxH+X+Y, in which "W" / "H" specify the
546 horizontal/vertical scale (percent) and "X" / "Y" locate the image 592 "H" specify the horizontal/vertical scale (percent), and "X" / "Y"
547 centre (percent). A scale of 0 displays the image with tiling. A 593 locate the image centre (percent). A scale of 0 displays the image
548 scale of 1 displays the image without any scaling. A scale of 2 to 9 594 with tiling. A scale of 1 displays the image without any scaling. A
549 specifies an integer number of images in that direction. No image 595 scale of 2 to 9 specifies an integer number of images in that
550 will be magnified beyond 10 times its original size. The maximum 596 direction. No image will be magnified beyond 10 times its original
551 permitted scale is 1000. [default 0x0+50+50] 597 size. The maximum permitted scale is 1000. Special string of "auto"
598 used as a geometry will cause image to be automatically scaled to
599 match window size. If used in conjunction with -tr option -
600 specified pixmap will be blended over transparency image using
601 either alpha-blending, or any other blending type, specified with
602 -blt "type" option. [default 0x0+50+50]
552 603
553 path: *path* 604 path: *path*
554 Specify the colon-delimited search path for finding XPM files. 605 Specify the colon-delimited search path for finding XPM files.
555 606
556 font: *fontlist* 607 font: *fontlist*
… …
616 normal text font will being used for the given style. 667 normal text font will being used for the given style.
617 668
618 intensityStyles: *boolean* 669 intensityStyles: *boolean*
619 When font styles are not enabled, or this option is enabled (True, 670 When font styles are not enabled, or this option is enabled (True,
620 option -is, the default), bold and italic font styles imply high 671 option -is, the default), bold and italic font styles imply high
621 intensity foreground/backround colours. Disabling this option 672 intensity foreground/background colours. Disabling this option
622 (False, option +is) disables this behaviour, the high intensity 673 (False, option +is) disables this behaviour, the high intensity
623 colours are not reachable. 674 colours are not reachable.
624 675
625 selectstyle: *mode* 676 selectstyle: *mode*
626 Set mouse selection style to old which is 2.20, oldword which is 677 Set mouse selection style to old which is 2.20, oldword which is
627 xterm style with 2.20 old word selection, or anything else which 678 xterm style with 2.20 old word selection, or anything else which
628 gives xterm style selection. 679 gives xterm style selection. Only effective when the original
680 (non-perl) selection code is in use.
629 681
630 scrollstyle: *mode* 682 scrollstyle: *mode*
631 Set scrollbar style to rxvt, plain, next or xterm. plain is the 683 Set scrollbar style to rxvt, plain, next or xterm. plain is the
632 author's favourite. 684 author's favourite.
633 685
… …
643 695
644 mapAlert: *boolean* 696 mapAlert: *boolean*
645 True: de-iconify (map) on receipt of a bell character. False: no 697 True: de-iconify (map) on receipt of a bell character. False: no
646 de-iconify (map) on receipt of a bell character [default]. 698 de-iconify (map) on receipt of a bell character [default].
647 699
700 urgentOnBell: *boolean*
701 True: set the urgency hint for the wm on receipt of a bell
702 character. False: do not set the urgency hint [default].
703
648 visualBell: *boolean* 704 visualBell: *boolean*
649 True: use visual bell on receipt of a bell character; option -vb. 705 True: use visual bell on receipt of a bell character; option -vb.
650 False: no visual bell [default]; option +vb. 706 False: no visual bell [default]; option +vb.
651 707
652 loginShell: *boolean* 708 loginShell: *boolean*
… …
669 Example: 725 Example:
670 726
671 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 727 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
672 728
673 This creates a new file in your home directory with the screen 729 This creates a new file in your home directory with the screen
674 contents everytime you hit "Print". 730 contents every time you hit "Print".
675 731
676 scrollBar: *boolean* 732 scrollBar: *boolean*
677 True: enable the scrollbar [default]; option -sb. False: disable the 733 True: enable the scrollbar [default]; option -sb. False: disable the
678 scrollbar; option +sb. 734 scrollbar; option +sb.
679 735
… …
694 do not scroll to bottom when tty receives output; option +si. 750 do not scroll to bottom when tty receives output; option +si.
695 751
696 scrollWithBuffer: *boolean* 752 scrollWithBuffer: *boolean*
697 True: scroll with scrollback buffer when tty receives new lines (and 753 True: scroll with scrollback buffer when tty receives new lines (and
698 scrollTtyOutput is False); option -sw. False: do not scroll with 754 scrollTtyOutput is False); option -sw. False: do not scroll with
699 scrollback buffer when tty recieves new lines; option +sw. 755 scrollback buffer when tty receives new lines; option +sw.
700 756
701 scrollTtyKeypress: *boolean* 757 scrollTtyKeypress: *boolean*
702 True: scroll to bottom when a non-special key is pressed. Special 758 True: scroll to bottom when a non-special key is pressed. Special
703 keys are those which are intercepted by rxvt-unicode for special 759 keys are those which are intercepted by rxvt-unicode for special
704 handling and are not passed onto the shell; option -sk. False: do 760 handling and are not passed onto the shell; option -sk. False: do
… …
780 836
781 cutchars: *string* 837 cutchars: *string*
782 The characters used as delimiters for double-click word selection 838 The characters used as delimiters for double-click word selection
783 (whitespace delimiting is added automatically if resource is given). 839 (whitespace delimiting is added automatically if resource is given).
784 840
785 When the selection extension is in use (the default if compiled in, 841 When the perl selection extension is in use (the default if compiled
786 see the rxvtperl(3) manpage), a suitable regex using these 842 in, see the rxvtperl(3) manpage), a suitable regex using these
787 characters will be created (if the resource exists, otherwise, no 843 characters will be created (if the resource exists, otherwise, no
788 regex will be created). In this mode, characters outside ISO-8859-1 844 regex will be created). In this mode, characters outside ISO-8859-1
789 can be used. 845 can be used.
790 846
791 When the selection extension is not used, only ISO-8859-1 characters 847 When the selection extension is not used, only ISO-8859-1 characters
… …
843 899
844 secondaryScreen: *boolean* 900 secondaryScreen: *boolean*
845 Turn on/off secondary screen (default enabled). 901 Turn on/off secondary screen (default enabled).
846 902
847 secondaryScroll: *boolean* 903 secondaryScroll: *boolean*
848 Turn on/off secondary screen scroll (default enabled). If the this 904 Turn on/off secondary screen scroll (default enabled). If this
849 option is enabled, scrolls on the secondary screen will change the 905 option is enabled, scrolls on the secondary screen will change the
850 scrollback buffer and switching to/from the secondary screen will 906 scrollback buffer and switching to/from the secondary screen will
851 instead scroll the screen up. 907 instead scroll the screen up.
852 908
853 hold: *boolean* 909 hold: *boolean*
… …
879 935
880 *string* may contain escape values ("\a": bell, "\b": backspace, 936 *string* may contain escape values ("\a": bell, "\b": backspace,
881 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 937 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
882 "\000": octal number) or verbatim control characters ("^?": delete, 938 "\000": octal number) or verbatim control characters ("^?": delete,
883 "^@": null, "^A" ...) and may be enclosed with double quotes so that 939 "^@": null, "^A" ...) and may be enclosed with double quotes so that
884 it can start or end with whitespace. 940 it can start or end with whitespace. This feature is deprecated and
941 will be removed.
885 942
886 Please note that you need to double the "\" in resource files, as 943 Please note that you need to double the "\" in resource files, as
887 Xlib itself does it's own de-escaping (you can use "\033" instead of 944 Xlib itself does its own de-escaping (you can use "\033" instead of
888 "\e" (and so on), which will work with both Xt and rxvt's own 945 "\e" (and so on), which will work with both Xt and rxvt's own
889 processing). 946 processing).
890 947
891 You can define a range of keysyms in one shot by providing a 948 You can define a range of keysyms in one shot by providing a
892 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 949 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
893 `/' should be a character not used by the strings. 950 `/' should be a character not used by the strings.
894 951
895 Its usage can be demonstrated by an example: 952 Its usage can be demonstrated by an example:
896 953
897 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 954 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
959 For example, "default,-selection" will use all the default extension 1016 For example, "default,-selection" will use all the default extension
960 except "selection". 1017 except "selection".
961 1018
962 Extension names can also be followed by an argument in angle 1019 Extension names can also be followed by an argument in angle
963 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey 1020 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
964 for searchable scorllback to Alt/Meta-s). Mentioning the same 1021 for searchable scrollback to Alt/Meta-s). Mentioning the same
965 extension multiple times with different arguments will pass multiple 1022 extension multiple times with different arguments will pass multiple
966 arguments to the extension. 1023 arguments to the extension.
967 1024
968 Each extension is looked up in the library directories, loaded if 1025 Each extension is looked up in the library directories, loaded if
969 necessary, and bound to the current terminal instance. 1026 necessary, and bound to the current terminal instance.
… …
1000 Sets the hotkey that starts the incremental scrollback buffer search 1057 Sets the hotkey that starts the incremental scrollback buffer search
1001 (default: "M-s"). 1058 (default: "M-s").
1002 1059
1003 urlLauncher: *string* 1060 urlLauncher: *string*
1004 Specifies the program to be started with a URL argument. Used by the 1061 Specifies the program to be started with a URL argument. Used by the
1005 "selection-popup" and "mark-urls" perl extensions. 1062 "selection-popup" and "matcher" perl extensions.
1006 1063
1007 transient-for: *windowid* 1064 transient-for: *windowid*
1008 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given 1065 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1009 window id. 1066 window id.
1010 1067
1011 override-redirect: *boolean* 1068 override-redirect: *boolean*
1012 Compile *frills*: Sets override-redirect for the terminal window, 1069 Compile *frills*: Sets override-redirect for the terminal window,
1013 making it almost invisible to window managers; option 1070 making it almost invisible to window managers; option
1014 -override-redirect. 1071 -override-redirect.
1072
1073 iso14755_52: *boolean*
1074 Turn on/off ISO 14755 5.2 mode (default enabled).
1015 1075
1016THE SCROLLBAR 1076THE SCROLLBAR
1017 Lines of text that scroll off the top of the rxvt window (resource: 1077 Lines of text that scroll off the top of the rxvt window (resource:
1018 saveLines) and can be scrolled back using the scrollbar or by 1078 saveLines) and can be scrolled back using the scrollbar or by
1019 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1079 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
1033 disabled -- on the assumption that we are using a fullscreen 1093 disabled -- on the assumption that we are using a fullscreen
1034 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ 1094 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
1035 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the 1095 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
1036 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. 1096 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
1037 1097
1038TEXT SELECTION AND INSERTION 1098THE SELECTION: SELECTING AND PASTING TEXT
1039 The behaviour of text selection and insertion mechanism is similar to 1099 The behaviour of text selection and insertion/pasting mechanism is
1040 *xterm*(1). 1100 similar to *xterm*(1).
1041 1101
1042 Selection: 1102 Selecting:
1043 Left click at the beginning of the region, drag to the end of the 1103 Left click at the beginning of the region, drag to the end of the
1044 region and release; Right click to extend the marked region; Left 1104 region and release; Right click to extend the marked region; Left
1045 double-click to select a word; Left triple-click to select the 1105 double-click to select a word; Left triple-click to select the
1046 entire logical line (which can span multiple screen lines), unless 1106 entire logical line (which can span multiple screen lines), unless
1047 modified by resource tripleclickwords. 1107 modified by resource tripleclickwords.
… …
1050 (Compile: *frills*) will create a rectangular selection instead of a 1110 (Compile: *frills*) will create a rectangular selection instead of a
1051 normal one. In this mode, every selected row becomes its own line in 1111 normal one. In this mode, every selected row becomes its own line in
1052 the selection, and trailing whitespace is visually underlined and 1112 the selection, and trailing whitespace is visually underlined and
1053 removed from the selection. 1113 removed from the selection.
1054 1114
1055 Insertion: 1115 Pasting:
1056 Pressing and releasing the Middle mouse button in an rxvt window 1116 Pressing and releasing the Middle mouse button in an rxvt window
1057 causes the value of the PRIMARY selection (or CLIPBOARD with the 1117 causes the value of the PRIMARY selection (or CLIPBOARD with the
1058 Meta modifier) to be inserted as if it had been typed on the 1118 Meta modifier) to be inserted as if it had been typed on the
1059 keyboard. 1119 keyboard.
1060 1120
… …
1104 This mode lets you input characters representing the keycap symbols 1164 This mode lets you input characters representing the keycap symbols
1105 of your keyboard, if representable in the current locale encoding. 1165 of your keyboard, if representable in the current locale encoding.
1106 1166
1107 Start by pressing "Control" and "Shift" together, then releasing 1167 Start by pressing "Control" and "Shift" together, then releasing
1108 them. The next special key (cursor keys, home etc.) you enter will 1168 them. The next special key (cursor keys, home etc.) you enter will
1109 not invoke it's usual function but instead will insert the 1169 not invoke its usual function but instead will insert the
1110 corresponding keycap symbol. The symbol will only be entered when 1170 corresponding keycap symbol. The symbol will only be entered when
1111 the key has been released, otherwise pressing e.g. "Shift" would 1171 the key has been released, otherwise pressing e.g. "Shift" would
1112 enter the symbol for "ISO Level 2 Switch", although your intention 1172 enter the symbol for "ISO Level 2 Switch", although your intention
1113 might have been to enter a reverse tab (Shift-Tab). 1173 might have been to enter a reverse tab (Shift-Tab).
1114 1174
… …
1143 setgid to root or to some other group on others. 1203 setgid to root or to some other group on others.
1144 1204
1145COLORS AND GRAPHICS 1205COLORS AND GRAPHICS
1146 In addition to the default foreground and background colours, rxvt can 1206 In addition to the default foreground and background colours, rxvt can
1147 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1207 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1148 versions of the same). Here is a list of the colours with their rgb.txt 1208 versions of the same). Here is a list of the colours with their names.
1149 names.
1150 1209
1151 color0 (black) = Black 1210 color0 (black) = Black
1152 color1 (red) = Red3 1211 color1 (red) = Red3
1153 color2 (green) = Green3 1212 color2 (green) = Green3
1154 color3 (yellow) = Yellow3 1213 color3 (yellow) = Yellow3
… …
1170 It is also possible to specify the colour values of foreground, 1229 It is also possible to specify the colour values of foreground,
1171 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1230 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1172 0-15, as a convenient shorthand to reference the colour name of 1231 0-15, as a convenient shorthand to reference the colour name of
1173 color0-color15. 1232 color0-color15.
1174 1233
1234 In addition to the colours defined above, rxvt offers an additional 72
1235 colours. The first 64 of those (with indices 16 to 79) consist of a
1236 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1237 by 8 additional shades of gray (with indices 80 to 87).
1238
1239 Together, all those colours implement the 88 colour xterm colours. Only
1240 the first 16 can be changed using resources currently, the rest can only
1241 be changed via command sequences ("escape codes").
1242
1175 Note that -rv ("reverseVideo: True") simulates reverse video by always 1243 Note that -rv ("reverseVideo: True") simulates reverse video by always
1176 swapping the foreground/background colours. This is in contrast to 1244 swapping the foreground/background colours. This is in contrast to
1177 *xterm*(1) where the colours are only swapped if they have not otherwise 1245 *xterm*(1) where the colours are only swapped if they have not otherwise
1178 been specified. For example, 1246 been specified. For example,
1179 1247
1180 rxvt -fg Black -bg White -rv 1248 rxvt -fg Black -bg White -rv
1181 would yield White on Black, while on *xterm*(1) it would yield Black 1249 would yield White on Black, while on *xterm*(1) it would yield Black
1182 on White. 1250 on White.
1183 1251
1252 ALPHA CHANNEL SUPPORT
1253 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1254 get their act together, rxvt-unicode will support
1255 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1256 digits/component) colour specifications, in addition to the ones
1257 provided by X, where the additional A component specifies opacity
1258 (alpha) values. The minimum value of 0 is completely transparent). You
1259 can also prefix any color with "[percent]", where "percent" is a decimal
1260 percentage (0-100) that specifies the opacity of the color, where 0 is
1261 completely transparent and 100 is completelxy opaque.
1262
1263 You probably need to specify "-depth 32", too, and have the luck that
1264 your X-server uses ARGB pixel layout, as X is far from just supporting
1265 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1266
1267 For example, the following selects an almost completely transparent red
1268 background, and an almost opaque pink foreground:
1269
1270 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1271
1272 *Please note that transparency of any kind if completely unsupported by
1273 the author. Don't bug him with installation questions!*
1274
1184ENVIRONMENT 1275ENVIRONMENT
1185 rxvt sets and/or uses the following environment variables: 1276 rxvt sets and/or uses the following environment variables:
1186 1277
1187 TERM 1278 TERM
1188 Normally set to "rxvt-unicode", unless overwritten at configure 1279 Normally set to "rxvt-unicode", unless overwritten at configure
1189 time, via resources or on the commandline. 1280 time, via resources or on the command line.
1190 1281
1191 COLORTERM 1282 COLORTERM
1192 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1283 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1193 with XPM support, and optionally with the added extension "-mono" to 1284 with XPM support, and optionally with the added extension "-mono" to
1194 indicate that rxvt-unicode runs on a monochrome screen. 1285 indicate that rxvt-unicode runs on a monochrome screen.
1195 1286
1196 COLORFGBG 1287 COLORFGBG
1197 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1288 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
… …
1211 Set to the terminfo directory iff rxvt was configured with 1302 Set to the terminfo directory iff rxvt was configured with
1212 "--with-terminfo=PATH". 1303 "--with-terminfo=PATH".
1213 1304
1214 DISPLAY 1305 DISPLAY
1215 Used by rxvt to connect to the display and set to the correct 1306 Used by rxvt to connect to the display and set to the correct
1216 display in it's child processes. 1307 display in its child processes.
1217 1308
1218 SHELL 1309 SHELL
1219 The shell to be used for command execution, defaults to "/bin/sh". 1310 The shell to be used for command execution, defaults to "/bin/sh".
1220 1311
1221 RXVT_SOCKET 1312 RXVT_SOCKET
… …
1245 1336
1246CURRENT PROJECT COORDINATOR 1337CURRENT PROJECT COORDINATOR
1247 Project Coordinator 1338 Project Coordinator
1248 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1339 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1249 1340
1250 <http://software.schmorp.de/#rxvt-unicode> 1341 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1251 1342
1252AUTHORS 1343AUTHORS
1253 John Bovey 1344 John Bovey
1254 University of Kent, 1992, wrote the original Xvt. 1345 University of Kent, 1992, wrote the original Xvt.
1255 1346

Diff Legend

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