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.188 by sf-exg, Thu Nov 4 12:13:20 2010 UTC vs.
Revision 1.247 by sf-exg, Thu Jul 14 05:33:25 2016 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 .. 100) or lighten (100 .. 200) the transparent background;
153resource 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>
558You 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
559distribution do also load settings from the B<~/.Xresources> file when X 534distribution do also load settings from the B<~/.Xresources> file when X
560starts. @@RXVT_NAME@@ will consult the following files/resources in order, 535starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561with later settings overwriting earlier ones: 536with later settings overwriting earlier ones:
562 537
563 1. system-wide app-defaults file, either locale-dependent OR global
564 2. app-defaults file in $XAPPLRESDIR 538 1. app-defaults file in $XAPPLRESDIR
539 2. $HOME/.Xdefaults
565 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 540 3. RESOURCE_MANAGER property on root-window of screen 0
566 4. SCREEN_RESOURCES for the current screen 541 4. SCREEN_RESOURCES property on root-window of the current screen
567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 542 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568 6. resources specified via -xrm on the commandline 543 6. resources specified via -xrm on the commandline
569 544
570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 545Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
571names: 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
687 662
688B<False>: specify that everything is to be displayed, even 663B<False>: specify that everything is to be displayed, even
689if 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
690monitor to display anything); option B<+ss>. 665monitor to display anything); option B<+ss>.
691 666
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> 667=item B<fading:> I<number>
700 668
701Fade 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>.
702 670
703=item B<fadeColor:> I<colour> 671=item B<fadeColor:> I<colour>
704 672
705Fade 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
706colour is black; option B<-fadecolor>. 674colour is black; option B<-fadecolor>.
707 675
708=item B<tintColor:> I<colour>
709
710Tint the transparent background with the given colour; option
711B<-tint>.
712
713=item B<shading:> I<number>
714
715Darken (0 .. 100) or lighten (100 .. 200) the transparent background;
716option B<-sh>.
717
718=item B<blendType:> I<string>
719
720Specify background blending type; option B<-blt>.
721
722=item B<blurRadius:> I<number>
723
724Apply gaussian blur with the specified radius to the transparent
725background; option B<-blr>.
726
727=item B<iconFile:> I<file> 676=item B<iconFile:> I<file>
728 677
729Set the application icon pixmap; option B<-icon>. 678Set the application icon pixmap; option B<-icon>.
730 679
731=item B<scrollColor:> I<colour> 680=item B<scrollColor:> I<colour>
739 688
740=item B<borderColor:> I<colour> 689=item B<borderColor:> I<colour>
741 690
742The 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
743and the text. 692and the text.
744
745=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
746
747Use the specified image file for the background and also
748optionally specify its scaling with a geometry string B<WxH+X+Y>,
749(default C<100x100+50+50>) in which B<"W" / "H"> specify the
750horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
751centre (percent). A scale of 0 displays the image with tiling.
752The maximum permitted scale is 1000.
753Additional operations can be specified after colon B<:op1:op2...>.
754Supported operations are:
755
756 tile force background image to be tiled and not scaled. Equivalent to 0x0
757 propscale will scale image keeping proportions
758 auto will scale image to match window size. Equivalent to 100x100
759 hscale will scale image horizontally to the window size
760 vscale will scale image vertically to the window size
761 scale will scale image to match window size
762 root will tile image as if it was a root window background, auto-adjusting
763 whenever terminal window moves
764
765If used in conjunction with B<-tr> option, the specified pixmap will be
766blended over the transparent background using alpha-blending. If I<afterimage>
767support has been compiled in it is possible to choose other blending
768types with B<-blt "type"> option.
769
770=item B<path:> I<path>
771
772Specify the colon-delimited search path for finding background image files.
773 693
774=item B<font:> I<fontlist> 694=item B<font:> I<fontlist>
775 695
776Select 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
777that 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
874 794
875B<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
876the 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
877[default]; option B<+ls>. 797[default]; option B<+ls>.
878 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
879=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
880 805
881B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
882option 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>
883[default]; option B<+ut>. 808[default]; option B<+ut>.
900=item B<scrollstyle:> I<mode> 825=item B<scrollstyle:> I<mode>
901 826
902Set 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
903the author's favourite. 828the author's favourite.
904 829
830=item B<thickness:> I<number>
831
832Set the scrollbar width in pixels.
833
905=item B<scrollBar:> I<boolean> 834=item B<scrollBar:> I<boolean>
906 835
907B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 836B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
908disable the scrollbar; option B<+sb>. 837disable the scrollbar; option B<+sb>.
909 838
928B<False>: do not scroll to bottom when tty receives output; option 857B<False>: do not scroll to bottom when tty receives output; option
929B<+si>. 858B<+si>.
930 859
931=item B<scrollWithBuffer:> I<boolean> 860=item B<scrollWithBuffer:> I<boolean>
932 861
933B<True>: scroll with scrollback buffer when tty receives new lines (and 862B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
934B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 863try to show the same lines) and B<scrollTtyOutput> is False; option
935with 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>.
936 866
937=item B<scrollTtyKeypress:> I<boolean> 867=item B<scrollTtyKeypress:> I<boolean>
938 868
939B<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
940are those which are intercepted by rxvt-unicode for special handling and 870are those which are intercepted by rxvt-unicode for special handling and
941are 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
942bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
943 873
944=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
945 875
946Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
947resource is limited on most machines to 65535; option B<-sl>.
948 877
949=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
950 879
951Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
952option B<-b>. 881option B<-b>.
1015 944
1016=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
1017 946
1018Mouse pointer background colour. 947Mouse pointer background colour.
1019 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
1020=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
1021 956
1022Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
1023large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
1024 959
1050 985
1051B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1052 987
1053=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
1054 989
1055B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1056 991
1057=item B<inputMethod:> I<name> 992=item B<inputMethod:> I<name>
1058 993
1059I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
1060 995
1129Sets the working directory for the shell (or the command specified via 1064Sets the working directory for the shell (or the command specified via
1130B<-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
1131@@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
1132directory will be used; option B<-cd>. 1067directory will be used; option B<-cd>.
1133 1068
1134=item B<keysym.>I<sym>: I<string> 1069=item B<keysym.>I<sym>: I<action>
1135 1070
1136Compile I<frills>: Associate I<string> with keysym I<sym>. The 1071Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1137intervening resource name B<keysym.> cannot be omitted. 1072resource name B<keysym.> cannot be omitted.
1138 1073
1139The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1074Using this resource, you can map key combinations such as
1140any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1075C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1141B<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
1142and 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
1143B<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 B<ISOLevel3>, B<AppKeypad>,
1085B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1086B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1087B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1144 1088
1145The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1089The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1146whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1090whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1147keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1091keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1148current application keymap mode state. 1092current application keymap mode state.
1149 1093
1150The spellings of I<key> can be obtained by using B<xev>(1) command or 1094Due the the large number of modifier combinations, a key mapping will
1151searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1095match if I<at least> the specified identifiers are being set, and no other
1096key mappings with those and more bits are being defined. That means that
1097defining a mapping for C<a> will automatically provide definitions for
1098C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1099themselves. See the C<builtin:> action, below, for a way to work around
1100this when this is a problem.
1101
1102The spelling of I<key> depends on your implementation of X. An easy way to
1103find a key name is to use the B<xev>(1) command. You can find a list by
1104looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1152omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1105the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1153keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1106value (B<0x0000 - 0xFFFF>).
1154performed in an exact manner; however, the closest match is assured.
1155 1107
1156I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1108As with any resource value, the I<action> string may contain backslash
1109escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1157number), see RESOURCES in C<man 7 X> for further details. 1110number), see RESOURCES in C<man 7 X> for further details.
1158 1111
1159You can define a range of keysyms in one shot by providing a I<string> 1112An action starts with an action prefix that selects a certain type
1160with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1113of action, followed by a colon. An action string without colons is
1114interpreted as a literal string to pass to the tty (as if it was
1115prefixed with C<string:>).
1116
1117The following action prefixes are known - extensions can provide
1118additional prefixes:
1119
1120=over 4
1121
1122=item string:STRING
1123
1124If the I<action> starts with C<string:> (or otherwise contains no colons),
1125then the remaining C<STRING> will be passed to the program running in the
1126terminal. For example, you could replace whatever Shift-Tab outputs by the
1127string C<echo rm -rf /> followed by a newline:
1128
1129 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1130
1131This could in theory be used to completely redefine your keymap.
1132
1133In addition, for actions of this type, you can define a range of
1134keysyms in one shot by loading the C<keysym-list> perl extension and
1135providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1161should be a character not used by the strings. 1136the delimiter `/' should be a character not used by the strings.
1162 1137
1163Its usage can be demonstrated by an example: 1138Its usage can be demonstrated by an example:
1164 1139
1165 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1140 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1166 1141
1167The above line is equivalent to the following three lines: 1142The above line is equivalent to the following three lines:
1168 1143
1169 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1144 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1170 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1145 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1171 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1146 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1172 1147
1148=item command:STRING
1149
1173If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1150If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1174is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1151is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1152the opposite of C<string:> - instead of sending it to the program running
1153in the terminal, it will be treated as if it were program output). This is
1154most useful to feed command sequences into @@RXVT_NAME@@.
1155
1175example the following means "change the current locale to C<zh_CN.GBK> 1156For example the following means "change the current locale to C<zh_CN.GBK>
1176when Control-Meta-c is being pressed": 1157when Control-Meta-c is being pressed":
1177 1158
1178 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1159 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1179 1160
1180If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1161The following example will map Control-Meta-1 and Control-Meta-2 to
1181is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) 1162the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1182manpage. For example, the F<selection> extension (activated via 1163font-switching at runtime:
1183C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1184 1164
1185 URxvt.keysym.M-C-c: perl:selection:rot13 1165 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1166 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1186 1167
1187Due the the large number of modifier combinations, a defined key mapping 1168Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1188will match if I<at least> the specified identifiers are being set, and 1169info):
1189no other key mappings with those and more bits are being defined. That
1190means that defining a key map for C<a> will automatically provide
1191definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1192mappings themselves.
1193 1170
1194Unfortunately, this will override built-in key mappings. For example 1171 URxvt.keysym.M-C-3: command:\033[8;25;80t
1172 URxvt.keysym.M-C-4: command:\033[8;48;110t
1173
1174=item builtin:
1175
1176The builtin action is the action that @@RXVT_NAME@@ would execute if no
1177key binding existed for the key combination. The obvious use is to undo
1178the effect of existing bindings. The not so obvious use is to reinstate
1179bindings when another binding overrides too many modifiers.
1180
1195if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1181For example if you overwrite the C<Insert> key you will disable
1196C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1182@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1197user-defined keymap using the C<builtin:> replacement: 1183"holes" into the user-defined keymap using the C<builtin:> replacement:
1198 1184
1199 URxvt.keysym.Insert: <my insert key sequence> 1185 URxvt.keysym.Insert: <my insert key sequence>
1200 URxvt.keysym.S-Insert: builtin: 1186 URxvt.keysym.S-Insert: builtin:
1201 1187
1202The first line defines a mapping for C<Insert> and I<any> combination 1188The first line defines a mapping for C<Insert> and I<any> combination
1203of modifiers. The second line re-establishes the default mapping for 1189of modifiers. The second line re-establishes the default mapping for
1204C<Shift-Insert>. 1190C<Shift-Insert>.
1205 1191
1206The following example will map Control-Meta-1 and Control-Meta-2 to 1192=item builtin-string:
1207the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1208font-switching at runtime:
1209 1193
1210 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1194This action is mainly useful to restore string mappings for keys that
1211 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1195have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1196difficult to explain - basically, this action will send the string to the
1197application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1198action for it.
1212 1199
1213Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1200An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1214info): 1201selection when you press C<Shift-Insert>. With the following bindings, it
1202would instead emit the (undocumented, but what applications running in the
1203terminal might expect) sequence C<ESC [ 2 $> instead:
1215 1204
1216 URxvt.keysym.M-C-3: command:\033[8;25;80t 1205 URxvt.keysym.S-Insert: builtin-string:
1217 URxvt.keysym.M-C-4: command:\033[8;48;110t 1206 URxvt.keysym.C-S-Insert: builtin:
1207
1208The first line disables the paste functionality for that key
1209combination, and the second reinstates the default behaviour for
1210C<Control-Shift-Insert>, which would otherwise be overridden.
1211
1212Similarly, to let applications gain access to the C<C-M-c> (copy to
1213clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1214this:
1215
1216 URxvt.keysym.C-M-c: builtin-string:
1217 URxvt.keysym.C-M-v: builtin-string:
1218
1219=item EXTENSION:STRING
1220
1221An action of this form invokes the action B<STRING>, if any, provided
1222by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1223be loaded automatically if necessary.
1224
1225Not all extensions define actions, but popular extensions that do
1226include the I<selection> and I<matcher> extensions (documented in their
1227own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1228respectively).
1229
1230From the silly examples department, this will rot13-"encrypt"
1231@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1232keyboards:
1233
1234 URxvt.keysym.M-C-c: selection:rot13
1235
1236=item perl:STRING *DEPRECATED*
1237
1238This is a deprecated way of invoking commands provided by perl
1239extensions. It is still supported, but should not be used anymore.
1240
1241=back
1218 1242
1219=item B<perl-ext-common>: I<string> 1243=item B<perl-ext-common>: I<string>
1220 1244
1221=item B<perl-ext>: I<string> 1245=item B<perl-ext>: I<string>
1222 1246
1224use in this terminal instance; option B<-pe>. 1248use in this terminal instance; option B<-pe>.
1225 1249
1226Extension names can be prefixed with a C<-> sign to prohibit using 1250Extension names can be prefixed with a C<-> sign to prohibit using
1227them. This can be useful to selectively disable some extensions loaded 1251them. This can be useful to selectively disable some extensions loaded
1228by default, or specified via the C<perl-ext-common> resource. For 1252by default, or specified via the C<perl-ext-common> resource. For
1229example, C<default,-selection> will use all the default extension except 1253example, C<default,-selection> will use all the default extensions except
1230C<selection>. 1254C<selection>.
1231 1255
1232Extension names can also be followed by an argument in angle brackets 1256The default set includes the C<selection>, C<option-popup>,
1233(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1257C<selection-popup>, C<readline> and C<searchable-scrollback>
1234searchable scrollback to Alt/Meta-s). Mentioning the same extension 1258extensions, and extensions which are mentioned in B<keysym> resources.
1235multiple times with different arguments will pass multiple arguments to 1259
1236the extension. 1260Any extension such that a corresponding resource is given on the
1261command line is automatically appended to B<perl-ext>.
1237 1262
1238Each extension is looked up in the library directories, loaded if 1263Each extension is looked up in the library directories, loaded if
1239necessary, and bound to the current terminal instance. 1264necessary, and bound to the current terminal instance. When the library
1265search path contains multiple extension files of the same name, then the
1266first one found will be used.
1240 1267
1241If both of these resources are the empty string, then the perl 1268If both of these resources are the empty string, then the perl interpreter
1242interpreter will not be initialized. The idea behind two options is that 1269will not be initialized. The rationale for having two options is that
1243B<perl-ext-common> will be used for extensions that should be available to 1270B<perl-ext-common> will be used for extensions that should be available to
1244all instances, while B<perl-ext> is used for specific instances. 1271all instances, while B<perl-ext> is used for specific instances.
1245 1272
1246=item B<perl-eval>: I<string> 1273=item B<perl-eval>: I<string>
1247 1274
1249the @@RXVT_NAME@@perl(3) manpage. 1276the @@RXVT_NAME@@perl(3) manpage.
1250 1277
1251=item B<perl-lib>: I<path> 1278=item B<perl-lib>: I<path>
1252 1279
1253Colon-separated list of additional directories that hold extension 1280Colon-separated list of additional directories that hold extension
1254scripts. When looking for extensions specified by the C<perl> resource, 1281scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1255@@RXVT_NAME@@ will first look in these directories and then in 1282in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1256F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1283lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1257 1284
1258See the @@RXVT_NAME@@perl(3) manpage. 1285See the @@RXVT_NAME@@perl(3) manpage.
1259 1286
1260=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1287=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1261 1288
1265=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1292=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1266 1293
1267Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1294Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1268for details. 1295for details.
1269 1296
1270=item B<searchable-scrollback:> I<keysym> 1297=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1271 1298
1272Sets the hotkey that starts the incremental scrollback buffer search 1299This resource is deprecated and will be removed. Use a B<keysym> resource
1273(default: C<M-s>). 1300instead, e.g.:
1274 1301
1302 URxvt.keysym.M-s: searchable-scrollback:start
1303
1275=item B<urlLauncher>: I<string> 1304=item B<url-launcher>: I<string>
1276 1305
1277Specifies the program to be started with a URL argument. Used by the 1306Specifies the program to be started with a URL argument. Used by the
1278C<selection-popup> and C<matcher> perl extensions. 1307C<selection-popup> and C<matcher> perl extensions.
1279 1308
1280=item B<transient-for>: I<windowid> 1309=item B<transient-for>: I<windowid>
1348window causes the value of the PRIMARY selection (or CLIPBOARD with the 1377window causes the value of the PRIMARY selection (or CLIPBOARD with the
1349B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1378B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1350 1379
1351Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1380Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1352inserted too. 1381inserted too.
1382
1383rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1384<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1385binding causes the value of the internal selection to be copied to the
1386CLIPBOARD selection, while the second binding causes the value of the
1387CLIPBOARD selection to be inserted.
1353 1388
1354=back 1389=back
1355 1390
1356=head1 CHANGING FONTS 1391=head1 CHANGING FONTS
1357 1392
1446In addition to the default foreground and background colours, 1481In addition to the default foreground and background colours,
1447B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1482B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1448high-intensity (potentially bold/blink) versions of the same, and 72 (or 1483high-intensity (potentially bold/blink) versions of the same, and 72 (or
1449240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1484240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1450cube plus a 8 (24) colour greyscale ramp. 1485cube plus a 8 (24) colour greyscale ramp.
1486
1487B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1488C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1489number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1490colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
149124-bit colour space. When indexing collisions happen, the nearest old colour in
1492the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1493use many similar 24-bit colours. It's typically not a problem in common
1494scenarios.
1451 1495
1452Here is a list of the ANSI colours with their names. 1496Here is a list of the ANSI colours with their names.
1453 1497
1454=begin table 1498=begin table
1455 1499
1482The following text gives values for the standard 88 colour mode (and 1526The following text gives values for the standard 88 colour mode (and
1483values for the 256 colour mode in parentheses). 1527values for the 256 colour mode in parentheses).
1484 1528
1485The RGB cube uses indices 16..79 (16..231) using the following formulas: 1529The RGB cube uses indices 16..79 (16..231) using the following formulas:
1486 1530
1487 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1531 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1488 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1532 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1489 1533
1490The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1534The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1491steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of 1535steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1492the RGB cube. 1536the RGB cube.
1493 1537
1509White. 1553White.
1510 1554
1511=head2 ALPHA CHANNEL SUPPORT 1555=head2 ALPHA CHANNEL SUPPORT
1512 1556
1513If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1557If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1514their act together, rxvt-unicode will do it's own alpha channel management: 1558their act together, rxvt-unicode will do its own alpha channel management:
1515 1559
1516You can prefix any colour with an opaqueness percentage enclosed in 1560You can prefix any colour with an opaqueness percentage enclosed in
1517brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1561brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1518(0-100) that specifies the opacity of the colour, where C<0> is completely 1562(0-100) that specifies the opacity of the colour, where C<0> is completely
1519transparent and C<100> is completely opaque. For example, C<[50]red> is a 1563transparent and C<100> is completely opaque. For example, C<[50]red> is a
1601 1645
1602=item B<SHELL> 1646=item B<SHELL>
1603 1647
1604The shell to be used for command execution, defaults to C</bin/sh>. 1648The shell to be used for command execution, defaults to C</bin/sh>.
1605 1649
1606=item B<RXVT_SOCKET> 1650=item B<RXVT_SOCKET> [I<sic>]
1607 1651
1608The unix domain socket path used by @@RXVT_NAME@@c(1) and 1652The unix domain socket path used by @@RXVT_NAME@@c(1) and
1609@@RXVT_NAME@@d(1). 1653@@RXVT_NAME@@d(1).
1610 1654
1611Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1655Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1656
1657=item B<URXVT_PERL_LIB>
1658
1659Additional F<:>-separated library search path for perl extensions. Will be
1660searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1661directory.
1662
1663=item B<URXVT_PERL_VERBOSITY>
1664
1665See L<@@RXVT_NAME@@perl>(3).
1612 1666
1613=item B<HOME> 1667=item B<HOME>
1614 1668
1615Used to locate the default directory for the unix domain socket for 1669Used to locate the default directory for the unix domain socket for
1616daemon communications and to locate various resource files (such as 1670daemon communications and to locate various resource files (such as
1617C<.Xdefaults>) 1671C<.Xdefaults>)
1618 1672
1619=item B<XAPPLRESDIR> 1673=item B<XAPPLRESDIR>
1620 1674
1621Directory where various X resource files are being located. 1675Directory where application-specific X resource files are located.
1622 1676
1623=item B<XENVIRONMENT> 1677=item B<XENVIRONMENT>
1624 1678
1625If set and accessible, gives the name of a X resource file to be loaded by 1679If set and accessible, gives the name of a X resource file to be loaded by
1626@@RXVT_NAME@@. 1680@@RXVT_NAME@@.
1637 1691
1638=back 1692=back
1639 1693
1640=head1 SEE ALSO 1694=head1 SEE ALSO
1641 1695
1696@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1642@@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) 1697@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1643 1698
1644=head1 CURRENT PROJECT COORDINATOR 1699=head1 CURRENT PROJECT COORDINATOR
1645 1700
1646=over 4 1701=over 4
1647 1702
1648=item Project Coordinator 1703=item Project Coordinator
1649 1704
1650Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1705Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1651 1706
1652L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1707L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1653 1708
1654=back 1709=back
1655 1710
1659 1714
1660=item John Bovey 1715=item John Bovey
1661 1716
1662University of Kent, 1992, wrote the original Xvt. 1717University of Kent, 1992, wrote the original Xvt.
1663 1718
1664=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1719=item Rob Nation <nation@rocket.sanders.lockheed.com>
1665 1720
1666very heavily modified Xvt and came up with Rxvt 1721very heavily modified Xvt and came up with Rxvt
1667 1722
1668=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1723=item Angelo Haritsis <ah@doc.ic.ac.uk>
1669 1724
1670wrote the Greek Keyboard Input (no longer in code) 1725wrote the Greek Keyboard Input (no longer in code)
1671 1726
1672=item mj olesen L<< <olesen@me.QueensU.CA> >> 1727=item mj olesen <olesen@me.QueensU.CA>
1673 1728
1674Wrote the menu system. 1729Wrote the menu system.
1675 1730
1676Project Coordinator (changes.txt 2.11 to 2.21) 1731Project Coordinator (changes.txt 2.11 to 2.21)
1677 1732
1678=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1733=item Oezguer Kesim <kesim@math.fu-berlin.de>
1679 1734
1680Project Coordinator (changes.txt 2.21a to 2.4.5) 1735Project Coordinator (changes.txt 2.21a to 2.4.5)
1681 1736
1682=item Geoff Wing L<< <gcw@pobox.com> >> 1737=item Geoff Wing <gcw@pobox.com>
1683 1738
1684Rewrote screen display and text selection routines. 1739Rewrote screen display and text selection routines.
1685 1740
1686Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1741Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1687 1742
1688=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1743=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1689 1744
1690Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1745Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1691extension, random hacks, numerous bugfixes and extensions. 1746extension, random hacks, numerous bugfixes and extensions.
1692 1747
1693Project Coordinator (Changes 1.0 -) 1748Project Coordinator (Changes 1.0 -)
1694 1749
1695=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1750=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1696 1751
1697Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1752pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1698 1753
1699=back 1754=back
1700 1755

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines