[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.194 by sf-exg, Wed Mar 9 13:24:30 2011 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC

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

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.194 by sf-exg, Wed Mar 9 13:24:30 2011 UTC vs. Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.194 by sf-exg, Wed Mar 9 13:24:30 2011 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC