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.63 by root, Thu Nov 2 17:37: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 8.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
… …
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.
105 110
… …
123 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;
124 resource *tintColor*. Example: 129 resource *tintColor*. Example:
125 130
126 rxvt -tr -tint blue -sh 40 131 rxvt -tr -tint blue -sh 40
127 132
133 -sh *number*
128 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 134 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
129 background image in addition to tinting it (i.e. -tint must be 135 image in addition to (or instead of) tinting it; resource *shading*.
130 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*.
131 148
132 -bg *colour* 149 -bg *colour*
133 Window background colour; resource background. 150 Window background colour; resource background.
134 151
135 -fg *colour* 152 -fg *colour*
136 Window foreground colour; resource foreground. 153 Window foreground colour; resource foreground.
137 154
138 -pixmap *file[;geom]* 155 -pixmap *file[;geom]*
139 Compile *XPM*: Specify XPM file for the background and also 156 Compile *afterimage*: Specify image file for the background and also
140 optionally specify its scaling with a geometry string. Note you may 157 optionally specify its scaling with a geometry string. Note you may
141 need to add quotes to avoid special shell interpretation of the ";" 158 need to add quotes to avoid special shell interpretation of the ";"
142 in the command-line; resource backgroundPixmap. 159 in the command-line; for more details see resource backgroundPixmap.
143 160
144 -cr *colour* 161 -cr *colour*
145 The cursor colour; resource cursorColor. 162 The cursor colour; resource cursorColor.
146 163
147 -pr *colour* 164 -pr *colour*
… …
327 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
328 for more info. 345 for more info.
329 346
330 -tcw 347 -tcw
331 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
332 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
333 selection the end of the logical line only. resource 351 selection the end of the logical line only. resource
334 tripleclickwords. 352 tripleclickwords.
335 353
336 -insecure 354 -insecure
337 Enable "insecure" mode, which currently enables most of the escape 355 Enable "insecure" mode, which currently enables most of the escape
… …
484 Use the specified colour to display underlined characters when the 502 Use the specified colour to display underlined characters when the
485 foreground colour is the default. 503 foreground colour is the default.
486 504
487 colorRV: *colour* 505 colorRV: *colour*
488 Use the specified colour as the background for reverse video 506 Use the specified colour as the background for reverse video
489 characters. 507 characters when OPTION_HC is disabled (--disable-frills).
490 508
491 underlineColor: *colour* 509 underlineColor: *colour*
492 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
493 itself. If unset, use the foreground colour. 511 itself. If unset, use the foreground colour.
494 512
… …
505 True: simulate reverse video by foreground and background colours; 523 True: simulate reverse video by foreground and background colours;
506 option -rv. False: regular screen colours [default]; option +rv. See 524 option -rv. False: regular screen colours [default]; option +rv. See
507 note in COLORS AND GRAPHICS section. 525 note in COLORS AND GRAPHICS section.
508 526
509 jumpScroll: *boolean* 527 jumpScroll: *boolean*
510 True: specify that jump scrolling should be used. When scrolling 528 True: specify that jump scrolling should be used. When receiving
511 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
512 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.
513 546
514 inheritPixmap: *boolean* 547 inheritPixmap: *boolean*
515 True: make the background inherit the parent windows' pixmap, giving 548 True: make the background inherit the parent windows' pixmap, giving
516 artificial transparency. False: do not inherit the parent windows' 549 artificial transparency. False: do not inherit the parent windows'
517 pixmap. 550 pixmap.
… …
531 Tint the transparent background pixmap with the given colour; option 564 Tint the transparent background pixmap with the given colour; option
532 -tint. 565 -tint.
533 566
534 shading: *number* 567 shading: *number*
535 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 568 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
536 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.
537 577
538 scrollColor: *colour* 578 scrollColor: *colour*
539 Use the specified colour for the scrollbar [default #B2B2B2]. 579 Use the specified colour for the scrollbar [default #B2B2B2].
540 580
541 troughColor: *colour* 581 troughColor: *colour*
… …
545 borderColor: *colour* 585 borderColor: *colour*
546 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
547 scrollbar and the text. 587 scrollbar and the text.
548 588
549 backgroundPixmap: *file[;geom]* 589 backgroundPixmap: *file[;geom]*
550 Use the specified XPM file (note the `.xpm' extension is optional) 590 Use the specified image file for the background and also optionally
551 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" /
552 geometry string WxH+X+Y, in which "W" / "H" specify the
553 horizontal/vertical scale (percent) and "X" / "Y" locate the image 592 "H" specify the horizontal/vertical scale (percent), and "X" / "Y"
554 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
555 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
556 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
557 will be magnified beyond 10 times its original size. The maximum 596 direction. No image will be magnified beyond 10 times its original
558 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]
559 603
560 path: *path* 604 path: *path*
561 Specify the colon-delimited search path for finding XPM files. 605 Specify the colon-delimited search path for finding XPM files.
562 606
563 font: *fontlist* 607 font: *fontlist*
… …
630 colours are not reachable. 674 colours are not reachable.
631 675
632 selectstyle: *mode* 676 selectstyle: *mode*
633 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
634 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
635 gives xterm style selection. 679 gives xterm style selection. Only effective when the original
680 (non-perl) selection code is in use.
636 681
637 scrollstyle: *mode* 682 scrollstyle: *mode*
638 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
639 author's favourite. 684 author's favourite.
640 685
… …
649 explicitly set; option -n. 694 explicitly set; option -n.
650 695
651 mapAlert: *boolean* 696 mapAlert: *boolean*
652 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
653 de-iconify (map) on receipt of a bell character [default]. 698 de-iconify (map) on receipt of a bell character [default].
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].
654 703
655 visualBell: *boolean* 704 visualBell: *boolean*
656 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.
657 False: no visual bell [default]; option +vb. 706 False: no visual bell [default]; option +vb.
658 707
… …
787 836
788 cutchars: *string* 837 cutchars: *string*
789 The characters used as delimiters for double-click word selection 838 The characters used as delimiters for double-click word selection
790 (whitespace delimiting is added automatically if resource is given). 839 (whitespace delimiting is added automatically if resource is given).
791 840
792 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
793 see the rxvtperl(3) manpage), a suitable regex using these 842 in, see the rxvtperl(3) manpage), a suitable regex using these
794 characters will be created (if the resource exists, otherwise, no 843 characters will be created (if the resource exists, otherwise, no
795 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
796 can be used. 845 can be used.
797 846
798 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
… …
850 899
851 secondaryScreen: *boolean* 900 secondaryScreen: *boolean*
852 Turn on/off secondary screen (default enabled). 901 Turn on/off secondary screen (default enabled).
853 902
854 secondaryScroll: *boolean* 903 secondaryScroll: *boolean*
855 Turn on/off secondary screen scroll (default enabled). If the this 904 Turn on/off secondary screen scroll (default enabled). If this
856 option is enabled, scrolls on the secondary screen will change the 905 option is enabled, scrolls on the secondary screen will change the
857 scrollback buffer and switching to/from the secondary screen will 906 scrollback buffer and switching to/from the secondary screen will
858 instead scroll the screen up. 907 instead scroll the screen up.
859 908
860 hold: *boolean* 909 hold: *boolean*
… …
1008 Sets the hotkey that starts the incremental scrollback buffer search 1057 Sets the hotkey that starts the incremental scrollback buffer search
1009 (default: "M-s"). 1058 (default: "M-s").
1010 1059
1011 urlLauncher: *string* 1060 urlLauncher: *string*
1012 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
1013 "selection-popup" and "mark-urls" perl extensions. 1062 "selection-popup" and "matcher" perl extensions.
1014 1063
1015 transient-for: *windowid* 1064 transient-for: *windowid*
1016 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given 1065 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1017 window id. 1066 window id.
1018 1067
1019 override-redirect: *boolean* 1068 override-redirect: *boolean*
1020 Compile *frills*: Sets override-redirect for the terminal window, 1069 Compile *frills*: Sets override-redirect for the terminal window,
1021 making it almost invisible to window managers; option 1070 making it almost invisible to window managers; option
1022 -override-redirect. 1071 -override-redirect.
1072
1073 iso14755_52: *boolean*
1074 Turn on/off ISO 14755 5.2 mode (default enabled).
1023 1075
1024THE SCROLLBAR 1076THE SCROLLBAR
1025 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:
1026 saveLines) and can be scrolled back using the scrollbar or by 1078 saveLines) and can be scrolled back using the scrollbar or by
1027 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1079 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
1041 disabled -- on the assumption that we are using a fullscreen 1093 disabled -- on the assumption that we are using a fullscreen
1042 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ 1094 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
1043 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the 1095 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
1044 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.
1045 1097
1046TEXT SELECTION AND INSERTION 1098THE SELECTION: SELECTING AND PASTING TEXT
1047 The behaviour of text selection and insertion mechanism is similar to 1099 The behaviour of text selection and insertion/pasting mechanism is
1048 *xterm*(1). 1100 similar to *xterm*(1).
1049 1101
1050 Selection: 1102 Selecting:
1051 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
1052 region and release; Right click to extend the marked region; Left 1104 region and release; Right click to extend the marked region; Left
1053 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
1054 entire logical line (which can span multiple screen lines), unless 1106 entire logical line (which can span multiple screen lines), unless
1055 modified by resource tripleclickwords. 1107 modified by resource tripleclickwords.
… …
1058 (Compile: *frills*) will create a rectangular selection instead of a 1110 (Compile: *frills*) will create a rectangular selection instead of a
1059 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
1060 the selection, and trailing whitespace is visually underlined and 1112 the selection, and trailing whitespace is visually underlined and
1061 removed from the selection. 1113 removed from the selection.
1062 1114
1063 Insertion: 1115 Pasting:
1064 Pressing and releasing the Middle mouse button in an rxvt window 1116 Pressing and releasing the Middle mouse button in an rxvt window
1065 causes the value of the PRIMARY selection (or CLIPBOARD with the 1117 causes the value of the PRIMARY selection (or CLIPBOARD with the
1066 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
1067 keyboard. 1119 keyboard.
1068 1120
… …
1202 get their act together, rxvt-unicode will support 1254 get their act together, rxvt-unicode will support
1203 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 1255 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1204 digits/component) colour specifications, in addition to the ones 1256 digits/component) colour specifications, in addition to the ones
1205 provided by X, where the additional A component specifies opacity 1257 provided by X, where the additional A component specifies opacity
1206 (alpha) values. The minimum value of 0 is completely transparent). You 1258 (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 1259 can also prefix any color with "[percent]", where "percent" is a decimal
1208 specifiying the opacity value. 1260 percentage (0-100) that specifies the opacity of the color, where 0 is
1261 completely transparent and 100 is completelxy opaque.
1209 1262
1210 You probably need to specify "-depth 32", too, and have the luck that 1263 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 1264 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. 1265 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1213 1266
1214 For example, the following selects an almost completely transparent red 1267 For example, the following selects an almost completely transparent red
1215 background, and an almost opaque pink foreground: 1268 background, and an almost opaque pink foreground:
1216 1269
1217 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1270 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1218 1271
1219 *Please note that transparency of any kind if completely unsupported by 1272 *Please note that transparency of any kind if completely unsupported by
1220 the author. Don't bug him with installation questions!* 1273 the author. Don't bug him with installation questions!*
1221 1274
1222ENVIRONMENT 1275ENVIRONMENT

Diff Legend

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