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.196 by root, Fri May 6 10:18:00 2011 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 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[;geom[:op1][:op2][...]]>
189
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191optionally specify its scaling with a geometry string. 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
408=item B<-pt> I<style> 380=item B<-pt> I<style>
409 381
410Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
411B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
412 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
413=item B<-im> I<text> 388=item B<-im> I<text>
414 389
415Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
416 391
417=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
431Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
432button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
433in-use. Instead of selecting a full line it will extend the selection to 408in-use. Instead of selecting a full line it will extend the selection to
434the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
435 410
411=item B<-dpb>|B<+dpb>
412
413Compile frills: Disable (or enable) emitting bracketed paste mode
414sequences (default enabled). Bracketed paste mode allows programs
415to detect when something is pasted. Since more and more programs
416abuse this, these sequences can be disabled. The command sequences to
417enable and query paste mode will still work, but the actual bracket
418sequences will no longer be emitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
420
436=item B<-insecure> 421=item B<-insecure>
437 422
438Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
439sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
440info. 425info.
452 437
453=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
454 439
455Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
456B<secondaryScroll>. 441B<secondaryScroll>.
442
443=item B<-rm> I<mode>
444
445Compile I<frills>: Sets long line rewrapping behaviour on window resizes
446to one of B<auto> (the default), B<always> or B<never>. The latter two
447modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
448is non-empty, and wings lines (acts like B<never>) otherwise; resource
449B<rewrapMode>.
457 450
458=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
459 452
460Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
461will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
687 680
688B<False>: specify that everything is to be displayed, even 681B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the 682if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>. 683monitor to display anything); option B<+ss>.
691 684
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> 685=item B<fading:> I<number>
700 686
701Fade the text by the given percentage when focus is lost; option B<-fade>. 687Fade the text by the given percentage when focus is lost; option B<-fade>.
702 688
703=item B<fadeColor:> I<colour> 689=item B<fadeColor:> I<colour>
704 690
705Fade to this colour, when fading is used (see B<fading:>). The default 691Fade to this colour, when fading is used (see B<fading:>). The default
706colour is black; option B<-fadecolor>. 692colour is black; option B<-fadecolor>.
707 693
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> 694=item B<iconFile:> I<file>
731 695
732Set the application icon pixmap; option B<-icon>. 696Set the application icon pixmap; option B<-icon>.
733 697
734=item B<scrollColor:> I<colour> 698=item B<scrollColor:> I<colour>
742 706
743=item B<borderColor:> I<colour> 707=item B<borderColor:> I<colour>
744 708
745The colour of the border around the text area and between the scrollbar 709The colour of the border around the text area and between the scrollbar
746and the text. 710and the text.
747
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
749
750Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>,
752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
754centre (percent). A scale of 0 displays the image with tiling.
755The maximum permitted scale is 1000.
756Additional operations can be specified after colon B<:op1:op2...>.
757Supported operations are:
758
759 tile force background image to be tiled and not scaled. Equivalent to 0x0
760 propscale will scale image keeping proportions
761 auto will scale image to match window size. Equivalent to 100x100
762 hscale will scale image horizontally to the window size
763 vscale will scale image vertically to the window size
764 scale will scale image to match window size
765 root will tile image as if it was a root window background, auto-adjusting
766 whenever terminal window moves
767
768If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
772
773=item B<path:> I<path>
774
775Specify the colon-delimited search path for finding background image files.
776 711
777=item B<font:> I<fontlist> 712=item B<font:> I<fontlist>
778 713
779Select the fonts to be used. This is a comma separated list of font names 714Select the fonts to be used. This is a comma separated list of font names
780that are checked in order when trying to find glyphs for characters. The 715that are checked in order when trying to find glyphs for characters. The
877 812
878B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 813B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
879the shell; option B<-ls>. B<False>: start as a normal sub-shell 814the shell; option B<-ls>. B<False>: start as a normal sub-shell
880[default]; option B<+ls>. 815[default]; option B<+ls>.
881 816
817=item B<multiClickTime:> I<number>
818
819Specify the maximum time in milliseconds between multi-click select
820events. The default is 500 milliseconds; option B<-mc>.
821
882=item B<utmpInhibit:> I<boolean> 822=item B<utmpInhibit:> I<boolean>
883 823
884B<True>: inhibit writing record into the system log file B<utmp>; 824B<True>: inhibit writing record into the system log file B<utmp>;
885option B<-ut>. B<False>: write record into the system log file B<utmp> 825option B<-ut>. B<False>: write record into the system log file B<utmp>
886[default]; option B<+ut>. 826[default]; option B<+ut>.
949are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 889are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
950bottom when a non-special key is pressed; option B<+sk>. 890bottom when a non-special key is pressed; option B<+sk>.
951 891
952=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
953 893
954Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
955resource is limited on most machines to 65535; option B<-sl>.
956 895
957=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
958 897
959Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
960option B<-b>. 899option B<-b>.
1023 962
1024=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
1025 964
1026Mouse pointer background colour. 965Mouse pointer background colour.
1027 966
967=item B<pointerShape:> I<string>
968
969Compile I<frills>: Specifies the name of the mouse pointer shape
970[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
971file for possible values (omit the C<XC_> prefix).
972
1028=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
1029 974
1030Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
1031large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
1032 977
1058 1003
1059B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1060 1005
1061=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
1062 1007
1063B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1064 1009
1065=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
1066 1011
1067I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
1068 1013
1086 1031
1087Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1088button. Instead of selecting a full line it will extend the selection to 1033button. Instead of selecting a full line it will extend the selection to
1089the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1090 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
1091=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1092 1041
1093Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1094echo arbitrary strings like the icon name or the locale. This could be 1043echo arbitrary strings like the icon name or the locale. This could be
1095abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1096through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1097write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1098default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
1116 1065
1117=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1118 1067
1119Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1120 1069
1070=item B<rewrapMode:> I<mode>
1071
1072Sets long line rewrap behaviour on window resize to one of B<auto>
1073(default), B<always> or B<never>.
1074
1121=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1122 1076
1123Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1124option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1125scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
1137Sets the working directory for the shell (or the command specified via 1091Sets the working directory for the shell (or the command specified via
1138B<-e>). The I<path> must be an absolute path and it must exist for 1092B<-e>). The I<path> must be an absolute path and it must exist for
1139@@RXVT_NAME@@ to start. If it isn't specified then the current working 1093@@RXVT_NAME@@ to start. If it isn't specified then the current working
1140directory will be used; option B<-cd>. 1094directory will be used; option B<-cd>.
1141 1095
1142=item B<keysym.>I<sym>: I<string> 1096=item B<keysym.>I<sym>: I<action>
1143 1097
1144Compile I<frills>: Associate I<string> with keysym I<sym>. The 1098Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1145intervening resource name B<keysym.> cannot be omitted. 1099resource name B<keysym.> cannot be omitted.
1146 1100
1147The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1101Using this resource, you can map key combinations such as
1148any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1102C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1149B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1103string than would normally result from that combination, making the
1150and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1104terminal scroll up or down the way you want it, or any other thing an
1151B<2>, B<3>, B<4>, B<5>. 1105extension might provide.
1106
1107The key combination that triggers the action, I<sym>, has the following format:
1108
1109 (modifiers-)key
1110
1111Where I<modifiers> can be any combination of the following full or
1112abbreviated modifier names:
1113
1114=begin table
1115
1116 B<ISOLevel3> B<I>
1117 B<AppKeypad> B<K>
1118 B<Control> B<C>
1119 B<NumLock> B<N>
1120 B<Shift> B<S>
1121 B<Meta> B<M> I<or> B<A>
1122 B<Lock> B<L>
1123 B<Mod1> B<1>
1124 B<Mod2> B<2>
1125 B<Mod3> B<3>
1126 B<Mod4> B<4>
1127 B<Mod5> B<5>
1128
1129=end table
1152 1130
1153The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1131The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1154whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1132whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1155keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1133keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1156current application keymap mode state. 1134current application keymap mode state.
1157 1135
1158The spellings of I<key> can be obtained by using B<xev>(1) command or 1136Due the the large number of modifier combinations, a key mapping will
1159searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1137match if I<at least> the specified identifiers are being set, and no other
1138key mappings with those and more bits are being defined. That means that
1139defining a mapping for C<a> will automatically provide definitions for
1140C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1141themselves. See the C<builtin:> action, below, for a way to work around
1142this when this is a problem.
1143
1144The spelling of I<key> depends on your implementation of X. An easy way to
1145find a key name is to use the B<xev>(1) command. You can find a list by
1146looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1160omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1147the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1161keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1148value (B<0x0000 - 0xFFFF>).
1162performed in an exact manner; however, the closest match is assured.
1163 1149
1164I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1150As with any resource value, the I<action> string may contain backslash
1151escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1165number), see RESOURCES in C<man 7 X> for further details. 1152number), see RESOURCES in C<man 7 X> for further details.
1166 1153
1154An action starts with an action prefix that selects a certain type
1155of action, followed by a colon. An action string without colons is
1156interpreted as a literal string to pass to the tty (as if it was
1157prefixed with C<string:>).
1158
1159The following action prefixes are known - extensions can provide
1160additional prefixes:
1161
1162=over 4
1163
1164=item string:STRING
1165
1166If the I<action> starts with C<string:> (or otherwise contains no colons),
1167then the remaining C<STRING> will be passed to the program running in the
1168terminal. For example, you could replace whatever Shift-Tab outputs by the
1169string C<echo rm -rf /> followed by a newline:
1170
1171 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1172
1173This could in theory be used to completely redefine your keymap.
1174
1175In addition, for actions of this type, you can define a range of
1176keysyms in one shot by loading the C<keysym-list> perl extension and
1177providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1178the delimiter `/' should be a character not used by the strings.
1179
1180Its usage can be demonstrated by an example:
1181
1182 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1183
1184The above line is equivalent to the following three lines:
1185
1186 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1187 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1188 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1189
1190=item command:STRING
1191
1167If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1192If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1168is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1193is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1194the opposite of C<string:> - instead of sending it to the program running
1195in the terminal, it will be treated as if it were program output). This is
1196most useful to feed command sequences into @@RXVT_NAME@@.
1197
1169example the following means "change the current locale to C<zh_CN.GBK> 1198For example the following means "change the current locale to C<zh_CN.GBK>
1170when Control-Meta-c is being pressed": 1199when Control-Meta-c is being pressed":
1171 1200
1172 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1201 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1173 1202
1174If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1203The following example will map Control-Meta-1 and Control-Meta-2 to
1175is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1204the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1176manpage. For example, the F<selection> extension (activated via 1205font-switching at runtime:
1177C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1178 1206
1179 URxvt.keysym.M-C-c: perl:selection:rot13 1207 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1208 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1180 1209
1181Due the the large number of modifier combinations, a defined key mapping 1210Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1182will match if I<at least> the specified identifiers are being set, and 1211info):
1183no other key mappings with those and more bits are being defined. That
1184means that defining a key map for C<a> will automatically provide
1185definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1186mappings themselves.
1187 1212
1188Unfortunately, this will override built-in key mappings. For example 1213 URxvt.keysym.M-C-3: command:\033[8;25;80t
1214 URxvt.keysym.M-C-4: command:\033[8;48;110t
1215
1216=item builtin:
1217
1218The builtin action is the action that @@RXVT_NAME@@ would execute if no
1219key binding existed for the key combination. The obvious use is to undo
1220the effect of existing bindings. The not so obvious use is to reinstate
1221bindings when another binding overrides too many modifiers.
1222
1189if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1223For example if you overwrite the C<Insert> key you will disable
1190C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1224@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1191user-defined keymap using the C<builtin:> replacement: 1225"holes" into the user-defined keymap using the C<builtin:> replacement:
1192 1226
1193 URxvt.keysym.Insert: <my insert key sequence> 1227 URxvt.keysym.Insert: <my insert key sequence>
1194 URxvt.keysym.S-Insert: builtin: 1228 URxvt.keysym.S-Insert: builtin:
1195 1229
1196The first line defines a mapping for C<Insert> and I<any> combination 1230The first line defines a mapping for C<Insert> and I<any> combination
1197of modifiers. The second line re-establishes the default mapping for 1231of modifiers. The second line re-establishes the default mapping for
1198C<Shift-Insert>. 1232C<Shift-Insert>.
1199 1233
1200The following example will map Control-Meta-1 and Control-Meta-2 to 1234=item builtin-string:
1201the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1202font-switching at runtime:
1203 1235
1204 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1236This action is mainly useful to restore string mappings for keys that
1205 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1237have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1238difficult to explain - basically, this action will send the string to the
1239application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1240action for it.
1206 1241
1207Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1242An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1208info): 1243selection when you press C<Shift-Insert>. With the following bindings, it
1244would instead emit the (undocumented, but what applications running in the
1245terminal might expect) sequence C<ESC [ 2 $> instead:
1209 1246
1210 URxvt.keysym.M-C-3: command:\033[8;25;80t 1247 URxvt.keysym.S-Insert: builtin-string:
1211 URxvt.keysym.M-C-4: command:\033[8;48;110t 1248 URxvt.keysym.C-S-Insert: builtin:
1249
1250The first line disables the paste functionality for that key
1251combination, and the second reinstates the default behaviour for
1252C<Control-Shift-Insert>, which would otherwise be overridden.
1253
1254Similarly, to let applications gain access to the C<C-M-c> (copy to
1255clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1256this:
1257
1258 URxvt.keysym.C-M-c: builtin-string:
1259 URxvt.keysym.C-M-v: builtin-string:
1260
1261=item EXTENSION:STRING
1262
1263An action of this form invokes the action B<STRING>, if any, provided
1264by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1265be loaded automatically if necessary.
1266
1267Not all extensions define actions, but popular extensions that do
1268include the I<selection> and I<matcher> extensions (documented in their
1269own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1270respectively).
1271
1272From the silly examples department, this will rot13-"encrypt"
1273@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1274keyboards:
1275
1276 URxvt.keysym.M-C-c: selection:rot13
1277
1278=item perl:STRING *DEPRECATED*
1279
1280This is a deprecated way of invoking commands provided by perl
1281extensions. It is still supported, but should not be used anymore.
1282
1283=back
1212 1284
1213=item B<perl-ext-common>: I<string> 1285=item B<perl-ext-common>: I<string>
1214 1286
1215=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1216 1288
1218use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1219 1291
1220Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to prohibit using
1221them. This can be useful to selectively disable some extensions loaded 1293them. This can be useful to selectively disable some extensions loaded
1222by default, or specified via the C<perl-ext-common> resource. For 1294by default, or specified via the C<perl-ext-common> resource. For
1223example, C<default,-selection> will use all the default extension except 1295example, C<default,-selection> will use all the default extensions except
1224C<selection>. 1296C<selection>.
1225 1297
1226Extension names can also be followed by an argument in angle brackets 1298The default set includes the C<selection>, C<option-popup>,
1227(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1299C<selection-popup>, C<readline> and C<searchable-scrollback>
1228searchable scrollback to Alt/Meta-s). Mentioning the same extension 1300extensions, and extensions which are mentioned in B<keysym> resources.
1229multiple times with different arguments will pass multiple arguments to 1301
1230the extension. 1302Any extension such that a corresponding resource is given on the
1303command line is automatically appended to B<perl-ext>.
1231 1304
1232Each extension is looked up in the library directories, loaded if 1305Each extension is looked up in the library directories, loaded if
1233necessary, and bound to the current terminal instance. 1306necessary, and bound to the current terminal instance. When the library
1307search path contains multiple extension files of the same name, then the
1308first one found will be used.
1234 1309
1235If both of these resources are the empty string, then the perl 1310If both of these resources are the empty string, then the perl interpreter
1236interpreter will not be initialized. The idea behind two options is that 1311will not be initialized. The rationale for having two options is that
1237B<perl-ext-common> will be used for extensions that should be available to 1312B<perl-ext-common> will be used for extensions that should be available to
1238all instances, while B<perl-ext> is used for specific instances. 1313all instances, while B<perl-ext> is used for specific instances.
1239 1314
1240=item B<perl-eval>: I<string> 1315=item B<perl-eval>: I<string>
1241 1316
1243the @@RXVT_NAME@@perl(3) manpage. 1318the @@RXVT_NAME@@perl(3) manpage.
1244 1319
1245=item B<perl-lib>: I<path> 1320=item B<perl-lib>: I<path>
1246 1321
1247Colon-separated list of additional directories that hold extension 1322Colon-separated list of additional directories that hold extension
1248scripts. When looking for extensions specified by the C<perl> resource, 1323scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1249@@RXVT_NAME@@ will first look in these directories and then in 1324in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1250F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1325lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1251 1326
1252See the @@RXVT_NAME@@perl(3) manpage. 1327See the @@RXVT_NAME@@perl(3) manpage.
1253 1328
1254=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1329=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1255 1330
1259=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1334=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1260 1335
1261Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1336Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1262for details. 1337for details.
1263 1338
1264=item B<searchable-scrollback:> I<keysym> 1339=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1265 1340
1266Sets the hotkey that starts the incremental scrollback buffer search 1341This resource is deprecated and will be removed. Use a B<keysym> resource
1267(default: C<M-s>). 1342instead, e.g.:
1268 1343
1344 URxvt.keysym.M-s: searchable-scrollback:start
1345
1269=item B<urlLauncher>: I<string> 1346=item B<url-launcher>: I<string>
1270 1347
1271Specifies the program to be started with a URL argument. Used by the 1348Specifies the program to be started with a URL argument. Used by the
1272C<selection-popup> and C<matcher> perl extensions. 1349C<selection-popup> and C<matcher> perl extensions.
1273 1350
1274=item B<transient-for>: I<windowid> 1351=item B<transient-for>: I<windowid>
1342window causes the value of the PRIMARY selection (or CLIPBOARD with the 1419window causes the value of the PRIMARY selection (or CLIPBOARD with the
1343B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1420B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1344 1421
1345Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1422Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1346inserted too. 1423inserted too.
1424
1425rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1426<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1427binding causes the value of the internal selection to be copied to the
1428CLIPBOARD selection, while the second binding causes the value of the
1429CLIPBOARD selection to be inserted.
1347 1430
1348=back 1431=back
1349 1432
1350=head1 CHANGING FONTS 1433=head1 CHANGING FONTS
1351 1434
1440In addition to the default foreground and background colours, 1523In addition to the default foreground and background colours,
1441B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1524B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1442high-intensity (potentially bold/blink) versions of the same, and 72 (or 1525high-intensity (potentially bold/blink) versions of the same, and 72 (or
1443240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1526240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1444cube plus a 8 (24) colour greyscale ramp. 1527cube plus a 8 (24) colour greyscale ramp.
1528
1529B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1530C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1531number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1532colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
153324-bit colour space. When indexing collisions happen, the nearest old colour in
1534the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1535use many similar 24-bit colours. It's typically not a problem in common
1536scenarios.
1445 1537
1446Here is a list of the ANSI colours with their names. 1538Here is a list of the ANSI colours with their names.
1447 1539
1448=begin table 1540=begin table
1449 1541
1476The following text gives values for the standard 88 colour mode (and 1568The following text gives values for the standard 88 colour mode (and
1477values for the 256 colour mode in parentheses). 1569values for the 256 colour mode in parentheses).
1478 1570
1479The RGB cube uses indices 16..79 (16..231) using the following formulas: 1571The RGB cube uses indices 16..79 (16..231) using the following formulas:
1480 1572
1481 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1573 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1482 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1574 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1483 1575
1484The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1576The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1485steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1577steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1486the RGB cube. 1578the RGB cube.
1487 1579
1503White. 1595White.
1504 1596
1505=head2 ALPHA CHANNEL SUPPORT 1597=head2 ALPHA CHANNEL SUPPORT
1506 1598
1507If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1599If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1508their act together, rxvt-unicode will do it's own alpha channel management: 1600their act together, rxvt-unicode will do its own alpha channel management:
1509 1601
1510You can prefix any colour with an opaqueness percentage enclosed in 1602You can prefix any colour with an opaqueness percentage enclosed in
1511brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1603brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1512(0-100) that specifies the opacity of the colour, where C<0> is completely 1604(0-100) that specifies the opacity of the colour, where C<0> is completely
1513transparent and C<100> is completely opaque. For example, C<[50]red> is a 1605transparent and C<100> is completely opaque. For example, C<[50]red> is a
1595 1687
1596=item B<SHELL> 1688=item B<SHELL>
1597 1689
1598The shell to be used for command execution, defaults to C</bin/sh>. 1690The shell to be used for command execution, defaults to C</bin/sh>.
1599 1691
1600=item B<RXVT_SOCKET> 1692=item B<RXVT_SOCKET> [I<sic>]
1601 1693
1602The unix domain socket path used by @@RXVT_NAME@@c(1) and 1694The unix domain socket path used by @@RXVT_NAME@@c(1) and
1603@@RXVT_NAME@@d(1). 1695@@RXVT_NAME@@d(1).
1604 1696
1605Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1697Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1698
1699=item B<URXVT_PERL_LIB>
1700
1701Additional F<:>-separated library search path for perl extensions. Will be
1702searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1703directory.
1704
1705=item B<URXVT_PERL_VERBOSITY>
1706
1707See L<@@RXVT_NAME@@perl>(3).
1606 1708
1607=item B<HOME> 1709=item B<HOME>
1608 1710
1609Used to locate the default directory for the unix domain socket for 1711Used to locate the default directory for the unix domain socket for
1610daemon communications and to locate various resource files (such as 1712daemon communications and to locate various resource files (such as
1631 1733
1632=back 1734=back
1633 1735
1634=head1 SEE ALSO 1736=head1 SEE ALSO
1635 1737
1738@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1636@@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) 1739@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1637 1740
1638=head1 CURRENT PROJECT COORDINATOR 1741=head1 CURRENT PROJECT COORDINATOR
1639 1742
1640=over 4 1743=over 4
1641 1744
1642=item Project Coordinator 1745=item Project Coordinator
1643 1746
1644Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1747Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1645 1748
1646L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1749L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1647 1750
1648=back 1751=back
1649 1752
1653 1756
1654=item John Bovey 1757=item John Bovey
1655 1758
1656University of Kent, 1992, wrote the original Xvt. 1759University of Kent, 1992, wrote the original Xvt.
1657 1760
1658=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1761=item Rob Nation <nation@rocket.sanders.lockheed.com>
1659 1762
1660very heavily modified Xvt and came up with Rxvt 1763very heavily modified Xvt and came up with Rxvt
1661 1764
1662=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1765=item Angelo Haritsis <ah@doc.ic.ac.uk>
1663 1766
1664wrote the Greek Keyboard Input (no longer in code) 1767wrote the Greek Keyboard Input (no longer in code)
1665 1768
1666=item mj olesen L<< <olesen@me.QueensU.CA> >> 1769=item mj olesen <olesen@me.QueensU.CA>
1667 1770
1668Wrote the menu system. 1771Wrote the menu system.
1669 1772
1670Project Coordinator (changes.txt 2.11 to 2.21) 1773Project Coordinator (changes.txt 2.11 to 2.21)
1671 1774
1672=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1775=item Oezguer Kesim <kesim@math.fu-berlin.de>
1673 1776
1674Project Coordinator (changes.txt 2.21a to 2.4.5) 1777Project Coordinator (changes.txt 2.21a to 2.4.5)
1675 1778
1676=item Geoff Wing L<< <gcw@pobox.com> >> 1779=item Geoff Wing <gcw@pobox.com>
1677 1780
1678Rewrote screen display and text selection routines. 1781Rewrote screen display and text selection routines.
1679 1782
1680Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1783Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1681 1784
1682=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1785=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1683 1786
1684Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1787Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1685extension, random hacks, numerous bugfixes and extensions. 1788extension, random hacks, numerous bugfixes and extensions.
1686 1789
1687Project Coordinator (Changes 1.0 -) 1790Project Coordinator (Changes 1.0 -)
1688 1791
1689=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1792=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1690 1793
1691pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1794pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1692 1795
1693=back 1796=back
1694 1797

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines