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.184 by sf-exg, Sat Sep 11 21:28:59 2010 UTC vs.
Revision 1.256 by root, Mon Nov 22 17:00:49 2021 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>
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
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
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 132
137=item B<-fade> I<number> 133=item B<-fade> I<number>
138 134
139Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
143=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
144 140
145Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
147 143
148=item B<-tint> I<colour>
149
150Tint the transparent background pixmap with the given colour when
151transparency is enabled with B<-tr>. This only works for
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colours essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file> 144=item B<-icon> I<file>
188 145
189Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 146Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 147is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 148application window; resource I<iconFile>.
192 149
193=item B<-bg> I<colour> 150=item B<-bg> I<colour>
194 151
195Window background colour; resource B<background>. 152Window background colour; resource B<background>.
196 153
197=item B<-fg> I<colour> 154=item B<-fg> I<colour>
198 155
199Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>.
207 157
208=item B<-cr> I<colour> 158=item B<-cr> I<colour>
209 159
210The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
211 161
270 220
271=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
272 222
273Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
274 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
275=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
276 230
277Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
278B<utmpInhibit>. 232B<utmpInhibit>.
279 233
357 311
358=item B<-override-redirect> 312=item B<-override-redirect>
359 313
360Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
361B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
362 321
363=item B<-sbg> 322=item B<-sbg>
364 323
365Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
366drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
421=item B<-pt> I<style> 380=item B<-pt> I<style>
422 381
423Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
424B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
425 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
426=item B<-im> I<text> 388=item B<-im> I<text>
427 389
428Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
429 391
430=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
444Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
445button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
446in-use. Instead of selecting a full line it will extend the selection to 408in-use. Instead of selecting a full line it will extend the selection to
447the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
448 410
411=item B<-dpb>|B<+dpb>
412
413Compile frills: Disable (or enable) emitting bracketed paste mode
414sequences (default enabled). Bracketed paste mode allows programs
415to detect when something is pasted. Since more and more programs
416abuse this, these sequences can be disabled. The command sequences to
417enable and query paste mode will still work, but the actual bracket
418sequences will no longer be emitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
420
449=item B<-insecure> 421=item B<-insecure>
450 422
451Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
452sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
453info. 425info.
465 437
466=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
467 439
468Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
469B<secondaryScroll>. 441B<secondaryScroll>.
442
443=item B<-rm> I<mode>
444
445Compile I<frills>: Sets long line rewrapping behaviour on window resizes
446to one of B<auto> (the default), B<always> or B<never>. The latter two
447modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
448is non-empty, and wings lines (acts like B<never>) otherwise; resource
449B<rewrapMode>.
470 450
471=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
472 452
473Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
474will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
553 533
554 # now communicate with rxvt 534 # now communicate with rxvt
555 my $slave = $pty->slave; 535 my $slave = $pty->slave;
556 while (<$slave>) { print $slave "got <$_>\n" } 536 while (<$slave>) { print $slave "got <$_>\n" }
557 537
538Note that, despite what the name might imply, the file descriptor does not
539need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
540domain or tcp socket). While tty operations cannot be done in this case,
541B<@@RXVT_NAME@@> can still be remote controlled with it:
542
543 use Socket;
544 use Fcntl;
545
546 socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
547 fcntl $slave, Fcntl::F_SETFD, 0;
548 system "exec @@RXVT_NAME|| -pty-fd " . (fileno $slave) . " &";
549 close $slave;
550
551 syswrite $URXVT, "Type a secret password: ";
552 my $secret = do { local $/ = "\r"; <$URXVT> };
553 print "No so secret anymore: $secret\n";
554
558=item B<-pe> I<string> 555=item B<-pe> I<string>
559 556
560Comma-separated list of perl extension scripts to use (or not to use) in 557Comma-separated list of perl extension scripts to use (or not to use) in
561this terminal instance. See resource B<perl-ext> for details. 558this terminal instance. See resource B<perl-ext> for details.
562 559
571You can set and change the resources using X11 tools like B<xrdb>. Many 568You can set and change the resources using X11 tools like B<xrdb>. Many
572distribution do also load settings from the B<~/.Xresources> file when X 569distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 570starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 571with later settings overwriting earlier ones:
575 572
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 573 1. app-defaults file in $XAPPLRESDIR
574 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 575 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 576 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 577 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 578 6. resources specified via -xrm on the commandline
582 579
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 580Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 581names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
589be used. Command-line arguments can be used to override resource 586be used. Command-line arguments can be used to override resource
590settings. The following resources are supported (you might want to 587settings. The following resources are supported (you might want to
591check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 588check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
592extensions not documented here): 589extensions not documented here):
593 590
594=over 4 591=over
595 592
596=item B<depth:> I<bitdepth> 593=item B<depth:> I<bitdepth>
597 594
598Compile I<xft>: Attempt to find a visual with the given bit depth; 595Compile I<xft>: Attempt to find a visual with the given bit depth;
599option B<-depth>. 596option B<-depth>.
700 697
701B<False>: specify that everything is to be displayed, even 698B<False>: specify that everything is to be displayed, even
702if the refresh is too fast for the human eye to read anything (or the 699if the refresh is too fast for the human eye to read anything (or the
703monitor to display anything); option B<+ss>. 700monitor to display anything); option B<+ss>.
704 701
705=item B<transparent:> I<boolean>
706
707Turn on/off illusion of a transparent window background.
708
709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710future versions.
711
712I<Please address all transparency related issues to Sasha Vasko at
713sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
714
715=item B<fading:> I<number> 702=item B<fading:> I<number>
716 703
717Fade the text by the given percentage when focus is lost; option B<-fade>. 704Fade the text by the given percentage when focus is lost; option B<-fade>.
718 705
719=item B<fadeColor:> I<colour> 706=item B<fadeColor:> I<colour>
720 707
721Fade to this colour, when fading is used (see B<fading:>). The default 708Fade to this colour, when fading is used (see B<fading:>). The default
722colour is black; option B<-fadecolor>. 709colour is black; option B<-fadecolor>.
723 710
724=item B<tintColor:> I<colour>
725
726Tint the transparent background pixmap with the given colour; option
727B<-tint>.
728
729=item B<shading:> I<number>
730
731Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
732in addition to tinting it; option B<-sh>.
733
734=item B<blendType:> I<string>
735
736Specify background blending type; option B<-blt>.
737
738=item B<blurRadius:> I<number>
739
740Apply gaussian blur with the specified radius to the transparent
741background image; option B<-blr>.
742
743=item B<iconFile:> I<file> 711=item B<iconFile:> I<file>
744 712
745Set the application icon pixmap; option B<-icon>. 713Set the application icon pixmap; option B<-icon>.
746 714
747=item B<scrollColor:> I<colour> 715=item B<scrollColor:> I<colour>
755 723
756=item B<borderColor:> I<colour> 724=item B<borderColor:> I<colour>
757 725
758The colour of the border around the text area and between the scrollbar 726The colour of the border around the text area and between the scrollbar
759and the text. 727and the text.
760
761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
762
763Use the specified image file for the background and also
764optionally specify its scaling with a geometry string B<WxH+X+Y>,
765(default C<100x100+50+50>) in which B<"W" / "H"> specify the
766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767centre (percent). A scale of 0 displays the image with tiling.
768The maximum permitted scale is 1000.
769Additional operations can be specified after colon B<:op1:op2...>.
770Supported operations are:
771
772 tile force background image to be tiled and not scaled. Equivalent to 0x0
773 propscale will scale image keeping proportions
774 auto will scale image to match window size. Equivalent to 100x100
775 hscale will scale image horizontally to the window size
776 vscale will scale image vertically to the window size
777 scale will scale image to match window size
778 root will tile image as if it was a root window background, auto-adjusting
779 whenever terminal window moves
780
781If used in conjunction with B<-tr> option, the specified pixmap will be
782blended over transparency image using either alpha-blending, or any
783other blending type, specified with B<-blt "type"> option.
784
785=item B<path:> I<path>
786
787Specify the colon-delimited search path for finding background image files.
788 728
789=item B<font:> I<fontlist> 729=item B<font:> I<fontlist>
790 730
791Select the fonts to be used. This is a comma separated list of font names 731Select the fonts to be used. This is a comma separated list of font names
792that are checked in order when trying to find glyphs for characters. The 732that are checked in order when trying to find glyphs for characters. The
889 829
890B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 830B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
891the shell; option B<-ls>. B<False>: start as a normal sub-shell 831the shell; option B<-ls>. B<False>: start as a normal sub-shell
892[default]; option B<+ls>. 832[default]; option B<+ls>.
893 833
834=item B<multiClickTime:> I<number>
835
836Specify the maximum time in milliseconds between multi-click select
837events. The default is 500 milliseconds; option B<-mc>.
838
894=item B<utmpInhibit:> I<boolean> 839=item B<utmpInhibit:> I<boolean>
895 840
896B<True>: inhibit writing record into the system log file B<utmp>; 841B<True>: inhibit writing record into the system log file B<utmp>;
897option B<-ut>. B<False>: write record into the system log file B<utmp> 842option B<-ut>. B<False>: write record into the system log file B<utmp>
898[default]; option B<+ut>. 843[default]; option B<+ut>.
915=item B<scrollstyle:> I<mode> 860=item B<scrollstyle:> I<mode>
916 861
917Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 862Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
918the author's favourite. 863the author's favourite.
919 864
865=item B<thickness:> I<number>
866
867Set the scrollbar width in pixels.
868
920=item B<scrollBar:> I<boolean> 869=item B<scrollBar:> I<boolean>
921 870
922B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 871B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
923disable the scrollbar; option B<+sb>. 872disable the scrollbar; option B<+sb>.
924 873
943B<False>: do not scroll to bottom when tty receives output; option 892B<False>: do not scroll to bottom when tty receives output; option
944B<+si>. 893B<+si>.
945 894
946=item B<scrollWithBuffer:> I<boolean> 895=item B<scrollWithBuffer:> I<boolean>
947 896
948B<True>: scroll with scrollback buffer when tty receives new lines (and 897B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
949B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 898try to show the same lines) and B<scrollTtyOutput> is False; option
950with scrollback buffer when tty receives new lines; option B<+sw>. 899B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
900new lines; option B<+sw>.
951 901
952=item B<scrollTtyKeypress:> I<boolean> 902=item B<scrollTtyKeypress:> I<boolean>
953 903
954B<True>: scroll to bottom when a non-special key is pressed. Special keys 904B<True>: scroll to bottom when a non-special key is pressed. Special keys
955are those which are intercepted by rxvt-unicode for special handling and 905are those which are intercepted by rxvt-unicode for special handling and
956are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 906are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
957bottom when a non-special key is pressed; option B<+sk>. 907bottom when a non-special key is pressed; option B<+sk>.
958 908
959=item B<saveLines:> I<number> 909=item B<saveLines:> I<number>
960 910
961Save I<number> lines in the scrollback buffer [default 64]. This 911Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
962resource is limited on most machines to 65535; option B<-sl>.
963 912
964=item B<internalBorder:> I<number> 913=item B<internalBorder:> I<number>
965 914
966Internal border of I<number> pixels. This resource is limited to 100; 915Internal border of I<number> pixels. This resource is limited to 100;
967option B<-b>. 916option B<-b>.
1030 979
1031=item B<pointerColor2:> I<colour> 980=item B<pointerColor2:> I<colour>
1032 981
1033Mouse pointer background colour. 982Mouse pointer background colour.
1034 983
984=item B<pointerShape:> I<string>
985
986Compile I<frills>: Specifies the name of the mouse pointer shape
987[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
988file for possible values (omit the C<XC_> prefix).
989
1035=item B<pointerBlankDelay:> I<number> 990=item B<pointerBlankDelay:> I<number>
1036 991
1037Specifies number of seconds before blanking the pointer [default 2]. Use a 992Specifies number of seconds before blanking the pointer [default 2]. Use a
1038large number (e.g. C<987654321>) to effectively disable the timeout. 993large number (e.g. C<987654321>) to effectively disable the timeout.
1039 994
1065 1020
1066B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1021B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1067 1022
1068=item B<preeditType:> I<style> 1023=item B<preeditType:> I<style>
1069 1024
1070B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1025B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1071 1026
1072=item B<inputMethod:> I<name> 1027=item B<inputMethod:> I<name>
1073 1028
1074I<name> of inputMethod to use; option B<-im>. 1029I<name> of inputMethod to use; option B<-im>.
1075 1030
1093 1048
1094Change the meaning of triple-click selection with the left mouse 1049Change the meaning of triple-click selection with the left mouse
1095button. Instead of selecting a full line it will extend the selection to 1050button. Instead of selecting a full line it will extend the selection to
1096the end of the logical line only; option B<-tcw>. 1051the end of the logical line only; option B<-tcw>.
1097 1052
1053=item B<disablePasteBrackets:> I<boolean>
1054
1055Prevent emission of paste bracket sequences; option B<-dpb>.
1056
1098=item B<insecure:> I<boolean> 1057=item B<insecure:> I<boolean>
1099 1058
1100Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1059Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1101echo arbitrary strings like the icon name or the locale. This could be 1060echo arbitrary strings like the icon name or the locale. This could be
1102abused if somebody gets 8-bit-clean access to your display, whether 1061abused if somebody gets 8-bit-clean access to your display, whether
1103through a mail client displaying mail bodies unfiltered or through 1062through a mail client displaying mail bodies unfiltered or through
1104write(1) or any other means. Therefore, these sequences are disabled by 1063write(1) or any other means. Therefore, these sequences are disabled by
1105default. (Note that many other terminals, including xterm, have these 1064default. (Note that many other terminals, including xterm, have these
1123 1082
1124=item B<secondaryScreen:> I<boolean> 1083=item B<secondaryScreen:> I<boolean>
1125 1084
1126Turn on/off secondary screen (default enabled). 1085Turn on/off secondary screen (default enabled).
1127 1086
1087=item B<rewrapMode:> I<mode>
1088
1089Sets long line rewrap behaviour on window resize to one of B<auto>
1090(default), B<always> or B<never>.
1091
1128=item B<secondaryScroll:> I<boolean> 1092=item B<secondaryScroll:> I<boolean>
1129 1093
1130Turn on/off secondary screen scroll (default enabled). If this 1094Turn on/off secondary screen scroll (default enabled). If this
1131option is enabled, scrolls on the secondary screen will change the 1095option is enabled, scrolls on the secondary screen will change the
1132scrollback buffer and, when secondaryScreen is off, switching 1096scrollback buffer and, when secondaryScreen is off, switching
1144Sets the working directory for the shell (or the command specified via 1108Sets the working directory for the shell (or the command specified via
1145B<-e>). The I<path> must be an absolute path and it must exist for 1109B<-e>). The I<path> must be an absolute path and it must exist for
1146@@RXVT_NAME@@ to start. If it isn't specified then the current working 1110@@RXVT_NAME@@ to start. If it isn't specified then the current working
1147directory will be used; option B<-cd>. 1111directory will be used; option B<-cd>.
1148 1112
1149=item B<keysym.>I<sym>: I<string> 1113=item B<keysym.>I<sym>: I<action>
1150 1114
1151Compile I<frills>: Associate I<string> with keysym I<sym>. The 1115Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1152intervening resource name B<keysym.> cannot be omitted. 1116resource name B<keysym.> cannot be omitted.
1153 1117
1154The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1118Using this resource, you can map key combinations such as
1155any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1119C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1156B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1120string than would normally result from that combination, making the
1157and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1121terminal scroll up or down the way you want it, or any other thing an
1158B<2>, B<3>, B<4>, B<5>. 1122extension might provide.
1123
1124The key combination that triggers the action, I<sym>, has the following format:
1125
1126 (modifiers-)key
1127
1128Where I<modifiers> can be any combination of the following full or
1129abbreviated modifier names:
1130
1131=begin table
1132
1133 B<ISOLevel3> B<I>
1134 B<AppKeypad> B<K>
1135 B<Control> B<C>
1136 B<NumLock> B<N>
1137 B<Shift> B<S>
1138 B<Meta> B<M> I<or> B<A>
1139 B<Lock> B<L>
1140 B<Mod1> B<1>
1141 B<Mod2> B<2>
1142 B<Mod3> B<3>
1143 B<Mod4> B<4>
1144 B<Mod5> B<5>
1145
1146=end table
1159 1147
1160The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1148The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1161whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1149whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1162keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1150keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1163current application keymap mode state. 1151current application keymap mode state.
1164 1152
1165The spellings of I<key> can be obtained by using B<xev>(1) command or 1153Due the the large number of modifier combinations, a key mapping will
1166searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1154match if I<at least> the specified identifiers are being set, and no other
1155key mappings with those and more bits are being defined. That means that
1156defining a mapping for C<a> will automatically provide definitions for
1157C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1158themselves. See the C<builtin:> action, below, for a way to work around
1159this when this is a problem.
1160
1161The spelling of I<key> depends on your implementation of X. An easy way to
1162find a key name is to use the B<xev>(1) command. You can find a list by
1163looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1167omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1164the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1168keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1165value (B<0x0000 - 0xFFFF>).
1169performed in an exact manner; however, the closest match is assured.
1170 1166
1171I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1167As with any resource value, the I<action> string may contain backslash
1168escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1172number), see RESOURCES in C<man 7 X> for further details. 1169number), see RESOURCES in C<man 7 X> for further details.
1173 1170
1174You can define a range of keysyms in one shot by providing a I<string> 1171An action starts with an action prefix that selects a certain type
1175with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1172of action, followed by a colon. An action string without colons is
1173interpreted as a literal string to pass to the tty (as if it was
1174prefixed with C<string:>).
1175
1176The following action prefixes are known - extensions can provide
1177additional prefixes:
1178
1179=over
1180
1181=item string:STRING
1182
1183If the I<action> starts with C<string:> (or otherwise contains no colons),
1184then the remaining C<STRING> will be passed to the program running in the
1185terminal. For example, you could replace whatever Shift-Tab outputs by the
1186string C<echo rm -rf /> followed by a newline:
1187
1188 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1189
1190This could in theory be used to completely redefine your keymap.
1191
1192In addition, for actions of this type, you can define a range of
1193keysyms in one shot by loading the C<keysym-list> perl extension and
1194providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1176should be a character not used by the strings. 1195the delimiter `/' should be a character not used by the strings.
1177 1196
1178Its usage can be demonstrated by an example: 1197Its usage can be demonstrated by an example:
1179 1198
1180 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1199 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1181 1200
1182The above line is equivalent to the following three lines: 1201The above line is equivalent to the following three lines:
1183 1202
1184 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1203 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1185 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1204 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1186 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1205 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1187 1206
1207=item command:STRING
1208
1188If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1209If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1189is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1210is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1211the opposite of C<string:> - instead of sending it to the program running
1212in the terminal, it will be treated as if it were program output). This is
1213most useful to feed command sequences into @@RXVT_NAME@@.
1214
1190example the following means "change the current locale to C<zh_CN.GBK> 1215For example the following means "change the current locale to C<zh_CN.GBK>
1191when Control-Meta-c is being pressed": 1216when Control-Meta-c is being pressed":
1192 1217
1193 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1218 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1194 1219
1195If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1220The following example will map Control-Meta-1 and Control-Meta-2 to
1196is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1221the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1197manpage. For example, the F<selection> extension (activated via 1222font-switching at runtime:
1198C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1199 1223
1200 URxvt.keysym.M-C-c: perl:selection:rot13 1224 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1225 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1201 1226
1202Due the the large number of modifier combinations, a defined key mapping 1227Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1203will match if at I<at least> the specified identifiers are being set, and 1228info):
1204no other key mappings with those and more bits are being defined. That
1205means that defining a key map for C<a> will automatically provide
1206definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1207mappings themselves.
1208 1229
1209Unfortunately, this will override built-in key mappings. For example 1230 URxvt.keysym.M-C-3: command:\033[8;25;80t
1231 URxvt.keysym.M-C-4: command:\033[8;48;110t
1232
1233=item builtin:
1234
1235The builtin action is the action that @@RXVT_NAME@@ would execute if no
1236key binding existed for the key combination. The obvious use is to undo
1237the effect of existing bindings. The not so obvious use is to reinstate
1238bindings when another binding overrides too many modifiers.
1239
1210if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1240For example if you overwrite the C<Insert> key you will disable
1211C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1241@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1212user-defined keymap using the C<builtin:> replacement: 1242"holes" into the user-defined keymap using the C<builtin:> replacement:
1213 1243
1214 URxvt.keysym.Insert: <my insert key sequence> 1244 URxvt.keysym.Insert: <my insert key sequence>
1215 URxvt.keysym.S-Insert: builtin: 1245 URxvt.keysym.S-Insert: builtin:
1216 1246
1217The first line defines a mapping for C<Insert> and I<any> combination 1247The first line defines a mapping for C<Insert> and I<any> combination
1218of modifiers. The second line re-establishes the default mapping for 1248of modifiers. The second line re-establishes the default mapping for
1219C<Shift-Insert>. 1249C<Shift-Insert>.
1220 1250
1221The following example will map Control-Meta-1 and Control-Meta-2 to 1251=item builtin-string:
1222the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1223font-switching at runtime:
1224 1252
1225 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1253This action is mainly useful to restore string mappings for keys that
1226 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1254have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1255difficult to explain - basically, this action will send the string to the
1256application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1257action for it.
1227 1258
1228Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1259An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1229info): 1260selection when you press C<Shift-Insert>. With the following bindings, it
1261would instead emit the (undocumented, but what applications running in the
1262terminal might expect) sequence C<ESC [ 2 $> instead:
1230 1263
1231 URxvt.keysym.M-C-3: command:\033[8;25;80t 1264 URxvt.keysym.S-Insert: builtin-string:
1232 URxvt.keysym.M-C-4: command:\033[8;48;110t 1265 URxvt.keysym.C-S-Insert: builtin:
1266
1267The first line disables the paste functionality for that key
1268combination, and the second reinstates the default behaviour for
1269C<Control-Shift-Insert>, which would otherwise be overridden.
1270
1271Similarly, to let applications gain access to the C<C-M-c> (copy to
1272clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1273this:
1274
1275 URxvt.keysym.C-M-c: builtin-string:
1276 URxvt.keysym.C-M-v: builtin-string:
1277
1278=item EXTENSION:STRING
1279
1280An action of this form invokes the action B<STRING>, if any, provided
1281by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1282be loaded automatically if necessary.
1283
1284Not all extensions define actions, but popular extensions that do
1285include the I<selection> and I<matcher> extensions (documented in their
1286own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1287respectively).
1288
1289From the silly examples department, this will rot13-"encrypt"
1290@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1291keyboards:
1292
1293 URxvt.keysym.M-C-c: selection:rot13
1294
1295=item perl:STRING *DEPRECATED*
1296
1297This is a deprecated way of invoking commands provided by perl
1298extensions. It is still supported, but should not be used anymore.
1299
1300=back
1233 1301
1234=item B<perl-ext-common>: I<string> 1302=item B<perl-ext-common>: I<string>
1235 1303
1236=item B<perl-ext>: I<string> 1304=item B<perl-ext>: I<string>
1237 1305
1238Comma-separated list(s) of perl extension scripts (default: C<default>) to 1306Comma-separated list(s) of perl extension scripts (default: C<default>) to
1239use in this terminal instance; option B<-pe>. 1307use in this terminal instance; option B<-pe>.
1240 1308
1241Extension names can be prefixed with a C<-> sign to prohibit using 1309Extension names can be prefixed with a C<-> sign to remove them again, in
1242them. This can be useful to selectively disable some extensions loaded 1310case they had been specified earlier. This can be useful to selectively
1243by default, or specified via the C<perl-ext-common> resource. For 1311disable some extensions loaded by default, or specified via the
1244example, C<default,-selection> will use all the default extension except 1312C<perl-ext-common> resource. For example, C<default,-selection> will use
1245C<selection>. 1313all the default extensions except C<selection>.
1246 1314
1247Extension names can also be followed by an argument in angle brackets 1315To prohibit autoloading of extensions, you can prefix them with C</>,
1248(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1316which will make urxvt refuse to automatically load them (this can be
1249searchable scrollback to Alt/Meta-s). Mentioning the same extension 1317overriden, however, by specifying the extension name again without a
1250multiple times with different arguments will pass multiple arguments to 1318prefix, though). This does not prohibit extensions themselves loading
1251the extension. 1319other extensions. For example, C<default,/background> will keep the
1320C<background> extension from being loaded when a background OSC sequence
1321is received.
1322
1323The default set includes the C<selection>, C<option-popup>,
1324C<selection-popup>, C<readline>, C<searchable-scrollback> and
1325C<confirm-paste> extensions, as well as any extensions which are mentioned
1326in B<keysym> resources.
1327
1328Any extension such that a corresponding resource is given on the
1329command line is automatically appended to B<perl-ext>.
1252 1330
1253Each extension is looked up in the library directories, loaded if 1331Each extension is looked up in the library directories, loaded if
1254necessary, and bound to the current terminal instance. 1332necessary, and bound to the current terminal instance. When the library
1333search path contains multiple extension files of the same name, then the
1334first one found will be used.
1255 1335
1256If both of these resources are the empty string, then the perl 1336If both of these resources are the empty string, then the perl interpreter
1257interpreter will not be initialized. The idea behind two options is that 1337will not be initialized. The rationale for having two options is that
1258B<perl-ext-common> will be used for extensions that should be available to 1338B<perl-ext-common> will be used for extensions that should be available to
1259all instances, while B<perl-ext> is used for specific instances. 1339all instances, while B<perl-ext> is used for specific instances.
1260 1340
1261=item B<perl-eval>: I<string> 1341=item B<perl-eval>: I<string>
1262 1342
1264the @@RXVT_NAME@@perl(3) manpage. 1344the @@RXVT_NAME@@perl(3) manpage.
1265 1345
1266=item B<perl-lib>: I<path> 1346=item B<perl-lib>: I<path>
1267 1347
1268Colon-separated list of additional directories that hold extension 1348Colon-separated list of additional directories that hold extension
1269scripts. When looking for extensions specified by the C<perl> resource, 1349scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1270@@RXVT_NAME@@ will first look in these directories and then in 1350in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1271F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1351lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1272 1352
1273See the @@RXVT_NAME@@perl(3) manpage. 1353See the @@RXVT_NAME@@perl(3) manpage.
1274 1354
1275=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1355=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1276 1356
1280=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1360=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1281 1361
1282Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1362Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1283for details. 1363for details.
1284 1364
1285=item B<searchable-scrollback:> I<keysym> 1365=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1286 1366
1287Sets the hotkey that starts the incremental scrollback buffer search 1367This resource is deprecated and will be removed. Use a B<keysym> resource
1288(default: C<M-s>). 1368instead, e.g.:
1289 1369
1370 URxvt.keysym.M-s: searchable-scrollback:start
1371
1290=item B<urlLauncher>: I<string> 1372=item B<url-launcher>: I<string>
1291 1373
1292Specifies the program to be started with a URL argument. Used by the 1374Specifies the program to be started with a URL argument. Used by the
1293C<selection-popup> and C<matcher> perl extensions. 1375C<selection-popup> and C<matcher> perl extensions.
1294 1376
1295=item B<transient-for>: I<windowid> 1377=item B<transient-for>: I<windowid>
1339=head1 THE SELECTION: SELECTING AND PASTING TEXT 1421=head1 THE SELECTION: SELECTING AND PASTING TEXT
1340 1422
1341The behaviour of text selection and insertion/pasting mechanism is similar 1423The behaviour of text selection and insertion/pasting mechanism is similar
1342to I<xterm>(1). 1424to I<xterm>(1).
1343 1425
1344=over 4 1426=over
1345 1427
1346=item B<Selecting>: 1428=item B<Selecting>:
1347 1429
1348Left click at the beginning of the region, drag to the end of the region 1430Left click at the beginning of the region, drag to the end of the region
1349and release; Right click to extend the marked region; Left double-click 1431and release; Right click to extend the marked region; Left double-click
1364B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1446B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1365 1447
1366Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1448Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1367inserted too. 1449inserted too.
1368 1450
1451rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1452<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1453binding causes the value of the internal selection to be copied to the
1454CLIPBOARD selection, while the second binding causes the value of the
1455CLIPBOARD selection to be inserted.
1456
1369=back 1457=back
1370 1458
1371=head1 CHANGING FONTS 1459=head1 CHANGING FONTS
1372 1460
1373Changing fonts (or font sizes, respectively) via the keypad is not yet 1461Changing fonts (or font sizes, respectively) via the keypad is not yet
1390and character codes using the keyboard. It consists of 4 parts. The 1478and character codes using the keyboard. It consists of 4 parts. The
1391first part is available if rxvt-unicode has been compiled with 1479first part is available if rxvt-unicode has been compiled with
1392C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1480C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1393with C<--enable-iso14755>. 1481with C<--enable-iso14755>.
1394 1482
1395=over 4 1483=over
1396 1484
1397=item * 5.1: Basic method 1485=item * 5.1: Basic method
1398 1486
1399This allows you to enter unicode characters using their hexcode. 1487This allows you to enter unicode characters using their hexcode.
1400 1488
1461In addition to the default foreground and background colours, 1549In addition to the default foreground and background colours,
1462B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1550B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1463high-intensity (potentially bold/blink) versions of the same, and 72 (or 1551high-intensity (potentially bold/blink) versions of the same, and 72 (or
1464240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1552240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1465cube plus a 8 (24) colour greyscale ramp. 1553cube plus a 8 (24) colour greyscale ramp.
1554
1555B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1556C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1557number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1558colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
155924-bit colour space. When indexing collisions happen, the nearest old colour in
1560the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1561use many similar 24-bit colours. It's typically not a problem in common
1562scenarios.
1466 1563
1467Here is a list of the ANSI colours with their names. 1564Here is a list of the ANSI colours with their names.
1468 1565
1469=begin table 1566=begin table
1470 1567
1497The following text gives values for the standard 88 colour mode (and 1594The following text gives values for the standard 88 colour mode (and
1498values for the 256 colour mode in parentheses). 1595values for the 256 colour mode in parentheses).
1499 1596
1500The RGB cube uses indices 16..79 (16..231) using the following formulas: 1597The RGB cube uses indices 16..79 (16..231) using the following formulas:
1501 1598
1502 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1599 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1503 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1600 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1504 1601
1505The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1602The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1506steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1603steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1507the RGB cube. 1604the RGB cube.
1508 1605
1524White. 1621White.
1525 1622
1526=head2 ALPHA CHANNEL SUPPORT 1623=head2 ALPHA CHANNEL SUPPORT
1527 1624
1528If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1625If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1529their act together, rxvt-unicode will do it's own alpha channel management: 1626their act together, rxvt-unicode will do its own alpha channel management:
1530 1627
1531You can prefix any colour with an opaqueness percentage enclosed in 1628You can prefix any colour with an opaqueness percentage enclosed in
1532brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1629brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1533(0-100) that specifies the opacity of the colour, where C<0> is completely 1630(0-100) that specifies the opacity of the colour, where C<0> is completely
1534transparent and C<100> is completely opaque. For example, C<[50]red> is a 1631transparent and C<100> is completely opaque. For example, C<[50]red> is a
1571 1668
1572=head1 ENVIRONMENT 1669=head1 ENVIRONMENT
1573 1670
1574B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1671B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1575 1672
1576=over 4 1673=over
1577 1674
1578=item B<TERM> 1675=item B<TERM>
1579 1676
1580Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1677Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1581resources or on the command line. 1678resources or on the command line.
1616 1713
1617=item B<SHELL> 1714=item B<SHELL>
1618 1715
1619The shell to be used for command execution, defaults to C</bin/sh>. 1716The shell to be used for command execution, defaults to C</bin/sh>.
1620 1717
1621=item B<RXVT_SOCKET> 1718=item B<RXVT_SOCKET> [I<sic>]
1622 1719
1623The unix domain socket path used by @@RXVT_NAME@@c(1) and 1720The unix domain socket path used by @@RXVT_NAME@@c(1) and
1624@@RXVT_NAME@@d(1). 1721@@RXVT_NAME@@d(1).
1625 1722
1626Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1723Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1724
1725=item B<URXVT_PERL_LIB>
1726
1727Additional F<:>-separated library search path for perl extensions. Will be
1728searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1729directory.
1730
1731=item B<URXVT_PERL_VERBOSITY>
1732
1733See L<@@RXVT_NAME@@perl>(3).
1627 1734
1628=item B<HOME> 1735=item B<HOME>
1629 1736
1630Used to locate the default directory for the unix domain socket for 1737Used to locate the default directory for the unix domain socket for
1631daemon communications and to locate various resource files (such as 1738daemon communications and to locate various resource files (such as
1632C<.Xdefaults>) 1739C<.Xdefaults>)
1633 1740
1634=item B<XAPPLRESDIR> 1741=item B<XAPPLRESDIR>
1635 1742
1636Directory where various X resource files are being located. 1743Directory where application-specific X resource files are located.
1637 1744
1638=item B<XENVIRONMENT> 1745=item B<XENVIRONMENT>
1639 1746
1640If set and accessible, gives the name of a X resource file to be loaded by 1747If set and accessible, gives the name of a X resource file to be loaded by
1641@@RXVT_NAME@@. 1748@@RXVT_NAME@@.
1642 1749
1643=back 1750=back
1644 1751
1645=head1 FILES 1752=head1 FILES
1646 1753
1647=over 4 1754=over
1648 1755
1649=item B</usr/lib/X11/rgb.txt> 1756=item B</usr/lib/X11/rgb.txt>
1650 1757
1651Colour names. 1758Colour names.
1652 1759
1653=back 1760=back
1654 1761
1655=head1 SEE ALSO 1762=head1 SEE ALSO
1656 1763
1764@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1657@@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) 1765@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1658 1766
1659=head1 CURRENT PROJECT COORDINATOR 1767=head1 CURRENT PROJECT COORDINATOR
1660 1768
1661=over 4 1769=over
1662 1770
1663=item Project Coordinator 1771=item Project Coordinator
1664 1772
1665Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1773Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1666 1774
1667L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1775L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1668 1776
1669=back 1777=back
1670 1778
1671=head1 AUTHORS 1779=head1 AUTHORS
1672 1780
1673=over 4 1781=over
1674 1782
1675=item John Bovey 1783=item John Bovey
1676 1784
1677University of Kent, 1992, wrote the original Xvt. 1785University of Kent, 1992, wrote the original Xvt.
1678 1786
1679=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1787=item Rob Nation <nation@rocket.sanders.lockheed.com>
1680 1788
1681very heavily modified Xvt and came up with Rxvt 1789very heavily modified Xvt and came up with Rxvt
1682 1790
1683=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1791=item Angelo Haritsis <ah@doc.ic.ac.uk>
1684 1792
1685wrote the Greek Keyboard Input (no longer in code) 1793wrote the Greek Keyboard Input (no longer in code)
1686 1794
1687=item mj olesen L<< <olesen@me.QueensU.CA> >> 1795=item mj olesen <olesen@me.QueensU.CA>
1688 1796
1689Wrote the menu system. 1797Wrote the menu system.
1690 1798
1691Project Coordinator (changes.txt 2.11 to 2.21) 1799Project Coordinator (changes.txt 2.11 to 2.21)
1692 1800
1693=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1801=item Oezguer Kesim <kesim@math.fu-berlin.de>
1694 1802
1695Project Coordinator (changes.txt 2.21a to 2.4.5) 1803Project Coordinator (changes.txt 2.21a to 2.4.5)
1696 1804
1697=item Geoff Wing L<< <gcw@pobox.com> >> 1805=item Geoff Wing <gcw@pobox.com>
1698 1806
1699Rewrote screen display and text selection routines. 1807Rewrote screen display and text selection routines.
1700 1808
1701Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1809Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1702 1810
1703=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1811=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1704 1812
1705Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1813Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1706extension, random hacks, numerous bugfixes and extensions. 1814extension, random hacks, numerous bugfixes and extensions.
1707 1815
1708Project Coordinator (Changes 1.0 -) 1816Project Coordinator (Changes 1.0 -)
1709 1817
1710=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1818=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1711 1819
1712Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1820pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1713 1821
1714=back 1822=back
1715 1823

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines