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.219 by root, Thu Jun 7 16:06:23 2012 UTC vs.
Revision 1.236 by sf-exg, Sat Aug 16 10:51:23 2014 UTC

127 127
128=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
129 129
130Turn 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>.
131 131
132=item B<-tr>|B<+tr>
133
134Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
135
136B<-ip> is still accepted as an obsolete alias but will be removed in
137future versions.
138
139=item B<-fade> I<number> 132=item B<-fade> I<number>
140 133
141Fade 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
142fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
143colour; resource B<fading>. 136colour; resource B<fading>.
145=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
146 139
147Fade 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
148is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
149 142
150=item B<-tint> I<colour>
151
152Tint the transparent background with the given colour;
153resource I<tintColor>.
154
155=item B<-sh> I<number>
156
157Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
158A value of 100 means no shading; resource I<shading>.
159
160=item B<-blr> I<HxV>
161
162Apply Gaussian Blur with the specified radii to the transparent
163background. If a single number is specified, the vertical and
164horizontal radii are considered to be the same. Setting one of the
165radii to 1 and the other to a large number creates interesting effects
166on some backgrounds. The maximum radius value is 128. An horizontal or
167vertical radius of 0 disables blurring;
168resource I<blurRadius>.
169
170=item B<-icon> I<file> 143=item B<-icon> I<file>
171 144
172Compile I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
173is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
174application window; resource I<iconFile>. 147application window; resource I<iconFile>.
178Window background colour; resource B<background>. 151Window background colour; resource B<background>.
179 152
180=item B<-fg> I<colour> 153=item B<-fg> I<colour>
181 154
182Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
183
184=item B<-pixmap> I<file[;oplist]>
185
186Compile I<pixbuf>: Specify image file for the background and also
187optionally specify a list of operations to modify it. Note you may need to
188add quotes to avoid special shell interpretation of the C<;> in the
189command-line; for more details see resource B<backgroundPixmap>.
190 156
191=item B<-cr> I<colour> 157=item B<-cr> I<colour>
192 158
193The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
194 160
253 219
254=item B<-ls>|B<+ls> 220=item B<-ls>|B<+ls>
255 221
256Start as a login-shell/sub-shell; resource B<loginShell>. 222Start as a login-shell/sub-shell; resource B<loginShell>.
257 223
224=item B<-mc> I<milliseconds>
225
226Specify the maximum time between multi-click selections.
227
258=item B<-ut>|B<+ut> 228=item B<-ut>|B<+ut>
259 229
260Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 230Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
261B<utmpInhibit>. 231B<utmpInhibit>.
262 232
340 310
341=item B<-override-redirect> 311=item B<-override-redirect>
342 312
343Compile I<frills>: Sets override-redirect on the window; resource 313Compile I<frills>: Sets override-redirect on the window; resource
344B<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.
345 320
346=item B<-sbg> 321=item B<-sbg>
347 322
348Compile 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
349drawing characters and just rely on what the specified fonts provide. Use 324drawing characters and just rely on what the specified fonts provide. Use
683 658
684B<False>: specify that everything is to be displayed, even 659B<False>: specify that everything is to be displayed, even
685if 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
686monitor to display anything); option B<+ss>. 661monitor to display anything); option B<+ss>.
687 662
688=item B<transparent:> I<boolean>
689
690Turn on/off pseudo-transparency by using the root pixmap as background.
691
692B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
693future versions.
694
695=item B<fading:> I<number> 663=item B<fading:> I<number>
696 664
697Fade 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>.
698 666
699=item B<fadeColor:> I<colour> 667=item B<fadeColor:> I<colour>
700 668
701Fade 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
702colour is black; option B<-fadecolor>. 670colour is black; option B<-fadecolor>.
703 671
704=item B<tintColor:> I<colour>
705
706Tint the transparent background with the given colour. If the RENDER
707extension is not available only black, red, green, yellow, blue,
708magenta, cyan and white tints can be performed server-side. Note that
709a black tint yields a completely black image while a white tint yields
710the image unchanged; option B<-tint>.
711
712=item B<shading:> I<number>
713
714Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
715A value of 100 means no shading; option B<-sh>.
716
717=item B<blurRadius:> I<number>
718
719Apply gaussian blur with the specified radius to the transparent
720background; option B<-blr>.
721
722=item B<iconFile:> I<file> 672=item B<iconFile:> I<file>
723 673
724Set the application icon pixmap; option B<-icon>. 674Set the application icon pixmap; option B<-icon>.
725 675
726=item B<scrollColor:> I<colour> 676=item B<scrollColor:> I<colour>
734 684
735=item B<borderColor:> I<colour> 685=item B<borderColor:> I<colour>
736 686
737The 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
738and the text. 688and the text.
739
740=item B<backgroundPixmap:> I<file[;oplist]>
741
742Use the specified image file for the background and also
743optionally specify a colon separated list of operations to modify it.
744Supported operations are:
745
746=over 4
747
748=item B<WxH+X+Y>
749
750sets scale and position. B<"W" / "H"> specify the horizontal/vertical
751scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
752scale of 0 disables scaling.
753
754=item B<op=tile>
755
756enables tiling
757
758=item B<op=keep-aspect>
759
760maintain the image aspect ratio when scaling
761
762=item B<op=root-align>
763
764use the position of the terminal window relative to the root window as
765the image offset, simulating a root window background
766
767=back
768
769The default scale and position setting is C<100x100+50+50>.
770Alternatively, a predefined set of templates can be used to achieve
771the most common setups:
772
773=over 4
774
775=item B<style=tiled>
776
777the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
778
779=item B<style=aspect-stretched>
780
781the image is scaled to fill the whole window maintaining the aspect
782ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
783
784=item B<style=stretched>
785
786the image is scaled to fill the whole window. Equivalent to 100x100
787
788=item B<style=centered>
789
790the image is centered with no scaling. Equivalent to 0x0+50+50
791
792=item B<style=root-tiled>
793
794the image is tiled with no scaling and using 'root' positioning.
795Equivalent to 0x0:op=tile:op=root-align
796
797=back
798
799If multiple templates are specified the last one wins. Note that a
800template overrides all the scale, position and operations settings.
801
802If used in conjunction with B<-tr> option, the specified pixmap will be
803blended over the transparent background using alpha-blending.
804
805=item B<path:> I<path>
806
807Specify the colon-delimited search path for finding background image files.
808 689
809=item B<font:> I<fontlist> 690=item B<font:> I<fontlist>
810 691
811Select 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
812that 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
908=item B<loginShell:> I<boolean> 789=item B<loginShell:> I<boolean>
909 790
910B<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
911the 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
912[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>.
913 799
914=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
915 801
916B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
917option 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>
1169Sets the working directory for the shell (or the command specified via 1055Sets the working directory for the shell (or the command specified via
1170B<-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
1171@@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
1172directory will be used; option B<-cd>. 1058directory will be used; option B<-cd>.
1173 1059
1174=item B<keysym.>I<sym>: I<string> 1060=item B<keysym.>I<sym>: I<action>
1175 1061
1176Compile I<frills>: Associate I<string> with keysym I<sym>. The 1062Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1177intervening resource name B<keysym.> cannot be omitted. 1063resource name B<keysym.> cannot be omitted.
1178 1064
1179The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1065Using this resource, you can map key combinations such as
1180any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1066C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1181B<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
1182and 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
1183B<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>.
1184 1079
1185The 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
1186whatever 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
1187keys 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
1188current application keymap mode state. 1083current application keymap mode state.
1189 1084
1190The 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
1191searching 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
1192omitting 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
1193keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1097value (B<0x0000 - 0xFFFF>).
1194performed in an exact manner; however, the closest match is assured.
1195 1098
1196I<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
1197number), see RESOURCES in C<man 7 X> for further details. 1101number), see RESOURCES in C<man 7 X> for further details.
1198 1102
1199You can define a range of keysyms in one shot by 1103An action starts with an action prefix that selects a certain type
1200loading the C<keysym-list> perl extension and providing a I<string> 1104of action, followed by a colon. An action string without colons is
1201with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1105interpreted as a literal string to pass to the tty (as if it was
1202should be a character not used by the strings. 1106prefixed with C<string:>).
1203 1107
1204Its usage can be demonstrated by an example: 1108The following action prefixes are known - extensions can provide
1109additional prefixes:
1205 1110
1206 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1111=over 4
1207 1112
1208The above line is equivalent to the following three lines: 1113=item string:STRING
1209 1114
1210 URxvt.keysym.Meta-Control-0x61: \033<a> 1115If the I<action> starts with C<string:> (or otherwise contains no colons),
1211 URxvt.keysym.Meta-Control-0x62: \033<b> 1116then the remaining C<STRING> will be passed to the program running in the
1212 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:
1213 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
1214If 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>
1215is 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
1216example 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>
1217when Control-Meta-c is being pressed": 1133when Control-Meta-c is being pressed":
1218 1134
1219 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
1220 1136
1221If 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
1222is 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
1223manpage. For example, the F<selection> extension (activated via 1139font-switching at runtime:
1224C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1225 1140
1226 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
1227 1143
1228Due the the large number of modifier combinations, a defined key mapping 1144Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1229will match if I<at least> the specified identifiers are being set, and 1145info):
1230no other key mappings with those and more bits are being defined. That
1231means that defining a key map for C<a> will automatically provide
1232definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1233mappings themselves.
1234 1146
1235Unfortunately, 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
1236if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1157For example if you overwrite the C<Insert> key you will disable
1237C<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
1238user-defined keymap using the C<builtin:> replacement: 1159"holes" into the user-defined keymap using the C<builtin:> replacement:
1239 1160
1240 URxvt.keysym.Insert: <my insert key sequence> 1161 URxvt.keysym.Insert: <my insert key sequence>
1241 URxvt.keysym.S-Insert: builtin: 1162 URxvt.keysym.S-Insert: builtin:
1242 1163
1243The 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
1244of modifiers. The second line re-establishes the default mapping for 1165of modifiers. The second line re-establishes the default mapping for
1245C<Shift-Insert>. 1166C<Shift-Insert>.
1246 1167
1247The following example will map Control-Meta-1 and Control-Meta-2 to 1168=item builtin-string:
1248the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1249font-switching at runtime:
1250 1169
1251 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1170This action is mainly useful to restore string mappings for keys that
1252 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.
1253 1175
1254Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1176An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1255info): 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:
1256 1180
1257 URxvt.keysym.M-C-3: command:\033[8;25;80t 1181 URxvt.keysym.S-Insert: builtin-string:
1258 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
1259 1218
1260=item B<perl-ext-common>: I<string> 1219=item B<perl-ext-common>: I<string>
1261 1220
1262=item B<perl-ext>: I<string> 1221=item B<perl-ext>: I<string>
1263 1222
1265use in this terminal instance; option B<-pe>. 1224use in this terminal instance; option B<-pe>.
1266 1225
1267Extension names can be prefixed with a C<-> sign to prohibit using 1226Extension names can be prefixed with a C<-> sign to prohibit using
1268them. This can be useful to selectively disable some extensions loaded 1227them. This can be useful to selectively disable some extensions loaded
1269by default, or specified via the C<perl-ext-common> resource. For 1228by default, or specified via the C<perl-ext-common> resource. For
1270example, C<default,-selection> will use all the default extension except 1229example, C<default,-selection> will use all the default extensions except
1271C<selection>. 1230C<selection>.
1272 1231
1273Extension names can also be followed by an argument in angle brackets 1232The default set includes the C<selection>, C<option-popup>,
1274(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1233C<selection-popup> and C<readline> extensions, any extensions that define
1275searchable scrollback to Alt/Meta-s). Mentioning the same extension 1234keybindings via C<BINDING> meta comments, extensions loaded because
1276multiple times with different arguments will pass multiple arguments to 1235their resources/commandline switches were used, and extensions which are
1277the extension. 1236mentioned in B<keysym> resources.
1278 1237
1279Each extension is looked up in the library directories, loaded if 1238Each extension is looked up in the library directories, loaded if
1280necessary, 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.
1281 1242
1282If both of these resources are the empty string, then the perl 1243If both of these resources are the empty string, then the perl interpreter
1283interpreter will not be initialized. The idea behind two options is that 1244will not be initialized. The rationale for having two options is that
1284B<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
1285all instances, while B<perl-ext> is used for specific instances. 1246all instances, while B<perl-ext> is used for specific instances.
1286 1247
1287=item B<perl-eval>: I<string> 1248=item B<perl-eval>: I<string>
1288 1249
1306=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1267=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1307 1268
1308Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1269Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1309for details. 1270for details.
1310 1271
1311=item B<searchable-scrollback:> I<keysym> 1272=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1312 1273
1313Sets the hotkey that starts the incremental scrollback buffer search 1274This resource is deprecated and will be removed. Use a B<keysym> resource
1314(default: C<M-s>). 1275instead, e.g.:
1315 1276
1277 URxvt.keysym.M-s: searchable-scrollback:start
1278
1316=item B<urlLauncher>: I<string> 1279=item B<url-launcher>: I<string>
1317 1280
1318Specifies 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
1319C<selection-popup> and C<matcher> perl extensions. 1282C<selection-popup> and C<matcher> perl extensions.
1320 1283
1321=item B<transient-for>: I<windowid> 1284=item B<transient-for>: I<windowid>
1332Turn on/off ISO 14755 (default enabled). 1295Turn on/off ISO 14755 (default enabled).
1333 1296
1334=item B<iso14755_52:> I<boolean> 1297=item B<iso14755_52:> I<boolean>
1335 1298
1336Turn 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.
1337 1414
1338=back 1415=back
1339 1416
1340=head1 THE SCROLLBAR 1417=head1 THE SCROLLBAR
1341 1418
1389window causes the value of the PRIMARY selection (or CLIPBOARD with the 1466window causes the value of the PRIMARY selection (or CLIPBOARD with the
1390B<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.
1391 1468
1392Pressing 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
1393inserted 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.
1394 1477
1395=back 1478=back
1396 1479
1397=head1 CHANGING FONTS 1480=head1 CHANGING FONTS
1398 1481
1523The following text gives values for the standard 88 colour mode (and 1606The following text gives values for the standard 88 colour mode (and
1524values for the 256 colour mode in parentheses). 1607values for the 256 colour mode in parentheses).
1525 1608
1526The 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:
1527 1610
1528 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
1529 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
1530 1613
1531The 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%
1532steps (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
1533the RGB cube. 1616the RGB cube.
1534 1617
1688 1771
1689=back 1772=back
1690 1773
1691=head1 SEE ALSO 1774=head1 SEE ALSO
1692 1775
1693@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1776@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1777@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1694 1778
1695=head1 CURRENT PROJECT COORDINATOR 1779=head1 CURRENT PROJECT COORDINATOR
1696 1780
1697=over 4 1781=over 4
1698 1782
1699=item Project Coordinator 1783=item Project Coordinator
1700 1784
1701Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1785Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1702 1786
1703L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1787L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1704 1788
1705=back 1789=back
1706 1790
1710 1794
1711=item John Bovey 1795=item John Bovey
1712 1796
1713University of Kent, 1992, wrote the original Xvt. 1797University of Kent, 1992, wrote the original Xvt.
1714 1798
1715=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1799=item Rob Nation <nation@rocket.sanders.lockheed.com>
1716 1800
1717very heavily modified Xvt and came up with Rxvt 1801very heavily modified Xvt and came up with Rxvt
1718 1802
1719=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1803=item Angelo Haritsis <ah@doc.ic.ac.uk>
1720 1804
1721wrote the Greek Keyboard Input (no longer in code) 1805wrote the Greek Keyboard Input (no longer in code)
1722 1806
1723=item mj olesen L<< <olesen@me.QueensU.CA> >> 1807=item mj olesen <olesen@me.QueensU.CA>
1724 1808
1725Wrote the menu system. 1809Wrote the menu system.
1726 1810
1727Project Coordinator (changes.txt 2.11 to 2.21) 1811Project Coordinator (changes.txt 2.11 to 2.21)
1728 1812
1729=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1813=item Oezguer Kesim <kesim@math.fu-berlin.de>
1730 1814
1731Project Coordinator (changes.txt 2.21a to 2.4.5) 1815Project Coordinator (changes.txt 2.21a to 2.4.5)
1732 1816
1733=item Geoff Wing L<< <gcw@pobox.com> >> 1817=item Geoff Wing <gcw@pobox.com>
1734 1818
1735Rewrote screen display and text selection routines. 1819Rewrote screen display and text selection routines.
1736 1820
1737Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1821Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1738 1822
1739=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1823=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1740 1824
1741Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1825Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1742extension, random hacks, numerous bugfixes and extensions. 1826extension, random hacks, numerous bugfixes and extensions.
1743 1827
1744Project Coordinator (Changes 1.0 -) 1828Project Coordinator (Changes 1.0 -)
1745 1829
1746=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1830=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1747 1831
1748pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1832pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1749 1833
1750=back 1834=back
1751 1835

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines