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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC vs.
Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC

…		…
127		127
128	=item B<-ss>\|B<+ss>	128	=item B<-ss>\|B<+ss>
129		129
130	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>.
131		131
132	=item B<-tr>\|B<+tr>
133
134	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
135
136	B<-ip> is still accepted as an obsolete alias but will be removed in
137	future versions.
138
139	=item B<-fade> I<number>	132	=item B<-fade> I<number>
140		133
141	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
142	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
143	colour; resource B<fading>.	136	colour; resource B<fading>.
…		…
145	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
146		139
147	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
148	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
149		142
150	=item B<-tint> I<colour>
151
152	Tint the transparent background with the given colour;
153	resource I<tintColor>.
154
155	=item B<-sh> I<number>
156
157	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
158	A value of 100 means no shading; resource I<shading>.
159
160	=item B<-blr> I<HxV>
161
162	Apply Gaussian Blur with the specified radii to the transparent
163	background. If a single number is specified, the vertical and
164	horizontal radii are considered to be the same. Setting one of the
165	radii to 1 and the other to a large number creates interesting effects
166	on some backgrounds. The maximum radius value is 128. An horizontal or
167	vertical radius of 0 disables blurring;
168	resource I<blurRadius>.
169
170	=item B<-icon> I<file>	143	=item B<-icon> I<file>
171		144
172	Compile I<pixbuf>: Use the specified image as application icon. This	145	Compile I<pixbuf>: Use the specified image as application icon. This
173	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
174	application window; resource I<iconFile>.	147	application window; resource I<iconFile>.
…		…
178	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
179		152
180	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
181		154
182	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
183
184	=item B<-pixmap> I<file[;oplist]>
185
186	Compile I<pixbuf>: Specify image file for the background and also
187	optionally specify a list of operations to modify it. Note you may need to
188	add quotes to avoid special shell interpretation of the C<;> in the
189	command-line; for more details see resource B<backgroundPixmap>.
190		156
191	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
192		158
193	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
194		160
…		…
253		219
254	=item B<-ls>\|B<+ls>	220	=item B<-ls>\|B<+ls>
255		221
256	Start as a login-shell/sub-shell; resource B<loginShell>.	222	Start as a login-shell/sub-shell; resource B<loginShell>.
257		223
		224	=item B<-mc> I<milliseconds>
		225
		226	Specify the maximum time between multi-click selections.
		227
258	=item B<-ut>\|B<+ut>	228	=item B<-ut>\|B<+ut>
259		229
260	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	230	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
261	B<utmpInhibit>.	231	B<utmpInhibit>.
262		232
…		…
340		310
341	=item B<-override-redirect>	311	=item B<-override-redirect>
342		312
343	Compile I<frills>: Sets override-redirect on the window; resource	313	Compile I<frills>: Sets override-redirect on the window; resource
344	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.
345		320
346	=item B<-sbg>	321	=item B<-sbg>
347		322
348	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
349	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
…		…
683		658
684	B<False>: specify that everything is to be displayed, even	659	B<False>: specify that everything is to be displayed, even
685	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
686	monitor to display anything); option B<+ss>.	661	monitor to display anything); option B<+ss>.
687		662
688	=item B<transparent:> I<boolean>
689
690	Turn on/off pseudo-transparency by using the root pixmap as background.
691
692	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
693	future versions.
694
695	=item B<fading:> I<number>	663	=item B<fading:> I<number>
696		664
697	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>.
698		666
699	=item B<fadeColor:> I<colour>	667	=item B<fadeColor:> I<colour>
700		668
701	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
702	colour is black; option B<-fadecolor>.	670	colour is black; option B<-fadecolor>.
703		671
704	=item B<tintColor:> I<colour>
705
706	Tint the transparent background with the given colour. If the RENDER
707	extension is not available only black, red, green, yellow, blue,
708	magenta, cyan and white tints can be performed server-side. Note that
709	a black tint yields a completely black image while a white tint yields
710	the image unchanged; option B<-tint>.
711
712	=item B<shading:> I<number>
713
714	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
715	A value of 100 means no shading; option B<-sh>.
716
717	=item B<blurRadius:> I<number>
718
719	Apply gaussian blur with the specified radius to the transparent
720	background; option B<-blr>.
721
722	=item B<iconFile:> I<file>	672	=item B<iconFile:> I<file>
723		673
724	Set the application icon pixmap; option B<-icon>.	674	Set the application icon pixmap; option B<-icon>.
725		675
726	=item B<scrollColor:> I<colour>	676	=item B<scrollColor:> I<colour>
…		…
734		684
735	=item B<borderColor:> I<colour>	685	=item B<borderColor:> I<colour>
736		686
737	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
738	and the text.	688	and the text.
739
740	=item B<backgroundPixmap:> I<file[;oplist]>
741
742	Use the specified image file for the background and also
743	optionally specify a colon separated list of operations to modify it.
744	Supported operations are:
745
746	=over 4
747
748	=item B<WxH+X+Y>
749
750	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
751	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
752	scale of 0 disables scaling.
753
754	=item B<op=tile>
755
756	enables tiling
757
758	=item B<op=keep-aspect>
759
760	maintain the image aspect ratio when scaling
761
762	=item B<op=root-align>
763
764	use the position of the terminal window relative to the root window as
765	the image offset, simulating a root window background
766
767	=back
768
769	The default scale and position setting is C<100x100+50+50>.
770	Alternatively, a predefined set of templates can be used to achieve
771	the most common setups:
772
773	=over 4
774
775	=item B<style=tiled>
776
777	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
778
779	=item B<style=aspect-stretched>
780
781	the image is scaled to fill the whole window maintaining the aspect
782	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
783
784	=item B<style=stretched>
785
786	the image is scaled to fill the whole window. Equivalent to 100x100
787
788	=item B<style=centered>
789
790	the image is centered with no scaling. Equivalent to 0x0+50+50
791
792	=item B<style=root-tiled>
793
794	the image is tiled with no scaling and using 'root' positioning.
795	Equivalent to 0x0:op=tile:op=root-align
796
797	=back
798
799	If multiple templates are specified the last one wins. Note that a
800	template overrides all the scale, position and operations settings.
801
802	If used in conjunction with B<-tr> option, the specified pixmap will be
803	blended over the transparent background using alpha-blending.
804
805	=item B<path:> I<path>
806
807	Specify the colon-delimited search path for finding background image files.
808		689
809	=item B<font:> I<fontlist>	690	=item B<font:> I<fontlist>
810		691
811	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
812	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
…		…
908	=item B<loginShell:> I<boolean>	789	=item B<loginShell:> I<boolean>
909		790
910	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
911	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
912	[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>.
913		799
914	=item B<utmpInhibit:> I<boolean>	800	=item B<utmpInhibit:> I<boolean>
915		801
916	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>;
917	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>
…		…
1169	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
1170	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
1171	@@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
1172	directory will be used; option B<-cd>.	1058	directory will be used; option B<-cd>.
1173		1059
1174	=item B<keysym.>I<sym>: I<string>	1060	=item B<keysym.>I<sym>: I<action>
1175		1061
1176	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1062	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1177	intervening resource name B<keysym.> cannot be omitted.	1063	resource name B<keysym.> cannot be omitted.
1178		1064
1179	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
1180	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1066	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1181	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
1182	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
1183	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>.
1184		1079
1185	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
1186	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
1187	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
1188	current application keymap mode state.	1083	current application keymap mode state.
1189		1084
1190	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
1191	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
1192	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
1193	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1097	value (B<0x0000 - 0xFFFF>).
1194	performed in an exact manner; however, the closest match is assured.
1195		1098
1196	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
1197	number), see RESOURCES in C<man 7 X> for further details.	1101	number), see RESOURCES in C<man 7 X> for further details.
1198		1102
1199	You can define a range of keysyms in one shot by	1103	An action starts with an action prefix that selects a certain type
1200	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
1201	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
		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
1202	should be a character not used by the strings.	1127	the delimiter `/' should be a character not used by the strings.
1203		1128
1204	Its usage can be demonstrated by an example:	1129	Its usage can be demonstrated by an example:
1205		1130
1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1131	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1207		1132
1208	The above line is equivalent to the following three lines:	1133	The above line is equivalent to the following three lines:
1209		1134
1210	URxvt.keysym.Meta-Control-0x61: \033<a>	1135	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1211	URxvt.keysym.Meta-Control-0x62: \033<b>	1136	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1212	URxvt.keysym.Meta-Control-0x63: \033<c>	1137	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1213		1138
		1139	=item command:STRING
		1140
1214	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>
1215	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
1216	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>
1217	when Control-Meta-c is being pressed":	1148	when Control-Meta-c is being pressed":
1218		1149
1219	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
1220		1151
1221	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
1222	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
1223	manpage. For example, the F<selection> extension (activated via	1154	font-switching at runtime:
1224	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1225		1155
1226	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
1227		1158
1228	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
1229	will match if I<at least> the specified identifiers are being set, and	1160	info):
1230	no other key mappings with those and more bits are being defined. That
1231	means that defining a key map for C<a> will automatically provide
1232	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1233	mappings themselves.
1234		1161
1235	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
1236	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
1237	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
1238	user-defined keymap using the C<builtin:> replacement:	1174	"holes" into the user-defined keymap using the C<builtin:> replacement:
1239		1175
1240	URxvt.keysym.Insert: <my insert key sequence>	1176	URxvt.keysym.Insert: <my insert key sequence>
1241	URxvt.keysym.S-Insert: builtin:	1177	URxvt.keysym.S-Insert: builtin:
1242		1178
1243	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
1244	of modifiers. The second line re-establishes the default mapping for	1180	of modifiers. The second line re-establishes the default mapping for
1245	C<Shift-Insert>.	1181	C<Shift-Insert>.
1246		1182
1247	The following example will map Control-Meta-1 and Control-Meta-2 to	1183	=item builtin-string:
1248	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1249	font-switching at runtime:
1250		1184
1251	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1185	This action is mainly useful to restore string mappings for keys that
1252	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.
1253		1190
1254	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
1255	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:
1256		1195
1257	URxvt.keysym.M-C-3: command:\033[8;25;80t	1196	URxvt.keysym.S-Insert: builtin-string:
1258	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
1259		1233
1260	=item B<perl-ext-common>: I<string>	1234	=item B<perl-ext-common>: I<string>
1261		1235
1262	=item B<perl-ext>: I<string>	1236	=item B<perl-ext>: I<string>
1263		1237
…		…
1265	use in this terminal instance; option B<-pe>.	1239	use in this terminal instance; option B<-pe>.
1266		1240
1267	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
1268	them. This can be useful to selectively disable some extensions loaded	1242	them. This can be useful to selectively disable some extensions loaded
1269	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
1270	example, C<default,-selection> will use all the default extension except	1244	example, C<default,-selection> will use all the default extensions except
1271	C<selection>.	1245	C<selection>.
1272		1246
1273	Extension names can also be followed by an argument in angle brackets	1247	The default set includes the C<selection>, C<option-popup>,
1274	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1248	C<selection-popup> and C<readline> extensions, any extensions that
1275	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1249	define keybindings via C<BINDING> meta comments, and extensions which
1276	multiple times with different arguments will pass multiple arguments to	1250	are mentioned in B<keysym> resources.
1277	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>.
1278		1254
1279	Each extension is looked up in the library directories, loaded if	1255	Each extension is looked up in the library directories, loaded if
1280	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.
1281		1259
1282	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
1283	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
1284	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
1285	all instances, while B<perl-ext> is used for specific instances.	1263	all instances, while B<perl-ext> is used for specific instances.
1286		1264
1287	=item B<perl-eval>: I<string>	1265	=item B<perl-eval>: I<string>
1288		1266
…		…
1306	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1284	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1307		1285
1308	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1286	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1309	for details.	1287	for details.
1310		1288
1311	=item B<searchable-scrollback:> I<keysym>	1289	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1312		1290
1313	Sets the hotkey that starts the incremental scrollback buffer search	1291	This resource is deprecated and will be removed. Use a B<keysym> resource
1314	(default: C<M-s>).	1292	instead, e.g.:
1315		1293
		1294	URxvt.keysym.M-s: searchable-scrollback:start
		1295
1316	=item B<urlLauncher>: I<string>	1296	=item B<url-launcher>: I<string>
1317		1297
1318	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
1319	C<selection-popup> and C<matcher> perl extensions.	1299	C<selection-popup> and C<matcher> perl extensions.
1320		1300
1321	=item B<transient-for>: I<windowid>	1301	=item B<transient-for>: I<windowid>
…		…
1332	Turn on/off ISO 14755 (default enabled).	1312	Turn on/off ISO 14755 (default enabled).
1333		1313
1334	=item B<iso14755_52:> I<boolean>	1314	=item B<iso14755_52:> I<boolean>
1335		1315
1336	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.
1337		1431
1338	=back	1432	=back
1339		1433
1340	=head1 THE SCROLLBAR	1434	=head1 THE SCROLLBAR
1341		1435
…		…
1389	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
1390	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.
1391		1485
1392	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
1393	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.
1394		1494
1395	=back	1495	=back
1396		1496
1397	=head1 CHANGING FONTS	1497	=head1 CHANGING FONTS
1398		1498
…		…
1523	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
1524	values for the 256 colour mode in parentheses).	1624	values for the 256 colour mode in parentheses).
1525		1625
1526	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:
1527		1627
1528	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
1529	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
1530		1630
1531	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%
1532	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
1533	the RGB cube.	1633	the RGB cube.
1534		1634
…		…
1697		1797
1698	=over 4	1798	=over 4
1699		1799
1700	=item Project Coordinator	1800	=item Project Coordinator
1701		1801
1702	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1802	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1703		1803
1704	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1804	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1705		1805
1706	=back	1806	=back
1707		1807
…		…
1711		1811
1712	=item John Bovey	1812	=item John Bovey
1713		1813
1714	University of Kent, 1992, wrote the original Xvt.	1814	University of Kent, 1992, wrote the original Xvt.
1715		1815
1716	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1816	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1717		1817
1718	very heavily modified Xvt and came up with Rxvt	1818	very heavily modified Xvt and came up with Rxvt
1719		1819
1720	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1820	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1721		1821
1722	wrote the Greek Keyboard Input (no longer in code)	1822	wrote the Greek Keyboard Input (no longer in code)
1723		1823
1724	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1824	=item mj olesen <olesen@me.QueensU.CA>
1725		1825
1726	Wrote the menu system.	1826	Wrote the menu system.
1727		1827
1728	Project Coordinator (changes.txt 2.11 to 2.21)	1828	Project Coordinator (changes.txt 2.11 to 2.21)
1729		1829
1730	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1830	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1731		1831
1732	Project Coordinator (changes.txt 2.21a to 2.4.5)	1832	Project Coordinator (changes.txt 2.21a to 2.4.5)
1733		1833
1734	=item Geoff Wing L<< <gcw@pobox.com> >>	1834	=item Geoff Wing <gcw@pobox.com>
1735		1835
1736	Rewrote screen display and text selection routines.	1836	Rewrote screen display and text selection routines.
1737		1837
1738	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1838	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1739		1839
1740	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1840	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1741		1841
1742	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1842	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1743	extension, random hacks, numerous bugfixes and extensions.	1843	extension, random hacks, numerous bugfixes and extensions.
1744		1844
1745	Project Coordinator (Changes 1.0 -)	1845	Project Coordinator (Changes 1.0 -)
1746		1846
1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1847	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1748		1848
1749	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.
1750		1850
1751	=back	1851	=back
1752		1852

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.220 by root, Fri Sep 21 23:31:43 2012 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.220 by root, Fri Sep 21 23:31:43 2012 UTC vs.
Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC