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.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 2015 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 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 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 pixmap with the given colour when
148transparency is enabled with B<-tr>. This only works for
149non-tiled backgrounds, currently. See also the B<-sh> option that can be
150used to brighten or darken the image in addition to tinting it.
151Please note that certain tint colours can be applied on the server-side,
152thus yielding performance gain of two orders of magnitude. These colours are:
153blue, red, green, cyan, magenta, yellow, and those close to them. Also
154pure black and pure white colours essentially mean no tinting; resource
155I<tintColor>. Example:
156
157 @@RXVT_NAME@@ -tr -tint blue -sh 40
158
159=item B<-sh> I<number>
160
161Darken (0 .. 100) or lighten (100 .. 200) the transparent
162background image in addition to (or instead of) tinting it;
163resource I<shading>.
164
165=item B<-blt> I<string>
166
167Specify background blending type. If background pixmap is specified
168at the same time as transparency - such pixmap will be blended over
169transparency image, using method specified. Supported values are :
170B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
171B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
172B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
173alpha-blending. Compile I<afterimage>; resource I<blendType>.
174
175=item B<-blr> I<HxV>
176
177Apply Gaussian Blur with the specified radii to the transparent
178background image. If single number is specified - both vertical and
179horizontal radii are considered to be the same. Setting one of the
180radii to 1 and another to a large number creates interesting effects
181on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
182resource I<blurRadius>.
183
184=item B<-icon> I<file> 144=item B<-icon> I<file>
185 145
186Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 146Compile I<pixbuf>: Use the specified image as application icon. This
187is used by many window managers, taskbars and pagers to represent the 147is used by many window managers, taskbars and pagers to represent the
188application window; resource I<iconFile>. 148application window; resource I<iconFile>.
189 149
190=item B<-bg> I<colour> 150=item B<-bg> I<colour>
191 151
192Window background colour; resource B<background>. 152Window background colour; resource B<background>.
193 153
194=item B<-fg> I<colour> 154=item B<-fg> I<colour>
195 155
196Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
197
198=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
199
200Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
201optionally specify its scaling with a geometry string. Note you may need to
202add quotes to avoid special shell interpretation of the C<;> in the
203command-line; for more details see resource B<backgroundPixmap>.
204 157
205=item B<-cr> I<colour> 158=item B<-cr> I<colour>
206 159
207The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
208 161
267 220
268=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
269 222
270Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
271 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
272=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
273 230
274Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
275B<utmpInhibit>. 232B<utmpInhibit>.
276 233
354 311
355=item B<-override-redirect> 312=item B<-override-redirect>
356 313
357Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
358B<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.
359 321
360=item B<-sbg> 322=item B<-sbg>
361 323
362Compile 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
363drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
418=item B<-pt> I<style> 380=item B<-pt> I<style>
419 381
420Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
421B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
422 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
423=item B<-im> I<text> 388=item B<-im> I<text>
424 389
425Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
426 391
427=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
568You can set and change the resources using X11 tools like B<xrdb>. Many 533You can set and change the resources using X11 tools like B<xrdb>. Many
569distribution do also load settings from the B<~/.Xresources> file when X 534distribution do also load settings from the B<~/.Xresources> file when X
570starts. @@RXVT_NAME@@ will consult the following files/resources in order, 535starts. @@RXVT_NAME@@ will consult the following files/resources in order,
571with later settings overwriting earlier ones: 536with later settings overwriting earlier ones:
572 537
573 1. system-wide app-defaults file, either locale-dependent OR global
574 2. app-defaults file in $XAPPLRESDIR 538 1. app-defaults file in $XAPPLRESDIR
539 2. $HOME/.Xdefaults
575 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 540 3. RESOURCE_MANAGER property on root-window of screen 0
576 4. SCREEN_RESOURCES for the current screen 541 4. SCREEN_RESOURCES property on root-window of the current screen
577 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 542 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
578 6. resources specified via -xrm on the commandline 543 6. resources specified via -xrm on the commandline
579 544
580Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 545Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
581names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 546names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
697 662
698B<False>: specify that everything is to be displayed, even 663B<False>: specify that everything is to be displayed, even
699if the refresh is too fast for the human eye to read anything (or the 664if the refresh is too fast for the human eye to read anything (or the
700monitor to display anything); option B<+ss>. 665monitor to display anything); option B<+ss>.
701 666
702=item B<transparent:> I<boolean>
703
704Turn on/off illusion of a transparent window background.
705
706B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
707future versions.
708
709=item B<fading:> I<number> 667=item B<fading:> I<number>
710 668
711Fade the text by the given percentage when focus is lost; option B<-fade>. 669Fade the text by the given percentage when focus is lost; option B<-fade>.
712 670
713=item B<fadeColor:> I<colour> 671=item B<fadeColor:> I<colour>
714 672
715Fade to this colour, when fading is used (see B<fading:>). The default 673Fade to this colour, when fading is used (see B<fading:>). The default
716colour is black; option B<-fadecolor>. 674colour is black; option B<-fadecolor>.
717 675
718=item B<tintColor:> I<colour>
719
720Tint the transparent background pixmap with the given colour; option
721B<-tint>.
722
723=item B<shading:> I<number>
724
725Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
726in addition to tinting it; option B<-sh>.
727
728=item B<blendType:> I<string>
729
730Specify background blending type; option B<-blt>.
731
732=item B<blurRadius:> I<number>
733
734Apply gaussian blur with the specified radius to the transparent
735background image; option B<-blr>.
736
737=item B<iconFile:> I<file> 676=item B<iconFile:> I<file>
738 677
739Set the application icon pixmap; option B<-icon>. 678Set the application icon pixmap; option B<-icon>.
740 679
741=item B<scrollColor:> I<colour> 680=item B<scrollColor:> I<colour>
749 688
750=item B<borderColor:> I<colour> 689=item B<borderColor:> I<colour>
751 690
752The colour of the border around the text area and between the scrollbar 691The colour of the border around the text area and between the scrollbar
753and the text. 692and the text.
754
755=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
756
757Use the specified image file for the background and also
758optionally specify its scaling with a geometry string B<WxH+X+Y>,
759(default C<100x100+50+50>) in which B<"W" / "H"> specify the
760horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
761centre (percent). A scale of 0 displays the image with tiling.
762The maximum permitted scale is 1000.
763Additional operations can be specified after colon B<:op1:op2...>.
764Supported operations are:
765
766 tile force background image to be tiled and not scaled. Equivalent to 0x0
767 propscale will scale image keeping proportions
768 auto will scale image to match window size. Equivalent to 100x100
769 hscale will scale image horizontally to the window size
770 vscale will scale image vertically to the window size
771 scale will scale image to match window size
772 root will tile image as if it was a root window background, auto-adjusting
773 whenever terminal window moves
774
775If used in conjunction with B<-tr> option, the specified pixmap will be
776blended over transparency image using alpha-blending. If I<afterimage>
777support has been compiled in it is possible to choose other blending
778types with B<-blt "type"> option.
779
780=item B<path:> I<path>
781
782Specify the colon-delimited search path for finding background image files.
783 693
784=item B<font:> I<fontlist> 694=item B<font:> I<fontlist>
785 695
786Select the fonts to be used. This is a comma separated list of font names 696Select the fonts to be used. This is a comma separated list of font names
787that are checked in order when trying to find glyphs for characters. The 697that are checked in order when trying to find glyphs for characters. The
884 794
885B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 795B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
886the shell; option B<-ls>. B<False>: start as a normal sub-shell 796the shell; option B<-ls>. B<False>: start as a normal sub-shell
887[default]; option B<+ls>. 797[default]; option B<+ls>.
888 798
799=item B<multiClickTime:> I<number>
800
801Specify the maximum time in milliseconds between multi-click select
802events. The default is 500 milliseconds; option B<-mc>.
803
889=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
890 805
891B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
892option B<-ut>. B<False>: write record into the system log file B<utmp> 807option B<-ut>. B<False>: write record into the system log file B<utmp>
893[default]; option B<+ut>. 808[default]; option B<+ut>.
910=item B<scrollstyle:> I<mode> 825=item B<scrollstyle:> I<mode>
911 826
912Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 827Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
913the author's favourite. 828the author's favourite.
914 829
830=item B<thickness:> I<number>
831
832Set the scrollbar width in pixels.
833
915=item B<scrollBar:> I<boolean> 834=item B<scrollBar:> I<boolean>
916 835
917B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 836B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
918disable the scrollbar; option B<+sb>. 837disable the scrollbar; option B<+sb>.
919 838
938B<False>: do not scroll to bottom when tty receives output; option 857B<False>: do not scroll to bottom when tty receives output; option
939B<+si>. 858B<+si>.
940 859
941=item B<scrollWithBuffer:> I<boolean> 860=item B<scrollWithBuffer:> I<boolean>
942 861
943B<True>: scroll with scrollback buffer when tty receives new lines (and 862B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
944B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 863try to show the same lines) and B<scrollTtyOutput> is False; option
945with scrollback buffer when tty receives new lines; option B<+sw>. 864B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
865new lines; option B<+sw>.
946 866
947=item B<scrollTtyKeypress:> I<boolean> 867=item B<scrollTtyKeypress:> I<boolean>
948 868
949B<True>: scroll to bottom when a non-special key is pressed. Special keys 869B<True>: scroll to bottom when a non-special key is pressed. Special keys
950are those which are intercepted by rxvt-unicode for special handling and 870are those which are intercepted by rxvt-unicode for special handling and
1060 980
1061B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 981B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1062 982
1063=item B<preeditType:> I<style> 983=item B<preeditType:> I<style>
1064 984
1065B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 985B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1066 986
1067=item B<inputMethod:> I<name> 987=item B<inputMethod:> I<name>
1068 988
1069I<name> of inputMethod to use; option B<-im>. 989I<name> of inputMethod to use; option B<-im>.
1070 990
1139Sets the working directory for the shell (or the command specified via 1059Sets the working directory for the shell (or the command specified via
1140B<-e>). The I<path> must be an absolute path and it must exist for 1060B<-e>). The I<path> must be an absolute path and it must exist for
1141@@RXVT_NAME@@ to start. If it isn't specified then the current working 1061@@RXVT_NAME@@ to start. If it isn't specified then the current working
1142directory will be used; option B<-cd>. 1062directory will be used; option B<-cd>.
1143 1063
1144=item B<keysym.>I<sym>: I<string> 1064=item B<keysym.>I<sym>: I<action>
1145 1065
1146Compile I<frills>: Associate I<string> with keysym I<sym>. The 1066Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1147intervening resource name B<keysym.> cannot be omitted. 1067resource name B<keysym.> cannot be omitted.
1148 1068
1149The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1069Using this resource, you can map key combinations such as
1150any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1070C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1151B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1071string than would normally result from that combination, making the
1152and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1072terminal scroll up or down the way you want it, or any other thing an
1153B<2>, B<3>, B<4>, B<5>. 1073extension might provide.
1074
1075The key combination that triggers the action, I<sym>, has the following format:
1076
1077 (modifiers-)key
1078
1079Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1080B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1081B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1082B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1154 1083
1155The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1084The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1156whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1085whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1157keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1086keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1158current application keymap mode state. 1087current application keymap mode state.
1159 1088
1160The spellings of I<key> can be obtained by using B<xev>(1) command or 1089Due the the large number of modifier combinations, a key mapping will
1161searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1090match if I<at least> the specified identifiers are being set, and no other
1091key mappings with those and more bits are being defined. That means that
1092defining a mapping for C<a> will automatically provide definitions for
1093C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1094themselves. See the C<builtin:> action, below, for a way to work around
1095this when this is a problem.
1096
1097The spelling of I<key> depends on your implementation of X. An easy way to
1098find a key name is to use the B<xev>(1) command. You can find a list by
1099looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1162omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1100the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1163keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1101value (B<0x0000 - 0xFFFF>).
1164performed in an exact manner; however, the closest match is assured.
1165 1102
1166I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1103As with any resource value, the I<action> string may contain backslash
1104escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1167number), see RESOURCES in C<man 7 X> for further details. 1105number), see RESOURCES in C<man 7 X> for further details.
1168 1106
1169You can define a range of keysyms in one shot by providing a I<string> 1107An action starts with an action prefix that selects a certain type
1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1108of action, followed by a colon. An action string without colons is
1109interpreted as a literal string to pass to the tty (as if it was
1110prefixed with C<string:>).
1111
1112The following action prefixes are known - extensions can provide
1113additional prefixes:
1114
1115=over 4
1116
1117=item string:STRING
1118
1119If the I<action> starts with C<string:> (or otherwise contains no colons),
1120then the remaining C<STRING> will be passed to the program running in the
1121terminal. For example, you could replace whatever Shift-Tab outputs by the
1122string C<echo rm -rf /> followed by a newline:
1123
1124 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1125
1126This could in theory be used to completely redefine your keymap.
1127
1128In addition, for actions of this type, you can define a range of
1129keysyms in one shot by loading the C<keysym-list> perl extension and
1130providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1171should be a character not used by the strings. 1131the delimiter `/' should be a character not used by the strings.
1172 1132
1173Its usage can be demonstrated by an example: 1133Its usage can be demonstrated by an example:
1174 1134
1175 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1135 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1176 1136
1177The above line is equivalent to the following three lines: 1137The above line is equivalent to the following three lines:
1178 1138
1179 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1139 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1180 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1140 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1181 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1141 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1182 1142
1143=item command:STRING
1144
1183If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1145If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1184is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1146is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1147the opposite of C<string:> - instead of sending it to the program running
1148in the terminal, it will be treated as if it were program output). This is
1149most useful to feed command sequences into @@RXVT_NAME@@.
1150
1185example the following means "change the current locale to C<zh_CN.GBK> 1151For example the following means "change the current locale to C<zh_CN.GBK>
1186when Control-Meta-c is being pressed": 1152when Control-Meta-c is being pressed":
1187 1153
1188 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1154 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1189 1155
1190If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1156The following example will map Control-Meta-1 and Control-Meta-2 to
1191is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1157the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1192manpage. For example, the F<selection> extension (activated via 1158font-switching at runtime:
1193C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1194 1159
1195 URxvt.keysym.M-C-c: perl:selection:rot13 1160 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1161 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1196 1162
1197Due the the large number of modifier combinations, a defined key mapping 1163Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1198will match if I<at least> the specified identifiers are being set, and 1164info):
1199no other key mappings with those and more bits are being defined. That
1200means that defining a key map for C<a> will automatically provide
1201definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1202mappings themselves.
1203 1165
1204Unfortunately, this will override built-in key mappings. For example 1166 URxvt.keysym.M-C-3: command:\033[8;25;80t
1167 URxvt.keysym.M-C-4: command:\033[8;48;110t
1168
1169=item builtin:
1170
1171The builtin action is the action that @@RXVT_NAME@@ would execute if no
1172key binding existed for the key combination. The obvious use is to undo
1173the effect of existing bindings. The not so obvious use is to reinstate
1174bindings when another binding overrides too many modifiers.
1175
1205if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1176For example if you overwrite the C<Insert> key you will disable
1206C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1177@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1207user-defined keymap using the C<builtin:> replacement: 1178"holes" into the user-defined keymap using the C<builtin:> replacement:
1208 1179
1209 URxvt.keysym.Insert: <my insert key sequence> 1180 URxvt.keysym.Insert: <my insert key sequence>
1210 URxvt.keysym.S-Insert: builtin: 1181 URxvt.keysym.S-Insert: builtin:
1211 1182
1212The first line defines a mapping for C<Insert> and I<any> combination 1183The first line defines a mapping for C<Insert> and I<any> combination
1213of modifiers. The second line re-establishes the default mapping for 1184of modifiers. The second line re-establishes the default mapping for
1214C<Shift-Insert>. 1185C<Shift-Insert>.
1215 1186
1216The following example will map Control-Meta-1 and Control-Meta-2 to 1187=item builtin-string:
1217the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1218font-switching at runtime:
1219 1188
1220 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1189This action is mainly useful to restore string mappings for keys that
1221 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1190have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1191difficult to explain - basically, this action will send the string to the
1192application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1193action for it.
1222 1194
1223Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1195An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1224info): 1196selection when you press C<Shift-Insert>. With the following bindings, it
1197would instead emit the (undocumented, but what applications running in the
1198terminal might expect) sequence C<ESC [ 2 $> instead:
1225 1199
1226 URxvt.keysym.M-C-3: command:\033[8;25;80t 1200 URxvt.keysym.S-Insert: builtin-string:
1227 URxvt.keysym.M-C-4: command:\033[8;48;110t 1201 URxvt.keysym.C-S-Insert: builtin:
1202
1203The first line disables the paste functionality for that key
1204combination, and the second reinstates the default behaviour for
1205C<Control-Shift-Insert>, which would otherwise be overridden.
1206
1207Similarly, to let applications gain access to the C<C-M-c> (copy to
1208clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1209this:
1210
1211 URxvt.keysym.C-M-c: builtin-string:
1212 URxvt.keysym.C-M-v: builtin-string:
1213
1214=item EXTENSION:STRING
1215
1216An action of this form invokes the action B<STRING>, if any, provided
1217by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1218be loaded automatically if necessary.
1219
1220Not all extensions define actions, but popular extensions that do
1221include the I<selection> and I<matcher> extensions (documented in their
1222own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1223respectively).
1224
1225From the silly examples department, this will rot13-"encrypt"
1226@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1227keyboards:
1228
1229 URxvt.keysym.M-C-c: selection:rot13
1230
1231=item perl:STRING *DEPRECATED*
1232
1233This is a deprecated way of invoking commands provided by perl
1234extensions. It is still supported, but should not be used anymore.
1235
1236=back
1228 1237
1229=item B<perl-ext-common>: I<string> 1238=item B<perl-ext-common>: I<string>
1230 1239
1231=item B<perl-ext>: I<string> 1240=item B<perl-ext>: I<string>
1232 1241
1234use in this terminal instance; option B<-pe>. 1243use in this terminal instance; option B<-pe>.
1235 1244
1236Extension names can be prefixed with a C<-> sign to prohibit using 1245Extension names can be prefixed with a C<-> sign to prohibit using
1237them. This can be useful to selectively disable some extensions loaded 1246them. This can be useful to selectively disable some extensions loaded
1238by default, or specified via the C<perl-ext-common> resource. For 1247by default, or specified via the C<perl-ext-common> resource. For
1239example, C<default,-selection> will use all the default extension except 1248example, C<default,-selection> will use all the default extensions except
1240C<selection>. 1249C<selection>.
1241 1250
1242Extension names can also be followed by an argument in angle brackets 1251The default set includes the C<selection>, C<option-popup>,
1243(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1252C<selection-popup>, C<readline> and C<searchable-scrollback>
1244searchable scrollback to Alt/Meta-s). Mentioning the same extension 1253extensions, and extensions which are mentioned in B<keysym> resources.
1245multiple times with different arguments will pass multiple arguments to 1254
1246the extension. 1255Any extension such that a corresponding resource is given on the
1256command line is automatically appended to B<perl-ext>.
1247 1257
1248Each extension is looked up in the library directories, loaded if 1258Each extension is looked up in the library directories, loaded if
1249necessary, and bound to the current terminal instance. 1259necessary, and bound to the current terminal instance. When the library
1260search path contains multiple extension files of the same name, then the
1261first one found will be used.
1250 1262
1251If both of these resources are the empty string, then the perl 1263If both of these resources are the empty string, then the perl interpreter
1252interpreter will not be initialized. The idea behind two options is that 1264will not be initialized. The rationale for having two options is that
1253B<perl-ext-common> will be used for extensions that should be available to 1265B<perl-ext-common> will be used for extensions that should be available to
1254all instances, while B<perl-ext> is used for specific instances. 1266all instances, while B<perl-ext> is used for specific instances.
1255 1267
1256=item B<perl-eval>: I<string> 1268=item B<perl-eval>: I<string>
1257 1269
1259the @@RXVT_NAME@@perl(3) manpage. 1271the @@RXVT_NAME@@perl(3) manpage.
1260 1272
1261=item B<perl-lib>: I<path> 1273=item B<perl-lib>: I<path>
1262 1274
1263Colon-separated list of additional directories that hold extension 1275Colon-separated list of additional directories that hold extension
1264scripts. When looking for extensions specified by the C<perl> resource, 1276scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1265@@RXVT_NAME@@ will first look in these directories and then in 1277in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1266F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1278lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1267 1279
1268See the @@RXVT_NAME@@perl(3) manpage. 1280See the @@RXVT_NAME@@perl(3) manpage.
1269 1281
1270=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1282=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1271 1283
1275=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1287=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1276 1288
1277Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1289Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1278for details. 1290for details.
1279 1291
1280=item B<searchable-scrollback:> I<keysym> 1292=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1281 1293
1282Sets the hotkey that starts the incremental scrollback buffer search 1294This resource is deprecated and will be removed. Use a B<keysym> resource
1283(default: C<M-s>). 1295instead, e.g.:
1284 1296
1297 URxvt.keysym.M-s: searchable-scrollback:start
1298
1285=item B<urlLauncher>: I<string> 1299=item B<url-launcher>: I<string>
1286 1300
1287Specifies the program to be started with a URL argument. Used by the 1301Specifies the program to be started with a URL argument. Used by the
1288C<selection-popup> and C<matcher> perl extensions. 1302C<selection-popup> and C<matcher> perl extensions.
1289 1303
1290=item B<transient-for>: I<windowid> 1304=item B<transient-for>: I<windowid>
1301Turn on/off ISO 14755 (default enabled). 1315Turn on/off ISO 14755 (default enabled).
1302 1316
1303=item B<iso14755_52:> I<boolean> 1317=item B<iso14755_52:> I<boolean>
1304 1318
1305Turn on/off ISO 14755 5.2 mode (default enabled). 1319Turn on/off ISO 14755 5.2 mode (default enabled).
1320
1321=back
1322
1323=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1324
1325=over 4
1326
1327=item B<-pixmap> I<file[;oplist]>
1328
1329=item B<backgroundPixmap:> I<file[;oplist]>
1330
1331Compile I<pixbuf>: Use the specified image file as the window's
1332background and also optionally specify a colon separated list of
1333operations to modify it. Note that you may need to quote the C<;>
1334character when using the command line option, as C<;> is usually a
1335metacharacter in shells. Supported operations are:
1336
1337=over 4
1338
1339=item B<WxH+X+Y>
1340
1341sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1342scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1343scale of 0 disables scaling.
1344
1345=item B<op=tile>
1346
1347enables tiling
1348
1349=item B<op=keep-aspect>
1350
1351maintain the image aspect ratio when scaling
1352
1353=item B<op=root-align>
1354
1355use the position of the terminal window relative to the root window as
1356the image offset, simulating a root window background
1357
1358=back
1359
1360The default scale and position setting is C<100x100+50+50>.
1361Alternatively, a predefined set of templates can be used to achieve
1362the most common setups:
1363
1364=over 4
1365
1366=item B<style=tiled>
1367
1368the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1369
1370=item B<style=aspect-stretched>
1371
1372the image is scaled to fill the whole window maintaining the aspect
1373ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1374
1375=item B<style=stretched>
1376
1377the image is scaled to fill the whole window. Equivalent to 100x100
1378
1379=item B<style=centered>
1380
1381the image is centered with no scaling. Equivalent to 0x0+50+50
1382
1383=item B<style=root-tiled>
1384
1385the image is tiled with no scaling and using 'root' positioning.
1386Equivalent to 0x0:op=tile:op=root-align
1387
1388=back
1389
1390If multiple templates are specified the last one wins. Note that a
1391template overrides all the scale, position and operations settings.
1392
1393If used in conjunction with pseudo-transparency, the specified pixmap
1394will be blended over the transparent background using alpha-blending.
1395
1396=item B<-tr>|B<+tr>
1397
1398=item B<transparent:> I<boolean>
1399
1400Turn on/off pseudo-transparency by using the root pixmap as background.
1401
1402B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1403will be removed in future versions.
1404
1405=item B<-tint> I<colour>
1406
1407=item B<tintColor:> I<colour>
1408
1409Tint the transparent background with the given colour. Note that a
1410black tint yields a completely black image while a white tint yields
1411the image unchanged.
1412
1413=item B<-sh> I<number>
1414
1415=item B<shading:> I<number>
1416
1417Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1418A value of 100 means no shading.
1419
1420=item B<-blr> I<HxV>
1421
1422=item B<blurRadius:> I<HxV>
1423
1424Apply gaussian blur with the specified radius to the transparent
1425background. If a single number is specified, the vertical and
1426horizontal radii are considered to be the same. Setting one of the
1427radii to 1 and the other to a large number creates interesting effects
1428on some backgrounds. The maximum radius value is 128. An horizontal or
1429vertical radius of 0 disables blurring.
1430
1431=item B<path:> I<path>
1432
1433Specify the colon-delimited search path for finding background image files.
1306 1434
1307=back 1435=back
1308 1436
1309=head1 THE SCROLLBAR 1437=head1 THE SCROLLBAR
1310 1438
1358window causes the value of the PRIMARY selection (or CLIPBOARD with the 1486window causes the value of the PRIMARY selection (or CLIPBOARD with the
1359B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1487B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1360 1488
1361Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1489Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1362inserted too. 1490inserted too.
1491
1492rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1493<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1494binding causes the value of the internal selection to be copied to the
1495CLIPBOARD selection, while the second binding causes the value of the
1496CLIPBOARD selection to be inserted.
1363 1497
1364=back 1498=back
1365 1499
1366=head1 CHANGING FONTS 1500=head1 CHANGING FONTS
1367 1501
1492The following text gives values for the standard 88 colour mode (and 1626The following text gives values for the standard 88 colour mode (and
1493values for the 256 colour mode in parentheses). 1627values for the 256 colour mode in parentheses).
1494 1628
1495The RGB cube uses indices 16..79 (16..231) using the following formulas: 1629The RGB cube uses indices 16..79 (16..231) using the following formulas:
1496 1630
1497 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1631 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1498 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1632 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1499 1633
1500The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1634The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1501steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1635steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1502the RGB cube. 1636the RGB cube.
1503 1637
1519White. 1653White.
1520 1654
1521=head2 ALPHA CHANNEL SUPPORT 1655=head2 ALPHA CHANNEL SUPPORT
1522 1656
1523If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1657If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1524their act together, rxvt-unicode will do it's own alpha channel management: 1658their act together, rxvt-unicode will do its own alpha channel management:
1525 1659
1526You can prefix any colour with an opaqueness percentage enclosed in 1660You can prefix any colour with an opaqueness percentage enclosed in
1527brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1661brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1528(0-100) that specifies the opacity of the colour, where C<0> is completely 1662(0-100) that specifies the opacity of the colour, where C<0> is completely
1529transparent and C<100> is completely opaque. For example, C<[50]red> is a 1663transparent and C<100> is completely opaque. For example, C<[50]red> is a
1611 1745
1612=item B<SHELL> 1746=item B<SHELL>
1613 1747
1614The shell to be used for command execution, defaults to C</bin/sh>. 1748The shell to be used for command execution, defaults to C</bin/sh>.
1615 1749
1616=item B<RXVT_SOCKET> 1750=item B<RXVT_SOCKET> [I<sic>]
1617 1751
1618The unix domain socket path used by @@RXVT_NAME@@c(1) and 1752The unix domain socket path used by @@RXVT_NAME@@c(1) and
1619@@RXVT_NAME@@d(1). 1753@@RXVT_NAME@@d(1).
1620 1754
1621Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1755Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1756
1757=item B<URXVT_PERL_LIB>
1758
1759Additional F<:>-separated library search path for perl extensions. Will be
1760searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1761directory.
1762
1763=item B<URXVT_PERL_VERBOSITY>
1764
1765See L<@@RXVT_NAME@@perl>(3).
1622 1766
1623=item B<HOME> 1767=item B<HOME>
1624 1768
1625Used to locate the default directory for the unix domain socket for 1769Used to locate the default directory for the unix domain socket for
1626daemon communications and to locate various resource files (such as 1770daemon communications and to locate various resource files (such as
1627C<.Xdefaults>) 1771C<.Xdefaults>)
1628 1772
1629=item B<XAPPLRESDIR> 1773=item B<XAPPLRESDIR>
1630 1774
1631Directory where various X resource files are being located. 1775Directory where application-specific X resource files are located.
1632 1776
1633=item B<XENVIRONMENT> 1777=item B<XENVIRONMENT>
1634 1778
1635If set and accessible, gives the name of a X resource file to be loaded by 1779If set and accessible, gives the name of a X resource file to be loaded by
1636@@RXVT_NAME@@. 1780@@RXVT_NAME@@.
1647 1791
1648=back 1792=back
1649 1793
1650=head1 SEE ALSO 1794=head1 SEE ALSO
1651 1795
1796@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1652@@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) 1797@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1653 1798
1654=head1 CURRENT PROJECT COORDINATOR 1799=head1 CURRENT PROJECT COORDINATOR
1655 1800
1656=over 4 1801=over 4
1657 1802
1658=item Project Coordinator 1803=item Project Coordinator
1659 1804
1660Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1805Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1661 1806
1662L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1807L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1663 1808
1664=back 1809=back
1665 1810
1669 1814
1670=item John Bovey 1815=item John Bovey
1671 1816
1672University of Kent, 1992, wrote the original Xvt. 1817University of Kent, 1992, wrote the original Xvt.
1673 1818
1674=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1819=item Rob Nation <nation@rocket.sanders.lockheed.com>
1675 1820
1676very heavily modified Xvt and came up with Rxvt 1821very heavily modified Xvt and came up with Rxvt
1677 1822
1678=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1823=item Angelo Haritsis <ah@doc.ic.ac.uk>
1679 1824
1680wrote the Greek Keyboard Input (no longer in code) 1825wrote the Greek Keyboard Input (no longer in code)
1681 1826
1682=item mj olesen L<< <olesen@me.QueensU.CA> >> 1827=item mj olesen <olesen@me.QueensU.CA>
1683 1828
1684Wrote the menu system. 1829Wrote the menu system.
1685 1830
1686Project Coordinator (changes.txt 2.11 to 2.21) 1831Project Coordinator (changes.txt 2.11 to 2.21)
1687 1832
1688=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1833=item Oezguer Kesim <kesim@math.fu-berlin.de>
1689 1834
1690Project Coordinator (changes.txt 2.21a to 2.4.5) 1835Project Coordinator (changes.txt 2.21a to 2.4.5)
1691 1836
1692=item Geoff Wing L<< <gcw@pobox.com> >> 1837=item Geoff Wing <gcw@pobox.com>
1693 1838
1694Rewrote screen display and text selection routines. 1839Rewrote screen display and text selection routines.
1695 1840
1696Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1841Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1697 1842
1698=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1843=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1699 1844
1700Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1845Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1701extension, random hacks, numerous bugfixes and extensions. 1846extension, random hacks, numerous bugfixes and extensions.
1702 1847
1703Project Coordinator (Changes 1.0 -) 1848Project Coordinator (Changes 1.0 -)
1704 1849
1705=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1850=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1706 1851
1707Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1852pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1708 1853
1709=back 1854=back
1710 1855

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines