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.194 by sf-exg, Wed Mar 9 13:24:30 2011 UTC vs.
Revision 1.228 by root, Sun Apr 27 19:43:46 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
687 649
688B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the 651if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
691 653
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> 654=item B<fading:> I<number>
700 655
701Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
702 657
703=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
704 659
705Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
706colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
707 662
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> 663=item B<iconFile:> I<file>
731 664
732Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
733 666
734=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
742 675
743=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
744 677
745The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
746and the text. 679and 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 680
777=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
778 682
779Select the fonts to be used. This is a comma separated list of font names 683Select 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 684that are checked in order when trying to find glyphs for characters. The
935B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
936B<+si>. 840B<+si>.
937 841
938=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
939 843
940B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
941B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
942with scrollback buffer when tty receives new lines; option B<+sw>. 846B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
847new lines; option B<+sw>.
943 848
944=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
945 850
946B<True>: scroll to bottom when a non-special key is pressed. Special keys 851B<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 852are those which are intercepted by rxvt-unicode for special handling and
1136Sets the working directory for the shell (or the command specified via 1041Sets 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 1042B<-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 1043@@RXVT_NAME@@ to start. If it isn't specified then the current working
1139directory will be used; option B<-cd>. 1044directory will be used; option B<-cd>.
1140 1045
1141=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1142 1047
1143Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1144intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1145 1050
1146The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1147any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<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>, 1053string 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>, 1054terminal scroll up or down the way you want it, or any other thing an
1150B<2>, B<3>, B<4>, B<5>. 1055extension might provide.
1056
1057The key combination that triggers the action, I<sym>, has the following format:
1058
1059 (modifiers-)key
1060
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1062B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1064B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1151 1065
1152The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1066The 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 1067whatever 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 1068keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1155current application keymap mode state. 1069current application keymap mode state.
1156 1070
1157The spellings of I<key> can be obtained by using B<xev>(1) command or 1071Due the the large number of modifier combinations, a key mapping will
1158searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1072match if I<at least> the specified identifiers are being set, and no other
1073key mappings with those and more bits are being defined. That means that
1074defining a mapping for C<a> will automatically provide definitions for
1075C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1076themselves. See the C<builtin:> action, below, for a way to work around
1077this when this is a problem.
1078
1079The spelling of I<key> depends on your implementation of X. An easy way to
1080find a key name is to use the B<xev>(1) command. You can find a list by
1081looking 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 1082the 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 1083value (B<0x0000 - 0xFFFF>).
1161performed in an exact manner; however, the closest match is assured.
1162 1084
1163I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1085As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1164number), see RESOURCES in C<man 7 X> for further details. 1087number), see RESOURCES in C<man 7 X> for further details.
1165 1088
1166You can define a range of keysyms in one shot by providing a I<string> 1089An action starts with an action prefix that selects a certain type
1167with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1090of action, followed by a colon. An action strings without colons is
1168should be a character not used by the strings. 1091interpreted as a literal string to pass to the tty (as if they were
1092prefixed with C<string:>).
1169 1093
1170Its usage can be demonstrated by an example: 1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1171 1096
1172 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1097=over 4
1173 1098
1174The above line is equivalent to the following three lines: 1099=item string:STRING
1175 1100
1176 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1177 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1102then the remaining C<STRING> will be passed to the program running in the
1178 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1103terminal. For example, you could replace whatever Shift-Tab outputs by the
1104string C<echo rm -rf /> followed by a newline:
1179 1105
1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107
1108This could in theory be used to completely redefine your keymap.
1109
1110=item command:STRING
1111
1180If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1112If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1181is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1114the opposite of C<string:> - instead of sending it to the program running
1115in the terminal, it will be treated as if it were program output). This is
1116most useful to feed command sequences into @@RXVT_NAME@@.
1117
1182example the following means "change the current locale to C<zh_CN.GBK> 1118For example the following means "change the current locale to C<zh_CN.GBK>
1183when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1184 1120
1185 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1121 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1186 1122
1187If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1123The following example will map Control-Meta-1 and Control-Meta-2 to
1188is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1124the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1189manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1190C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1191 1126
1192 URxvt.keysym.M-C-c: perl:selection:rot13 1127 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1128 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1193 1129
1194Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1195will match if I<at least> the specified identifiers are being set, and 1131info):
1196no other key mappings with those and more bits are being defined. That
1197means that defining a key map for C<a> will automatically provide
1198definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1199mappings themselves.
1200 1132
1201Unfortunately, this will override built-in key mappings. For example 1133 URxvt.keysym.M-C-3: command:\033[8;25;80t
1134 URxvt.keysym.M-C-4: command:\033[8;48;110t
1135
1136=item builtin:
1137
1138The builtin action is the action that @@RXVT_NAME@@ would execute if no
1139key binding existed for the key combination. The obvious use is to undo
1140the effect of existing bindings. The not so obvious use is to reinstate
1141bindings when another binding overrides too many modifiers.
1142
1202if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1203C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1144@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1204user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1205 1146
1206 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1207 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1208 1149
1209The first line defines a mapping for C<Insert> and I<any> combination 1150The first line defines a mapping for C<Insert> and I<any> combination
1210of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1211C<Shift-Insert>. 1152C<Shift-Insert>.
1212 1153
1213The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item EXTENSION:STRING
1214the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1215font-switching at runtime:
1216 1155
1217 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1156An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1218 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1157extension of the same name. The extension will be loaded automatically if
1158neccessary.
1219 1159
1220Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1160Not all extensions define key actions, but popular extensions that do
1221info): 1161include the I<selection> and I<matcher> extensions (documented in their
1162own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1163respectively).
1222 1164
1223 URxvt.keysym.M-C-3: command:\033[8;25;80t 1165From the silly examples department, this will rot13-"encrypt"
1224 URxvt.keysym.M-C-4: command:\033[8;48;110t 1166@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1167keyboards:
1168
1169 URxvt.keysym.M-C-c: selection:rot13
1170
1171=item perl:STRING
1172
1173This is a deprecated way of passing key mappings to perl extensions. It is
1174still supported, but should not be used anymore.
1175
1176=back
1177
1178In addition, you can define a range of keysyms in one shot by loading
1179the C<keysym-list> perl extension and providing a I<string> with pattern
1180B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1181character not used by the strings.
1182
1183Its usage can be demonstrated by an example:
1184
1185 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1186
1187The above line is equivalent to the following three lines:
1188
1189 URxvt.keysym.Meta-Control-0x61: \033<a>
1190 URxvt.keysym.Meta-Control-0x62: \033<b>
1191 URxvt.keysym.Meta-Control-0x63: \033<c>
1225 1192
1226=item B<perl-ext-common>: I<string> 1193=item B<perl-ext-common>: I<string>
1227 1194
1228=item B<perl-ext>: I<string> 1195=item B<perl-ext>: I<string>
1229 1196
1256the @@RXVT_NAME@@perl(3) manpage. 1223the @@RXVT_NAME@@perl(3) manpage.
1257 1224
1258=item B<perl-lib>: I<path> 1225=item B<perl-lib>: I<path>
1259 1226
1260Colon-separated list of additional directories that hold extension 1227Colon-separated list of additional directories that hold extension
1261scripts. When looking for extensions specified by the C<perl> resource, 1228scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1262@@RXVT_NAME@@ will first look in these directories and then in 1229in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1263F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1230lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1264 1231
1265See the @@RXVT_NAME@@perl(3) manpage. 1232See the @@RXVT_NAME@@perl(3) manpage.
1266 1233
1267=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1234=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1268 1235
1277=item B<searchable-scrollback:> I<keysym> 1244=item B<searchable-scrollback:> I<keysym>
1278 1245
1279Sets the hotkey that starts the incremental scrollback buffer search 1246Sets the hotkey that starts the incremental scrollback buffer search
1280(default: C<M-s>). 1247(default: C<M-s>).
1281 1248
1282=item B<urlLauncher>: I<string> 1249=item B<url-launcher>: I<string>
1283 1250
1284Specifies the program to be started with a URL argument. Used by the 1251Specifies the program to be started with a URL argument. Used by the
1285C<selection-popup> and C<matcher> perl extensions. 1252C<selection-popup> and C<matcher> perl extensions.
1286 1253
1287=item B<transient-for>: I<windowid> 1254=item B<transient-for>: I<windowid>
1298Turn on/off ISO 14755 (default enabled). 1265Turn on/off ISO 14755 (default enabled).
1299 1266
1300=item B<iso14755_52:> I<boolean> 1267=item B<iso14755_52:> I<boolean>
1301 1268
1302Turn on/off ISO 14755 5.2 mode (default enabled). 1269Turn on/off ISO 14755 5.2 mode (default enabled).
1270
1271=back
1272
1273=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1274
1275=over 4
1276
1277=item B<-pixmap> I<file[;oplist]>
1278
1279=item B<backgroundPixmap:> I<file[;oplist]>
1280
1281Compile I<pixbuf>: Use the specified image file as the window's
1282background and also optionally specify a colon separated list of
1283operations to modify it. Note that you may need to quote the C<;>
1284character when using the command line option, as C<;> is usually a
1285metacharacter in shells. Supported operations are:
1286
1287=over 4
1288
1289=item B<WxH+X+Y>
1290
1291sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1292scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1293scale of 0 disables scaling.
1294
1295=item B<op=tile>
1296
1297enables tiling
1298
1299=item B<op=keep-aspect>
1300
1301maintain the image aspect ratio when scaling
1302
1303=item B<op=root-align>
1304
1305use the position of the terminal window relative to the root window as
1306the image offset, simulating a root window background
1307
1308=back
1309
1310The default scale and position setting is C<100x100+50+50>.
1311Alternatively, a predefined set of templates can be used to achieve
1312the most common setups:
1313
1314=over 4
1315
1316=item B<style=tiled>
1317
1318the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1319
1320=item B<style=aspect-stretched>
1321
1322the image is scaled to fill the whole window maintaining the aspect
1323ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1324
1325=item B<style=stretched>
1326
1327the image is scaled to fill the whole window. Equivalent to 100x100
1328
1329=item B<style=centered>
1330
1331the image is centered with no scaling. Equivalent to 0x0+50+50
1332
1333=item B<style=root-tiled>
1334
1335the image is tiled with no scaling and using 'root' positioning.
1336Equivalent to 0x0:op=tile:op=root-align
1337
1338=back
1339
1340If multiple templates are specified the last one wins. Note that a
1341template overrides all the scale, position and operations settings.
1342
1343If used in conjunction with pseudo-transparency, the specified pixmap
1344will be blended over the transparent background using alpha-blending.
1345
1346=item B<-tr>|B<+tr>
1347
1348=item B<transparent:> I<boolean>
1349
1350Turn on/off pseudo-transparency by using the root pixmap as background.
1351
1352B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1353will be removed in future versions.
1354
1355=item B<-tint> I<colour>
1356
1357=item B<tintColor:> I<colour>
1358
1359Tint the transparent background with the given colour. Note that a
1360black tint yields a completely black image while a white tint yields
1361the image unchanged.
1362
1363=item B<-sh> I<number>
1364
1365=item B<shading:> I<number>
1366
1367Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1368A value of 100 means no shading.
1369
1370=item B<-blr> I<HxV>
1371
1372=item B<blurRadius:> I<HxV>
1373
1374Apply gaussian blur with the specified radius to the transparent
1375background. If a single number is specified, the vertical and
1376horizontal radii are considered to be the same. Setting one of the
1377radii to 1 and the other to a large number creates interesting effects
1378on some backgrounds. The maximum radius value is 128. An horizontal or
1379vertical radius of 0 disables blurring.
1380
1381=item B<path:> I<path>
1382
1383Specify the colon-delimited search path for finding background image files.
1303 1384
1304=back 1385=back
1305 1386
1306=head1 THE SCROLLBAR 1387=head1 THE SCROLLBAR
1307 1388
1355window causes the value of the PRIMARY selection (or CLIPBOARD with the 1436window causes the value of the PRIMARY selection (or CLIPBOARD with the
1356B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1437B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1357 1438
1358Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1439Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1359inserted too. 1440inserted too.
1441
1442rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1443<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1444binding causes the value of the internal selection to be copied to the
1445CLIPBOARD selection, while the second binding causes the value of the
1446CLIPBOARD selection to be inserted.
1360 1447
1361=back 1448=back
1362 1449
1363=head1 CHANGING FONTS 1450=head1 CHANGING FONTS
1364 1451
1489The following text gives values for the standard 88 colour mode (and 1576The following text gives values for the standard 88 colour mode (and
1490values for the 256 colour mode in parentheses). 1577values for the 256 colour mode in parentheses).
1491 1578
1492The RGB cube uses indices 16..79 (16..231) using the following formulas: 1579The RGB cube uses indices 16..79 (16..231) using the following formulas:
1493 1580
1494 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1581 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1495 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1582 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1496 1583
1497The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1584The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1498steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1585steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1499the RGB cube. 1586the RGB cube.
1500 1587
1516White. 1603White.
1517 1604
1518=head2 ALPHA CHANNEL SUPPORT 1605=head2 ALPHA CHANNEL SUPPORT
1519 1606
1520If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1607If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1521their act together, rxvt-unicode will do it's own alpha channel management: 1608their act together, rxvt-unicode will do its own alpha channel management:
1522 1609
1523You can prefix any colour with an opaqueness percentage enclosed in 1610You can prefix any colour with an opaqueness percentage enclosed in
1524brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1611brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1525(0-100) that specifies the opacity of the colour, where C<0> is completely 1612(0-100) that specifies the opacity of the colour, where C<0> is completely
1526transparent and C<100> is completely opaque. For example, C<[50]red> is a 1613transparent and C<100> is completely opaque. For example, C<[50]red> is a
1608 1695
1609=item B<SHELL> 1696=item B<SHELL>
1610 1697
1611The shell to be used for command execution, defaults to C</bin/sh>. 1698The shell to be used for command execution, defaults to C</bin/sh>.
1612 1699
1613=item B<RXVT_SOCKET> 1700=item B<RXVT_SOCKET> [I<sic>]
1614 1701
1615The unix domain socket path used by @@RXVT_NAME@@c(1) and 1702The unix domain socket path used by @@RXVT_NAME@@c(1) and
1616@@RXVT_NAME@@d(1). 1703@@RXVT_NAME@@d(1).
1617 1704
1618Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1705Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1706
1707=item B<URXVT_PERL_LIB>
1708
1709Additional F<:>-separated library search path for perl extensions. Will be
1710searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1711directory.
1712
1713=item B<URXVT_PERL_VERBOSITY>
1714
1715See L<@@RXVT_NAME@@perl>(3).
1619 1716
1620=item B<HOME> 1717=item B<HOME>
1621 1718
1622Used to locate the default directory for the unix domain socket for 1719Used to locate the default directory for the unix domain socket for
1623daemon communications and to locate various resource files (such as 1720daemon communications and to locate various resource files (such as
1644 1741
1645=back 1742=back
1646 1743
1647=head1 SEE ALSO 1744=head1 SEE ALSO
1648 1745
1746@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1649@@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) 1747@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1650 1748
1651=head1 CURRENT PROJECT COORDINATOR 1749=head1 CURRENT PROJECT COORDINATOR
1652 1750
1653=over 4 1751=over 4
1654 1752
1655=item Project Coordinator 1753=item Project Coordinator
1656 1754
1657Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1755Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1658 1756
1659L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1757L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1660 1758
1661=back 1759=back
1662 1760
1666 1764
1667=item John Bovey 1765=item John Bovey
1668 1766
1669University of Kent, 1992, wrote the original Xvt. 1767University of Kent, 1992, wrote the original Xvt.
1670 1768
1671=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1769=item Rob Nation <nation@rocket.sanders.lockheed.com>
1672 1770
1673very heavily modified Xvt and came up with Rxvt 1771very heavily modified Xvt and came up with Rxvt
1674 1772
1675=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1773=item Angelo Haritsis <ah@doc.ic.ac.uk>
1676 1774
1677wrote the Greek Keyboard Input (no longer in code) 1775wrote the Greek Keyboard Input (no longer in code)
1678 1776
1679=item mj olesen L<< <olesen@me.QueensU.CA> >> 1777=item mj olesen <olesen@me.QueensU.CA>
1680 1778
1681Wrote the menu system. 1779Wrote the menu system.
1682 1780
1683Project Coordinator (changes.txt 2.11 to 2.21) 1781Project Coordinator (changes.txt 2.11 to 2.21)
1684 1782
1685=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1783=item Oezguer Kesim <kesim@math.fu-berlin.de>
1686 1784
1687Project Coordinator (changes.txt 2.21a to 2.4.5) 1785Project Coordinator (changes.txt 2.21a to 2.4.5)
1688 1786
1689=item Geoff Wing L<< <gcw@pobox.com> >> 1787=item Geoff Wing <gcw@pobox.com>
1690 1788
1691Rewrote screen display and text selection routines. 1789Rewrote screen display and text selection routines.
1692 1790
1693Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1791Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1694 1792
1695=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1793=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1696 1794
1697Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1795Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1698extension, random hacks, numerous bugfixes and extensions. 1796extension, random hacks, numerous bugfixes and extensions.
1699 1797
1700Project Coordinator (Changes 1.0 -) 1798Project Coordinator (Changes 1.0 -)
1701 1799
1702=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1800=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1703 1801
1704pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1802pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1705 1803
1706=back 1804=back
1707 1805

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines