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.177 by root, Sun May 23 00:48:53 2010 UTC vs.
Revision 1.255 by root, Sat Jul 24 11:00:58 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>: 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>: 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
… …
571You can set and change the resources using X11 tools like B<xrdb>. Many 551You 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 552distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 553starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 554with later settings overwriting earlier ones:
575 555
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 556 1. app-defaults file in $XAPPLRESDIR
557 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 558 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 559 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 560 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 561 6. resources specified via -xrm on the commandline
582 562
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 563Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 564names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
… …
589be used. Command-line arguments can be used to override resource 569be used. Command-line arguments can be used to override resource
590settings. The following resources are supported (you might want to 570settings. The following resources are supported (you might want to
591check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 571check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
592extensions not documented here): 572extensions not documented here):
593 573
594=over 4 574=over
595 575
596=item B<depth:> I<bitdepth> 576=item B<depth:> I<bitdepth>
597 577
598Compile I<xft>: Attempt to find a visual with the given bit depth; 578Compile I<xft>: Attempt to find a visual with the given bit depth;
599option B<-depth>. 579option B<-depth>.
… …
700 680
701B<False>: specify that everything is to be displayed, even 681B<False>: specify that everything is to be displayed, even
702if the refresh is too fast for the human eye to read anything (or the 682if the refresh is too fast for the human eye to read anything (or the
703monitor to display anything); option B<+ss>. 683monitor to display anything); option B<+ss>.
704 684
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> 685=item B<fading:> I<number>
716 686
717Fade the text by the given percentage when focus is lost; option B<-fade>. 687Fade the text by the given percentage when focus is lost; option B<-fade>.
718 688
719=item B<fadeColor:> I<colour> 689=item B<fadeColor:> I<colour>
720 690
721Fade to this colour, when fading is used (see B<fading:>). The default 691Fade to this colour, when fading is used (see B<fading:>). The default
722colour is black; option B<-fadecolor>. 692colour is black; option B<-fadecolor>.
723 693
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> 694=item B<iconFile:> I<file>
744 695
745Set the application icon pixmap; option B<-icon>. 696Set the application icon pixmap; option B<-icon>.
746 697
747=item B<scrollColor:> I<colour> 698=item B<scrollColor:> I<colour>
… …
755 706
756=item B<borderColor:> I<colour> 707=item B<borderColor:> I<colour>
757 708
758The colour of the border around the text area and between the scrollbar 709The colour of the border around the text area and between the scrollbar
759and the text. 710and 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<0x0+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. A scale
768of 1 displays the image without any scaling. A scale of 2 to 9 specifies
769an integer number of images in that direction. No image will be magnified
770beyond 10 times its original size. The maximum permitted scale is 1000.
771Additional operations can be specified after colon B<:op1:op2...>.
772Supported operations are:
773
774 tile force background image to be tiled and not scaled. Equivalent to 0x0
775 propscale will scale image keeping proportions
776 auto will scale image to match window size. Equivalent to 100x100
777 hscale will scale image horizontally to the window size
778 vscale will scale image vertically to the window size
779 scale will scale image to match window size
780 root will tile image as if it was a root window background, auto-adjusting
781 whenever terminal window moves
782
783If used in conjunction with B<-tr> option, the specified pixmap will be
784blended over transparency image using either alpha-blending, or any
785other blending type, specified with B<-blt "type"> option.
786
787=item B<path:> I<path>
788
789Specify the colon-delimited search path for finding background image files.
790 711
791=item B<font:> I<fontlist> 712=item B<font:> I<fontlist>
792 713
793Select the fonts to be used. This is a comma separated list of font names 714Select the fonts to be used. This is a comma separated list of font names
794that are checked in order when trying to find glyphs for characters. The 715that are checked in order when trying to find glyphs for characters. The
… …
891 812
892B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 813B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
893the shell; option B<-ls>. B<False>: start as a normal sub-shell 814the shell; option B<-ls>. B<False>: start as a normal sub-shell
894[default]; option B<+ls>. 815[default]; option B<+ls>.
895 816
817=item B<multiClickTime:> I<number>
818
819Specify the maximum time in milliseconds between multi-click select
820events. The default is 500 milliseconds; option B<-mc>.
821
896=item B<utmpInhibit:> I<boolean> 822=item B<utmpInhibit:> I<boolean>
897 823
898B<True>: inhibit writing record into the system log file B<utmp>; 824B<True>: inhibit writing record into the system log file B<utmp>;
899option B<-ut>. B<False>: write record into the system log file B<utmp> 825option B<-ut>. B<False>: write record into the system log file B<utmp>
900[default]; option B<+ut>. 826[default]; option B<+ut>.
… …
917=item B<scrollstyle:> I<mode> 843=item B<scrollstyle:> I<mode>
918 844
919Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 845Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
920the author's favourite. 846the author's favourite.
921 847
848=item B<thickness:> I<number>
849
850Set the scrollbar width in pixels.
851
922=item B<scrollBar:> I<boolean> 852=item B<scrollBar:> I<boolean>
923 853
924B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 854B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
925disable the scrollbar; option B<+sb>. 855disable the scrollbar; option B<+sb>.
926 856
… …
945B<False>: do not scroll to bottom when tty receives output; option 875B<False>: do not scroll to bottom when tty receives output; option
946B<+si>. 876B<+si>.
947 877
948=item B<scrollWithBuffer:> I<boolean> 878=item B<scrollWithBuffer:> I<boolean>
949 879
950B<True>: scroll with scrollback buffer when tty receives new lines (and 880B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
951B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 881try to show the same lines) and B<scrollTtyOutput> is False; option
952with scrollback buffer when tty receives new lines; option B<+sw>. 882B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
883new lines; option B<+sw>.
953 884
954=item B<scrollTtyKeypress:> I<boolean> 885=item B<scrollTtyKeypress:> I<boolean>
955 886
956B<True>: scroll to bottom when a non-special key is pressed. Special keys 887B<True>: scroll to bottom when a non-special key is pressed. Special keys
957are those which are intercepted by rxvt-unicode for special handling and 888are those which are intercepted by rxvt-unicode for special handling and
958are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 889are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
959bottom when a non-special key is pressed; option B<+sk>. 890bottom when a non-special key is pressed; option B<+sk>.
960 891
961=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
962 893
963Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
964resource is limited on most machines to 65535; option B<-sl>.
965 895
966=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
967 897
968Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
969option B<-b>. 899option B<-b>.
… …
1032 962
1033=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
1034 964
1035Mouse pointer background colour. 965Mouse pointer background colour.
1036 966
967=item B<pointerShape:> I<string>
968
969Compile I<frills>: Specifies the name of the mouse pointer shape
970[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
971file for possible values (omit the C<XC_> prefix).
972
1037=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
1038 974
1039Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
1040large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
1041 977
1042=item B<backspacekey:> I<string> 978=item B<backspacekey:> I<string>
1043 979
1044The string to send when the backspace key is pressed. If set to B<DEC> 980The string to send when the backspace key is pressed. If set to B<DEC>
1045or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 981or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1046(code 8) - which can be reversed with the appropriate DEC private mode 982(code 8) - which can be reversed with the appropriate DEC private mode
1047escape sequence. 983escape sequence.
1048 984
1049=item B<deletekey:> I<string> 985=item B<deletekey:> I<string>
1050 986
… …
1067 1003
1068B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1069 1005
1070=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
1071 1007
1072B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1073 1009
1074=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
1075 1011
1076I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
1077 1013
… …
1095 1031
1096Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1097button. Instead of selecting a full line it will extend the selection to 1033button. Instead of selecting a full line it will extend the selection to
1098the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1099 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
1100=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1101 1041
1102Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1103echo arbitrary strings like the icon name or the locale. This could be 1043echo arbitrary strings like the icon name or the locale. This could be
1104abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1105through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1106write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1107default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
… …
1125 1065
1126=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1127 1067
1128Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1129 1069
1070=item B<rewrapMode:> I<mode>
1071
1072Sets long line rewrap behaviour on window resize to one of B<auto>
1073(default), B<always> or B<never>.
1074
1130=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1131 1076
1132Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1133option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1134scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
… …
1146Sets the working directory for the shell (or the command specified via 1091Sets the working directory for the shell (or the command specified via
1147B<-e>). The I<path> must be an absolute path and it must exist for 1092B<-e>). The I<path> must be an absolute path and it must exist for
1148@@RXVT_NAME@@ to start. If it isn't specified then the current working 1093@@RXVT_NAME@@ to start. If it isn't specified then the current working
1149directory will be used; option B<-cd>. 1094directory will be used; option B<-cd>.
1150 1095
1151=item B<keysym.>I<sym>: I<string> 1096=item B<keysym.>I<sym>: I<action>
1152 1097
1153Compile I<frills>: Associate I<string> with keysym I<sym>. The 1098Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1154intervening resource name B<keysym.> cannot be omitted. 1099resource name B<keysym.> cannot be omitted.
1155 1100
1156The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1101Using this resource, you can map key combinations such as
1157any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1102C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1158B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1103string than would normally result from that combination, making the
1159and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1104terminal scroll up or down the way you want it, or any other thing an
1160B<2>, B<3>, B<4>, B<5>. 1105extension might provide.
1106
1107The key combination that triggers the action, I<sym>, has the following format:
1108
1109 (modifiers-)key
1110
1111Where I<modifiers> can be any combination of the following full or
1112abbreviated modifier names:
1113
1114=begin table
1115
1116 B<ISOLevel3> B<I>
1117 B<AppKeypad> B<K>
1118 B<Control> B<C>
1119 B<NumLock> B<N>
1120 B<Shift> B<S>
1121 B<Meta> B<M> I<or> B<A>
1122 B<Lock> B<L>
1123 B<Mod1> B<1>
1124 B<Mod2> B<2>
1125 B<Mod3> B<3>
1126 B<Mod4> B<4>
1127 B<Mod5> B<5>
1128
1129=end table
1161 1130
1162The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1131The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1163whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1132whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1164keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1133keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1165current application keymap mode state. 1134current application keymap mode state.
1166 1135
1167The spellings of I<key> can be obtained by using B<xev>(1) command or 1136Due the the large number of modifier combinations, a key mapping will
1168searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1137match if I<at least> the specified identifiers are being set, and no other
1138key mappings with those and more bits are being defined. That means that
1139defining a mapping for C<a> will automatically provide definitions for
1140C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1141themselves. See the C<builtin:> action, below, for a way to work around
1142this when this is a problem.
1143
1144The spelling of I<key> depends on your implementation of X. An easy way to
1145find a key name is to use the B<xev>(1) command. You can find a list by
1146looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1169omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1147the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1170keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1148value (B<0x0000 - 0xFFFF>).
1171performed in an exact manner; however, the closest match is assured.
1172 1149
1173I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1150As with any resource value, the I<action> string may contain backslash
1151escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1174number), see RESOURCES in C<man 7 X> for futher details. 1152number), see RESOURCES in C<man 7 X> for further details.
1175 1153
1176You can define a range of keysyms in one shot by providing a I<string> 1154An action starts with an action prefix that selects a certain type
1177with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1155of action, followed by a colon. An action string without colons is
1156interpreted as a literal string to pass to the tty (as if it was
1157prefixed with C<string:>).
1158
1159The following action prefixes are known - extensions can provide
1160additional prefixes:
1161
1162=over
1163
1164=item string:STRING
1165
1166If the I<action> starts with C<string:> (or otherwise contains no colons),
1167then the remaining C<STRING> will be passed to the program running in the
1168terminal. For example, you could replace whatever Shift-Tab outputs by the
1169string C<echo rm -rf /> followed by a newline:
1170
1171 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1172
1173This could in theory be used to completely redefine your keymap.
1174
1175In addition, for actions of this type, you can define a range of
1176keysyms in one shot by loading the C<keysym-list> perl extension and
1177providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1178should be a character not used by the strings. 1178the delimiter `/' should be a character not used by the strings.
1179 1179
1180Its usage can be demonstrated by an example: 1180Its usage can be demonstrated by an example:
1181 1181
1182 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1182 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1183 1183
1184The above line is equivalent to the following three lines: 1184The above line is equivalent to the following three lines:
1185 1185
1186 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1186 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1187 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1187 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1188 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1188 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1189 1189
1190=item command:STRING
1191
1190If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1192If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1191is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1193is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1194the opposite of C<string:> - instead of sending it to the program running
1195in the terminal, it will be treated as if it were program output). This is
1196most useful to feed command sequences into @@RXVT_NAME@@.
1197
1192example the following means "change the current locale to C<zh_CN.GBK> 1198For example the following means "change the current locale to C<zh_CN.GBK>
1193when Control-Meta-c is being pressed": 1199when Control-Meta-c is being pressed":
1194 1200
1195 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1201 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1196 1202
1197If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1203The following example will map Control-Meta-1 and Control-Meta-2 to
1198is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1204the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1199manpage. For example, the F<selection> extension (activated via 1205font-switching at runtime:
1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1201 1206
1202 URxvt.keysym.M-C-c: perl:selection:rot13 1207 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1208 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1203 1209
1204Due the the large number of modifier combinations, a defined key mapping 1210Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1205will match if at I<at least> the specified identifiers are being set, and 1211info):
1206no other key mappings with those and more bits are being defined. That
1207means that defining a key map for C<a> will automatically provide
1208definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1209mappings themselves.
1210 1212
1211Unfortunately, this will override built-in key mappings. For example 1213 URxvt.keysym.M-C-3: command:\033[8;25;80t
1214 URxvt.keysym.M-C-4: command:\033[8;48;110t
1215
1216=item builtin:
1217
1218The builtin action is the action that @@RXVT_NAME@@ would execute if no
1219key binding existed for the key combination. The obvious use is to undo
1220the effect of existing bindings. The not so obvious use is to reinstate
1221bindings when another binding overrides too many modifiers.
1222
1212if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1223For example if you overwrite the C<Insert> key you will disable
1213C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1224@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1214user-defined keymap using the C<builtin:> replacement: 1225"holes" into the user-defined keymap using the C<builtin:> replacement:
1215 1226
1216 URxvt.keysym.Insert: <my insert key sequence> 1227 URxvt.keysym.Insert: <my insert key sequence>
1217 URxvt.keysym.S-Insert: builtin: 1228 URxvt.keysym.S-Insert: builtin:
1218 1229
1219The first line defines a mapping for C<Insert> and I<any> combination 1230The first line defines a mapping for C<Insert> and I<any> combination
1220of modifiers. The second line re-establishes the default mapping for 1231of modifiers. The second line re-establishes the default mapping for
1221C<Shift-Insert>. 1232C<Shift-Insert>.
1222 1233
1223The following example will map Control-Meta-1 and Control-Meta-2 to 1234=item builtin-string:
1224the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1225font-switching at runtime:
1226 1235
1227 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1236This action is mainly useful to restore string mappings for keys that
1228 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1237have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1238difficult to explain - basically, this action will send the string to the
1239application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1240action for it.
1229 1241
1230Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1242An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1231info): 1243selection when you press C<Shift-Insert>. With the following bindings, it
1244would instead emit the (undocumented, but what applications running in the
1245terminal might expect) sequence C<ESC [ 2 $> instead:
1232 1246
1233 URxvt.keysym.M-C-3: command:\033[8;25;80t 1247 URxvt.keysym.S-Insert: builtin-string:
1234 URxvt.keysym.M-C-4: command:\033[8;48;110t 1248 URxvt.keysym.C-S-Insert: builtin:
1249
1250The first line disables the paste functionality for that key
1251combination, and the second reinstates the default behaviour for
1252C<Control-Shift-Insert>, which would otherwise be overridden.
1253
1254Similarly, to let applications gain access to the C<C-M-c> (copy to
1255clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1256this:
1257
1258 URxvt.keysym.C-M-c: builtin-string:
1259 URxvt.keysym.C-M-v: builtin-string:
1260
1261=item EXTENSION:STRING
1262
1263An action of this form invokes the action B<STRING>, if any, provided
1264by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1265be loaded automatically if necessary.
1266
1267Not all extensions define actions, but popular extensions that do
1268include the I<selection> and I<matcher> extensions (documented in their
1269own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1270respectively).
1271
1272From the silly examples department, this will rot13-"encrypt"
1273@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1274keyboards:
1275
1276 URxvt.keysym.M-C-c: selection:rot13
1277
1278=item perl:STRING *DEPRECATED*
1279
1280This is a deprecated way of invoking commands provided by perl
1281extensions. It is still supported, but should not be used anymore.
1282
1283=back
1235 1284
1236=item B<perl-ext-common>: I<string> 1285=item B<perl-ext-common>: I<string>
1237 1286
1238=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1239 1288
1240Comma-separated list(s) of perl extension scripts (default: C<default>) to 1289Comma-separated list(s) of perl extension scripts (default: C<default>) to
1241use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1242 1291
1243Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to remove them again, in
1244them. This can be useful to selectively disable some extensions loaded 1293case they had been specified earlier. This can be useful to selectively
1245by default, or specified via the C<perl-ext-common> resource. For 1294disable some extensions loaded by default, or specified via the
1246example, C<default,-selection> will use all the default extension except 1295C<perl-ext-common> resource. For example, C<default,-selection> will use
1247C<selection>. 1296all the default extensions except C<selection>.
1248 1297
1249Extension names can also be followed by an argument in angle brackets 1298To prohibit autoloading of extensions, you can prefix them with C</>,
1250(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1299which will make urxvt refuse to automatically load them (this can be
1251searchable scrollback to Alt/Meta-s). Mentioning the same extension 1300overriden, however, by specifying the extension name again without a
1252multiple times with different arguments will pass multiple arguments to 1301prefix, though). This does not prohibit extensions themselves loading
1253the extension. 1302other extensions. For example, C<default,/background> will keep the
1303C<background> extension from being loaded when a background OSC sequence
1304is received.
1305
1306The default set includes the C<selection>, C<option-popup>,
1307C<selection-popup>, C<readline>, C<searchable-scrollback> and
1308C<confirm-paste> extensions, as well as any extensions which are mentioned
1309in B<keysym> resources.
1310
1311Any extension such that a corresponding resource is given on the
1312command line is automatically appended to B<perl-ext>.
1254 1313
1255Each extension is looked up in the library directories, loaded if 1314Each extension is looked up in the library directories, loaded if
1256necessary, and bound to the current terminal instance. 1315necessary, and bound to the current terminal instance. When the library
1316search path contains multiple extension files of the same name, then the
1317first one found will be used.
1257 1318
1258If both of these resources are the empty string, then the perl 1319If both of these resources are the empty string, then the perl interpreter
1259interpreter will not be initialized. The idea behind two options is that 1320will not be initialized. The rationale for having two options is that
1260B<perl-ext-common> will be used for extensions that should be available to 1321B<perl-ext-common> will be used for extensions that should be available to
1261all instances, while B<perl-ext> is used for specific instances. 1322all instances, while B<perl-ext> is used for specific instances.
1262 1323
1263=item B<perl-eval>: I<string> 1324=item B<perl-eval>: I<string>
1264 1325
… …
1266the @@RXVT_NAME@@perl(3) manpage. 1327the @@RXVT_NAME@@perl(3) manpage.
1267 1328
1268=item B<perl-lib>: I<path> 1329=item B<perl-lib>: I<path>
1269 1330
1270Colon-separated list of additional directories that hold extension 1331Colon-separated list of additional directories that hold extension
1271scripts. When looking for extensions specified by the C<perl> resource, 1332scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1272@@RXVT_NAME@@ will first look in these directories and then in 1333in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1273F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1334lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1274 1335
1275See the @@RXVT_NAME@@perl(3) manpage. 1336See the @@RXVT_NAME@@perl(3) manpage.
1276 1337
1277=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1338=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1278 1339
… …
1282=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1343=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1283 1344
1284Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1345Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1285for details. 1346for details.
1286 1347
1287=item B<searchable-scrollback:> I<keysym> 1348=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1288 1349
1289Sets the hotkey that starts the incremental scrollback buffer search 1350This resource is deprecated and will be removed. Use a B<keysym> resource
1290(default: C<M-s>). 1351instead, e.g.:
1291 1352
1353 URxvt.keysym.M-s: searchable-scrollback:start
1354
1292=item B<urlLauncher>: I<string> 1355=item B<url-launcher>: I<string>
1293 1356
1294Specifies the program to be started with a URL argument. Used by the 1357Specifies the program to be started with a URL argument. Used by the
1295C<selection-popup> and C<matcher> perl extensions. 1358C<selection-popup> and C<matcher> perl extensions.
1296 1359
1297=item B<transient-for>: I<windowid> 1360=item B<transient-for>: I<windowid>
… …
1341=head1 THE SELECTION: SELECTING AND PASTING TEXT 1404=head1 THE SELECTION: SELECTING AND PASTING TEXT
1342 1405
1343The behaviour of text selection and insertion/pasting mechanism is similar 1406The behaviour of text selection and insertion/pasting mechanism is similar
1344to I<xterm>(1). 1407to I<xterm>(1).
1345 1408
1346=over 4 1409=over
1347 1410
1348=item B<Selecting>: 1411=item B<Selecting>:
1349 1412
1350Left click at the beginning of the region, drag to the end of the region 1413Left click at the beginning of the region, drag to the end of the region
1351and release; Right click to extend the marked region; Left double-click 1414and release; Right click to extend the marked region; Left double-click
… …
1366B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1429B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1367 1430
1368Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1431Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1369inserted too. 1432inserted too.
1370 1433
1434rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1435<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1436binding causes the value of the internal selection to be copied to the
1437CLIPBOARD selection, while the second binding causes the value of the
1438CLIPBOARD selection to be inserted.
1439
1371=back 1440=back
1372 1441
1373=head1 CHANGING FONTS 1442=head1 CHANGING FONTS
1374 1443
1375Changing fonts (or font sizes, respectively) via the keypad is not yet 1444Changing fonts (or font sizes, respectively) via the keypad is not yet
… …
1392and character codes using the keyboard. It consists of 4 parts. The 1461and character codes using the keyboard. It consists of 4 parts. The
1393first part is available if rxvt-unicode has been compiled with 1462first part is available if rxvt-unicode has been compiled with
1394C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1463C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1395with C<--enable-iso14755>. 1464with C<--enable-iso14755>.
1396 1465
1397=over 4 1466=over
1398 1467
1399=item * 5.1: Basic method 1468=item * 5.1: Basic method
1400 1469
1401This allows you to enter unicode characters using their hexcode. 1470This allows you to enter unicode characters using their hexcode.
1402 1471
… …
1459on some systems or setgid to root or to some other group on others. 1528on some systems or setgid to root or to some other group on others.
1460 1529
1461=head1 COLOURS AND GRAPHICS 1530=head1 COLOURS AND GRAPHICS
1462 1531
1463In addition to the default foreground and background colours, 1532In addition to the default foreground and background colours,
1464B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1533B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1465high-intensity bold/blink versions of the same). Here is a list of the 1534high-intensity (potentially bold/blink) versions of the same, and 72 (or
1466colours with their names. 1535240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1536cube plus a 8 (24) colour greyscale ramp.
1537
1538B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1539C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1540number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1541colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
154224-bit colour space. When indexing collisions happen, the nearest old colour in
1543the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1544use many similar 24-bit colours. It's typically not a problem in common
1545scenarios.
1546
1547Here is a list of the ANSI colours with their names.
1467 1548
1468=begin table 1549=begin table
1469 1550
1470 B<color0> (black) = Black 1551 B<color0> (black) = Black
1471 B<color1> (red) = Red3 1552 B<color1> (red) = Red3
… …
1491It is also possible to specify the colour values of B<foreground>, 1572It is also possible to specify the colour values of B<foreground>,
1492B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1573B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1493a number 0-15, as a convenient shorthand to reference the colour name of 1574a number 0-15, as a convenient shorthand to reference the colour name of
1494color0-color15. 1575color0-color15.
1495 1576
1496In addition to the colours defined above, @@RXVT_NAME@@ offers an 1577The following text gives values for the standard 88 colour mode (and
1497additional 72 colours. The first 64 of those (with indices 16 to 79) 1578values for the 256 colour mode in parentheses).
1498consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
149916>), followed by 8 additional shades of gray (with indices 80 to 87).
1500 1579
1580The RGB cube uses indices 16..79 (16..231) using the following formulas:
1581
1582 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1583 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1584
1585The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1586steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1587the RGB cube.
1588
1501Together, all those colours implement the 88 colour xterm colours. Only 1589Together, all those colours implement the 88 (256) colour xterm
1502the first 16 can be changed using resources currently, the rest can only 1590colours. Only the first 16 can be changed using resources currently, the
1503be changed via command sequences ("escape codes"). 1591rest can only be changed via command sequences ("escape codes").
1592
1593Applications are advised to use terminfo or command sequences to discover
1594number and RGB values of all colours (yes, you can query this...).
1504 1595
1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1596Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1506always swapping the foreground/background colours. This is in contrast to 1597always swapping the foreground/background colours. This is in contrast to
1507I<xterm>(1) where the colours are only swapped if they have not otherwise 1598I<xterm>(1) where the colours are only swapped if they have not otherwise
1508been specified. For example, 1599been specified. For example,
… …
1513White. 1604White.
1514 1605
1515=head2 ALPHA CHANNEL SUPPORT 1606=head2 ALPHA CHANNEL SUPPORT
1516 1607
1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1608If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1518their act together, rxvt-unicode will do it's own alpha channel management: 1609their act together, rxvt-unicode will do its own alpha channel management:
1519 1610
1520You can prefix any colour with an opaquenes percentage enclosed in 1611You can prefix any colour with an opaqueness percentage enclosed in
1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1612brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1522(0-100) that specifies the opacity of the colour, where C<0> is completely 1613(0-100) that specifies the opacity of the colour, where C<0> is completely
1523transparent and C<100> is completely opaque. For example, C<[50]red> is a 1614transparent and C<100> is completely opaque. For example, C<[50]red> is a
1524half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1615half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1525is the recommended format to specify transparency values, and works with 1616is the recommended format to specify transparency values, and works with
… …
1560 1651
1561=head1 ENVIRONMENT 1652=head1 ENVIRONMENT
1562 1653
1563B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1654B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1564 1655
1565=over 4 1656=over
1566 1657
1567=item B<TERM> 1658=item B<TERM>
1568 1659
1569Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1660Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1570resources or on the command line. 1661resources or on the command line.
… …
1605 1696
1606=item B<SHELL> 1697=item B<SHELL>
1607 1698
1608The shell to be used for command execution, defaults to C</bin/sh>. 1699The shell to be used for command execution, defaults to C</bin/sh>.
1609 1700
1610=item B<RXVT_SOCKET> 1701=item B<RXVT_SOCKET> [I<sic>]
1611 1702
1612The unix domain socket path used by @@RXVT_NAME@@c(1) and 1703The unix domain socket path used by @@RXVT_NAME@@c(1) and
1613@@RXVT_NAME@@d(1). 1704@@RXVT_NAME@@d(1).
1614 1705
1615Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1706Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1707
1708=item B<URXVT_PERL_LIB>
1709
1710Additional F<:>-separated library search path for perl extensions. Will be
1711searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1712directory.
1713
1714=item B<URXVT_PERL_VERBOSITY>
1715
1716See L<@@RXVT_NAME@@perl>(3).
1616 1717
1617=item B<HOME> 1718=item B<HOME>
1618 1719
1619Used to locate the default directory for the unix domain socket for 1720Used to locate the default directory for the unix domain socket for
1620daemon communications and to locate various resource files (such as 1721daemon communications and to locate various resource files (such as
1621C<.Xdefaults>) 1722C<.Xdefaults>)
1622 1723
1623=item B<XAPPLRESDIR> 1724=item B<XAPPLRESDIR>
1624 1725
1625Directory where various X resource files are being located. 1726Directory where application-specific X resource files are located.
1626 1727
1627=item B<XENVIRONMENT> 1728=item B<XENVIRONMENT>
1628 1729
1629If set and accessible, gives the name of a X resource file to be loaded by 1730If set and accessible, gives the name of a X resource file to be loaded by
1630@@RXVT_NAME@@. 1731@@RXVT_NAME@@.
1631 1732
1632=back 1733=back
1633 1734
1634=head1 FILES 1735=head1 FILES
1635 1736
1636=over 4 1737=over
1637 1738
1638=item B</usr/lib/X11/rgb.txt> 1739=item B</usr/lib/X11/rgb.txt>
1639 1740
1640Colour names. 1741Colour names.
1641 1742
1642=back 1743=back
1643 1744
1644=head1 SEE ALSO 1745=head1 SEE ALSO
1645 1746
1747@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1646@@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) 1748@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1647 1749
1648=head1 CURRENT PROJECT COORDINATOR 1750=head1 CURRENT PROJECT COORDINATOR
1649 1751
1650=over 4 1752=over
1651 1753
1652=item Project Coordinator 1754=item Project Coordinator
1653 1755
1654Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1756Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1655 1757
1656L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1758L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1657 1759
1658=back 1760=back
1659 1761
1660=head1 AUTHORS 1762=head1 AUTHORS
1661 1763
1662=over 4 1764=over
1663 1765
1664=item John Bovey 1766=item John Bovey
1665 1767
1666University of Kent, 1992, wrote the original Xvt. 1768University of Kent, 1992, wrote the original Xvt.
1667 1769
1668=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1770=item Rob Nation <nation@rocket.sanders.lockheed.com>
1669 1771
1670very heavily modified Xvt and came up with Rxvt 1772very heavily modified Xvt and came up with Rxvt
1671 1773
1672=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1774=item Angelo Haritsis <ah@doc.ic.ac.uk>
1673 1775
1674wrote the Greek Keyboard Input (no longer in code) 1776wrote the Greek Keyboard Input (no longer in code)
1675 1777
1676=item mj olesen L<< <olesen@me.QueensU.CA> >> 1778=item mj olesen <olesen@me.QueensU.CA>
1677 1779
1678Wrote the menu system. 1780Wrote the menu system.
1679 1781
1680Project Coordinator (changes.txt 2.11 to 2.21) 1782Project Coordinator (changes.txt 2.11 to 2.21)
1681 1783
1682=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1784=item Oezguer Kesim <kesim@math.fu-berlin.de>
1683 1785
1684Project Coordinator (changes.txt 2.21a to 2.4.5) 1786Project Coordinator (changes.txt 2.21a to 2.4.5)
1685 1787
1686=item Geoff Wing L<< <gcw@pobox.com> >> 1788=item Geoff Wing <gcw@pobox.com>
1687 1789
1688Rewrote screen display and text selection routines. 1790Rewrote screen display and text selection routines.
1689 1791
1690Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1792Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1691 1793
1692=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1794=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1693 1795
1694Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1796Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1695extension, random hacks, numerous bugfixes and extensions. 1797extension, random hacks, numerous bugfixes and extensions.
1696 1798
1697Project Coordinator (Changes 1.0 -) 1799Project Coordinator (Changes 1.0 -)
1698 1800
1699=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1801=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1700 1802
1701Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1803pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1702 1804
1703=back 1805=back
1704 1806

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines