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.211 by sf-exg, Sat Dec 31 17:17:12 2011 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<-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, the vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and the other to a large number creates interesting effects
171on some backgrounds. The 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[;oplist]>
189
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191optionally specify a list of operations to modify it. 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[;oplist]>
749
750Use the specified image file for the background and also
751optionally specify a colon separated list of operations to modify it.
752Supported operations are:
753
754=over 4
755
756=item B<WxH+X+Y>
757
758sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
760scale of 0 disables scaling. The maximum permitted scale is 1000.
761
762=item B<op=tile>
763
764enables tiling
765
766=item B<op=keep-aspect>
767
768maintain the image aspect ratio when scaling
769
770=item B<op=root-align>
771
772use the position of the terminal window relative to the root window as
773the image offset, simulating a root window background
774
775=back
776
777The default scale and position setting is C<100x100+50+50>.
778Alternatively, a predefined set of templates can be used to achieve
779the most common setups:
780
781=over 4
782
783=item B<style=tiled>
784
785the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786
787=item B<style=aspect-stretched>
788
789the image is scaled to fill the whole window maintaining the aspect
790ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
791
792=item B<style=stretched>
793
794the image is scaled to fill the whole window. Equivalent to 100x100
795
796=item B<style=centered>
797
798the image is centered with no scaling. Equivalent to 0x0+50+50
799
800=item B<style=root-tiled>
801
802the image is tiled with no scaling and using 'root' positioning.
803Equivalent to 0x0:op=tile:op=root-align
804
805=back
806
807If multiple templates are specified the last one wins. Note that a
808template overrides all the scale, position and operations settings.
809
810If used in conjunction with B<-tr> option, the specified pixmap will be
811blended over the transparent background using alpha-blending. If I<afterimage>
812support has been compiled in it is possible to choose other blending
813types with B<-blt "type"> option.
814
815=item B<path:> I<path>
816
817Specify the colon-delimited search path for finding background image files.
818 680
819=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
820 682
821Select 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
822that 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
1179Sets the working directory for the shell (or the command specified via 1041Sets the working directory for the shell (or the command specified via
1180B<-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
1181@@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
1182directory will be used; option B<-cd>. 1044directory will be used; option B<-cd>.
1183 1045
1184=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1185 1047
1186Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1187intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1188 1050
1189The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1190any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1191B<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
1192and 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
1193B<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>.
1194 1065
1195The 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
1196whatever 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
1197keys 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
1198current application keymap mode state. 1069current application keymap mode state.
1199 1070
1200The 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
1201searching 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
1202omitting 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
1203keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1204performed in an exact manner; however, the closest match is assured.
1205 1084
1206I<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
1207number), see RESOURCES in C<man 7 X> for further details. 1087number), see RESOURCES in C<man 7 X> for further details.
1208 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
1209You can define a range of keysyms in one shot by 1205In addition, you can define a range of keysyms in one shot by loading
1210loading the C<keysym-list> perl extension and providing a I<string> 1206the C<keysym-list> perl extension and providing a I<string> with pattern
1211with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1207B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1212should be a character not used by the strings. 1208character not used by the strings.
1213 1209
1214Its usage can be demonstrated by an example: 1210Its usage can be demonstrated by an example:
1215 1211
1216 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1212 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1217 1213
1218The above line is equivalent to the following three lines: 1214The above line is equivalent to the following three lines:
1219 1215
1220 URxvt.keysym.Meta-Control-0x61: \033<a> 1216 URxvt.keysym.Meta-Control-0x61: \033<a>
1221 URxvt.keysym.Meta-Control-0x62: \033<b> 1217 URxvt.keysym.Meta-Control-0x62: \033<b>
1222 URxvt.keysym.Meta-Control-0x63: \033<c> 1218 URxvt.keysym.Meta-Control-0x63: \033<c>
1223
1224If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1225is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1226example the following means "change the current locale to C<zh_CN.GBK>
1227when Control-Meta-c is being pressed":
1228
1229 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1230
1231If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1232is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1233manpage. For example, the F<selection> extension (activated via
1234C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1235
1236 URxvt.keysym.M-C-c: perl:selection:rot13
1237
1238Due the the large number of modifier combinations, a defined key mapping
1239will match if I<at least> the specified identifiers are being set, and
1240no other key mappings with those and more bits are being defined. That
1241means that defining a key map for C<a> will automatically provide
1242definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1243mappings themselves.
1244
1245Unfortunately, this will override built-in key mappings. For example
1246if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1247C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1248user-defined keymap using the C<builtin:> replacement:
1249
1250 URxvt.keysym.Insert: <my insert key sequence>
1251 URxvt.keysym.S-Insert: builtin:
1252
1253The first line defines a mapping for C<Insert> and I<any> combination
1254of modifiers. The second line re-establishes the default mapping for
1255C<Shift-Insert>.
1256
1257The following example will map Control-Meta-1 and Control-Meta-2 to
1258the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1259font-switching at runtime:
1260
1261 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1262 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1263
1264Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1265info):
1266
1267 URxvt.keysym.M-C-3: command:\033[8;25;80t
1268 URxvt.keysym.M-C-4: command:\033[8;48;110t
1269 1219
1270=item B<perl-ext-common>: I<string> 1220=item B<perl-ext-common>: I<string>
1271 1221
1272=item B<perl-ext>: I<string> 1222=item B<perl-ext>: I<string>
1273 1223
1300the @@RXVT_NAME@@perl(3) manpage. 1250the @@RXVT_NAME@@perl(3) manpage.
1301 1251
1302=item B<perl-lib>: I<path> 1252=item B<perl-lib>: I<path>
1303 1253
1304Colon-separated list of additional directories that hold extension 1254Colon-separated list of additional directories that hold extension
1305scripts. When looking for perl extensions, @@RXVT_NAME@@ will first 1255scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1306look in these directories, then in $HOME/.urxvt/ext and lastly in 1256in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1307F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1257lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1308 1258
1309See the @@RXVT_NAME@@perl(3) manpage. 1259See the @@RXVT_NAME@@perl(3) manpage.
1310 1260
1311=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1261=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1312 1262
1321=item B<searchable-scrollback:> I<keysym> 1271=item B<searchable-scrollback:> I<keysym>
1322 1272
1323Sets the hotkey that starts the incremental scrollback buffer search 1273Sets the hotkey that starts the incremental scrollback buffer search
1324(default: C<M-s>). 1274(default: C<M-s>).
1325 1275
1326=item B<urlLauncher>: I<string> 1276=item B<url-launcher>: I<string>
1327 1277
1328Specifies 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
1329C<selection-popup> and C<matcher> perl extensions. 1279C<selection-popup> and C<matcher> perl extensions.
1330 1280
1331=item B<transient-for>: I<windowid> 1281=item B<transient-for>: I<windowid>
1342Turn on/off ISO 14755 (default enabled). 1292Turn on/off ISO 14755 (default enabled).
1343 1293
1344=item B<iso14755_52:> I<boolean> 1294=item B<iso14755_52:> I<boolean>
1345 1295
1346Turn 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.
1347 1411
1348=back 1412=back
1349 1413
1350=head1 THE SCROLLBAR 1414=head1 THE SCROLLBAR
1351 1415
1399window causes the value of the PRIMARY selection (or CLIPBOARD with the 1463window causes the value of the PRIMARY selection (or CLIPBOARD with the
1400B<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.
1401 1465
1402Pressing 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
1403inserted 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.
1404 1474
1405=back 1475=back
1406 1476
1407=head1 CHANGING FONTS 1477=head1 CHANGING FONTS
1408 1478
1533The following text gives values for the standard 88 colour mode (and 1603The following text gives values for the standard 88 colour mode (and
1534values for the 256 colour mode in parentheses). 1604values for the 256 colour mode in parentheses).
1535 1605
1536The 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:
1537 1607
1538 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
1539 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
1540 1610
1541The 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%
1542steps (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
1543the RGB cube. 1613the RGB cube.
1544 1614
1652 1722
1653=item B<SHELL> 1723=item B<SHELL>
1654 1724
1655The 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>.
1656 1726
1657=item B<RXVT_SOCKET> 1727=item B<RXVT_SOCKET> [I<sic>]
1658 1728
1659The unix domain socket path used by @@RXVT_NAME@@c(1) and 1729The unix domain socket path used by @@RXVT_NAME@@c(1) and
1660@@RXVT_NAME@@d(1). 1730@@RXVT_NAME@@d(1).
1661 1731
1662Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. 1732Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1733
1734=item B<URXVT_PERL_LIB>
1735
1736Additional F<:>-separated library search path for perl extensions. Will be
1737searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1738directory.
1739
1740=item B<URXVT_PERL_VERBOSITY>
1741
1742See L<@@RXVT_NAME@@perl>(3).
1663 1743
1664=item B<HOME> 1744=item B<HOME>
1665 1745
1666Used to locate the default directory for the unix domain socket for 1746Used to locate the default directory for the unix domain socket for
1667daemon communications and to locate various resource files (such as 1747daemon communications and to locate various resource files (such as
1688 1768
1689=back 1769=back
1690 1770
1691=head1 SEE ALSO 1771=head1 SEE ALSO
1692 1772
1773@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1693@@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)
1694 1775
1695=head1 CURRENT PROJECT COORDINATOR 1776=head1 CURRENT PROJECT COORDINATOR
1696 1777
1697=over 4 1778=over 4
1698 1779
1699=item Project Coordinator 1780=item Project Coordinator
1700 1781
1701Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1782Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1702 1783
1703L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1784L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1704 1785
1705=back 1786=back
1706 1787
1710 1791
1711=item John Bovey 1792=item John Bovey
1712 1793
1713University of Kent, 1992, wrote the original Xvt. 1794University of Kent, 1992, wrote the original Xvt.
1714 1795
1715=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1796=item Rob Nation <nation@rocket.sanders.lockheed.com>
1716 1797
1717very heavily modified Xvt and came up with Rxvt 1798very heavily modified Xvt and came up with Rxvt
1718 1799
1719=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1800=item Angelo Haritsis <ah@doc.ic.ac.uk>
1720 1801
1721wrote the Greek Keyboard Input (no longer in code) 1802wrote the Greek Keyboard Input (no longer in code)
1722 1803
1723=item mj olesen L<< <olesen@me.QueensU.CA> >> 1804=item mj olesen <olesen@me.QueensU.CA>
1724 1805
1725Wrote the menu system. 1806Wrote the menu system.
1726 1807
1727Project Coordinator (changes.txt 2.11 to 2.21) 1808Project Coordinator (changes.txt 2.11 to 2.21)
1728 1809
1729=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1810=item Oezguer Kesim <kesim@math.fu-berlin.de>
1730 1811
1731Project Coordinator (changes.txt 2.21a to 2.4.5) 1812Project Coordinator (changes.txt 2.21a to 2.4.5)
1732 1813
1733=item Geoff Wing L<< <gcw@pobox.com> >> 1814=item Geoff Wing <gcw@pobox.com>
1734 1815
1735Rewrote screen display and text selection routines. 1816Rewrote screen display and text selection routines.
1736 1817
1737Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1818Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1738 1819
1739=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1820=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1740 1821
1741Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1822Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1742extension, random hacks, numerous bugfixes and extensions. 1823extension, random hacks, numerous bugfixes and extensions.
1743 1824
1744Project Coordinator (Changes 1.0 -) 1825Project Coordinator (Changes 1.0 -)
1745 1826
1746=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1827=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1747 1828
1748pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1829pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1749 1830
1750=back 1831=back
1751 1832

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines