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.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC vs.
Revision 1.231 by root, Sat May 17 17:12:29 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> or I<xft>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file> 143=item B<-icon> I<file>
188 144
189Compile I<afterimage> or I<pixbuf>: 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> or I<pixbuf>: 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<100x100+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.
768The maximum permitted scale is 1000.
769Additional operations can be specified after colon B<:op1:op2...>.
770Supported operations are:
771
772 tile force background image to be tiled and not scaled. Equivalent to 0x0
773 propscale will scale image keeping proportions
774 auto will scale image to match window size. Equivalent to 100x100
775 hscale will scale image horizontally to the window size
776 vscale will scale image vertically to the window size
777 scale will scale image to match window size
778 root will tile image as if it was a root window background, auto-adjusting
779 whenever terminal window moves
780
781If used in conjunction with B<-tr> option, the specified pixmap will be
782blended over transparency image using alpha-blending. If I<afterimage>
783support has been compiled in it is possible to choose other blending
784types with B<-blt "type"> option.
785
786=item B<path:> I<path>
787
788Specify the colon-delimited search path for finding background image files.
789 680
790=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
791 682
792Select 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
793that 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
916=item B<scrollstyle:> I<mode> 807=item B<scrollstyle:> I<mode>
917 808
918Set 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
919the author's favourite. 810the author's favourite.
920 811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
815
921=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
922 817
923B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
924disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
925 820
944B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
945B<+si>. 840B<+si>.
946 841
947=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
948 843
949B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
950B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
951with 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>.
952 848
953=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
954 850
955B<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
956are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
1145Sets the working directory for the shell (or the command specified via 1041Sets the working directory for the shell (or the command specified via
1146B<-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
1147@@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
1148directory will be used; option B<-cd>. 1044directory will be used; option B<-cd>.
1149 1045
1150=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1151 1047
1152Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1153intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1154 1050
1155The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1156any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1157B<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
1158and 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
1159B<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>.
1160 1065
1161The 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
1162whatever 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
1163keys 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
1164current application keymap mode state. 1069current application keymap mode state.
1165 1070
1166The 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
1167searching 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
1168omitting 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
1169keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1170performed in an exact manner; however, the closest match is assured.
1171 1084
1172I<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
1173number), see RESOURCES in C<man 7 X> for further details. 1087number), see RESOURCES in C<man 7 X> for further details.
1174 1088
1175You 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
1176with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1090of action, followed by a colon. An action strings without colons is
1177should 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:>).
1178 1093
1179Its usage can be demonstrated by an example: 1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1180 1096
1181 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1097=over 4
1182 1098
1183The above line is equivalent to the following three lines: 1099=item string:STRING
1184 1100
1185 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1186 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1102then the remaining C<STRING> will be passed to the program running in the
1187 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:
1188 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
1189If 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>
1190is 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
1191example 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>
1192when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1193 1120
1194 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
1195 1122
1196If 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
1197is 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
1198manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1199C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1200 1126
1201 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
1202 1129
1203Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1204will match if I<at least> the specified identifiers are being set, and 1131info):
1205no other key mappings with those and more bits are being defined. That
1206means that defining a key map for C<a> will automatically provide
1207definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1208mappings themselves.
1209 1132
1210Unfortunately, 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
1211if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1212C<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
1213user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1214 1146
1215 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1216 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1217 1149
1218The 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
1219of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1220C<Shift-Insert>. 1152C<Shift-Insert>.
1221 1153
1222The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item builtin-string:
1223the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1224font-switching at runtime:
1225 1155
1226 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1156This action is mainly useful to restore string mappings for keys that
1227 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 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.
1228 1161
1229Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1162An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1230info): 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:
1231 1166
1232 URxvt.keysym.M-C-3: command:\033[8;25;80t 1167 URxvt.keysym.S-Insert: builtin-string:
1233 URxvt.keysym.M-C-4: command:\033[8;48;110t 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 *DEPRECATED*
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
1234 1204
1235=item B<perl-ext-common>: I<string> 1205=item B<perl-ext-common>: I<string>
1236 1206
1237=item B<perl-ext>: I<string> 1207=item B<perl-ext>: I<string>
1238 1208
1243them. This can be useful to selectively disable some extensions loaded 1213them. This can be useful to selectively disable some extensions loaded
1244by default, or specified via the C<perl-ext-common> resource. For 1214by default, or specified via the C<perl-ext-common> resource. For
1245example, C<default,-selection> will use all the default extension except 1215example, C<default,-selection> will use all the default extension except
1246C<selection>. 1216C<selection>.
1247 1217
1248Extension names can also be followed by an argument in angle brackets 1218Some extensions define resources or command line switches, and will
1249(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1219automatically be used when their resource or switch is specified.
1250searchable scrollback to Alt/Meta-s). Mentioning the same extension
1251multiple times with different arguments will pass multiple arguments to
1252the extension.
1253 1220
1254Each extension is looked up in the library directories, loaded if 1221Each extension is looked up in the library directories, loaded if
1255necessary, and bound to the current terminal instance. 1222necessary, and bound to the current terminal instance.
1256 1223
1257If both of these resources are the empty string, then the perl 1224If both of these resources are the empty string, then the perl interpreter
1258interpreter will not be initialized. The idea behind two options is that 1225will not be initialized. The rationale for having two options is that
1259B<perl-ext-common> will be used for extensions that should be available to 1226B<perl-ext-common> will be used for extensions that should be available to
1260all instances, while B<perl-ext> is used for specific instances. 1227all instances, while B<perl-ext> is used for specific instances.
1261 1228
1262=item B<perl-eval>: I<string> 1229=item B<perl-eval>: I<string>
1263 1230
1265the @@RXVT_NAME@@perl(3) manpage. 1232the @@RXVT_NAME@@perl(3) manpage.
1266 1233
1267=item B<perl-lib>: I<path> 1234=item B<perl-lib>: I<path>
1268 1235
1269Colon-separated list of additional directories that hold extension 1236Colon-separated list of additional directories that hold extension
1270scripts. When looking for extensions specified by the C<perl> resource, 1237scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1271@@RXVT_NAME@@ will first look in these directories and then in 1238in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1272F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1239lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1273 1240
1274See the @@RXVT_NAME@@perl(3) manpage. 1241See the @@RXVT_NAME@@perl(3) manpage.
1275 1242
1276=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1243=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1277 1244
1281=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1248=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1282 1249
1283Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1250Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1284for details. 1251for details.
1285 1252
1286=item B<searchable-scrollback:> I<keysym> 1253=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1287 1254
1288Sets the hotkey that starts the incremental scrollback buffer search 1255This resource is deprecated and will be removed. Use a B<keysym> resource
1289(default: C<M-s>). 1256instead, e.g.:
1290 1257
1258 URxvt.keysym.M-s: searchable-scrollback:start
1259
1291=item B<urlLauncher>: I<string> 1260=item B<url-launcher>: I<string>
1292 1261
1293Specifies the program to be started with a URL argument. Used by the 1262Specifies the program to be started with a URL argument. Used by the
1294C<selection-popup> and C<matcher> perl extensions. 1263C<selection-popup> and C<matcher> perl extensions.
1295 1264
1296=item B<transient-for>: I<windowid> 1265=item B<transient-for>: I<windowid>
1307Turn on/off ISO 14755 (default enabled). 1276Turn on/off ISO 14755 (default enabled).
1308 1277
1309=item B<iso14755_52:> I<boolean> 1278=item B<iso14755_52:> I<boolean>
1310 1279
1311Turn on/off ISO 14755 5.2 mode (default enabled). 1280Turn on/off ISO 14755 5.2 mode (default enabled).
1281
1282=back
1283
1284=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1285
1286=over 4
1287
1288=item B<-pixmap> I<file[;oplist]>
1289
1290=item B<backgroundPixmap:> I<file[;oplist]>
1291
1292Compile I<pixbuf>: Use the specified image file as the window's
1293background and also optionally specify a colon separated list of
1294operations to modify it. Note that you may need to quote the C<;>
1295character when using the command line option, as C<;> is usually a
1296metacharacter in shells. Supported operations are:
1297
1298=over 4
1299
1300=item B<WxH+X+Y>
1301
1302sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1303scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1304scale of 0 disables scaling.
1305
1306=item B<op=tile>
1307
1308enables tiling
1309
1310=item B<op=keep-aspect>
1311
1312maintain the image aspect ratio when scaling
1313
1314=item B<op=root-align>
1315
1316use the position of the terminal window relative to the root window as
1317the image offset, simulating a root window background
1318
1319=back
1320
1321The default scale and position setting is C<100x100+50+50>.
1322Alternatively, a predefined set of templates can be used to achieve
1323the most common setups:
1324
1325=over 4
1326
1327=item B<style=tiled>
1328
1329the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1330
1331=item B<style=aspect-stretched>
1332
1333the image is scaled to fill the whole window maintaining the aspect
1334ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1335
1336=item B<style=stretched>
1337
1338the image is scaled to fill the whole window. Equivalent to 100x100
1339
1340=item B<style=centered>
1341
1342the image is centered with no scaling. Equivalent to 0x0+50+50
1343
1344=item B<style=root-tiled>
1345
1346the image is tiled with no scaling and using 'root' positioning.
1347Equivalent to 0x0:op=tile:op=root-align
1348
1349=back
1350
1351If multiple templates are specified the last one wins. Note that a
1352template overrides all the scale, position and operations settings.
1353
1354If used in conjunction with pseudo-transparency, the specified pixmap
1355will be blended over the transparent background using alpha-blending.
1356
1357=item B<-tr>|B<+tr>
1358
1359=item B<transparent:> I<boolean>
1360
1361Turn on/off pseudo-transparency by using the root pixmap as background.
1362
1363B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1364will be removed in future versions.
1365
1366=item B<-tint> I<colour>
1367
1368=item B<tintColor:> I<colour>
1369
1370Tint the transparent background with the given colour. Note that a
1371black tint yields a completely black image while a white tint yields
1372the image unchanged.
1373
1374=item B<-sh> I<number>
1375
1376=item B<shading:> I<number>
1377
1378Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1379A value of 100 means no shading.
1380
1381=item B<-blr> I<HxV>
1382
1383=item B<blurRadius:> I<HxV>
1384
1385Apply gaussian blur with the specified radius to the transparent
1386background. If a single number is specified, the vertical and
1387horizontal radii are considered to be the same. Setting one of the
1388radii to 1 and the other to a large number creates interesting effects
1389on some backgrounds. The maximum radius value is 128. An horizontal or
1390vertical radius of 0 disables blurring.
1391
1392=item B<path:> I<path>
1393
1394Specify the colon-delimited search path for finding background image files.
1312 1395
1313=back 1396=back
1314 1397
1315=head1 THE SCROLLBAR 1398=head1 THE SCROLLBAR
1316 1399
1364window causes the value of the PRIMARY selection (or CLIPBOARD with the 1447window causes the value of the PRIMARY selection (or CLIPBOARD with the
1365B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1448B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1366 1449
1367Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1450Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1368inserted too. 1451inserted too.
1452
1453rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1454<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1455binding causes the value of the internal selection to be copied to the
1456CLIPBOARD selection, while the second binding causes the value of the
1457CLIPBOARD selection to be inserted.
1369 1458
1370=back 1459=back
1371 1460
1372=head1 CHANGING FONTS 1461=head1 CHANGING FONTS
1373 1462
1498The following text gives values for the standard 88 colour mode (and 1587The following text gives values for the standard 88 colour mode (and
1499values for the 256 colour mode in parentheses). 1588values for the 256 colour mode in parentheses).
1500 1589
1501The RGB cube uses indices 16..79 (16..231) using the following formulas: 1590The RGB cube uses indices 16..79 (16..231) using the following formulas:
1502 1591
1503 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1592 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1504 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1593 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1505 1594
1506The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1595The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1507steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1596steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1508the RGB cube. 1597the RGB cube.
1509 1598
1525White. 1614White.
1526 1615
1527=head2 ALPHA CHANNEL SUPPORT 1616=head2 ALPHA CHANNEL SUPPORT
1528 1617
1529If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1618If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1530their act together, rxvt-unicode will do it's own alpha channel management: 1619their act together, rxvt-unicode will do its own alpha channel management:
1531 1620
1532You can prefix any colour with an opaqueness percentage enclosed in 1621You can prefix any colour with an opaqueness percentage enclosed in
1533brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1622brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1534(0-100) that specifies the opacity of the colour, where C<0> is completely 1623(0-100) that specifies the opacity of the colour, where C<0> is completely
1535transparent and C<100> is completely opaque. For example, C<[50]red> is a 1624transparent and C<100> is completely opaque. For example, C<[50]red> is a
1617 1706
1618=item B<SHELL> 1707=item B<SHELL>
1619 1708
1620The shell to be used for command execution, defaults to C</bin/sh>. 1709The shell to be used for command execution, defaults to C</bin/sh>.
1621 1710
1622=item B<RXVT_SOCKET> 1711=item B<RXVT_SOCKET> [I<sic>]
1623 1712
1624The unix domain socket path used by @@RXVT_NAME@@c(1) and 1713The unix domain socket path used by @@RXVT_NAME@@c(1) and
1625@@RXVT_NAME@@d(1). 1714@@RXVT_NAME@@d(1).
1626 1715
1627Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1716Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1717
1718=item B<URXVT_PERL_LIB>
1719
1720Additional F<:>-separated library search path for perl extensions. Will be
1721searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1722directory.
1723
1724=item B<URXVT_PERL_VERBOSITY>
1725
1726See L<@@RXVT_NAME@@perl>(3).
1628 1727
1629=item B<HOME> 1728=item B<HOME>
1630 1729
1631Used to locate the default directory for the unix domain socket for 1730Used to locate the default directory for the unix domain socket for
1632daemon communications and to locate various resource files (such as 1731daemon communications and to locate various resource files (such as
1633C<.Xdefaults>) 1732C<.Xdefaults>)
1634 1733
1635=item B<XAPPLRESDIR> 1734=item B<XAPPLRESDIR>
1636 1735
1637Directory where various X resource files are being located. 1736Directory where application-specific X resource files are located.
1638 1737
1639=item B<XENVIRONMENT> 1738=item B<XENVIRONMENT>
1640 1739
1641If set and accessible, gives the name of a X resource file to be loaded by 1740If set and accessible, gives the name of a X resource file to be loaded by
1642@@RXVT_NAME@@. 1741@@RXVT_NAME@@.
1653 1752
1654=back 1753=back
1655 1754
1656=head1 SEE ALSO 1755=head1 SEE ALSO
1657 1756
1757@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1658@@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) 1758@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1659 1759
1660=head1 CURRENT PROJECT COORDINATOR 1760=head1 CURRENT PROJECT COORDINATOR
1661 1761
1662=over 4 1762=over 4
1663 1763
1664=item Project Coordinator 1764=item Project Coordinator
1665 1765
1666Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1766Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1667 1767
1668L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1768L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1669 1769
1670=back 1770=back
1671 1771
1675 1775
1676=item John Bovey 1776=item John Bovey
1677 1777
1678University of Kent, 1992, wrote the original Xvt. 1778University of Kent, 1992, wrote the original Xvt.
1679 1779
1680=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1780=item Rob Nation <nation@rocket.sanders.lockheed.com>
1681 1781
1682very heavily modified Xvt and came up with Rxvt 1782very heavily modified Xvt and came up with Rxvt
1683 1783
1684=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1784=item Angelo Haritsis <ah@doc.ic.ac.uk>
1685 1785
1686wrote the Greek Keyboard Input (no longer in code) 1786wrote the Greek Keyboard Input (no longer in code)
1687 1787
1688=item mj olesen L<< <olesen@me.QueensU.CA> >> 1788=item mj olesen <olesen@me.QueensU.CA>
1689 1789
1690Wrote the menu system. 1790Wrote the menu system.
1691 1791
1692Project Coordinator (changes.txt 2.11 to 2.21) 1792Project Coordinator (changes.txt 2.11 to 2.21)
1693 1793
1694=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1794=item Oezguer Kesim <kesim@math.fu-berlin.de>
1695 1795
1696Project Coordinator (changes.txt 2.21a to 2.4.5) 1796Project Coordinator (changes.txt 2.21a to 2.4.5)
1697 1797
1698=item Geoff Wing L<< <gcw@pobox.com> >> 1798=item Geoff Wing <gcw@pobox.com>
1699 1799
1700Rewrote screen display and text selection routines. 1800Rewrote screen display and text selection routines.
1701 1801
1702Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1802Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1703 1803
1704=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1804=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1705 1805
1706Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1806Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1707extension, random hacks, numerous bugfixes and extensions. 1807extension, random hacks, numerous bugfixes and extensions.
1708 1808
1709Project Coordinator (Changes 1.0 -) 1809Project Coordinator (Changes 1.0 -)
1710 1810
1711=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1811=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1712 1812
1713Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1813pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1714 1814
1715=back 1815=back
1716 1816

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines