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.215 by sf-exg, Sun May 20 16:34:42 2012 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 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
335 306
336=item B<-override-redirect> 307=item B<-override-redirect>
337 308
338Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
339B<override-redirect>. 310B<override-redirect>.
311
312=item B<-dockapp>
313
314Sets the initial state of the window to WithdrawnState, which makes
315window managers that support this extension treat it as a dockapp.
340 316
341=item B<-sbg> 317=item B<-sbg>
342 318
343Compile I<frills>: Disable the usage of the built-in block graphics/line 319Compile I<frills>: Disable the usage of the built-in block graphics/line
344drawing characters and just rely on what the specified fonts provide. Use 320drawing characters and just rely on what the specified fonts provide. Use
678 654
679B<False>: specify that everything is to be displayed, even 655B<False>: specify that everything is to be displayed, even
680if the refresh is too fast for the human eye to read anything (or the 656if the refresh is too fast for the human eye to read anything (or the
681monitor to display anything); option B<+ss>. 657monitor to display anything); option B<+ss>.
682 658
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> 659=item B<fading:> I<number>
691 660
692Fade the text by the given percentage when focus is lost; option B<-fade>. 661Fade the text by the given percentage when focus is lost; option B<-fade>.
693 662
694=item B<fadeColor:> I<colour> 663=item B<fadeColor:> I<colour>
695 664
696Fade to this colour, when fading is used (see B<fading:>). The default 665Fade to this colour, when fading is used (see B<fading:>). The default
697colour is black; option B<-fadecolor>. 666colour is black; option B<-fadecolor>.
698 667
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<blurRadius:> I<number>
713
714Apply gaussian blur with the specified radius to the transparent
715background; option B<-blr>.
716
717=item B<iconFile:> I<file> 668=item B<iconFile:> I<file>
718 669
719Set the application icon pixmap; option B<-icon>. 670Set the application icon pixmap; option B<-icon>.
720 671
721=item B<scrollColor:> I<colour> 672=item B<scrollColor:> I<colour>
729 680
730=item B<borderColor:> I<colour> 681=item B<borderColor:> I<colour>
731 682
732The colour of the border around the text area and between the scrollbar 683The colour of the border around the text area and between the scrollbar
733and the text. 684and the text.
734
735=item B<backgroundPixmap:> I<file[;oplist]>
736
737Use the specified image file for the background and also
738optionally specify a colon separated list of operations to modify it.
739Supported operations are:
740
741=over 4
742
743=item B<WxH+X+Y>
744
745sets scale and position. B<"W" / "H"> specify the horizontal/vertical
746scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
747scale of 0 disables scaling.
748
749=item B<op=tile>
750
751enables tiling
752
753=item B<op=keep-aspect>
754
755maintain the image aspect ratio when scaling
756
757=item B<op=root-align>
758
759use the position of the terminal window relative to the root window as
760the image offset, simulating a root window background
761
762=back
763
764The default scale and position setting is C<100x100+50+50>.
765Alternatively, a predefined set of templates can be used to achieve
766the most common setups:
767
768=over 4
769
770=item B<style=tiled>
771
772the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
773
774=item B<style=aspect-stretched>
775
776the image is scaled to fill the whole window maintaining the aspect
777ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
778
779=item B<style=stretched>
780
781the image is scaled to fill the whole window. Equivalent to 100x100
782
783=item B<style=centered>
784
785the image is centered with no scaling. Equivalent to 0x0+50+50
786
787=item B<style=root-tiled>
788
789the image is tiled with no scaling and using 'root' positioning.
790Equivalent to 0x0:op=tile:op=root-align
791
792=back
793
794If multiple templates are specified the last one wins. Note that a
795template overrides all the scale, position and operations settings.
796
797If used in conjunction with B<-tr> option, the specified pixmap will be
798blended over the transparent background using alpha-blending.
799
800=item B<path:> I<path>
801
802Specify the colon-delimited search path for finding background image files.
803 685
804=item B<font:> I<fontlist> 686=item B<font:> I<fontlist>
805 687
806Select the fonts to be used. This is a comma separated list of font names 688Select the fonts to be used. This is a comma separated list of font names
807that are checked in order when trying to find glyphs for characters. The 689that are checked in order when trying to find glyphs for characters. The
1164Sets the working directory for the shell (or the command specified via 1046Sets the working directory for the shell (or the command specified via
1165B<-e>). The I<path> must be an absolute path and it must exist for 1047B<-e>). The I<path> must be an absolute path and it must exist for
1166@@RXVT_NAME@@ to start. If it isn't specified then the current working 1048@@RXVT_NAME@@ to start. If it isn't specified then the current working
1167directory will be used; option B<-cd>. 1049directory will be used; option B<-cd>.
1168 1050
1169=item B<keysym.>I<sym>: I<string> 1051=item B<keysym.>I<sym>: I<action>
1170 1052
1171Compile I<frills>: Associate I<string> with keysym I<sym>. The 1053Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1172intervening resource name B<keysym.> cannot be omitted. 1054resource name B<keysym.> cannot be omitted.
1173 1055
1174The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1056Using this resource, you can map key combinations such as
1175any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1057C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1176B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1058string than would normally result from that combination, making the
1177and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1059terminal scroll up or down the way you want it, or any other thing an
1178B<2>, B<3>, B<4>, B<5>. 1060extension might provide.
1061
1062The key combination that triggers the action, I<sym>, has the following format:
1063
1064 (modifiers-)key
1065
1066Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1067B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1068B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1069B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1179 1070
1180The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1071The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1181whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1072whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1182keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1073keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1183current application keymap mode state. 1074current application keymap mode state.
1184 1075
1185The spellings of I<key> can be obtained by using B<xev>(1) command or 1076Due the the large number of modifier combinations, a key mapping will
1186searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1077match if I<at least> the specified identifiers are being set, and no other
1078key mappings with those and more bits are being defined. That means that
1079defining a mapping for C<a> will automatically provide definitions for
1080C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1081themselves. See the C<builtin:> action, below, for a way to work around
1082this when this is a problem.
1083
1084The spelling of I<key> depends on your implementation of X. An easy way to
1085find a key name is to use the B<xev>(1) command. You can find a list by
1086looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1187omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1087the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1188keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1088value (B<0x0000 - 0xFFFF>).
1189performed in an exact manner; however, the closest match is assured.
1190 1089
1191I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1090As with any resource value, the I<action> string may contain backslash
1091escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1192number), see RESOURCES in C<man 7 X> for further details. 1092number), see RESOURCES in C<man 7 X> for further details.
1193 1093
1194You can define a range of keysyms in one shot by 1094An action starts with an action prefix that selects a certain type
1195loading the C<keysym-list> perl extension and providing a I<string> 1095of action, followed by a colon. An action string without colons is
1196with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1096interpreted as a literal string to pass to the tty (as if it was
1197should be a character not used by the strings. 1097prefixed with C<string:>).
1198 1098
1199Its usage can be demonstrated by an example: 1099The following action prefixes are known - extensions can provide
1100additional prefixes:
1200 1101
1201 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1102=over 4
1202 1103
1203The above line is equivalent to the following three lines: 1104=item string:STRING
1204 1105
1205 URxvt.keysym.Meta-Control-0x61: \033<a> 1106If the I<action> starts with C<string:> (or otherwise contains no colons),
1206 URxvt.keysym.Meta-Control-0x62: \033<b> 1107then the remaining C<STRING> will be passed to the program running in the
1207 URxvt.keysym.Meta-Control-0x63: \033<c> 1108terminal. For example, you could replace whatever Shift-Tab outputs by the
1109string C<echo rm -rf /> followed by a newline:
1208 1110
1111 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1112
1113This could in theory be used to completely redefine your keymap.
1114
1115=item command:STRING
1116
1209If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1117If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1210is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1118is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1119the opposite of C<string:> - instead of sending it to the program running
1120in the terminal, it will be treated as if it were program output). This is
1121most useful to feed command sequences into @@RXVT_NAME@@.
1122
1211example the following means "change the current locale to C<zh_CN.GBK> 1123For example the following means "change the current locale to C<zh_CN.GBK>
1212when Control-Meta-c is being pressed": 1124when Control-Meta-c is being pressed":
1213 1125
1214 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1126 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1215 1127
1216If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1128The following example will map Control-Meta-1 and Control-Meta-2 to
1217is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1129the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1218manpage. For example, the F<selection> extension (activated via 1130font-switching at runtime:
1219C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1220 1131
1221 URxvt.keysym.M-C-c: perl:selection:rot13 1132 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1133 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1222 1134
1223Due the the large number of modifier combinations, a defined key mapping 1135Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1224will match if I<at least> the specified identifiers are being set, and 1136info):
1225no other key mappings with those and more bits are being defined. That
1226means that defining a key map for C<a> will automatically provide
1227definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1228mappings themselves.
1229 1137
1230Unfortunately, this will override built-in key mappings. For example 1138 URxvt.keysym.M-C-3: command:\033[8;25;80t
1139 URxvt.keysym.M-C-4: command:\033[8;48;110t
1140
1141=item builtin:
1142
1143The builtin action is the action that @@RXVT_NAME@@ would execute if no
1144key binding existed for the key combination. The obvious use is to undo
1145the effect of existing bindings. The not so obvious use is to reinstate
1146bindings when another binding overrides too many modifiers.
1147
1231if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1148For example if you overwrite the C<Insert> key you will disable
1232C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1149@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1233user-defined keymap using the C<builtin:> replacement: 1150"holes" into the user-defined keymap using the C<builtin:> replacement:
1234 1151
1235 URxvt.keysym.Insert: <my insert key sequence> 1152 URxvt.keysym.Insert: <my insert key sequence>
1236 URxvt.keysym.S-Insert: builtin: 1153 URxvt.keysym.S-Insert: builtin:
1237 1154
1238The first line defines a mapping for C<Insert> and I<any> combination 1155The first line defines a mapping for C<Insert> and I<any> combination
1239of modifiers. The second line re-establishes the default mapping for 1156of modifiers. The second line re-establishes the default mapping for
1240C<Shift-Insert>. 1157C<Shift-Insert>.
1241 1158
1242The following example will map Control-Meta-1 and Control-Meta-2 to 1159=item builtin-string:
1243the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1244font-switching at runtime:
1245 1160
1246 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1161This action is mainly useful to restore string mappings for keys that
1247 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1162have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1163difficult to explain - basically, this action will send the string to the
1164application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1165action for it.
1248 1166
1249Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1167An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1250info): 1168selection when you press C<Shift-Insert>. With the following bindings, it
1169would instead emit the (undocumented, but what applications running in the
1170terminal might expect) sequence C<ESC [ 2 $> instead:
1251 1171
1252 URxvt.keysym.M-C-3: command:\033[8;25;80t 1172 URxvt.keysym.S-Insert: builtin-string:
1253 URxvt.keysym.M-C-4: command:\033[8;48;110t 1173 URxvt.keysym.C-S-Insert: builtin:
1174
1175The first line disables the paste functionality for that key
1176combination, and the second reinstates the default behaviour for
1177C<Control-Shift-Insert>, which would otherwise be overridden.
1178
1179Similarly, to let applications gain access to the C<C-M-c> (copy to
1180clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181this:
1182
1183 URxvt.keysym.C-S-c: builtin-string:
1184 URxvt.keysym.C-S-v: builtin-string:
1185
1186=item EXTENSION:STRING
1187
1188An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1189extension of the same name. The extension will be loaded automatically if
1190necessary.
1191
1192Not all extensions define key actions, but popular extensions that do
1193include the I<selection> and I<matcher> extensions (documented in their
1194own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195respectively).
1196
1197From the silly examples department, this will rot13-"encrypt"
1198@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1199keyboards:
1200
1201 URxvt.keysym.M-C-c: selection:rot13
1202
1203=item perl:STRING *DEPRECATED*
1204
1205This is a deprecated way of passing key mappings to perl extensions. It is
1206still supported, but should not be used anymore.
1207
1208=back
1254 1209
1255=item B<perl-ext-common>: I<string> 1210=item B<perl-ext-common>: I<string>
1256 1211
1257=item B<perl-ext>: I<string> 1212=item B<perl-ext>: I<string>
1258 1213
1260use in this terminal instance; option B<-pe>. 1215use in this terminal instance; option B<-pe>.
1261 1216
1262Extension names can be prefixed with a C<-> sign to prohibit using 1217Extension names can be prefixed with a C<-> sign to prohibit using
1263them. This can be useful to selectively disable some extensions loaded 1218them. This can be useful to selectively disable some extensions loaded
1264by default, or specified via the C<perl-ext-common> resource. For 1219by default, or specified via the C<perl-ext-common> resource. For
1265example, C<default,-selection> will use all the default extension except 1220example, C<default,-selection> will use all the default extensions except
1266C<selection>. 1221C<selection>.
1267 1222
1268Extension names can also be followed by an argument in angle brackets 1223The default set includes the C<selection>, C<option-popup>,
1269(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1224C<selection-popup> and C<readline> extensions, any extensions that define
1270searchable scrollback to Alt/Meta-s). Mentioning the same extension 1225keybindings via C<BINDING> meta comments, extensions loaded because
1271multiple times with different arguments will pass multiple arguments to 1226their resources/commandline switches were used, and extensions which are
1272the extension. 1227mentioned in B<keysym> resources.
1273 1228
1274Each extension is looked up in the library directories, loaded if 1229Each extension is looked up in the library directories, loaded if
1275necessary, and bound to the current terminal instance. 1230necessary, and bound to the current terminal instance. When the library
1231search path contains multiple extension files of the same name, then the
1232first one found will be used.
1276 1233
1277If both of these resources are the empty string, then the perl 1234If both of these resources are the empty string, then the perl interpreter
1278interpreter will not be initialized. The idea behind two options is that 1235will not be initialized. The rationale for having two options is that
1279B<perl-ext-common> will be used for extensions that should be available to 1236B<perl-ext-common> will be used for extensions that should be available to
1280all instances, while B<perl-ext> is used for specific instances. 1237all instances, while B<perl-ext> is used for specific instances.
1281 1238
1282=item B<perl-eval>: I<string> 1239=item B<perl-eval>: I<string>
1283 1240
1285the @@RXVT_NAME@@perl(3) manpage. 1242the @@RXVT_NAME@@perl(3) manpage.
1286 1243
1287=item B<perl-lib>: I<path> 1244=item B<perl-lib>: I<path>
1288 1245
1289Colon-separated list of additional directories that hold extension 1246Colon-separated list of additional directories that hold extension
1290scripts. When looking for perl extensions, @@RXVT_NAME@@ will first 1247scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1291look in these directories, then in $HOME/.urxvt/ext and lastly in 1248in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1292F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1249lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1293 1250
1294See the @@RXVT_NAME@@perl(3) manpage. 1251See the @@RXVT_NAME@@perl(3) manpage.
1295 1252
1296=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1253=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1297 1254
1301=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1258=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1302 1259
1303Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1260Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1304for details. 1261for details.
1305 1262
1306=item B<searchable-scrollback:> I<keysym> 1263=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1307 1264
1308Sets the hotkey that starts the incremental scrollback buffer search 1265This resource is deprecated and will be removed. Use a B<keysym> resource
1309(default: C<M-s>). 1266instead, e.g.:
1310 1267
1268 URxvt.keysym.M-s: searchable-scrollback:start
1269
1311=item B<urlLauncher>: I<string> 1270=item B<url-launcher>: I<string>
1312 1271
1313Specifies the program to be started with a URL argument. Used by the 1272Specifies the program to be started with a URL argument. Used by the
1314C<selection-popup> and C<matcher> perl extensions. 1273C<selection-popup> and C<matcher> perl extensions.
1315 1274
1316=item B<transient-for>: I<windowid> 1275=item B<transient-for>: I<windowid>
1327Turn on/off ISO 14755 (default enabled). 1286Turn on/off ISO 14755 (default enabled).
1328 1287
1329=item B<iso14755_52:> I<boolean> 1288=item B<iso14755_52:> I<boolean>
1330 1289
1331Turn on/off ISO 14755 5.2 mode (default enabled). 1290Turn on/off ISO 14755 5.2 mode (default enabled).
1291
1292=back
1293
1294=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1295
1296=over 4
1297
1298=item B<-pixmap> I<file[;oplist]>
1299
1300=item B<backgroundPixmap:> I<file[;oplist]>
1301
1302Compile I<pixbuf>: Use the specified image file as the window's
1303background and also optionally specify a colon separated list of
1304operations to modify it. Note that you may need to quote the C<;>
1305character when using the command line option, as C<;> is usually a
1306metacharacter in shells. Supported operations are:
1307
1308=over 4
1309
1310=item B<WxH+X+Y>
1311
1312sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1313scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1314scale of 0 disables scaling.
1315
1316=item B<op=tile>
1317
1318enables tiling
1319
1320=item B<op=keep-aspect>
1321
1322maintain the image aspect ratio when scaling
1323
1324=item B<op=root-align>
1325
1326use the position of the terminal window relative to the root window as
1327the image offset, simulating a root window background
1328
1329=back
1330
1331The default scale and position setting is C<100x100+50+50>.
1332Alternatively, a predefined set of templates can be used to achieve
1333the most common setups:
1334
1335=over 4
1336
1337=item B<style=tiled>
1338
1339the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1340
1341=item B<style=aspect-stretched>
1342
1343the image is scaled to fill the whole window maintaining the aspect
1344ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1345
1346=item B<style=stretched>
1347
1348the image is scaled to fill the whole window. Equivalent to 100x100
1349
1350=item B<style=centered>
1351
1352the image is centered with no scaling. Equivalent to 0x0+50+50
1353
1354=item B<style=root-tiled>
1355
1356the image is tiled with no scaling and using 'root' positioning.
1357Equivalent to 0x0:op=tile:op=root-align
1358
1359=back
1360
1361If multiple templates are specified the last one wins. Note that a
1362template overrides all the scale, position and operations settings.
1363
1364If used in conjunction with pseudo-transparency, the specified pixmap
1365will be blended over the transparent background using alpha-blending.
1366
1367=item B<-tr>|B<+tr>
1368
1369=item B<transparent:> I<boolean>
1370
1371Turn on/off pseudo-transparency by using the root pixmap as background.
1372
1373B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1374will be removed in future versions.
1375
1376=item B<-tint> I<colour>
1377
1378=item B<tintColor:> I<colour>
1379
1380Tint the transparent background with the given colour. Note that a
1381black tint yields a completely black image while a white tint yields
1382the image unchanged.
1383
1384=item B<-sh> I<number>
1385
1386=item B<shading:> I<number>
1387
1388Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1389A value of 100 means no shading.
1390
1391=item B<-blr> I<HxV>
1392
1393=item B<blurRadius:> I<HxV>
1394
1395Apply gaussian blur with the specified radius to the transparent
1396background. If a single number is specified, the vertical and
1397horizontal radii are considered to be the same. Setting one of the
1398radii to 1 and the other to a large number creates interesting effects
1399on some backgrounds. The maximum radius value is 128. An horizontal or
1400vertical radius of 0 disables blurring.
1401
1402=item B<path:> I<path>
1403
1404Specify the colon-delimited search path for finding background image files.
1332 1405
1333=back 1406=back
1334 1407
1335=head1 THE SCROLLBAR 1408=head1 THE SCROLLBAR
1336 1409
1384window causes the value of the PRIMARY selection (or CLIPBOARD with the 1457window causes the value of the PRIMARY selection (or CLIPBOARD with the
1385B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1458B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1386 1459
1387Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1460Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1388inserted too. 1461inserted too.
1462
1463rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1464<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1465binding causes the value of the internal selection to be copied to the
1466CLIPBOARD selection, while the second binding causes the value of the
1467CLIPBOARD selection to be inserted.
1389 1468
1390=back 1469=back
1391 1470
1392=head1 CHANGING FONTS 1471=head1 CHANGING FONTS
1393 1472
1518The following text gives values for the standard 88 colour mode (and 1597The following text gives values for the standard 88 colour mode (and
1519values for the 256 colour mode in parentheses). 1598values for the 256 colour mode in parentheses).
1520 1599
1521The RGB cube uses indices 16..79 (16..231) using the following formulas: 1600The RGB cube uses indices 16..79 (16..231) using the following formulas:
1522 1601
1523 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1602 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1524 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1603 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1525 1604
1526The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1605The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1527steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1606steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1528the RGB cube. 1607the RGB cube.
1529 1608
1637 1716
1638=item B<SHELL> 1717=item B<SHELL>
1639 1718
1640The shell to be used for command execution, defaults to C</bin/sh>. 1719The shell to be used for command execution, defaults to C</bin/sh>.
1641 1720
1642=item B<RXVT_SOCKET> 1721=item B<RXVT_SOCKET> [I<sic>]
1643 1722
1644The unix domain socket path used by @@RXVT_NAME@@c(1) and 1723The unix domain socket path used by @@RXVT_NAME@@c(1) and
1645@@RXVT_NAME@@d(1). 1724@@RXVT_NAME@@d(1).
1646 1725
1647Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. 1726Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1727
1728=item B<URXVT_PERL_LIB>
1729
1730Additional F<:>-separated library search path for perl extensions. Will be
1731searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1732directory.
1733
1734=item B<URXVT_PERL_VERBOSITY>
1735
1736See L<@@RXVT_NAME@@perl>(3).
1648 1737
1649=item B<HOME> 1738=item B<HOME>
1650 1739
1651Used to locate the default directory for the unix domain socket for 1740Used to locate the default directory for the unix domain socket for
1652daemon communications and to locate various resource files (such as 1741daemon communications and to locate various resource files (such as
1673 1762
1674=back 1763=back
1675 1764
1676=head1 SEE ALSO 1765=head1 SEE ALSO
1677 1766
1767@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1678@@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) 1768@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1679 1769
1680=head1 CURRENT PROJECT COORDINATOR 1770=head1 CURRENT PROJECT COORDINATOR
1681 1771
1682=over 4 1772=over 4
1683 1773
1684=item Project Coordinator 1774=item Project Coordinator
1685 1775
1686Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1776Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1687 1777
1688L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1778L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1689 1779
1690=back 1780=back
1691 1781
1695 1785
1696=item John Bovey 1786=item John Bovey
1697 1787
1698University of Kent, 1992, wrote the original Xvt. 1788University of Kent, 1992, wrote the original Xvt.
1699 1789
1700=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1790=item Rob Nation <nation@rocket.sanders.lockheed.com>
1701 1791
1702very heavily modified Xvt and came up with Rxvt 1792very heavily modified Xvt and came up with Rxvt
1703 1793
1704=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1794=item Angelo Haritsis <ah@doc.ic.ac.uk>
1705 1795
1706wrote the Greek Keyboard Input (no longer in code) 1796wrote the Greek Keyboard Input (no longer in code)
1707 1797
1708=item mj olesen L<< <olesen@me.QueensU.CA> >> 1798=item mj olesen <olesen@me.QueensU.CA>
1709 1799
1710Wrote the menu system. 1800Wrote the menu system.
1711 1801
1712Project Coordinator (changes.txt 2.11 to 2.21) 1802Project Coordinator (changes.txt 2.11 to 2.21)
1713 1803
1714=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1804=item Oezguer Kesim <kesim@math.fu-berlin.de>
1715 1805
1716Project Coordinator (changes.txt 2.21a to 2.4.5) 1806Project Coordinator (changes.txt 2.21a to 2.4.5)
1717 1807
1718=item Geoff Wing L<< <gcw@pobox.com> >> 1808=item Geoff Wing <gcw@pobox.com>
1719 1809
1720Rewrote screen display and text selection routines. 1810Rewrote screen display and text selection routines.
1721 1811
1722Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1812Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1723 1813
1724=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1814=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1725 1815
1726Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1816Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1727extension, random hacks, numerous bugfixes and extensions. 1817extension, random hacks, numerous bugfixes and extensions.
1728 1818
1729Project Coordinator (Changes 1.0 -) 1819Project Coordinator (Changes 1.0 -)
1730 1820
1731=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1821=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1732 1822
1733pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1823pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1734 1824
1735=back 1825=back
1736 1826

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines