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.117 by root, Fri Jul 28 09:14:10 2006 UTC vs.
Revision 1.127 by ayin, Wed May 2 23:06:32 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
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
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
437The window will not be destroyed when @@RXVT_NAME@@ exits. 437The window will not be destroyed when @@RXVT_NAME@@ exits.
438 438
439It might be useful to know that @@RXVT_NAME@@ will not close file 439It might be useful to know that @@RXVT_NAME@@ will not close file
440descriptors passed to it (except for stdin/out/err, of course), so you 440descriptors passed to it (except for stdin/out/err, of course), so you
441can use file descriptors to communicate with the programs within the 441can use file descriptors to communicate with the programs within the
442terminal. This works regardless of wether the C<-embed> option was used or 442terminal. This works regardless of whether the C<-embed> option was used or
443not. 443not.
444 444
445Here is a short Gtk2-perl snippet that illustrates how this option can be 445Here is a short Gtk2-perl snippet that illustrates how this option can be
446used (a longer example is in F<doc/embed>): 446used (a longer example is in F<doc/embed>):
447 447
452 }); 452 });
453 453
454=item B<-pty-fd> I<file descriptor> 454=item B<-pty-fd> I<file descriptor>
455 455
456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
457pair but instead use the given filehandle as the tty master. This is 457pair 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 458useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
459without having to run a program within it. 459without having to run a program within it.
460 460
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 461If 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 462entries and will not tinker with pty/tty permissions - you have to do that
564Use the specified colour to display underlined characters when the 564Use the specified colour to display underlined characters when the
565foreground colour is the default. 565foreground colour is the default.
566 566
567=item B<colorRV:> I<colour> 567=item B<colorRV:> I<colour>
568 568
569Use the specified colour as the background for reverse video 569Use the specified colour as the background for reverse video characters
570characters. 570when OPTION_HC is disabled (--disable-frills).
571 571
572=item B<underlineColor:> I<colour> 572=item B<underlineColor:> I<colour>
573 573
574If set, use the specified colour as the colour for the underline 574If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 575itself. If unset, use the foreground colour.
620Tint the transparent background pixmap with the given colour; option 620Tint the transparent background pixmap with the given colour; option
621B<-tint>. 621B<-tint>.
622 622
623=item B<shading:> I<number> 623=item B<shading:> I<number>
624 624
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626image in addition to tinting it. 626in addition to tinting it; option B<-sh>.
627 627
628=item B<scrollColor:> I<colour> 628=item B<scrollColor:> I<colour>
629 629
630Use the specified colour for the scrollbar [default #B2B2B2]. 630Use the specified colour for the scrollbar [default #B2B2B2].
631 631
719 719
720=item B<intensityStyles:> I<boolean> 720=item B<intensityStyles:> I<boolean>
721 721
722When font styles are not enabled, or this option is enabled (B<True>, 722When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 723option B<-is>, the default), bold and italic font styles imply high
724intensity foreground/backround colours. Disabling this option (B<False>, 724intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 725option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 726reachable.
727 727
728=item B<selectstyle:> I<mode> 728=item B<selectstyle:> I<mode>
729 729
751=item B<mapAlert:> I<boolean> 751=item B<mapAlert:> I<boolean>
752 752
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 754de-iconify (map) on receipt of a bell character [default].
755 755
756=item B<urgentOnBell:> I<boolean>
757
758B<True>: set the urgency hint for the wm on receipt of a bell character.
759B<False>: do not set the urgency hint [default].
760
756=item B<visualBell:> I<boolean> 761=item B<visualBell:> I<boolean>
757 762
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 763B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 764B<False>: no visual bell [default]; option B<+vb>.
760 765
781Example: 786Example:
782 787
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 788 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 789
785This creates a new file in your home directory with the screen contents 790This creates a new file in your home directory with the screen contents
786everytime you hit C<Print>. 791every time you hit C<Print>.
787 792
788=item B<scrollBar:> I<boolean> 793=item B<scrollBar:> I<boolean>
789 794
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 795B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 796disable the scrollbar; option B<+sb>.
813 818
814=item B<scrollWithBuffer:> I<boolean> 819=item B<scrollWithBuffer:> I<boolean>
815 820
816B<True>: scroll with scrollback buffer when tty receives new lines (and 821B<True>: scroll with scrollback buffer when tty receives new lines (and
817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 822B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
818with scrollback buffer when tty recieves new lines; option B<+sw>. 823with scrollback buffer when tty receives new lines; option B<+sw>.
819 824
820=item B<scrollTtyKeypress:> I<boolean> 825=item B<scrollTtyKeypress:> I<boolean>
821 826
822B<True>: scroll to bottom when a non-special key is pressed. Special keys 827B<True>: scroll to bottom when a non-special key is pressed. Special keys
823are those which are intercepted by rxvt-unicode for special handling and 828are those which are intercepted by rxvt-unicode for special handling and
988 993
989Turn on/off secondary screen (default enabled). 994Turn on/off secondary screen (default enabled).
990 995
991=item B<secondaryScroll:> I<boolean> 996=item B<secondaryScroll:> I<boolean>
992 997
993Turn on/off secondary screen scroll (default enabled). If the this 998Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 999option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1000scrollback buffer and switching to/from the secondary screen will
996instead scroll the screen up. 1001instead scroll the screen up.
997 1002
998=item B<hold>: I<boolean> 1003=item B<hold>: I<boolean>
1026 1031
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1032I<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, 1033C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1034C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1035C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031can start or end with whitespace. 1036can start or end with whitespace. B<This feature is deprecated and will
1037be removed>.
1032 1038
1033Please note that you need to double the C<\> in resource files, as 1039Please 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 1040Xlib 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 1041C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1036processing). 1042processing).
1037 1043
1038You can define a range of keysyms in one shot by providing a I<string> 1044You can define a range of keysyms in one shot by providing a I<string>
1039with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1045with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040should be a character not used by the strings. 1046should be a character not used by the strings.
1041 1047
1042Its usage can be demonstrated by an example: 1048Its usage can be demonstrated by an example:
1043 1049
1044 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1050 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1108example, C<default,-selection> will use all the default extension except 1114example, C<default,-selection> will use all the default extension except
1109C<selection>. 1115C<selection>.
1110 1116
1111Extension names can also be followed by an argument in angle brackets 1117Extension names can also be followed by an argument in angle brackets
1112(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1118(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1113searchable scorllback to Alt/Meta-s). Mentioning the same extension 1119searchable scrollback to Alt/Meta-s). Mentioning the same extension
1114multiple times with different arguments will pass multiple arguments to 1120multiple times with different arguments will pass multiple arguments to
1115the extension. 1121the extension.
1116 1122
1117Each extension is looked up in the library directories, loaded if 1123Each extension is looked up in the library directories, loaded if
1118necessary, and bound to the current terminal instance. 1124necessary, and bound to the current terminal instance.
1154(default: C<M-s>). 1160(default: C<M-s>).
1155 1161
1156=item B<urlLauncher>: I<string> 1162=item B<urlLauncher>: I<string>
1157 1163
1158Specifies the program to be started with a URL argument. Used by the 1164Specifies the program to be started with a URL argument. Used by the
1159C<selection-popup> and C<mark-urls> perl extensions. 1165C<selection-popup> and C<matcher> perl extensions.
1160 1166
1161=item B<transient-for>: I<windowid> 1167=item B<transient-for>: I<windowid>
1162 1168
1163Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1169Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164 1170
1377If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1383If 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> 1384their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1379(recommended, but B<MUST> have 4 digits/component) colour specifications, 1385(recommended, but B<MUST> have 4 digits/component) colour specifications,
1380in addition to the ones provided by X, where the additional A component 1386in addition to the ones provided by X, where the additional A component
1381specifies opacity (alpha) values. The minimum value of C<0> is completely 1387specifies 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 1388transparent). You can also prefix any color with C<[percent]>, where
1383to four hex digits specifiying the opacity value. 1389C<percent> is a decimal percentage (0-100) that specifies the opacity of
1390the color, where C<0> is completely transparent and C<100> is completelxy
1391opaque.
1384 1392
1385You probably need to specify B<"-depth 32">, too, and have the luck that 1393You 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 1394your 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. 1395ARGB visuals out of the box, and rxvt-unicode just fudges around.
1388 1396
1389For example, the following selects an almost completely transparent red 1397For example, the following selects an almost completely transparent red
1390background, and an almost opaque pink foreground: 1398background, and an almost opaque pink foreground:
1391 1399
1392 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1400 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1393 1401
1394I<Please note that transparency of any kind if completely unsupported by 1402I<Please note that transparency of any kind if completely unsupported by
1395the author. Don't bug him with installation questions!> 1403the author. Don't bug him with installation questions!>
1396 1404
1397=head1 ENVIRONMENT 1405=head1 ENVIRONMENT
1401=over 4 1409=over 4
1402 1410
1403=item B<TERM> 1411=item B<TERM>
1404 1412
1405Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1413Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1406resources or on the commandline. 1414resources or on the command line.
1407 1415
1408=item B<COLORTERM> 1416=item B<COLORTERM>
1409 1417
1410Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1418Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411compiled with XPM support, and optionally with the added extension 1419compiled with XPM support, and optionally with the added extension
1412C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1420C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1413 1421
1414=item B<COLORFGBG> 1422=item B<COLORFGBG>
1415 1423

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines