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.195 by sf-exg, Sat Apr 30 18:45:38 2011 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<-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
… …
344 306
345=item B<-override-redirect> 307=item B<-override-redirect>
346 308
347Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
348B<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.
349 316
350=item B<-sbg> 317=item B<-sbg>
351 318
352Compile 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
353drawing characters and just rely on what the specified fonts provide. Use 320drawing characters and just rely on what the specified fonts provide. Use
… …
687 654
688B<False>: specify that everything is to be displayed, even 655B<False>: specify that everything is to be displayed, even
689if 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
690monitor to display anything); option B<+ss>. 657monitor to display anything); option B<+ss>.
691 658
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> 659=item B<fading:> I<number>
700 660
701Fade 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>.
702 662
703=item B<fadeColor:> I<colour> 663=item B<fadeColor:> I<colour>
704 664
705Fade 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
706colour is black; option B<-fadecolor>. 666colour is black; option B<-fadecolor>.
707 667
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> 668=item B<iconFile:> I<file>
731 669
732Set the application icon pixmap; option B<-icon>. 670Set the application icon pixmap; option B<-icon>.
733 671
734=item B<scrollColor:> I<colour> 672=item B<scrollColor:> I<colour>
… …
742 680
743=item B<borderColor:> I<colour> 681=item B<borderColor:> I<colour>
744 682
745The 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
746and the text. 684and 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 displays the image with tiling.
755The maximum permitted scale is 1000.
756Additional operations can be specified after colon B<:op1:op2...>.
757Supported operations are:
758
759 tile force background image to be tiled and not scaled. Equivalent to 0x0
760 propscale will scale image keeping proportions
761 auto will scale image to match window size. Equivalent to 100x100
762 hscale will scale image horizontally to the window size
763 vscale will scale image vertically to the window size
764 scale will scale image to match window size
765 root will tile image as if it was a root window background, auto-adjusting
766 whenever terminal window moves
767
768If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
772
773=item B<path:> I<path>
774
775Specify the colon-delimited search path for finding background image files.
776 685
777=item B<font:> I<fontlist> 686=item B<font:> I<fontlist>
778 687
779Select 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
780that 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
… …
935B<False>: do not scroll to bottom when tty receives output; option 844B<False>: do not scroll to bottom when tty receives output; option
936B<+si>. 845B<+si>.
937 846
938=item B<scrollWithBuffer:> I<boolean> 847=item B<scrollWithBuffer:> I<boolean>
939 848
940B<True>: scroll with scrollback buffer when tty receives new lines (and 849B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
941B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 850try to show the same lines) and B<scrollTtyOutput> is False; option
942with scrollback buffer when tty receives new lines; option B<+sw>. 851B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
852new lines; option B<+sw>.
943 853
944=item B<scrollTtyKeypress:> I<boolean> 854=item B<scrollTtyKeypress:> I<boolean>
945 855
946B<True>: scroll to bottom when a non-special key is pressed. Special keys 856B<True>: scroll to bottom when a non-special key is pressed. Special keys
947are those which are intercepted by rxvt-unicode for special handling and 857are those which are intercepted by rxvt-unicode for special handling and
… …
1136Sets the working directory for the shell (or the command specified via 1046Sets the working directory for the shell (or the command specified via
1137B<-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
1138@@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
1139directory will be used; option B<-cd>. 1049directory will be used; option B<-cd>.
1140 1050
1141=item B<keysym.>I<sym>: I<string> 1051=item B<keysym.>I<sym>: I<action>
1142 1052
1143Compile I<frills>: Associate I<string> with keysym I<sym>. The 1053Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1144intervening resource name B<keysym.> cannot be omitted. 1054resource name B<keysym.> cannot be omitted.
1145 1055
1146The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1056Using this resource, you can map key combinations such as
1147any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1057C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1148B<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
1149and 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
1150B<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>.
1151 1070
1152The 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
1153whatever 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
1154keys 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
1155current application keymap mode state. 1074current application keymap mode state.
1156 1075
1157The 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
1158searching 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
1159omitting 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
1160keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1088value (B<0x0000 - 0xFFFF>).
1161performed in an exact manner; however, the closest match is assured.
1162 1089
1163I<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
1164number), see RESOURCES in C<man 7 X> for further details. 1092number), see RESOURCES in C<man 7 X> for further details.
1165 1093
1094An action starts with an action prefix that selects a certain type
1095of action, followed by a colon. An action string without colons is
1096interpreted as a literal string to pass to the tty (as if it was
1097prefixed with C<string:>).
1098
1099The following action prefixes are known - extensions can provide
1100additional prefixes:
1101
1102=over 4
1103
1104=item string:STRING
1105
1106If the I<action> starts with C<string:> (or otherwise contains no colons),
1107then the remaining C<STRING> will be passed to the program running in the
1108terminal. For example, you could replace whatever Shift-Tab outputs by the
1109string C<echo rm -rf /> followed by a newline:
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
1166If 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>
1167is 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
1168example 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>
1169when Control-Meta-c is being pressed": 1124when Control-Meta-c is being pressed":
1170 1125
1171 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
1172 1127
1173If 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
1174is 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
1175manpage. For example, the F<selection> extension (activated via 1130font-switching at runtime:
1176C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1177 1131
1178 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
1179 1134
1180Due the the large number of modifier combinations, a defined key mapping 1135Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1181will match if I<at least> the specified identifiers are being set, and 1136info):
1182no other key mappings with those and more bits are being defined. That
1183means that defining a key map for C<a> will automatically provide
1184definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1185mappings themselves.
1186 1137
1187Unfortunately, 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
1188if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1148For example if you overwrite the C<Insert> key you will disable
1189C<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
1190user-defined keymap using the C<builtin:> replacement: 1150"holes" into the user-defined keymap using the C<builtin:> replacement:
1191 1151
1192 URxvt.keysym.Insert: <my insert key sequence> 1152 URxvt.keysym.Insert: <my insert key sequence>
1193 URxvt.keysym.S-Insert: builtin: 1153 URxvt.keysym.S-Insert: builtin:
1194 1154
1195The 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
1196of modifiers. The second line re-establishes the default mapping for 1156of modifiers. The second line re-establishes the default mapping for
1197C<Shift-Insert>. 1157C<Shift-Insert>.
1198 1158
1199The following example will map Control-Meta-1 and Control-Meta-2 to 1159=item builtin-string:
1200the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1201font-switching at runtime:
1202 1160
1203 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1161This action is mainly useful to restore string mappings for keys that
1204 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.
1205 1166
1206Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1167An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1207info): 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:
1208 1171
1209 URxvt.keysym.M-C-3: command:\033[8;25;80t 1172 URxvt.keysym.S-Insert: builtin-string:
1210 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
1211 1209
1212=item B<perl-ext-common>: I<string> 1210=item B<perl-ext-common>: I<string>
1213 1211
1214=item B<perl-ext>: I<string> 1212=item B<perl-ext>: I<string>
1215 1213
… …
1217use in this terminal instance; option B<-pe>. 1215use in this terminal instance; option B<-pe>.
1218 1216
1219Extension names can be prefixed with a C<-> sign to prohibit using 1217Extension names can be prefixed with a C<-> sign to prohibit using
1220them. This can be useful to selectively disable some extensions loaded 1218them. This can be useful to selectively disable some extensions loaded
1221by default, or specified via the C<perl-ext-common> resource. For 1219by default, or specified via the C<perl-ext-common> resource. For
1222example, C<default,-selection> will use all the default extension except 1220example, C<default,-selection> will use all the default extensions except
1223C<selection>. 1221C<selection>.
1224 1222
1225Extension names can also be followed by an argument in angle brackets 1223The default set includes the C<selection>, C<option-popup>,
1226(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1224C<selection-popup> and C<readline> extensions, any extensions that define
1227searchable scrollback to Alt/Meta-s). Mentioning the same extension 1225keybindings via C<BINDING> meta comments, extensions loaded because
1228multiple times with different arguments will pass multiple arguments to 1226their resources/commandline switches were used, and extensions which are
1229the extension. 1227mentioned in B<keysym> resources.
1230 1228
1231Each extension is looked up in the library directories, loaded if 1229Each extension is looked up in the library directories, loaded if
1232necessary, 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.
1233 1233
1234If both of these resources are the empty string, then the perl 1234If both of these resources are the empty string, then the perl interpreter
1235interpreter will not be initialized. The idea behind two options is that 1235will not be initialized. The rationale for having two options is that
1236B<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
1237all instances, while B<perl-ext> is used for specific instances. 1237all instances, while B<perl-ext> is used for specific instances.
1238 1238
1239=item B<perl-eval>: I<string> 1239=item B<perl-eval>: I<string>
1240 1240
… …
1242the @@RXVT_NAME@@perl(3) manpage. 1242the @@RXVT_NAME@@perl(3) manpage.
1243 1243
1244=item B<perl-lib>: I<path> 1244=item B<perl-lib>: I<path>
1245 1245
1246Colon-separated list of additional directories that hold extension 1246Colon-separated list of additional directories that hold extension
1247scripts. When looking for extensions specified by the C<perl> resource, 1247scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1248@@RXVT_NAME@@ will first look in these directories and then in 1248in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1249F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1249lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1250 1250
1251See the @@RXVT_NAME@@perl(3) manpage. 1251See the @@RXVT_NAME@@perl(3) manpage.
1252 1252
1253=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1253=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1254 1254
… …
1258=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1258=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1259 1259
1260Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1260Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1261for details. 1261for details.
1262 1262
1263=item B<searchable-scrollback:> I<keysym> 1263=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1264 1264
1265Sets the hotkey that starts the incremental scrollback buffer search 1265This resource is deprecated and will be removed. Use a B<keysym> resource
1266(default: C<M-s>). 1266instead, e.g.:
1267 1267
1268 URxvt.keysym.M-s: searchable-scrollback:start
1269
1268=item B<urlLauncher>: I<string> 1270=item B<url-launcher>: I<string>
1269 1271
1270Specifies 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
1271C<selection-popup> and C<matcher> perl extensions. 1273C<selection-popup> and C<matcher> perl extensions.
1272 1274
1273=item B<transient-for>: I<windowid> 1275=item B<transient-for>: I<windowid>
… …
1284Turn on/off ISO 14755 (default enabled). 1286Turn on/off ISO 14755 (default enabled).
1285 1287
1286=item B<iso14755_52:> I<boolean> 1288=item B<iso14755_52:> I<boolean>
1287 1289
1288Turn 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.
1289 1405
1290=back 1406=back
1291 1407
1292=head1 THE SCROLLBAR 1408=head1 THE SCROLLBAR
1293 1409
… …
1341window causes the value of the PRIMARY selection (or CLIPBOARD with the 1457window causes the value of the PRIMARY selection (or CLIPBOARD with the
1342B<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.
1343 1459
1344Pressing 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
1345inserted 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.
1346 1468
1347=back 1469=back
1348 1470
1349=head1 CHANGING FONTS 1471=head1 CHANGING FONTS
1350 1472
… …
1475The following text gives values for the standard 88 colour mode (and 1597The following text gives values for the standard 88 colour mode (and
1476values for the 256 colour mode in parentheses). 1598values for the 256 colour mode in parentheses).
1477 1599
1478The 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:
1479 1601
1480 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
1481 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
1482 1604
1483The 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%
1484steps (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
1485the RGB cube. 1607the RGB cube.
1486 1608
… …
1502White. 1624White.
1503 1625
1504=head2 ALPHA CHANNEL SUPPORT 1626=head2 ALPHA CHANNEL SUPPORT
1505 1627
1506If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1628If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1507their act together, rxvt-unicode will do it's own alpha channel management: 1629their act together, rxvt-unicode will do its own alpha channel management:
1508 1630
1509You can prefix any colour with an opaqueness percentage enclosed in 1631You can prefix any colour with an opaqueness percentage enclosed in
1510brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1632brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1511(0-100) that specifies the opacity of the colour, where C<0> is completely 1633(0-100) that specifies the opacity of the colour, where C<0> is completely
1512transparent and C<100> is completely opaque. For example, C<[50]red> is a 1634transparent and C<100> is completely opaque. For example, C<[50]red> is a
… …
1594 1716
1595=item B<SHELL> 1717=item B<SHELL>
1596 1718
1597The 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>.
1598 1720
1599=item B<RXVT_SOCKET> 1721=item B<RXVT_SOCKET> [I<sic>]
1600 1722
1601The unix domain socket path used by @@RXVT_NAME@@c(1) and 1723The unix domain socket path used by @@RXVT_NAME@@c(1) and
1602@@RXVT_NAME@@d(1). 1724@@RXVT_NAME@@d(1).
1603 1725
1604Default F<<< $HOME/.rxvt-unicode-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).
1605 1737
1606=item B<HOME> 1738=item B<HOME>
1607 1739
1608Used to locate the default directory for the unix domain socket for 1740Used to locate the default directory for the unix domain socket for
1609daemon communications and to locate various resource files (such as 1741daemon communications and to locate various resource files (such as
… …
1630 1762
1631=back 1763=back
1632 1764
1633=head1 SEE ALSO 1765=head1 SEE ALSO
1634 1766
1767@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1635@@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)
1636 1769
1637=head1 CURRENT PROJECT COORDINATOR 1770=head1 CURRENT PROJECT COORDINATOR
1638 1771
1639=over 4 1772=over 4
1640 1773
1641=item Project Coordinator 1774=item Project Coordinator
1642 1775
1643Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1776Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1644 1777
1645L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1778L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1646 1779
1647=back 1780=back
1648 1781
… …
1652 1785
1653=item John Bovey 1786=item John Bovey
1654 1787
1655University of Kent, 1992, wrote the original Xvt. 1788University of Kent, 1992, wrote the original Xvt.
1656 1789
1657=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1790=item Rob Nation <nation@rocket.sanders.lockheed.com>
1658 1791
1659very heavily modified Xvt and came up with Rxvt 1792very heavily modified Xvt and came up with Rxvt
1660 1793
1661=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1794=item Angelo Haritsis <ah@doc.ic.ac.uk>
1662 1795
1663wrote the Greek Keyboard Input (no longer in code) 1796wrote the Greek Keyboard Input (no longer in code)
1664 1797
1665=item mj olesen L<< <olesen@me.QueensU.CA> >> 1798=item mj olesen <olesen@me.QueensU.CA>
1666 1799
1667Wrote the menu system. 1800Wrote the menu system.
1668 1801
1669Project Coordinator (changes.txt 2.11 to 2.21) 1802Project Coordinator (changes.txt 2.11 to 2.21)
1670 1803
1671=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1804=item Oezguer Kesim <kesim@math.fu-berlin.de>
1672 1805
1673Project Coordinator (changes.txt 2.21a to 2.4.5) 1806Project Coordinator (changes.txt 2.21a to 2.4.5)
1674 1807
1675=item Geoff Wing L<< <gcw@pobox.com> >> 1808=item Geoff Wing <gcw@pobox.com>
1676 1809
1677Rewrote screen display and text selection routines. 1810Rewrote screen display and text selection routines.
1678 1811
1679Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1812Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1680 1813
1681=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1814=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1682 1815
1683Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1816Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1684extension, random hacks, numerous bugfixes and extensions. 1817extension, random hacks, numerous bugfixes and extensions.
1685 1818
1686Project Coordinator (Changes 1.0 -) 1819Project Coordinator (Changes 1.0 -)
1687 1820
1688=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1821=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1689 1822
1690pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1823pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1691 1824
1692=back 1825=back
1693 1826

Diff Legend

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