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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 UTC vs. Revision 1.241 by root, Wed Dec 17 15:22:10 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 UTC vs.
Revision 1.241 by root, Wed Dec 17 15:22:10 2014 UTC