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.190 by sf-exg, Thu Dec 9 10:03:56 2010 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC

84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
85Orange'. 85Orange'.
86 86
87The following options are available: 87The following options are available:
88 88
89=over 4 89=over
90 90
91=item B<-help>, B<--help> 91=item B<-help>, B<--help>
92 92
93Print out a message describing available options. 93Print out a message describing available options.
94 94
98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
116
111=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
112 118
113Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
114 120
115=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
122 128
123=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
124 130
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126 132
127=item B<-tr>|B<+tr> 133=item B<-fps> I<number>
128 134
129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>. 135Compile I<frills>: Set the refresh interval (in frames per second or
130 136negative seconds); resource B<refreshRate>.
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133 137
134=item B<-fade> I<number> 138=item B<-fade> I<number>
135 139
136Fade the text by the given percentage when focus is lost. Small values 140Fade the text by the given percentage when focus is lost. Small values
137fade a little only, 100 completely replaces all colours by the fade 141fade a little only, 100 completely replaces all colours by the fade
140=item B<-fadecolor> I<colour> 144=item B<-fadecolor> I<colour>
141 145
142Fade to this colour when fading is used (see B<-fade>). The default colour 146Fade to this colour when fading is used (see B<-fade>). The default colour
143is opaque black. resource B<fadeColor>. 147is opaque black. resource B<fadeColor>.
144 148
145=item B<-tint> I<colour>
146
147Tint the transparent background with the given colour;
148resource I<tintColor>.
149
150=item B<-sh> I<number>
151
152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153A value of 100 means no shading; resource 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
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour 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. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128;
172resource I<blurRadius>.
173
174=item B<-icon> I<file> 149=item B<-icon> I<file>
175 150
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 151Compile I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the 152is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>. 153application window; resource I<iconFile>.
179 154
180=item B<-bg> I<colour> 155=item B<-bg> I<colour>
181 156
182Window background colour; resource B<background>. 157Window background colour; resource B<background>.
183 158
184=item B<-fg> I<colour> 159=item B<-fg> I<colour>
185 160
186Window foreground colour; resource B<foreground>. 161Window foreground colour; resource B<foreground>.
187
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
189
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191optionally specify its scaling with a geometry string. Note you may need to
192add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>.
194 162
195=item B<-cr> I<colour> 163=item B<-cr> I<colour>
196 164
197The cursor colour; resource B<cursorColor>. 165The cursor colour; resource B<cursorColor>.
198 166
257 225
258=item B<-ls>|B<+ls> 226=item B<-ls>|B<+ls>
259 227
260Start as a login-shell/sub-shell; resource B<loginShell>. 228Start as a login-shell/sub-shell; resource B<loginShell>.
261 229
230=item B<-mc> I<milliseconds>
231
232Specify the maximum time between multi-click selections.
233
262=item B<-ut>|B<+ut> 234=item B<-ut>|B<+ut>
263 235
264Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 236Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
265B<utmpInhibit>. 237B<utmpInhibit>.
266 238
344 316
345=item B<-override-redirect> 317=item B<-override-redirect>
346 318
347Compile I<frills>: Sets override-redirect on the window; resource 319Compile I<frills>: Sets override-redirect on the window; resource
348B<override-redirect>. 320B<override-redirect>.
321
322=item B<-dockapp>
323
324Sets the initial state of the window to WithdrawnState, which makes
325window managers that support this extension treat it as a dockapp.
349 326
350=item B<-sbg> 327=item B<-sbg>
351 328
352Compile I<frills>: Disable the usage of the built-in block graphics/line 329Compile I<frills>: Disable the usage of the built-in block graphics/line
353drawing characters and just rely on what the specified fonts provide. Use 330drawing characters and just rely on what the specified fonts provide. Use
408=item B<-pt> I<style> 385=item B<-pt> I<style>
409 386
410Compile I<XIM>: input style for input method; B<OverTheSpot>, 387Compile I<XIM>: input style for input method; B<OverTheSpot>,
411B<OffTheSpot>, B<Root>; resource B<preeditType>. 388B<OffTheSpot>, B<Root>; resource B<preeditType>.
412 389
390If the perl extension C<xim-onthespot> is used (which is the default),
391then additionally the C<OnTheSpot> preedit type is available.
392
413=item B<-im> I<text> 393=item B<-im> I<text>
414 394
415Compile I<XIM>: input method name. resource B<inputMethod>. 395Compile I<XIM>: input method name. resource B<inputMethod>.
416 396
417=item B<-imlocale> I<string> 397=item B<-imlocale> I<string>
431Change the meaning of triple-click selection with the left mouse 411Change the meaning of triple-click selection with the left mouse
432button. Only effective when the original (non-perl) selection code is 412button. Only effective when the original (non-perl) selection code is
433in-use. Instead of selecting a full line it will extend the selection to 413in-use. Instead of selecting a full line it will extend the selection to
434the end of the logical line only. resource B<tripleclickwords>. 414the end of the logical line only. resource B<tripleclickwords>.
435 415
416=item B<-dpb>|B<+dpb>
417
418Compile frills: Disable (or enable) emitting bracketed paste mode
419sequences (default enabled). Bracketed paste mode allows programs
420to detect when something is pasted. Since more and more programs
421abuse this, these sequences can be disabled. The command sequences to
422enable and query paste mode will still work, but the actual bracket
423sequences will no longer be emitted. You can also toggle this from the
424ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
425
436=item B<-insecure> 426=item B<-insecure>
437 427
438Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
439sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
440info. 430info.
452 442
453=item B<-ssr>|B<+ssr> 443=item B<-ssr>|B<+ssr>
454 444
455Turn on/off secondary screen scroll (default enabled); resource 445Turn on/off secondary screen scroll (default enabled); resource
456B<secondaryScroll>. 446B<secondaryScroll>.
447
448=item B<-rm> I<mode>
449
450Compile I<frills>: Sets long line rewrapping behaviour on window resizes
451to one of B<auto> (the default), B<always> or B<never>. The latter two
452modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
453is non-empty, and wings lines (acts like B<never>) otherwise; resource
454B<rewrapMode>.
457 455
458=item B<-hold>|B<+hold> 456=item B<-hold>|B<+hold>
459 457
460Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 458Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
461will not immediately destroy its window when the program executed within 459will not immediately destroy its window when the program executed within
540 538
541 # now communicate with rxvt 539 # now communicate with rxvt
542 my $slave = $pty->slave; 540 my $slave = $pty->slave;
543 while (<$slave>) { print $slave "got <$_>\n" } 541 while (<$slave>) { print $slave "got <$_>\n" }
544 542
543Note that, despite what the name might imply, the file descriptor does not
544need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
545domain or tcp socket). While tty operations cannot be done in this case,
546B<@@RXVT_NAME@@> can still be remote controlled with it:
547
548 use Socket;
549 use Fcntl;
550
551 socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
552 fcntl $slave, Fcntl::F_SETFD, 0;
553 system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
554 close $slave;
555
556 syswrite $URXVT, "Type a secret password: ";
557 my $secret = do { local $/ = "\r"; <$URXVT> };
558 print "Not so secret anymore: $secret\n";
559
545=item B<-pe> I<string> 560=item B<-pe> I<string>
546 561
547Comma-separated list of perl extension scripts to use (or not to use) in 562Comma-separated list of perl extension scripts to use (or not to use) in
548this terminal instance. See resource B<perl-ext> for details. 563this terminal instance. See resource B<perl-ext> for details.
549 564
558You can set and change the resources using X11 tools like B<xrdb>. Many 573You can set and change the resources using X11 tools like B<xrdb>. Many
559distribution do also load settings from the B<~/.Xresources> file when X 574distribution do also load settings from the B<~/.Xresources> file when X
560starts. @@RXVT_NAME@@ will consult the following files/resources in order, 575starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561with later settings overwriting earlier ones: 576with later settings overwriting earlier ones:
562 577
563 1. system-wide app-defaults file, either locale-dependent OR global
564 2. app-defaults file in $XAPPLRESDIR 578 1. app-defaults file in $XAPPLRESDIR
579 2. $HOME/.Xdefaults
565 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 580 3. RESOURCE_MANAGER property on root-window of screen 0
566 4. SCREEN_RESOURCES for the current screen 581 4. SCREEN_RESOURCES property on root-window of the current screen
567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 582 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568 6. resources specified via -xrm on the commandline 583 6. resources specified via -xrm on the commandline
569 584
570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 585Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 586names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
576be used. Command-line arguments can be used to override resource 591be used. Command-line arguments can be used to override resource
577settings. The following resources are supported (you might want to 592settings. The following resources are supported (you might want to
578check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 593check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
579extensions not documented here): 594extensions not documented here):
580 595
581=over 4 596=over
582 597
583=item B<depth:> I<bitdepth> 598=item B<depth:> I<bitdepth>
584 599
585Compile I<xft>: Attempt to find a visual with the given bit depth; 600Compile I<xft>: Attempt to find a visual with the given bit depth;
586option B<-depth>. 601option B<-depth>.
687 702
688B<False>: specify that everything is to be displayed, even 703B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the 704if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>. 705monitor to display anything); option B<+ss>.
691 706
692=item B<transparent:> I<boolean> 707=item B<refreshRate:> I<number>
693 708
694Turn on/off pseudo-transparency by using the root pixmap as background. 709Compile I<frills>: When positive, sets the maximum refreshes per second
695 710(the default is C<60>). When zero or negative, sets the minimum interval
696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 711between refreshes, negated. That is, positive numbers limit the number
697future versions. 712of refreshes per second to that number, similar to a fps limiter in
713games. Zero or negative numbers get negated and directly set the minimum
714interval between refreshs, that is, C<10> and C<-0.1> both specify the
715same refresh interval (likewise C<50> and C<0.02>). Fractional values are
716supported; option B<-fps>.
698 717
699=item B<fading:> I<number> 718=item B<fading:> I<number>
700 719
701Fade the text by the given percentage when focus is lost; option B<-fade>. 720Fade the text by the given percentage when focus is lost; option B<-fade>.
702 721
703=item B<fadeColor:> I<colour> 722=item B<fadeColor:> I<colour>
704 723
705Fade to this colour, when fading is used (see B<fading:>). The default 724Fade to this colour, when fading is used (see B<fading:>). The default
706colour is black; option B<-fadecolor>. 725colour is black; option B<-fadecolor>.
707 726
708=item B<tintColor:> I<colour>
709
710Tint the transparent background with the given colour. If the RENDER
711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
715
716=item B<shading:> I<number>
717
718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
719A value of 100 means no shading; option B<-sh>.
720
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number>
726
727Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>.
729
730=item B<iconFile:> I<file> 727=item B<iconFile:> I<file>
731 728
732Set the application icon pixmap; option B<-icon>. 729Set the application icon pixmap; option B<-icon>.
733 730
734=item B<scrollColor:> I<colour> 731=item B<scrollColor:> I<colour>
742 739
743=item B<borderColor:> I<colour> 740=item B<borderColor:> I<colour>
744 741
745The colour of the border around the text area and between the scrollbar 742The colour of the border around the text area and between the scrollbar
746and the text. 743and the text.
747
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
749
750Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>,
752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
754centre (percent). A scale of 0 displays the image with tiling.
755The maximum permitted scale is 1000.
756Additional operations can be specified after colon B<:op1:op2...>.
757Supported operations are:
758
759 tile force background image to be tiled and not scaled. Equivalent to 0x0
760 propscale will scale image keeping proportions
761 auto will scale image to match window size. Equivalent to 100x100
762 hscale will scale image horizontally to the window size
763 vscale will scale image vertically to the window size
764 scale will scale image to match window size
765 root will tile image as if it was a root window background, auto-adjusting
766 whenever terminal window moves
767
768If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
772
773=item B<path:> I<path>
774
775Specify the colon-delimited search path for finding background image files.
776 744
777=item B<font:> I<fontlist> 745=item B<font:> I<fontlist>
778 746
779Select the fonts to be used. This is a comma separated list of font names 747Select the fonts to be used. This is a comma separated list of font names
780that are checked in order when trying to find glyphs for characters. The 748that are checked in order when trying to find glyphs for characters. The
877 845
878B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 846B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
879the shell; option B<-ls>. B<False>: start as a normal sub-shell 847the shell; option B<-ls>. B<False>: start as a normal sub-shell
880[default]; option B<+ls>. 848[default]; option B<+ls>.
881 849
850=item B<multiClickTime:> I<number>
851
852Specify the maximum time in milliseconds between multi-click select
853events. The default is 500 milliseconds; option B<-mc>.
854
882=item B<utmpInhibit:> I<boolean> 855=item B<utmpInhibit:> I<boolean>
883 856
884B<True>: inhibit writing record into the system log file B<utmp>; 857B<True>: inhibit writing record into the system log file B<utmp>;
885option B<-ut>. B<False>: write record into the system log file B<utmp> 858option B<-ut>. B<False>: write record into the system log file B<utmp>
886[default]; option B<+ut>. 859[default]; option B<+ut>.
903=item B<scrollstyle:> I<mode> 876=item B<scrollstyle:> I<mode>
904 877
905Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 878Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
906the author's favourite. 879the author's favourite.
907 880
881=item B<thickness:> I<number>
882
883Set the scrollbar width in pixels.
884
908=item B<scrollBar:> I<boolean> 885=item B<scrollBar:> I<boolean>
909 886
910B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 887B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
911disable the scrollbar; option B<+sb>. 888disable the scrollbar; option B<+sb>.
912 889
931B<False>: do not scroll to bottom when tty receives output; option 908B<False>: do not scroll to bottom when tty receives output; option
932B<+si>. 909B<+si>.
933 910
934=item B<scrollWithBuffer:> I<boolean> 911=item B<scrollWithBuffer:> I<boolean>
935 912
936B<True>: scroll with scrollback buffer when tty receives new lines (and 913B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
937B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 914try to show the same lines) and B<scrollTtyOutput> is False; option
938with scrollback buffer when tty receives new lines; option B<+sw>. 915B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
916new lines; option B<+sw>.
939 917
940=item B<scrollTtyKeypress:> I<boolean> 918=item B<scrollTtyKeypress:> I<boolean>
941 919
942B<True>: scroll to bottom when a non-special key is pressed. Special keys 920B<True>: scroll to bottom when a non-special key is pressed. Special keys
943are those which are intercepted by rxvt-unicode for special handling and 921are those which are intercepted by rxvt-unicode for special handling and
944are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 922are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
945bottom when a non-special key is pressed; option B<+sk>. 923bottom when a non-special key is pressed; option B<+sk>.
946 924
947=item B<saveLines:> I<number> 925=item B<saveLines:> I<number>
948 926
949Save I<number> lines in the scrollback buffer [default 64]. This 927Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
950resource is limited on most machines to 65535; option B<-sl>.
951 928
952=item B<internalBorder:> I<number> 929=item B<internalBorder:> I<number>
953 930
954Internal border of I<number> pixels. This resource is limited to 100; 931Internal border of I<number> pixels. This resource is limited to 100;
955option B<-b>. 932option B<-b>.
1018 995
1019=item B<pointerColor2:> I<colour> 996=item B<pointerColor2:> I<colour>
1020 997
1021Mouse pointer background colour. 998Mouse pointer background colour.
1022 999
1000=item B<pointerShape:> I<string>
1001
1002Compile I<frills>: Specifies the name of the mouse pointer shape
1003[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
1004file for possible values (omit the C<XC_> prefix).
1005
1023=item B<pointerBlankDelay:> I<number> 1006=item B<pointerBlankDelay:> I<number>
1024 1007
1025Specifies number of seconds before blanking the pointer [default 2]. Use a 1008Specifies number of seconds before blanking the pointer [default 2]. Use a
1026large number (e.g. C<987654321>) to effectively disable the timeout. 1009large number (e.g. C<987654321>) to effectively disable the timeout.
1027 1010
1053 1036
1054B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1037B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1055 1038
1056=item B<preeditType:> I<style> 1039=item B<preeditType:> I<style>
1057 1040
1058B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1041B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1059 1042
1060=item B<inputMethod:> I<name> 1043=item B<inputMethod:> I<name>
1061 1044
1062I<name> of inputMethod to use; option B<-im>. 1045I<name> of inputMethod to use; option B<-im>.
1063 1046
1081 1064
1082Change the meaning of triple-click selection with the left mouse 1065Change the meaning of triple-click selection with the left mouse
1083button. Instead of selecting a full line it will extend the selection to 1066button. Instead of selecting a full line it will extend the selection to
1084the end of the logical line only; option B<-tcw>. 1067the end of the logical line only; option B<-tcw>.
1085 1068
1069=item B<disablePasteBrackets:> I<boolean>
1070
1071Prevent emission of paste bracket sequences; option B<-dpb>.
1072
1086=item B<insecure:> I<boolean> 1073=item B<insecure:> I<boolean>
1087 1074
1088Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1075Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1089echo arbitrary strings like the icon name or the locale. This could be 1076echo arbitrary strings like the icon name or the locale. This could be
1090abused if somebody gets 8-bit-clean access to your display, whether 1077abused if somebody gets 8-bit-clean access to your display, whether
1091through a mail client displaying mail bodies unfiltered or through 1078through a mail client displaying mail bodies unfiltered or through
1092write(1) or any other means. Therefore, these sequences are disabled by 1079write(1) or any other means. Therefore, these sequences are disabled by
1093default. (Note that many other terminals, including xterm, have these 1080default. (Note that many other terminals, including xterm, have these
1111 1098
1112=item B<secondaryScreen:> I<boolean> 1099=item B<secondaryScreen:> I<boolean>
1113 1100
1114Turn on/off secondary screen (default enabled). 1101Turn on/off secondary screen (default enabled).
1115 1102
1103=item B<rewrapMode:> I<mode>
1104
1105Sets long line rewrap behaviour on window resize to one of B<auto>
1106(default), B<always> or B<never>.
1107
1116=item B<secondaryScroll:> I<boolean> 1108=item B<secondaryScroll:> I<boolean>
1117 1109
1118Turn on/off secondary screen scroll (default enabled). If this 1110Turn on/off secondary screen scroll (default enabled). If this
1119option is enabled, scrolls on the secondary screen will change the 1111option is enabled, scrolls on the secondary screen will change the
1120scrollback buffer and, when secondaryScreen is off, switching 1112scrollback buffer and, when secondaryScreen is off, switching
1132Sets the working directory for the shell (or the command specified via 1124Sets the working directory for the shell (or the command specified via
1133B<-e>). The I<path> must be an absolute path and it must exist for 1125B<-e>). The I<path> must be an absolute path and it must exist for
1134@@RXVT_NAME@@ to start. If it isn't specified then the current working 1126@@RXVT_NAME@@ to start. If it isn't specified then the current working
1135directory will be used; option B<-cd>. 1127directory will be used; option B<-cd>.
1136 1128
1137=item B<keysym.>I<sym>: I<string> 1129=item B<keysym.>I<sym>: I<action>
1138 1130
1139Compile I<frills>: Associate I<string> with keysym I<sym>. The 1131Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1140intervening resource name B<keysym.> cannot be omitted. 1132resource name B<keysym.> cannot be omitted.
1141 1133
1142The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1134Using this resource, you can map key combinations such as
1143any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1135C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1144B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1136string than would normally result from that combination, making the
1145and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1137terminal scroll up or down the way you want it, or any other thing an
1146B<2>, B<3>, B<4>, B<5>. 1138extension might provide.
1139
1140The key combination that triggers the action, I<sym>, has the following format:
1141
1142 (modifiers-)key
1143
1144Where I<modifiers> can be any combination of the following full or
1145abbreviated modifier names:
1146
1147=begin table
1148
1149 B<ISOLevel3> B<I>
1150 B<AppKeypad> B<K>
1151 B<Control> B<C>
1152 B<NumLock> B<N>
1153 B<Shift> B<S>
1154 B<Meta> B<M> I<or> B<A>
1155 B<Lock> B<L>
1156 B<Mod1> B<1>
1157 B<Mod2> B<2>
1158 B<Mod3> B<3>
1159 B<Mod4> B<4>
1160 B<Mod5> B<5>
1161
1162=end table
1147 1163
1148The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1164The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1149whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1165whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1150keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1166keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1151current application keymap mode state. 1167current application keymap mode state.
1152 1168
1153The spellings of I<key> can be obtained by using B<xev>(1) command or 1169Due the the large number of modifier combinations, a key mapping will
1154searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1170match if I<at least> the specified identifiers are being set, and no other
1171key mappings with those and more bits are being defined. That means that
1172defining a mapping for C<a> will automatically provide definitions for
1173C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1174themselves. See the C<builtin:> action, below, for a way to work around
1175this when this is a problem.
1176
1177The spelling of I<key> depends on your implementation of X. An easy way to
1178find a key name is to use the B<xev>(1) command. You can find a list by
1179looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1155omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1180the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1156keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1181value (B<0x0000 - 0xFFFF>).
1157performed in an exact manner; however, the closest match is assured.
1158 1182
1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1183As with any resource value, the I<action> string may contain backslash
1184escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1160number), see RESOURCES in C<man 7 X> for further details. 1185number), see RESOURCES in C<man 7 X> for further details.
1161 1186
1162You can define a range of keysyms in one shot by providing a I<string> 1187An action starts with an action prefix that selects a certain type
1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1188of action, followed by a colon. An action string without colons is
1189interpreted as a literal string to pass to the tty (as if it was
1190prefixed with C<string:>).
1191
1192The following action prefixes are known - extensions can provide
1193additional prefixes:
1194
1195=over
1196
1197=item string:STRING
1198
1199If the I<action> starts with C<string:> (or otherwise contains no colons),
1200then the remaining C<STRING> will be passed to the program running in the
1201terminal. For example, you could replace whatever Shift-Tab outputs by the
1202string C<echo rm -rf /> followed by a newline:
1203
1204 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1205
1206This could in theory be used to completely redefine your keymap.
1207
1208In addition, for actions of this type, you can define a range of
1209keysyms in one shot by loading the C<keysym-list> perl extension and
1210providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1164should be a character not used by the strings. 1211the delimiter `/' should be a character not used by the strings.
1165 1212
1166Its usage can be demonstrated by an example: 1213Its usage can be demonstrated by an example:
1167 1214
1168 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1215 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1169 1216
1170The above line is equivalent to the following three lines: 1217The above line is equivalent to the following three lines:
1171 1218
1172 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1219 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1173 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1220 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1174 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1221 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1175 1222
1223=item command:STRING
1224
1176If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1225If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1177is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1226is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1227the opposite of C<string:> - instead of sending it to the program running
1228in the terminal, it will be treated as if it were program output). This is
1229most useful to feed command sequences into @@RXVT_NAME@@.
1230
1178example the following means "change the current locale to C<zh_CN.GBK> 1231For example the following means "change the current locale to C<zh_CN.GBK>
1179when Control-Meta-c is being pressed": 1232when Control-Meta-c is being pressed":
1180 1233
1181 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1234 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1182 1235
1183If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1236The following example will map Control-Meta-1 and Control-Meta-2 to
1184is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1237the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1185manpage. For example, the F<selection> extension (activated via 1238font-switching at runtime:
1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187 1239
1188 URxvt.keysym.M-C-c: perl:selection:rot13 1240 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1241 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1189 1242
1190Due the the large number of modifier combinations, a defined key mapping 1243Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1191will match if I<at least> the specified identifiers are being set, and 1244info):
1192no other key mappings with those and more bits are being defined. That
1193means that defining a key map for C<a> will automatically provide
1194definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1195mappings themselves.
1196 1245
1197Unfortunately, this will override built-in key mappings. For example 1246 URxvt.keysym.M-C-3: command:\033[8;25;80t
1247 URxvt.keysym.M-C-4: command:\033[8;48;110t
1248
1249=item builtin:
1250
1251The builtin action is the action that @@RXVT_NAME@@ would execute if no
1252key binding existed for the key combination. The obvious use is to undo
1253the effect of existing bindings. The not so obvious use is to reinstate
1254bindings when another binding overrides too many modifiers.
1255
1198if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1256For example if you overwrite the C<Insert> key you will disable
1199C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1257@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1200user-defined keymap using the C<builtin:> replacement: 1258"holes" into the user-defined keymap using the C<builtin:> replacement:
1201 1259
1202 URxvt.keysym.Insert: <my insert key sequence> 1260 URxvt.keysym.Insert: <my insert key sequence>
1203 URxvt.keysym.S-Insert: builtin: 1261 URxvt.keysym.S-Insert: builtin:
1204 1262
1205The first line defines a mapping for C<Insert> and I<any> combination 1263The first line defines a mapping for C<Insert> and I<any> combination
1206of modifiers. The second line re-establishes the default mapping for 1264of modifiers. The second line re-establishes the default mapping for
1207C<Shift-Insert>. 1265C<Shift-Insert>.
1208 1266
1209The following example will map Control-Meta-1 and Control-Meta-2 to 1267=item builtin-string:
1210the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1211font-switching at runtime:
1212 1268
1213 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1269This action is mainly useful to restore string mappings for keys that
1214 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1270have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1271difficult to explain - basically, this action will send the string to the
1272application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1273action for it.
1215 1274
1216Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1275An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1217info): 1276selection when you press C<Shift-Insert>. With the following bindings, it
1277would instead emit the (undocumented, but what applications running in the
1278terminal might expect) sequence C<ESC [ 2 $> instead:
1218 1279
1219 URxvt.keysym.M-C-3: command:\033[8;25;80t 1280 URxvt.keysym.S-Insert: builtin-string:
1220 URxvt.keysym.M-C-4: command:\033[8;48;110t 1281 URxvt.keysym.C-S-Insert: builtin:
1282
1283The first line disables the paste functionality for that key
1284combination, and the second reinstates the default behaviour for
1285C<Control-Shift-Insert>, which would otherwise be overridden.
1286
1287Similarly, to let applications gain access to the C<C-M-c> (copy to
1288clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1289this:
1290
1291 URxvt.keysym.C-M-c: builtin-string:
1292 URxvt.keysym.C-M-v: builtin-string:
1293
1294=item EXTENSION:STRING
1295
1296An action of this form invokes the action B<STRING>, if any, provided
1297by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1298be loaded automatically if necessary.
1299
1300Not all extensions define actions, but popular extensions that do
1301include the I<selection> and I<matcher> extensions (documented in their
1302own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1303respectively).
1304
1305From the silly examples department, this will rot13-"encrypt"
1306@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1307keyboards:
1308
1309 URxvt.keysym.M-C-c: selection:rot13
1310
1311=item perl:STRING *DEPRECATED*
1312
1313This is a deprecated way of invoking commands provided by perl
1314extensions. It is still supported, but should not be used anymore.
1315
1316=back
1221 1317
1222=item B<perl-ext-common>: I<string> 1318=item B<perl-ext-common>: I<string>
1223 1319
1224=item B<perl-ext>: I<string> 1320=item B<perl-ext>: I<string>
1225 1321
1226Comma-separated list(s) of perl extension scripts (default: C<default>) to 1322Comma-separated list(s) of perl extension scripts (default: C<default>) to
1227use in this terminal instance; option B<-pe>. 1323use in this terminal instance; option B<-pe>.
1228 1324
1229Extension names can be prefixed with a C<-> sign to prohibit using 1325Extension names can be prefixed with a C<-> sign to remove them again, in
1230them. This can be useful to selectively disable some extensions loaded 1326case they had been specified earlier. This can be useful to selectively
1231by default, or specified via the C<perl-ext-common> resource. For 1327disable some extensions loaded by default, or specified via the
1232example, C<default,-selection> will use all the default extension except 1328C<perl-ext-common> resource. For example, C<default,-selection> will use
1233C<selection>. 1329all the default extensions except C<selection>.
1234 1330
1235Extension names can also be followed by an argument in angle brackets 1331To prohibit autoloading of extensions, you can prefix them with C</>,
1236(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1332which will make urxvt refuse to automatically load them (this can be
1237searchable scrollback to Alt/Meta-s). Mentioning the same extension 1333overridden, however, by specifying the extension name again without a
1238multiple times with different arguments will pass multiple arguments to 1334prefix, though). This does not prohibit extensions themselves loading
1239the extension. 1335other extensions. For example, C<default,/background> will keep the
1336C<background> extension from being loaded when a background OSC sequence
1337is received.
1338
1339The default set includes the C<selection>, C<option-popup>,
1340C<selection-popup>, C<readline>, C<searchable-scrollback> and
1341C<confirm-paste> extensions, as well as any extensions which are mentioned
1342in B<keysym> resources.
1343
1344Any extension such that a corresponding resource is given on the
1345command line is automatically appended to B<perl-ext>.
1240 1346
1241Each extension is looked up in the library directories, loaded if 1347Each extension is looked up in the library directories, loaded if
1242necessary, and bound to the current terminal instance. 1348necessary, and bound to the current terminal instance. When the library
1349search path contains multiple extension files of the same name, then the
1350first one found will be used.
1243 1351
1244If both of these resources are the empty string, then the perl 1352If both of these resources are the empty string, then the perl interpreter
1245interpreter will not be initialized. The idea behind two options is that 1353will not be initialized. The rationale for having two options is that
1246B<perl-ext-common> will be used for extensions that should be available to 1354B<perl-ext-common> will be used for extensions that should be available to
1247all instances, while B<perl-ext> is used for specific instances. 1355all instances, while B<perl-ext> is used for specific instances.
1248 1356
1249=item B<perl-eval>: I<string> 1357=item B<perl-eval>: I<string>
1250 1358
1252the @@RXVT_NAME@@perl(3) manpage. 1360the @@RXVT_NAME@@perl(3) manpage.
1253 1361
1254=item B<perl-lib>: I<path> 1362=item B<perl-lib>: I<path>
1255 1363
1256Colon-separated list of additional directories that hold extension 1364Colon-separated list of additional directories that hold extension
1257scripts. When looking for extensions specified by the C<perl> resource, 1365scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1258@@RXVT_NAME@@ will first look in these directories and then in 1366in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1259F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1367lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260 1368
1261See the @@RXVT_NAME@@perl(3) manpage. 1369See the @@RXVT_NAME@@perl(3) manpage.
1262 1370
1263=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1371=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1264 1372
1268=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1376=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1269 1377
1270Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1378Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1271for details. 1379for details.
1272 1380
1273=item B<searchable-scrollback:> I<keysym> 1381=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1274 1382
1275Sets the hotkey that starts the incremental scrollback buffer search 1383This resource is deprecated and will be removed. Use a B<keysym> resource
1276(default: C<M-s>). 1384instead, e.g.:
1277 1385
1386 URxvt.keysym.M-s: searchable-scrollback:start
1387
1278=item B<urlLauncher>: I<string> 1388=item B<url-launcher>: I<string>
1279 1389
1280Specifies the program to be started with a URL argument. Used by the 1390Specifies the program to be started with a URL argument. Used by the
1281C<selection-popup> and C<matcher> perl extensions. 1391C<selection-popup> and C<matcher> perl extensions.
1282 1392
1283=item B<transient-for>: I<windowid> 1393=item B<transient-for>: I<windowid>
1327=head1 THE SELECTION: SELECTING AND PASTING TEXT 1437=head1 THE SELECTION: SELECTING AND PASTING TEXT
1328 1438
1329The behaviour of text selection and insertion/pasting mechanism is similar 1439The behaviour of text selection and insertion/pasting mechanism is similar
1330to I<xterm>(1). 1440to I<xterm>(1).
1331 1441
1332=over 4 1442=over
1333 1443
1334=item B<Selecting>: 1444=item B<Selecting>:
1335 1445
1336Left click at the beginning of the region, drag to the end of the region 1446Left click at the beginning of the region, drag to the end of the region
1337and release; Right click to extend the marked region; Left double-click 1447and release; Right click to extend the marked region; Left double-click
1352B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1462B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1353 1463
1354Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1464Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1355inserted too. 1465inserted too.
1356 1466
1467rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1468<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1469binding causes the value of the internal selection to be copied to the
1470CLIPBOARD selection, while the second binding causes the value of the
1471CLIPBOARD selection to be inserted.
1472
1357=back 1473=back
1358 1474
1359=head1 CHANGING FONTS 1475=head1 CHANGING FONTS
1360 1476
1361Changing fonts (or font sizes, respectively) via the keypad is not yet 1477Changing fonts (or font sizes, respectively) via the keypad is not yet
1378and character codes using the keyboard. It consists of 4 parts. The 1494and character codes using the keyboard. It consists of 4 parts. The
1379first part is available if rxvt-unicode has been compiled with 1495first part is available if rxvt-unicode has been compiled with
1380C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1496C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1381with C<--enable-iso14755>. 1497with C<--enable-iso14755>.
1382 1498
1383=over 4 1499=over
1384 1500
1385=item * 5.1: Basic method 1501=item * 5.1: Basic method
1386 1502
1387This allows you to enter unicode characters using their hexcode. 1503This allows you to enter unicode characters using their hexcode.
1388 1504
1449In addition to the default foreground and background colours, 1565In addition to the default foreground and background colours,
1450B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1566B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1451high-intensity (potentially bold/blink) versions of the same, and 72 (or 1567high-intensity (potentially bold/blink) versions of the same, and 72 (or
1452240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1568240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1453cube plus a 8 (24) colour greyscale ramp. 1569cube plus a 8 (24) colour greyscale ramp.
1570
1571B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1572C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1573number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1574colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
157524-bit colour space. When indexing collisions happen, the nearest old colour in
1576the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1577use many similar 24-bit colours. It's typically not a problem in common
1578scenarios.
1454 1579
1455Here is a list of the ANSI colours with their names. 1580Here is a list of the ANSI colours with their names.
1456 1581
1457=begin table 1582=begin table
1458 1583
1485The following text gives values for the standard 88 colour mode (and 1610The following text gives values for the standard 88 colour mode (and
1486values for the 256 colour mode in parentheses). 1611values for the 256 colour mode in parentheses).
1487 1612
1488The RGB cube uses indices 16..79 (16..231) using the following formulas: 1613The RGB cube uses indices 16..79 (16..231) using the following formulas:
1489 1614
1490 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1615 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1491 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1616 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1492 1617
1493The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1618The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1494steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1619steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1495the RGB cube. 1620the RGB cube.
1496 1621
1512White. 1637White.
1513 1638
1514=head2 ALPHA CHANNEL SUPPORT 1639=head2 ALPHA CHANNEL SUPPORT
1515 1640
1516If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1641If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1517their act together, rxvt-unicode will do it's own alpha channel management: 1642their act together, rxvt-unicode will do its own alpha channel management:
1518 1643
1519You can prefix any colour with an opaqueness percentage enclosed in 1644You can prefix any colour with an opaqueness percentage enclosed in
1520brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1645brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1521(0-100) that specifies the opacity of the colour, where C<0> is completely 1646(0-100) that specifies the opacity of the colour, where C<0> is completely
1522transparent and C<100> is completely opaque. For example, C<[50]red> is a 1647transparent and C<100> is completely opaque. For example, C<[50]red> is a
1559 1684
1560=head1 ENVIRONMENT 1685=head1 ENVIRONMENT
1561 1686
1562B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1687B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1563 1688
1564=over 4 1689=over
1565 1690
1566=item B<TERM> 1691=item B<TERM>
1567 1692
1568Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1693Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1569resources or on the command line. 1694resources or on the command line.
1604 1729
1605=item B<SHELL> 1730=item B<SHELL>
1606 1731
1607The shell to be used for command execution, defaults to C</bin/sh>. 1732The shell to be used for command execution, defaults to C</bin/sh>.
1608 1733
1609=item B<RXVT_SOCKET> 1734=item B<RXVT_SOCKET> [I<sic>]
1610 1735
1611The unix domain socket path used by @@RXVT_NAME@@c(1) and 1736The unix domain socket path used by @@RXVT_NAME@@c(1) and
1612@@RXVT_NAME@@d(1). 1737@@RXVT_NAME@@d(1).
1613 1738
1614Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1739Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1740
1741=item B<URXVT_PERL_LIB>
1742
1743Additional F<:>-separated library search path for perl extensions. Will be
1744searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1745directory.
1746
1747=item B<URXVT_PERL_VERBOSITY>
1748
1749See L<@@RXVT_NAME@@perl>(3).
1615 1750
1616=item B<HOME> 1751=item B<HOME>
1617 1752
1618Used to locate the default directory for the unix domain socket for 1753Used to locate the default directory for the unix domain socket for
1619daemon communications and to locate various resource files (such as 1754daemon communications and to locate various resource files (such as
1620C<.Xdefaults>) 1755C<.Xdefaults>)
1621 1756
1622=item B<XAPPLRESDIR> 1757=item B<XAPPLRESDIR>
1623 1758
1624Directory where various X resource files are being located. 1759Directory where application-specific X resource files are located.
1625 1760
1626=item B<XENVIRONMENT> 1761=item B<XENVIRONMENT>
1627 1762
1628If set and accessible, gives the name of a X resource file to be loaded by 1763If set and accessible, gives the name of a X resource file to be loaded by
1629@@RXVT_NAME@@. 1764@@RXVT_NAME@@.
1630 1765
1631=back 1766=back
1632 1767
1633=head1 FILES 1768=head1 FILES
1634 1769
1635=over 4 1770=over
1636 1771
1637=item B</usr/lib/X11/rgb.txt> 1772=item B</usr/lib/X11/rgb.txt>
1638 1773
1639Colour names. 1774Colour names.
1640 1775
1641=back 1776=back
1642 1777
1643=head1 SEE ALSO 1778=head1 SEE ALSO
1644 1779
1780@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1645@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1781@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1646 1782
1647=head1 CURRENT PROJECT COORDINATOR 1783=head1 CURRENT PROJECT COORDINATOR
1648 1784
1649=over 4 1785=over
1650 1786
1651=item Project Coordinator 1787=item Project Coordinator
1652 1788
1653Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1789Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1654 1790
1655L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1791L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1656 1792
1657=back 1793=back
1658 1794
1659=head1 AUTHORS 1795=head1 AUTHORS
1660 1796
1661=over 4 1797=over
1662 1798
1663=item John Bovey 1799=item John Bovey
1664 1800
1665University of Kent, 1992, wrote the original Xvt. 1801University of Kent, 1992, wrote the original Xvt.
1666 1802
1667=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1803=item Rob Nation <nation@rocket.sanders.lockheed.com>
1668 1804
1669very heavily modified Xvt and came up with Rxvt 1805very heavily modified Xvt and came up with Rxvt
1670 1806
1671=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1807=item Angelo Haritsis <ah@doc.ic.ac.uk>
1672 1808
1673wrote the Greek Keyboard Input (no longer in code) 1809wrote the Greek Keyboard Input (no longer in code)
1674 1810
1675=item mj olesen L<< <olesen@me.QueensU.CA> >> 1811=item mj olesen <olesen@me.QueensU.CA>
1676 1812
1677Wrote the menu system. 1813Wrote the menu system.
1678 1814
1679Project Coordinator (changes.txt 2.11 to 2.21) 1815Project Coordinator (changes.txt 2.11 to 2.21)
1680 1816
1681=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1817=item Oezguer Kesim <kesim@math.fu-berlin.de>
1682 1818
1683Project Coordinator (changes.txt 2.21a to 2.4.5) 1819Project Coordinator (changes.txt 2.21a to 2.4.5)
1684 1820
1685=item Geoff Wing L<< <gcw@pobox.com> >> 1821=item Geoff Wing <gcw@pobox.com>
1686 1822
1687Rewrote screen display and text selection routines. 1823Rewrote screen display and text selection routines.
1688 1824
1689Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1825Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1690 1826
1691=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1827=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1692 1828
1693Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1829Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1694extension, random hacks, numerous bugfixes and extensions. 1830extension, random hacks, numerous bugfixes and extensions.
1695 1831
1696Project Coordinator (Changes 1.0 -) 1832Project Coordinator (Changes 1.0 -)
1697 1833
1698=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1834=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1699 1835
1700Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1836pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1701 1837
1702=back 1838=back
1703 1839

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines