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.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC

93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions!>
114 122
115=item B<-fade> I<number> 123=item B<-fade> I<number>
116 124
117Fade the text by the given percentage when focus is lost. Small values 125Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 126fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 127colour; resource B<fading>.
120 128
121=item B<-fadecolor> I<colour> 129=item B<-fadecolor> I<colour>
122 130
123Fade to this colour when fading is used (see B<-fade>). The default colour 131Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 132is opaque black. resource B<fadeColor>.
125 133
126=item B<-tint> I<colour> 134=item B<-tint> I<colour>
127 135
128Tint the transparent background pixmap with the given colour when 136Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 137transparency is enabled with B<-tr> or B<-ip>. This only works for
172resource B<borderColor>. 180resource B<borderColor>.
173 181
174=item B<-fn> I<fontlist> 182=item B<-fn> I<fontlist>
175 183
176Select the fonts to be used. This is a comma separated list of font names 184Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 185that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 186first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 187smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 188font list is always appended to it. See resource B<font> for more details.
181 189
182In short, to specify an X11 core font, just specify it's name or prefix it 190In short, to specify an X11 core font, just specify it's name or prefix it
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 197See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 198section of @@RXVT_NAME@@(7).
191 199
192=item B<-fb> I<fontlist> 200=item B<-fb> I<fontlist>
193 201
194Compile font-styles: The bold font list to use when B<bold> characters are to 202Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 203are to be printed. See resource B<boldFont> for details.
196 204
197=item B<-fi> I<fontlist> 205=item B<-fi> I<fontlist>
198 206
199Compile font-styles: The italic font list to use when I<italic> characters are to 207Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 208characters are to be printed. See resource B<italicFont> for details.
201 209
202=item B<-fbi> I<fontlist> 210=item B<-fbi> I<fontlist>
203 211
204Compile font-styles: The bold italic font list to use when B<< I<bold 212Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205italic> >> characters are to be printed. See resource B<boldItalicFont> 213italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 214for details.
207 215
208=item B<-is>|B<+is> 216=item B<-is>|B<+is>
209 217
210Compile font-styles: Bold/Italic font styles imply high intensity 218Compile I<font-styles>: Bold/Italic font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 219foreground/background (default). See resource B<intensityStyles> for
212details. 220details.
213 221
214=item B<-name> I<name> 222=item B<-name> I<name>
215 223
296=item B<-bl> 304=item B<-bl>
297 305
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 306Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 307if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 308decorations; resource B<borderLess>.
309
310=item B<-override-redirect>
311
312Compile I<frills>: Sets override-redirect on the window; resource
313B<override-redirect>.
314
315=item B<-sbg>
316
317Compile I<frills>: Disable the usage of the built-in block graphics/line
318drawing characters and just rely on what the specified fonts provide. Use
319this if you have a good font and want to use its block graphic glyphs;
320resource B<skipBuiltinGlyphs>.
301 321
302=item B<-lsp> I<number> 322=item B<-lsp> I<number>
303 323
304Compile I<frills>: Lines (pixel height) to insert between each row of 324Compile I<frills>: Lines (pixel height) to insert between each row of
305the display. Useful to work around font rendering problems; resource 325the display. Useful to work around font rendering problems; resource
428 $rxvt->signal_connect_after (realize => sub { 448 $rxvt->signal_connect_after (realize => sub {
429 my $xid = $_[0]->window->get_xid; 449 my $xid = $_[0]->window->get_xid;
430 system "@@RXVT_NAME@@ -embed $xid &"; 450 system "@@RXVT_NAME@@ -embed $xid &";
431 }); 451 });
432 452
433=item B<-pty-fd> I<fileno> 453=item B<-pty-fd> I<file descriptor>
434 454
435Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
436pair but instead use the given filehandle as the tty master. This is 456pair but instead use the given filehandle as the tty master. This is
437useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 457useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
438without having to run a program within it. 458without having to run a program within it.
439 459
440If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
441entries and will not tinker with pty/tty permissions - you have to do that 461entries and will not tinker with pty/tty permissions - you have to do that
442yourself if you want that. 462yourself if you want that.
443 463
464As an extremely special case, specifying C<-1> will completely suppress
465pty/tty operations.
466
444Here is a example in perl that illustrates how this option can be used (a 467Here is a example in perl that illustrates how this option can be used (a
445longer example is in F<doc/pty-fd>): 468longer example is in F<doc/pty-fd>):
446 469
447 use IO::Pty; 470 use IO::Pty;
448 use Fcntl; 471 use Fcntl;
456 my $slave = $pty->slave; 479 my $slave = $pty->slave;
457 while (<$slave>) { print $slave "got <$_>\n" } 480 while (<$slave>) { print $slave "got <$_>\n" }
458 481
459=item B<-pe> I<string> 482=item B<-pe> I<string>
460 483
461Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>. 484Comma-separated list of perl extension scripts to use (or not to use) in
485this terminal instance. See resource B<perl-ext> for details.
462 486
463=back 487=back
464 488
465=head1 RESOURCES (available also as long-options) 489=head1 RESOURCES (available also as long-options)
466 490
467Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 491Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
468options) compiled into your version. 492options) compiled into your version.
469 493
470There are two different methods that @@RXVT_NAME@@ can use to get the 494You can set and change the resources using X11 tools like B<xrdb>. Many
471Xresource data: using the X libraries (Xrm*-functions) or internal 495distribution do also load settings from the B<~/.Xresources> file when X
472Xresources reader (B<~/.Xdefaults>). For the first method (ie. 496starts. @@RXVT_NAME@@ will consult the following files/resources in order,
473B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 497with later settings overwriting earlier ones:
474resources using X11 tools like B<xrdb>. Many distribution do also load
475settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
476will consult the following files/resources in order, with later settings
477overwriting earlier ones:
478 498
479 1. system-wide app-defaults file, either locale-dependent OR global 499 1. system-wide app-defaults file, either locale-dependent OR global
480 2. app-defaults file in $XAPPLRESDIR 500 2. app-defaults file in $XAPPLRESDIR
481 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 501 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
482 4. SCREEN_RESOURCES for the current screen 502 4. SCREEN_RESOURCES for the current screen
483 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 503 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
484 504
485If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
486lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
487set in XAPPLOADDIR/URxvt (compile-time defined: usually
488B</usr/lib/X11/app-defaults/URxvt>) and resources set in
489B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
490Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 505Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
491class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 506names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
492resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 507common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
493easily configured, while the class name B<URxvt> allows resources 508configured, while the class name B<URxvt> allows resources unique to
494unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 509B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
495shared between different B<@@RXVT_NAME@@> configurations. If no 510configurations. If no resources are specified, suitable defaults will
496resources are specified, suitable defaults will be used. Command-line 511be used. Command-line arguments can be used to override resource
497arguments can be used to override resource settings. The following 512settings. The following resources are supported (you might want to
498resources are allowed: 513check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
514extensions not documented here):
499 515
500=over 4 516=over 4
517
518=item B<depth:> I<bitdepth>
519
520Compile I<xft>: Attempt to find a visual with the given bit depth;
521option B<-depth>.
501 522
502=item B<geometry:> I<geom> 523=item B<geometry:> I<geom>
503 524
504Create the window with the specified X window geometry [default 80x24]; 525Create the window with the specified X window geometry [default 80x24];
505option B<-geometry>. 526option B<-geometry>.
578=item B<inheritPixmap:> I<boolean> 599=item B<inheritPixmap:> I<boolean>
579 600
580B<True>: make the background inherit the parent windows' pixmap, giving 601B<True>: make the background inherit the parent windows' pixmap, giving
581artificial transparency. B<False>: do not inherit the parent windows' 602artificial transparency. B<False>: do not inherit the parent windows'
582pixmap. 603pixmap.
604
605I<Please note that transparency of any kind if completely unsupported by
606the author. Don't bug him with installation questions!>
583 607
584=item B<fading:> I<number> 608=item B<fading:> I<number>
585 609
586Fade the text by the given percentage when focus is lost; option B<-fade>. 610Fade the text by the given percentage when focus is lost; option B<-fade>.
587 611
624of 1 displays the image without any scaling. A scale of 2 to 9 648of 1 displays the image without any scaling. A scale of 2 to 9
625specifies an integer number of images in that direction. No image will 649specifies an integer number of images in that direction. No image will
626be magnified beyond 10 times its original size. The maximum permitted 650be magnified beyond 10 times its original size. The maximum permitted
627scale is 1000. [default 0x0+50+50] 651scale is 1000. [default 0x0+50+50]
628 652
629=item B<menu:> I<file[;tag]>
630
631Read in the specified menu file (note the `.menu' extension is
632optional) and also optionally specify a starting tag to find. See the
633reference documentation for details on the syntax for the menuBar.
634
635=item B<path:> I<path> 653=item B<path:> I<path>
636 654
637Specify the colon-delimited search path for finding files (XPM and 655Specify the colon-delimited search path for finding XPM files.
638menus), in addition to the paths specified by the B<RXVTPATH> and
639B<PATH> environment variables.
640 656
641=item B<font:> I<fontlist> 657=item B<font:> I<fontlist>
642 658
643Select the fonts to be used. This is a comma separated list of font 659Select the fonts to be used. This is a comma separated list of font names
644names that are used in turn when trying to display Unicode characters. 660that are checked in order when trying to find glyphs for characters. The
645The first font defines the cell size for characters; other fonts might 661first font defines the cell size for characters; other fonts might be
646be smaller, but not larger. A reasonable default font list is always 662smaller, but not (in general) larger. A (hopefully) reasonable default
647appended to it; option B<-fn>. 663font list is always appended to it; option B<-fn>.
648 664
649Each font can either be a standard X11 core font (XLFD) name, with 665Each font can either be a standard X11 core font (XLFD) name, with
650optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 666optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
651 667
652In addition, each font can be prefixed with additional hints and 668In addition, each font can be prefixed with additional hints and
654hint currently is C<codeset=codeset-name>, and this is only used for Xft 670hint currently is C<codeset=codeset-name>, and this is only used for Xft
655fonts. 671fonts.
656 672
657For example, this font resource 673For example, this font resource
658 674
659 URxvt*font: 9x15bold,\ 675 URxvt.font: 9x15bold,\
660 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 676 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
661 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 677 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 678 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
663 xft:Code2000:antialias=false 679 xft:Code2000:antialias=false
664 680
761 777
762The string will be interpreted as if typed into the shell as-is. 778The string will be interpreted as if typed into the shell as-is.
763 779
764Example: 780Example:
765 781
766 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 783
768This creates a new file in your home directory with the screen contents 784This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>. 785everytime you hit C<Print>.
770 786
771=item B<scrollBar:> I<boolean> 787=item B<scrollBar:> I<boolean>
825=item B<borderLess:> I<boolean> 841=item B<borderLess:> I<boolean>
826 842
827Set MWM hints to request a borderless window, i.e. if honoured by the 843Set MWM hints to request a borderless window, i.e. if honoured by the
828WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 844WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
829 845
846=item B<skipBuiltinGlyphs:> I<boolean>
847
848Compile I<frills>: Disable the usage of the built-in block graphics/line
849drawing characters and just rely on what the specified fonts provide. Use
850this if you have a good font and want to use its block graphic glyphs;
851option B<-sbg>.
852
830=item B<termName:> I<termname> 853=item B<termName:> I<termname>
831 854
832Specifies the terminal type name to be set in the B<TERM> environment 855Specifies the terminal type name to be set in the B<TERM> environment
833variable; option B<-tn>. 856variable; option B<-tn>.
834 857
889pressed. If unset it will send the sequence traditionally associated 912pressed. If unset it will send the sequence traditionally associated
890with the B<Execute> key. 913with the B<Execute> key.
891 914
892=item B<cutchars:> I<string> 915=item B<cutchars:> I<string>
893 916
894The characters used as delimiters for double-click word selection. The 917The characters used as delimiters for double-click word selection
895built-in default: 918(whitespace delimiting is added automatically if resource is given).
919
920When the selection extension is in use (the default if compiled in, see
921the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
922will be created (if the resource exists, otherwise, no regex will be
923created). In this mode, characters outside ISO-8859-1 can be used.
924
925When the selection extension is not used, only ISO-8859-1 characters can
926be used. If not specified, the built-in default is used:
896 927
897B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
898 929
899=item B<preeditType:> I<style> 930=item B<preeditType:> I<style>
900 931
936default. (Note that many other terminals, including xterm, have these 967default. (Note that many other terminals, including xterm, have these
937sequences enabled by default, which doesn't make it safer, though). 968sequences enabled by default, which doesn't make it safer, though).
938 969
939You can enable them by setting this boolean resource or specifying 970You can enable them by setting this boolean resource or specifying
940B<-insecure> as an option. At the moment, this enables display-answer, 971B<-insecure> as an option. At the moment, this enables display-answer,
941locale, findfont, icon label and window title requests as well as dynamic 972locale, findfont, icon label and window title requests.
942menubar dispatch.
943 973
944=item B<modifier:> I<modifier> 974=item B<modifier:> I<modifier>
945 975
946Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 976Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
947B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 977B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
951 981
952Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 982Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
953character is passed through. It may contain escape values as described 983character is passed through. It may contain escape values as described
954in the entry on B<keysym> following. 984in the entry on B<keysym> following.
955 985
956=item B<secondaryScreen:> I<bool> 986=item B<secondaryScreen:> I<boolean>
957 987
958Turn on/off secondary screen (default enabled). 988Turn on/off secondary screen (default enabled).
959 989
960=item B<secondaryScroll:> I<bool> 990=item B<secondaryScroll:> I<boolean>
961 991
962Turn on/off secondary screen scroll (default enabled). If the this 992Turn on/off secondary screen scroll (default enabled). If the this
963option is enabled, scrolls on the secondary screen will change the 993option is enabled, scrolls on the secondary screen will change the
964scrollback buffer and switching to/from the secondary screen will 994scrollback buffer and switching to/from the secondary screen will
965instead scroll the screen up. 995instead scroll the screen up.
966 996
967=item B<hold>: I<bool> 997=item B<hold>: I<boolean>
968 998
969Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
970will not immediately destroy its window when the program executed within 1000will not immediately destroy its window when the program executed within
971it exits. Instead, it will wait till it is being killed or closed by the 1001it exits. Instead, it will wait till it is being killed or closed by the
972user. 1002user.
997C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1027C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
998C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1028C<\000>: octal number) or verbatim control characters (C<^?>: delete,
999C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1029C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1000can start or end with whitespace. 1030can start or end with whitespace.
1001 1031
1002Please note that you need to double the C<\> when using 1032Please note that you need to double the C<\> in resource files, as
1003C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1033Xlib itself does it's own de-escaping (you can use C<\033> instead of
1004use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1034C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1005@@RXVT_NAME@@'s own processing). 1035processing).
1006 1036
1007You can define a range of keysyms in one shot by providing a I<string> 1037You can define a range of keysyms in one shot by providing a I<string>
1008with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1009should be a character not used by the strings. 1039should be a character not used by the strings.
1010 1040
1062info): 1092info):
1063 1093
1064 URxvt.keysym.M-C-3: command:\033[8;25;80t 1094 URxvt.keysym.M-C-3: command:\033[8;25;80t
1065 URxvt.keysym.M-C-4: command:\033[8;48;110t 1095 URxvt.keysym.M-C-4: command:\033[8;48;110t
1066 1096
1097=item B<perl-ext-common>: I<string>
1098
1067=item B<perl-ext>: I<string> 1099=item B<perl-ext>: I<string>
1068 1100
1069Colon-separated list of perl extension scripts to use in this terminal 1101Comma-separated list(s) of perl extension scripts (default: C<default>) to
1102use in this terminal instance; option B<-pe>.
1103
1104Extension names can be prefixed with a C<-> sign to prohibit using
1105them. This can be useful to selectively disable some extensions loaded
1106by default, or specified via the C<perl-ext-common> resource. For
1107example, C<default,-selection> will use all the default extension except
1108C<selection>.
1109
1110Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to
1114the extension.
1115
1070instance. Each extension is looked up in the library directories, loaded 1116Each extension is looked up in the library directories, loaded if
1071if necessary, and bound to the current terminal instance. If this resource 1117necessary, and bound to the current terminal instance.
1072is empty or missing, then the perl interpreter will not be initialized; 1118
1073option B<-pe>. 1119If both of these resources are the empty string, then the perl
1120interpreter will not be initialized. The idea behind two options is that
1121B<perl-ext-common> will be used for extensions that should be available to
1122all instances, while B<perl-ext> is used for specific instances.
1074 1123
1075=item B<perl-eval>: I<string> 1124=item B<perl-eval>: I<string>
1076 1125
1077Perl code to be evaluated when all extensions have been registered. See the 1126Perl code to be evaluated when all extensions have been registered. See
1078@@RXVT_NAME@@perl(3) manpage. 1127the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1128will be ignored when running setuid/setgid.
1079 1129
1080=item B<perl-lib>: I<path> 1130=item B<perl-lib>: I<path>
1081 1131
1082Colon-separated list of additional directories that hold extension 1132Colon-separated list of additional directories that hold extension
1083scripts. When looking for extensions specified by the C<perl> resource, 1133scripts. When looking for extensions specified by the C<perl> resource,
1084@@RXVT_NAME@@ will first look in these directories and then in 1134@@RXVT_NAME@@ will first look in these directories and then in
1085F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1135F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1136will be ignored when running setuid/setgid.
1086 1137
1087See the @@RXVT_NAME@@perl(3) manpage. 1138See the @@RXVT_NAME@@perl(3) manpage.
1139
1140=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141
1142Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1143details.
1144
1145=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1146
1147Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1148for details.
1149
1150=item B<searchable-scrollback:> I<keysym>
1151
1152Sets the hotkey that starts the incremental scrollback buffer search
1153(default: C<M-s>).
1154
1155=item B<urlLauncher>: I<string>
1156
1157Specifies the program to be started with a URL argument. Used by the
1158C<selection-popup> and C<mark-urls> perl extensions.
1159
1160=item B<transient-for>: I<windowid>
1161
1162Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163
1164=item B<override-redirect>: I<boolean>
1165
1166Compile I<frills>: Sets override-redirect for the terminal window, making
1167it almost invisible to window managers; option B<-override-redirect>.
1088 1168
1089=back 1169=back
1090 1170
1091=head1 THE SCROLLBAR 1171=head1 THE SCROLLBAR
1092 1172
1134selection, and trailing whitespace is visually underlined and removed from 1214selection, and trailing whitespace is visually underlined and removed from
1135the selection. 1215the selection.
1136 1216
1137=item B<Insertion>: 1217=item B<Insertion>:
1138 1218
1139Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1140an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
1141inserted as if it had been typed on the keyboard. 1221Meta modifier) to be inserted as if it had been typed on the keyboard.
1222
1223Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224inserted too.
1142 1225
1143=back 1226=back
1144 1227
1145=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
1146 1229
1147Changing fonts (or font sizes, respectively) via the keypad is not yet 1230Changing fonts (or font sizes, respectively) via the keypad is not yet
1148supported in rxvt-unicode. Bug me if you need this. 1231supported in rxvt-unicode. Bug me if you need this.
1149 1232
1150You can, however, switch fonts at runtime using escape sequences (and 1233You can, however, switch fonts at runtime using escape sequences, e.g.:
1151therefore using the menubar), e.g.:
1152 1234
1153 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1235 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1236
1237You can use keyboard shortcuts, too:
1238
1239 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1240 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1154 1241
1155rxvt-unicode will automatically re-apply these fonts to the output so far. 1242rxvt-unicode will automatically re-apply these fonts to the output so far.
1156 1243
1157=head1 ISO 14755 SUPPORT 1244=head1 ISO 14755 SUPPORT
1158 1245
1229=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1230 1317
1231In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1232B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1319B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1233high-intensity bold/blink versions of the same). Here is a list of the 1320high-intensity bold/blink versions of the same). Here is a list of the
1234colours with their B<rgb.txt> names. 1321colours with their names.
1235 1322
1236=begin table 1323=begin table
1237 1324
1238 B<color0> (black) = Black 1325 B<color0> (black) = Black
1239 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
1273would yield White on Black, while on I<xterm>(1) it would yield Black 1360would yield White on Black, while on I<xterm>(1) it would yield Black
1274on White. 1361on White.
1275 1362
1276=back 1363=back
1277 1364
1365=head2 ALPHA CHANNEL SUPPORT
1366
1367If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1368their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1369(recommended, but B<MUST> have 4 digits/component) colour specifications,
1370in addition to the ones provided by X, where the additional A component
1371specifies opacity (alpha) values. The minimum value of C<0> is completely
1372transparent). You can also prefix any color with C<[a]>, where C<a> is on
1373to four hex digits specifiying the opacity value.
1374
1375You probably need to specify B<"-depth 32">, too, and have the luck that
1376your X-server uses ARGB pixel layout, as X is far from just supporting
1377ARGB visuals out of the box, and rxvt-unicode just fudges around.
1378
1379For example, the following selects an almost completely transparent red
1380background, and an almost opaque pink foreground:
1381
1382 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1383
1384I<Please note that transparency of any kind if completely unsupported by
1385the author. Don't bug him with installation questions!>
1386
1278=head1 ENVIRONMENT 1387=head1 ENVIRONMENT
1279 1388
1280B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1389B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1281 1390
1282=over 4 1391=over 4
1320 1429
1321=item B<SHELL> 1430=item B<SHELL>
1322 1431
1323The shell to be used for command execution, defaults to C</bin/sh>. 1432The shell to be used for command execution, defaults to C</bin/sh>.
1324 1433
1325=item B<RXVTPATH>
1326
1327The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1328files.
1329
1330=item B<PATH>
1331
1332Used in the same way as C<RXVTPATH>.
1333
1334=item B<RXVT_SOCKET> 1434=item B<RXVT_SOCKET>
1335 1435
1336The unix domain socket path used by @@RXVT_NAME@@c(1) and 1436The unix domain socket path used by @@RXVT_NAME@@c(1) and
1337@@RXVT_NAME@@d(1). 1437@@RXVT_NAME@@d(1).
1338 1438
1407 1507
1408Project Coordinator (changes.txt 2.21a to 2.4.5) 1508Project Coordinator (changes.txt 2.21a to 2.4.5)
1409 1509
1410=item Geoff Wing L<< <gcw@pobox.com> >> 1510=item Geoff Wing L<< <gcw@pobox.com> >>
1411 1511
1412Rewrote screen display and text selection routines. Project Coordinator 1512Rewrote screen display and text selection routines.
1513
1413(changes.txt 2.4.6 - rxvt-unicode) 1514Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1414 1515
1415=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1516=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1416 1517
1417Forked rxvt-unicode, rewrote most of the display code and internal 1518Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1418character handling to store text in unicode, improve xterm 1519extension, random hacks, numerous bugfixes and extensions.
1419compatibility and apply numerous other bugfixes and extensions.
1420 1520
1421Project Coordinator (Changes 1.0 -) 1521Project Coordinator (Changes 1.0 -)
1422 1522
1523=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1524
1525Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1526
1423=back 1527=back
1424 1528

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines