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.201 by sf-exg, Wed Aug 10 07:34:35 2011 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 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: Disables (or enabled) 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 omitted. 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 disables scaling.
755The maximum permitted scale is 1000.
756Additional operations can be specified after colon B<:op1:op2...>.
757Supported operations are:
758
759 tile will tile image
760 propscale will scale image keeping proportions
761 scale will scale image to match window size
762 center will center image with no scaling
763 root will tile image as if it was a root window background, auto-adjusting
764 whenever terminal window moves
765
766If used in conjunction with B<-tr> option, the specified pixmap will be
767blended over the transparent background using alpha-blending. If I<afterimage>
768support has been compiled in it is possible to choose other blending
769types with B<-blt "type"> option.
770
771=item B<path:> I<path>
772
773Specify the colon-delimited search path for finding background image files.
774 711
775=item B<font:> I<fontlist> 712=item B<font:> I<fontlist>
776 713
777Select 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
778that 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
875 812
876B<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
877the 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
878[default]; option B<+ls>. 815[default]; option B<+ls>.
879 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
880=item B<utmpInhibit:> I<boolean> 822=item B<utmpInhibit:> I<boolean>
881 823
882B<True>: inhibit writing record into the system log file B<utmp>; 824B<True>: inhibit writing record into the system log file B<utmp>;
883option 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>
884[default]; option B<+ut>. 826[default]; option B<+ut>.
947are 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
948bottom when a non-special key is pressed; option B<+sk>. 890bottom when a non-special key is pressed; option B<+sk>.
949 891
950=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
951 893
952Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
953resource is limited on most machines to 65535; option B<-sl>.
954 895
955=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
956 897
957Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
958option B<-b>. 899option B<-b>.
1021 962
1022=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
1023 964
1024Mouse pointer background colour. 965Mouse pointer background colour.
1025 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
1026=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
1027 974
1028Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
1029large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
1030 977
1056 1003
1057B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1058 1005
1059=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
1060 1007
1061B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1062 1009
1063=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
1064 1011
1065I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
1066 1013
1083=item B<tripleclickwords:> I<boolean> 1030=item B<tripleclickwords:> I<boolean>
1084 1031
1085Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1086button. 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
1087the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevents emission of paste bracket sequences; option B<-dpb>.
1088 1039
1089=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1090 1041
1091Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
1092echo 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
1114 1065
1115=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1116 1067
1117Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1118 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
1119=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1120 1076
1121Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1122option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1123scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
1135Sets the working directory for the shell (or the command specified via 1091Sets the working directory for the shell (or the command specified via
1136B<-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
1137@@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
1138directory will be used; option B<-cd>. 1094directory will be used; option B<-cd>.
1139 1095
1140=item B<keysym.>I<sym>: I<string> 1096=item B<keysym.>I<sym>: I<action>
1141 1097
1142Compile I<frills>: Associate I<string> with keysym I<sym>. The 1098Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1143intervening resource name B<keysym.> cannot be omitted. 1099resource name B<keysym.> cannot be omitted.
1144 1100
1145The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1101Using this resource, you can map key combinations such as
1146any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1102C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1147B<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
1148and 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
1149B<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
1150 1130
1151The 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
1152whatever 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
1153keys 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
1154current application keymap mode state. 1134current application keymap mode state.
1155 1135
1156The 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
1157searching 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
1158omitting 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
1159keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1148value (B<0x0000 - 0xFFFF>).
1160performed in an exact manner; however, the closest match is assured.
1161 1149
1162I<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
1163number), see RESOURCES in C<man 7 X> for further details. 1152number), see RESOURCES in C<man 7 X> for further details.
1164 1153
1165You can define a range of keysyms in one shot by providing a I<string> 1154An action starts with an action prefix that selects a certain type
1166with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 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
1167should be a character not used by the strings. 1178the delimiter `/' should be a character not used by the strings.
1168 1179
1169Its usage can be demonstrated by an example: 1180Its usage can be demonstrated by an example:
1170 1181
1171 URxvt.keysym.M-C-0x61: list|\033<|abc|> 1182 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1172 1183
1173The above line is equivalent to the following three lines: 1184The above line is equivalent to the following three lines:
1174 1185
1175 URxvt.keysym.Meta-Control-0x61: \033<a> 1186 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1176 URxvt.keysym.Meta-Control-0x62: \033<b> 1187 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1177 URxvt.keysym.Meta-Control-0x63: \033<c> 1188 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1178 1189
1190=item command:STRING
1191
1179If 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>
1180is 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
1181example 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>
1182when Control-Meta-c is being pressed": 1199when Control-Meta-c is being pressed":
1183 1200
1184 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
1185 1202
1186If 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
1187is 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
1188manpage. For example, the F<selection> extension (activated via 1205font-switching at runtime:
1189C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1190 1206
1191 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
1192 1209
1193Due the the large number of modifier combinations, a defined key mapping 1210Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1194will match if I<at least> the specified identifiers are being set, and 1211info):
1195no other key mappings with those and more bits are being defined. That
1196means that defining a key map for C<a> will automatically provide
1197definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1198mappings themselves.
1199 1212
1200Unfortunately, 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
1201if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1223For example if you overwrite the C<Insert> key you will disable
1202C<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
1203user-defined keymap using the C<builtin:> replacement: 1225"holes" into the user-defined keymap using the C<builtin:> replacement:
1204 1226
1205 URxvt.keysym.Insert: <my insert key sequence> 1227 URxvt.keysym.Insert: <my insert key sequence>
1206 URxvt.keysym.S-Insert: builtin: 1228 URxvt.keysym.S-Insert: builtin:
1207 1229
1208The 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
1209of modifiers. The second line re-establishes the default mapping for 1231of modifiers. The second line re-establishes the default mapping for
1210C<Shift-Insert>. 1232C<Shift-Insert>.
1211 1233
1212The following example will map Control-Meta-1 and Control-Meta-2 to 1234=item builtin-string:
1213the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1214font-switching at runtime:
1215 1235
1216 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1236This action is mainly useful to restore string mappings for keys that
1217 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.
1218 1241
1219Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1242An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1220info): 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:
1221 1246
1222 URxvt.keysym.M-C-3: command:\033[8;25;80t 1247 URxvt.keysym.S-Insert: builtin-string:
1223 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
1224 1284
1225=item B<perl-ext-common>: I<string> 1285=item B<perl-ext-common>: I<string>
1226 1286
1227=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1228 1288
1230use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1231 1291
1232Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to prohibit using
1233them. This can be useful to selectively disable some extensions loaded 1293them. This can be useful to selectively disable some extensions loaded
1234by default, or specified via the C<perl-ext-common> resource. For 1294by default, or specified via the C<perl-ext-common> resource. For
1235example, C<default,-selection> will use all the default extension except 1295example, C<default,-selection> will use all the default extensions except
1236C<selection>. 1296C<selection>.
1237 1297
1238Extension names can also be followed by an argument in angle brackets 1298The default set includes the C<selection>, C<option-popup>,
1239(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1299C<selection-popup>, C<readline> and C<searchable-scrollback>
1240searchable scrollback to Alt/Meta-s). Mentioning the same extension 1300extensions, and extensions which are mentioned in B<keysym> resources.
1241multiple times with different arguments will pass multiple arguments to 1301
1242the extension. 1302Any extension such that a corresponding resource is given on the
1303command line is automatically appended to B<perl-ext>.
1243 1304
1244Each extension is looked up in the library directories, loaded if 1305Each extension is looked up in the library directories, loaded if
1245necessary, 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.
1246 1309
1247If both of these resources are the empty string, then the perl 1310If both of these resources are the empty string, then the perl interpreter
1248interpreter will not be initialized. The idea behind two options is that 1311will not be initialized. The rationale for having two options is that
1249B<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
1250all instances, while B<perl-ext> is used for specific instances. 1313all instances, while B<perl-ext> is used for specific instances.
1251 1314
1252=item B<perl-eval>: I<string> 1315=item B<perl-eval>: I<string>
1253 1316
1255the @@RXVT_NAME@@perl(3) manpage. 1318the @@RXVT_NAME@@perl(3) manpage.
1256 1319
1257=item B<perl-lib>: I<path> 1320=item B<perl-lib>: I<path>
1258 1321
1259Colon-separated list of additional directories that hold extension 1322Colon-separated list of additional directories that hold extension
1260scripts. When looking for extensions specified by the C<perl> resource, 1323scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1261@@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
1262F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1325lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1263 1326
1264See the @@RXVT_NAME@@perl(3) manpage. 1327See the @@RXVT_NAME@@perl(3) manpage.
1265 1328
1266=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1329=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1267 1330
1271=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1334=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1272 1335
1273Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1336Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1274for details. 1337for details.
1275 1338
1276=item B<searchable-scrollback:> I<keysym> 1339=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1277 1340
1278Sets the hotkey that starts the incremental scrollback buffer search 1341This resource is deprecated and will be removed. Use a B<keysym> resource
1279(default: C<M-s>). 1342instead, e.g.:
1280 1343
1344 URxvt.keysym.M-s: searchable-scrollback:start
1345
1281=item B<urlLauncher>: I<string> 1346=item B<url-launcher>: I<string>
1282 1347
1283Specifies 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
1284C<selection-popup> and C<matcher> perl extensions. 1349C<selection-popup> and C<matcher> perl extensions.
1285 1350
1286=item B<transient-for>: I<windowid> 1351=item B<transient-for>: I<windowid>
1354window causes the value of the PRIMARY selection (or CLIPBOARD with the 1419window causes the value of the PRIMARY selection (or CLIPBOARD with the
1355B<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.
1356 1421
1357Pressing 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
1358inserted 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.
1359 1430
1360=back 1431=back
1361 1432
1362=head1 CHANGING FONTS 1433=head1 CHANGING FONTS
1363 1434
1452In addition to the default foreground and background colours, 1523In addition to the default foreground and background colours,
1453B<@@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
1454high-intensity (potentially bold/blink) versions of the same, and 72 (or 1525high-intensity (potentially bold/blink) versions of the same, and 72 (or
1455240 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
1456cube 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.
1457 1537
1458Here is a list of the ANSI colours with their names. 1538Here is a list of the ANSI colours with their names.
1459 1539
1460=begin table 1540=begin table
1461 1541
1488The following text gives values for the standard 88 colour mode (and 1568The following text gives values for the standard 88 colour mode (and
1489values for the 256 colour mode in parentheses). 1569values for the 256 colour mode in parentheses).
1490 1570
1491The 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:
1492 1572
1493 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
1494 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
1495 1575
1496The 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%
1497steps (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
1498the RGB cube. 1578the RGB cube.
1499 1579
1515White. 1595White.
1516 1596
1517=head2 ALPHA CHANNEL SUPPORT 1597=head2 ALPHA CHANNEL SUPPORT
1518 1598
1519If 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
1520their act together, rxvt-unicode will do it's own alpha channel management: 1600their act together, rxvt-unicode will do its own alpha channel management:
1521 1601
1522You can prefix any colour with an opaqueness percentage enclosed in 1602You can prefix any colour with an opaqueness percentage enclosed in
1523brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1603brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1524(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
1525transparent 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
1607 1687
1608=item B<SHELL> 1688=item B<SHELL>
1609 1689
1610The 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>.
1611 1691
1612=item B<RXVT_SOCKET> 1692=item B<RXVT_SOCKET> [I<sic>]
1613 1693
1614The unix domain socket path used by @@RXVT_NAME@@c(1) and 1694The unix domain socket path used by @@RXVT_NAME@@c(1) and
1615@@RXVT_NAME@@d(1). 1695@@RXVT_NAME@@d(1).
1616 1696
1617Default 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).
1618 1708
1619=item B<HOME> 1709=item B<HOME>
1620 1710
1621Used to locate the default directory for the unix domain socket for 1711Used to locate the default directory for the unix domain socket for
1622daemon communications and to locate various resource files (such as 1712daemon communications and to locate various resource files (such as
1643 1733
1644=back 1734=back
1645 1735
1646=head1 SEE ALSO 1736=head1 SEE ALSO
1647 1737
1738@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1648@@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)
1649 1740
1650=head1 CURRENT PROJECT COORDINATOR 1741=head1 CURRENT PROJECT COORDINATOR
1651 1742
1652=over 4 1743=over 4
1653 1744
1654=item Project Coordinator 1745=item Project Coordinator
1655 1746
1656Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1747Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1657 1748
1658L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1749L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1659 1750
1660=back 1751=back
1661 1752
1665 1756
1666=item John Bovey 1757=item John Bovey
1667 1758
1668University of Kent, 1992, wrote the original Xvt. 1759University of Kent, 1992, wrote the original Xvt.
1669 1760
1670=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1761=item Rob Nation <nation@rocket.sanders.lockheed.com>
1671 1762
1672very heavily modified Xvt and came up with Rxvt 1763very heavily modified Xvt and came up with Rxvt
1673 1764
1674=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1765=item Angelo Haritsis <ah@doc.ic.ac.uk>
1675 1766
1676wrote the Greek Keyboard Input (no longer in code) 1767wrote the Greek Keyboard Input (no longer in code)
1677 1768
1678=item mj olesen L<< <olesen@me.QueensU.CA> >> 1769=item mj olesen <olesen@me.QueensU.CA>
1679 1770
1680Wrote the menu system. 1771Wrote the menu system.
1681 1772
1682Project Coordinator (changes.txt 2.11 to 2.21) 1773Project Coordinator (changes.txt 2.11 to 2.21)
1683 1774
1684=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1775=item Oezguer Kesim <kesim@math.fu-berlin.de>
1685 1776
1686Project Coordinator (changes.txt 2.21a to 2.4.5) 1777Project Coordinator (changes.txt 2.21a to 2.4.5)
1687 1778
1688=item Geoff Wing L<< <gcw@pobox.com> >> 1779=item Geoff Wing <gcw@pobox.com>
1689 1780
1690Rewrote screen display and text selection routines. 1781Rewrote screen display and text selection routines.
1691 1782
1692Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1783Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1693 1784
1694=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1785=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1695 1786
1696Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1787Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1697extension, random hacks, numerous bugfixes and extensions. 1788extension, random hacks, numerous bugfixes and extensions.
1698 1789
1699Project Coordinator (Changes 1.0 -) 1790Project Coordinator (Changes 1.0 -)
1700 1791
1701=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1792=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1702 1793
1703pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1794pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1704 1795
1705=back 1796=back
1706 1797

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines