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.120 by root, Sat Aug 12 01:37:11 2006 UTC vs.
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC

17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
140used to brighten or darken the image in addition to tinting it; resource 140used to brighten or darken the image in addition to tinting it; resource
141I<tintColor>. Example: 141I<tintColor>. Example:
142 142
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 143 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 144
145=item B<-sh> 145=item B<-sh> I<number>
146 146
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 148background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>). 149resource I<shading>.
150
151=item B<-blt> I<string>
152
153Specify background blending type. If background pixmap is specified
154at the same time as transparency - such pixmap will be blended over
155transparency image, using method specified. Supported values are :
156B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159alpha-blending; resource I<blendType>.
160
161=item B<-blr> I<number>
162
163Apply Gaussian Blur with the specified radius to the transparent
164background image; resource I<blurRadius>.
150 165
151=item B<-bg> I<colour> 166=item B<-bg> I<colour>
152 167
153Window background colour; resource B<background>. 168Window background colour; resource B<background>.
154 169
156 171
157Window foreground colour; resource B<foreground>. 172Window foreground colour; resource B<foreground>.
158 173
159=item B<-pixmap> I<file[;geom]> 174=item B<-pixmap> I<file[;geom]>
160 175
161Compile I<XPM>: Specify XPM file for the background and also optionally 176Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 177optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 178add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 179command-line; for more details see resource B<backgroundPixmap>.
165 180
166=item B<-cr> I<colour> 181=item B<-cr> I<colour>
167 182
168The cursor colour; resource B<cursorColor>. 183The cursor colour; resource B<cursorColor>.
169 184
386for more info. 401for more info.
387 402
388=item B<-tcw> 403=item B<-tcw>
389 404
390Change the meaning of triple-click selection with the left mouse 405Change the meaning of triple-click selection with the left mouse
406button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 407in-use. Instead of selecting a full line it will extend the selection the
392end of the logical line only. resource B<tripleclickwords>. 408end of the logical line only. resource B<tripleclickwords>.
393 409
394=item B<-insecure> 410=item B<-insecure>
395 411
396Enable "insecure" mode, which currently enables most of the escape 412Enable "insecure" mode, which currently enables most of the escape
564Use the specified colour to display underlined characters when the 580Use the specified colour to display underlined characters when the
565foreground colour is the default. 581foreground colour is the default.
566 582
567=item B<colorRV:> I<colour> 583=item B<colorRV:> I<colour>
568 584
569Use the specified colour as the background for reverse video 585Use the specified colour as the background for reverse video characters
570characters. 586when OPTION_HC is disabled (--disable-frills).
571 587
572=item B<underlineColor:> I<colour> 588=item B<underlineColor:> I<colour>
573 589
574If set, use the specified colour as the colour for the underline 590If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 591itself. If unset, use the foreground colour.
620Tint the transparent background pixmap with the given colour; option 636Tint the transparent background pixmap with the given colour; option
621B<-tint>. 637B<-tint>.
622 638
623=item B<shading:> I<number> 639=item B<shading:> I<number>
624 640
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 641Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626image in addition to tinting it. 642in addition to tinting it; option B<-sh>.
643
644=item B<blendType:> I<string>
645
646Specify background blending type; option B<-blt>.
647
648=item B<blurRadius:> I<number>
649
650Apply Gaussian Blurr with the specified radius to the transparent
651background image; option B<-blr>.
627 652
628=item B<scrollColor:> I<colour> 653=item B<scrollColor:> I<colour>
629 654
630Use the specified colour for the scrollbar [default #B2B2B2]. 655Use the specified colour for the scrollbar [default #B2B2B2].
631 656
639The colour of the border around the text area and between the scrollbar 664The colour of the border around the text area and between the scrollbar
640and the text. 665and the text.
641 666
642=item B<backgroundPixmap:> I<file[;geom]> 667=item B<backgroundPixmap:> I<file[;geom]>
643 668
644Use the specified XPM file (note the `.xpm' extension is optional) for 669Use the specified image file for the background and also optionally
645the background and also optionally specify its scaling with a geometry 670specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 671in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 672and B<"X" / "Y"> locate the image centre (percent).
648centre (percent). A scale of 0 displays the image with tiling. A scale 673A 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 674image without any scaling. A scale of 2 to 9 specifies an integer
650specifies an integer number of images in that direction. No image will 675number of images in that direction. No image will be magnified beyond
651be magnified beyond 10 times its original size. The maximum permitted 67610 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 677Special string of B<"auto"> used as a geometry will cause image to be
678automatically scaled to match window size.
679If used in conjunction with B<-tr> option - specified pixmap will be
680blended over transparency image using either alpha-blending, or any
681other blending type, specified with B<-blt "type"> option.
682[default 0x0+50+50]
653 683
654=item B<path:> I<path> 684=item B<path:> I<path>
655 685
656Specify the colon-delimited search path for finding XPM files. 686Specify the colon-delimited search path for finding XPM files.
657 687
725option B<+is>) disables this behaviour, the high intensity colours are not 755option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 756reachable.
727 757
728=item B<selectstyle:> I<mode> 758=item B<selectstyle:> I<mode>
729 759
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is 760Set 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 761is xterm style with 2.20 old word selection, or anything else which
732xterm style selection. 762gives xterm style selection. Only effective when the original (non-perl)
763selection code is in use.
733 764
734=item B<scrollstyle:> I<mode> 765=item B<scrollstyle:> I<mode>
735 766
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 767Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite. 768the author's favourite.
750 781
751=item B<mapAlert:> I<boolean> 782=item B<mapAlert:> I<boolean>
752 783
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 784B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 785de-iconify (map) on receipt of a bell character [default].
786
787=item B<urgentOnBell:> I<boolean>
788
789B<True>: set the urgency hint for the wm on receipt of a bell character.
790B<False>: do not set the urgency hint [default].
755 791
756=item B<visualBell:> I<boolean> 792=item B<visualBell:> I<boolean>
757 793
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 794B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 795B<False>: no visual bell [default]; option B<+vb>.
916=item B<cutchars:> I<string> 952=item B<cutchars:> I<string>
917 953
918The characters used as delimiters for double-click word selection 954The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 955(whitespace delimiting is added automatically if resource is given).
920 956
921When the selection extension is in use (the default if compiled in, see 957When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 958in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 959characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 960will be created). In this mode, characters outside ISO-8859-1 can be used.
925 961
926When the selection extension is not used, only ISO-8859-1 characters can 962When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 963be used. If not specified, the built-in default is used:
928 964
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 965B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
988 1024
989Turn on/off secondary screen (default enabled). 1025Turn on/off secondary screen (default enabled).
990 1026
991=item B<secondaryScroll:> I<boolean> 1027=item B<secondaryScroll:> I<boolean>
992 1028
993Turn on/off secondary screen scroll (default enabled). If the this 1029Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1030option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1031scrollback buffer and switching to/from the secondary screen will
996instead scroll the screen up. 1032instead scroll the screen up.
997 1033
998=item B<hold>: I<boolean> 1034=item B<hold>: I<boolean>
1155(default: C<M-s>). 1191(default: C<M-s>).
1156 1192
1157=item B<urlLauncher>: I<string> 1193=item B<urlLauncher>: I<string>
1158 1194
1159Specifies the program to be started with a URL argument. Used by the 1195Specifies the program to be started with a URL argument. Used by the
1160C<selection-popup> and C<mark-urls> perl extensions. 1196C<selection-popup> and C<matcher> perl extensions.
1161 1197
1162=item B<transient-for>: I<windowid> 1198=item B<transient-for>: I<windowid>
1163 1199
1164Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1200Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1165 1201
1166=item B<override-redirect>: I<boolean> 1202=item B<override-redirect>: I<boolean>
1167 1203
1168Compile I<frills>: Sets override-redirect for the terminal window, making 1204Compile I<frills>: Sets override-redirect for the terminal window, making
1169it almost invisible to window managers; option B<-override-redirect>. 1205it almost invisible to window managers; option B<-override-redirect>.
1206
1207=item B<iso14755_52:> I<boolean>
1208
1209Turn on/off ISO 14755 5.2 mode (default enabled).
1170 1210
1171=back 1211=back
1172 1212
1173=head1 THE SCROLLBAR 1213=head1 THE SCROLLBAR
1174 1214
1193application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1233application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1194(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1234(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1195up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1235up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1196respectively. 1236respectively.
1197 1237
1198=head1 TEXT SELECTION AND INSERTION 1238=head1 THE SELECTION: SELECTING AND PASTING TEXT
1199 1239
1200The behaviour of text selection and insertion mechanism is similar to 1240The behaviour of text selection and insertion/pasting mechanism is similar
1201I<xterm>(1). 1241to I<xterm>(1).
1202 1242
1203=over 4 1243=over 4
1204 1244
1205=item B<Selection>: 1245=item B<Selecting>:
1206 1246
1207Left click at the beginning of the region, drag to the end of the region 1247Left click at the beginning of the region, drag to the end of the region
1208and release; Right click to extend the marked region; Left double-click 1248and release; Right click to extend the marked region; Left double-click
1209to select a word; Left triple-click to select the entire logical line 1249to select a word; Left triple-click to select the entire logical line
1210(which can span multiple screen lines), unless modified by resource 1250(which can span multiple screen lines), unless modified by resource
1214(Compile: I<frills>) will create a rectangular selection instead of a 1254(Compile: I<frills>) will create a rectangular selection instead of a
1215normal one. In this mode, every selected row becomes its own line in the 1255normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from 1256selection, and trailing whitespace is visually underlined and removed from
1217the selection. 1257the selection.
1218 1258
1219=item B<Insertion>: 1259=item B<Pasting>:
1220 1260
1221Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1261Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1222window causes the value of the PRIMARY selection (or CLIPBOARD with the 1262window causes the value of the PRIMARY selection (or CLIPBOARD with the
1223Meta modifier) to be inserted as if it had been typed on the keyboard. 1263B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1224 1264
1225Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1265Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1226inserted too. 1266inserted too.
1227 1267
1228=back 1268=back
1378If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1418If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1379their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1419their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1380(recommended, but B<MUST> have 4 digits/component) colour specifications, 1420(recommended, but B<MUST> have 4 digits/component) colour specifications,
1381in addition to the ones provided by X, where the additional A component 1421in addition to the ones provided by X, where the additional A component
1382specifies opacity (alpha) values. The minimum value of C<0> is completely 1422specifies opacity (alpha) values. The minimum value of C<0> is completely
1383transparent). You can also prefix any color with C<[a]>, where C<a> is on 1423transparent). You can also prefix any color with C<[percent]>, where
1384to four hex digits specifiying the opacity value. 1424C<percent> is a decimal percentage (0-100) that specifies the opacity of
1425the color, where C<0> is completely transparent and C<100> is completelxy
1426opaque.
1385 1427
1386You probably need to specify B<"-depth 32">, too, and have the luck that 1428You probably need to specify B<"-depth 32">, too, and have the luck that
1387your X-server uses ARGB pixel layout, as X is far from just supporting 1429your X-server uses ARGB pixel layout, as X is far from just supporting
1388ARGB visuals out of the box, and rxvt-unicode just fudges around. 1430ARGB visuals out of the box, and rxvt-unicode just fudges around.
1389 1431
1390For example, the following selects an almost completely transparent red 1432For example, the following selects an almost completely transparent red
1391background, and an almost opaque pink foreground: 1433background, and an almost opaque pink foreground:
1392 1434
1393 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1435 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1394 1436
1395I<Please note that transparency of any kind if completely unsupported by 1437I<Please note that transparency of any kind if completely unsupported by
1396the author. Don't bug him with installation questions!> 1438the author. Don't bug him with installation questions!>
1397 1439
1398=head1 ENVIRONMENT 1440=head1 ENVIRONMENT

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines