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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 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
…		…
398		379
399	=item B<-pt> I<style>	380	=item B<-pt> I<style>
400		381
401	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
402	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
403		387
404	=item B<-im> I<text>	388	=item B<-im> I<text>
405		389
406	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
407		391
…		…
678		662
679	B<False>: specify that everything is to be displayed, even	663	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	664	if the refresh is too fast for the human eye to read anything (or the
681	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
682		666
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>	667	=item B<fading:> I<number>
691		668
692	Fade the text by the given percentage when focus is lost; option B<-fade>.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
693		670
694	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
695		672
696	Fade to this colour, when fading is used (see B<fading:>). The default	673	Fade to this colour, when fading is used (see B<fading:>). The default
697	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
698		675
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<blendType:> I<string>
713
714	Specify background blending type; option B<-blt>.
715
716	=item B<blurRadius:> I<number>
717
718	Apply gaussian blur with the specified radius to the transparent
719	background; option B<-blr>.
720
721	=item B<iconFile:> I<file>	676	=item B<iconFile:> I<file>
722		677
723	Set the application icon pixmap; option B<-icon>.	678	Set the application icon pixmap; option B<-icon>.
724		679
725	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
…		…
733		688
734	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
735		690
736	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
737	and the text.	692	and the text.
738
739	=item B<backgroundPixmap:> I<file[;oplist]>
740
741	Use the specified image file for the background and also
742	optionally specify a colon separated list of operations to modify it.
743	Supported operations are:
744
745	=over 4
746
747	=item B<WxH+X+Y>
748
749	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
750	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
751	scale of 0 disables scaling. The maximum permitted scale is 1000.
752
753	=item B<op=tile>
754
755	enables tiling
756
757	=item B<op=keep-aspect>
758
759	maintain the image aspect ratio when scaling
760
761	=item B<op=root-align>
762
763	use the position of the terminal window relative to the root window as
764	the image offset, simulating a root window background
765
766	=back
767
768	The default scale and position setting is C<100x100+50+50>.
769	Alternatively, a predefined set of templates can be used to achieve
770	the most common setups:
771
772	=over 4
773
774	=item B<style=tiled>
775
776	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
777
778	=item B<style=aspect-stretched>
779
780	the image is scaled to fill the whole window maintaining the aspect
781	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
782
783	=item B<style=stretched>
784
785	the image is scaled to fill the whole window. Equivalent to 100x100
786
787	=item B<style=centered>
788
789	the image is centered with no scaling. Equivalent to 0x0+50+50
790
791	=item B<style=root-tiled>
792
793	the image is tiled with no scaling and using 'root' positioning.
794	Equivalent to 0x0:op=tile:op=root-align
795
796	=back
797
798	If multiple templates are specified the last one wins. Note that a
799	template overrides all the scale, position and operations settings.
800
801	If used in conjunction with B<-tr> option, the specified pixmap will be
802	blended over the transparent background using alpha-blending.
803
804	=item B<path:> I<path>
805
806	Specify the colon-delimited search path for finding background image files.
807		693
808	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
809		695
810	Select the fonts to be used. This is a comma separated list of font names	696	Select the fonts to be used. This is a comma separated list of font names
811	that are checked in order when trying to find glyphs for characters. The	697	that are checked in order when trying to find glyphs for characters. The
…		…
908		794
909	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
910	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
911	[default]; option B<+ls>.	797	[default]; option B<+ls>.
912		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
913	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
914		805
915	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
916	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
917	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
1054		945
1055	=item B<pointerColor2:> I<colour>	946	=item B<pointerColor2:> I<colour>
1056		947
1057	Mouse pointer background colour.	948	Mouse pointer background colour.
1058		949
		950	=item B<pointerShape:> I<string>
		951
		952	Compile I<frills>: Specifies the name of the mouse pointer shape
		953	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		954	file for possible values (omit the C<XC_> prefix).
		955
1059	=item B<pointerBlankDelay:> I<number>	956	=item B<pointerBlankDelay:> I<number>
1060		957
1061	Specifies number of seconds before blanking the pointer [default 2]. Use a	958	Specifies number of seconds before blanking the pointer [default 2]. Use a
1062	large number (e.g. C<987654321>) to effectively disable the timeout.	959	large number (e.g. C<987654321>) to effectively disable the timeout.
1063		960
…		…
1089		986
1090	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	987	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1091		988
1092	=item B<preeditType:> I<style>	989	=item B<preeditType:> I<style>
1093		990
1094	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	991	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1095		992
1096	=item B<inputMethod:> I<name>	993	=item B<inputMethod:> I<name>
1097		994
1098	I<name> of inputMethod to use; option B<-im>.	995	I<name> of inputMethod to use; option B<-im>.
1099		996
…		…
1168	Sets the working directory for the shell (or the command specified via	1065	Sets the working directory for the shell (or the command specified via
1169	B<-e>). The I<path> must be an absolute path and it must exist for	1066	B<-e>). The I<path> must be an absolute path and it must exist for
1170	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1067	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1171	directory will be used; option B<-cd>.	1068	directory will be used; option B<-cd>.
1172		1069
1173	=item B<keysym.>I<sym>: I<string>	1070	=item B<keysym.>I<sym>: I<action>
1174		1071
1175	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1072	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1176	intervening resource name B<keysym.> cannot be omitted.	1073	resource name B<keysym.> cannot be omitted.
1177		1074
1178	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1075	Using this resource, you can map key combinations such as
1179	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1076	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1180	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1077	string than would normally result from that combination, making the
1181	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1078	terminal scroll up or down the way you want it, or any other thing an
1182	B<2>, B<3>, B<4>, B<5>.	1079	extension might provide.
		1080
		1081	The key combination that triggers the action, I<sym>, has the following format:
		1082
		1083	(modifiers-)key
		1084
		1085	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1086	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1087	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1088	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1183		1089
1184	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1090	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1185	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1091	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1186	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1092	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1187	current application keymap mode state.	1093	current application keymap mode state.
1188		1094
1189	The spellings of I<key> can be obtained by using B<xev>(1) command or	1095	Due the the large number of modifier combinations, a key mapping will
1190	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1096	match if I<at least> the specified identifiers are being set, and no other
		1097	key mappings with those and more bits are being defined. That means that
		1098	defining a mapping for C<a> will automatically provide definitions for
		1099	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1100	themselves. See the C<builtin:> action, below, for a way to work around
		1101	this when this is a problem.
		1102
		1103	The spelling of I<key> depends on your implementation of X. An easy way to
		1104	find a key name is to use the B<xev>(1) command. You can find a list by
		1105	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1191	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1106	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1192	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1107	value (B<0x0000 - 0xFFFF>).
1193	performed in an exact manner; however, the closest match is assured.
1194		1108
1195	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1109	As with any resource value, the I<action> string may contain backslash
		1110	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1196	number), see RESOURCES in C<man 7 X> for further details.	1111	number), see RESOURCES in C<man 7 X> for further details.
1197		1112
1198	You can define a range of keysyms in one shot by	1113	An action starts with an action prefix that selects a certain type
1199	loading the C<keysym-list> perl extension and providing a I<string>	1114	of action, followed by a colon. An action string without colons is
1200	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1115	interpreted as a literal string to pass to the tty (as if it was
		1116	prefixed with C<string:>).
		1117
		1118	The following action prefixes are known - extensions can provide
		1119	additional prefixes:
		1120
		1121	=over 4
		1122
		1123	=item string:STRING
		1124
		1125	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1126	then the remaining C<STRING> will be passed to the program running in the
		1127	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1128	string C<echo rm -rf /> followed by a newline:
		1129
		1130	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1131
		1132	This could in theory be used to completely redefine your keymap.
		1133
		1134	In addition, for actions of this type, you can define a range of
		1135	keysyms in one shot by loading the C<keysym-list> perl extension and
		1136	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1201	should be a character not used by the strings.	1137	the delimiter `/' should be a character not used by the strings.
1202		1138
1203	Its usage can be demonstrated by an example:	1139	Its usage can be demonstrated by an example:
1204		1140
1205	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1141	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1206		1142
1207	The above line is equivalent to the following three lines:	1143	The above line is equivalent to the following three lines:
1208		1144
1209	URxvt.keysym.Meta-Control-0x61: \033<a>	1145	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1210	URxvt.keysym.Meta-Control-0x62: \033<b>	1146	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1211	URxvt.keysym.Meta-Control-0x63: \033<c>	1147	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1212		1148
		1149	=item command:STRING
		1150
1213	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1151	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1214	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1152	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1153	the opposite of C<string:> - instead of sending it to the program running
		1154	in the terminal, it will be treated as if it were program output). This is
		1155	most useful to feed command sequences into @@RXVT_NAME@@.
		1156
1215	example the following means "change the current locale to C<zh_CN.GBK>	1157	For example the following means "change the current locale to C<zh_CN.GBK>
1216	when Control-Meta-c is being pressed":	1158	when Control-Meta-c is being pressed":
1217		1159
1218	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1160	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1219		1161
1220	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1162	The following example will map Control-Meta-1 and Control-Meta-2 to
1221	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1163	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1222	manpage. For example, the F<selection> extension (activated via	1164	font-switching at runtime:
1223	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1224		1165
1225	URxvt.keysym.M-C-c: perl:selection:rot13	1166	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1167	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1226		1168
1227	Due the the large number of modifier combinations, a defined key mapping	1169	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1228	will match if I<at least> the specified identifiers are being set, and	1170	info):
1229	no other key mappings with those and more bits are being defined. That
1230	means that defining a key map for C<a> will automatically provide
1231	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1232	mappings themselves.
1233		1171
1234	Unfortunately, this will override built-in key mappings. For example	1172	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1173	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1174
		1175	=item builtin:
		1176
		1177	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1178	key binding existed for the key combination. The obvious use is to undo
		1179	the effect of existing bindings. The not so obvious use is to reinstate
		1180	bindings when another binding overrides too many modifiers.
		1181
1235	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1182	For example if you overwrite the C<Insert> key you will disable
1236	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1183	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1237	user-defined keymap using the C<builtin:> replacement:	1184	"holes" into the user-defined keymap using the C<builtin:> replacement:
1238		1185
1239	URxvt.keysym.Insert: <my insert key sequence>	1186	URxvt.keysym.Insert: <my insert key sequence>
1240	URxvt.keysym.S-Insert: builtin:	1187	URxvt.keysym.S-Insert: builtin:
1241		1188
1242	The first line defines a mapping for C<Insert> and I<any> combination	1189	The first line defines a mapping for C<Insert> and I<any> combination
1243	of modifiers. The second line re-establishes the default mapping for	1190	of modifiers. The second line re-establishes the default mapping for
1244	C<Shift-Insert>.	1191	C<Shift-Insert>.
1245		1192
1246	The following example will map Control-Meta-1 and Control-Meta-2 to	1193	=item builtin-string:
1247	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1248	font-switching at runtime:
1249		1194
1250	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1195	This action is mainly useful to restore string mappings for keys that
1251	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1196	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1197	difficult to explain - basically, this action will send the string to the
		1198	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1199	action for it.
1252		1200
1253	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1201	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1254	info):	1202	selection when you press C<Shift-Insert>. With the following bindings, it
		1203	would instead emit the (undocumented, but what applications running in the
		1204	terminal might expect) sequence C<ESC [ 2 $> instead:
1255		1205
1256	URxvt.keysym.M-C-3: command:\033[8;25;80t	1206	URxvt.keysym.S-Insert: builtin-string:
1257	URxvt.keysym.M-C-4: command:\033[8;48;110t	1207	URxvt.keysym.C-S-Insert: builtin:
		1208
		1209	The first line disables the paste functionality for that key
		1210	combination, and the second reinstates the default behaviour for
		1211	C<Control-Shift-Insert>, which would otherwise be overridden.
		1212
		1213	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1214	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1215	this:
		1216
		1217	URxvt.keysym.C-M-c: builtin-string:
		1218	URxvt.keysym.C-M-v: builtin-string:
		1219
		1220	=item EXTENSION:STRING
		1221
		1222	An action of this form invokes the action B<STRING>, if any, provided
		1223	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1224	be loaded automatically if necessary.
		1225
		1226	Not all extensions define actions, but popular extensions that do
		1227	include the I<selection> and I<matcher> extensions (documented in their
		1228	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1229	respectively).
		1230
		1231	From the silly examples department, this will rot13-"encrypt"
		1232	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1233	keyboards:
		1234
		1235	URxvt.keysym.M-C-c: selection:rot13
		1236
		1237	=item perl:STRING DEPRECATED
		1238
		1239	This is a deprecated way of invoking commands provided by perl
		1240	extensions. It is still supported, but should not be used anymore.
		1241
		1242	=back
1258		1243
1259	=item B<perl-ext-common>: I<string>	1244	=item B<perl-ext-common>: I<string>
1260		1245
1261	=item B<perl-ext>: I<string>	1246	=item B<perl-ext>: I<string>
1262		1247
…		…
1264	use in this terminal instance; option B<-pe>.	1249	use in this terminal instance; option B<-pe>.
1265		1250
1266	Extension names can be prefixed with a C<-> sign to prohibit using	1251	Extension names can be prefixed with a C<-> sign to prohibit using
1267	them. This can be useful to selectively disable some extensions loaded	1252	them. This can be useful to selectively disable some extensions loaded
1268	by default, or specified via the C<perl-ext-common> resource. For	1253	by default, or specified via the C<perl-ext-common> resource. For
1269	example, C<default,-selection> will use all the default extension except	1254	example, C<default,-selection> will use all the default extensions except
1270	C<selection>.	1255	C<selection>.
1271		1256
1272	Extension names can also be followed by an argument in angle brackets	1257	The default set includes the C<selection>, C<option-popup>,
1273	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1258	C<selection-popup>, C<readline> and C<searchable-scrollback>
1274	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1259	extensions, and extensions which are mentioned in B<keysym> resources.
1275	multiple times with different arguments will pass multiple arguments to	1260
1276	the extension.	1261	Any extension such that a corresponding resource is given on the
		1262	command line is automatically appended to B<perl-ext>.
1277		1263
1278	Each extension is looked up in the library directories, loaded if	1264	Each extension is looked up in the library directories, loaded if
1279	necessary, and bound to the current terminal instance.	1265	necessary, and bound to the current terminal instance. When the library
		1266	search path contains multiple extension files of the same name, then the
		1267	first one found will be used.
1280		1268
1281	If both of these resources are the empty string, then the perl	1269	If both of these resources are the empty string, then the perl interpreter
1282	interpreter will not be initialized. The idea behind two options is that	1270	will not be initialized. The rationale for having two options is that
1283	B<perl-ext-common> will be used for extensions that should be available to	1271	B<perl-ext-common> will be used for extensions that should be available to
1284	all instances, while B<perl-ext> is used for specific instances.	1272	all instances, while B<perl-ext> is used for specific instances.
1285		1273
1286	=item B<perl-eval>: I<string>	1274	=item B<perl-eval>: I<string>
1287		1275
…		…
1289	the @@RXVT_NAME@@perl(3) manpage.	1277	the @@RXVT_NAME@@perl(3) manpage.
1290		1278
1291	=item B<perl-lib>: I<path>	1279	=item B<perl-lib>: I<path>
1292		1280
1293	Colon-separated list of additional directories that hold extension	1281	Colon-separated list of additional directories that hold extension
1294	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first	1282	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1295	look in these directories, then in $HOME/.urxvt/ext and lastly in	1283	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1296	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1284	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1297		1285
1298	See the @@RXVT_NAME@@perl(3) manpage.	1286	See the @@RXVT_NAME@@perl(3) manpage.
1299		1287
1300	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1288	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1301		1289
…		…
1305	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1293	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1306		1294
1307	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1295	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1308	for details.	1296	for details.
1309		1297
1310	=item B<searchable-scrollback:> I<keysym>	1298	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1311		1299
1312	Sets the hotkey that starts the incremental scrollback buffer search	1300	This resource is deprecated and will be removed. Use a B<keysym> resource
1313	(default: C<M-s>).	1301	instead, e.g.:
1314		1302
		1303	URxvt.keysym.M-s: searchable-scrollback:start
		1304
1315	=item B<urlLauncher>: I<string>	1305	=item B<url-launcher>: I<string>
1316		1306
1317	Specifies the program to be started with a URL argument. Used by the	1307	Specifies the program to be started with a URL argument. Used by the
1318	C<selection-popup> and C<matcher> perl extensions.	1308	C<selection-popup> and C<matcher> perl extensions.
1319		1309
1320	=item B<transient-for>: I<windowid>	1310	=item B<transient-for>: I<windowid>
…		…
1331	Turn on/off ISO 14755 (default enabled).	1321	Turn on/off ISO 14755 (default enabled).
1332		1322
1333	=item B<iso14755_52:> I<boolean>	1323	=item B<iso14755_52:> I<boolean>
1334		1324
1335	Turn on/off ISO 14755 5.2 mode (default enabled).	1325	Turn on/off ISO 14755 5.2 mode (default enabled).
		1326
		1327	=back
		1328
		1329	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1330
		1331	=over 4
		1332
		1333	=item B<-pixmap> I<file[;oplist]>
		1334
		1335	=item B<backgroundPixmap:> I<file[;oplist]>
		1336
		1337	Compile I<pixbuf>: Use the specified image file as the window's
		1338	background and also optionally specify a colon separated list of
		1339	operations to modify it. Note that you may need to quote the C<;>
		1340	character when using the command line option, as C<;> is usually a
		1341	metacharacter in shells. Supported operations are:
		1342
		1343	=over 4
		1344
		1345	=item B<WxH+X+Y>
		1346
		1347	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1348	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1349	scale of 0 disables scaling.
		1350
		1351	=item B<op=tile>
		1352
		1353	enables tiling
		1354
		1355	=item B<op=keep-aspect>
		1356
		1357	maintain the image aspect ratio when scaling
		1358
		1359	=item B<op=root-align>
		1360
		1361	use the position of the terminal window relative to the root window as
		1362	the image offset, simulating a root window background
		1363
		1364	=back
		1365
		1366	The default scale and position setting is C<100x100+50+50>.
		1367	Alternatively, a predefined set of templates can be used to achieve
		1368	the most common setups:
		1369
		1370	=over 4
		1371
		1372	=item B<style=tiled>
		1373
		1374	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1375
		1376	=item B<style=aspect-stretched>
		1377
		1378	the image is scaled to fill the whole window maintaining the aspect
		1379	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1380
		1381	=item B<style=stretched>
		1382
		1383	the image is scaled to fill the whole window. Equivalent to 100x100
		1384
		1385	=item B<style=centered>
		1386
		1387	the image is centered with no scaling. Equivalent to 0x0+50+50
		1388
		1389	=item B<style=root-tiled>
		1390
		1391	the image is tiled with no scaling and using 'root' positioning.
		1392	Equivalent to 0x0:op=tile:op=root-align
		1393
		1394	=back
		1395
		1396	If multiple templates are specified the last one wins. Note that a
		1397	template overrides all the scale, position and operations settings.
		1398
		1399	If used in conjunction with pseudo-transparency, the specified pixmap
		1400	will be blended over the transparent background using alpha-blending.
		1401
		1402	=item B<-tr>\|B<+tr>
		1403
		1404	=item B<transparent:> I<boolean>
		1405
		1406	Turn on/off pseudo-transparency by using the root pixmap as background.
		1407
		1408	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1409	will be removed in future versions.
		1410
		1411	=item B<-tint> I<colour>
		1412
		1413	=item B<tintColor:> I<colour>
		1414
		1415	Tint the transparent background with the given colour. Note that a
		1416	black tint yields a completely black image while a white tint yields
		1417	the image unchanged.
		1418
		1419	=item B<-sh> I<number>
		1420
		1421	=item B<shading:> I<number>
		1422
		1423	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1424	A value of 100 means no shading.
		1425
		1426	=item B<-blr> I<HxV>
		1427
		1428	=item B<blurRadius:> I<HxV>
		1429
		1430	Apply gaussian blur with the specified radius to the transparent
		1431	background. If a single number is specified, the vertical and
		1432	horizontal radii are considered to be the same. Setting one of the
		1433	radii to 1 and the other to a large number creates interesting effects
		1434	on some backgrounds. The maximum radius value is 128. An horizontal or
		1435	vertical radius of 0 disables blurring.
		1436
		1437	=item B<path:> I<path>
		1438
		1439	Specify the colon-delimited search path for finding background image files.
1336		1440
1337	=back	1441	=back
1338		1442
1339	=head1 THE SCROLLBAR	1443	=head1 THE SCROLLBAR
1340		1444
…		…
1388	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1492	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1389	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1493	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1390		1494
1391	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1495	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1392	inserted too.	1496	inserted too.
		1497
		1498	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1499	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1500	binding causes the value of the internal selection to be copied to the
		1501	CLIPBOARD selection, while the second binding causes the value of the
		1502	CLIPBOARD selection to be inserted.
1393		1503
1394	=back	1504	=back
1395		1505
1396	=head1 CHANGING FONTS	1506	=head1 CHANGING FONTS
1397		1507
…		…
1522	The following text gives values for the standard 88 colour mode (and	1632	The following text gives values for the standard 88 colour mode (and
1523	values for the 256 colour mode in parentheses).	1633	values for the 256 colour mode in parentheses).
1524		1634
1525	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1635	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1526		1636
1527	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1637	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1528	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1638	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1529		1639
1530	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1640	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1531	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1641	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1532	the RGB cube.	1642	the RGB cube.
1533		1643
…		…
1641		1751
1642	=item B<SHELL>	1752	=item B<SHELL>
1643		1753
1644	The shell to be used for command execution, defaults to C</bin/sh>.	1754	The shell to be used for command execution, defaults to C</bin/sh>.
1645		1755
1646	=item B<RXVT_SOCKET>	1756	=item B<RXVT_SOCKET> [I<sic>]
1647		1757
1648	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1758	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1649	@@RXVT_NAME@@d(1).	1759	@@RXVT_NAME@@d(1).
1650		1760
1651	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.	1761	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1762
		1763	=item B<URXVT_PERL_LIB>
		1764
		1765	Additional F<:>-separated library search path for perl extensions. Will be
		1766	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1767	directory.
		1768
		1769	=item B<URXVT_PERL_VERBOSITY>
		1770
		1771	See L<@@RXVT_NAME@@perl>(3).
1652		1772
1653	=item B<HOME>	1773	=item B<HOME>
1654		1774
1655	Used to locate the default directory for the unix domain socket for	1775	Used to locate the default directory for the unix domain socket for
1656	daemon communications and to locate various resource files (such as	1776	daemon communications and to locate various resource files (such as
…		…
1677		1797
1678	=back	1798	=back
1679		1799
1680	=head1 SEE ALSO	1800	=head1 SEE ALSO
1681		1801
		1802	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1682	@@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)	1803	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1683		1804
1684	=head1 CURRENT PROJECT COORDINATOR	1805	=head1 CURRENT PROJECT COORDINATOR
1685		1806
1686	=over 4	1807	=over 4
1687		1808
1688	=item Project Coordinator	1809	=item Project Coordinator
1689		1810
1690	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1811	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1691		1812
1692	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1813	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1693		1814
1694	=back	1815	=back
1695		1816
…		…
1699		1820
1700	=item John Bovey	1821	=item John Bovey
1701		1822
1702	University of Kent, 1992, wrote the original Xvt.	1823	University of Kent, 1992, wrote the original Xvt.
1703		1824
1704	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1825	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1705		1826
1706	very heavily modified Xvt and came up with Rxvt	1827	very heavily modified Xvt and came up with Rxvt
1707		1828
1708	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1829	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1709		1830
1710	wrote the Greek Keyboard Input (no longer in code)	1831	wrote the Greek Keyboard Input (no longer in code)
1711		1832
1712	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1833	=item mj olesen <olesen@me.QueensU.CA>
1713		1834
1714	Wrote the menu system.	1835	Wrote the menu system.
1715		1836
1716	Project Coordinator (changes.txt 2.11 to 2.21)	1837	Project Coordinator (changes.txt 2.11 to 2.21)
1717		1838
1718	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1839	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1719		1840
1720	Project Coordinator (changes.txt 2.21a to 2.4.5)	1841	Project Coordinator (changes.txt 2.21a to 2.4.5)
1721		1842
1722	=item Geoff Wing L<< <gcw@pobox.com> >>	1843	=item Geoff Wing <gcw@pobox.com>
1723		1844
1724	Rewrote screen display and text selection routines.	1845	Rewrote screen display and text selection routines.
1725		1846
1726	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1847	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1727		1848
1728	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1849	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1729		1850
1730	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1851	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1731	extension, random hacks, numerous bugfixes and extensions.	1852	extension, random hacks, numerous bugfixes and extensions.
1732		1853
1733	Project Coordinator (Changes 1.0 -)	1854	Project Coordinator (Changes 1.0 -)
1734		1855
1735	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1856	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1736		1857
1737	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1858	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1738		1859
1739	=back	1860	=back
1740		1861

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC vs. Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC