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.206 by sf-exg, Sun Nov 20 10:58:58 2011 UTC vs.
Revision 1.241 by root, Wed Dec 17 15:22:10 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
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
116
111=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
112 118
113Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
114 120
115=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 128
123=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
124 130
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn 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 132
134=item B<-fade> I<number> 133=item B<-fade> I<number>
135 134
136Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
137fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
140=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
141 140
142Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
143is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
144 143
145=item B<-tint> I<colour>
146
147Tint the transparent background with the given colour;
148resource I<tintColor>.
149
150=item B<-sh> I<number>
151
152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153A value of 100 means no shading; resource I<shading>.
154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128;
172resource I<blurRadius>.
173
174=item B<-icon> I<file> 144=item B<-icon> I<file>
175 145
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 146Compile I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the 147is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>. 148application window; resource I<iconFile>.
179 149
180=item B<-bg> I<colour> 150=item B<-bg> I<colour>
181 151
182Window background colour; resource B<background>. 152Window background colour; resource B<background>.
183 153
184=item B<-fg> I<colour> 154=item B<-fg> I<colour>
185 155
186Window foreground colour; resource B<foreground>. 156Window 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 157
195=item B<-cr> I<colour> 158=item B<-cr> I<colour>
196 159
197The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
198 161
257 220
258=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
259 222
260Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
261 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
262=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
263 230
264Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
265B<utmpInhibit>. 232B<utmpInhibit>.
266 233
344 311
345=item B<-override-redirect> 312=item B<-override-redirect>
346 313
347Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
348B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
349 321
350=item B<-sbg> 322=item B<-sbg>
351 323
352Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
353drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
687 659
688B<False>: specify that everything is to be displayed, even 660B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the 661if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>. 662monitor to display anything); option B<+ss>.
691 663
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> 664=item B<fading:> I<number>
700 665
701Fade the text by the given percentage when focus is lost; option B<-fade>. 666Fade the text by the given percentage when focus is lost; option B<-fade>.
702 667
703=item B<fadeColor:> I<colour> 668=item B<fadeColor:> I<colour>
704 669
705Fade to this colour, when fading is used (see B<fading:>). The default 670Fade to this colour, when fading is used (see B<fading:>). The default
706colour is black; option B<-fadecolor>. 671colour is black; option B<-fadecolor>.
707 672
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> 673=item B<iconFile:> I<file>
731 674
732Set the application icon pixmap; option B<-icon>. 675Set the application icon pixmap; option B<-icon>.
733 676
734=item B<scrollColor:> I<colour> 677=item B<scrollColor:> I<colour>
742 685
743=item B<borderColor:> I<colour> 686=item B<borderColor:> I<colour>
744 687
745The colour of the border around the text area and between the scrollbar 688The colour of the border around the text area and between the scrollbar
746and the text. 689and 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=pscale>
767
768enables proportional scaling
769
770=item B<op=root>
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=pscale
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
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 690
819=item B<font:> I<fontlist> 691=item B<font:> I<fontlist>
820 692
821Select the fonts to be used. This is a comma separated list of font names 693Select 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 694that are checked in order when trying to find glyphs for characters. The
918=item B<loginShell:> I<boolean> 790=item B<loginShell:> I<boolean>
919 791
920B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 792B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
921the shell; option B<-ls>. B<False>: start as a normal sub-shell 793the shell; option B<-ls>. B<False>: start as a normal sub-shell
922[default]; option B<+ls>. 794[default]; option B<+ls>.
795
796=item B<multiClickTime:> I<number>
797
798Specify the maximum time in milliseconds between multi-click select
799events. The default is 500 milliseconds; option B<-mc>.
923 800
924=item B<utmpInhibit:> I<boolean> 801=item B<utmpInhibit:> I<boolean>
925 802
926B<True>: inhibit writing record into the system log file B<utmp>; 803B<True>: inhibit writing record into the system log file B<utmp>;
927option B<-ut>. B<False>: write record into the system log file B<utmp> 804option B<-ut>. B<False>: write record into the system log file B<utmp>
1179Sets the working directory for the shell (or the command specified via 1056Sets 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 1057B<-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 1058@@RXVT_NAME@@ to start. If it isn't specified then the current working
1182directory will be used; option B<-cd>. 1059directory will be used; option B<-cd>.
1183 1060
1184=item B<keysym.>I<sym>: I<string> 1061=item B<keysym.>I<sym>: I<action>
1185 1062
1186Compile I<frills>: Associate I<string> with keysym I<sym>. The 1063Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1187intervening resource name B<keysym.> cannot be omitted. 1064resource name B<keysym.> cannot be omitted.
1188 1065
1189The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1066Using this resource, you can map key combinations such as
1190any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1067C<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>, 1068string 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>, 1069terminal scroll up or down the way you want it, or any other thing an
1193B<2>, B<3>, B<4>, B<5>. 1070extension might provide.
1071
1072The key combination that triggers the action, I<sym>, has the following format:
1073
1074 (modifiers-)key
1075
1076Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1077B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1078B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1079B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1194 1080
1195The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1081The 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 1082whatever 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 1083keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1198current application keymap mode state. 1084current application keymap mode state.
1199 1085
1200The spellings of I<key> can be obtained by using B<xev>(1) command or 1086Due the the large number of modifier combinations, a key mapping will
1201searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1087match if I<at least> the specified identifiers are being set, and no other
1088key mappings with those and more bits are being defined. That means that
1089defining a mapping for C<a> will automatically provide definitions for
1090C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1091themselves. See the C<builtin:> action, below, for a way to work around
1092this when this is a problem.
1093
1094The spelling of I<key> depends on your implementation of X. An easy way to
1095find a key name is to use the B<xev>(1) command. You can find a list by
1096looking 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 1097the 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 1098value (B<0x0000 - 0xFFFF>).
1204performed in an exact manner; however, the closest match is assured.
1205 1099
1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1100As with any resource value, the I<action> string may contain backslash
1101escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1207number), see RESOURCES in C<man 7 X> for further details. 1102number), see RESOURCES in C<man 7 X> for further details.
1208 1103
1209You can define a range of keysyms in one shot by providing a I<string> 1104An action starts with an action prefix that selects a certain type
1210with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1105of action, followed by a colon. An action string without colons is
1106interpreted as a literal string to pass to the tty (as if it was
1107prefixed with C<string:>).
1108
1109The following action prefixes are known - extensions can provide
1110additional prefixes:
1111
1112=over 4
1113
1114=item string:STRING
1115
1116If the I<action> starts with C<string:> (or otherwise contains no colons),
1117then the remaining C<STRING> will be passed to the program running in the
1118terminal. For example, you could replace whatever Shift-Tab outputs by the
1119string C<echo rm -rf /> followed by a newline:
1120
1121 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1122
1123This could in theory be used to completely redefine your keymap.
1124
1125In addition, for actions of this type, you can define a range of
1126keysyms in one shot by loading the C<keysym-list> perl extension and
1127providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1211should be a character not used by the strings. 1128the delimiter `/' should be a character not used by the strings.
1212 1129
1213Its usage can be demonstrated by an example: 1130Its usage can be demonstrated by an example:
1214 1131
1215 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1132 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1216 1133
1217The above line is equivalent to the following three lines: 1134The above line is equivalent to the following three lines:
1218 1135
1219 URxvt.keysym.Meta-Control-0x61: \033<a> 1136 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1220 URxvt.keysym.Meta-Control-0x62: \033<b> 1137 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1221 URxvt.keysym.Meta-Control-0x63: \033<c> 1138 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1222 1139
1140=item command:STRING
1141
1223If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1142If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1224is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1143is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1144the opposite of C<string:> - instead of sending it to the program running
1145in the terminal, it will be treated as if it were program output). This is
1146most useful to feed command sequences into @@RXVT_NAME@@.
1147
1225example the following means "change the current locale to C<zh_CN.GBK> 1148For example the following means "change the current locale to C<zh_CN.GBK>
1226when Control-Meta-c is being pressed": 1149when Control-Meta-c is being pressed":
1227 1150
1228 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1151 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1229 1152
1230If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1153The following example will map Control-Meta-1 and Control-Meta-2 to
1231is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1154the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1232manpage. For example, the F<selection> extension (activated via 1155font-switching at runtime:
1233C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1234 1156
1235 URxvt.keysym.M-C-c: perl:selection:rot13 1157 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1158 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1236 1159
1237Due the the large number of modifier combinations, a defined key mapping 1160Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1238will match if I<at least> the specified identifiers are being set, and 1161info):
1239no other key mappings with those and more bits are being defined. That
1240means that defining a key map for C<a> will automatically provide
1241definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1242mappings themselves.
1243 1162
1244Unfortunately, this will override built-in key mappings. For example 1163 URxvt.keysym.M-C-3: command:\033[8;25;80t
1164 URxvt.keysym.M-C-4: command:\033[8;48;110t
1165
1166=item builtin:
1167
1168The builtin action is the action that @@RXVT_NAME@@ would execute if no
1169key binding existed for the key combination. The obvious use is to undo
1170the effect of existing bindings. The not so obvious use is to reinstate
1171bindings when another binding overrides too many modifiers.
1172
1245if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1173For example if you overwrite the C<Insert> key you will disable
1246C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1174@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1247user-defined keymap using the C<builtin:> replacement: 1175"holes" into the user-defined keymap using the C<builtin:> replacement:
1248 1176
1249 URxvt.keysym.Insert: <my insert key sequence> 1177 URxvt.keysym.Insert: <my insert key sequence>
1250 URxvt.keysym.S-Insert: builtin: 1178 URxvt.keysym.S-Insert: builtin:
1251 1179
1252The first line defines a mapping for C<Insert> and I<any> combination 1180The first line defines a mapping for C<Insert> and I<any> combination
1253of modifiers. The second line re-establishes the default mapping for 1181of modifiers. The second line re-establishes the default mapping for
1254C<Shift-Insert>. 1182C<Shift-Insert>.
1255 1183
1256The following example will map Control-Meta-1 and Control-Meta-2 to 1184=item builtin-string:
1257the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1258font-switching at runtime:
1259 1185
1260 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1186This action is mainly useful to restore string mappings for keys that
1261 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1187have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1188difficult to explain - basically, this action will send the string to the
1189application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1190action for it.
1262 1191
1263Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1192An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1264info): 1193selection when you press C<Shift-Insert>. With the following bindings, it
1194would instead emit the (undocumented, but what applications running in the
1195terminal might expect) sequence C<ESC [ 2 $> instead:
1265 1196
1266 URxvt.keysym.M-C-3: command:\033[8;25;80t 1197 URxvt.keysym.S-Insert: builtin-string:
1267 URxvt.keysym.M-C-4: command:\033[8;48;110t 1198 URxvt.keysym.C-S-Insert: builtin:
1199
1200The first line disables the paste functionality for that key
1201combination, and the second reinstates the default behaviour for
1202C<Control-Shift-Insert>, which would otherwise be overridden.
1203
1204Similarly, to let applications gain access to the C<C-M-c> (copy to
1205clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1206this:
1207
1208 URxvt.keysym.C-M-c: builtin-string:
1209 URxvt.keysym.C-M-v: builtin-string:
1210
1211=item EXTENSION:STRING
1212
1213An action of this form invokes the action B<STRING>, if any, provided
1214by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1215be loaded automatically if necessary.
1216
1217Not all extensions define actions, but popular extensions that do
1218include the I<selection> and I<matcher> extensions (documented in their
1219own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1220respectively).
1221
1222From the silly examples department, this will rot13-"encrypt"
1223@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1224keyboards:
1225
1226 URxvt.keysym.M-C-c: selection:rot13
1227
1228=item perl:STRING *DEPRECATED*
1229
1230This is a deprecated way of invoking commands provided by perl
1231extensions. It is still supported, but should not be used anymore.
1232
1233=back
1268 1234
1269=item B<perl-ext-common>: I<string> 1235=item B<perl-ext-common>: I<string>
1270 1236
1271=item B<perl-ext>: I<string> 1237=item B<perl-ext>: I<string>
1272 1238
1274use in this terminal instance; option B<-pe>. 1240use in this terminal instance; option B<-pe>.
1275 1241
1276Extension names can be prefixed with a C<-> sign to prohibit using 1242Extension names can be prefixed with a C<-> sign to prohibit using
1277them. This can be useful to selectively disable some extensions loaded 1243them. This can be useful to selectively disable some extensions loaded
1278by default, or specified via the C<perl-ext-common> resource. For 1244by default, or specified via the C<perl-ext-common> resource. For
1279example, C<default,-selection> will use all the default extension except 1245example, C<default,-selection> will use all the default extensions except
1280C<selection>. 1246C<selection>.
1281 1247
1282Extension names can also be followed by an argument in angle brackets 1248The default set includes the C<selection>, C<option-popup>,
1283(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1249C<selection-popup> and C<readline> extensions, any extensions that
1284searchable scrollback to Alt/Meta-s). Mentioning the same extension 1250define keybindings via C<BINDING> meta comments, and extensions which
1285multiple times with different arguments will pass multiple arguments to 1251are mentioned in B<keysym> resources.
1286the extension. 1252
1253Any extension such that a corresponding resource is given on the
1254command line is automatically appended to B<perl-ext>.
1287 1255
1288Each extension is looked up in the library directories, loaded if 1256Each extension is looked up in the library directories, loaded if
1289necessary, and bound to the current terminal instance. 1257necessary, and bound to the current terminal instance. When the library
1258search path contains multiple extension files of the same name, then the
1259first one found will be used.
1290 1260
1291If both of these resources are the empty string, then the perl 1261If both of these resources are the empty string, then the perl interpreter
1292interpreter will not be initialized. The idea behind two options is that 1262will not be initialized. The rationale for having two options is that
1293B<perl-ext-common> will be used for extensions that should be available to 1263B<perl-ext-common> will be used for extensions that should be available to
1294all instances, while B<perl-ext> is used for specific instances. 1264all instances, while B<perl-ext> is used for specific instances.
1295 1265
1296=item B<perl-eval>: I<string> 1266=item B<perl-eval>: I<string>
1297 1267
1299the @@RXVT_NAME@@perl(3) manpage. 1269the @@RXVT_NAME@@perl(3) manpage.
1300 1270
1301=item B<perl-lib>: I<path> 1271=item B<perl-lib>: I<path>
1302 1272
1303Colon-separated list of additional directories that hold extension 1273Colon-separated list of additional directories that hold extension
1304scripts. When looking for perl extensions, @@RXVT_NAME@@ will first 1274scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1305look in these directories, then in $HOME/.urxvt/ext and lastly in 1275in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1306F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1276lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1307 1277
1308See the @@RXVT_NAME@@perl(3) manpage. 1278See the @@RXVT_NAME@@perl(3) manpage.
1309 1279
1310=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1280=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1311 1281
1315=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1285=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1316 1286
1317Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1287Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1318for details. 1288for details.
1319 1289
1320=item B<searchable-scrollback:> I<keysym> 1290=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1321 1291
1322Sets the hotkey that starts the incremental scrollback buffer search 1292This resource is deprecated and will be removed. Use a B<keysym> resource
1323(default: C<M-s>). 1293instead, e.g.:
1324 1294
1295 URxvt.keysym.M-s: searchable-scrollback:start
1296
1325=item B<urlLauncher>: I<string> 1297=item B<url-launcher>: I<string>
1326 1298
1327Specifies the program to be started with a URL argument. Used by the 1299Specifies the program to be started with a URL argument. Used by the
1328C<selection-popup> and C<matcher> perl extensions. 1300C<selection-popup> and C<matcher> perl extensions.
1329 1301
1330=item B<transient-for>: I<windowid> 1302=item B<transient-for>: I<windowid>
1341Turn on/off ISO 14755 (default enabled). 1313Turn on/off ISO 14755 (default enabled).
1342 1314
1343=item B<iso14755_52:> I<boolean> 1315=item B<iso14755_52:> I<boolean>
1344 1316
1345Turn on/off ISO 14755 5.2 mode (default enabled). 1317Turn on/off ISO 14755 5.2 mode (default enabled).
1318
1319=back
1320
1321=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1322
1323=over 4
1324
1325=item B<-pixmap> I<file[;oplist]>
1326
1327=item B<backgroundPixmap:> I<file[;oplist]>
1328
1329Compile I<pixbuf>: Use the specified image file as the window's
1330background and also optionally specify a colon separated list of
1331operations to modify it. Note that you may need to quote the C<;>
1332character when using the command line option, as C<;> is usually a
1333metacharacter in shells. Supported operations are:
1334
1335=over 4
1336
1337=item B<WxH+X+Y>
1338
1339sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1340scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1341scale of 0 disables scaling.
1342
1343=item B<op=tile>
1344
1345enables tiling
1346
1347=item B<op=keep-aspect>
1348
1349maintain the image aspect ratio when scaling
1350
1351=item B<op=root-align>
1352
1353use the position of the terminal window relative to the root window as
1354the image offset, simulating a root window background
1355
1356=back
1357
1358The default scale and position setting is C<100x100+50+50>.
1359Alternatively, a predefined set of templates can be used to achieve
1360the most common setups:
1361
1362=over 4
1363
1364=item B<style=tiled>
1365
1366the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1367
1368=item B<style=aspect-stretched>
1369
1370the image is scaled to fill the whole window maintaining the aspect
1371ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1372
1373=item B<style=stretched>
1374
1375the image is scaled to fill the whole window. Equivalent to 100x100
1376
1377=item B<style=centered>
1378
1379the image is centered with no scaling. Equivalent to 0x0+50+50
1380
1381=item B<style=root-tiled>
1382
1383the image is tiled with no scaling and using 'root' positioning.
1384Equivalent to 0x0:op=tile:op=root-align
1385
1386=back
1387
1388If multiple templates are specified the last one wins. Note that a
1389template overrides all the scale, position and operations settings.
1390
1391If used in conjunction with pseudo-transparency, the specified pixmap
1392will be blended over the transparent background using alpha-blending.
1393
1394=item B<-tr>|B<+tr>
1395
1396=item B<transparent:> I<boolean>
1397
1398Turn on/off pseudo-transparency by using the root pixmap as background.
1399
1400B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1401will be removed in future versions.
1402
1403=item B<-tint> I<colour>
1404
1405=item B<tintColor:> I<colour>
1406
1407Tint the transparent background with the given colour. Note that a
1408black tint yields a completely black image while a white tint yields
1409the image unchanged.
1410
1411=item B<-sh> I<number>
1412
1413=item B<shading:> I<number>
1414
1415Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1416A value of 100 means no shading.
1417
1418=item B<-blr> I<HxV>
1419
1420=item B<blurRadius:> I<HxV>
1421
1422Apply gaussian blur with the specified radius to the transparent
1423background. If a single number is specified, the vertical and
1424horizontal radii are considered to be the same. Setting one of the
1425radii to 1 and the other to a large number creates interesting effects
1426on some backgrounds. The maximum radius value is 128. An horizontal or
1427vertical radius of 0 disables blurring.
1428
1429=item B<path:> I<path>
1430
1431Specify the colon-delimited search path for finding background image files.
1346 1432
1347=back 1433=back
1348 1434
1349=head1 THE SCROLLBAR 1435=head1 THE SCROLLBAR
1350 1436
1398window causes the value of the PRIMARY selection (or CLIPBOARD with the 1484window causes the value of the PRIMARY selection (or CLIPBOARD with the
1399B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1485B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1400 1486
1401Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1487Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1402inserted too. 1488inserted too.
1489
1490rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1491<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1492binding causes the value of the internal selection to be copied to the
1493CLIPBOARD selection, while the second binding causes the value of the
1494CLIPBOARD selection to be inserted.
1403 1495
1404=back 1496=back
1405 1497
1406=head1 CHANGING FONTS 1498=head1 CHANGING FONTS
1407 1499
1532The following text gives values for the standard 88 colour mode (and 1624The following text gives values for the standard 88 colour mode (and
1533values for the 256 colour mode in parentheses). 1625values for the 256 colour mode in parentheses).
1534 1626
1535The RGB cube uses indices 16..79 (16..231) using the following formulas: 1627The RGB cube uses indices 16..79 (16..231) using the following formulas:
1536 1628
1537 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1629 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1538 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1630 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1539 1631
1540The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1632The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1541steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1633steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1542the RGB cube. 1634the RGB cube.
1543 1635
1559White. 1651White.
1560 1652
1561=head2 ALPHA CHANNEL SUPPORT 1653=head2 ALPHA CHANNEL SUPPORT
1562 1654
1563If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1655If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1564their act together, rxvt-unicode will do it's own alpha channel management: 1656their act together, rxvt-unicode will do its own alpha channel management:
1565 1657
1566You can prefix any colour with an opaqueness percentage enclosed in 1658You can prefix any colour with an opaqueness percentage enclosed in
1567brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1659brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1568(0-100) that specifies the opacity of the colour, where C<0> is completely 1660(0-100) that specifies the opacity of the colour, where C<0> is completely
1569transparent and C<100> is completely opaque. For example, C<[50]red> is a 1661transparent and C<100> is completely opaque. For example, C<[50]red> is a
1651 1743
1652=item B<SHELL> 1744=item B<SHELL>
1653 1745
1654The shell to be used for command execution, defaults to C</bin/sh>. 1746The shell to be used for command execution, defaults to C</bin/sh>.
1655 1747
1656=item B<RXVT_SOCKET> 1748=item B<RXVT_SOCKET> [I<sic>]
1657 1749
1658The unix domain socket path used by @@RXVT_NAME@@c(1) and 1750The unix domain socket path used by @@RXVT_NAME@@c(1) and
1659@@RXVT_NAME@@d(1). 1751@@RXVT_NAME@@d(1).
1660 1752
1661Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1753Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1754
1755=item B<URXVT_PERL_LIB>
1756
1757Additional F<:>-separated library search path for perl extensions. Will be
1758searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1759directory.
1760
1761=item B<URXVT_PERL_VERBOSITY>
1762
1763See L<@@RXVT_NAME@@perl>(3).
1662 1764
1663=item B<HOME> 1765=item B<HOME>
1664 1766
1665Used to locate the default directory for the unix domain socket for 1767Used to locate the default directory for the unix domain socket for
1666daemon communications and to locate various resource files (such as 1768daemon communications and to locate various resource files (such as
1687 1789
1688=back 1790=back
1689 1791
1690=head1 SEE ALSO 1792=head1 SEE ALSO
1691 1793
1794@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1692@@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) 1795@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1693 1796
1694=head1 CURRENT PROJECT COORDINATOR 1797=head1 CURRENT PROJECT COORDINATOR
1695 1798
1696=over 4 1799=over 4
1697 1800
1698=item Project Coordinator 1801=item Project Coordinator
1699 1802
1700Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1803Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1701 1804
1702L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1805L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1703 1806
1704=back 1807=back
1705 1808
1709 1812
1710=item John Bovey 1813=item John Bovey
1711 1814
1712University of Kent, 1992, wrote the original Xvt. 1815University of Kent, 1992, wrote the original Xvt.
1713 1816
1714=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1817=item Rob Nation <nation@rocket.sanders.lockheed.com>
1715 1818
1716very heavily modified Xvt and came up with Rxvt 1819very heavily modified Xvt and came up with Rxvt
1717 1820
1718=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1821=item Angelo Haritsis <ah@doc.ic.ac.uk>
1719 1822
1720wrote the Greek Keyboard Input (no longer in code) 1823wrote the Greek Keyboard Input (no longer in code)
1721 1824
1722=item mj olesen L<< <olesen@me.QueensU.CA> >> 1825=item mj olesen <olesen@me.QueensU.CA>
1723 1826
1724Wrote the menu system. 1827Wrote the menu system.
1725 1828
1726Project Coordinator (changes.txt 2.11 to 2.21) 1829Project Coordinator (changes.txt 2.11 to 2.21)
1727 1830
1728=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1831=item Oezguer Kesim <kesim@math.fu-berlin.de>
1729 1832
1730Project Coordinator (changes.txt 2.21a to 2.4.5) 1833Project Coordinator (changes.txt 2.21a to 2.4.5)
1731 1834
1732=item Geoff Wing L<< <gcw@pobox.com> >> 1835=item Geoff Wing <gcw@pobox.com>
1733 1836
1734Rewrote screen display and text selection routines. 1837Rewrote screen display and text selection routines.
1735 1838
1736Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1839Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1737 1840
1738=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1841=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1739 1842
1740Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1843Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1741extension, random hacks, numerous bugfixes and extensions. 1844extension, random hacks, numerous bugfixes and extensions.
1742 1845
1743Project Coordinator (Changes 1.0 -) 1846Project Coordinator (Changes 1.0 -)
1744 1847
1745=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1848=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1746 1849
1747pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1850pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1748 1851
1749=back 1852=back
1750 1853

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines