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.185 by sf-exg, Mon Oct 4 07:18:23 2010 UTC vs.
Revision 1.241 by root, Wed Dec 17 15:22:10 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
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 132
137=item B<-fade> I<number> 133=item B<-fade> I<number>
138 134
139Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
143=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
144 140
145Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
147 143
148=item B<-tint> I<colour>
149
150Tint the transparent background pixmap with the given colour when
151transparency is enabled with B<-tr>. This only works for
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colours essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file> 144=item B<-icon> I<file>
188 145
189Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 146Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 147is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 148application window; resource I<iconFile>.
192 149
193=item B<-bg> I<colour> 150=item B<-bg> I<colour>
194 151
195Window background colour; resource B<background>. 152Window background colour; resource B<background>.
196 153
197=item B<-fg> I<colour> 154=item B<-fg> I<colour>
198 155
199Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>.
207 157
208=item B<-cr> I<colour> 158=item B<-cr> I<colour>
209 159
210The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
211 161
270 220
271=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
272 222
273Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
274 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
275=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
276 230
277Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
278B<utmpInhibit>. 232B<utmpInhibit>.
279 233
357 311
358=item B<-override-redirect> 312=item B<-override-redirect>
359 313
360Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
361B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
362 321
363=item B<-sbg> 322=item B<-sbg>
364 323
365Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
366drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
571You 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
572distribution do also load settings from the B<~/.Xresources> file when X 531distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 532starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 533with later settings overwriting earlier ones:
575 534
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 535 1. app-defaults file in $XAPPLRESDIR
536 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 537 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 538 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 539 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 540 6. resources specified via -xrm on the commandline
582 541
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 542Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: 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
700 659
701B<False>: specify that everything is to be displayed, even 660B<False>: specify that everything is to be displayed, even
702if 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
703monitor to display anything); option B<+ss>. 662monitor to display anything); option B<+ss>.
704 663
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> 664=item B<fading:> I<number>
716 665
717Fade 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>.
718 667
719=item B<fadeColor:> I<colour> 668=item B<fadeColor:> I<colour>
720 669
721Fade 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
722colour is black; option B<-fadecolor>. 671colour is black; option B<-fadecolor>.
723 672
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> 673=item B<iconFile:> I<file>
744 674
745Set the application icon pixmap; option B<-icon>. 675Set the application icon pixmap; option B<-icon>.
746 676
747=item B<scrollColor:> I<colour> 677=item B<scrollColor:> I<colour>
755 685
756=item B<borderColor:> I<colour> 686=item B<borderColor:> I<colour>
757 687
758The 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
759and the text. 689and the text.
760
761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
762
763Use the specified image file for the background and also
764optionally specify its scaling with a geometry string B<WxH+X+Y>,
765(default C<100x100+50+50>) in which B<"W" / "H"> specify the
766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767centre (percent). A scale of 0 displays the image with tiling.
768The maximum permitted scale is 1000.
769Additional operations can be specified after colon B<:op1:op2...>.
770Supported operations are:
771
772 tile force background image to be tiled and not scaled. Equivalent to 0x0
773 propscale will scale image keeping proportions
774 auto will scale image to match window size. Equivalent to 100x100
775 hscale will scale image horizontally to the window size
776 vscale will scale image vertically to the window size
777 scale will scale image to match window size
778 root will tile image as if it was a root window background, auto-adjusting
779 whenever terminal window moves
780
781If used in conjunction with B<-tr> option, the specified pixmap will be
782blended over transparency image using either alpha-blending, or any
783other blending type, specified with B<-blt "type"> option.
784
785=item B<path:> I<path>
786
787Specify the colon-delimited search path for finding background image files.
788 690
789=item B<font:> I<fontlist> 691=item B<font:> I<fontlist>
790 692
791Select 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
792that 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
889 791
890B<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
891the 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
892[default]; option B<+ls>. 794[default]; option B<+ls>.
893 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
894=item B<utmpInhibit:> I<boolean> 801=item B<utmpInhibit:> I<boolean>
895 802
896B<True>: inhibit writing record into the system log file B<utmp>; 803B<True>: inhibit writing record into the system log file B<utmp>;
897option B<-ut>. B<False>: write record into the system log file B<utmp> 804option B<-ut>. B<False>: write record into the system log file B<utmp>
898[default]; option B<+ut>. 805[default]; option B<+ut>.
915=item B<scrollstyle:> I<mode> 822=item B<scrollstyle:> I<mode>
916 823
917Set 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
918the author's favourite. 825the author's favourite.
919 826
827=item B<thickness:> I<number>
828
829Set the scrollbar width in pixels.
830
920=item B<scrollBar:> I<boolean> 831=item B<scrollBar:> I<boolean>
921 832
922B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 833B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
923disable the scrollbar; option B<+sb>. 834disable the scrollbar; option B<+sb>.
924 835
943B<False>: do not scroll to bottom when tty receives output; option 854B<False>: do not scroll to bottom when tty receives output; option
944B<+si>. 855B<+si>.
945 856
946=item B<scrollWithBuffer:> I<boolean> 857=item B<scrollWithBuffer:> I<boolean>
947 858
948B<True>: scroll with scrollback buffer when tty receives new lines (and 859B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
949B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 860try to show the same lines) and B<scrollTtyOutput> is False; option
950with 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>.
951 863
952=item B<scrollTtyKeypress:> I<boolean> 864=item B<scrollTtyKeypress:> I<boolean>
953 865
954B<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
955are those which are intercepted by rxvt-unicode for special handling and 867are those which are intercepted by rxvt-unicode for special handling and
1144Sets the working directory for the shell (or the command specified via 1056Sets the working directory for the shell (or the command specified via
1145B<-e>). The I<path> must be an absolute path and it must exist for 1057B<-e>). The I<path> must be an absolute path and it must exist for
1146@@RXVT_NAME@@ to start. If it isn't specified then the current working 1058@@RXVT_NAME@@ to start. If it isn't specified then the current working
1147directory will be used; option B<-cd>. 1059directory will be used; option B<-cd>.
1148 1060
1149=item B<keysym.>I<sym>: I<string> 1061=item B<keysym.>I<sym>: I<action>
1150 1062
1151Compile I<frills>: Associate I<string> with keysym I<sym>. The 1063Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1152intervening resource name B<keysym.> cannot be omitted. 1064resource name B<keysym.> cannot be omitted.
1153 1065
1154The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1066Using this resource, you can map key combinations such as
1155any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1067C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1156B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1068string than would normally result from that combination, making the
1157and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1069terminal scroll up or down the way you want it, or any other thing an
1158B<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>.
1159 1080
1160The 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
1161whatever 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
1162keys 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
1163current application keymap mode state. 1084current application keymap mode state.
1164 1085
1165The 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
1166searching 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
1167omitting 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
1168keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1098value (B<0x0000 - 0xFFFF>).
1169performed in an exact manner; however, the closest match is assured.
1170 1099
1171I<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
1172number), see RESOURCES in C<man 7 X> for further details. 1102number), see RESOURCES in C<man 7 X> for further details.
1173 1103
1174You 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
1175with 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
1176should be a character not used by the strings. 1128the delimiter `/' should be a character not used by the strings.
1177 1129
1178Its usage can be demonstrated by an example: 1130Its usage can be demonstrated by an example:
1179 1131
1180 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1132 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1181 1133
1182The above line is equivalent to the following three lines: 1134The above line is equivalent to the following three lines:
1183 1135
1184 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1136 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1185 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1137 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1186 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1138 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1187 1139
1140=item command:STRING
1141
1188If 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>
1189is 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
1190example 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>
1191when Control-Meta-c is being pressed": 1149when Control-Meta-c is being pressed":
1192 1150
1193 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
1194 1152
1195If 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
1196is 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
1197manpage. For example, the F<selection> extension (activated via 1155font-switching at runtime:
1198C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1199 1156
1200 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
1201 1159
1202Due the the large number of modifier combinations, a defined key mapping 1160Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1203will match if I<at least> the specified identifiers are being set, and 1161info):
1204no other key mappings with those and more bits are being defined. That
1205means that defining a key map for C<a> will automatically provide
1206definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1207mappings themselves.
1208 1162
1209Unfortunately, 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
1210if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1173For example if you overwrite the C<Insert> key you will disable
1211C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1174@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1212user-defined keymap using the C<builtin:> replacement: 1175"holes" into the user-defined keymap using the C<builtin:> replacement:
1213 1176
1214 URxvt.keysym.Insert: <my insert key sequence> 1177 URxvt.keysym.Insert: <my insert key sequence>
1215 URxvt.keysym.S-Insert: builtin: 1178 URxvt.keysym.S-Insert: builtin:
1216 1179
1217The 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
1218of modifiers. The second line re-establishes the default mapping for 1181of modifiers. The second line re-establishes the default mapping for
1219C<Shift-Insert>. 1182C<Shift-Insert>.
1220 1183
1221The following example will map Control-Meta-1 and Control-Meta-2 to 1184=item builtin-string:
1222the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1223font-switching at runtime:
1224 1185
1225 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1186This action is mainly useful to restore string mappings for keys that
1226 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.
1227 1191
1228Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1192An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1229info): 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:
1230 1196
1231 URxvt.keysym.M-C-3: command:\033[8;25;80t 1197 URxvt.keysym.S-Insert: builtin-string:
1232 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
1233 1234
1234=item B<perl-ext-common>: I<string> 1235=item B<perl-ext-common>: I<string>
1235 1236
1236=item B<perl-ext>: I<string> 1237=item B<perl-ext>: I<string>
1237 1238
1239use in this terminal instance; option B<-pe>. 1240use in this terminal instance; option B<-pe>.
1240 1241
1241Extension names can be prefixed with a C<-> sign to prohibit using 1242Extension names can be prefixed with a C<-> sign to prohibit using
1242them. This can be useful to selectively disable some extensions loaded 1243them. This can be useful to selectively disable some extensions loaded
1243by default, or specified via the C<perl-ext-common> resource. For 1244by default, or specified via the C<perl-ext-common> resource. For
1244example, C<default,-selection> will use all the default extension except 1245example, C<default,-selection> will use all the default extensions except
1245C<selection>. 1246C<selection>.
1246 1247
1247Extension names can also be followed by an argument in angle brackets 1248The default set includes the C<selection>, C<option-popup>,
1248(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1249C<selection-popup> and C<readline> extensions, any extensions that
1249searchable scrollback to Alt/Meta-s). Mentioning the same extension 1250define keybindings via C<BINDING> meta comments, and extensions which
1250multiple times with different arguments will pass multiple arguments to 1251are mentioned in B<keysym> resources.
1251the extension. 1252
1253Any extension such that a corresponding resource is given on the
1254command line is automatically appended to B<perl-ext>.
1252 1255
1253Each extension is looked up in the library directories, loaded if 1256Each extension is looked up in the library directories, loaded if
1254necessary, and bound to the current terminal instance. 1257necessary, and bound to the current terminal instance. When the library
1258search path contains multiple extension files of the same name, then the
1259first one found will be used.
1255 1260
1256If both of these resources are the empty string, then the perl 1261If both of these resources are the empty string, then the perl interpreter
1257interpreter will not be initialized. The idea behind two options is that 1262will not be initialized. The rationale for having two options is that
1258B<perl-ext-common> will be used for extensions that should be available to 1263B<perl-ext-common> will be used for extensions that should be available to
1259all instances, while B<perl-ext> is used for specific instances. 1264all instances, while B<perl-ext> is used for specific instances.
1260 1265
1261=item B<perl-eval>: I<string> 1266=item B<perl-eval>: I<string>
1262 1267
1264the @@RXVT_NAME@@perl(3) manpage. 1269the @@RXVT_NAME@@perl(3) manpage.
1265 1270
1266=item B<perl-lib>: I<path> 1271=item B<perl-lib>: I<path>
1267 1272
1268Colon-separated list of additional directories that hold extension 1273Colon-separated list of additional directories that hold extension
1269scripts. When looking for extensions specified by the C<perl> resource, 1274scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1270@@RXVT_NAME@@ will first look in these directories and then in 1275in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1271F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1276lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1272 1277
1273See the @@RXVT_NAME@@perl(3) manpage. 1278See the @@RXVT_NAME@@perl(3) manpage.
1274 1279
1275=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1280=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1276 1281
1280=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1285=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1281 1286
1282Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1287Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1283for details. 1288for details.
1284 1289
1285=item B<searchable-scrollback:> I<keysym> 1290=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1286 1291
1287Sets the hotkey that starts the incremental scrollback buffer search 1292This resource is deprecated and will be removed. Use a B<keysym> resource
1288(default: C<M-s>). 1293instead, e.g.:
1289 1294
1295 URxvt.keysym.M-s: searchable-scrollback:start
1296
1290=item B<urlLauncher>: I<string> 1297=item B<url-launcher>: I<string>
1291 1298
1292Specifies the program to be started with a URL argument. Used by the 1299Specifies the program to be started with a URL argument. Used by the
1293C<selection-popup> and C<matcher> perl extensions. 1300C<selection-popup> and C<matcher> perl extensions.
1294 1301
1295=item B<transient-for>: I<windowid> 1302=item B<transient-for>: I<windowid>
1306Turn on/off ISO 14755 (default enabled). 1313Turn on/off ISO 14755 (default enabled).
1307 1314
1308=item B<iso14755_52:> I<boolean> 1315=item B<iso14755_52:> I<boolean>
1309 1316
1310Turn on/off ISO 14755 5.2 mode (default enabled). 1317Turn on/off ISO 14755 5.2 mode (default enabled).
1318
1319=back
1320
1321=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1322
1323=over 4
1324
1325=item B<-pixmap> I<file[;oplist]>
1326
1327=item B<backgroundPixmap:> I<file[;oplist]>
1328
1329Compile I<pixbuf>: Use the specified image file as the window's
1330background and also optionally specify a colon separated list of
1331operations to modify it. Note that you may need to quote the C<;>
1332character when using the command line option, as C<;> is usually a
1333metacharacter in shells. Supported operations are:
1334
1335=over 4
1336
1337=item B<WxH+X+Y>
1338
1339sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1340scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1341scale of 0 disables scaling.
1342
1343=item B<op=tile>
1344
1345enables tiling
1346
1347=item B<op=keep-aspect>
1348
1349maintain the image aspect ratio when scaling
1350
1351=item B<op=root-align>
1352
1353use the position of the terminal window relative to the root window as
1354the image offset, simulating a root window background
1355
1356=back
1357
1358The default scale and position setting is C<100x100+50+50>.
1359Alternatively, a predefined set of templates can be used to achieve
1360the most common setups:
1361
1362=over 4
1363
1364=item B<style=tiled>
1365
1366the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1367
1368=item B<style=aspect-stretched>
1369
1370the image is scaled to fill the whole window maintaining the aspect
1371ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1372
1373=item B<style=stretched>
1374
1375the image is scaled to fill the whole window. Equivalent to 100x100
1376
1377=item B<style=centered>
1378
1379the image is centered with no scaling. Equivalent to 0x0+50+50
1380
1381=item B<style=root-tiled>
1382
1383the image is tiled with no scaling and using 'root' positioning.
1384Equivalent to 0x0:op=tile:op=root-align
1385
1386=back
1387
1388If multiple templates are specified the last one wins. Note that a
1389template overrides all the scale, position and operations settings.
1390
1391If used in conjunction with pseudo-transparency, the specified pixmap
1392will be blended over the transparent background using alpha-blending.
1393
1394=item B<-tr>|B<+tr>
1395
1396=item B<transparent:> I<boolean>
1397
1398Turn on/off pseudo-transparency by using the root pixmap as background.
1399
1400B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1401will be removed in future versions.
1402
1403=item B<-tint> I<colour>
1404
1405=item B<tintColor:> I<colour>
1406
1407Tint the transparent background with the given colour. Note that a
1408black tint yields a completely black image while a white tint yields
1409the image unchanged.
1410
1411=item B<-sh> I<number>
1412
1413=item B<shading:> I<number>
1414
1415Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1416A value of 100 means no shading.
1417
1418=item B<-blr> I<HxV>
1419
1420=item B<blurRadius:> I<HxV>
1421
1422Apply gaussian blur with the specified radius to the transparent
1423background. If a single number is specified, the vertical and
1424horizontal radii are considered to be the same. Setting one of the
1425radii to 1 and the other to a large number creates interesting effects
1426on some backgrounds. The maximum radius value is 128. An horizontal or
1427vertical radius of 0 disables blurring.
1428
1429=item B<path:> I<path>
1430
1431Specify the colon-delimited search path for finding background image files.
1311 1432
1312=back 1433=back
1313 1434
1314=head1 THE SCROLLBAR 1435=head1 THE SCROLLBAR
1315 1436
1363window causes the value of the PRIMARY selection (or CLIPBOARD with the 1484window causes the value of the PRIMARY selection (or CLIPBOARD with the
1364B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1485B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1365 1486
1366Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1487Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1367inserted too. 1488inserted too.
1489
1490rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1491<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1492binding causes the value of the internal selection to be copied to the
1493CLIPBOARD selection, while the second binding causes the value of the
1494CLIPBOARD selection to be inserted.
1368 1495
1369=back 1496=back
1370 1497
1371=head1 CHANGING FONTS 1498=head1 CHANGING FONTS
1372 1499
1497The following text gives values for the standard 88 colour mode (and 1624The following text gives values for the standard 88 colour mode (and
1498values for the 256 colour mode in parentheses). 1625values for the 256 colour mode in parentheses).
1499 1626
1500The RGB cube uses indices 16..79 (16..231) using the following formulas: 1627The RGB cube uses indices 16..79 (16..231) using the following formulas:
1501 1628
1502 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1629 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1503 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1630 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1504 1631
1505The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1632The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1506steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1633steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1507the RGB cube. 1634the RGB cube.
1508 1635
1524White. 1651White.
1525 1652
1526=head2 ALPHA CHANNEL SUPPORT 1653=head2 ALPHA CHANNEL SUPPORT
1527 1654
1528If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1655If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1529their act together, rxvt-unicode will do it's own alpha channel management: 1656their act together, rxvt-unicode will do its own alpha channel management:
1530 1657
1531You can prefix any colour with an opaqueness percentage enclosed in 1658You can prefix any colour with an opaqueness percentage enclosed in
1532brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1659brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1533(0-100) that specifies the opacity of the colour, where C<0> is completely 1660(0-100) that specifies the opacity of the colour, where C<0> is completely
1534transparent and C<100> is completely opaque. For example, C<[50]red> is a 1661transparent and C<100> is completely opaque. For example, C<[50]red> is a
1616 1743
1617=item B<SHELL> 1744=item B<SHELL>
1618 1745
1619The shell to be used for command execution, defaults to C</bin/sh>. 1746The shell to be used for command execution, defaults to C</bin/sh>.
1620 1747
1621=item B<RXVT_SOCKET> 1748=item B<RXVT_SOCKET> [I<sic>]
1622 1749
1623The unix domain socket path used by @@RXVT_NAME@@c(1) and 1750The unix domain socket path used by @@RXVT_NAME@@c(1) and
1624@@RXVT_NAME@@d(1). 1751@@RXVT_NAME@@d(1).
1625 1752
1626Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1753Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1754
1755=item B<URXVT_PERL_LIB>
1756
1757Additional F<:>-separated library search path for perl extensions. Will be
1758searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1759directory.
1760
1761=item B<URXVT_PERL_VERBOSITY>
1762
1763See L<@@RXVT_NAME@@perl>(3).
1627 1764
1628=item B<HOME> 1765=item B<HOME>
1629 1766
1630Used to locate the default directory for the unix domain socket for 1767Used to locate the default directory for the unix domain socket for
1631daemon communications and to locate various resource files (such as 1768daemon communications and to locate various resource files (such as
1632C<.Xdefaults>) 1769C<.Xdefaults>)
1633 1770
1634=item B<XAPPLRESDIR> 1771=item B<XAPPLRESDIR>
1635 1772
1636Directory where various X resource files are being located. 1773Directory where application-specific X resource files are located.
1637 1774
1638=item B<XENVIRONMENT> 1775=item B<XENVIRONMENT>
1639 1776
1640If set and accessible, gives the name of a X resource file to be loaded by 1777If set and accessible, gives the name of a X resource file to be loaded by
1641@@RXVT_NAME@@. 1778@@RXVT_NAME@@.
1652 1789
1653=back 1790=back
1654 1791
1655=head1 SEE ALSO 1792=head1 SEE ALSO
1656 1793
1794@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1657@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1795@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1658 1796
1659=head1 CURRENT PROJECT COORDINATOR 1797=head1 CURRENT PROJECT COORDINATOR
1660 1798
1661=over 4 1799=over 4
1662 1800
1663=item Project Coordinator 1801=item Project Coordinator
1664 1802
1665Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1803Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1666 1804
1667L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1805L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1668 1806
1669=back 1807=back
1670 1808
1674 1812
1675=item John Bovey 1813=item John Bovey
1676 1814
1677University of Kent, 1992, wrote the original Xvt. 1815University of Kent, 1992, wrote the original Xvt.
1678 1816
1679=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1817=item Rob Nation <nation@rocket.sanders.lockheed.com>
1680 1818
1681very heavily modified Xvt and came up with Rxvt 1819very heavily modified Xvt and came up with Rxvt
1682 1820
1683=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1821=item Angelo Haritsis <ah@doc.ic.ac.uk>
1684 1822
1685wrote the Greek Keyboard Input (no longer in code) 1823wrote the Greek Keyboard Input (no longer in code)
1686 1824
1687=item mj olesen L<< <olesen@me.QueensU.CA> >> 1825=item mj olesen <olesen@me.QueensU.CA>
1688 1826
1689Wrote the menu system. 1827Wrote the menu system.
1690 1828
1691Project Coordinator (changes.txt 2.11 to 2.21) 1829Project Coordinator (changes.txt 2.11 to 2.21)
1692 1830
1693=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1831=item Oezguer Kesim <kesim@math.fu-berlin.de>
1694 1832
1695Project Coordinator (changes.txt 2.21a to 2.4.5) 1833Project Coordinator (changes.txt 2.21a to 2.4.5)
1696 1834
1697=item Geoff Wing L<< <gcw@pobox.com> >> 1835=item Geoff Wing <gcw@pobox.com>
1698 1836
1699Rewrote screen display and text selection routines. 1837Rewrote screen display and text selection routines.
1700 1838
1701Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1839Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1702 1840
1703=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1841=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1704 1842
1705Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1843Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1706extension, random hacks, numerous bugfixes and extensions. 1844extension, random hacks, numerous bugfixes and extensions.
1707 1845
1708Project Coordinator (Changes 1.0 -) 1846Project Coordinator (Changes 1.0 -)
1709 1847
1710=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1848=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1711 1849
1712Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1850pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1713 1851
1714=back 1852=back
1715 1853

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines