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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC vs.
Revision 1.238 by sf-exg, Sat Oct 11 22:02:50 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[;oplist]>
189
190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191	optionally specify a list of operations to modify it. 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[;oplist]>
749
750	Use the specified image file for the background and also
751	optionally specify a colon separated list of operations to modify it.
752	Supported operations are:
753
754	=over 4
755
756	=item B<WxH+X+Y>
757
758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
760	scale of 0 disables scaling. The maximum permitted scale is 1000.
761
762	=item B<op=tile>
763
764	enables tiling
765
766	=item B<op=keep-aspect>
767
768	maintain the image aspect ratio when scaling
769
770	=item B<op=root-align>
771
772	use the position of the terminal window relative to the root window as
773	the image offset, simulating a root window background
774
775	=back
776
777	The default scale and position setting is C<100x100+50+50>.
778	Alternatively, a predefined set of templates can be used to achieve
779	the most common setups:
780
781	=over 4
782
783	=item B<style=tiled>
784
785	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786
787	=item B<style=aspect-stretched>
788
789	the image is scaled to fill the whole window maintaining the aspect
790	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
791
792	=item B<style=stretched>
793
794	the image is scaled to fill the whole window. Equivalent to 100x100
795
796	=item B<style=centered>
797
798	the image is centered with no scaling. Equivalent to 0x0+50+50
799
800	=item B<style=root-tiled>
801
802	the image is tiled with no scaling and using 'root' positioning.
803	Equivalent to 0x0:op=tile:op=root-align
804
805	=back
806
807	If multiple templates are specified the last one wins. Note that a
808	template overrides all the scale, position and operations settings.
809
810	If used in conjunction with B<-tr> option, the specified pixmap will be
811	blended over the transparent background using alpha-blending. If I<afterimage>
812	support has been compiled in it is possible to choose other blending
813	types with B<-blt "type"> option.
814
815	=item B<path:> I<path>
816
817	Specify the colon-delimited search path for finding background image files.
818		689
819	=item B<font:> I<fontlist>	690	=item B<font:> I<fontlist>
820		691
821	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
822	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
…		…
918	=item B<loginShell:> I<boolean>	789	=item B<loginShell:> I<boolean>
919		790
920	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
921	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
922	[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>.
923		799
924	=item B<utmpInhibit:> I<boolean>	800	=item B<utmpInhibit:> I<boolean>
925		801
926	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>;
927	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>
…		…
1179	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
1180	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
1181	@@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
1182	directory will be used; option B<-cd>.	1058	directory will be used; option B<-cd>.
1183		1059
1184	=item B<keysym.>I<sym>: I<string>	1060	=item B<keysym.>I<sym>: I<action>
1185		1061
1186	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1062	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1187	intervening resource name B<keysym.> cannot be omitted.	1063	resource name B<keysym.> cannot be omitted.
1188		1064
1189	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
1190	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1066	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1191	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
1192	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
1193	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>.
1194		1079
1195	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
1196	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
1197	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
1198	current application keymap mode state.	1083	current application keymap mode state.
1199		1084
1200	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
1201	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
1202	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
1203	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1097	value (B<0x0000 - 0xFFFF>).
1204	performed in an exact manner; however, the closest match is assured.
1205		1098
1206	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
1207	number), see RESOURCES in C<man 7 X> for further details.	1101	number), see RESOURCES in C<man 7 X> for further details.
1208		1102
1209	You can define a range of keysyms in one shot by	1103	An action starts with an action prefix that selects a certain type
1210	loading the C<keysym-list> perl extension and providing a I<string>	1104	of action, followed by a colon. An action string without colons is
1211	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1105	interpreted as a literal string to pass to the tty (as if it was
1212	should be a character not used by the strings.	1106	prefixed with C<string:>).
1213		1107
1214	Its usage can be demonstrated by an example:	1108	The following action prefixes are known - extensions can provide
		1109	additional prefixes:
1215		1110
1216	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1111	=over 4
1217		1112
1218	The above line is equivalent to the following three lines:	1113	=item string:STRING
1219		1114
1220	URxvt.keysym.Meta-Control-0x61: \033<a>	1115	If the I<action> starts with C<string:> (or otherwise contains no colons),
1221	URxvt.keysym.Meta-Control-0x62: \033<b>	1116	then the remaining C<STRING> will be passed to the program running in the
1222	URxvt.keysym.Meta-Control-0x63: \033<c>	1117	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1118	string C<echo rm -rf /> followed by a newline:
1223		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	=item command:STRING
		1125
1224	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1126	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1225	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1127	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1128	the opposite of C<string:> - instead of sending it to the program running
		1129	in the terminal, it will be treated as if it were program output). This is
		1130	most useful to feed command sequences into @@RXVT_NAME@@.
		1131
1226	example the following means "change the current locale to C<zh_CN.GBK>	1132	For example the following means "change the current locale to C<zh_CN.GBK>
1227	when Control-Meta-c is being pressed":	1133	when Control-Meta-c is being pressed":
1228		1134
1229	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1135	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1230		1136
1231	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1137	The following example will map Control-Meta-1 and Control-Meta-2 to
1232	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1138	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1233	manpage. For example, the F<selection> extension (activated via	1139	font-switching at runtime:
1234	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1235		1140
1236	URxvt.keysym.M-C-c: perl:selection:rot13	1141	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1142	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1237		1143
1238	Due the the large number of modifier combinations, a defined key mapping	1144	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1239	will match if I<at least> the specified identifiers are being set, and	1145	info):
1240	no other key mappings with those and more bits are being defined. That
1241	means that defining a key map for C<a> will automatically provide
1242	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1243	mappings themselves.
1244		1146
1245	Unfortunately, this will override built-in key mappings. For example	1147	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1148	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1149
		1150	=item builtin:
		1151
		1152	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1153	key binding existed for the key combination. The obvious use is to undo
		1154	the effect of existing bindings. The not so obvious use is to reinstate
		1155	bindings when another binding overrides too many modifiers.
		1156
1246	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1157	For example if you overwrite the C<Insert> key you will disable
1247	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1158	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1248	user-defined keymap using the C<builtin:> replacement:	1159	"holes" into the user-defined keymap using the C<builtin:> replacement:
1249		1160
1250	URxvt.keysym.Insert: <my insert key sequence>	1161	URxvt.keysym.Insert: <my insert key sequence>
1251	URxvt.keysym.S-Insert: builtin:	1162	URxvt.keysym.S-Insert: builtin:
1252		1163
1253	The first line defines a mapping for C<Insert> and I<any> combination	1164	The first line defines a mapping for C<Insert> and I<any> combination
1254	of modifiers. The second line re-establishes the default mapping for	1165	of modifiers. The second line re-establishes the default mapping for
1255	C<Shift-Insert>.	1166	C<Shift-Insert>.
1256		1167
1257	The following example will map Control-Meta-1 and Control-Meta-2 to	1168	=item builtin-string:
1258	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1259	font-switching at runtime:
1260		1169
1261	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1170	This action is mainly useful to restore string mappings for keys that
1262	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1171	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1172	difficult to explain - basically, this action will send the string to the
		1173	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1174	action for it.
1263		1175
1264	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1176	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1265	info):	1177	selection when you press C<Shift-Insert>. With the following bindings, it
		1178	would instead emit the (undocumented, but what applications running in the
		1179	terminal might expect) sequence C<ESC [ 2 $> instead:
1266		1180
1267	URxvt.keysym.M-C-3: command:\033[8;25;80t	1181	URxvt.keysym.S-Insert: builtin-string:
1268	URxvt.keysym.M-C-4: command:\033[8;48;110t	1182	URxvt.keysym.C-S-Insert: builtin:
		1183
		1184	The first line disables the paste functionality for that key
		1185	combination, and the second reinstates the default behaviour for
		1186	C<Control-Shift-Insert>, which would otherwise be overridden.
		1187
		1188	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1189	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1190	this:
		1191
		1192	URxvt.keysym.C-M-c: builtin-string:
		1193	URxvt.keysym.C-M-v: builtin-string:
		1194
		1195	=item EXTENSION:STRING
		1196
		1197	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
		1198	extension of the same name. The extension will be loaded automatically if
		1199	necessary.
		1200
		1201	Not all extensions define key actions, but popular extensions that do
		1202	include the I<selection> and I<matcher> extensions (documented in their
		1203	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1204	respectively).
		1205
		1206	From the silly examples department, this will rot13-"encrypt"
		1207	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1208	keyboards:
		1209
		1210	URxvt.keysym.M-C-c: selection:rot13
		1211
		1212	=item perl:STRING DEPRECATED
		1213
		1214	This is a deprecated way of passing key mappings to perl extensions. It is
		1215	still supported, but should not be used anymore.
		1216
		1217	=back
1269		1218
1270	=item B<perl-ext-common>: I<string>	1219	=item B<perl-ext-common>: I<string>
1271		1220
1272	=item B<perl-ext>: I<string>	1221	=item B<perl-ext>: I<string>
1273		1222
…		…
1275	use in this terminal instance; option B<-pe>.	1224	use in this terminal instance; option B<-pe>.
1276		1225
1277	Extension names can be prefixed with a C<-> sign to prohibit using	1226	Extension names can be prefixed with a C<-> sign to prohibit using
1278	them. This can be useful to selectively disable some extensions loaded	1227	them. This can be useful to selectively disable some extensions loaded
1279	by default, or specified via the C<perl-ext-common> resource. For	1228	by default, or specified via the C<perl-ext-common> resource. For
1280	example, C<default,-selection> will use all the default extension except	1229	example, C<default,-selection> will use all the default extensions except
1281	C<selection>.	1230	C<selection>.
1282		1231
1283	Extension names can also be followed by an argument in angle brackets	1232	The default set includes the C<selection>, C<option-popup>,
1284	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1233	C<selection-popup> and C<readline> extensions, any extensions that
1285	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1234	define keybindings via C<BINDING> meta comments, and extensions which
1286	multiple times with different arguments will pass multiple arguments to	1235	are mentioned in B<keysym> resources.
1287	the extension.	1236
		1237	Any extension such that a corresponding resource is given on the
		1238	command line is automatically appended to B<perl-ext>.
1288		1239
1289	Each extension is looked up in the library directories, loaded if	1240	Each extension is looked up in the library directories, loaded if
1290	necessary, and bound to the current terminal instance.	1241	necessary, and bound to the current terminal instance. When the library
		1242	search path contains multiple extension files of the same name, then the
		1243	first one found will be used.
1291		1244
1292	If both of these resources are the empty string, then the perl	1245	If both of these resources are the empty string, then the perl interpreter
1293	interpreter will not be initialized. The idea behind two options is that	1246	will not be initialized. The rationale for having two options is that
1294	B<perl-ext-common> will be used for extensions that should be available to	1247	B<perl-ext-common> will be used for extensions that should be available to
1295	all instances, while B<perl-ext> is used for specific instances.	1248	all instances, while B<perl-ext> is used for specific instances.
1296		1249
1297	=item B<perl-eval>: I<string>	1250	=item B<perl-eval>: I<string>
1298		1251
…		…
1300	the @@RXVT_NAME@@perl(3) manpage.	1253	the @@RXVT_NAME@@perl(3) manpage.
1301		1254
1302	=item B<perl-lib>: I<path>	1255	=item B<perl-lib>: I<path>
1303		1256
1304	Colon-separated list of additional directories that hold extension	1257	Colon-separated list of additional directories that hold extension
1305	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first	1258	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1306	look in these directories, then in $HOME/.urxvt/ext and lastly in	1259	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1307	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1260	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1308		1261
1309	See the @@RXVT_NAME@@perl(3) manpage.	1262	See the @@RXVT_NAME@@perl(3) manpage.
1310		1263
1311	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1264	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1312		1265
…		…
1316	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1269	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1317		1270
1318	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1271	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1319	for details.	1272	for details.
1320		1273
1321	=item B<searchable-scrollback:> I<keysym>	1274	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1322		1275
1323	Sets the hotkey that starts the incremental scrollback buffer search	1276	This resource is deprecated and will be removed. Use a B<keysym> resource
1324	(default: C<M-s>).	1277	instead, e.g.:
1325		1278
		1279	URxvt.keysym.M-s: searchable-scrollback:start
		1280
1326	=item B<urlLauncher>: I<string>	1281	=item B<url-launcher>: I<string>
1327		1282
1328	Specifies the program to be started with a URL argument. Used by the	1283	Specifies the program to be started with a URL argument. Used by the
1329	C<selection-popup> and C<matcher> perl extensions.	1284	C<selection-popup> and C<matcher> perl extensions.
1330		1285
1331	=item B<transient-for>: I<windowid>	1286	=item B<transient-for>: I<windowid>
…		…
1342	Turn on/off ISO 14755 (default enabled).	1297	Turn on/off ISO 14755 (default enabled).
1343		1298
1344	=item B<iso14755_52:> I<boolean>	1299	=item B<iso14755_52:> I<boolean>
1345		1300
1346	Turn on/off ISO 14755 5.2 mode (default enabled).	1301	Turn on/off ISO 14755 5.2 mode (default enabled).
		1302
		1303	=back
		1304
		1305	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1306
		1307	=over 4
		1308
		1309	=item B<-pixmap> I<file[;oplist]>
		1310
		1311	=item B<backgroundPixmap:> I<file[;oplist]>
		1312
		1313	Compile I<pixbuf>: Use the specified image file as the window's
		1314	background and also optionally specify a colon separated list of
		1315	operations to modify it. Note that you may need to quote the C<;>
		1316	character when using the command line option, as C<;> is usually a
		1317	metacharacter in shells. Supported operations are:
		1318
		1319	=over 4
		1320
		1321	=item B<WxH+X+Y>
		1322
		1323	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1324	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1325	scale of 0 disables scaling.
		1326
		1327	=item B<op=tile>
		1328
		1329	enables tiling
		1330
		1331	=item B<op=keep-aspect>
		1332
		1333	maintain the image aspect ratio when scaling
		1334
		1335	=item B<op=root-align>
		1336
		1337	use the position of the terminal window relative to the root window as
		1338	the image offset, simulating a root window background
		1339
		1340	=back
		1341
		1342	The default scale and position setting is C<100x100+50+50>.
		1343	Alternatively, a predefined set of templates can be used to achieve
		1344	the most common setups:
		1345
		1346	=over 4
		1347
		1348	=item B<style=tiled>
		1349
		1350	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1351
		1352	=item B<style=aspect-stretched>
		1353
		1354	the image is scaled to fill the whole window maintaining the aspect
		1355	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1356
		1357	=item B<style=stretched>
		1358
		1359	the image is scaled to fill the whole window. Equivalent to 100x100
		1360
		1361	=item B<style=centered>
		1362
		1363	the image is centered with no scaling. Equivalent to 0x0+50+50
		1364
		1365	=item B<style=root-tiled>
		1366
		1367	the image is tiled with no scaling and using 'root' positioning.
		1368	Equivalent to 0x0:op=tile:op=root-align
		1369
		1370	=back
		1371
		1372	If multiple templates are specified the last one wins. Note that a
		1373	template overrides all the scale, position and operations settings.
		1374
		1375	If used in conjunction with pseudo-transparency, the specified pixmap
		1376	will be blended over the transparent background using alpha-blending.
		1377
		1378	=item B<-tr>\|B<+tr>
		1379
		1380	=item B<transparent:> I<boolean>
		1381
		1382	Turn on/off pseudo-transparency by using the root pixmap as background.
		1383
		1384	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1385	will be removed in future versions.
		1386
		1387	=item B<-tint> I<colour>
		1388
		1389	=item B<tintColor:> I<colour>
		1390
		1391	Tint the transparent background with the given colour. Note that a
		1392	black tint yields a completely black image while a white tint yields
		1393	the image unchanged.
		1394
		1395	=item B<-sh> I<number>
		1396
		1397	=item B<shading:> I<number>
		1398
		1399	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1400	A value of 100 means no shading.
		1401
		1402	=item B<-blr> I<HxV>
		1403
		1404	=item B<blurRadius:> I<HxV>
		1405
		1406	Apply gaussian blur with the specified radius to the transparent
		1407	background. If a single number is specified, the vertical and
		1408	horizontal radii are considered to be the same. Setting one of the
		1409	radii to 1 and the other to a large number creates interesting effects
		1410	on some backgrounds. The maximum radius value is 128. An horizontal or
		1411	vertical radius of 0 disables blurring.
		1412
		1413	=item B<path:> I<path>
		1414
		1415	Specify the colon-delimited search path for finding background image files.
1347		1416
1348	=back	1417	=back
1349		1418
1350	=head1 THE SCROLLBAR	1419	=head1 THE SCROLLBAR
1351		1420
…		…
1399	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1468	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1400	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1469	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1401		1470
1402	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1471	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1403	inserted too.	1472	inserted too.
		1473
		1474	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1475	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1476	binding causes the value of the internal selection to be copied to the
		1477	CLIPBOARD selection, while the second binding causes the value of the
		1478	CLIPBOARD selection to be inserted.
1404		1479
1405	=back	1480	=back
1406		1481
1407	=head1 CHANGING FONTS	1482	=head1 CHANGING FONTS
1408		1483
…		…
1533	The following text gives values for the standard 88 colour mode (and	1608	The following text gives values for the standard 88 colour mode (and
1534	values for the 256 colour mode in parentheses).	1609	values for the 256 colour mode in parentheses).
1535		1610
1536	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1611	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1537		1612
1538	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1613	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1539	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1614	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1540		1615
1541	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1616	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1542	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1617	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1543	the RGB cube.	1618	the RGB cube.
1544		1619
…		…
1652		1727
1653	=item B<SHELL>	1728	=item B<SHELL>
1654		1729
1655	The shell to be used for command execution, defaults to C</bin/sh>.	1730	The shell to be used for command execution, defaults to C</bin/sh>.
1656		1731
1657	=item B<RXVT_SOCKET>	1732	=item B<RXVT_SOCKET> [I<sic>]
1658		1733
1659	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1734	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1660	@@RXVT_NAME@@d(1).	1735	@@RXVT_NAME@@d(1).
1661		1736
1662	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.	1737	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1738
		1739	=item B<URXVT_PERL_LIB>
		1740
		1741	Additional F<:>-separated library search path for perl extensions. Will be
		1742	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1743	directory.
		1744
		1745	=item B<URXVT_PERL_VERBOSITY>
		1746
		1747	See L<@@RXVT_NAME@@perl>(3).
1663		1748
1664	=item B<HOME>	1749	=item B<HOME>
1665		1750
1666	Used to locate the default directory for the unix domain socket for	1751	Used to locate the default directory for the unix domain socket for
1667	daemon communications and to locate various resource files (such as	1752	daemon communications and to locate various resource files (such as
…		…
1688		1773
1689	=back	1774	=back
1690		1775
1691	=head1 SEE ALSO	1776	=head1 SEE ALSO
1692		1777
		1778	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1693	@@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)	1779	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1694		1780
1695	=head1 CURRENT PROJECT COORDINATOR	1781	=head1 CURRENT PROJECT COORDINATOR
1696		1782
1697	=over 4	1783	=over 4
1698		1784
1699	=item Project Coordinator	1785	=item Project Coordinator
1700		1786
1701	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1787	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1702		1788
1703	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1789	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1704		1790
1705	=back	1791	=back
1706		1792
…		…
1710		1796
1711	=item John Bovey	1797	=item John Bovey
1712		1798
1713	University of Kent, 1992, wrote the original Xvt.	1799	University of Kent, 1992, wrote the original Xvt.
1714		1800
1715	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1801	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1716		1802
1717	very heavily modified Xvt and came up with Rxvt	1803	very heavily modified Xvt and came up with Rxvt
1718		1804
1719	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1805	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1720		1806
1721	wrote the Greek Keyboard Input (no longer in code)	1807	wrote the Greek Keyboard Input (no longer in code)
1722		1808
1723	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1809	=item mj olesen <olesen@me.QueensU.CA>
1724		1810
1725	Wrote the menu system.	1811	Wrote the menu system.
1726		1812
1727	Project Coordinator (changes.txt 2.11 to 2.21)	1813	Project Coordinator (changes.txt 2.11 to 2.21)
1728		1814
1729	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1815	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1730		1816
1731	Project Coordinator (changes.txt 2.21a to 2.4.5)	1817	Project Coordinator (changes.txt 2.21a to 2.4.5)
1732		1818
1733	=item Geoff Wing L<< <gcw@pobox.com> >>	1819	=item Geoff Wing <gcw@pobox.com>
1734		1820
1735	Rewrote screen display and text selection routines.	1821	Rewrote screen display and text selection routines.
1736		1822
1737	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1823	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1738		1824
1739	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1825	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1740		1826
1741	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1827	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1742	extension, random hacks, numerous bugfixes and extensions.	1828	extension, random hacks, numerous bugfixes and extensions.
1743		1829
1744	Project Coordinator (Changes 1.0 -)	1830	Project Coordinator (Changes 1.0 -)
1745		1831
1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1832	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1747		1833
1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1834	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1749		1835
1750	=back	1836	=back
1751		1837

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC vs. Revision 1.238 by sf-exg, Sat Oct 11 22:02:50 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC vs.
Revision 1.238 by sf-exg, Sat Oct 11 22:02:50 2014 UTC