ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.132 by root, Mon Jun 18 13:38:12 2007 UTC

… …
108 108
109Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
110 110
111=item B<-j>|B<+j> 111=item B<-j>|B<+j>
112 112
113Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114
115=item B<-ss>|B<+ss>
116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
114 118
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 119=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
116 120
117Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off inheriting parent window's pixmap. Alternative form is
118B<-tr>; resource B<inheritPixmap>. 122B<-tr>; resource B<inheritPixmap>.
… …
140used to brighten or darken the image in addition to tinting it; resource 144used to brighten or darken the image in addition to tinting it; resource
141I<tintColor>. Example: 145I<tintColor>. Example:
142 146
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 147 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 148
145=item B<-sh> 149=item B<-sh> I<number>
146 150
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 151Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 152background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>); resource I<shading>. 153resource I<shading>.
154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159transparency image, using method specified. Supported values are :
160B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending; resource I<blendType>.
164
165=item B<-blr> I<number>
166
167Apply Gaussian Blur with the specified radius to the transparent
168background image; resource I<blurRadius>.
150 169
151=item B<-bg> I<colour> 170=item B<-bg> I<colour>
152 171
153Window background colour; resource B<background>. 172Window background colour; resource B<background>.
154 173
… …
156 175
157Window foreground colour; resource B<foreground>. 176Window foreground colour; resource B<foreground>.
158 177
159=item B<-pixmap> I<file[;geom]> 178=item B<-pixmap> I<file[;geom]>
160 179
161Compile I<XPM>: Specify XPM file for the background and also optionally 180Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 181optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 182add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 183command-line; for more details see resource B<backgroundPixmap>.
165 184
166=item B<-cr> I<colour> 185=item B<-cr> I<colour>
167 186
168The cursor colour; resource B<cursorColor>. 187The cursor colour; resource B<cursorColor>.
169 188
… …
386for more info. 405for more info.
387 406
388=item B<-tcw> 407=item B<-tcw>
389 408
390Change the meaning of triple-click selection with the left mouse 409Change the meaning of triple-click selection with the left mouse
410button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 411in-use. Instead of selecting a full line it will extend the selection the
392end of the logical line only. resource B<tripleclickwords>. 412end of the logical line only. resource B<tripleclickwords>.
393 413
394=item B<-insecure> 414=item B<-insecure>
395 415
396Enable "insecure" mode, which currently enables most of the escape 416Enable "insecure" mode, which currently enables most of the escape
… …
591option B<-rv>. B<False>: regular screen colours [default]; option 611option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 612B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 613
594=item B<jumpScroll:> I<boolean> 614=item B<jumpScroll:> I<boolean>
595 615
596B<True>: specify that jump scrolling should be used. When scrolling 616B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 617of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
618has been read, resulting in fewer updates while still displaying every
619received line; option B<-j>.
620
598B<False>: specify that smooth scrolling should be used; option B<+j>. 621B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
622force a screen refresh on each new line it received; option B<+j>.
623
624=item B<skipScroll:> I<boolean>
625
626B<True>: (the default) specify that skip scrolling should be used. When
627receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
628(around 60 times per second), resulting in far fewer updates. This can
629result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
630option B<-ss>.
631
632B<False>: specify that everything is to be displayed, even
633if the refresh is too fast for the human eye to read anything (or the
634monitor to display anything); option B<+ss>.
599 635
600=item B<inheritPixmap:> I<boolean> 636=item B<inheritPixmap:> I<boolean>
601 637
602B<True>: make the background inherit the parent windows' pixmap, giving 638B<True>: make the background inherit the parent windows' pixmap, giving
603artificial transparency. B<False>: do not inherit the parent windows' 639artificial transparency. B<False>: do not inherit the parent windows'
… …
623=item B<shading:> I<number> 659=item B<shading:> I<number>
624 660
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 661Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626in addition to tinting it; option B<-sh>. 662in addition to tinting it; option B<-sh>.
627 663
664=item B<blendType:> I<string>
665
666Specify background blending type; option B<-blt>.
667
668=item B<blurRadius:> I<number>
669
670Apply Gaussian Blurr with the specified radius to the transparent
671background image; option B<-blr>.
672
628=item B<scrollColor:> I<colour> 673=item B<scrollColor:> I<colour>
629 674
630Use the specified colour for the scrollbar [default #B2B2B2]. 675Use the specified colour for the scrollbar [default #B2B2B2].
631 676
632=item B<troughColor:> I<colour> 677=item B<troughColor:> I<colour>
… …
639The colour of the border around the text area and between the scrollbar 684The colour of the border around the text area and between the scrollbar
640and the text. 685and the text.
641 686
642=item B<backgroundPixmap:> I<file[;geom]> 687=item B<backgroundPixmap:> I<file[;geom]>
643 688
644Use the specified XPM file (note the `.xpm' extension is optional) for 689Use the specified image file for the background and also optionally
645the background and also optionally specify its scaling with a geometry 690specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 691in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 692and B<"X" / "Y"> locate the image centre (percent).
648centre (percent). A scale of 0 displays the image with tiling. A scale 693A scale of 0 displays the image with tiling. A scale of 1 displays the
649of 1 displays the image without any scaling. A scale of 2 to 9 694image without any scaling. A scale of 2 to 9 specifies an integer
650specifies an integer number of images in that direction. No image will 695number of images in that direction. No image will be magnified beyond
651be magnified beyond 10 times its original size. The maximum permitted 69610 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 697Special string of B<"auto"> used as a geometry will cause image to be
698automatically scaled to match window size.
699If used in conjunction with B<-tr> option - specified pixmap will be
700blended over transparency image using either alpha-blending, or any
701other blending type, specified with B<-blt "type"> option.
702[default 0x0+50+50]
653 703
654=item B<path:> I<path> 704=item B<path:> I<path>
655 705
656Specify the colon-delimited search path for finding XPM files. 706Specify the colon-delimited search path for finding XPM files.
657 707
… …
725option B<+is>) disables this behaviour, the high intensity colours are not 775option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 776reachable.
727 777
728=item B<selectstyle:> I<mode> 778=item B<selectstyle:> I<mode>
729 779
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is 780Set mouse selection style to B<old> which is 2.20, B<oldword> which
731xterm style with 2.20 old word selection, or anything else which gives 781is xterm style with 2.20 old word selection, or anything else which
732xterm style selection. 782gives xterm style selection. Only effective when the original (non-perl)
783selection code is in use.
733 784
734=item B<scrollstyle:> I<mode> 785=item B<scrollstyle:> I<mode>
735 786
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 787Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite. 788the author's favourite.
… …
921=item B<cutchars:> I<string> 972=item B<cutchars:> I<string>
922 973
923The characters used as delimiters for double-click word selection 974The characters used as delimiters for double-click word selection
924(whitespace delimiting is added automatically if resource is given). 975(whitespace delimiting is added automatically if resource is given).
925 976
926When the selection extension is in use (the default if compiled in, see 977When the perl selection extension is in use (the default if compiled
927the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 978in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
928will be created (if the resource exists, otherwise, no regex will be 979characters will be created (if the resource exists, otherwise, no regex
929created). In this mode, characters outside ISO-8859-1 can be used. 980will be created). In this mode, characters outside ISO-8859-1 can be used.
930 981
931When the selection extension is not used, only ISO-8859-1 characters can 982When the selection extension is not used, only ISO-8859-1 characters can
932be used. If not specified, the built-in default is used: 983be used. If not specified, the built-in default is used:
933 984
934B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 985B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
… …
1171=item B<override-redirect>: I<boolean> 1222=item B<override-redirect>: I<boolean>
1172 1223
1173Compile I<frills>: Sets override-redirect for the terminal window, making 1224Compile I<frills>: Sets override-redirect for the terminal window, making
1174it almost invisible to window managers; option B<-override-redirect>. 1225it almost invisible to window managers; option B<-override-redirect>.
1175 1226
1227=item B<iso14755_52:> I<boolean>
1228
1229Turn on/off ISO 14755 5.2 mode (default enabled).
1230
1176=back 1231=back
1177 1232
1178=head1 THE SCROLLBAR 1233=head1 THE SCROLLBAR
1179 1234
1180Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1235Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1198application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1253application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1199(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1254(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1200up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1255up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1201respectively. 1256respectively.
1202 1257
1203=head1 TEXT SELECTION AND INSERTION 1258=head1 THE SELECTION: SELECTING AND PASTING TEXT
1204 1259
1205The behaviour of text selection and insertion mechanism is similar to 1260The behaviour of text selection and insertion/pasting mechanism is similar
1206I<xterm>(1). 1261to I<xterm>(1).
1207 1262
1208=over 4 1263=over 4
1209 1264
1210=item B<Selection>: 1265=item B<Selecting>:
1211 1266
1212Left click at the beginning of the region, drag to the end of the region 1267Left click at the beginning of the region, drag to the end of the region
1213and release; Right click to extend the marked region; Left double-click 1268and release; Right click to extend the marked region; Left double-click
1214to select a word; Left triple-click to select the entire logical line 1269to select a word; Left triple-click to select the entire logical line
1215(which can span multiple screen lines), unless modified by resource 1270(which can span multiple screen lines), unless modified by resource
… …
1219(Compile: I<frills>) will create a rectangular selection instead of a 1274(Compile: I<frills>) will create a rectangular selection instead of a
1220normal one. In this mode, every selected row becomes its own line in the 1275normal one. In this mode, every selected row becomes its own line in the
1221selection, and trailing whitespace is visually underlined and removed from 1276selection, and trailing whitespace is visually underlined and removed from
1222the selection. 1277the selection.
1223 1278
1224=item B<Insertion>: 1279=item B<Pasting>:
1225 1280
1226Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1281Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1227window causes the value of the PRIMARY selection (or CLIPBOARD with the 1282window causes the value of the PRIMARY selection (or CLIPBOARD with the
1228Meta modifier) to be inserted as if it had been typed on the keyboard. 1283B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1229 1284
1230Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1285Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1231inserted too. 1286inserted too.
1232 1287
1233=back 1288=back

Diff Legend

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