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.250 by root, Sat Oct 10 20:06:45 2020 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
951are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 871are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
952bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
953 873
954=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
955 875
956Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
957resource is limited on most machines to 65535; option B<-sl>.
958 877
959=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
960 879
961Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
962option B<-b>. 881option B<-b>.
1025 944
1026=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
1027 946
1028Mouse pointer background colour. 947Mouse pointer background colour.
1029 948
949=item B<pointerShape:> I<string>
950
951Compile I<frills>: Specifies the name of the mouse pointer shape
952[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
953file for possible values (omit the C<XC_> prefix).
954
1030=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
1031 956
1032Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
1033large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
1034 959
1060 985
1061B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1062 987
1063=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
1064 989
1065B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1066 991
1067=item B<inputMethod:> I<name> 992=item B<inputMethod:> I<name>
1068 993
1069I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
1070 995
1139Sets the working directory for the shell (or the command specified via 1064Sets 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 1065B<-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 1066@@RXVT_NAME@@ to start. If it isn't specified then the current working
1142directory will be used; option B<-cd>. 1067directory will be used; option B<-cd>.
1143 1068
1144=item B<keysym.>I<sym>: I<string> 1069=item B<keysym.>I<sym>: I<action>
1145 1070
1146Compile I<frills>: Associate I<string> with keysym I<sym>. The 1071Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1147intervening resource name B<keysym.> cannot be omitted. 1072resource name B<keysym.> cannot be omitted.
1148 1073
1149The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1074Using this resource, you can map key combinations such as
1150any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1075C<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>, 1076string 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>, 1077terminal scroll up or down the way you want it, or any other thing an
1153B<2>, B<3>, B<4>, B<5>. 1078extension might provide.
1079
1080The key combination that triggers the action, I<sym>, has the following format:
1081
1082 (modifiers-)key
1083
1084Where I<modifiers> can be any combination of the following full or
1085abbreviated modifier names:
1086
1087=begin table
1088
1089 B<ISOLevel3> B<I>
1090 B<AppKeypad> B<K>
1091 B<Control> B<C>
1092 B<NumLock> B<N>
1093 B<Shift> B<S>
1094 B<Meta> B<M> I<or> B<A>
1095 B<Lock> B<L>
1096 B<Mod1> B<1>
1097 B<Mod2> B<2>
1098 B<Mod3> B<3>
1099 B<Mod4> B<4>
1100 B<Mod5> B<5>
1101
1102=end table
1154 1103
1155The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1104The 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 1105whatever 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 1106keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1158current application keymap mode state. 1107current application keymap mode state.
1159 1108
1160The spellings of I<key> can be obtained by using B<xev>(1) command or 1109Due the the large number of modifier combinations, a key mapping will
1161searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1110match if I<at least> the specified identifiers are being set, and no other
1111key mappings with those and more bits are being defined. That means that
1112defining a mapping for C<a> will automatically provide definitions for
1113C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1114themselves. See the C<builtin:> action, below, for a way to work around
1115this when this is a problem.
1116
1117The spelling of I<key> depends on your implementation of X. An easy way to
1118find a key name is to use the B<xev>(1) command. You can find a list by
1119looking 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 1120the 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 1121value (B<0x0000 - 0xFFFF>).
1164performed in an exact manner; however, the closest match is assured.
1165 1122
1166I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1123As with any resource value, the I<action> string may contain backslash
1124escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1167number), see RESOURCES in C<man 7 X> for further details. 1125number), see RESOURCES in C<man 7 X> for further details.
1168 1126
1169You can define a range of keysyms in one shot by providing a I<string> 1127An action starts with an action prefix that selects a certain type
1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1128of action, followed by a colon. An action string without colons is
1129interpreted as a literal string to pass to the tty (as if it was
1130prefixed with C<string:>).
1131
1132The following action prefixes are known - extensions can provide
1133additional prefixes:
1134
1135=over 4
1136
1137=item string:STRING
1138
1139If the I<action> starts with C<string:> (or otherwise contains no colons),
1140then the remaining C<STRING> will be passed to the program running in the
1141terminal. For example, you could replace whatever Shift-Tab outputs by the
1142string C<echo rm -rf /> followed by a newline:
1143
1144 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1145
1146This could in theory be used to completely redefine your keymap.
1147
1148In addition, for actions of this type, you can define a range of
1149keysyms in one shot by loading the C<keysym-list> perl extension and
1150providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1171should be a character not used by the strings. 1151the delimiter `/' should be a character not used by the strings.
1172 1152
1173Its usage can be demonstrated by an example: 1153Its usage can be demonstrated by an example:
1174 1154
1175 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1155 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1176 1156
1177The above line is equivalent to the following three lines: 1157The above line is equivalent to the following three lines:
1178 1158
1179 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1159 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1180 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1160 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1181 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1161 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1182 1162
1163=item command:STRING
1164
1183If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1165If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1184is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1166is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1167the opposite of C<string:> - instead of sending it to the program running
1168in the terminal, it will be treated as if it were program output). This is
1169most useful to feed command sequences into @@RXVT_NAME@@.
1170
1185example the following means "change the current locale to C<zh_CN.GBK> 1171For example the following means "change the current locale to C<zh_CN.GBK>
1186when Control-Meta-c is being pressed": 1172when Control-Meta-c is being pressed":
1187 1173
1188 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1174 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1189 1175
1190If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1176The 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) 1177the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1192manpage. For example, the F<selection> extension (activated via 1178font-switching at runtime:
1193C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1194 1179
1195 URxvt.keysym.M-C-c: perl:selection:rot13 1180 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1181 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1196 1182
1197Due the the large number of modifier combinations, a defined key mapping 1183Other 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 1184info):
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 1185
1204Unfortunately, this will override built-in key mappings. For example 1186 URxvt.keysym.M-C-3: command:\033[8;25;80t
1187 URxvt.keysym.M-C-4: command:\033[8;48;110t
1188
1189=item builtin:
1190
1191The builtin action is the action that @@RXVT_NAME@@ would execute if no
1192key binding existed for the key combination. The obvious use is to undo
1193the effect of existing bindings. The not so obvious use is to reinstate
1194bindings when another binding overrides too many modifiers.
1195
1205if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1196For 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 1197@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1207user-defined keymap using the C<builtin:> replacement: 1198"holes" into the user-defined keymap using the C<builtin:> replacement:
1208 1199
1209 URxvt.keysym.Insert: <my insert key sequence> 1200 URxvt.keysym.Insert: <my insert key sequence>
1210 URxvt.keysym.S-Insert: builtin: 1201 URxvt.keysym.S-Insert: builtin:
1211 1202
1212The first line defines a mapping for C<Insert> and I<any> combination 1203The first line defines a mapping for C<Insert> and I<any> combination
1213of modifiers. The second line re-establishes the default mapping for 1204of modifiers. The second line re-establishes the default mapping for
1214C<Shift-Insert>. 1205C<Shift-Insert>.
1215 1206
1216The following example will map Control-Meta-1 and Control-Meta-2 to 1207=item builtin-string:
1217the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1218font-switching at runtime:
1219 1208
1220 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1209This action is mainly useful to restore string mappings for keys that
1221 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1210have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1211difficult to explain - basically, this action will send the string to the
1212application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1213action for it.
1222 1214
1223Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1215An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1224info): 1216selection when you press C<Shift-Insert>. With the following bindings, it
1217would instead emit the (undocumented, but what applications running in the
1218terminal might expect) sequence C<ESC [ 2 $> instead:
1225 1219
1226 URxvt.keysym.M-C-3: command:\033[8;25;80t 1220 URxvt.keysym.S-Insert: builtin-string:
1227 URxvt.keysym.M-C-4: command:\033[8;48;110t 1221 URxvt.keysym.C-S-Insert: builtin:
1222
1223The first line disables the paste functionality for that key
1224combination, and the second reinstates the default behaviour for
1225C<Control-Shift-Insert>, which would otherwise be overridden.
1226
1227Similarly, to let applications gain access to the C<C-M-c> (copy to
1228clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1229this:
1230
1231 URxvt.keysym.C-M-c: builtin-string:
1232 URxvt.keysym.C-M-v: builtin-string:
1233
1234=item EXTENSION:STRING
1235
1236An action of this form invokes the action B<STRING>, if any, provided
1237by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1238be loaded automatically if necessary.
1239
1240Not all extensions define actions, but popular extensions that do
1241include the I<selection> and I<matcher> extensions (documented in their
1242own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1243respectively).
1244
1245From the silly examples department, this will rot13-"encrypt"
1246@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1247keyboards:
1248
1249 URxvt.keysym.M-C-c: selection:rot13
1250
1251=item perl:STRING *DEPRECATED*
1252
1253This is a deprecated way of invoking commands provided by perl
1254extensions. It is still supported, but should not be used anymore.
1255
1256=back
1228 1257
1229=item B<perl-ext-common>: I<string> 1258=item B<perl-ext-common>: I<string>
1230 1259
1231=item B<perl-ext>: I<string> 1260=item B<perl-ext>: I<string>
1232 1261
1234use in this terminal instance; option B<-pe>. 1263use in this terminal instance; option B<-pe>.
1235 1264
1236Extension names can be prefixed with a C<-> sign to prohibit using 1265Extension names can be prefixed with a C<-> sign to prohibit using
1237them. This can be useful to selectively disable some extensions loaded 1266them. This can be useful to selectively disable some extensions loaded
1238by default, or specified via the C<perl-ext-common> resource. For 1267by default, or specified via the C<perl-ext-common> resource. For
1239example, C<default,-selection> will use all the default extension except 1268example, C<default,-selection> will use all the default extensions except
1240C<selection>. 1269C<selection>.
1241 1270
1242Extension names can also be followed by an argument in angle brackets 1271The default set includes the C<selection>, C<option-popup>,
1243(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1272C<selection-popup>, C<readline> and C<searchable-scrollback>
1244searchable scrollback to Alt/Meta-s). Mentioning the same extension 1273extensions, and extensions which are mentioned in B<keysym> resources.
1245multiple times with different arguments will pass multiple arguments to 1274
1246the extension. 1275Any extension such that a corresponding resource is given on the
1276command line is automatically appended to B<perl-ext>.
1247 1277
1248Each extension is looked up in the library directories, loaded if 1278Each extension is looked up in the library directories, loaded if
1249necessary, and bound to the current terminal instance. 1279necessary, and bound to the current terminal instance. When the library
1280search path contains multiple extension files of the same name, then the
1281first one found will be used.
1250 1282
1251If both of these resources are the empty string, then the perl 1283If both of these resources are the empty string, then the perl interpreter
1252interpreter will not be initialized. The idea behind two options is that 1284will 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 1285B<perl-ext-common> will be used for extensions that should be available to
1254all instances, while B<perl-ext> is used for specific instances. 1286all instances, while B<perl-ext> is used for specific instances.
1255 1287
1256=item B<perl-eval>: I<string> 1288=item B<perl-eval>: I<string>
1257 1289
1259the @@RXVT_NAME@@perl(3) manpage. 1291the @@RXVT_NAME@@perl(3) manpage.
1260 1292
1261=item B<perl-lib>: I<path> 1293=item B<perl-lib>: I<path>
1262 1294
1263Colon-separated list of additional directories that hold extension 1295Colon-separated list of additional directories that hold extension
1264scripts. When looking for extensions specified by the C<perl> resource, 1296scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1265@@RXVT_NAME@@ will first look in these directories and then in 1297in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1266F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1298lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1267 1299
1268See the @@RXVT_NAME@@perl(3) manpage. 1300See the @@RXVT_NAME@@perl(3) manpage.
1269 1301
1270=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1302=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1271 1303
1275=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1307=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1276 1308
1277Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1309Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1278for details. 1310for details.
1279 1311
1280=item B<searchable-scrollback:> I<keysym> 1312=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1281 1313
1282Sets the hotkey that starts the incremental scrollback buffer search 1314This resource is deprecated and will be removed. Use a B<keysym> resource
1283(default: C<M-s>). 1315instead, e.g.:
1284 1316
1317 URxvt.keysym.M-s: searchable-scrollback:start
1318
1285=item B<urlLauncher>: I<string> 1319=item B<url-launcher>: I<string>
1286 1320
1287Specifies the program to be started with a URL argument. Used by the 1321Specifies the program to be started with a URL argument. Used by the
1288C<selection-popup> and C<matcher> perl extensions. 1322C<selection-popup> and C<matcher> perl extensions.
1289 1323
1290=item B<transient-for>: I<windowid> 1324=item B<transient-for>: I<windowid>
1358window causes the value of the PRIMARY selection (or CLIPBOARD with the 1392window 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. 1393B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1360 1394
1361Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1395Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1362inserted too. 1396inserted too.
1397
1398rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1399<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1400binding causes the value of the internal selection to be copied to the
1401CLIPBOARD selection, while the second binding causes the value of the
1402CLIPBOARD selection to be inserted.
1363 1403
1364=back 1404=back
1365 1405
1366=head1 CHANGING FONTS 1406=head1 CHANGING FONTS
1367 1407
1456In addition to the default foreground and background colours, 1496In addition to the default foreground and background colours,
1457B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1497B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1458high-intensity (potentially bold/blink) versions of the same, and 72 (or 1498high-intensity (potentially bold/blink) versions of the same, and 72 (or
1459240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1499240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1460cube plus a 8 (24) colour greyscale ramp. 1500cube plus a 8 (24) colour greyscale ramp.
1501
1502B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1503C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1504number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1505colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
150624-bit colour space. When indexing collisions happen, the nearest old colour in
1507the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1508use many similar 24-bit colours. It's typically not a problem in common
1509scenarios.
1461 1510
1462Here is a list of the ANSI colours with their names. 1511Here is a list of the ANSI colours with their names.
1463 1512
1464=begin table 1513=begin table
1465 1514
1492The following text gives values for the standard 88 colour mode (and 1541The following text gives values for the standard 88 colour mode (and
1493values for the 256 colour mode in parentheses). 1542values for the 256 colour mode in parentheses).
1494 1543
1495The RGB cube uses indices 16..79 (16..231) using the following formulas: 1544The RGB cube uses indices 16..79 (16..231) using the following formulas:
1496 1545
1497 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1546 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 1547 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1499 1548
1500The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1549The 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 1550steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1502the RGB cube. 1551the RGB cube.
1503 1552
1519White. 1568White.
1520 1569
1521=head2 ALPHA CHANNEL SUPPORT 1570=head2 ALPHA CHANNEL SUPPORT
1522 1571
1523If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1572If 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: 1573their act together, rxvt-unicode will do its own alpha channel management:
1525 1574
1526You can prefix any colour with an opaqueness percentage enclosed in 1575You can prefix any colour with an opaqueness percentage enclosed in
1527brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1576brackets, 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 1577(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 1578transparent and C<100> is completely opaque. For example, C<[50]red> is a
1611 1660
1612=item B<SHELL> 1661=item B<SHELL>
1613 1662
1614The shell to be used for command execution, defaults to C</bin/sh>. 1663The shell to be used for command execution, defaults to C</bin/sh>.
1615 1664
1616=item B<RXVT_SOCKET> 1665=item B<RXVT_SOCKET> [I<sic>]
1617 1666
1618The unix domain socket path used by @@RXVT_NAME@@c(1) and 1667The unix domain socket path used by @@RXVT_NAME@@c(1) and
1619@@RXVT_NAME@@d(1). 1668@@RXVT_NAME@@d(1).
1620 1669
1621Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1670Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1671
1672=item B<URXVT_PERL_LIB>
1673
1674Additional F<:>-separated library search path for perl extensions. Will be
1675searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1676directory.
1677
1678=item B<URXVT_PERL_VERBOSITY>
1679
1680See L<@@RXVT_NAME@@perl>(3).
1622 1681
1623=item B<HOME> 1682=item B<HOME>
1624 1683
1625Used to locate the default directory for the unix domain socket for 1684Used to locate the default directory for the unix domain socket for
1626daemon communications and to locate various resource files (such as 1685daemon communications and to locate various resource files (such as
1627C<.Xdefaults>) 1686C<.Xdefaults>)
1628 1687
1629=item B<XAPPLRESDIR> 1688=item B<XAPPLRESDIR>
1630 1689
1631Directory where various X resource files are being located. 1690Directory where application-specific X resource files are located.
1632 1691
1633=item B<XENVIRONMENT> 1692=item B<XENVIRONMENT>
1634 1693
1635If set and accessible, gives the name of a X resource file to be loaded by 1694If set and accessible, gives the name of a X resource file to be loaded by
1636@@RXVT_NAME@@. 1695@@RXVT_NAME@@.
1647 1706
1648=back 1707=back
1649 1708
1650=head1 SEE ALSO 1709=head1 SEE ALSO
1651 1710
1711@@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) 1712@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1653 1713
1654=head1 CURRENT PROJECT COORDINATOR 1714=head1 CURRENT PROJECT COORDINATOR
1655 1715
1656=over 4 1716=over 4
1657 1717
1658=item Project Coordinator 1718=item Project Coordinator
1659 1719
1660Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1720Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1661 1721
1662L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1722L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1663 1723
1664=back 1724=back
1665 1725
1669 1729
1670=item John Bovey 1730=item John Bovey
1671 1731
1672University of Kent, 1992, wrote the original Xvt. 1732University of Kent, 1992, wrote the original Xvt.
1673 1733
1674=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1734=item Rob Nation <nation@rocket.sanders.lockheed.com>
1675 1735
1676very heavily modified Xvt and came up with Rxvt 1736very heavily modified Xvt and came up with Rxvt
1677 1737
1678=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1738=item Angelo Haritsis <ah@doc.ic.ac.uk>
1679 1739
1680wrote the Greek Keyboard Input (no longer in code) 1740wrote the Greek Keyboard Input (no longer in code)
1681 1741
1682=item mj olesen L<< <olesen@me.QueensU.CA> >> 1742=item mj olesen <olesen@me.QueensU.CA>
1683 1743
1684Wrote the menu system. 1744Wrote the menu system.
1685 1745
1686Project Coordinator (changes.txt 2.11 to 2.21) 1746Project Coordinator (changes.txt 2.11 to 2.21)
1687 1747
1688=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1748=item Oezguer Kesim <kesim@math.fu-berlin.de>
1689 1749
1690Project Coordinator (changes.txt 2.21a to 2.4.5) 1750Project Coordinator (changes.txt 2.21a to 2.4.5)
1691 1751
1692=item Geoff Wing L<< <gcw@pobox.com> >> 1752=item Geoff Wing <gcw@pobox.com>
1693 1753
1694Rewrote screen display and text selection routines. 1754Rewrote screen display and text selection routines.
1695 1755
1696Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1756Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1697 1757
1698=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1758=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1699 1759
1700Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1760Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1701extension, random hacks, numerous bugfixes and extensions. 1761extension, random hacks, numerous bugfixes and extensions.
1702 1762
1703Project Coordinator (Changes 1.0 -) 1763Project Coordinator (Changes 1.0 -)
1704 1764
1705=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1765=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1706 1766
1707Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1767pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1708 1768
1709=back 1769=back
1710 1770

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines