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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.198 by sf-exg, Tue Aug 9 18:41:31 2011 UTC vs. Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.198 by sf-exg, Tue Aug 9 18:41:31 2011 UTC vs.
Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC