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.220 by root, Fri Sep 21 23:31:43 2012 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 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
… …
340 306
341=item B<-override-redirect> 307=item B<-override-redirect>
342 308
343Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
344B<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.
345 316
346=item B<-sbg> 317=item B<-sbg>
347 318
348Compile 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
349drawing characters and just rely on what the specified fonts provide. Use 320drawing characters and just rely on what the specified fonts provide. Use
… …
683 654
684B<False>: specify that everything is to be displayed, even 655B<False>: specify that everything is to be displayed, even
685if 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
686monitor to display anything); option B<+ss>. 657monitor to display anything); option B<+ss>.
687 658
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> 659=item B<fading:> I<number>
696 660
697Fade 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>.
698 662
699=item B<fadeColor:> I<colour> 663=item B<fadeColor:> I<colour>
700 664
701Fade 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
702colour is black; option B<-fadecolor>. 666colour is black; option B<-fadecolor>.
703 667
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> 668=item B<iconFile:> I<file>
723 669
724Set the application icon pixmap; option B<-icon>. 670Set the application icon pixmap; option B<-icon>.
725 671
726=item B<scrollColor:> I<colour> 672=item B<scrollColor:> I<colour>
… …
734 680
735=item B<borderColor:> I<colour> 681=item B<borderColor:> I<colour>
736 682
737The 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
738and the text. 684and 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 685
809=item B<font:> I<fontlist> 686=item B<font:> I<fontlist>
810 687
811Select 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
812that 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
… …
1169Sets the working directory for the shell (or the command specified via 1046Sets 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 1047B<-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 1048@@RXVT_NAME@@ to start. If it isn't specified then the current working
1172directory will be used; option B<-cd>. 1049directory will be used; option B<-cd>.
1173 1050
1174=item B<keysym.>I<sym>: I<string> 1051=item B<keysym.>I<sym>: I<action>
1175 1052
1176Compile I<frills>: Associate I<string> with keysym I<sym>. The 1053Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1177intervening resource name B<keysym.> cannot be omitted. 1054resource name B<keysym.> cannot be omitted.
1178 1055
1179The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1056Using this resource, you can map key combinations such as
1180any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1057C<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>, 1058string 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>, 1059terminal scroll up or down the way you want it, or any other thing an
1183B<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>.
1184 1070
1185The 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
1186whatever 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
1187keys 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
1188current application keymap mode state. 1074current application keymap mode state.
1189 1075
1190The 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
1191searching 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
1192omitting 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
1193keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1088value (B<0x0000 - 0xFFFF>).
1194performed in an exact manner; however, the closest match is assured.
1195 1089
1196I<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
1197number), see RESOURCES in C<man 7 X> for further details. 1092number), see RESOURCES in C<man 7 X> for further details.
1198 1093
1199You can define a range of keysyms in one shot by 1094An action starts with an action prefix that selects a certain type
1200loading the C<keysym-list> perl extension and providing a I<string> 1095of action, followed by a colon. An action string without colons is
1201with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1096interpreted as a literal string to pass to the tty (as if it was
1202should be a character not used by the strings. 1097prefixed with C<string:>).
1203 1098
1204Its usage can be demonstrated by an example: 1099The following action prefixes are known - extensions can provide
1100additional prefixes:
1205 1101
1206 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1102=over 4
1207 1103
1208The above line is equivalent to the following three lines: 1104=item string:STRING
1209 1105
1210 URxvt.keysym.Meta-Control-0x61: \033<a> 1106If the I<action> starts with C<string:> (or otherwise contains no colons),
1211 URxvt.keysym.Meta-Control-0x62: \033<b> 1107then the remaining C<STRING> will be passed to the program running in the
1212 URxvt.keysym.Meta-Control-0x63: \033<c> 1108terminal. For example, you could replace whatever Shift-Tab outputs by the
1109string C<echo rm -rf /> followed by a newline:
1213 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
1214If 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>
1215is 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
1216example 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>
1217when Control-Meta-c is being pressed": 1124when Control-Meta-c is being pressed":
1218 1125
1219 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
1220 1127
1221If 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
1222is 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
1223manpage. For example, the F<selection> extension (activated via 1130font-switching at runtime:
1224C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1225 1131
1226 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
1227 1134
1228Due the the large number of modifier combinations, a defined key mapping 1135Other 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 1136info):
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 1137
1235Unfortunately, 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
1236if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1148For 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 1149@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1238user-defined keymap using the C<builtin:> replacement: 1150"holes" into the user-defined keymap using the C<builtin:> replacement:
1239 1151
1240 URxvt.keysym.Insert: <my insert key sequence> 1152 URxvt.keysym.Insert: <my insert key sequence>
1241 URxvt.keysym.S-Insert: builtin: 1153 URxvt.keysym.S-Insert: builtin:
1242 1154
1243The 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
1244of modifiers. The second line re-establishes the default mapping for 1156of modifiers. The second line re-establishes the default mapping for
1245C<Shift-Insert>. 1157C<Shift-Insert>.
1246 1158
1247The following example will map Control-Meta-1 and Control-Meta-2 to 1159=item builtin-string:
1248the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1249font-switching at runtime:
1250 1160
1251 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1161This action is mainly useful to restore string mappings for keys that
1252 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.
1253 1166
1254Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1167An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1255info): 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:
1256 1171
1257 URxvt.keysym.M-C-3: command:\033[8;25;80t 1172 URxvt.keysym.S-Insert: builtin-string:
1258 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
1259 1209
1260=item B<perl-ext-common>: I<string> 1210=item B<perl-ext-common>: I<string>
1261 1211
1262=item B<perl-ext>: I<string> 1212=item B<perl-ext>: I<string>
1263 1213
… …
1265use in this terminal instance; option B<-pe>. 1215use in this terminal instance; option B<-pe>.
1266 1216
1267Extension names can be prefixed with a C<-> sign to prohibit using 1217Extension names can be prefixed with a C<-> sign to prohibit using
1268them. This can be useful to selectively disable some extensions loaded 1218them. This can be useful to selectively disable some extensions loaded
1269by default, or specified via the C<perl-ext-common> resource. For 1219by default, or specified via the C<perl-ext-common> resource. For
1270example, C<default,-selection> will use all the default extension except 1220example, C<default,-selection> will use all the default extensions except
1271C<selection>. 1221C<selection>.
1272 1222
1273Extension names can also be followed by an argument in angle brackets 1223The default set includes the C<selection>, C<option-popup>,
1274(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1224C<selection-popup> and C<readline> extensions, any extensions that define
1275searchable scrollback to Alt/Meta-s). Mentioning the same extension 1225keybindings via C<BINDING> meta comments, extensions loaded because
1276multiple times with different arguments will pass multiple arguments to 1226their resources/commandline switches were used, and extensions which are
1277the extension. 1227mentioned in B<keysym> resources.
1278 1228
1279Each extension is looked up in the library directories, loaded if 1229Each extension is looked up in the library directories, loaded if
1280necessary, 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.
1281 1233
1282If both of these resources are the empty string, then the perl 1234If both of these resources are the empty string, then the perl interpreter
1283interpreter will not be initialized. The idea behind two options is that 1235will 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 1236B<perl-ext-common> will be used for extensions that should be available to
1285all instances, while B<perl-ext> is used for specific instances. 1237all instances, while B<perl-ext> is used for specific instances.
1286 1238
1287=item B<perl-eval>: I<string> 1239=item B<perl-eval>: I<string>
1288 1240
… …
1306=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1258=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1307 1259
1308Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1260Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1309for details. 1261for details.
1310 1262
1311=item B<searchable-scrollback:> I<keysym> 1263=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1312 1264
1313Sets the hotkey that starts the incremental scrollback buffer search 1265This resource is deprecated and will be removed. Use a B<keysym> resource
1314(default: C<M-s>). 1266instead, e.g.:
1315 1267
1268 URxvt.keysym.M-s: searchable-scrollback:start
1269
1316=item B<urlLauncher>: I<string> 1270=item B<url-launcher>: I<string>
1317 1271
1318Specifies 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
1319C<selection-popup> and C<matcher> perl extensions. 1273C<selection-popup> and C<matcher> perl extensions.
1320 1274
1321=item B<transient-for>: I<windowid> 1275=item B<transient-for>: I<windowid>
… …
1332Turn on/off ISO 14755 (default enabled). 1286Turn on/off ISO 14755 (default enabled).
1333 1287
1334=item B<iso14755_52:> I<boolean> 1288=item B<iso14755_52:> I<boolean>
1335 1289
1336Turn 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.
1337 1405
1338=back 1406=back
1339 1407
1340=head1 THE SCROLLBAR 1408=head1 THE SCROLLBAR
1341 1409
… …
1389window causes the value of the PRIMARY selection (or CLIPBOARD with the 1457window 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. 1458B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1391 1459
1392Pressing 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
1393inserted 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.
1394 1468
1395=back 1469=back
1396 1470
1397=head1 CHANGING FONTS 1471=head1 CHANGING FONTS
1398 1472
… …
1523The following text gives values for the standard 88 colour mode (and 1597The following text gives values for the standard 88 colour mode (and
1524values for the 256 colour mode in parentheses). 1598values for the 256 colour mode in parentheses).
1525 1599
1526The 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:
1527 1601
1528 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
1529 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
1530 1604
1531The 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%
1532steps (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
1533the RGB cube. 1607the RGB cube.
1534 1608
… …
1697 1771
1698=over 4 1772=over 4
1699 1773
1700=item Project Coordinator 1774=item Project Coordinator
1701 1775
1702Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1776Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1703 1777
1704L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1778L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1705 1779
1706=back 1780=back
1707 1781
… …
1711 1785
1712=item John Bovey 1786=item John Bovey
1713 1787
1714University of Kent, 1992, wrote the original Xvt. 1788University of Kent, 1992, wrote the original Xvt.
1715 1789
1716=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1790=item Rob Nation <nation@rocket.sanders.lockheed.com>
1717 1791
1718very heavily modified Xvt and came up with Rxvt 1792very heavily modified Xvt and came up with Rxvt
1719 1793
1720=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1794=item Angelo Haritsis <ah@doc.ic.ac.uk>
1721 1795
1722wrote the Greek Keyboard Input (no longer in code) 1796wrote the Greek Keyboard Input (no longer in code)
1723 1797
1724=item mj olesen L<< <olesen@me.QueensU.CA> >> 1798=item mj olesen <olesen@me.QueensU.CA>
1725 1799
1726Wrote the menu system. 1800Wrote the menu system.
1727 1801
1728Project Coordinator (changes.txt 2.11 to 2.21) 1802Project Coordinator (changes.txt 2.11 to 2.21)
1729 1803
1730=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1804=item Oezguer Kesim <kesim@math.fu-berlin.de>
1731 1805
1732Project Coordinator (changes.txt 2.21a to 2.4.5) 1806Project Coordinator (changes.txt 2.21a to 2.4.5)
1733 1807
1734=item Geoff Wing L<< <gcw@pobox.com> >> 1808=item Geoff Wing <gcw@pobox.com>
1735 1809
1736Rewrote screen display and text selection routines. 1810Rewrote screen display and text selection routines.
1737 1811
1738Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1812Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1739 1813
1740=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1814=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1741 1815
1742Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1816Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1743extension, random hacks, numerous bugfixes and extensions. 1817extension, random hacks, numerous bugfixes and extensions.
1744 1818
1745Project Coordinator (Changes 1.0 -) 1819Project Coordinator (Changes 1.0 -)
1746 1820
1747=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1821=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1748 1822
1749pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1823pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1750 1824
1751=back 1825=back
1752 1826

Diff Legend

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