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.195 by sf-exg, Sat Apr 30 18:45:38 2011 UTC vs.
Revision 1.246 by sf-exg, Tue Jun 21 12:03:55 2016 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 pseudo-transparency by using the root pixmap as 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 with the given colour;
148resource I<tintColor>.
149
150=item B<-sh> I<number>
151
152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153A value of 100 means no shading; resource I<shading>.
154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128;
172resource I<blurRadius>.
173
174=item B<-icon> I<file> 144=item B<-icon> I<file>
175 145
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 146Compile I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the 147is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>. 148application window; resource I<iconFile>.
179 149
180=item B<-bg> I<colour> 150=item B<-bg> I<colour>
181 151
182Window background colour; resource B<background>. 152Window background colour; resource B<background>.
183 153
184=item B<-fg> I<colour> 154=item B<-fg> I<colour>
185 155
186Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
187
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
189
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191optionally specify its scaling with a geometry string. Note you may need to
192add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>.
194 157
195=item B<-cr> I<colour> 158=item B<-cr> I<colour>
196 159
197The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
198 161
257 220
258=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
259 222
260Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
261 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
262=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
263 230
264Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
265B<utmpInhibit>. 232B<utmpInhibit>.
266 233
344 311
345=item B<-override-redirect> 312=item B<-override-redirect>
346 313
347Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
348B<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.
349 321
350=item B<-sbg> 322=item B<-sbg>
351 323
352Compile 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
353drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
407 379
408=item B<-pt> I<style> 380=item B<-pt> I<style>
409 381
410Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
411B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
412 387
413=item B<-im> I<text> 388=item B<-im> I<text>
414 389
415Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
416 391
687 662
688B<False>: specify that everything is to be displayed, even 663B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the 664if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>. 665monitor to display anything); option B<+ss>.
691 666
692=item B<transparent:> I<boolean>
693
694Turn on/off pseudo-transparency by using the root pixmap as background.
695
696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
697future versions.
698
699=item B<fading:> I<number> 667=item B<fading:> I<number>
700 668
701Fade the text by the given percentage when focus is lost; option B<-fade>. 669Fade the text by the given percentage when focus is lost; option B<-fade>.
702 670
703=item B<fadeColor:> I<colour> 671=item B<fadeColor:> I<colour>
704 672
705Fade to this colour, when fading is used (see B<fading:>). The default 673Fade to this colour, when fading is used (see B<fading:>). The default
706colour is black; option B<-fadecolor>. 674colour is black; option B<-fadecolor>.
707 675
708=item B<tintColor:> I<colour>
709
710Tint the transparent background with the given colour. If the RENDER
711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
715
716=item B<shading:> I<number>
717
718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
719A value of 100 means no shading; option B<-sh>.
720
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number>
726
727Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>.
729
730=item B<iconFile:> I<file> 676=item B<iconFile:> I<file>
731 677
732Set the application icon pixmap; option B<-icon>. 678Set the application icon pixmap; option B<-icon>.
733 679
734=item B<scrollColor:> I<colour> 680=item B<scrollColor:> I<colour>
742 688
743=item B<borderColor:> I<colour> 689=item B<borderColor:> I<colour>
744 690
745The colour of the border around the text area and between the scrollbar 691The colour of the border around the text area and between the scrollbar
746and the text. 692and the text.
747
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
749
750Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>,
752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
754centre (percent). A scale of 0 displays the image with tiling.
755The maximum permitted scale is 1000.
756Additional operations can be specified after colon B<:op1:op2...>.
757Supported operations are:
758
759 tile force background image to be tiled and not scaled. Equivalent to 0x0
760 propscale will scale image keeping proportions
761 auto will scale image to match window size. Equivalent to 100x100
762 hscale will scale image horizontally to the window size
763 vscale will scale image vertically to the window size
764 scale will scale image to match window size
765 root will tile image as if it was a root window background, auto-adjusting
766 whenever terminal window moves
767
768If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
772
773=item B<path:> I<path>
774
775Specify the colon-delimited search path for finding background image files.
776 693
777=item B<font:> I<fontlist> 694=item B<font:> I<fontlist>
778 695
779Select the fonts to be used. This is a comma separated list of font names 696Select the fonts to be used. This is a comma separated list of font names
780that are checked in order when trying to find glyphs for characters. The 697that are checked in order when trying to find glyphs for characters. The
877 794
878B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 795B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
879the shell; option B<-ls>. B<False>: start as a normal sub-shell 796the shell; option B<-ls>. B<False>: start as a normal sub-shell
880[default]; option B<+ls>. 797[default]; option B<+ls>.
881 798
799=item B<multiClickTime:> I<number>
800
801Specify the maximum time in milliseconds between multi-click select
802events. The default is 500 milliseconds; option B<-mc>.
803
882=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
883 805
884B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
885option B<-ut>. B<False>: write record into the system log file B<utmp> 807option B<-ut>. B<False>: write record into the system log file B<utmp>
886[default]; option B<+ut>. 808[default]; option B<+ut>.
935B<False>: do not scroll to bottom when tty receives output; option 857B<False>: do not scroll to bottom when tty receives output; option
936B<+si>. 858B<+si>.
937 859
938=item B<scrollWithBuffer:> I<boolean> 860=item B<scrollWithBuffer:> I<boolean>
939 861
940B<True>: scroll with scrollback buffer when tty receives new lines (and 862B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
941B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 863try to show the same lines) and B<scrollTtyOutput> is False; option
942with scrollback buffer when tty receives new lines; option B<+sw>. 864B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
865new lines; option B<+sw>.
943 866
944=item B<scrollTtyKeypress:> I<boolean> 867=item B<scrollTtyKeypress:> I<boolean>
945 868
946B<True>: scroll to bottom when a non-special key is pressed. Special keys 869B<True>: scroll to bottom when a non-special key is pressed. Special keys
947are those which are intercepted by rxvt-unicode for special handling and 870are those which are intercepted by rxvt-unicode for special handling and
948are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 871are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
949bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
950 873
951=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
952 875
953Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
954resource is limited on most machines to 65535; option B<-sl>.
955 877
956=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
957 879
958Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
959option B<-b>. 881option B<-b>.
1022 944
1023=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
1024 946
1025Mouse pointer background colour. 947Mouse pointer background colour.
1026 948
949=item B<pointerShape:> I<string>
950
951Compile I<frills>: Specifies the name of the mouse pointer shape
952[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
953file for possible values (omit the C<XC_> prefix).
954
1027=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
1028 956
1029Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
1030large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
1031 959
1057 985
1058B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1059 987
1060=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
1061 989
1062B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1063 991
1064=item B<inputMethod:> I<name> 992=item B<inputMethod:> I<name>
1065 993
1066I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
1067 995
1136Sets the working directory for the shell (or the command specified via 1064Sets the working directory for the shell (or the command specified via
1137B<-e>). The I<path> must be an absolute path and it must exist for 1065B<-e>). The I<path> must be an absolute path and it must exist for
1138@@RXVT_NAME@@ to start. If it isn't specified then the current working 1066@@RXVT_NAME@@ to start. If it isn't specified then the current working
1139directory will be used; option B<-cd>. 1067directory will be used; option B<-cd>.
1140 1068
1141=item B<keysym.>I<sym>: I<string> 1069=item B<keysym.>I<sym>: I<action>
1142 1070
1143Compile I<frills>: Associate I<string> with keysym I<sym>. The 1071Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1144intervening resource name B<keysym.> cannot be omitted. 1072resource name B<keysym.> cannot be omitted.
1145 1073
1146The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1074Using this resource, you can map key combinations such as
1147any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1075C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1148B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1076string than would normally result from that combination, making the
1149and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1077terminal scroll up or down the way you want it, or any other thing an
1150B<2>, B<3>, B<4>, B<5>. 1078extension might provide.
1079
1080The key combination that triggers the action, I<sym>, has the following format:
1081
1082 (modifiers-)key
1083
1084Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1085B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1086B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1087B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1151 1088
1152The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1089The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1153whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1090whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1154keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1091keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1155current application keymap mode state. 1092current application keymap mode state.
1156 1093
1157The spellings of I<key> can be obtained by using B<xev>(1) command or 1094Due the the large number of modifier combinations, a key mapping will
1158searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1095match if I<at least> the specified identifiers are being set, and no other
1096key mappings with those and more bits are being defined. That means that
1097defining a mapping for C<a> will automatically provide definitions for
1098C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1099themselves. See the C<builtin:> action, below, for a way to work around
1100this when this is a problem.
1101
1102The spelling of I<key> depends on your implementation of X. An easy way to
1103find a key name is to use the B<xev>(1) command. You can find a list by
1104looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1159omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1105the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1160keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1106value (B<0x0000 - 0xFFFF>).
1161performed in an exact manner; however, the closest match is assured.
1162 1107
1163I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1108As with any resource value, the I<action> string may contain backslash
1109escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1164number), see RESOURCES in C<man 7 X> for further details. 1110number), see RESOURCES in C<man 7 X> for further details.
1165 1111
1112An action starts with an action prefix that selects a certain type
1113of action, followed by a colon. An action string without colons is
1114interpreted as a literal string to pass to the tty (as if it was
1115prefixed with C<string:>).
1116
1117The following action prefixes are known - extensions can provide
1118additional prefixes:
1119
1120=over 4
1121
1122=item string:STRING
1123
1124If the I<action> starts with C<string:> (or otherwise contains no colons),
1125then the remaining C<STRING> will be passed to the program running in the
1126terminal. For example, you could replace whatever Shift-Tab outputs by the
1127string C<echo rm -rf /> followed by a newline:
1128
1129 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1130
1131This could in theory be used to completely redefine your keymap.
1132
1133In addition, for actions of this type, you can define a range of
1134keysyms in one shot by loading the C<keysym-list> perl extension and
1135providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1136the delimiter `/' should be a character not used by the strings.
1137
1138Its usage can be demonstrated by an example:
1139
1140 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1141
1142The above line is equivalent to the following three lines:
1143
1144 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1145 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1146 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1147
1148=item command:STRING
1149
1166If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1150If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1167is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1151is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1152the opposite of C<string:> - instead of sending it to the program running
1153in the terminal, it will be treated as if it were program output). This is
1154most useful to feed command sequences into @@RXVT_NAME@@.
1155
1168example the following means "change the current locale to C<zh_CN.GBK> 1156For example the following means "change the current locale to C<zh_CN.GBK>
1169when Control-Meta-c is being pressed": 1157when Control-Meta-c is being pressed":
1170 1158
1171 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1159 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1172 1160
1173If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1161The following example will map Control-Meta-1 and Control-Meta-2 to
1174is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1162the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1175manpage. For example, the F<selection> extension (activated via 1163font-switching at runtime:
1176C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1177 1164
1178 URxvt.keysym.M-C-c: perl:selection:rot13 1165 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1166 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1179 1167
1180Due the the large number of modifier combinations, a defined key mapping 1168Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1181will match if I<at least> the specified identifiers are being set, and 1169info):
1182no other key mappings with those and more bits are being defined. That
1183means that defining a key map for C<a> will automatically provide
1184definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1185mappings themselves.
1186 1170
1187Unfortunately, this will override built-in key mappings. For example 1171 URxvt.keysym.M-C-3: command:\033[8;25;80t
1172 URxvt.keysym.M-C-4: command:\033[8;48;110t
1173
1174=item builtin:
1175
1176The builtin action is the action that @@RXVT_NAME@@ would execute if no
1177key binding existed for the key combination. The obvious use is to undo
1178the effect of existing bindings. The not so obvious use is to reinstate
1179bindings when another binding overrides too many modifiers.
1180
1188if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1181For example if you overwrite the C<Insert> key you will disable
1189C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1182@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1190user-defined keymap using the C<builtin:> replacement: 1183"holes" into the user-defined keymap using the C<builtin:> replacement:
1191 1184
1192 URxvt.keysym.Insert: <my insert key sequence> 1185 URxvt.keysym.Insert: <my insert key sequence>
1193 URxvt.keysym.S-Insert: builtin: 1186 URxvt.keysym.S-Insert: builtin:
1194 1187
1195The first line defines a mapping for C<Insert> and I<any> combination 1188The first line defines a mapping for C<Insert> and I<any> combination
1196of modifiers. The second line re-establishes the default mapping for 1189of modifiers. The second line re-establishes the default mapping for
1197C<Shift-Insert>. 1190C<Shift-Insert>.
1198 1191
1199The following example will map Control-Meta-1 and Control-Meta-2 to 1192=item builtin-string:
1200the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1201font-switching at runtime:
1202 1193
1203 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1194This action is mainly useful to restore string mappings for keys that
1204 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1195have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1196difficult to explain - basically, this action will send the string to the
1197application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1198action for it.
1205 1199
1206Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1200An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1207info): 1201selection when you press C<Shift-Insert>. With the following bindings, it
1202would instead emit the (undocumented, but what applications running in the
1203terminal might expect) sequence C<ESC [ 2 $> instead:
1208 1204
1209 URxvt.keysym.M-C-3: command:\033[8;25;80t 1205 URxvt.keysym.S-Insert: builtin-string:
1210 URxvt.keysym.M-C-4: command:\033[8;48;110t 1206 URxvt.keysym.C-S-Insert: builtin:
1207
1208The first line disables the paste functionality for that key
1209combination, and the second reinstates the default behaviour for
1210C<Control-Shift-Insert>, which would otherwise be overridden.
1211
1212Similarly, to let applications gain access to the C<C-M-c> (copy to
1213clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1214this:
1215
1216 URxvt.keysym.C-M-c: builtin-string:
1217 URxvt.keysym.C-M-v: builtin-string:
1218
1219=item EXTENSION:STRING
1220
1221An action of this form invokes the action B<STRING>, if any, provided
1222by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1223be loaded automatically if necessary.
1224
1225Not all extensions define actions, but popular extensions that do
1226include the I<selection> and I<matcher> extensions (documented in their
1227own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1228respectively).
1229
1230From the silly examples department, this will rot13-"encrypt"
1231@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1232keyboards:
1233
1234 URxvt.keysym.M-C-c: selection:rot13
1235
1236=item perl:STRING *DEPRECATED*
1237
1238This is a deprecated way of invoking commands provided by perl
1239extensions. It is still supported, but should not be used anymore.
1240
1241=back
1211 1242
1212=item B<perl-ext-common>: I<string> 1243=item B<perl-ext-common>: I<string>
1213 1244
1214=item B<perl-ext>: I<string> 1245=item B<perl-ext>: I<string>
1215 1246
1217use in this terminal instance; option B<-pe>. 1248use in this terminal instance; option B<-pe>.
1218 1249
1219Extension names can be prefixed with a C<-> sign to prohibit using 1250Extension names can be prefixed with a C<-> sign to prohibit using
1220them. This can be useful to selectively disable some extensions loaded 1251them. This can be useful to selectively disable some extensions loaded
1221by default, or specified via the C<perl-ext-common> resource. For 1252by default, or specified via the C<perl-ext-common> resource. For
1222example, C<default,-selection> will use all the default extension except 1253example, C<default,-selection> will use all the default extensions except
1223C<selection>. 1254C<selection>.
1224 1255
1225Extension names can also be followed by an argument in angle brackets 1256The default set includes the C<selection>, C<option-popup>,
1226(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1257C<selection-popup>, C<readline> and C<searchable-scrollback>
1227searchable scrollback to Alt/Meta-s). Mentioning the same extension 1258extensions, and extensions which are mentioned in B<keysym> resources.
1228multiple times with different arguments will pass multiple arguments to 1259
1229the extension. 1260Any extension such that a corresponding resource is given on the
1261command line is automatically appended to B<perl-ext>.
1230 1262
1231Each extension is looked up in the library directories, loaded if 1263Each extension is looked up in the library directories, loaded if
1232necessary, and bound to the current terminal instance. 1264necessary, and bound to the current terminal instance. When the library
1265search path contains multiple extension files of the same name, then the
1266first one found will be used.
1233 1267
1234If both of these resources are the empty string, then the perl 1268If both of these resources are the empty string, then the perl interpreter
1235interpreter will not be initialized. The idea behind two options is that 1269will not be initialized. The rationale for having two options is that
1236B<perl-ext-common> will be used for extensions that should be available to 1270B<perl-ext-common> will be used for extensions that should be available to
1237all instances, while B<perl-ext> is used for specific instances. 1271all instances, while B<perl-ext> is used for specific instances.
1238 1272
1239=item B<perl-eval>: I<string> 1273=item B<perl-eval>: I<string>
1240 1274
1242the @@RXVT_NAME@@perl(3) manpage. 1276the @@RXVT_NAME@@perl(3) manpage.
1243 1277
1244=item B<perl-lib>: I<path> 1278=item B<perl-lib>: I<path>
1245 1279
1246Colon-separated list of additional directories that hold extension 1280Colon-separated list of additional directories that hold extension
1247scripts. When looking for extensions specified by the C<perl> resource, 1281scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1248@@RXVT_NAME@@ will first look in these directories and then in 1282in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1249F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1283lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1250 1284
1251See the @@RXVT_NAME@@perl(3) manpage. 1285See the @@RXVT_NAME@@perl(3) manpage.
1252 1286
1253=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1287=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1254 1288
1258=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1292=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1259 1293
1260Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1294Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1261for details. 1295for details.
1262 1296
1263=item B<searchable-scrollback:> I<keysym> 1297=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1264 1298
1265Sets the hotkey that starts the incremental scrollback buffer search 1299This resource is deprecated and will be removed. Use a B<keysym> resource
1266(default: C<M-s>). 1300instead, e.g.:
1267 1301
1302 URxvt.keysym.M-s: searchable-scrollback:start
1303
1268=item B<urlLauncher>: I<string> 1304=item B<url-launcher>: I<string>
1269 1305
1270Specifies the program to be started with a URL argument. Used by the 1306Specifies the program to be started with a URL argument. Used by the
1271C<selection-popup> and C<matcher> perl extensions. 1307C<selection-popup> and C<matcher> perl extensions.
1272 1308
1273=item B<transient-for>: I<windowid> 1309=item B<transient-for>: I<windowid>
1284Turn on/off ISO 14755 (default enabled). 1320Turn on/off ISO 14755 (default enabled).
1285 1321
1286=item B<iso14755_52:> I<boolean> 1322=item B<iso14755_52:> I<boolean>
1287 1323
1288Turn on/off ISO 14755 5.2 mode (default enabled). 1324Turn on/off ISO 14755 5.2 mode (default enabled).
1325
1326=back
1327
1328=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1329
1330=over 4
1331
1332=item B<-pixmap> I<file[;oplist]>
1333
1334=item B<backgroundPixmap:> I<file[;oplist]>
1335
1336Compile I<pixbuf>: Use the specified image file as the window's
1337background and also optionally specify a colon separated list of
1338operations to modify it. Note that you may need to quote the C<;>
1339character when using the command line option, as C<;> is usually a
1340metacharacter in shells. Supported operations are:
1341
1342=over 4
1343
1344=item B<WxH+X+Y>
1345
1346sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1347scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1348scale of 0 disables scaling.
1349
1350=item B<op=tile>
1351
1352enables tiling
1353
1354=item B<op=keep-aspect>
1355
1356maintain the image aspect ratio when scaling
1357
1358=item B<op=root-align>
1359
1360use the position of the terminal window relative to the root window as
1361the image offset, simulating a root window background
1362
1363=back
1364
1365The default scale and position setting is C<100x100+50+50>.
1366Alternatively, a predefined set of templates can be used to achieve
1367the most common setups:
1368
1369=over 4
1370
1371=item B<style=tiled>
1372
1373the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1374
1375=item B<style=aspect-stretched>
1376
1377the image is scaled to fill the whole window maintaining the aspect
1378ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1379
1380=item B<style=stretched>
1381
1382the image is scaled to fill the whole window. Equivalent to 100x100
1383
1384=item B<style=centered>
1385
1386the image is centered with no scaling. Equivalent to 0x0+50+50
1387
1388=item B<style=root-tiled>
1389
1390the image is tiled with no scaling and using 'root' positioning.
1391Equivalent to 0x0:op=tile:op=root-align
1392
1393=back
1394
1395If multiple templates are specified the last one wins. Note that a
1396template overrides all the scale, position and operations settings.
1397
1398If used in conjunction with pseudo-transparency, the specified pixmap
1399will be blended over the transparent background using alpha-blending.
1400
1401=item B<-tr>|B<+tr>
1402
1403=item B<transparent:> I<boolean>
1404
1405Turn on/off pseudo-transparency by using the root pixmap as background.
1406
1407B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1408will be removed in future versions.
1409
1410=item B<-tint> I<colour>
1411
1412=item B<tintColor:> I<colour>
1413
1414Tint the transparent background with the given colour. Note that a
1415black tint yields a completely black image while a white tint yields
1416the image unchanged.
1417
1418=item B<-sh> I<number>
1419
1420=item B<shading:> I<number>
1421
1422Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1423A value of 100 means no shading.
1424
1425=item B<-blr> I<HxV>
1426
1427=item B<blurRadius:> I<HxV>
1428
1429Apply gaussian blur with the specified radius to the transparent
1430background. If a single number is specified, the vertical and
1431horizontal radii are considered to be the same. Setting one of the
1432radii to 1 and the other to a large number creates interesting effects
1433on some backgrounds. The maximum radius value is 128. An horizontal or
1434vertical radius of 0 disables blurring.
1435
1436=item B<path:> I<path>
1437
1438Specify the colon-delimited search path for finding background image files.
1289 1439
1290=back 1440=back
1291 1441
1292=head1 THE SCROLLBAR 1442=head1 THE SCROLLBAR
1293 1443
1341window causes the value of the PRIMARY selection (or CLIPBOARD with the 1491window causes the value of the PRIMARY selection (or CLIPBOARD with the
1342B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1492B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1343 1493
1344Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1494Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1345inserted too. 1495inserted too.
1496
1497rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1498<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1499binding causes the value of the internal selection to be copied to the
1500CLIPBOARD selection, while the second binding causes the value of the
1501CLIPBOARD selection to be inserted.
1346 1502
1347=back 1503=back
1348 1504
1349=head1 CHANGING FONTS 1505=head1 CHANGING FONTS
1350 1506
1439In addition to the default foreground and background colours, 1595In addition to the default foreground and background colours,
1440B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1596B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1441high-intensity (potentially bold/blink) versions of the same, and 72 (or 1597high-intensity (potentially bold/blink) versions of the same, and 72 (or
1442240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1598240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1443cube plus a 8 (24) colour greyscale ramp. 1599cube plus a 8 (24) colour greyscale ramp.
1600
1601B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1602C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1603number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1604colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
160524-bit colour space. When indexing collisions happen, the nearest old colour in
1606the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1607use many similar 24-bit colours. It's typically not a problem in common
1608scenarios.
1444 1609
1445Here is a list of the ANSI colours with their names. 1610Here is a list of the ANSI colours with their names.
1446 1611
1447=begin table 1612=begin table
1448 1613
1475The following text gives values for the standard 88 colour mode (and 1640The following text gives values for the standard 88 colour mode (and
1476values for the 256 colour mode in parentheses). 1641values for the 256 colour mode in parentheses).
1477 1642
1478The RGB cube uses indices 16..79 (16..231) using the following formulas: 1643The RGB cube uses indices 16..79 (16..231) using the following formulas:
1479 1644
1480 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1645 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1481 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1646 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1482 1647
1483The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1648The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1484steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1649steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1485the RGB cube. 1650the RGB cube.
1486 1651
1502White. 1667White.
1503 1668
1504=head2 ALPHA CHANNEL SUPPORT 1669=head2 ALPHA CHANNEL SUPPORT
1505 1670
1506If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1671If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1507their act together, rxvt-unicode will do it's own alpha channel management: 1672their act together, rxvt-unicode will do its own alpha channel management:
1508 1673
1509You can prefix any colour with an opaqueness percentage enclosed in 1674You can prefix any colour with an opaqueness percentage enclosed in
1510brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1675brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1511(0-100) that specifies the opacity of the colour, where C<0> is completely 1676(0-100) that specifies the opacity of the colour, where C<0> is completely
1512transparent and C<100> is completely opaque. For example, C<[50]red> is a 1677transparent and C<100> is completely opaque. For example, C<[50]red> is a
1594 1759
1595=item B<SHELL> 1760=item B<SHELL>
1596 1761
1597The shell to be used for command execution, defaults to C</bin/sh>. 1762The shell to be used for command execution, defaults to C</bin/sh>.
1598 1763
1599=item B<RXVT_SOCKET> 1764=item B<RXVT_SOCKET> [I<sic>]
1600 1765
1601The unix domain socket path used by @@RXVT_NAME@@c(1) and 1766The unix domain socket path used by @@RXVT_NAME@@c(1) and
1602@@RXVT_NAME@@d(1). 1767@@RXVT_NAME@@d(1).
1603 1768
1604Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1769Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1770
1771=item B<URXVT_PERL_LIB>
1772
1773Additional F<:>-separated library search path for perl extensions. Will be
1774searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1775directory.
1776
1777=item B<URXVT_PERL_VERBOSITY>
1778
1779See L<@@RXVT_NAME@@perl>(3).
1605 1780
1606=item B<HOME> 1781=item B<HOME>
1607 1782
1608Used to locate the default directory for the unix domain socket for 1783Used to locate the default directory for the unix domain socket for
1609daemon communications and to locate various resource files (such as 1784daemon communications and to locate various resource files (such as
1630 1805
1631=back 1806=back
1632 1807
1633=head1 SEE ALSO 1808=head1 SEE ALSO
1634 1809
1810@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1635@@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) 1811@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1636 1812
1637=head1 CURRENT PROJECT COORDINATOR 1813=head1 CURRENT PROJECT COORDINATOR
1638 1814
1639=over 4 1815=over 4
1640 1816
1641=item Project Coordinator 1817=item Project Coordinator
1642 1818
1643Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1819Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1644 1820
1645L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1821L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1646 1822
1647=back 1823=back
1648 1824
1652 1828
1653=item John Bovey 1829=item John Bovey
1654 1830
1655University of Kent, 1992, wrote the original Xvt. 1831University of Kent, 1992, wrote the original Xvt.
1656 1832
1657=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1833=item Rob Nation <nation@rocket.sanders.lockheed.com>
1658 1834
1659very heavily modified Xvt and came up with Rxvt 1835very heavily modified Xvt and came up with Rxvt
1660 1836
1661=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1837=item Angelo Haritsis <ah@doc.ic.ac.uk>
1662 1838
1663wrote the Greek Keyboard Input (no longer in code) 1839wrote the Greek Keyboard Input (no longer in code)
1664 1840
1665=item mj olesen L<< <olesen@me.QueensU.CA> >> 1841=item mj olesen <olesen@me.QueensU.CA>
1666 1842
1667Wrote the menu system. 1843Wrote the menu system.
1668 1844
1669Project Coordinator (changes.txt 2.11 to 2.21) 1845Project Coordinator (changes.txt 2.11 to 2.21)
1670 1846
1671=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1847=item Oezguer Kesim <kesim@math.fu-berlin.de>
1672 1848
1673Project Coordinator (changes.txt 2.21a to 2.4.5) 1849Project Coordinator (changes.txt 2.21a to 2.4.5)
1674 1850
1675=item Geoff Wing L<< <gcw@pobox.com> >> 1851=item Geoff Wing <gcw@pobox.com>
1676 1852
1677Rewrote screen display and text selection routines. 1853Rewrote screen display and text selection routines.
1678 1854
1679Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1855Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1680 1856
1681=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1857=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1682 1858
1683Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1859Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1684extension, random hacks, numerous bugfixes and extensions. 1860extension, random hacks, numerous bugfixes and extensions.
1685 1861
1686Project Coordinator (Changes 1.0 -) 1862Project Coordinator (Changes 1.0 -)
1687 1863
1688=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1864=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1689 1865
1690pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1866pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1691 1867
1692=back 1868=back
1693 1869

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines