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.200 by sf-exg, Wed Aug 10 07:28:35 2011 UTC vs.
Revision 1.236 by sf-exg, Sat Aug 16 10:51:23 2014 UTC

… …
98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
111=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
112 117
113Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
114 119
115=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
… …
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 127
123=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
124 129
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127=item B<-tr>|B<+tr>
128
129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133 131
134=item B<-fade> I<number> 132=item B<-fade> I<number>
135 133
136Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
137fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
… …
140=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
141 139
142Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
143is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
144 142
145=item B<-tint> I<colour>
146
147Tint the transparent background with the given colour;
148resource I<tintColor>.
149
150=item B<-sh> I<number>
151
152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153A value of 100 means no shading; resource I<shading>.
154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128;
172resource I<blurRadius>.
173
174=item B<-icon> I<file> 143=item B<-icon> I<file>
175 144
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>. 147application window; resource I<iconFile>.
179 148
180=item B<-bg> I<colour> 149=item B<-bg> I<colour>
181 150
182Window background colour; resource B<background>. 151Window background colour; resource B<background>.
183 152
184=item B<-fg> I<colour> 153=item B<-fg> I<colour>
185 154
186Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
187
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
189
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191optionally specify its scaling with a geometry string. Note you may need to
192add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>.
194 156
195=item B<-cr> I<colour> 157=item B<-cr> I<colour>
196 158
197The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
198 160
… …
257 219
258=item B<-ls>|B<+ls> 220=item B<-ls>|B<+ls>
259 221
260Start as a login-shell/sub-shell; resource B<loginShell>. 222Start as a login-shell/sub-shell; resource B<loginShell>.
261 223
224=item B<-mc> I<milliseconds>
225
226Specify the maximum time between multi-click selections.
227
262=item B<-ut>|B<+ut> 228=item B<-ut>|B<+ut>
263 229
264Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 230Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
265B<utmpInhibit>. 231B<utmpInhibit>.
266 232
… …
344 310
345=item B<-override-redirect> 311=item B<-override-redirect>
346 312
347Compile I<frills>: Sets override-redirect on the window; resource 313Compile I<frills>: Sets override-redirect on the window; resource
348B<override-redirect>. 314B<override-redirect>.
315
316=item B<-dockapp>
317
318Sets the initial state of the window to WithdrawnState, which makes
319window managers that support this extension treat it as a dockapp.
349 320
350=item B<-sbg> 321=item B<-sbg>
351 322
352Compile I<frills>: Disable the usage of the built-in block graphics/line 323Compile I<frills>: Disable the usage of the built-in block graphics/line
353drawing characters and just rely on what the specified fonts provide. Use 324drawing characters and just rely on what the specified fonts provide. Use
… …
687 658
688B<False>: specify that everything is to be displayed, even 659B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the 660if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>. 661monitor to display anything); option B<+ss>.
691 662
692=item B<transparent:> I<boolean>
693
694Turn on/off pseudo-transparency by using the root pixmap as background.
695
696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
697future versions.
698
699=item B<fading:> I<number> 663=item B<fading:> I<number>
700 664
701Fade the text by the given percentage when focus is lost; option B<-fade>. 665Fade the text by the given percentage when focus is lost; option B<-fade>.
702 666
703=item B<fadeColor:> I<colour> 667=item B<fadeColor:> I<colour>
704 668
705Fade to this colour, when fading is used (see B<fading:>). The default 669Fade to this colour, when fading is used (see B<fading:>). The default
706colour is black; option B<-fadecolor>. 670colour is black; option B<-fadecolor>.
707 671
708=item B<tintColor:> I<colour>
709
710Tint the transparent background with the given colour. If the RENDER
711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
715
716=item B<shading:> I<number>
717
718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
719A value of 100 means no shading; option B<-sh>.
720
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number>
726
727Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>.
729
730=item B<iconFile:> I<file> 672=item B<iconFile:> I<file>
731 673
732Set the application icon pixmap; option B<-icon>. 674Set the application icon pixmap; option B<-icon>.
733 675
734=item B<scrollColor:> I<colour> 676=item B<scrollColor:> I<colour>
… …
742 684
743=item B<borderColor:> I<colour> 685=item B<borderColor:> I<colour>
744 686
745The colour of the border around the text area and between the scrollbar 687The colour of the border around the text area and between the scrollbar
746and the text. 688and the text.
747
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
749
750Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>,
752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
754centre (percent). A scale of 0 disables scaling.
755The maximum permitted scale is 1000.
756Additional operations can be specified after colon B<:op1:op2...>.
757Supported operations are:
758
759 tile will tile image
760 propscale will scale image keeping proportions
761 scale will scale image to match window size
762 root will tile image as if it was a root window background, auto-adjusting
763 whenever terminal window moves
764
765If used in conjunction with B<-tr> option, the specified pixmap will be
766blended over the transparent background using alpha-blending. If I<afterimage>
767support has been compiled in it is possible to choose other blending
768types with B<-blt "type"> option.
769
770=item B<path:> I<path>
771
772Specify the colon-delimited search path for finding background image files.
773 689
774=item B<font:> I<fontlist> 690=item B<font:> I<fontlist>
775 691
776Select the fonts to be used. This is a comma separated list of font names 692Select the fonts to be used. This is a comma separated list of font names
777that are checked in order when trying to find glyphs for characters. The 693that are checked in order when trying to find glyphs for characters. The
… …
873=item B<loginShell:> I<boolean> 789=item B<loginShell:> I<boolean>
874 790
875B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 791B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
876the shell; option B<-ls>. B<False>: start as a normal sub-shell 792the shell; option B<-ls>. B<False>: start as a normal sub-shell
877[default]; option B<+ls>. 793[default]; option B<+ls>.
794
795=item B<multiClickTime:> I<number>
796
797Specify the maximum time in milliseconds between multi-click select
798events. The default is 500 milliseconds; option B<-mc>.
878 799
879=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
880 801
881B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
882option B<-ut>. B<False>: write record into the system log file B<utmp> 803option B<-ut>. B<False>: write record into the system log file B<utmp>
… …
1134Sets the working directory for the shell (or the command specified via 1055Sets the working directory for the shell (or the command specified via
1135B<-e>). The I<path> must be an absolute path and it must exist for 1056B<-e>). The I<path> must be an absolute path and it must exist for
1136@@RXVT_NAME@@ to start. If it isn't specified then the current working 1057@@RXVT_NAME@@ to start. If it isn't specified then the current working
1137directory will be used; option B<-cd>. 1058directory will be used; option B<-cd>.
1138 1059
1139=item B<keysym.>I<sym>: I<string> 1060=item B<keysym.>I<sym>: I<action>
1140 1061
1141Compile I<frills>: Associate I<string> with keysym I<sym>. The 1062Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1142intervening resource name B<keysym.> cannot be omitted. 1063resource name B<keysym.> cannot be omitted.
1143 1064
1144The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1065Using this resource, you can map key combinations such as
1145any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1066C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1146B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1067string than would normally result from that combination, making the
1147and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1068terminal scroll up or down the way you want it, or any other thing an
1148B<2>, B<3>, B<4>, B<5>. 1069extension might provide.
1070
1071The key combination that triggers the action, I<sym>, has the following format:
1072
1073 (modifiers-)key
1074
1075Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1076B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1077B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1078B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1149 1079
1150The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1080The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1151whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1081whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1152keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1082keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1153current application keymap mode state. 1083current application keymap mode state.
1154 1084
1155The spellings of I<key> can be obtained by using B<xev>(1) command or 1085Due the the large number of modifier combinations, a key mapping will
1156searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1086match if I<at least> the specified identifiers are being set, and no other
1087key mappings with those and more bits are being defined. That means that
1088defining a mapping for C<a> will automatically provide definitions for
1089C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1090themselves. See the C<builtin:> action, below, for a way to work around
1091this when this is a problem.
1092
1093The spelling of I<key> depends on your implementation of X. An easy way to
1094find a key name is to use the B<xev>(1) command. You can find a list by
1095looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1157omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1096the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1158keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1097value (B<0x0000 - 0xFFFF>).
1159performed in an exact manner; however, the closest match is assured.
1160 1098
1161I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1099As with any resource value, the I<action> string may contain backslash
1100escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1162number), see RESOURCES in C<man 7 X> for further details. 1101number), see RESOURCES in C<man 7 X> for further details.
1163 1102
1164You can define a range of keysyms in one shot by providing a I<string> 1103An action starts with an action prefix that selects a certain type
1165with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1104of action, followed by a colon. An action string without colons is
1166should be a character not used by the strings. 1105interpreted as a literal string to pass to the tty (as if it was
1106prefixed with C<string:>).
1167 1107
1168Its usage can be demonstrated by an example: 1108The following action prefixes are known - extensions can provide
1109additional prefixes:
1169 1110
1170 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1111=over 4
1171 1112
1172The above line is equivalent to the following three lines: 1113=item string:STRING
1173 1114
1174 URxvt.keysym.Meta-Control-0x61: \033<a> 1115If the I<action> starts with C<string:> (or otherwise contains no colons),
1175 URxvt.keysym.Meta-Control-0x62: \033<b> 1116then the remaining C<STRING> will be passed to the program running in the
1176 URxvt.keysym.Meta-Control-0x63: \033<c> 1117terminal. For example, you could replace whatever Shift-Tab outputs by the
1118string C<echo rm -rf /> followed by a newline:
1177 1119
1120 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1121
1122This could in theory be used to completely redefine your keymap.
1123
1124=item command:STRING
1125
1178If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1126If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1179is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1127is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1128the opposite of C<string:> - instead of sending it to the program running
1129in the terminal, it will be treated as if it were program output). This is
1130most useful to feed command sequences into @@RXVT_NAME@@.
1131
1180example the following means "change the current locale to C<zh_CN.GBK> 1132For example the following means "change the current locale to C<zh_CN.GBK>
1181when Control-Meta-c is being pressed": 1133when Control-Meta-c is being pressed":
1182 1134
1183 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1135 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1184 1136
1185If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1137The following example will map Control-Meta-1 and Control-Meta-2 to
1186is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1138the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1187manpage. For example, the F<selection> extension (activated via 1139font-switching at runtime:
1188C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1189 1140
1190 URxvt.keysym.M-C-c: perl:selection:rot13 1141 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1142 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1191 1143
1192Due the the large number of modifier combinations, a defined key mapping 1144Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1193will match if I<at least> the specified identifiers are being set, and 1145info):
1194no other key mappings with those and more bits are being defined. That
1195means that defining a key map for C<a> will automatically provide
1196definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1197mappings themselves.
1198 1146
1199Unfortunately, this will override built-in key mappings. For example 1147 URxvt.keysym.M-C-3: command:\033[8;25;80t
1148 URxvt.keysym.M-C-4: command:\033[8;48;110t
1149
1150=item builtin:
1151
1152The builtin action is the action that @@RXVT_NAME@@ would execute if no
1153key binding existed for the key combination. The obvious use is to undo
1154the effect of existing bindings. The not so obvious use is to reinstate
1155bindings when another binding overrides too many modifiers.
1156
1200if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1157For example if you overwrite the C<Insert> key you will disable
1201C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1158@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1202user-defined keymap using the C<builtin:> replacement: 1159"holes" into the user-defined keymap using the C<builtin:> replacement:
1203 1160
1204 URxvt.keysym.Insert: <my insert key sequence> 1161 URxvt.keysym.Insert: <my insert key sequence>
1205 URxvt.keysym.S-Insert: builtin: 1162 URxvt.keysym.S-Insert: builtin:
1206 1163
1207The first line defines a mapping for C<Insert> and I<any> combination 1164The first line defines a mapping for C<Insert> and I<any> combination
1208of modifiers. The second line re-establishes the default mapping for 1165of modifiers. The second line re-establishes the default mapping for
1209C<Shift-Insert>. 1166C<Shift-Insert>.
1210 1167
1211The following example will map Control-Meta-1 and Control-Meta-2 to 1168=item builtin-string:
1212the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1213font-switching at runtime:
1214 1169
1215 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1170This action is mainly useful to restore string mappings for keys that
1216 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1171have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1172difficult to explain - basically, this action will send the string to the
1173application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1174action for it.
1217 1175
1218Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1176An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1219info): 1177selection when you press C<Shift-Insert>. With the following bindings, it
1178would instead emit the (undocumented, but what applications running in the
1179terminal might expect) sequence C<ESC [ 2 $> instead:
1220 1180
1221 URxvt.keysym.M-C-3: command:\033[8;25;80t 1181 URxvt.keysym.S-Insert: builtin-string:
1222 URxvt.keysym.M-C-4: command:\033[8;48;110t 1182 URxvt.keysym.C-S-Insert: builtin:
1183
1184The first line disables the paste functionality for that key
1185combination, and the second reinstates the default behaviour for
1186C<Control-Shift-Insert>, which would otherwise be overridden.
1187
1188Similarly, to let applications gain access to the C<C-M-c> (copy to
1189clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1190this:
1191
1192 URxvt.keysym.C-S-c: builtin-string:
1193 URxvt.keysym.C-S-v: builtin-string:
1194
1195=item EXTENSION:STRING
1196
1197An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1198extension of the same name. The extension will be loaded automatically if
1199necessary.
1200
1201Not all extensions define key actions, but popular extensions that do
1202include the I<selection> and I<matcher> extensions (documented in their
1203own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1204respectively).
1205
1206From the silly examples department, this will rot13-"encrypt"
1207@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1208keyboards:
1209
1210 URxvt.keysym.M-C-c: selection:rot13
1211
1212=item perl:STRING *DEPRECATED*
1213
1214This is a deprecated way of passing key mappings to perl extensions. It is
1215still supported, but should not be used anymore.
1216
1217=back
1223 1218
1224=item B<perl-ext-common>: I<string> 1219=item B<perl-ext-common>: I<string>
1225 1220
1226=item B<perl-ext>: I<string> 1221=item B<perl-ext>: I<string>
1227 1222
… …
1229use in this terminal instance; option B<-pe>. 1224use in this terminal instance; option B<-pe>.
1230 1225
1231Extension names can be prefixed with a C<-> sign to prohibit using 1226Extension names can be prefixed with a C<-> sign to prohibit using
1232them. This can be useful to selectively disable some extensions loaded 1227them. This can be useful to selectively disable some extensions loaded
1233by default, or specified via the C<perl-ext-common> resource. For 1228by default, or specified via the C<perl-ext-common> resource. For
1234example, C<default,-selection> will use all the default extension except 1229example, C<default,-selection> will use all the default extensions except
1235C<selection>. 1230C<selection>.
1236 1231
1237Extension names can also be followed by an argument in angle brackets 1232The default set includes the C<selection>, C<option-popup>,
1238(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1233C<selection-popup> and C<readline> extensions, any extensions that define
1239searchable scrollback to Alt/Meta-s). Mentioning the same extension 1234keybindings via C<BINDING> meta comments, extensions loaded because
1240multiple times with different arguments will pass multiple arguments to 1235their resources/commandline switches were used, and extensions which are
1241the extension. 1236mentioned in B<keysym> resources.
1242 1237
1243Each extension is looked up in the library directories, loaded if 1238Each extension is looked up in the library directories, loaded if
1244necessary, and bound to the current terminal instance. 1239necessary, and bound to the current terminal instance. When the library
1240search path contains multiple extension files of the same name, then the
1241first one found will be used.
1245 1242
1246If both of these resources are the empty string, then the perl 1243If both of these resources are the empty string, then the perl interpreter
1247interpreter will not be initialized. The idea behind two options is that 1244will not be initialized. The rationale for having two options is that
1248B<perl-ext-common> will be used for extensions that should be available to 1245B<perl-ext-common> will be used for extensions that should be available to
1249all instances, while B<perl-ext> is used for specific instances. 1246all instances, while B<perl-ext> is used for specific instances.
1250 1247
1251=item B<perl-eval>: I<string> 1248=item B<perl-eval>: I<string>
1252 1249
… …
1254the @@RXVT_NAME@@perl(3) manpage. 1251the @@RXVT_NAME@@perl(3) manpage.
1255 1252
1256=item B<perl-lib>: I<path> 1253=item B<perl-lib>: I<path>
1257 1254
1258Colon-separated list of additional directories that hold extension 1255Colon-separated list of additional directories that hold extension
1259scripts. When looking for extensions specified by the C<perl> resource, 1256scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1260@@RXVT_NAME@@ will first look in these directories and then in 1257in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1261F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1258lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1262 1259
1263See the @@RXVT_NAME@@perl(3) manpage. 1260See the @@RXVT_NAME@@perl(3) manpage.
1264 1261
1265=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1262=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1266 1263
… …
1270=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1267=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1271 1268
1272Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1269Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1273for details. 1270for details.
1274 1271
1275=item B<searchable-scrollback:> I<keysym> 1272=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1276 1273
1277Sets the hotkey that starts the incremental scrollback buffer search 1274This resource is deprecated and will be removed. Use a B<keysym> resource
1278(default: C<M-s>). 1275instead, e.g.:
1279 1276
1277 URxvt.keysym.M-s: searchable-scrollback:start
1278
1280=item B<urlLauncher>: I<string> 1279=item B<url-launcher>: I<string>
1281 1280
1282Specifies the program to be started with a URL argument. Used by the 1281Specifies the program to be started with a URL argument. Used by the
1283C<selection-popup> and C<matcher> perl extensions. 1282C<selection-popup> and C<matcher> perl extensions.
1284 1283
1285=item B<transient-for>: I<windowid> 1284=item B<transient-for>: I<windowid>
… …
1296Turn on/off ISO 14755 (default enabled). 1295Turn on/off ISO 14755 (default enabled).
1297 1296
1298=item B<iso14755_52:> I<boolean> 1297=item B<iso14755_52:> I<boolean>
1299 1298
1300Turn on/off ISO 14755 5.2 mode (default enabled). 1299Turn on/off ISO 14755 5.2 mode (default enabled).
1300
1301=back
1302
1303=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1304
1305=over 4
1306
1307=item B<-pixmap> I<file[;oplist]>
1308
1309=item B<backgroundPixmap:> I<file[;oplist]>
1310
1311Compile I<pixbuf>: Use the specified image file as the window's
1312background and also optionally specify a colon separated list of
1313operations to modify it. Note that you may need to quote the C<;>
1314character when using the command line option, as C<;> is usually a
1315metacharacter in shells. Supported operations are:
1316
1317=over 4
1318
1319=item B<WxH+X+Y>
1320
1321sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1322scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1323scale of 0 disables scaling.
1324
1325=item B<op=tile>
1326
1327enables tiling
1328
1329=item B<op=keep-aspect>
1330
1331maintain the image aspect ratio when scaling
1332
1333=item B<op=root-align>
1334
1335use the position of the terminal window relative to the root window as
1336the image offset, simulating a root window background
1337
1338=back
1339
1340The default scale and position setting is C<100x100+50+50>.
1341Alternatively, a predefined set of templates can be used to achieve
1342the most common setups:
1343
1344=over 4
1345
1346=item B<style=tiled>
1347
1348the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1349
1350=item B<style=aspect-stretched>
1351
1352the image is scaled to fill the whole window maintaining the aspect
1353ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1354
1355=item B<style=stretched>
1356
1357the image is scaled to fill the whole window. Equivalent to 100x100
1358
1359=item B<style=centered>
1360
1361the image is centered with no scaling. Equivalent to 0x0+50+50
1362
1363=item B<style=root-tiled>
1364
1365the image is tiled with no scaling and using 'root' positioning.
1366Equivalent to 0x0:op=tile:op=root-align
1367
1368=back
1369
1370If multiple templates are specified the last one wins. Note that a
1371template overrides all the scale, position and operations settings.
1372
1373If used in conjunction with pseudo-transparency, the specified pixmap
1374will be blended over the transparent background using alpha-blending.
1375
1376=item B<-tr>|B<+tr>
1377
1378=item B<transparent:> I<boolean>
1379
1380Turn on/off pseudo-transparency by using the root pixmap as background.
1381
1382B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1383will be removed in future versions.
1384
1385=item B<-tint> I<colour>
1386
1387=item B<tintColor:> I<colour>
1388
1389Tint the transparent background with the given colour. Note that a
1390black tint yields a completely black image while a white tint yields
1391the image unchanged.
1392
1393=item B<-sh> I<number>
1394
1395=item B<shading:> I<number>
1396
1397Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1398A value of 100 means no shading.
1399
1400=item B<-blr> I<HxV>
1401
1402=item B<blurRadius:> I<HxV>
1403
1404Apply gaussian blur with the specified radius to the transparent
1405background. If a single number is specified, the vertical and
1406horizontal radii are considered to be the same. Setting one of the
1407radii to 1 and the other to a large number creates interesting effects
1408on some backgrounds. The maximum radius value is 128. An horizontal or
1409vertical radius of 0 disables blurring.
1410
1411=item B<path:> I<path>
1412
1413Specify the colon-delimited search path for finding background image files.
1301 1414
1302=back 1415=back
1303 1416
1304=head1 THE SCROLLBAR 1417=head1 THE SCROLLBAR
1305 1418
… …
1353window causes the value of the PRIMARY selection (or CLIPBOARD with the 1466window causes the value of the PRIMARY selection (or CLIPBOARD with the
1354B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1467B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1355 1468
1356Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1469Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1357inserted too. 1470inserted too.
1471
1472rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1473<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1474binding causes the value of the internal selection to be copied to the
1475CLIPBOARD selection, while the second binding causes the value of the
1476CLIPBOARD selection to be inserted.
1358 1477
1359=back 1478=back
1360 1479
1361=head1 CHANGING FONTS 1480=head1 CHANGING FONTS
1362 1481
… …
1487The following text gives values for the standard 88 colour mode (and 1606The following text gives values for the standard 88 colour mode (and
1488values for the 256 colour mode in parentheses). 1607values for the 256 colour mode in parentheses).
1489 1608
1490The RGB cube uses indices 16..79 (16..231) using the following formulas: 1609The RGB cube uses indices 16..79 (16..231) using the following formulas:
1491 1610
1492 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1611 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1493 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1612 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1494 1613
1495The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1614The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1496steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1615steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1497the RGB cube. 1616the RGB cube.
1498 1617
… …
1514White. 1633White.
1515 1634
1516=head2 ALPHA CHANNEL SUPPORT 1635=head2 ALPHA CHANNEL SUPPORT
1517 1636
1518If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1637If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1519their act together, rxvt-unicode will do it's own alpha channel management: 1638their act together, rxvt-unicode will do its own alpha channel management:
1520 1639
1521You can prefix any colour with an opaqueness percentage enclosed in 1640You can prefix any colour with an opaqueness percentage enclosed in
1522brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1641brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1523(0-100) that specifies the opacity of the colour, where C<0> is completely 1642(0-100) that specifies the opacity of the colour, where C<0> is completely
1524transparent and C<100> is completely opaque. For example, C<[50]red> is a 1643transparent and C<100> is completely opaque. For example, C<[50]red> is a
… …
1606 1725
1607=item B<SHELL> 1726=item B<SHELL>
1608 1727
1609The shell to be used for command execution, defaults to C</bin/sh>. 1728The shell to be used for command execution, defaults to C</bin/sh>.
1610 1729
1611=item B<RXVT_SOCKET> 1730=item B<RXVT_SOCKET> [I<sic>]
1612 1731
1613The unix domain socket path used by @@RXVT_NAME@@c(1) and 1732The unix domain socket path used by @@RXVT_NAME@@c(1) and
1614@@RXVT_NAME@@d(1). 1733@@RXVT_NAME@@d(1).
1615 1734
1616Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1735Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1736
1737=item B<URXVT_PERL_LIB>
1738
1739Additional F<:>-separated library search path for perl extensions. Will be
1740searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1741directory.
1742
1743=item B<URXVT_PERL_VERBOSITY>
1744
1745See L<@@RXVT_NAME@@perl>(3).
1617 1746
1618=item B<HOME> 1747=item B<HOME>
1619 1748
1620Used to locate the default directory for the unix domain socket for 1749Used to locate the default directory for the unix domain socket for
1621daemon communications and to locate various resource files (such as 1750daemon communications and to locate various resource files (such as
… …
1642 1771
1643=back 1772=back
1644 1773
1645=head1 SEE ALSO 1774=head1 SEE ALSO
1646 1775
1776@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1647@@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) 1777@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1648 1778
1649=head1 CURRENT PROJECT COORDINATOR 1779=head1 CURRENT PROJECT COORDINATOR
1650 1780
1651=over 4 1781=over 4
1652 1782
1653=item Project Coordinator 1783=item Project Coordinator
1654 1784
1655Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1785Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1656 1786
1657L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1787L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1658 1788
1659=back 1789=back
1660 1790
… …
1664 1794
1665=item John Bovey 1795=item John Bovey
1666 1796
1667University of Kent, 1992, wrote the original Xvt. 1797University of Kent, 1992, wrote the original Xvt.
1668 1798
1669=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1799=item Rob Nation <nation@rocket.sanders.lockheed.com>
1670 1800
1671very heavily modified Xvt and came up with Rxvt 1801very heavily modified Xvt and came up with Rxvt
1672 1802
1673=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1803=item Angelo Haritsis <ah@doc.ic.ac.uk>
1674 1804
1675wrote the Greek Keyboard Input (no longer in code) 1805wrote the Greek Keyboard Input (no longer in code)
1676 1806
1677=item mj olesen L<< <olesen@me.QueensU.CA> >> 1807=item mj olesen <olesen@me.QueensU.CA>
1678 1808
1679Wrote the menu system. 1809Wrote the menu system.
1680 1810
1681Project Coordinator (changes.txt 2.11 to 2.21) 1811Project Coordinator (changes.txt 2.11 to 2.21)
1682 1812
1683=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1813=item Oezguer Kesim <kesim@math.fu-berlin.de>
1684 1814
1685Project Coordinator (changes.txt 2.21a to 2.4.5) 1815Project Coordinator (changes.txt 2.21a to 2.4.5)
1686 1816
1687=item Geoff Wing L<< <gcw@pobox.com> >> 1817=item Geoff Wing <gcw@pobox.com>
1688 1818
1689Rewrote screen display and text selection routines. 1819Rewrote screen display and text selection routines.
1690 1820
1691Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1821Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1692 1822
1693=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1823=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1694 1824
1695Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1825Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1696extension, random hacks, numerous bugfixes and extensions. 1826extension, random hacks, numerous bugfixes and extensions.
1697 1827
1698Project Coordinator (Changes 1.0 -) 1828Project Coordinator (Changes 1.0 -)
1699 1829
1700=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1830=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1701 1831
1702pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1832pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1703 1833
1704=back 1834=back
1705 1835

Diff Legend

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