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.216 by root, Tue Jun 5 21:29:51 2012 UTC vs.
Revision 1.230 by sf-exg, Mon Apr 28 16:00:34 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<-blr> I<HxV>
156
157Apply Gaussian Blur with the specified radii to the transparent
158background. If a single number is specified, the vertical and
159horizontal radii are considered to be the same. Setting one of the
160radii to 1 and the other to a large number creates interesting effects
161on some backgrounds. The maximum radius value is 128. An horizontal or
162vertical radius of 0 disables blurring;
163resource I<blurRadius>.
164
165=item B<-icon> I<file> 143=item B<-icon> I<file>
166 144
167Compile I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
168is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
169application window; resource I<iconFile>. 147application window; resource I<iconFile>.
173Window background colour; resource B<background>. 151Window background colour; resource B<background>.
174 152
175=item B<-fg> I<colour> 153=item B<-fg> I<colour>
176 154
177Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
178
179=item B<-pixmap> I<file[;oplist]>
180
181Compile I<pixbuf>: Specify image file for the background and also
182optionally specify a list of operations to modify it. Note you may need to
183add quotes to avoid special shell interpretation of the C<;> in the
184command-line; for more details see resource B<backgroundPixmap>.
185 156
186=item B<-cr> I<colour> 157=item B<-cr> I<colour>
187 158
188The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
189 160
678 649
679B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
680if 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
681monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
682 653
683=item B<transparent:> I<boolean>
684
685Turn on/off pseudo-transparency by using the root pixmap as background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
689
690=item B<fading:> I<number> 654=item B<fading:> I<number>
691 655
692Fade 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>.
693 657
694=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
695 659
696Fade 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
697colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
698 662
699=item B<tintColor:> I<colour>
700
701Tint the transparent background with the given colour. If the RENDER
702extension is not available only black, red, green, yellow, blue,
703magenta, cyan and white tints can be performed server-side. Note that
704a black tint yields a completely black image while a white tint yields
705the image unchanged; option B<-tint>.
706
707=item B<shading:> I<number>
708
709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
710A value of 100 means no shading; option B<-sh>.
711
712=item B<blurRadius:> I<number>
713
714Apply gaussian blur with the specified radius to the transparent
715background; option B<-blr>.
716
717=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
718 664
719Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
720 666
721=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
729 675
730=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
731 677
732The 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
733and the text. 679and the text.
734
735=item B<backgroundPixmap:> I<file[;oplist]>
736
737Use the specified image file for the background and also
738optionally specify a colon separated list of operations to modify it.
739Supported operations are:
740
741=over 4
742
743=item B<WxH+X+Y>
744
745sets scale and position. B<"W" / "H"> specify the horizontal/vertical
746scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
747scale of 0 disables scaling.
748
749=item B<op=tile>
750
751enables tiling
752
753=item B<op=keep-aspect>
754
755maintain the image aspect ratio when scaling
756
757=item B<op=root-align>
758
759use the position of the terminal window relative to the root window as
760the image offset, simulating a root window background
761
762=back
763
764The default scale and position setting is C<100x100+50+50>.
765Alternatively, a predefined set of templates can be used to achieve
766the most common setups:
767
768=over 4
769
770=item B<style=tiled>
771
772the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
773
774=item B<style=aspect-stretched>
775
776the image is scaled to fill the whole window maintaining the aspect
777ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
778
779=item B<style=stretched>
780
781the image is scaled to fill the whole window. Equivalent to 100x100
782
783=item B<style=centered>
784
785the image is centered with no scaling. Equivalent to 0x0+50+50
786
787=item B<style=root-tiled>
788
789the image is tiled with no scaling and using 'root' positioning.
790Equivalent to 0x0:op=tile:op=root-align
791
792=back
793
794If multiple templates are specified the last one wins. Note that a
795template overrides all the scale, position and operations settings.
796
797If used in conjunction with B<-tr> option, the specified pixmap will be
798blended over the transparent background using alpha-blending.
799
800=item B<path:> I<path>
801
802Specify the colon-delimited search path for finding background image files.
803 680
804=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
805 682
806Select 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
807that 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
1164Sets the working directory for the shell (or the command specified via 1041Sets the working directory for the shell (or the command specified via
1165B<-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
1166@@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
1167directory will be used; option B<-cd>. 1044directory will be used; option B<-cd>.
1168 1045
1169=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1170 1047
1171Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1172intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1173 1050
1174The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1175any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1176B<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
1177and 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
1178B<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>.
1179 1065
1180The 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
1181whatever 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
1182keys 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
1183current application keymap mode state. 1069current application keymap mode state.
1184 1070
1185The 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
1186searching 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
1187omitting 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
1188keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1189performed in an exact manner; however, the closest match is assured.
1190 1084
1191I<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
1192number), see RESOURCES in C<man 7 X> for further details. 1087number), see RESOURCES in C<man 7 X> for further details.
1193 1088
1089An action starts with an action prefix that selects a certain type
1090of action, followed by a colon. An action strings without colons is
1091interpreted as a literal string to pass to the tty (as if they were
1092prefixed with C<string:>).
1093
1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1096
1097=over 4
1098
1099=item string:STRING
1100
1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1102then the remaining C<STRING> will be passed to the program running in the
1103terminal. For example, you could replace whatever Shift-Tab outputs by the
1104string C<echo rm -rf /> followed by a newline:
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
1112If I<action> takes the form of C<command:STRING>, the specified B<STRING>
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
1118For example the following means "change the current locale to C<zh_CN.GBK>
1119when Control-Meta-c is being pressed":
1120
1121 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1122
1123The following example will map Control-Meta-1 and Control-Meta-2 to
1124the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1125font-switching at runtime:
1126
1127 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1128 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1129
1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1131info):
1132
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
1143For example if you overwrite the C<Insert> key you will disable
1144@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1146
1147 URxvt.keysym.Insert: <my insert key sequence>
1148 URxvt.keysym.S-Insert: builtin:
1149
1150The first line defines a mapping for C<Insert> and I<any> combination
1151of modifiers. The second line re-establishes the default mapping for
1152C<Shift-Insert>.
1153
1154=item builtin-string:
1155
1156This action is mainly useful to restore string mappings for keys that
1157have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1158difficult to explain - basically, this action will send the string to the
1159application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1160action for it.
1161
1162An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1163selection when you press C<Shift-Insert>. With the following bindings, it
1164would instead emit the (undocumented, but what applications running in the
1165terminal might expect) sequence C<ESC [ 2 $> instead:
1166
1167 URxvt.keysym.S-Insert: builtin-string:
1168 URxvt.keysym.C-S-Insert: builtin:
1169
1170The first line disables the paste functionality for that key
1171combination, and the second reinstates the default behaviour for
1172C<Control-Shift-Insert>, which would otherwise be overridden.
1173
1174Similarly, to let applications gain access to the C<C-M-c> (copy to
1175clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this:
1177
1178 URxvt.keysym.C-S-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string:
1180
1181=item EXTENSION:STRING
1182
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1184extension of the same name. The extension will be loaded automatically if
1185neccessary.
1186
1187Not all extensions define key actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively).
1191
1192From the silly examples department, this will rot13-"encrypt"
1193@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1194keyboards:
1195
1196 URxvt.keysym.M-C-c: selection:rot13
1197
1198=item perl:STRING
1199
1200This is a deprecated way of passing key mappings to perl extensions. It is
1201still supported, but should not be used anymore.
1202
1203=back
1204
1194You can define a range of keysyms in one shot by 1205In addition, you can define a range of keysyms in one shot by loading
1195loading the C<keysym-list> perl extension and providing a I<string> 1206the C<keysym-list> perl extension and providing a I<string> with pattern
1196with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1207B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1197should be a character not used by the strings. 1208character not used by the strings.
1198 1209
1199Its usage can be demonstrated by an example: 1210Its usage can be demonstrated by an example:
1200 1211
1201 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1212 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1202 1213
1203The above line is equivalent to the following three lines: 1214The above line is equivalent to the following three lines:
1204 1215
1205 URxvt.keysym.Meta-Control-0x61: \033<a> 1216 URxvt.keysym.Meta-Control-0x61: \033<a>
1206 URxvt.keysym.Meta-Control-0x62: \033<b> 1217 URxvt.keysym.Meta-Control-0x62: \033<b>
1207 URxvt.keysym.Meta-Control-0x63: \033<c> 1218 URxvt.keysym.Meta-Control-0x63: \033<c>
1208
1209If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1210is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1211example the following means "change the current locale to C<zh_CN.GBK>
1212when Control-Meta-c is being pressed":
1213
1214 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1215
1216If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1217is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1218manpage. For example, the F<selection> extension (activated via
1219C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1220
1221 URxvt.keysym.M-C-c: perl:selection:rot13
1222
1223Due the the large number of modifier combinations, a defined key mapping
1224will match if I<at least> the specified identifiers are being set, and
1225no other key mappings with those and more bits are being defined. That
1226means that defining a key map for C<a> will automatically provide
1227definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1228mappings themselves.
1229
1230Unfortunately, this will override built-in key mappings. For example
1231if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1232C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1233user-defined keymap using the C<builtin:> replacement:
1234
1235 URxvt.keysym.Insert: <my insert key sequence>
1236 URxvt.keysym.S-Insert: builtin:
1237
1238The first line defines a mapping for C<Insert> and I<any> combination
1239of modifiers. The second line re-establishes the default mapping for
1240C<Shift-Insert>.
1241
1242The following example will map Control-Meta-1 and Control-Meta-2 to
1243the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1244font-switching at runtime:
1245
1246 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1247 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1248
1249Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1250info):
1251
1252 URxvt.keysym.M-C-3: command:\033[8;25;80t
1253 URxvt.keysym.M-C-4: command:\033[8;48;110t
1254 1219
1255=item B<perl-ext-common>: I<string> 1220=item B<perl-ext-common>: I<string>
1256 1221
1257=item B<perl-ext>: I<string> 1222=item B<perl-ext>: I<string>
1258 1223
1286 1251
1287=item B<perl-lib>: I<path> 1252=item B<perl-lib>: I<path>
1288 1253
1289Colon-separated list of additional directories that hold extension 1254Colon-separated list of additional directories that hold extension
1290scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look 1255scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1291in these directories, then in C<$RXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and 1256in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1292lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1257lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1293 1258
1294See the @@RXVT_NAME@@perl(3) manpage. 1259See the @@RXVT_NAME@@perl(3) manpage.
1295 1260
1296=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1261=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1306=item B<searchable-scrollback:> I<keysym> 1271=item B<searchable-scrollback:> I<keysym>
1307 1272
1308Sets the hotkey that starts the incremental scrollback buffer search 1273Sets the hotkey that starts the incremental scrollback buffer search
1309(default: C<M-s>). 1274(default: C<M-s>).
1310 1275
1311=item B<urlLauncher>: I<string> 1276=item B<url-launcher>: I<string>
1312 1277
1313Specifies the program to be started with a URL argument. Used by the 1278Specifies the program to be started with a URL argument. Used by the
1314C<selection-popup> and C<matcher> perl extensions. 1279C<selection-popup> and C<matcher> perl extensions.
1315 1280
1316=item B<transient-for>: I<windowid> 1281=item B<transient-for>: I<windowid>
1327Turn on/off ISO 14755 (default enabled). 1292Turn on/off ISO 14755 (default enabled).
1328 1293
1329=item B<iso14755_52:> I<boolean> 1294=item B<iso14755_52:> I<boolean>
1330 1295
1331Turn on/off ISO 14755 5.2 mode (default enabled). 1296Turn on/off ISO 14755 5.2 mode (default enabled).
1297
1298=back
1299
1300=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1301
1302=over 4
1303
1304=item B<-pixmap> I<file[;oplist]>
1305
1306=item B<backgroundPixmap:> I<file[;oplist]>
1307
1308Compile I<pixbuf>: Use the specified image file as the window's
1309background and also optionally specify a colon separated list of
1310operations to modify it. Note that you may need to quote the C<;>
1311character when using the command line option, as C<;> is usually a
1312metacharacter in shells. Supported operations are:
1313
1314=over 4
1315
1316=item B<WxH+X+Y>
1317
1318sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1319scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1320scale of 0 disables scaling.
1321
1322=item B<op=tile>
1323
1324enables tiling
1325
1326=item B<op=keep-aspect>
1327
1328maintain the image aspect ratio when scaling
1329
1330=item B<op=root-align>
1331
1332use the position of the terminal window relative to the root window as
1333the image offset, simulating a root window background
1334
1335=back
1336
1337The default scale and position setting is C<100x100+50+50>.
1338Alternatively, a predefined set of templates can be used to achieve
1339the most common setups:
1340
1341=over 4
1342
1343=item B<style=tiled>
1344
1345the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1346
1347=item B<style=aspect-stretched>
1348
1349the image is scaled to fill the whole window maintaining the aspect
1350ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1351
1352=item B<style=stretched>
1353
1354the image is scaled to fill the whole window. Equivalent to 100x100
1355
1356=item B<style=centered>
1357
1358the image is centered with no scaling. Equivalent to 0x0+50+50
1359
1360=item B<style=root-tiled>
1361
1362the image is tiled with no scaling and using 'root' positioning.
1363Equivalent to 0x0:op=tile:op=root-align
1364
1365=back
1366
1367If multiple templates are specified the last one wins. Note that a
1368template overrides all the scale, position and operations settings.
1369
1370If used in conjunction with pseudo-transparency, the specified pixmap
1371will be blended over the transparent background using alpha-blending.
1372
1373=item B<-tr>|B<+tr>
1374
1375=item B<transparent:> I<boolean>
1376
1377Turn on/off pseudo-transparency by using the root pixmap as background.
1378
1379B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1380will be removed in future versions.
1381
1382=item B<-tint> I<colour>
1383
1384=item B<tintColor:> I<colour>
1385
1386Tint the transparent background with the given colour. Note that a
1387black tint yields a completely black image while a white tint yields
1388the image unchanged.
1389
1390=item B<-sh> I<number>
1391
1392=item B<shading:> I<number>
1393
1394Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1395A value of 100 means no shading.
1396
1397=item B<-blr> I<HxV>
1398
1399=item B<blurRadius:> I<HxV>
1400
1401Apply gaussian blur with the specified radius to the transparent
1402background. If a single number is specified, the vertical and
1403horizontal radii are considered to be the same. Setting one of the
1404radii to 1 and the other to a large number creates interesting effects
1405on some backgrounds. The maximum radius value is 128. An horizontal or
1406vertical radius of 0 disables blurring.
1407
1408=item B<path:> I<path>
1409
1410Specify the colon-delimited search path for finding background image files.
1332 1411
1333=back 1412=back
1334 1413
1335=head1 THE SCROLLBAR 1414=head1 THE SCROLLBAR
1336 1415
1384window causes the value of the PRIMARY selection (or CLIPBOARD with the 1463window causes the value of the PRIMARY selection (or CLIPBOARD with the
1385B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1464B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1386 1465
1387Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1466Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1388inserted too. 1467inserted too.
1468
1469rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1470<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1471binding causes the value of the internal selection to be copied to the
1472CLIPBOARD selection, while the second binding causes the value of the
1473CLIPBOARD selection to be inserted.
1389 1474
1390=back 1475=back
1391 1476
1392=head1 CHANGING FONTS 1477=head1 CHANGING FONTS
1393 1478
1518The following text gives values for the standard 88 colour mode (and 1603The following text gives values for the standard 88 colour mode (and
1519values for the 256 colour mode in parentheses). 1604values for the 256 colour mode in parentheses).
1520 1605
1521The RGB cube uses indices 16..79 (16..231) using the following formulas: 1606The RGB cube uses indices 16..79 (16..231) using the following formulas:
1522 1607
1523 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1608 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1524 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1609 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1525 1610
1526The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1611The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1527steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1612steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1528the RGB cube. 1613the RGB cube.
1529 1614
1637 1722
1638=item B<SHELL> 1723=item B<SHELL>
1639 1724
1640The shell to be used for command execution, defaults to C</bin/sh>. 1725The shell to be used for command execution, defaults to C</bin/sh>.
1641 1726
1642=item B<RXVT_SOCKET> (sic) 1727=item B<RXVT_SOCKET> [I<sic>]
1643 1728
1644The unix domain socket path used by @@RXVT_NAME@@c(1) and 1729The unix domain socket path used by @@RXVT_NAME@@c(1) and
1645@@RXVT_NAME@@d(1). 1730@@RXVT_NAME@@d(1).
1646 1731
1647Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. 1732Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1648 1733
1649=item B<RXVT_PERL_LIB> (sic) 1734=item B<URXVT_PERL_LIB>
1650 1735
1651Additional F<:>-separated library search path for perl extensions. Will be 1736Additional F<:>-separated library search path for perl extensions. Will be
1652searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library 1737searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1653directory. 1738directory.
1654 1739
1740=item B<URXVT_PERL_VERBOSITY>
1741
1742See L<@@RXVT_NAME@@perl>(3).
1743
1655=item B<HOME> 1744=item B<HOME>
1656 1745
1657Used to locate the default directory for the unix domain socket for 1746Used to locate the default directory for the unix domain socket for
1658daemon communications and to locate various resource files (such as 1747daemon communications and to locate various resource files (such as
1659C<.Xdefaults>) 1748C<.Xdefaults>)
1679 1768
1680=back 1769=back
1681 1770
1682=head1 SEE ALSO 1771=head1 SEE ALSO
1683 1772
1773@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1684@@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) 1774@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1685 1775
1686=head1 CURRENT PROJECT COORDINATOR 1776=head1 CURRENT PROJECT COORDINATOR
1687 1777
1688=over 4 1778=over 4
1689 1779
1690=item Project Coordinator 1780=item Project Coordinator
1691 1781
1692Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1782Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1693 1783
1694L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1784L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1695 1785
1696=back 1786=back
1697 1787
1701 1791
1702=item John Bovey 1792=item John Bovey
1703 1793
1704University of Kent, 1992, wrote the original Xvt. 1794University of Kent, 1992, wrote the original Xvt.
1705 1795
1706=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1796=item Rob Nation <nation@rocket.sanders.lockheed.com>
1707 1797
1708very heavily modified Xvt and came up with Rxvt 1798very heavily modified Xvt and came up with Rxvt
1709 1799
1710=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1800=item Angelo Haritsis <ah@doc.ic.ac.uk>
1711 1801
1712wrote the Greek Keyboard Input (no longer in code) 1802wrote the Greek Keyboard Input (no longer in code)
1713 1803
1714=item mj olesen L<< <olesen@me.QueensU.CA> >> 1804=item mj olesen <olesen@me.QueensU.CA>
1715 1805
1716Wrote the menu system. 1806Wrote the menu system.
1717 1807
1718Project Coordinator (changes.txt 2.11 to 2.21) 1808Project Coordinator (changes.txt 2.11 to 2.21)
1719 1809
1720=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1810=item Oezguer Kesim <kesim@math.fu-berlin.de>
1721 1811
1722Project Coordinator (changes.txt 2.21a to 2.4.5) 1812Project Coordinator (changes.txt 2.21a to 2.4.5)
1723 1813
1724=item Geoff Wing L<< <gcw@pobox.com> >> 1814=item Geoff Wing <gcw@pobox.com>
1725 1815
1726Rewrote screen display and text selection routines. 1816Rewrote screen display and text selection routines.
1727 1817
1728Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1818Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1729 1819
1730=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1820=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1731 1821
1732Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1822Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1733extension, random hacks, numerous bugfixes and extensions. 1823extension, random hacks, numerous bugfixes and extensions.
1734 1824
1735Project Coordinator (Changes 1.0 -) 1825Project Coordinator (Changes 1.0 -)
1736 1826
1737=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1827=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1738 1828
1739pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1829pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1740 1830
1741=back 1831=back
1742 1832

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines