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.118 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.129 by root, Mon May 28 20:34:56 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
144 144
145=item B<-sh> 145=item B<-sh>
146 146
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147I<number> Darken (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 tinting it (i.e. B<-tint> must be
149specified, too, e.g. C<-tint white>). 149specified, too, e.g. C<-tint white>); resource I<shading>.
150 150
151=item B<-bg> I<colour> 151=item B<-bg> I<colour>
152 152
153Window background colour; resource B<background>. 153Window background colour; resource B<background>.
154 154
386for more info. 386for more info.
387 387
388=item B<-tcw> 388=item B<-tcw>
389 389
390Change the meaning of triple-click selection with the left mouse 390Change the meaning of triple-click selection with the left mouse
391button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 392in-use. Instead of selecting a full line it will extend the selection the
392end of the logical line only. resource B<tripleclickwords>. 393end of the logical line only. resource B<tripleclickwords>.
393 394
394=item B<-insecure> 395=item B<-insecure>
395 396
396Enable "insecure" mode, which currently enables most of the escape 397Enable "insecure" mode, which currently enables most of the escape
452 }); 453 });
453 454
454=item B<-pty-fd> I<file descriptor> 455=item B<-pty-fd> I<file descriptor>
455 456
456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 457Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
457pair but instead use the given file handle as the tty master. This is 458pair but instead use the given file descriptor as the tty master. This is
458useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 459useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
459without having to run a program within it. 460without having to run a program within it.
460 461
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 462If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462entries and will not tinker with pty/tty permissions - you have to do that 463entries and will not tinker with pty/tty permissions - you have to do that
564Use the specified colour to display underlined characters when the 565Use the specified colour to display underlined characters when the
565foreground colour is the default. 566foreground colour is the default.
566 567
567=item B<colorRV:> I<colour> 568=item B<colorRV:> I<colour>
568 569
569Use the specified colour as the background for reverse video 570Use the specified colour as the background for reverse video characters
570characters. 571when OPTION_HC is disabled (--disable-frills).
571 572
572=item B<underlineColor:> I<colour> 573=item B<underlineColor:> I<colour>
573 574
574If set, use the specified colour as the colour for the underline 575If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 576itself. If unset, use the foreground colour.
620Tint the transparent background pixmap with the given colour; option 621Tint the transparent background pixmap with the given colour; option
621B<-tint>. 622B<-tint>.
622 623
623=item B<shading:> I<number> 624=item B<shading:> I<number>
624 625
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 626Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626image in addition to tinting it. 627in addition to tinting it; option B<-sh>.
627 628
628=item B<scrollColor:> I<colour> 629=item B<scrollColor:> I<colour>
629 630
630Use the specified colour for the scrollbar [default #B2B2B2]. 631Use the specified colour for the scrollbar [default #B2B2B2].
631 632
725option B<+is>) disables this behaviour, the high intensity colours are not 726option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 727reachable.
727 728
728=item B<selectstyle:> I<mode> 729=item B<selectstyle:> I<mode>
729 730
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is 731Set 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 732is xterm style with 2.20 old word selection, or anything else which
732xterm style selection. 733gives xterm style selection. Only effective when the original (non-perl)
734selection code is in use.
733 735
734=item B<scrollstyle:> I<mode> 736=item B<scrollstyle:> I<mode>
735 737
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 738Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite. 739the author's favourite.
750 752
751=item B<mapAlert:> I<boolean> 753=item B<mapAlert:> I<boolean>
752 754
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 755B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 756de-iconify (map) on receipt of a bell character [default].
757
758=item B<urgentOnBell:> I<boolean>
759
760B<True>: set the urgency hint for the wm on receipt of a bell character.
761B<False>: do not set the urgency hint [default].
755 762
756=item B<visualBell:> I<boolean> 763=item B<visualBell:> I<boolean>
757 764
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 765B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 766B<False>: no visual bell [default]; option B<+vb>.
916=item B<cutchars:> I<string> 923=item B<cutchars:> I<string>
917 924
918The characters used as delimiters for double-click word selection 925The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 926(whitespace delimiting is added automatically if resource is given).
920 927
921When the selection extension is in use (the default if compiled in, see 928When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 929in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 930characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 931will be created). In this mode, characters outside ISO-8859-1 can be used.
925 932
926When the selection extension is not used, only ISO-8859-1 characters can 933When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 934be used. If not specified, the built-in default is used:
928 935
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 936B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
988 995
989Turn on/off secondary screen (default enabled). 996Turn on/off secondary screen (default enabled).
990 997
991=item B<secondaryScroll:> I<boolean> 998=item B<secondaryScroll:> I<boolean>
992 999
993Turn on/off secondary screen scroll (default enabled). If the this 1000Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1001option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1002scrollback buffer and switching to/from the secondary screen will
996instead scroll the screen up. 1003instead scroll the screen up.
997 1004
998=item B<hold>: I<boolean> 1005=item B<hold>: I<boolean>
1026 1033
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1034I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1035C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1036C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1037C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031can start or end with whitespace. 1038can start or end with whitespace. B<This feature is deprecated and will
1039be removed>.
1032 1040
1033Please note that you need to double the C<\> in resource files, as 1041Please note that you need to double the C<\> in resource files, as
1034Xlib itself does its own de-escaping (you can use C<\033> instead of 1042Xlib itself does its own de-escaping (you can use C<\033> instead of
1035C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1043C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1036processing). 1044processing).
1154(default: C<M-s>). 1162(default: C<M-s>).
1155 1163
1156=item B<urlLauncher>: I<string> 1164=item B<urlLauncher>: I<string>
1157 1165
1158Specifies the program to be started with a URL argument. Used by the 1166Specifies the program to be started with a URL argument. Used by the
1159C<selection-popup> and C<mark-urls> perl extensions. 1167C<selection-popup> and C<matcher> perl extensions.
1160 1168
1161=item B<transient-for>: I<windowid> 1169=item B<transient-for>: I<windowid>
1162 1170
1163Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1171Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164 1172
1192application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1200application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1201(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1194up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1202up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195respectively. 1203respectively.
1196 1204
1197=head1 TEXT SELECTION AND INSERTION 1205=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198 1206
1199The behaviour of text selection and insertion mechanism is similar to 1207The behaviour of text selection and insertion/pasting mechanism is similar
1200I<xterm>(1). 1208to I<xterm>(1).
1201 1209
1202=over 4 1210=over 4
1203 1211
1204=item B<Selection>: 1212=item B<Selecting>:
1205 1213
1206Left click at the beginning of the region, drag to the end of the region 1214Left click at the beginning of the region, drag to the end of the region
1207and release; Right click to extend the marked region; Left double-click 1215and release; Right click to extend the marked region; Left double-click
1208to select a word; Left triple-click to select the entire logical line 1216to select a word; Left triple-click to select the entire logical line
1209(which can span multiple screen lines), unless modified by resource 1217(which can span multiple screen lines), unless modified by resource
1213(Compile: I<frills>) will create a rectangular selection instead of a 1221(Compile: I<frills>) will create a rectangular selection instead of a
1214normal one. In this mode, every selected row becomes its own line in the 1222normal one. In this mode, every selected row becomes its own line in the
1215selection, and trailing whitespace is visually underlined and removed from 1223selection, and trailing whitespace is visually underlined and removed from
1216the selection. 1224the selection.
1217 1225
1218=item B<Insertion>: 1226=item B<Pasting>:
1219 1227
1220Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1228Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1221window causes the value of the PRIMARY selection (or CLIPBOARD with the 1229window causes the value of the PRIMARY selection (or CLIPBOARD with the
1222Meta modifier) to be inserted as if it had been typed on the keyboard. 1230B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223 1231
1224Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1232Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225inserted too. 1233inserted too.
1226 1234
1227=back 1235=back
1377If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1385If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1386their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1379(recommended, but B<MUST> have 4 digits/component) colour specifications, 1387(recommended, but B<MUST> have 4 digits/component) colour specifications,
1380in addition to the ones provided by X, where the additional A component 1388in addition to the ones provided by X, where the additional A component
1381specifies opacity (alpha) values. The minimum value of C<0> is completely 1389specifies opacity (alpha) values. The minimum value of C<0> is completely
1382transparent). You can also prefix any color with C<[a]>, where C<a> is on 1390transparent). You can also prefix any color with C<[percent]>, where
1383to four hex digits specifiying the opacity value. 1391C<percent> is a decimal percentage (0-100) that specifies the opacity of
1392the color, where C<0> is completely transparent and C<100> is completelxy
1393opaque.
1384 1394
1385You probably need to specify B<"-depth 32">, too, and have the luck that 1395You probably need to specify B<"-depth 32">, too, and have the luck that
1386your X-server uses ARGB pixel layout, as X is far from just supporting 1396your X-server uses ARGB pixel layout, as X is far from just supporting
1387ARGB visuals out of the box, and rxvt-unicode just fudges around. 1397ARGB visuals out of the box, and rxvt-unicode just fudges around.
1388 1398
1389For example, the following selects an almost completely transparent red 1399For example, the following selects an almost completely transparent red
1390background, and an almost opaque pink foreground: 1400background, and an almost opaque pink foreground:
1391 1401
1392 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1402 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1393 1403
1394I<Please note that transparency of any kind if completely unsupported by 1404I<Please note that transparency of any kind if completely unsupported by
1395the author. Don't bug him with installation questions!> 1405the author. Don't bug him with installation questions!>
1396 1406
1397=head1 ENVIRONMENT 1407=head1 ENVIRONMENT

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines