[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.239 by sf-exg, Sun Oct 12 20:51:51 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
1202	should be a character not used by the strings.	1106	prefixed with C<string:>).
1203		1107
1204	Its usage can be demonstrated by an example:	1108	The following action prefixes are known - extensions can provide
		1109	additional prefixes:
1205		1110
1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1111	=over 4
1207		1112
1208	The above line is equivalent to the following three lines:	1113	=item string:STRING
1209		1114
1210	URxvt.keysym.Meta-Control-0x61: \033<a>	1115	If the I<action> starts with C<string:> (or otherwise contains no colons),
1211	URxvt.keysym.Meta-Control-0x62: \033<b>	1116	then the remaining C<STRING> will be passed to the program running in the
1212	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:
1213		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
1214	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>
1215	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
1216	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>
1217	when Control-Meta-c is being pressed":	1133	when Control-Meta-c is being pressed":
1218		1134
1219	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
1220		1136
1221	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
1222	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
1223	manpage. For example, the F<selection> extension (activated via	1139	font-switching at runtime:
1224	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1225		1140
1226	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
1227		1143
1228	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
1229	will match if I<at least> the specified identifiers are being set, and	1145	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		1146
1235	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
1236	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
1237	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
1238	user-defined keymap using the C<builtin:> replacement:	1159	"holes" into the user-defined keymap using the C<builtin:> replacement:
1239		1160
1240	URxvt.keysym.Insert: <my insert key sequence>	1161	URxvt.keysym.Insert: <my insert key sequence>
1241	URxvt.keysym.S-Insert: builtin:	1162	URxvt.keysym.S-Insert: builtin:
1242		1163
1243	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
1244	of modifiers. The second line re-establishes the default mapping for	1165	of modifiers. The second line re-establishes the default mapping for
1245	C<Shift-Insert>.	1166	C<Shift-Insert>.
1246		1167
1247	The following example will map Control-Meta-1 and Control-Meta-2 to	1168	=item builtin-string:
1248	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1249	font-switching at runtime:
1250		1169
1251	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1170	This action is mainly useful to restore string mappings for keys that
1252	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.
1253		1175
1254	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
1255	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:
1256		1180
1257	URxvt.keysym.M-C-3: command:\033[8;25;80t	1181	URxvt.keysym.S-Insert: builtin-string:
1258	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 invokes the action B<STRING>, if any, provided
		1198	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1199	be loaded automatically if necessary.
		1200
		1201	Not all extensions define 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 invoking commands provided by perl
		1215	extensions. It is still supported, but should not be used anymore.
		1216
		1217	=back
1259		1218
1260	=item B<perl-ext-common>: I<string>	1219	=item B<perl-ext-common>: I<string>
1261		1220
1262	=item B<perl-ext>: I<string>	1221	=item B<perl-ext>: I<string>
1263		1222
…		…
1265	use in this terminal instance; option B<-pe>.	1224	use in this terminal instance; option B<-pe>.
1266		1225
1267	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
1268	them. This can be useful to selectively disable some extensions loaded	1227	them. This can be useful to selectively disable some extensions loaded
1269	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
1270	example, C<default,-selection> will use all the default extension except	1229	example, C<default,-selection> will use all the default extensions except
1271	C<selection>.	1230	C<selection>.
1272		1231
1273	Extension names can also be followed by an argument in angle brackets	1232	The default set includes the C<selection>, C<option-popup>,
1274	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1233	C<selection-popup> and C<readline> extensions, any extensions that
1275	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1234	define keybindings via C<BINDING> meta comments, and extensions which
1276	multiple times with different arguments will pass multiple arguments to	1235	are mentioned in B<keysym> resources.
1277	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>.
1278		1239
1279	Each extension is looked up in the library directories, loaded if	1240	Each extension is looked up in the library directories, loaded if
1280	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.
1281		1244
1282	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
1283	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
1284	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
1285	all instances, while B<perl-ext> is used for specific instances.	1248	all instances, while B<perl-ext> is used for specific instances.
1286		1249
1287	=item B<perl-eval>: I<string>	1250	=item B<perl-eval>: I<string>
1288		1251
…		…
1306	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1269	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1307		1270
1308	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1271	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1309	for details.	1272	for details.
1310		1273
1311	=item B<searchable-scrollback:> I<keysym>	1274	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1312		1275
1313	Sets the hotkey that starts the incremental scrollback buffer search	1276	This resource is deprecated and will be removed. Use a B<keysym> resource
1314	(default: C<M-s>).	1277	instead, e.g.:
1315		1278
		1279	URxvt.keysym.M-s: searchable-scrollback:start
		1280
1316	=item B<urlLauncher>: I<string>	1281	=item B<url-launcher>: I<string>
1317		1282
1318	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
1319	C<selection-popup> and C<matcher> perl extensions.	1284	C<selection-popup> and C<matcher> perl extensions.
1320		1285
1321	=item B<transient-for>: I<windowid>	1286	=item B<transient-for>: I<windowid>
…		…
1332	Turn on/off ISO 14755 (default enabled).	1297	Turn on/off ISO 14755 (default enabled).
1333		1298
1334	=item B<iso14755_52:> I<boolean>	1299	=item B<iso14755_52:> I<boolean>
1335		1300
1336	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.
1337		1416
1338	=back	1417	=back
1339		1418
1340	=head1 THE SCROLLBAR	1419	=head1 THE SCROLLBAR
1341		1420
…		…
1389	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
1390	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.
1391		1470
1392	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
1393	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.
1394		1479
1395	=back	1480	=back
1396		1481
1397	=head1 CHANGING FONTS	1482	=head1 CHANGING FONTS
1398		1483
…		…
1523	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
1524	values for the 256 colour mode in parentheses).	1609	values for the 256 colour mode in parentheses).
1525		1610
1526	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:
1527		1612
1528	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
1529	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
1530		1615
1531	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%
1532	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
1533	the RGB cube.	1618	the RGB cube.
1534		1619
…		…
1697		1782
1698	=over 4	1783	=over 4
1699		1784
1700	=item Project Coordinator	1785	=item Project Coordinator
1701		1786
1702	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1787	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1703		1788
1704	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1789	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1705		1790
1706	=back	1791	=back
1707		1792
…		…
1711		1796
1712	=item John Bovey	1797	=item John Bovey
1713		1798
1714	University of Kent, 1992, wrote the original Xvt.	1799	University of Kent, 1992, wrote the original Xvt.
1715		1800
1716	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1801	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1717		1802
1718	very heavily modified Xvt and came up with Rxvt	1803	very heavily modified Xvt and came up with Rxvt
1719		1804
1720	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1805	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1721		1806
1722	wrote the Greek Keyboard Input (no longer in code)	1807	wrote the Greek Keyboard Input (no longer in code)
1723		1808
1724	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1809	=item mj olesen <olesen@me.QueensU.CA>
1725		1810
1726	Wrote the menu system.	1811	Wrote the menu system.
1727		1812
1728	Project Coordinator (changes.txt 2.11 to 2.21)	1813	Project Coordinator (changes.txt 2.11 to 2.21)
1729		1814
1730	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1815	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1731		1816
1732	Project Coordinator (changes.txt 2.21a to 2.4.5)	1817	Project Coordinator (changes.txt 2.21a to 2.4.5)
1733		1818
1734	=item Geoff Wing L<< <gcw@pobox.com> >>	1819	=item Geoff Wing <gcw@pobox.com>
1735		1820
1736	Rewrote screen display and text selection routines.	1821	Rewrote screen display and text selection routines.
1737		1822
1738	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1823	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1739		1824
1740	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1825	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1741		1826
1742	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1827	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1743	extension, random hacks, numerous bugfixes and extensions.	1828	extension, random hacks, numerous bugfixes and extensions.
1744		1829
1745	Project Coordinator (Changes 1.0 -)	1830	Project Coordinator (Changes 1.0 -)
1746		1831
1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1832	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1748		1833
1749	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.
1750		1835
1751	=back	1836	=back
1752		1837

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.239 by sf-exg, Sun Oct 12 20:51:51 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.239 by sf-exg, Sun Oct 12 20:51:51 2014 UTC