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.205 by sf-exg, Fri Nov 18 02:15:22 2011 UTC vs.
Revision 1.231 by root, Sat May 17 17:12:29 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 possible
114visual ids).
115
111=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
112 117
113Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
114 119
115=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 127
123=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
124 129
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn 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 131
134=item B<-fade> I<number> 132=item B<-fade> I<number>
135 133
136Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
137fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
140=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
141 139
142Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
143is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
144 142
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> 143=item B<-icon> I<file>
175 144
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>. 147application window; resource I<iconFile>.
179 148
180=item B<-bg> I<colour> 149=item B<-bg> I<colour>
181 150
182Window background colour; resource B<background>. 151Window background colour; resource B<background>.
183 152
184=item B<-fg> I<colour> 153=item B<-fg> I<colour>
185 154
186Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
187
188=item B<-pixmap> I<file[;oplist]>
189
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191optionally specify a list of operations to modify it. 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 156
195=item B<-cr> I<colour> 157=item B<-cr> I<colour>
196 158
197The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
198 160
687 649
688B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the 651if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
691 653
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> 654=item B<fading:> I<number>
700 655
701Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
702 657
703=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
704 659
705Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
706colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
707 662
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> 663=item B<iconFile:> I<file>
731 664
732Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
733 666
734=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
742 675
743=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
744 677
745The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
746and the text. 679and the text.
747
748=item B<backgroundPixmap:> I<file[;oplist]>
749
750Use the specified image file for the background and also
751optionally specify a colon separated list of operations to modify it.
752Supported operations are:
753
754=over 4
755
756=item B<WxH+X+Y>
757
758sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
760scale of 0 disables scaling. The maximum permitted scale is 1000.
761
762=item B<op=tile>
763
764enables tiling
765
766=item B<op=pscale>
767
768enables proportional scaling
769
770=item B<op=root>
771
772use the position of the terminal window relative to the root window as
773the image offset, simulating a root window background
774
775=back
776
777The default scale and position setting is C<100x100+50+50>.
778Alternatively, a predefined set of templates can be used to achieve
779the most common setups:
780
781=over 4
782
783=item B<style=tiled>
784
785the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786
787=item B<style=aspect-stretched>
788
789the image is scaled to fill the whole window maintaining the aspect
790ratio and centered. Equivalent to 100x100+50+50:op=pscale
791
792=item B<style=stretched>
793
794the image is scaled to fill the whole window. Equivalent to 100x100
795
796=item B<style=centered>
797
798the image is centered with no scaling. Equivalent to 0x0+50+50
799
800=item B<style=root-tiled>
801
802the image is tiled with no scaling and using 'root' positioning.
803Equivalent to 0x0:op=tile:op=root
804
805=back
806
807If multiple templates are specified the last one wins. Note that a
808template overrides all the scale, position and operations settings.
809
810If used in conjunction with B<-tr> option, the specified pixmap will be
811blended over the transparent background using alpha-blending. If I<afterimage>
812support has been compiled in it is possible to choose other blending
813types with B<-blt "type"> option.
814
815=item B<path:> I<path>
816
817Specify the colon-delimited search path for finding background image files.
818 680
819=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
820 682
821Select the fonts to be used. This is a comma separated list of font names 683Select the fonts to be used. This is a comma separated list of font names
822that are checked in order when trying to find glyphs for characters. The 684that are checked in order when trying to find glyphs for characters. The
1179Sets the working directory for the shell (or the command specified via 1041Sets the working directory for the shell (or the command specified via
1180B<-e>). The I<path> must be an absolute path and it must exist for 1042B<-e>). The I<path> must be an absolute path and it must exist for
1181@@RXVT_NAME@@ to start. If it isn't specified then the current working 1043@@RXVT_NAME@@ to start. If it isn't specified then the current working
1182directory will be used; option B<-cd>. 1044directory will be used; option B<-cd>.
1183 1045
1184=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1185 1047
1186Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1187intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1188 1050
1189The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1190any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1191B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1053string than would normally result from that combination, making the
1192and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1054terminal scroll up or down the way you want it, or any other thing an
1193B<2>, B<3>, B<4>, B<5>. 1055extension might provide.
1056
1057The key combination that triggers the action, I<sym>, has the following format:
1058
1059 (modifiers-)key
1060
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1062B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1064B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1194 1065
1195The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1066The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1196whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1067whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1197keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1068keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1198current application keymap mode state. 1069current application keymap mode state.
1199 1070
1200The spellings of I<key> can be obtained by using B<xev>(1) command or 1071Due the the large number of modifier combinations, a key mapping will
1201searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1072match if I<at least> the specified identifiers are being set, and no other
1073key mappings with those and more bits are being defined. That means that
1074defining a mapping for C<a> will automatically provide definitions for
1075C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1076themselves. See the C<builtin:> action, below, for a way to work around
1077this when this is a problem.
1078
1079The spelling of I<key> depends on your implementation of X. An easy way to
1080find a key name is to use the B<xev>(1) command. You can find a list by
1081looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1202omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1082the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1203keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1204performed in an exact manner; however, the closest match is assured.
1205 1084
1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1085As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1207number), see RESOURCES in C<man 7 X> for further details. 1087number), see RESOURCES in C<man 7 X> for further details.
1208 1088
1209You can define a range of keysyms in one shot by providing a I<string> 1089An action starts with an action prefix that selects a certain type
1210with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1090of action, followed by a colon. An action strings without colons is
1211should be a character not used by the strings. 1091interpreted as a literal string to pass to the tty (as if they were
1092prefixed with C<string:>).
1212 1093
1213Its usage can be demonstrated by an example: 1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1214 1096
1215 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1097=over 4
1216 1098
1217The above line is equivalent to the following three lines: 1099=item string:STRING
1218 1100
1219 URxvt.keysym.Meta-Control-0x61: \033<a> 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1220 URxvt.keysym.Meta-Control-0x62: \033<b> 1102then the remaining C<STRING> will be passed to the program running in the
1221 URxvt.keysym.Meta-Control-0x63: \033<c> 1103terminal. For example, you could replace whatever Shift-Tab outputs by the
1104string C<echo rm -rf /> followed by a newline:
1222 1105
1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107
1108This could in theory be used to completely redefine your keymap.
1109
1110=item command:STRING
1111
1223If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1112If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1224is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1114the opposite of C<string:> - instead of sending it to the program running
1115in the terminal, it will be treated as if it were program output). This is
1116most useful to feed command sequences into @@RXVT_NAME@@.
1117
1225example the following means "change the current locale to C<zh_CN.GBK> 1118For example the following means "change the current locale to C<zh_CN.GBK>
1226when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1227 1120
1228 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1121 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1229 1122
1230If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1123The following example will map Control-Meta-1 and Control-Meta-2 to
1231is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1124the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1232manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1233C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1234 1126
1235 URxvt.keysym.M-C-c: perl:selection:rot13 1127 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1128 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1236 1129
1237Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1238will match if I<at least> the specified identifiers are being set, and 1131info):
1239no other key mappings with those and more bits are being defined. That
1240means that defining a key map for C<a> will automatically provide
1241definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1242mappings themselves.
1243 1132
1244Unfortunately, this will override built-in key mappings. For example 1133 URxvt.keysym.M-C-3: command:\033[8;25;80t
1134 URxvt.keysym.M-C-4: command:\033[8;48;110t
1135
1136=item builtin:
1137
1138The builtin action is the action that @@RXVT_NAME@@ would execute if no
1139key binding existed for the key combination. The obvious use is to undo
1140the effect of existing bindings. The not so obvious use is to reinstate
1141bindings when another binding overrides too many modifiers.
1142
1245if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1246C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1144@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1247user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1248 1146
1249 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1250 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1251 1149
1252The first line defines a mapping for C<Insert> and I<any> combination 1150The first line defines a mapping for C<Insert> and I<any> combination
1253of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1254C<Shift-Insert>. 1152C<Shift-Insert>.
1255 1153
1256The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item builtin-string:
1257the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1258font-switching at runtime:
1259 1155
1260 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1156This action is mainly useful to restore string mappings for keys that
1261 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1157have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1158difficult to explain - basically, this action will send the string to the
1159application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1160action for it.
1262 1161
1263Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1162An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1264info): 1163selection when you press C<Shift-Insert>. With the following bindings, it
1164would instead emit the (undocumented, but what applications running in the
1165terminal might expect) sequence C<ESC [ 2 $> instead:
1265 1166
1266 URxvt.keysym.M-C-3: command:\033[8;25;80t 1167 URxvt.keysym.S-Insert: builtin-string:
1267 URxvt.keysym.M-C-4: command:\033[8;48;110t 1168 URxvt.keysym.C-S-Insert: builtin:
1169
1170The first line disables the paste functionality for that key
1171combination, and the second reinstates the default behaviour for
1172C<Control-Shift-Insert>, which would otherwise be overridden.
1173
1174Similarly, to let applications gain access to the C<C-M-c> (copy to
1175clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this:
1177
1178 URxvt.keysym.C-S-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string:
1180
1181=item EXTENSION:STRING
1182
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1184extension of the same name. The extension will be loaded automatically if
1185neccessary.
1186
1187Not all extensions define key actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively).
1191
1192From the silly examples department, this will rot13-"encrypt"
1193@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1194keyboards:
1195
1196 URxvt.keysym.M-C-c: selection:rot13
1197
1198=item perl:STRING *DEPRECATED*
1199
1200This is a deprecated way of passing key mappings to perl extensions. It is
1201still supported, but should not be used anymore.
1202
1203=back
1268 1204
1269=item B<perl-ext-common>: I<string> 1205=item B<perl-ext-common>: I<string>
1270 1206
1271=item B<perl-ext>: I<string> 1207=item B<perl-ext>: I<string>
1272 1208
1277them. This can be useful to selectively disable some extensions loaded 1213them. This can be useful to selectively disable some extensions loaded
1278by default, or specified via the C<perl-ext-common> resource. For 1214by default, or specified via the C<perl-ext-common> resource. For
1279example, C<default,-selection> will use all the default extension except 1215example, C<default,-selection> will use all the default extension except
1280C<selection>. 1216C<selection>.
1281 1217
1282Extension names can also be followed by an argument in angle brackets 1218Some extensions define resources or command line switches, and will
1283(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1219automatically be used when their resource or switch is specified.
1284searchable scrollback to Alt/Meta-s). Mentioning the same extension
1285multiple times with different arguments will pass multiple arguments to
1286the extension.
1287 1220
1288Each extension is looked up in the library directories, loaded if 1221Each extension is looked up in the library directories, loaded if
1289necessary, and bound to the current terminal instance. 1222necessary, and bound to the current terminal instance.
1290 1223
1291If both of these resources are the empty string, then the perl 1224If both of these resources are the empty string, then the perl interpreter
1292interpreter will not be initialized. The idea behind two options is that 1225will not be initialized. The rationale for having two options is that
1293B<perl-ext-common> will be used for extensions that should be available to 1226B<perl-ext-common> will be used for extensions that should be available to
1294all instances, while B<perl-ext> is used for specific instances. 1227all instances, while B<perl-ext> is used for specific instances.
1295 1228
1296=item B<perl-eval>: I<string> 1229=item B<perl-eval>: I<string>
1297 1230
1299the @@RXVT_NAME@@perl(3) manpage. 1232the @@RXVT_NAME@@perl(3) manpage.
1300 1233
1301=item B<perl-lib>: I<path> 1234=item B<perl-lib>: I<path>
1302 1235
1303Colon-separated list of additional directories that hold extension 1236Colon-separated list of additional directories that hold extension
1304scripts. When looking for extensions specified by the C<perl> resource, 1237scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1305@@RXVT_NAME@@ will first look in these directories and then in 1238in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1306F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1239lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1307 1240
1308See the @@RXVT_NAME@@perl(3) manpage. 1241See the @@RXVT_NAME@@perl(3) manpage.
1309 1242
1310=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1243=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1311 1244
1315=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1248=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1316 1249
1317Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1250Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1318for details. 1251for details.
1319 1252
1320=item B<searchable-scrollback:> I<keysym> 1253=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1321 1254
1322Sets the hotkey that starts the incremental scrollback buffer search 1255This resource is deprecated and will be removed. Use a B<keysym> resource
1323(default: C<M-s>). 1256instead, e.g.:
1324 1257
1258 URxvt.keysym.M-s: searchable-scrollback:start
1259
1325=item B<urlLauncher>: I<string> 1260=item B<url-launcher>: I<string>
1326 1261
1327Specifies the program to be started with a URL argument. Used by the 1262Specifies the program to be started with a URL argument. Used by the
1328C<selection-popup> and C<matcher> perl extensions. 1263C<selection-popup> and C<matcher> perl extensions.
1329 1264
1330=item B<transient-for>: I<windowid> 1265=item B<transient-for>: I<windowid>
1341Turn on/off ISO 14755 (default enabled). 1276Turn on/off ISO 14755 (default enabled).
1342 1277
1343=item B<iso14755_52:> I<boolean> 1278=item B<iso14755_52:> I<boolean>
1344 1279
1345Turn on/off ISO 14755 5.2 mode (default enabled). 1280Turn on/off ISO 14755 5.2 mode (default enabled).
1281
1282=back
1283
1284=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1285
1286=over 4
1287
1288=item B<-pixmap> I<file[;oplist]>
1289
1290=item B<backgroundPixmap:> I<file[;oplist]>
1291
1292Compile I<pixbuf>: Use the specified image file as the window's
1293background and also optionally specify a colon separated list of
1294operations to modify it. Note that you may need to quote the C<;>
1295character when using the command line option, as C<;> is usually a
1296metacharacter in shells. Supported operations are:
1297
1298=over 4
1299
1300=item B<WxH+X+Y>
1301
1302sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1303scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1304scale of 0 disables scaling.
1305
1306=item B<op=tile>
1307
1308enables tiling
1309
1310=item B<op=keep-aspect>
1311
1312maintain the image aspect ratio when scaling
1313
1314=item B<op=root-align>
1315
1316use the position of the terminal window relative to the root window as
1317the image offset, simulating a root window background
1318
1319=back
1320
1321The default scale and position setting is C<100x100+50+50>.
1322Alternatively, a predefined set of templates can be used to achieve
1323the most common setups:
1324
1325=over 4
1326
1327=item B<style=tiled>
1328
1329the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1330
1331=item B<style=aspect-stretched>
1332
1333the image is scaled to fill the whole window maintaining the aspect
1334ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1335
1336=item B<style=stretched>
1337
1338the image is scaled to fill the whole window. Equivalent to 100x100
1339
1340=item B<style=centered>
1341
1342the image is centered with no scaling. Equivalent to 0x0+50+50
1343
1344=item B<style=root-tiled>
1345
1346the image is tiled with no scaling and using 'root' positioning.
1347Equivalent to 0x0:op=tile:op=root-align
1348
1349=back
1350
1351If multiple templates are specified the last one wins. Note that a
1352template overrides all the scale, position and operations settings.
1353
1354If used in conjunction with pseudo-transparency, the specified pixmap
1355will be blended over the transparent background using alpha-blending.
1356
1357=item B<-tr>|B<+tr>
1358
1359=item B<transparent:> I<boolean>
1360
1361Turn on/off pseudo-transparency by using the root pixmap as background.
1362
1363B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1364will be removed in future versions.
1365
1366=item B<-tint> I<colour>
1367
1368=item B<tintColor:> I<colour>
1369
1370Tint the transparent background with the given colour. Note that a
1371black tint yields a completely black image while a white tint yields
1372the image unchanged.
1373
1374=item B<-sh> I<number>
1375
1376=item B<shading:> I<number>
1377
1378Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1379A value of 100 means no shading.
1380
1381=item B<-blr> I<HxV>
1382
1383=item B<blurRadius:> I<HxV>
1384
1385Apply gaussian blur with the specified radius to the transparent
1386background. If a single number is specified, the vertical and
1387horizontal radii are considered to be the same. Setting one of the
1388radii to 1 and the other to a large number creates interesting effects
1389on some backgrounds. The maximum radius value is 128. An horizontal or
1390vertical radius of 0 disables blurring.
1391
1392=item B<path:> I<path>
1393
1394Specify the colon-delimited search path for finding background image files.
1346 1395
1347=back 1396=back
1348 1397
1349=head1 THE SCROLLBAR 1398=head1 THE SCROLLBAR
1350 1399
1398window causes the value of the PRIMARY selection (or CLIPBOARD with the 1447window causes the value of the PRIMARY selection (or CLIPBOARD with the
1399B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1448B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1400 1449
1401Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1450Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1402inserted too. 1451inserted too.
1452
1453rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1454<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1455binding causes the value of the internal selection to be copied to the
1456CLIPBOARD selection, while the second binding causes the value of the
1457CLIPBOARD selection to be inserted.
1403 1458
1404=back 1459=back
1405 1460
1406=head1 CHANGING FONTS 1461=head1 CHANGING FONTS
1407 1462
1532The following text gives values for the standard 88 colour mode (and 1587The following text gives values for the standard 88 colour mode (and
1533values for the 256 colour mode in parentheses). 1588values for the 256 colour mode in parentheses).
1534 1589
1535The RGB cube uses indices 16..79 (16..231) using the following formulas: 1590The RGB cube uses indices 16..79 (16..231) using the following formulas:
1536 1591
1537 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1592 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1538 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1593 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1539 1594
1540The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1595The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1541steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1596steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1542the RGB cube. 1597the RGB cube.
1543 1598
1559White. 1614White.
1560 1615
1561=head2 ALPHA CHANNEL SUPPORT 1616=head2 ALPHA CHANNEL SUPPORT
1562 1617
1563If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1618If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1564their act together, rxvt-unicode will do it's own alpha channel management: 1619their act together, rxvt-unicode will do its own alpha channel management:
1565 1620
1566You can prefix any colour with an opaqueness percentage enclosed in 1621You can prefix any colour with an opaqueness percentage enclosed in
1567brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1622brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1568(0-100) that specifies the opacity of the colour, where C<0> is completely 1623(0-100) that specifies the opacity of the colour, where C<0> is completely
1569transparent and C<100> is completely opaque. For example, C<[50]red> is a 1624transparent and C<100> is completely opaque. For example, C<[50]red> is a
1651 1706
1652=item B<SHELL> 1707=item B<SHELL>
1653 1708
1654The shell to be used for command execution, defaults to C</bin/sh>. 1709The shell to be used for command execution, defaults to C</bin/sh>.
1655 1710
1656=item B<RXVT_SOCKET> 1711=item B<RXVT_SOCKET> [I<sic>]
1657 1712
1658The unix domain socket path used by @@RXVT_NAME@@c(1) and 1713The unix domain socket path used by @@RXVT_NAME@@c(1) and
1659@@RXVT_NAME@@d(1). 1714@@RXVT_NAME@@d(1).
1660 1715
1661Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1716Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1717
1718=item B<URXVT_PERL_LIB>
1719
1720Additional F<:>-separated library search path for perl extensions. Will be
1721searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1722directory.
1723
1724=item B<URXVT_PERL_VERBOSITY>
1725
1726See L<@@RXVT_NAME@@perl>(3).
1662 1727
1663=item B<HOME> 1728=item B<HOME>
1664 1729
1665Used to locate the default directory for the unix domain socket for 1730Used to locate the default directory for the unix domain socket for
1666daemon communications and to locate various resource files (such as 1731daemon communications and to locate various resource files (such as
1687 1752
1688=back 1753=back
1689 1754
1690=head1 SEE ALSO 1755=head1 SEE ALSO
1691 1756
1757@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1692@@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) 1758@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1693 1759
1694=head1 CURRENT PROJECT COORDINATOR 1760=head1 CURRENT PROJECT COORDINATOR
1695 1761
1696=over 4 1762=over 4
1697 1763
1698=item Project Coordinator 1764=item Project Coordinator
1699 1765
1700Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1766Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1701 1767
1702L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1768L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1703 1769
1704=back 1770=back
1705 1771
1709 1775
1710=item John Bovey 1776=item John Bovey
1711 1777
1712University of Kent, 1992, wrote the original Xvt. 1778University of Kent, 1992, wrote the original Xvt.
1713 1779
1714=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1780=item Rob Nation <nation@rocket.sanders.lockheed.com>
1715 1781
1716very heavily modified Xvt and came up with Rxvt 1782very heavily modified Xvt and came up with Rxvt
1717 1783
1718=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1784=item Angelo Haritsis <ah@doc.ic.ac.uk>
1719 1785
1720wrote the Greek Keyboard Input (no longer in code) 1786wrote the Greek Keyboard Input (no longer in code)
1721 1787
1722=item mj olesen L<< <olesen@me.QueensU.CA> >> 1788=item mj olesen <olesen@me.QueensU.CA>
1723 1789
1724Wrote the menu system. 1790Wrote the menu system.
1725 1791
1726Project Coordinator (changes.txt 2.11 to 2.21) 1792Project Coordinator (changes.txt 2.11 to 2.21)
1727 1793
1728=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1794=item Oezguer Kesim <kesim@math.fu-berlin.de>
1729 1795
1730Project Coordinator (changes.txt 2.21a to 2.4.5) 1796Project Coordinator (changes.txt 2.21a to 2.4.5)
1731 1797
1732=item Geoff Wing L<< <gcw@pobox.com> >> 1798=item Geoff Wing <gcw@pobox.com>
1733 1799
1734Rewrote screen display and text selection routines. 1800Rewrote screen display and text selection routines.
1735 1801
1736Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1802Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1737 1803
1738=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1804=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1739 1805
1740Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1806Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1741extension, random hacks, numerous bugfixes and extensions. 1807extension, random hacks, numerous bugfixes and extensions.
1742 1808
1743Project Coordinator (Changes 1.0 -) 1809Project Coordinator (Changes 1.0 -)
1744 1810
1745=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1811=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1746 1812
1747pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1813pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1748 1814
1749=back 1815=back
1750 1816

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines