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.212 by sf-exg, Sun Jan 1 14:31:28 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<-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, the vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and the other to a large number creates interesting effects
171on some backgrounds. The maximum radius value is 128. An horizontal or
172vertical radius of 0 disables blurring;
173resource I<blurRadius>.
174
175=item B<-icon> I<file> 143=item B<-icon> I<file>
176 144
177Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
178is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
179application window; resource I<iconFile>. 147application window; resource I<iconFile>.
180 148
181=item B<-bg> I<colour> 149=item B<-bg> I<colour>
182 150
183Window background colour; resource B<background>. 151Window background colour; resource B<background>.
184 152
185=item B<-fg> I<colour> 153=item B<-fg> I<colour>
186 154
187Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
188
189=item B<-pixmap> I<file[;oplist]>
190
191Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
192optionally specify a list of operations to modify it. Note you may need to
193add quotes to avoid special shell interpretation of the C<;> in the
194command-line; for more details see resource B<backgroundPixmap>.
195 156
196=item B<-cr> I<colour> 157=item B<-cr> I<colour>
197 158
198The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
199 160
688 649
689B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
690if 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
691monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
692 653
693=item B<transparent:> I<boolean>
694
695Turn on/off pseudo-transparency by using the root pixmap as background.
696
697B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
698future versions.
699
700=item B<fading:> I<number> 654=item B<fading:> I<number>
701 655
702Fade 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>.
703 657
704=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
705 659
706Fade 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
707colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
708 662
709=item B<tintColor:> I<colour>
710
711Tint the transparent background with the given colour. If the RENDER
712extension is not available only black, red, green, yellow, blue,
713magenta, cyan and white tints can be performed server-side. Note that
714a black tint yields a completely black image while a white tint yields
715the image unchanged; option B<-tint>.
716
717=item B<shading:> I<number>
718
719Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
720A value of 100 means no shading; option B<-sh>.
721
722=item B<blendType:> I<string>
723
724Specify background blending type; option B<-blt>.
725
726=item B<blurRadius:> I<number>
727
728Apply gaussian blur with the specified radius to the transparent
729background; option B<-blr>.
730
731=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
732 664
733Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
734 666
735=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
743 675
744=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
745 677
746The 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
747and the text. 679and the text.
748
749=item B<backgroundPixmap:> I<file[;oplist]>
750
751Use the specified image file for the background and also
752optionally specify a colon separated list of operations to modify it.
753Supported operations are:
754
755=over 4
756
757=item B<WxH+X+Y>
758
759sets scale and position. B<"W" / "H"> specify the horizontal/vertical
760scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
761scale of 0 disables scaling. The maximum permitted scale is 1000.
762
763=item B<op=tile>
764
765enables tiling
766
767=item B<op=keep-aspect>
768
769maintain the image aspect ratio when scaling
770
771=item B<op=root-align>
772
773use the position of the terminal window relative to the root window as
774the image offset, simulating a root window background
775
776=back
777
778The default scale and position setting is C<100x100+50+50>.
779Alternatively, a predefined set of templates can be used to achieve
780the most common setups:
781
782=over 4
783
784=item B<style=tiled>
785
786the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
787
788=item B<style=aspect-stretched>
789
790the image is scaled to fill the whole window maintaining the aspect
791ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
792
793=item B<style=stretched>
794
795the image is scaled to fill the whole window. Equivalent to 100x100
796
797=item B<style=centered>
798
799the image is centered with no scaling. Equivalent to 0x0+50+50
800
801=item B<style=root-tiled>
802
803the image is tiled with no scaling and using 'root' positioning.
804Equivalent to 0x0:op=tile:op=root-align
805
806=back
807
808If multiple templates are specified the last one wins. Note that a
809template overrides all the scale, position and operations settings.
810
811If used in conjunction with B<-tr> option, the specified pixmap will be
812blended over the transparent background using alpha-blending. If I<afterimage>
813support has been compiled in it is possible to choose other blending
814types with B<-blt "type"> option.
815
816=item B<path:> I<path>
817
818Specify the colon-delimited search path for finding background image files.
819 680
820=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
821 682
822Select 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
823that 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
1180Sets the working directory for the shell (or the command specified via 1041Sets the working directory for the shell (or the command specified via
1181B<-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
1182@@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
1183directory will be used; option B<-cd>. 1044directory will be used; option B<-cd>.
1184 1045
1185=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1186 1047
1187Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1188intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1189 1050
1190The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1191any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1192B<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
1193and 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
1194B<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>.
1195 1065
1196The 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
1197whatever 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
1198keys 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
1199current application keymap mode state. 1069current application keymap mode state.
1200 1070
1201The 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
1202searching 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
1203omitting 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
1204keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1205performed in an exact manner; however, the closest match is assured.
1206 1084
1207I<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
1208number), see RESOURCES in C<man 7 X> for further details. 1087number), see RESOURCES in C<man 7 X> for further details.
1209 1088
1210You can define a range of keysyms in one shot by 1089An action starts with an action prefix that selects a certain type
1211loading the C<keysym-list> perl extension and providing a I<string> 1090of action, followed by a colon. An action string without colons is
1212with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1091interpreted as a literal string to pass to the tty (as if it was
1213should be a character not used by the strings. 1092prefixed with C<string:>).
1214 1093
1215Its usage can be demonstrated by an example: 1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1216 1096
1217 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1097=over 4
1218 1098
1219The above line is equivalent to the following three lines: 1099=item string:STRING
1220 1100
1221 URxvt.keysym.Meta-Control-0x61: \033<a> 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1222 URxvt.keysym.Meta-Control-0x62: \033<b> 1102then the remaining C<STRING> will be passed to the program running in the
1223 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:
1224 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
1225If 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>
1226is 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
1227example 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>
1228when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1229 1120
1230 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
1231 1122
1232If 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
1233is 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
1234manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1235C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1236 1126
1237 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
1238 1129
1239Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1240will match if I<at least> the specified identifiers are being set, and 1131info):
1241no other key mappings with those and more bits are being defined. That
1242means that defining a key map for C<a> will automatically provide
1243definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1244mappings themselves.
1245 1132
1246Unfortunately, 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
1247if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1248C<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
1249user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1250 1146
1251 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1252 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1253 1149
1254The 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
1255of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1256C<Shift-Insert>. 1152C<Shift-Insert>.
1257 1153
1258The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item builtin-string:
1259the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1260font-switching at runtime:
1261 1155
1262 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1156This action is mainly useful to restore string mappings for keys that
1263 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.
1264 1161
1265Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1162An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1266info): 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:
1267 1166
1268 URxvt.keysym.M-C-3: command:\033[8;25;80t 1167 URxvt.keysym.S-Insert: builtin-string:
1269 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
1270 1204
1271=item B<perl-ext-common>: I<string> 1205=item B<perl-ext-common>: I<string>
1272 1206
1273=item B<perl-ext>: I<string> 1207=item B<perl-ext>: I<string>
1274 1208
1276use in this terminal instance; option B<-pe>. 1210use in this terminal instance; option B<-pe>.
1277 1211
1278Extension names can be prefixed with a C<-> sign to prohibit using 1212Extension names can be prefixed with a C<-> sign to prohibit using
1279them. This can be useful to selectively disable some extensions loaded 1213them. This can be useful to selectively disable some extensions loaded
1280by default, or specified via the C<perl-ext-common> resource. For 1214by default, or specified via the C<perl-ext-common> resource. For
1281example, C<default,-selection> will use all the default extension except 1215example, C<default,-selection> will use all the default extensions except
1282C<selection>. 1216C<selection>.
1283 1217
1284Extension names can also be followed by an argument in angle brackets 1218The default set includes the C<selection>, C<option-popup>,
1285(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1219C<selection-popup> and C<readline> extensions, any extensions that define
1286searchable scrollback to Alt/Meta-s). Mentioning the same extension 1220keybindings via C<BINDING> meta comments, extensions loaded because
1287multiple times with different arguments will pass multiple arguments to 1221their resources/commandline switches were used, and extensions which are
1288the extension. 1222mentioned in B<keysym> resources.
1289 1223
1290Each extension is looked up in the library directories, loaded if 1224Each extension is looked up in the library directories, loaded if
1291necessary, 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.
1292 1228
1293If both of these resources are the empty string, then the perl 1229If both of these resources are the empty string, then the perl interpreter
1294interpreter will not be initialized. The idea behind two options is that 1230will not be initialized. The rationale for having two options is that
1295B<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
1296all instances, while B<perl-ext> is used for specific instances. 1232all instances, while B<perl-ext> is used for specific instances.
1297 1233
1298=item B<perl-eval>: I<string> 1234=item B<perl-eval>: I<string>
1299 1235
1301the @@RXVT_NAME@@perl(3) manpage. 1237the @@RXVT_NAME@@perl(3) manpage.
1302 1238
1303=item B<perl-lib>: I<path> 1239=item B<perl-lib>: I<path>
1304 1240
1305Colon-separated list of additional directories that hold extension 1241Colon-separated list of additional directories that hold extension
1306scripts. When looking for perl extensions, @@RXVT_NAME@@ will first 1242scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1307look 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
1308F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1244lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1309 1245
1310See the @@RXVT_NAME@@perl(3) manpage. 1246See the @@RXVT_NAME@@perl(3) manpage.
1311 1247
1312=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1248=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1313 1249
1317=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1253=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1318 1254
1319Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1255Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1320for details. 1256for details.
1321 1257
1322=item B<searchable-scrollback:> I<keysym> 1258=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1323 1259
1324Sets the hotkey that starts the incremental scrollback buffer search 1260This resource is deprecated and will be removed. Use a B<keysym> resource
1325(default: C<M-s>). 1261instead, e.g.:
1326 1262
1263 URxvt.keysym.M-s: searchable-scrollback:start
1264
1327=item B<urlLauncher>: I<string> 1265=item B<url-launcher>: I<string>
1328 1266
1329Specifies 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
1330C<selection-popup> and C<matcher> perl extensions. 1268C<selection-popup> and C<matcher> perl extensions.
1331 1269
1332=item B<transient-for>: I<windowid> 1270=item B<transient-for>: I<windowid>
1343Turn on/off ISO 14755 (default enabled). 1281Turn on/off ISO 14755 (default enabled).
1344 1282
1345=item B<iso14755_52:> I<boolean> 1283=item B<iso14755_52:> I<boolean>
1346 1284
1347Turn 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.
1348 1400
1349=back 1401=back
1350 1402
1351=head1 THE SCROLLBAR 1403=head1 THE SCROLLBAR
1352 1404
1400window causes the value of the PRIMARY selection (or CLIPBOARD with the 1452window causes the value of the PRIMARY selection (or CLIPBOARD with the
1401B<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.
1402 1454
1403Pressing 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
1404inserted 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.
1405 1463
1406=back 1464=back
1407 1465
1408=head1 CHANGING FONTS 1466=head1 CHANGING FONTS
1409 1467
1534The following text gives values for the standard 88 colour mode (and 1592The following text gives values for the standard 88 colour mode (and
1535values for the 256 colour mode in parentheses). 1593values for the 256 colour mode in parentheses).
1536 1594
1537The 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:
1538 1596
1539 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
1540 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
1541 1599
1542The 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%
1543steps (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
1544the RGB cube. 1602the RGB cube.
1545 1603
1653 1711
1654=item B<SHELL> 1712=item B<SHELL>
1655 1713
1656The 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>.
1657 1715
1658=item B<RXVT_SOCKET> 1716=item B<RXVT_SOCKET> [I<sic>]
1659 1717
1660The unix domain socket path used by @@RXVT_NAME@@c(1) and 1718The unix domain socket path used by @@RXVT_NAME@@c(1) and
1661@@RXVT_NAME@@d(1). 1719@@RXVT_NAME@@d(1).
1662 1720
1663Default 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).
1664 1732
1665=item B<HOME> 1733=item B<HOME>
1666 1734
1667Used to locate the default directory for the unix domain socket for 1735Used to locate the default directory for the unix domain socket for
1668daemon communications and to locate various resource files (such as 1736daemon communications and to locate various resource files (such as
1689 1757
1690=back 1758=back
1691 1759
1692=head1 SEE ALSO 1760=head1 SEE ALSO
1693 1761
1762@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1694@@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)
1695 1764
1696=head1 CURRENT PROJECT COORDINATOR 1765=head1 CURRENT PROJECT COORDINATOR
1697 1766
1698=over 4 1767=over 4
1699 1768
1700=item Project Coordinator 1769=item Project Coordinator
1701 1770
1702Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1771Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1703 1772
1704L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1773L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1705 1774
1706=back 1775=back
1707 1776
1711 1780
1712=item John Bovey 1781=item John Bovey
1713 1782
1714University of Kent, 1992, wrote the original Xvt. 1783University of Kent, 1992, wrote the original Xvt.
1715 1784
1716=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1785=item Rob Nation <nation@rocket.sanders.lockheed.com>
1717 1786
1718very heavily modified Xvt and came up with Rxvt 1787very heavily modified Xvt and came up with Rxvt
1719 1788
1720=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1789=item Angelo Haritsis <ah@doc.ic.ac.uk>
1721 1790
1722wrote the Greek Keyboard Input (no longer in code) 1791wrote the Greek Keyboard Input (no longer in code)
1723 1792
1724=item mj olesen L<< <olesen@me.QueensU.CA> >> 1793=item mj olesen <olesen@me.QueensU.CA>
1725 1794
1726Wrote the menu system. 1795Wrote the menu system.
1727 1796
1728Project Coordinator (changes.txt 2.11 to 2.21) 1797Project Coordinator (changes.txt 2.11 to 2.21)
1729 1798
1730=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1799=item Oezguer Kesim <kesim@math.fu-berlin.de>
1731 1800
1732Project Coordinator (changes.txt 2.21a to 2.4.5) 1801Project Coordinator (changes.txt 2.21a to 2.4.5)
1733 1802
1734=item Geoff Wing L<< <gcw@pobox.com> >> 1803=item Geoff Wing <gcw@pobox.com>
1735 1804
1736Rewrote screen display and text selection routines. 1805Rewrote screen display and text selection routines.
1737 1806
1738Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1807Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1739 1808
1740=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1809=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1741 1810
1742Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1811Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1743extension, random hacks, numerous bugfixes and extensions. 1812extension, random hacks, numerous bugfixes and extensions.
1744 1813
1745Project Coordinator (Changes 1.0 -) 1814Project Coordinator (Changes 1.0 -)
1746 1815
1747=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1816=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1748 1817
1749pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1818pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1750 1819
1751=back 1820=back
1752 1821

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines