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.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC vs.
Revision 1.233 by sf-exg, Sat May 24 18:41: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<-blr> I<HxV>
156
157Apply Gaussian Blur with the specified radii to the transparent
158background. If a single number is specified, the vertical and
159horizontal radii are considered to be the same. Setting one of the
160radii to 1 and the other to a large number creates interesting effects
161on some backgrounds. The maximum radius value is 128. An horizontal or
162vertical radius of 0 disables blurring;
163resource I<blurRadius>.
164
165=item B<-icon> I<file> 143=item B<-icon> I<file>
166 144
167Compile I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
168is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
169application window; resource I<iconFile>. 147application window; resource I<iconFile>.
… …
173Window background colour; resource B<background>. 151Window background colour; resource B<background>.
174 152
175=item B<-fg> I<colour> 153=item B<-fg> I<colour>
176 154
177Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
178
179=item B<-pixmap> I<file[;oplist]>
180
181Compile I<pixbuf>: Specify image file for the background and also
182optionally specify a list of operations to modify it. Note you may need to
183add quotes to avoid special shell interpretation of the C<;> in the
184command-line; for more details see resource B<backgroundPixmap>.
185 156
186=item B<-cr> I<colour> 157=item B<-cr> I<colour>
187 158
188The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
189 160
… …
678 649
679B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
680if 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
681monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
682 653
683=item B<transparent:> I<boolean>
684
685Turn on/off pseudo-transparency by using the root pixmap as background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
689
690=item B<fading:> I<number> 654=item B<fading:> I<number>
691 655
692Fade 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>.
693 657
694=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
695 659
696Fade 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
697colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
698 662
699=item B<tintColor:> I<colour>
700
701Tint the transparent background with the given colour. If the RENDER
702extension is not available only black, red, green, yellow, blue,
703magenta, cyan and white tints can be performed server-side. Note that
704a black tint yields a completely black image while a white tint yields
705the image unchanged; option B<-tint>.
706
707=item B<shading:> I<number>
708
709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
710A value of 100 means no shading; option B<-sh>.
711
712=item B<blendType:> I<string>
713
714Specify background blending type; option B<-blt>.
715
716=item B<blurRadius:> I<number>
717
718Apply gaussian blur with the specified radius to the transparent
719background; option B<-blr>.
720
721=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
722 664
723Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
724 666
725=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
… …
733 675
734=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
735 677
736The 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
737and the text. 679and the text.
738
739=item B<backgroundPixmap:> I<file[;oplist]>
740
741Use the specified image file for the background and also
742optionally specify a colon separated list of operations to modify it.
743Supported operations are:
744
745=over 4
746
747=item B<WxH+X+Y>
748
749sets scale and position. B<"W" / "H"> specify the horizontal/vertical
750scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
751scale of 0 disables scaling. The maximum permitted scale is 1000.
752
753=item B<op=tile>
754
755enables tiling
756
757=item B<op=keep-aspect>
758
759maintain the image aspect ratio when scaling
760
761=item B<op=root-align>
762
763use the position of the terminal window relative to the root window as
764the image offset, simulating a root window background
765
766=back
767
768The default scale and position setting is C<100x100+50+50>.
769Alternatively, a predefined set of templates can be used to achieve
770the most common setups:
771
772=over 4
773
774=item B<style=tiled>
775
776the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
777
778=item B<style=aspect-stretched>
779
780the image is scaled to fill the whole window maintaining the aspect
781ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
782
783=item B<style=stretched>
784
785the image is scaled to fill the whole window. Equivalent to 100x100
786
787=item B<style=centered>
788
789the image is centered with no scaling. Equivalent to 0x0+50+50
790
791=item B<style=root-tiled>
792
793the image is tiled with no scaling and using 'root' positioning.
794Equivalent to 0x0:op=tile:op=root-align
795
796=back
797
798If multiple templates are specified the last one wins. Note that a
799template overrides all the scale, position and operations settings.
800
801If used in conjunction with B<-tr> option, the specified pixmap will be
802blended over the transparent background using alpha-blending.
803
804=item B<path:> I<path>
805
806Specify the colon-delimited search path for finding background image files.
807 680
808=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
809 682
810Select 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
811that 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
… …
1168Sets the working directory for the shell (or the command specified via 1041Sets the working directory for the shell (or the command specified via
1169B<-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
1170@@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
1171directory will be used; option B<-cd>. 1044directory will be used; option B<-cd>.
1172 1045
1173=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1174 1047
1175Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1176intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1177 1050
1178The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1179any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1180B<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
1181and 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
1182B<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>.
1183 1065
1184The 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
1185whatever 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
1186keys 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
1187current application keymap mode state. 1069current application keymap mode state.
1188 1070
1189The 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
1190searching 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
1191omitting 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
1192keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1193performed in an exact manner; however, the closest match is assured.
1194 1084
1195I<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
1196number), see RESOURCES in C<man 7 X> for further details. 1087number), see RESOURCES in C<man 7 X> for further details.
1197 1088
1198You can define a range of keysyms in one shot by 1089An action starts with an action prefix that selects a certain type
1199loading the C<keysym-list> perl extension and providing a I<string> 1090of action, followed by a colon. An action string without colons is
1200with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1091interpreted as a literal string to pass to the tty (as if it was
1201should be a character not used by the strings. 1092prefixed with C<string:>).
1202 1093
1203Its usage can be demonstrated by an example: 1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1204 1096
1205 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1097=over 4
1206 1098
1207The above line is equivalent to the following three lines: 1099=item string:STRING
1208 1100
1209 URxvt.keysym.Meta-Control-0x61: \033<a> 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1210 URxvt.keysym.Meta-Control-0x62: \033<b> 1102then the remaining C<STRING> will be passed to the program running in the
1211 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:
1212 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
1213If 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>
1214is 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
1215example 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>
1216when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1217 1120
1218 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
1219 1122
1220If 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
1221is 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
1222manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1223C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1224 1126
1225 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
1226 1129
1227Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1228will match if I<at least> the specified identifiers are being set, and 1131info):
1229no other key mappings with those and more bits are being defined. That
1230means that defining a key map for C<a> will automatically provide
1231definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1232mappings themselves.
1233 1132
1234Unfortunately, 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
1235if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1236C<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
1237user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1238 1146
1239 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1240 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1241 1149
1242The 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
1243of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1244C<Shift-Insert>. 1152C<Shift-Insert>.
1245 1153
1246The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item builtin-string:
1247the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1248font-switching at runtime:
1249 1155
1250 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1156This action is mainly useful to restore string mappings for keys that
1251 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.
1252 1161
1253Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1162An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1254info): 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:
1255 1166
1256 URxvt.keysym.M-C-3: command:\033[8;25;80t 1167 URxvt.keysym.S-Insert: builtin-string:
1257 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
1258 1204
1259=item B<perl-ext-common>: I<string> 1205=item B<perl-ext-common>: I<string>
1260 1206
1261=item B<perl-ext>: I<string> 1207=item B<perl-ext>: I<string>
1262 1208
… …
1264use in this terminal instance; option B<-pe>. 1210use in this terminal instance; option B<-pe>.
1265 1211
1266Extension names can be prefixed with a C<-> sign to prohibit using 1212Extension names can be prefixed with a C<-> sign to prohibit using
1267them. This can be useful to selectively disable some extensions loaded 1213them. This can be useful to selectively disable some extensions loaded
1268by default, or specified via the C<perl-ext-common> resource. For 1214by default, or specified via the C<perl-ext-common> resource. For
1269example, C<default,-selection> will use all the default extension except 1215example, C<default,-selection> will use all the default extensions except
1270C<selection>. 1216C<selection>.
1271 1217
1272Extension names can also be followed by an argument in angle brackets 1218The default set includes the C<selection>, C<option-popup>,
1273(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1219C<selection-popup> and C<readline> extensions, any extensions that define
1274searchable scrollback to Alt/Meta-s). Mentioning the same extension 1220keybindings via C<BINDING> meta comments, extensions loaded because
1275multiple times with different arguments will pass multiple arguments to 1221their resources/commandline switches were used, and extensions which are
1276the extension. 1222mentioned in B<keysym> resources.
1277 1223
1278Each extension is looked up in the library directories, loaded if 1224Each extension is looked up in the library directories, loaded if
1279necessary, and bound to the current terminal instance. 1225necessary, and bound to the current terminal instance. When the library
1226search path contains multiple extension files of the same name, then the
1227first one found will be used.
1280 1228
1281If both of these resources are the empty string, then the perl 1229If both of these resources are the empty string, then the perl interpreter
1282interpreter will not be initialized. The idea behind two options is that 1230will not be initialized. The rationale for having two options is that
1283B<perl-ext-common> will be used for extensions that should be available to 1231B<perl-ext-common> will be used for extensions that should be available to
1284all instances, while B<perl-ext> is used for specific instances. 1232all instances, while B<perl-ext> is used for specific instances.
1285 1233
1286=item B<perl-eval>: I<string> 1234=item B<perl-eval>: I<string>
1287 1235
… …
1289the @@RXVT_NAME@@perl(3) manpage. 1237the @@RXVT_NAME@@perl(3) manpage.
1290 1238
1291=item B<perl-lib>: I<path> 1239=item B<perl-lib>: I<path>
1292 1240
1293Colon-separated list of additional directories that hold extension 1241Colon-separated list of additional directories that hold extension
1294scripts. When looking for perl extensions, @@RXVT_NAME@@ will first 1242scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1295look in these directories, then in $HOME/.urxvt/ext and lastly in 1243in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1296F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1244lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1297 1245
1298See the @@RXVT_NAME@@perl(3) manpage. 1246See the @@RXVT_NAME@@perl(3) manpage.
1299 1247
1300=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1248=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1301 1249
… …
1305=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1253=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1306 1254
1307Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1255Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1308for details. 1256for details.
1309 1257
1310=item B<searchable-scrollback:> I<keysym> 1258=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1311 1259
1312Sets the hotkey that starts the incremental scrollback buffer search 1260This resource is deprecated and will be removed. Use a B<keysym> resource
1313(default: C<M-s>). 1261instead, e.g.:
1314 1262
1263 URxvt.keysym.M-s: searchable-scrollback:start
1264
1315=item B<urlLauncher>: I<string> 1265=item B<url-launcher>: I<string>
1316 1266
1317Specifies the program to be started with a URL argument. Used by the 1267Specifies the program to be started with a URL argument. Used by the
1318C<selection-popup> and C<matcher> perl extensions. 1268C<selection-popup> and C<matcher> perl extensions.
1319 1269
1320=item B<transient-for>: I<windowid> 1270=item B<transient-for>: I<windowid>
… …
1331Turn on/off ISO 14755 (default enabled). 1281Turn on/off ISO 14755 (default enabled).
1332 1282
1333=item B<iso14755_52:> I<boolean> 1283=item B<iso14755_52:> I<boolean>
1334 1284
1335Turn on/off ISO 14755 5.2 mode (default enabled). 1285Turn on/off ISO 14755 5.2 mode (default enabled).
1286
1287=back
1288
1289=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1290
1291=over 4
1292
1293=item B<-pixmap> I<file[;oplist]>
1294
1295=item B<backgroundPixmap:> I<file[;oplist]>
1296
1297Compile I<pixbuf>: Use the specified image file as the window's
1298background and also optionally specify a colon separated list of
1299operations to modify it. Note that you may need to quote the C<;>
1300character when using the command line option, as C<;> is usually a
1301metacharacter in shells. Supported operations are:
1302
1303=over 4
1304
1305=item B<WxH+X+Y>
1306
1307sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1308scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1309scale of 0 disables scaling.
1310
1311=item B<op=tile>
1312
1313enables tiling
1314
1315=item B<op=keep-aspect>
1316
1317maintain the image aspect ratio when scaling
1318
1319=item B<op=root-align>
1320
1321use the position of the terminal window relative to the root window as
1322the image offset, simulating a root window background
1323
1324=back
1325
1326The default scale and position setting is C<100x100+50+50>.
1327Alternatively, a predefined set of templates can be used to achieve
1328the most common setups:
1329
1330=over 4
1331
1332=item B<style=tiled>
1333
1334the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1335
1336=item B<style=aspect-stretched>
1337
1338the image is scaled to fill the whole window maintaining the aspect
1339ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1340
1341=item B<style=stretched>
1342
1343the image is scaled to fill the whole window. Equivalent to 100x100
1344
1345=item B<style=centered>
1346
1347the image is centered with no scaling. Equivalent to 0x0+50+50
1348
1349=item B<style=root-tiled>
1350
1351the image is tiled with no scaling and using 'root' positioning.
1352Equivalent to 0x0:op=tile:op=root-align
1353
1354=back
1355
1356If multiple templates are specified the last one wins. Note that a
1357template overrides all the scale, position and operations settings.
1358
1359If used in conjunction with pseudo-transparency, the specified pixmap
1360will be blended over the transparent background using alpha-blending.
1361
1362=item B<-tr>|B<+tr>
1363
1364=item B<transparent:> I<boolean>
1365
1366Turn on/off pseudo-transparency by using the root pixmap as background.
1367
1368B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1369will be removed in future versions.
1370
1371=item B<-tint> I<colour>
1372
1373=item B<tintColor:> I<colour>
1374
1375Tint the transparent background with the given colour. Note that a
1376black tint yields a completely black image while a white tint yields
1377the image unchanged.
1378
1379=item B<-sh> I<number>
1380
1381=item B<shading:> I<number>
1382
1383Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1384A value of 100 means no shading.
1385
1386=item B<-blr> I<HxV>
1387
1388=item B<blurRadius:> I<HxV>
1389
1390Apply gaussian blur with the specified radius to the transparent
1391background. If a single number is specified, the vertical and
1392horizontal radii are considered to be the same. Setting one of the
1393radii to 1 and the other to a large number creates interesting effects
1394on some backgrounds. The maximum radius value is 128. An horizontal or
1395vertical radius of 0 disables blurring.
1396
1397=item B<path:> I<path>
1398
1399Specify the colon-delimited search path for finding background image files.
1336 1400
1337=back 1401=back
1338 1402
1339=head1 THE SCROLLBAR 1403=head1 THE SCROLLBAR
1340 1404
… …
1388window causes the value of the PRIMARY selection (or CLIPBOARD with the 1452window causes the value of the PRIMARY selection (or CLIPBOARD with the
1389B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1453B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1390 1454
1391Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1455Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1392inserted too. 1456inserted too.
1457
1458rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1459<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1460binding causes the value of the internal selection to be copied to the
1461CLIPBOARD selection, while the second binding causes the value of the
1462CLIPBOARD selection to be inserted.
1393 1463
1394=back 1464=back
1395 1465
1396=head1 CHANGING FONTS 1466=head1 CHANGING FONTS
1397 1467
… …
1522The following text gives values for the standard 88 colour mode (and 1592The following text gives values for the standard 88 colour mode (and
1523values for the 256 colour mode in parentheses). 1593values for the 256 colour mode in parentheses).
1524 1594
1525The RGB cube uses indices 16..79 (16..231) using the following formulas: 1595The RGB cube uses indices 16..79 (16..231) using the following formulas:
1526 1596
1527 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1597 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1528 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1598 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1529 1599
1530The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1600The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1531steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1601steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1532the RGB cube. 1602the RGB cube.
1533 1603
… …
1641 1711
1642=item B<SHELL> 1712=item B<SHELL>
1643 1713
1644The shell to be used for command execution, defaults to C</bin/sh>. 1714The shell to be used for command execution, defaults to C</bin/sh>.
1645 1715
1646=item B<RXVT_SOCKET> 1716=item B<RXVT_SOCKET> [I<sic>]
1647 1717
1648The unix domain socket path used by @@RXVT_NAME@@c(1) and 1718The unix domain socket path used by @@RXVT_NAME@@c(1) and
1649@@RXVT_NAME@@d(1). 1719@@RXVT_NAME@@d(1).
1650 1720
1651Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. 1721Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1722
1723=item B<URXVT_PERL_LIB>
1724
1725Additional F<:>-separated library search path for perl extensions. Will be
1726searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1727directory.
1728
1729=item B<URXVT_PERL_VERBOSITY>
1730
1731See L<@@RXVT_NAME@@perl>(3).
1652 1732
1653=item B<HOME> 1733=item B<HOME>
1654 1734
1655Used to locate the default directory for the unix domain socket for 1735Used to locate the default directory for the unix domain socket for
1656daemon communications and to locate various resource files (such as 1736daemon communications and to locate various resource files (such as
… …
1677 1757
1678=back 1758=back
1679 1759
1680=head1 SEE ALSO 1760=head1 SEE ALSO
1681 1761
1762@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1682@@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) 1763@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1683 1764
1684=head1 CURRENT PROJECT COORDINATOR 1765=head1 CURRENT PROJECT COORDINATOR
1685 1766
1686=over 4 1767=over 4
1687 1768
1688=item Project Coordinator 1769=item Project Coordinator
1689 1770
1690Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1771Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1691 1772
1692L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1773L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1693 1774
1694=back 1775=back
1695 1776
… …
1699 1780
1700=item John Bovey 1781=item John Bovey
1701 1782
1702University of Kent, 1992, wrote the original Xvt. 1783University of Kent, 1992, wrote the original Xvt.
1703 1784
1704=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1785=item Rob Nation <nation@rocket.sanders.lockheed.com>
1705 1786
1706very heavily modified Xvt and came up with Rxvt 1787very heavily modified Xvt and came up with Rxvt
1707 1788
1708=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1789=item Angelo Haritsis <ah@doc.ic.ac.uk>
1709 1790
1710wrote the Greek Keyboard Input (no longer in code) 1791wrote the Greek Keyboard Input (no longer in code)
1711 1792
1712=item mj olesen L<< <olesen@me.QueensU.CA> >> 1793=item mj olesen <olesen@me.QueensU.CA>
1713 1794
1714Wrote the menu system. 1795Wrote the menu system.
1715 1796
1716Project Coordinator (changes.txt 2.11 to 2.21) 1797Project Coordinator (changes.txt 2.11 to 2.21)
1717 1798
1718=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1799=item Oezguer Kesim <kesim@math.fu-berlin.de>
1719 1800
1720Project Coordinator (changes.txt 2.21a to 2.4.5) 1801Project Coordinator (changes.txt 2.21a to 2.4.5)
1721 1802
1722=item Geoff Wing L<< <gcw@pobox.com> >> 1803=item Geoff Wing <gcw@pobox.com>
1723 1804
1724Rewrote screen display and text selection routines. 1805Rewrote screen display and text selection routines.
1725 1806
1726Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1807Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1727 1808
1728=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1809=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1729 1810
1730Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1811Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1731extension, random hacks, numerous bugfixes and extensions. 1812extension, random hacks, numerous bugfixes and extensions.
1732 1813
1733Project Coordinator (Changes 1.0 -) 1814Project Coordinator (Changes 1.0 -)
1734 1815
1735=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1816=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1736 1817
1737pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1818pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1738 1819
1739=back 1820=back
1740 1821

Diff Legend

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