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.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC vs.
Revision 1.242 by sf-exg, Fri Dec 26 21:49:11 2014 UTC

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 132
134=item B<-fade> I<number> 133=item B<-fade> I<number>
135 134
136Fade 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
137fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
140=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
141 140
142Fade 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
143is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
144 143
145=item B<-tint> I<colour>
146
147Tint the transparent background pixmap with the given colour when
148transparency is enabled with B<-tr>. This only works for
149non-tiled backgrounds, currently. See also the B<-sh> option that can be
150used to brighten or darken the image in addition to tinting it.
151Please note that certain tint colours can be applied on the server-side,
152thus yielding performance gain of two orders of magnitude. These colours are:
153blue, red, green, cyan, magenta, yellow, and those close to them. Also
154pure black and pure white colours essentially mean no tinting; resource
155I<tintColor>. Example:
156
157 @@RXVT_NAME@@ -tr -tint blue -sh 40
158
159=item B<-sh> I<number>
160
161Darken (0 .. 100) or lighten (100 .. 200) the transparent
162background image in addition to (or instead of) tinting it;
163resource I<shading>.
164
165=item B<-blt> I<string>
166
167Specify background blending type. If background pixmap is specified
168at the same time as transparency - such pixmap will be blended over
169transparency image, using method specified. Supported values are :
170B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
171B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
172B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
173alpha-blending. Compile I<afterimage>; resource I<blendType>.
174
175=item B<-blr> I<HxV>
176
177Apply Gaussian Blur with the specified radii to the transparent
178background image. If single number is specified - both vertical and
179horizontal radii are considered to be the same. Setting one of the
180radii to 1 and another to a large number creates interesting effects
181on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
182resource I<blurRadius>.
183
184=item B<-icon> I<file> 144=item B<-icon> I<file>
185 145
186Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 146Compile I<pixbuf>: Use the specified image as application icon. This
187is used by many window managers, taskbars and pagers to represent the 147is used by many window managers, taskbars and pagers to represent the
188application window; resource I<iconFile>. 148application window; resource I<iconFile>.
189 149
190=item B<-bg> I<colour> 150=item B<-bg> I<colour>
191 151
192Window background colour; resource B<background>. 152Window background colour; resource B<background>.
193 153
194=item B<-fg> I<colour> 154=item B<-fg> I<colour>
195 155
196Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
197
198=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
199
200Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
201optionally specify its scaling with a geometry string. Note you may need to
202add quotes to avoid special shell interpretation of the C<;> in the
203command-line; for more details see resource B<backgroundPixmap>.
204 157
205=item B<-cr> I<colour> 158=item B<-cr> I<colour>
206 159
207The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
208 161
267 220
268=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
269 222
270Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
271 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
272=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
273 230
274Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
275B<utmpInhibit>. 232B<utmpInhibit>.
276 233
354 311
355=item B<-override-redirect> 312=item B<-override-redirect>
356 313
357Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
358B<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.
359 321
360=item B<-sbg> 322=item B<-sbg>
361 323
362Compile 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
363drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
568You can set and change the resources using X11 tools like B<xrdb>. Many 530You can set and change the resources using X11 tools like B<xrdb>. Many
569distribution do also load settings from the B<~/.Xresources> file when X 531distribution do also load settings from the B<~/.Xresources> file when X
570starts. @@RXVT_NAME@@ will consult the following files/resources in order, 532starts. @@RXVT_NAME@@ will consult the following files/resources in order,
571with later settings overwriting earlier ones: 533with later settings overwriting earlier ones:
572 534
573 1. system-wide app-defaults file, either locale-dependent OR global
574 2. app-defaults file in $XAPPLRESDIR 535 1. app-defaults file in $XAPPLRESDIR
536 2. $HOME/.Xdefaults
575 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 537 3. RESOURCE_MANAGER property on root-window of screen 0
576 4. SCREEN_RESOURCES for the current screen 538 4. SCREEN_RESOURCES property on root-window of the current screen
577 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 539 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
578 6. resources specified via -xrm on the commandline 540 6. resources specified via -xrm on the commandline
579 541
580Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 542Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
581names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 543names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
697 659
698B<False>: specify that everything is to be displayed, even 660B<False>: specify that everything is to be displayed, even
699if the refresh is too fast for the human eye to read anything (or the 661if the refresh is too fast for the human eye to read anything (or the
700monitor to display anything); option B<+ss>. 662monitor to display anything); option B<+ss>.
701 663
702=item B<transparent:> I<boolean>
703
704Turn on/off illusion of a transparent window background.
705
706B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
707future versions.
708
709=item B<fading:> I<number> 664=item B<fading:> I<number>
710 665
711Fade the text by the given percentage when focus is lost; option B<-fade>. 666Fade the text by the given percentage when focus is lost; option B<-fade>.
712 667
713=item B<fadeColor:> I<colour> 668=item B<fadeColor:> I<colour>
714 669
715Fade to this colour, when fading is used (see B<fading:>). The default 670Fade to this colour, when fading is used (see B<fading:>). The default
716colour is black; option B<-fadecolor>. 671colour is black; option B<-fadecolor>.
717 672
718=item B<tintColor:> I<colour>
719
720Tint the transparent background pixmap with the given colour; option
721B<-tint>.
722
723=item B<shading:> I<number>
724
725Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
726in addition to tinting it; option B<-sh>.
727
728=item B<blendType:> I<string>
729
730Specify background blending type; option B<-blt>.
731
732=item B<blurRadius:> I<number>
733
734Apply gaussian blur with the specified radius to the transparent
735background image; option B<-blr>.
736
737=item B<iconFile:> I<file> 673=item B<iconFile:> I<file>
738 674
739Set the application icon pixmap; option B<-icon>. 675Set the application icon pixmap; option B<-icon>.
740 676
741=item B<scrollColor:> I<colour> 677=item B<scrollColor:> I<colour>
749 685
750=item B<borderColor:> I<colour> 686=item B<borderColor:> I<colour>
751 687
752The colour of the border around the text area and between the scrollbar 688The colour of the border around the text area and between the scrollbar
753and the text. 689and the text.
754
755=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
756
757Use the specified image file for the background and also
758optionally specify its scaling with a geometry string B<WxH+X+Y>,
759(default C<100x100+50+50>) in which B<"W" / "H"> specify the
760horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
761centre (percent). A scale of 0 displays the image with tiling.
762The maximum permitted scale is 1000.
763Additional operations can be specified after colon B<:op1:op2...>.
764Supported operations are:
765
766 tile force background image to be tiled and not scaled. Equivalent to 0x0
767 propscale will scale image keeping proportions
768 auto will scale image to match window size. Equivalent to 100x100
769 hscale will scale image horizontally to the window size
770 vscale will scale image vertically to the window size
771 scale will scale image to match window size
772 root will tile image as if it was a root window background, auto-adjusting
773 whenever terminal window moves
774
775If used in conjunction with B<-tr> option, the specified pixmap will be
776blended over transparency image using alpha-blending. If I<afterimage>
777support has been compiled in it is possible to choose other blending
778types with B<-blt "type"> option.
779
780=item B<path:> I<path>
781
782Specify the colon-delimited search path for finding background image files.
783 690
784=item B<font:> I<fontlist> 691=item B<font:> I<fontlist>
785 692
786Select the fonts to be used. This is a comma separated list of font names 693Select the fonts to be used. This is a comma separated list of font names
787that are checked in order when trying to find glyphs for characters. The 694that are checked in order when trying to find glyphs for characters. The
884 791
885B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 792B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
886the shell; option B<-ls>. B<False>: start as a normal sub-shell 793the shell; option B<-ls>. B<False>: start as a normal sub-shell
887[default]; option B<+ls>. 794[default]; option B<+ls>.
888 795
796=item B<multiClickTime:> I<number>
797
798Specify the maximum time in milliseconds between multi-click select
799events. The default is 500 milliseconds; option B<-mc>.
800
889=item B<utmpInhibit:> I<boolean> 801=item B<utmpInhibit:> I<boolean>
890 802
891B<True>: inhibit writing record into the system log file B<utmp>; 803B<True>: inhibit writing record into the system log file B<utmp>;
892option B<-ut>. B<False>: write record into the system log file B<utmp> 804option B<-ut>. B<False>: write record into the system log file B<utmp>
893[default]; option B<+ut>. 805[default]; option B<+ut>.
910=item B<scrollstyle:> I<mode> 822=item B<scrollstyle:> I<mode>
911 823
912Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 824Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
913the author's favourite. 825the author's favourite.
914 826
827=item B<thickness:> I<number>
828
829Set the scrollbar width in pixels.
830
915=item B<scrollBar:> I<boolean> 831=item B<scrollBar:> I<boolean>
916 832
917B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 833B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
918disable the scrollbar; option B<+sb>. 834disable the scrollbar; option B<+sb>.
919 835
938B<False>: do not scroll to bottom when tty receives output; option 854B<False>: do not scroll to bottom when tty receives output; option
939B<+si>. 855B<+si>.
940 856
941=item B<scrollWithBuffer:> I<boolean> 857=item B<scrollWithBuffer:> I<boolean>
942 858
943B<True>: scroll with scrollback buffer when tty receives new lines (and 859B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
944B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 860try to show the same lines) and B<scrollTtyOutput> is False; option
945with scrollback buffer when tty receives new lines; option B<+sw>. 861B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
862new lines; option B<+sw>.
946 863
947=item B<scrollTtyKeypress:> I<boolean> 864=item B<scrollTtyKeypress:> I<boolean>
948 865
949B<True>: scroll to bottom when a non-special key is pressed. Special keys 866B<True>: scroll to bottom when a non-special key is pressed. Special keys
950are those which are intercepted by rxvt-unicode for special handling and 867are those which are intercepted by rxvt-unicode for special handling and
1139Sets the working directory for the shell (or the command specified via 1056Sets the working directory for the shell (or the command specified via
1140B<-e>). The I<path> must be an absolute path and it must exist for 1057B<-e>). The I<path> must be an absolute path and it must exist for
1141@@RXVT_NAME@@ to start. If it isn't specified then the current working 1058@@RXVT_NAME@@ to start. If it isn't specified then the current working
1142directory will be used; option B<-cd>. 1059directory will be used; option B<-cd>.
1143 1060
1144=item B<keysym.>I<sym>: I<string> 1061=item B<keysym.>I<sym>: I<action>
1145 1062
1146Compile I<frills>: Associate I<string> with keysym I<sym>. The 1063Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1147intervening resource name B<keysym.> cannot be omitted. 1064resource name B<keysym.> cannot be omitted.
1148 1065
1149The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1066Using this resource, you can map key combinations such as
1150any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1067C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1151B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1068string than would normally result from that combination, making the
1152and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1069terminal scroll up or down the way you want it, or any other thing an
1153B<2>, B<3>, B<4>, B<5>. 1070extension might provide.
1071
1072The key combination that triggers the action, I<sym>, has the following format:
1073
1074 (modifiers-)key
1075
1076Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1077B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1078B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1079B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1154 1080
1155The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1081The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1156whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1082whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1157keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1083keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1158current application keymap mode state. 1084current application keymap mode state.
1159 1085
1160The spellings of I<key> can be obtained by using B<xev>(1) command or 1086Due the the large number of modifier combinations, a key mapping will
1161searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1087match if I<at least> the specified identifiers are being set, and no other
1088key mappings with those and more bits are being defined. That means that
1089defining a mapping for C<a> will automatically provide definitions for
1090C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1091themselves. See the C<builtin:> action, below, for a way to work around
1092this when this is a problem.
1093
1094The spelling of I<key> depends on your implementation of X. An easy way to
1095find a key name is to use the B<xev>(1) command. You can find a list by
1096looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1162omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1097the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1163keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1098value (B<0x0000 - 0xFFFF>).
1164performed in an exact manner; however, the closest match is assured.
1165 1099
1166I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1100As with any resource value, the I<action> string may contain backslash
1101escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1167number), see RESOURCES in C<man 7 X> for further details. 1102number), see RESOURCES in C<man 7 X> for further details.
1168 1103
1169You can define a range of keysyms in one shot by providing a I<string> 1104An action starts with an action prefix that selects a certain type
1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1105of action, followed by a colon. An action string without colons is
1106interpreted as a literal string to pass to the tty (as if it was
1107prefixed with C<string:>).
1108
1109The following action prefixes are known - extensions can provide
1110additional prefixes:
1111
1112=over 4
1113
1114=item string:STRING
1115
1116If the I<action> starts with C<string:> (or otherwise contains no colons),
1117then the remaining C<STRING> will be passed to the program running in the
1118terminal. For example, you could replace whatever Shift-Tab outputs by the
1119string C<echo rm -rf /> followed by a newline:
1120
1121 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1122
1123This could in theory be used to completely redefine your keymap.
1124
1125In addition, for actions of this type, you can define a range of
1126keysyms in one shot by loading the C<keysym-list> perl extension and
1127providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1171should be a character not used by the strings. 1128the delimiter `/' should be a character not used by the strings.
1172 1129
1173Its usage can be demonstrated by an example: 1130Its usage can be demonstrated by an example:
1174 1131
1175 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1132 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1176 1133
1177The above line is equivalent to the following three lines: 1134The above line is equivalent to the following three lines:
1178 1135
1179 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1136 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1180 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1137 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1181 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1138 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1182 1139
1140=item command:STRING
1141
1183If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1142If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1184is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1143is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1144the opposite of C<string:> - instead of sending it to the program running
1145in the terminal, it will be treated as if it were program output). This is
1146most useful to feed command sequences into @@RXVT_NAME@@.
1147
1185example the following means "change the current locale to C<zh_CN.GBK> 1148For example the following means "change the current locale to C<zh_CN.GBK>
1186when Control-Meta-c is being pressed": 1149when Control-Meta-c is being pressed":
1187 1150
1188 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1151 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1189 1152
1190If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1153The following example will map Control-Meta-1 and Control-Meta-2 to
1191is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1154the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1192manpage. For example, the F<selection> extension (activated via 1155font-switching at runtime:
1193C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1194 1156
1195 URxvt.keysym.M-C-c: perl:selection:rot13 1157 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1158 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1196 1159
1197Due the the large number of modifier combinations, a defined key mapping 1160Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1198will match if I<at least> the specified identifiers are being set, and 1161info):
1199no other key mappings with those and more bits are being defined. That
1200means that defining a key map for C<a> will automatically provide
1201definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1202mappings themselves.
1203 1162
1204Unfortunately, this will override built-in key mappings. For example 1163 URxvt.keysym.M-C-3: command:\033[8;25;80t
1164 URxvt.keysym.M-C-4: command:\033[8;48;110t
1165
1166=item builtin:
1167
1168The builtin action is the action that @@RXVT_NAME@@ would execute if no
1169key binding existed for the key combination. The obvious use is to undo
1170the effect of existing bindings. The not so obvious use is to reinstate
1171bindings when another binding overrides too many modifiers.
1172
1205if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1173For example if you overwrite the C<Insert> key you will disable
1206C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1174@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1207user-defined keymap using the C<builtin:> replacement: 1175"holes" into the user-defined keymap using the C<builtin:> replacement:
1208 1176
1209 URxvt.keysym.Insert: <my insert key sequence> 1177 URxvt.keysym.Insert: <my insert key sequence>
1210 URxvt.keysym.S-Insert: builtin: 1178 URxvt.keysym.S-Insert: builtin:
1211 1179
1212The first line defines a mapping for C<Insert> and I<any> combination 1180The first line defines a mapping for C<Insert> and I<any> combination
1213of modifiers. The second line re-establishes the default mapping for 1181of modifiers. The second line re-establishes the default mapping for
1214C<Shift-Insert>. 1182C<Shift-Insert>.
1215 1183
1216The following example will map Control-Meta-1 and Control-Meta-2 to 1184=item builtin-string:
1217the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1218font-switching at runtime:
1219 1185
1220 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1186This action is mainly useful to restore string mappings for keys that
1221 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1187have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1188difficult to explain - basically, this action will send the string to the
1189application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1190action for it.
1222 1191
1223Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1192An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1224info): 1193selection when you press C<Shift-Insert>. With the following bindings, it
1194would instead emit the (undocumented, but what applications running in the
1195terminal might expect) sequence C<ESC [ 2 $> instead:
1225 1196
1226 URxvt.keysym.M-C-3: command:\033[8;25;80t 1197 URxvt.keysym.S-Insert: builtin-string:
1227 URxvt.keysym.M-C-4: command:\033[8;48;110t 1198 URxvt.keysym.C-S-Insert: builtin:
1199
1200The first line disables the paste functionality for that key
1201combination, and the second reinstates the default behaviour for
1202C<Control-Shift-Insert>, which would otherwise be overridden.
1203
1204Similarly, to let applications gain access to the C<C-M-c> (copy to
1205clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1206this:
1207
1208 URxvt.keysym.C-M-c: builtin-string:
1209 URxvt.keysym.C-M-v: builtin-string:
1210
1211=item EXTENSION:STRING
1212
1213An action of this form invokes the action B<STRING>, if any, provided
1214by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1215be loaded automatically if necessary.
1216
1217Not all extensions define actions, but popular extensions that do
1218include the I<selection> and I<matcher> extensions (documented in their
1219own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1220respectively).
1221
1222From the silly examples department, this will rot13-"encrypt"
1223@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1224keyboards:
1225
1226 URxvt.keysym.M-C-c: selection:rot13
1227
1228=item perl:STRING *DEPRECATED*
1229
1230This is a deprecated way of invoking commands provided by perl
1231extensions. It is still supported, but should not be used anymore.
1232
1233=back
1228 1234
1229=item B<perl-ext-common>: I<string> 1235=item B<perl-ext-common>: I<string>
1230 1236
1231=item B<perl-ext>: I<string> 1237=item B<perl-ext>: I<string>
1232 1238
1234use in this terminal instance; option B<-pe>. 1240use in this terminal instance; option B<-pe>.
1235 1241
1236Extension names can be prefixed with a C<-> sign to prohibit using 1242Extension names can be prefixed with a C<-> sign to prohibit using
1237them. This can be useful to selectively disable some extensions loaded 1243them. This can be useful to selectively disable some extensions loaded
1238by default, or specified via the C<perl-ext-common> resource. For 1244by default, or specified via the C<perl-ext-common> resource. For
1239example, C<default,-selection> will use all the default extension except 1245example, C<default,-selection> will use all the default extensions except
1240C<selection>. 1246C<selection>.
1241 1247
1242Extension names can also be followed by an argument in angle brackets 1248The default set includes the C<selection>, C<option-popup>,
1243(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1249C<selection-popup>, C<readline> and C<searchable-scrollback>
1244searchable scrollback to Alt/Meta-s). Mentioning the same extension 1250extensions, and extensions which are mentioned in B<keysym> resources.
1245multiple times with different arguments will pass multiple arguments to 1251
1246the extension. 1252Any extension such that a corresponding resource is given on the
1253command line is automatically appended to B<perl-ext>.
1247 1254
1248Each extension is looked up in the library directories, loaded if 1255Each extension is looked up in the library directories, loaded if
1249necessary, and bound to the current terminal instance. 1256necessary, and bound to the current terminal instance. When the library
1257search path contains multiple extension files of the same name, then the
1258first one found will be used.
1250 1259
1251If both of these resources are the empty string, then the perl 1260If both of these resources are the empty string, then the perl interpreter
1252interpreter will not be initialized. The idea behind two options is that 1261will not be initialized. The rationale for having two options is that
1253B<perl-ext-common> will be used for extensions that should be available to 1262B<perl-ext-common> will be used for extensions that should be available to
1254all instances, while B<perl-ext> is used for specific instances. 1263all instances, while B<perl-ext> is used for specific instances.
1255 1264
1256=item B<perl-eval>: I<string> 1265=item B<perl-eval>: I<string>
1257 1266
1259the @@RXVT_NAME@@perl(3) manpage. 1268the @@RXVT_NAME@@perl(3) manpage.
1260 1269
1261=item B<perl-lib>: I<path> 1270=item B<perl-lib>: I<path>
1262 1271
1263Colon-separated list of additional directories that hold extension 1272Colon-separated list of additional directories that hold extension
1264scripts. When looking for extensions specified by the C<perl> resource, 1273scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1265@@RXVT_NAME@@ will first look in these directories and then in 1274in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1266F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1275lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1267 1276
1268See the @@RXVT_NAME@@perl(3) manpage. 1277See the @@RXVT_NAME@@perl(3) manpage.
1269 1278
1270=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1279=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1271 1280
1275=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1284=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1276 1285
1277Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1286Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1278for details. 1287for details.
1279 1288
1280=item B<searchable-scrollback:> I<keysym> 1289=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1281 1290
1282Sets the hotkey that starts the incremental scrollback buffer search 1291This resource is deprecated and will be removed. Use a B<keysym> resource
1283(default: C<M-s>). 1292instead, e.g.:
1284 1293
1294 URxvt.keysym.M-s: searchable-scrollback:start
1295
1285=item B<urlLauncher>: I<string> 1296=item B<url-launcher>: I<string>
1286 1297
1287Specifies the program to be started with a URL argument. Used by the 1298Specifies the program to be started with a URL argument. Used by the
1288C<selection-popup> and C<matcher> perl extensions. 1299C<selection-popup> and C<matcher> perl extensions.
1289 1300
1290=item B<transient-for>: I<windowid> 1301=item B<transient-for>: I<windowid>
1301Turn on/off ISO 14755 (default enabled). 1312Turn on/off ISO 14755 (default enabled).
1302 1313
1303=item B<iso14755_52:> I<boolean> 1314=item B<iso14755_52:> I<boolean>
1304 1315
1305Turn on/off ISO 14755 5.2 mode (default enabled). 1316Turn on/off ISO 14755 5.2 mode (default enabled).
1317
1318=back
1319
1320=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1321
1322=over 4
1323
1324=item B<-pixmap> I<file[;oplist]>
1325
1326=item B<backgroundPixmap:> I<file[;oplist]>
1327
1328Compile I<pixbuf>: Use the specified image file as the window's
1329background and also optionally specify a colon separated list of
1330operations to modify it. Note that you may need to quote the C<;>
1331character when using the command line option, as C<;> is usually a
1332metacharacter in shells. Supported operations are:
1333
1334=over 4
1335
1336=item B<WxH+X+Y>
1337
1338sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1339scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1340scale of 0 disables scaling.
1341
1342=item B<op=tile>
1343
1344enables tiling
1345
1346=item B<op=keep-aspect>
1347
1348maintain the image aspect ratio when scaling
1349
1350=item B<op=root-align>
1351
1352use the position of the terminal window relative to the root window as
1353the image offset, simulating a root window background
1354
1355=back
1356
1357The default scale and position setting is C<100x100+50+50>.
1358Alternatively, a predefined set of templates can be used to achieve
1359the most common setups:
1360
1361=over 4
1362
1363=item B<style=tiled>
1364
1365the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1366
1367=item B<style=aspect-stretched>
1368
1369the image is scaled to fill the whole window maintaining the aspect
1370ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1371
1372=item B<style=stretched>
1373
1374the image is scaled to fill the whole window. Equivalent to 100x100
1375
1376=item B<style=centered>
1377
1378the image is centered with no scaling. Equivalent to 0x0+50+50
1379
1380=item B<style=root-tiled>
1381
1382the image is tiled with no scaling and using 'root' positioning.
1383Equivalent to 0x0:op=tile:op=root-align
1384
1385=back
1386
1387If multiple templates are specified the last one wins. Note that a
1388template overrides all the scale, position and operations settings.
1389
1390If used in conjunction with pseudo-transparency, the specified pixmap
1391will be blended over the transparent background using alpha-blending.
1392
1393=item B<-tr>|B<+tr>
1394
1395=item B<transparent:> I<boolean>
1396
1397Turn on/off pseudo-transparency by using the root pixmap as background.
1398
1399B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1400will be removed in future versions.
1401
1402=item B<-tint> I<colour>
1403
1404=item B<tintColor:> I<colour>
1405
1406Tint the transparent background with the given colour. Note that a
1407black tint yields a completely black image while a white tint yields
1408the image unchanged.
1409
1410=item B<-sh> I<number>
1411
1412=item B<shading:> I<number>
1413
1414Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1415A value of 100 means no shading.
1416
1417=item B<-blr> I<HxV>
1418
1419=item B<blurRadius:> I<HxV>
1420
1421Apply gaussian blur with the specified radius to the transparent
1422background. If a single number is specified, the vertical and
1423horizontal radii are considered to be the same. Setting one of the
1424radii to 1 and the other to a large number creates interesting effects
1425on some backgrounds. The maximum radius value is 128. An horizontal or
1426vertical radius of 0 disables blurring.
1427
1428=item B<path:> I<path>
1429
1430Specify the colon-delimited search path for finding background image files.
1306 1431
1307=back 1432=back
1308 1433
1309=head1 THE SCROLLBAR 1434=head1 THE SCROLLBAR
1310 1435
1358window causes the value of the PRIMARY selection (or CLIPBOARD with the 1483window causes the value of the PRIMARY selection (or CLIPBOARD with the
1359B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1484B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1360 1485
1361Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1486Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1362inserted too. 1487inserted too.
1488
1489rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1490<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1491binding causes the value of the internal selection to be copied to the
1492CLIPBOARD selection, while the second binding causes the value of the
1493CLIPBOARD selection to be inserted.
1363 1494
1364=back 1495=back
1365 1496
1366=head1 CHANGING FONTS 1497=head1 CHANGING FONTS
1367 1498
1492The following text gives values for the standard 88 colour mode (and 1623The following text gives values for the standard 88 colour mode (and
1493values for the 256 colour mode in parentheses). 1624values for the 256 colour mode in parentheses).
1494 1625
1495The RGB cube uses indices 16..79 (16..231) using the following formulas: 1626The RGB cube uses indices 16..79 (16..231) using the following formulas:
1496 1627
1497 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1628 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1498 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1629 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1499 1630
1500The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1631The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1501steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1632steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1502the RGB cube. 1633the RGB cube.
1503 1634
1519White. 1650White.
1520 1651
1521=head2 ALPHA CHANNEL SUPPORT 1652=head2 ALPHA CHANNEL SUPPORT
1522 1653
1523If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1654If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1524their act together, rxvt-unicode will do it's own alpha channel management: 1655their act together, rxvt-unicode will do its own alpha channel management:
1525 1656
1526You can prefix any colour with an opaqueness percentage enclosed in 1657You can prefix any colour with an opaqueness percentage enclosed in
1527brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1658brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1528(0-100) that specifies the opacity of the colour, where C<0> is completely 1659(0-100) that specifies the opacity of the colour, where C<0> is completely
1529transparent and C<100> is completely opaque. For example, C<[50]red> is a 1660transparent and C<100> is completely opaque. For example, C<[50]red> is a
1611 1742
1612=item B<SHELL> 1743=item B<SHELL>
1613 1744
1614The shell to be used for command execution, defaults to C</bin/sh>. 1745The shell to be used for command execution, defaults to C</bin/sh>.
1615 1746
1616=item B<RXVT_SOCKET> 1747=item B<RXVT_SOCKET> [I<sic>]
1617 1748
1618The unix domain socket path used by @@RXVT_NAME@@c(1) and 1749The unix domain socket path used by @@RXVT_NAME@@c(1) and
1619@@RXVT_NAME@@d(1). 1750@@RXVT_NAME@@d(1).
1620 1751
1621Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1752Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1753
1754=item B<URXVT_PERL_LIB>
1755
1756Additional F<:>-separated library search path for perl extensions. Will be
1757searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1758directory.
1759
1760=item B<URXVT_PERL_VERBOSITY>
1761
1762See L<@@RXVT_NAME@@perl>(3).
1622 1763
1623=item B<HOME> 1764=item B<HOME>
1624 1765
1625Used to locate the default directory for the unix domain socket for 1766Used to locate the default directory for the unix domain socket for
1626daemon communications and to locate various resource files (such as 1767daemon communications and to locate various resource files (such as
1627C<.Xdefaults>) 1768C<.Xdefaults>)
1628 1769
1629=item B<XAPPLRESDIR> 1770=item B<XAPPLRESDIR>
1630 1771
1631Directory where various X resource files are being located. 1772Directory where application-specific X resource files are located.
1632 1773
1633=item B<XENVIRONMENT> 1774=item B<XENVIRONMENT>
1634 1775
1635If set and accessible, gives the name of a X resource file to be loaded by 1776If set and accessible, gives the name of a X resource file to be loaded by
1636@@RXVT_NAME@@. 1777@@RXVT_NAME@@.
1647 1788
1648=back 1789=back
1649 1790
1650=head1 SEE ALSO 1791=head1 SEE ALSO
1651 1792
1793@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1652@@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) 1794@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1653 1795
1654=head1 CURRENT PROJECT COORDINATOR 1796=head1 CURRENT PROJECT COORDINATOR
1655 1797
1656=over 4 1798=over 4
1657 1799
1658=item Project Coordinator 1800=item Project Coordinator
1659 1801
1660Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1802Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1661 1803
1662L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1804L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1663 1805
1664=back 1806=back
1665 1807
1669 1811
1670=item John Bovey 1812=item John Bovey
1671 1813
1672University of Kent, 1992, wrote the original Xvt. 1814University of Kent, 1992, wrote the original Xvt.
1673 1815
1674=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1816=item Rob Nation <nation@rocket.sanders.lockheed.com>
1675 1817
1676very heavily modified Xvt and came up with Rxvt 1818very heavily modified Xvt and came up with Rxvt
1677 1819
1678=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1820=item Angelo Haritsis <ah@doc.ic.ac.uk>
1679 1821
1680wrote the Greek Keyboard Input (no longer in code) 1822wrote the Greek Keyboard Input (no longer in code)
1681 1823
1682=item mj olesen L<< <olesen@me.QueensU.CA> >> 1824=item mj olesen <olesen@me.QueensU.CA>
1683 1825
1684Wrote the menu system. 1826Wrote the menu system.
1685 1827
1686Project Coordinator (changes.txt 2.11 to 2.21) 1828Project Coordinator (changes.txt 2.11 to 2.21)
1687 1829
1688=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1830=item Oezguer Kesim <kesim@math.fu-berlin.de>
1689 1831
1690Project Coordinator (changes.txt 2.21a to 2.4.5) 1832Project Coordinator (changes.txt 2.21a to 2.4.5)
1691 1833
1692=item Geoff Wing L<< <gcw@pobox.com> >> 1834=item Geoff Wing <gcw@pobox.com>
1693 1835
1694Rewrote screen display and text selection routines. 1836Rewrote screen display and text selection routines.
1695 1837
1696Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1838Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1697 1839
1698=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1840=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1699 1841
1700Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1842Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1701extension, random hacks, numerous bugfixes and extensions. 1843extension, random hacks, numerous bugfixes and extensions.
1702 1844
1703Project Coordinator (Changes 1.0 -) 1845Project Coordinator (Changes 1.0 -)
1704 1846
1705=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1847=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1706 1848
1707Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1849pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1708 1850
1709=back 1851=back
1710 1852

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines