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.181 by sf-exg, Tue Jun 15 13:05:39 2010 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 illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 131
137=item B<-fade> I<number> 132=item B<-fade> I<number>
138 133
139Fade 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
140fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
143=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
144 139
145Fade 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
146is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
147 142
148=item B<-tint> I<colour>
149
150Tint the transparent background pixmap with the given colour when
151transparency is enabled with B<-tr>. This only works for
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colours essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file> 143=item B<-icon> I<file>
188 144
189Compile I<afterimage>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 147application window; resource I<iconFile>.
192 148
193=item B<-bg> I<colour> 149=item B<-bg> I<colour>
194 150
195Window background colour; resource B<background>. 151Window background colour; resource B<background>.
196 152
197=item B<-fg> I<colour> 153=item B<-fg> I<colour>
198 154
199Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203Compile I<afterimage>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>.
207 156
208=item B<-cr> I<colour> 157=item B<-cr> I<colour>
209 158
210The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
211 160
571You can set and change the resources using X11 tools like B<xrdb>. Many 520You can set and change the resources using X11 tools like B<xrdb>. Many
572distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
575 524
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 530 6. resources specified via -xrm on the commandline
582 531
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
700 649
701B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
702if 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
703monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
704 653
705=item B<transparent:> I<boolean>
706
707Turn on/off illusion of a transparent window background.
708
709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710future versions.
711
712I<Please address all transparency related issues to Sasha Vasko at
713sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
714
715=item B<fading:> I<number> 654=item B<fading:> I<number>
716 655
717Fade 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>.
718 657
719=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
720 659
721Fade 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
722colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
723 662
724=item B<tintColor:> I<colour>
725
726Tint the transparent background pixmap with the given colour; option
727B<-tint>.
728
729=item B<shading:> I<number>
730
731Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
732in addition to tinting it; option B<-sh>.
733
734=item B<blendType:> I<string>
735
736Specify background blending type; option B<-blt>.
737
738=item B<blurRadius:> I<number>
739
740Apply gaussian blur with the specified radius to the transparent
741background image; option B<-blr>.
742
743=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
744 664
745Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
746 666
747=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
755 675
756=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
757 677
758The 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
759and the text. 679and the text.
760
761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
762
763Use the specified image file for the background and also
764optionally specify its scaling with a geometry string B<WxH+X+Y>,
765(default C<0x0+50+50>) in which B<"W" / "H"> specify the
766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767centre (percent). A scale of 0 displays the image with tiling. A scale
768of 1 displays the image without any scaling. A scale of 2 to 9 specifies
769an integer number of images in that direction. No image will be magnified
770beyond 10 times its original size. The maximum permitted scale is 1000.
771Additional operations can be specified after colon B<:op1:op2...>.
772Supported operations are:
773
774 tile force background image to be tiled and not scaled. Equivalent to 0x0
775 propscale will scale image keeping proportions
776 auto will scale image to match window size. Equivalent to 100x100
777 hscale will scale image horizontally to the window size
778 vscale will scale image vertically to the window size
779 scale will scale image to match window size
780 root will tile image as if it was a root window background, auto-adjusting
781 whenever terminal window moves
782
783If used in conjunction with B<-tr> option, the specified pixmap will be
784blended over transparency image using either alpha-blending, or any
785other blending type, specified with B<-blt "type"> option.
786
787=item B<path:> I<path>
788
789Specify the colon-delimited search path for finding background image files.
790 680
791=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
792 682
793Select 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
794that 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
917=item B<scrollstyle:> I<mode> 807=item B<scrollstyle:> I<mode>
918 808
919Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 809Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
920the author's favourite. 810the author's favourite.
921 811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
815
922=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
923 817
924B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
925disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
926 820
945B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
946B<+si>. 840B<+si>.
947 841
948=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
949 843
950B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
951B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
952with 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>.
953 848
954=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
955 850
956B<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
957are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
1146Sets the working directory for the shell (or the command specified via 1041Sets the working directory for the shell (or the command specified via
1147B<-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
1148@@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
1149directory will be used; option B<-cd>. 1044directory will be used; option B<-cd>.
1150 1045
1151=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1152 1047
1153Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1154intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1155 1050
1156The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1157any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1158B<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
1159and 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
1160B<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>.
1161 1065
1162The 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
1163whatever 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
1164keys 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
1165current application keymap mode state. 1069current application keymap mode state.
1166 1070
1167The 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
1168searching 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
1169omitting 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
1170keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1171performed in an exact manner; however, the closest match is assured.
1172 1084
1173I<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
1174number), see RESOURCES in C<man 7 X> for futher details. 1087number), see RESOURCES in C<man 7 X> for further details.
1175 1088
1176You 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
1177with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1090of action, followed by a colon. An action strings without colons is
1178should 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:>).
1179 1093
1180Its usage can be demonstrated by an example: 1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1181 1096
1182 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1097=over 4
1183 1098
1184The above line is equivalent to the following three lines: 1099=item string:STRING
1185 1100
1186 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1187 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1102then the remaining C<STRING> will be passed to the program running in the
1188 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:
1189 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
1190If 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>
1191is 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
1192example 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>
1193when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1194 1120
1195 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
1196 1122
1197If 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
1198is 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
1199manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1201 1126
1202 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
1203 1129
1204Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1205will match if at I<at least> the specified identifiers are being set, and 1131info):
1206no other key mappings with those and more bits are being defined. That
1207means that defining a key map for C<a> will automatically provide
1208definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1209mappings themselves.
1210 1132
1211Unfortunately, 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
1212if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1213C<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
1214user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1215 1146
1216 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1217 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1218 1149
1219The 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
1220of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1221C<Shift-Insert>. 1152C<Shift-Insert>.
1222 1153
1223The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item EXTENSION:STRING
1224the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1225font-switching at runtime:
1226 1155
1227 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)
1228 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1157extension of the same name. The extension will be loaded automatically if
1158neccessary.
1229 1159
1230Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1160Not all extensions define key actions, but popular extensions that do
1231info): 1161include the I<selection> and I<matcher> extensions (documented in their
1162own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1163respectively).
1232 1164
1233 URxvt.keysym.M-C-3: command:\033[8;25;80t 1165From the silly examples department, this will rot13-"encrypt"
1234 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>
1235 1192
1236=item B<perl-ext-common>: I<string> 1193=item B<perl-ext-common>: I<string>
1237 1194
1238=item B<perl-ext>: I<string> 1195=item B<perl-ext>: I<string>
1239 1196
1266the @@RXVT_NAME@@perl(3) manpage. 1223the @@RXVT_NAME@@perl(3) manpage.
1267 1224
1268=item B<perl-lib>: I<path> 1225=item B<perl-lib>: I<path>
1269 1226
1270Colon-separated list of additional directories that hold extension 1227Colon-separated list of additional directories that hold extension
1271scripts. When looking for extensions specified by the C<perl> resource, 1228scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1272@@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
1273F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1230lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1274 1231
1275See the @@RXVT_NAME@@perl(3) manpage. 1232See the @@RXVT_NAME@@perl(3) manpage.
1276 1233
1277=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1234=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1278 1235
1287=item B<searchable-scrollback:> I<keysym> 1244=item B<searchable-scrollback:> I<keysym>
1288 1245
1289Sets the hotkey that starts the incremental scrollback buffer search 1246Sets the hotkey that starts the incremental scrollback buffer search
1290(default: C<M-s>). 1247(default: C<M-s>).
1291 1248
1292=item B<urlLauncher>: I<string> 1249=item B<url-launcher>: I<string>
1293 1250
1294Specifies 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
1295C<selection-popup> and C<matcher> perl extensions. 1252C<selection-popup> and C<matcher> perl extensions.
1296 1253
1297=item B<transient-for>: I<windowid> 1254=item B<transient-for>: I<windowid>
1308Turn on/off ISO 14755 (default enabled). 1265Turn on/off ISO 14755 (default enabled).
1309 1266
1310=item B<iso14755_52:> I<boolean> 1267=item B<iso14755_52:> I<boolean>
1311 1268
1312Turn 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.
1313 1384
1314=back 1385=back
1315 1386
1316=head1 THE SCROLLBAR 1387=head1 THE SCROLLBAR
1317 1388
1365window causes the value of the PRIMARY selection (or CLIPBOARD with the 1436window causes the value of the PRIMARY selection (or CLIPBOARD with the
1366B<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.
1367 1438
1368Pressing 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
1369inserted 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.
1370 1447
1371=back 1448=back
1372 1449
1373=head1 CHANGING FONTS 1450=head1 CHANGING FONTS
1374 1451
1499The following text gives values for the standard 88 colour mode (and 1576The following text gives values for the standard 88 colour mode (and
1500values for the 256 colour mode in parentheses). 1577values for the 256 colour mode in parentheses).
1501 1578
1502The 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:
1503 1580
1504 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
1505 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
1506 1583
1507The 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%
1508steps (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
1509the RGB cube. 1586the RGB cube.
1510 1587
1526White. 1603White.
1527 1604
1528=head2 ALPHA CHANNEL SUPPORT 1605=head2 ALPHA CHANNEL SUPPORT
1529 1606
1530If 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
1531their act together, rxvt-unicode will do it's own alpha channel management: 1608their act together, rxvt-unicode will do its own alpha channel management:
1532 1609
1533You can prefix any colour with an opaqueness percentage enclosed in 1610You can prefix any colour with an opaqueness percentage enclosed in
1534brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1611brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1535(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
1536transparent 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
1618 1695
1619=item B<SHELL> 1696=item B<SHELL>
1620 1697
1621The 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>.
1622 1699
1623=item B<RXVT_SOCKET> 1700=item B<RXVT_SOCKET> [I<sic>]
1624 1701
1625The unix domain socket path used by @@RXVT_NAME@@c(1) and 1702The unix domain socket path used by @@RXVT_NAME@@c(1) and
1626@@RXVT_NAME@@d(1). 1703@@RXVT_NAME@@d(1).
1627 1704
1628Default 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).
1629 1716
1630=item B<HOME> 1717=item B<HOME>
1631 1718
1632Used to locate the default directory for the unix domain socket for 1719Used to locate the default directory for the unix domain socket for
1633daemon communications and to locate various resource files (such as 1720daemon communications and to locate various resource files (such as
1634C<.Xdefaults>) 1721C<.Xdefaults>)
1635 1722
1636=item B<XAPPLRESDIR> 1723=item B<XAPPLRESDIR>
1637 1724
1638Directory where various X resource files are being located. 1725Directory where application-specific X resource files are located.
1639 1726
1640=item B<XENVIRONMENT> 1727=item B<XENVIRONMENT>
1641 1728
1642If set and accessible, gives the name of a X resource file to be loaded by 1729If set and accessible, gives the name of a X resource file to be loaded by
1643@@RXVT_NAME@@. 1730@@RXVT_NAME@@.
1654 1741
1655=back 1742=back
1656 1743
1657=head1 SEE ALSO 1744=head1 SEE ALSO
1658 1745
1746@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1659@@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)
1660 1748
1661=head1 CURRENT PROJECT COORDINATOR 1749=head1 CURRENT PROJECT COORDINATOR
1662 1750
1663=over 4 1751=over 4
1664 1752
1665=item Project Coordinator 1753=item Project Coordinator
1666 1754
1667Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1755Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1668 1756
1669L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1757L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1670 1758
1671=back 1759=back
1672 1760
1676 1764
1677=item John Bovey 1765=item John Bovey
1678 1766
1679University of Kent, 1992, wrote the original Xvt. 1767University of Kent, 1992, wrote the original Xvt.
1680 1768
1681=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1769=item Rob Nation <nation@rocket.sanders.lockheed.com>
1682 1770
1683very heavily modified Xvt and came up with Rxvt 1771very heavily modified Xvt and came up with Rxvt
1684 1772
1685=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1773=item Angelo Haritsis <ah@doc.ic.ac.uk>
1686 1774
1687wrote the Greek Keyboard Input (no longer in code) 1775wrote the Greek Keyboard Input (no longer in code)
1688 1776
1689=item mj olesen L<< <olesen@me.QueensU.CA> >> 1777=item mj olesen <olesen@me.QueensU.CA>
1690 1778
1691Wrote the menu system. 1779Wrote the menu system.
1692 1780
1693Project Coordinator (changes.txt 2.11 to 2.21) 1781Project Coordinator (changes.txt 2.11 to 2.21)
1694 1782
1695=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1783=item Oezguer Kesim <kesim@math.fu-berlin.de>
1696 1784
1697Project Coordinator (changes.txt 2.21a to 2.4.5) 1785Project Coordinator (changes.txt 2.21a to 2.4.5)
1698 1786
1699=item Geoff Wing L<< <gcw@pobox.com> >> 1787=item Geoff Wing <gcw@pobox.com>
1700 1788
1701Rewrote screen display and text selection routines. 1789Rewrote screen display and text selection routines.
1702 1790
1703Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1791Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1704 1792
1705=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1793=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1706 1794
1707Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1795Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1708extension, random hacks, numerous bugfixes and extensions. 1796extension, random hacks, numerous bugfixes and extensions.
1709 1797
1710Project Coordinator (Changes 1.0 -) 1798Project Coordinator (Changes 1.0 -)
1711 1799
1712=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1800=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1713 1801
1714Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1802pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1715 1803
1716=back 1804=back
1717 1805

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines