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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.219 by root, Thu Jun 7 16:06:23 2012 UTC vs.
Revision 1.246 by sf-exg, Tue Jun 21 12:03:55 2016 UTC

…		…
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>	111	=item B<-visual> I<visualID>
112		112
113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible	113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114	visual ids).	114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
115		116
116	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
117		118
118	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
119		120
…		…
126	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>.
127		128
128	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
129		130
130	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>.
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		132
139	=item B<-fade> I<number>	133	=item B<-fade> I<number>
140		134
141	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
142	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
…		…
145	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
146		140
147	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
148	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
149		143
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>	144	=item B<-icon> I<file>
171		145
172	Compile I<pixbuf>: Use the specified image as application icon. This	146	Compile I<pixbuf>: Use the specified image as application icon. This
173	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
174	application window; resource I<iconFile>.	148	application window; resource I<iconFile>.
…		…
178	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
179		153
180	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
181		155
182	Window foreground colour; resource B<foreground>.	156	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		157
191	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
192		159
193	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
194		161
…		…
253		220
254	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
255		222
256	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
257		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
258	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
259		230
260	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
261	B<utmpInhibit>.	232	B<utmpInhibit>.
262		233
…		…
340		311
341	=item B<-override-redirect>	312	=item B<-override-redirect>
342		313
343	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
344	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.
345		321
346	=item B<-sbg>	322	=item B<-sbg>
347		323
348	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
349	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
…		…
403		379
404	=item B<-pt> I<style>	380	=item B<-pt> I<style>
405		381
406	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
407	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.
408		387
409	=item B<-im> I<text>	388	=item B<-im> I<text>
410		389
411	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
412		391
…		…
683		662
684	B<False>: specify that everything is to be displayed, even	663	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	664	if the refresh is too fast for the human eye to read anything (or the
686	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
687		666
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>	667	=item B<fading:> I<number>
696		668
697	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>.
698		670
699	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
700		672
701	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
702	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
703		675
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>	676	=item B<iconFile:> I<file>
723		677
724	Set the application icon pixmap; option B<-icon>.	678	Set the application icon pixmap; option B<-icon>.
725		679
726	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
…		…
734		688
735	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
736		690
737	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
738	and the text.	692	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		693
809	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
810		695
811	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
812	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
…		…
909		794
910	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
911	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
912	[default]; option B<+ls>.	797	[default]; option B<+ls>.
913		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
914	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
915		805
916	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>;
917	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>
918	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
981	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
982	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
983		873
984	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
985		875
986	Save I<number> lines in the scrollback buffer [default 64]. This	876	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
987	resource is limited on most machines to 65535; option B<-sl>.
988		877
989	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
990		879
991	Internal border of I<number> pixels. This resource is limited to 100;	880	Internal border of I<number> pixels. This resource is limited to 100;
992	option B<-b>.	881	option B<-b>.
…		…
1055		944
1056	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
1057		946
1058	Mouse pointer background colour.	947	Mouse pointer background colour.
1059		948
		949	=item B<pointerShape:> I<string>
		950
		951	Compile I<frills>: Specifies the name of the mouse pointer shape
		952	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		953	file for possible values (omit the C<XC_> prefix).
		954
1060	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
1061		956
1062	Specifies number of seconds before blanking the pointer [default 2]. Use a	957	Specifies number of seconds before blanking the pointer [default 2]. Use a
1063	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
1064		959
…		…
1090		985
1091	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1092		987
1093	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
1094		989
1095	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1096		991
1097	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
1098		993
1099	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
1100		995
…		…
1169	Sets the working directory for the shell (or the command specified via	1064	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	1065	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	1066	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1172	directory will be used; option B<-cd>.	1067	directory will be used; option B<-cd>.
1173		1068
1174	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
1175		1070
1176	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1177	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
1178		1073
1179	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1074	Using this resource, you can map key combinations such as
1180	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	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>,	1076	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>,	1077	terminal scroll up or down the way you want it, or any other thing an
1183	B<2>, B<3>, B<4>, B<5>.	1078	extension might provide.
		1079
		1080	The key combination that triggers the action, I<sym>, has the following format:
		1081
		1082	(modifiers-)key
		1083
		1084	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1085	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1086	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1087	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1184		1088
1185	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1089	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	1090	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	1091	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1188	current application keymap mode state.	1092	current application keymap mode state.
1189		1093
1190	The spellings of I<key> can be obtained by using B<xev>(1) command or	1094	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	1095	match if I<at least> the specified identifiers are being set, and no other
		1096	key mappings with those and more bits are being defined. That means that
		1097	defining a mapping for C<a> will automatically provide definitions for
		1098	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1099	themselves. See the C<builtin:> action, below, for a way to work around
		1100	this when this is a problem.
		1101
		1102	The spelling of I<key> depends on your implementation of X. An easy way to
		1103	find a key name is to use the B<xev>(1) command. You can find a list by
		1104	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	1105	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	1106	value (B<0x0000 - 0xFFFF>).
1194	performed in an exact manner; however, the closest match is assured.
1195		1107
1196	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1108	As with any resource value, the I<action> string may contain backslash
		1109	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1197	number), see RESOURCES in C<man 7 X> for further details.	1110	number), see RESOURCES in C<man 7 X> for further details.
1198		1111
1199	You can define a range of keysyms in one shot by	1112	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>	1113	of action, followed by a colon. An action string without colons is
1201	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1114	interpreted as a literal string to pass to the tty (as if it was
		1115	prefixed with C<string:>).
		1116
		1117	The following action prefixes are known - extensions can provide
		1118	additional prefixes:
		1119
		1120	=over 4
		1121
		1122	=item string:STRING
		1123
		1124	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1125	then the remaining C<STRING> will be passed to the program running in the
		1126	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1127	string C<echo rm -rf /> followed by a newline:
		1128
		1129	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1130
		1131	This could in theory be used to completely redefine your keymap.
		1132
		1133	In addition, for actions of this type, you can define a range of
		1134	keysyms in one shot by loading the C<keysym-list> perl extension and
		1135	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1202	should be a character not used by the strings.	1136	the delimiter `/' should be a character not used by the strings.
1203		1137
1204	Its usage can be demonstrated by an example:	1138	Its usage can be demonstrated by an example:
1205		1139
1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1140	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1207		1141
1208	The above line is equivalent to the following three lines:	1142	The above line is equivalent to the following three lines:
1209		1143
1210	URxvt.keysym.Meta-Control-0x61: \033<a>	1144	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1211	URxvt.keysym.Meta-Control-0x62: \033<b>	1145	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1212	URxvt.keysym.Meta-Control-0x63: \033<c>	1146	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1213		1147
		1148	=item command:STRING
		1149
1214	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1150	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	1151	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1152	the opposite of C<string:> - instead of sending it to the program running
		1153	in the terminal, it will be treated as if it were program output). This is
		1154	most useful to feed command sequences into @@RXVT_NAME@@.
		1155
1216	example the following means "change the current locale to C<zh_CN.GBK>	1156	For example the following means "change the current locale to C<zh_CN.GBK>
1217	when Control-Meta-c is being pressed":	1157	when Control-Meta-c is being pressed":
1218		1158
1219	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1159	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1220		1160
1221	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1161	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)	1162	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1223	manpage. For example, the F<selection> extension (activated via	1163	font-switching at runtime:
1224	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1225		1164
1226	URxvt.keysym.M-C-c: perl:selection:rot13	1165	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1166	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1227		1167
1228	Due the the large number of modifier combinations, a defined key mapping	1168	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	1169	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		1170
1235	Unfortunately, this will override built-in key mappings. For example	1171	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1172	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1173
		1174	=item builtin:
		1175
		1176	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1177	key binding existed for the key combination. The obvious use is to undo
		1178	the effect of existing bindings. The not so obvious use is to reinstate
		1179	bindings when another binding overrides too many modifiers.
		1180
1236	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1181	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	1182	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1238	user-defined keymap using the C<builtin:> replacement:	1183	"holes" into the user-defined keymap using the C<builtin:> replacement:
1239		1184
1240	URxvt.keysym.Insert: <my insert key sequence>	1185	URxvt.keysym.Insert: <my insert key sequence>
1241	URxvt.keysym.S-Insert: builtin:	1186	URxvt.keysym.S-Insert: builtin:
1242		1187
1243	The first line defines a mapping for C<Insert> and I<any> combination	1188	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	1189	of modifiers. The second line re-establishes the default mapping for
1245	C<Shift-Insert>.	1190	C<Shift-Insert>.
1246		1191
1247	The following example will map Control-Meta-1 and Control-Meta-2 to	1192	=item builtin-string:
1248	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1249	font-switching at runtime:
1250		1193
1251	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1194	This action is mainly useful to restore string mappings for keys that
1252	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1195	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1196	difficult to explain - basically, this action will send the string to the
		1197	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1198	action for it.
1253		1199
1254	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1200	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1255	info):	1201	selection when you press C<Shift-Insert>. With the following bindings, it
		1202	would instead emit the (undocumented, but what applications running in the
		1203	terminal might expect) sequence C<ESC [ 2 $> instead:
1256		1204
1257	URxvt.keysym.M-C-3: command:\033[8;25;80t	1205	URxvt.keysym.S-Insert: builtin-string:
1258	URxvt.keysym.M-C-4: command:\033[8;48;110t	1206	URxvt.keysym.C-S-Insert: builtin:
		1207
		1208	The first line disables the paste functionality for that key
		1209	combination, and the second reinstates the default behaviour for
		1210	C<Control-Shift-Insert>, which would otherwise be overridden.
		1211
		1212	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1213	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1214	this:
		1215
		1216	URxvt.keysym.C-M-c: builtin-string:
		1217	URxvt.keysym.C-M-v: builtin-string:
		1218
		1219	=item EXTENSION:STRING
		1220
		1221	An action of this form invokes the action B<STRING>, if any, provided
		1222	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1223	be loaded automatically if necessary.
		1224
		1225	Not all extensions define actions, but popular extensions that do
		1226	include the I<selection> and I<matcher> extensions (documented in their
		1227	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1228	respectively).
		1229
		1230	From the silly examples department, this will rot13-"encrypt"
		1231	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1232	keyboards:
		1233
		1234	URxvt.keysym.M-C-c: selection:rot13
		1235
		1236	=item perl:STRING DEPRECATED
		1237
		1238	This is a deprecated way of invoking commands provided by perl
		1239	extensions. It is still supported, but should not be used anymore.
		1240
		1241	=back
1259		1242
1260	=item B<perl-ext-common>: I<string>	1243	=item B<perl-ext-common>: I<string>
1261		1244
1262	=item B<perl-ext>: I<string>	1245	=item B<perl-ext>: I<string>
1263		1246
…		…
1265	use in this terminal instance; option B<-pe>.	1248	use in this terminal instance; option B<-pe>.
1266		1249
1267	Extension names can be prefixed with a C<-> sign to prohibit using	1250	Extension names can be prefixed with a C<-> sign to prohibit using
1268	them. This can be useful to selectively disable some extensions loaded	1251	them. This can be useful to selectively disable some extensions loaded
1269	by default, or specified via the C<perl-ext-common> resource. For	1252	by default, or specified via the C<perl-ext-common> resource. For
1270	example, C<default,-selection> will use all the default extension except	1253	example, C<default,-selection> will use all the default extensions except
1271	C<selection>.	1254	C<selection>.
1272		1255
1273	Extension names can also be followed by an argument in angle brackets	1256	The default set includes the C<selection>, C<option-popup>,
1274	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1257	C<selection-popup>, C<readline> and C<searchable-scrollback>
1275	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1258	extensions, and extensions which are mentioned in B<keysym> resources.
1276	multiple times with different arguments will pass multiple arguments to	1259
1277	the extension.	1260	Any extension such that a corresponding resource is given on the
		1261	command line is automatically appended to B<perl-ext>.
1278		1262
1279	Each extension is looked up in the library directories, loaded if	1263	Each extension is looked up in the library directories, loaded if
1280	necessary, and bound to the current terminal instance.	1264	necessary, and bound to the current terminal instance. When the library
		1265	search path contains multiple extension files of the same name, then the
		1266	first one found will be used.
1281		1267
1282	If both of these resources are the empty string, then the perl	1268	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	1269	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	1270	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.	1271	all instances, while B<perl-ext> is used for specific instances.
1286		1272
1287	=item B<perl-eval>: I<string>	1273	=item B<perl-eval>: I<string>
1288		1274
…		…
1306	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1292	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1307		1293
1308	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1294	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1309	for details.	1295	for details.
1310		1296
1311	=item B<searchable-scrollback:> I<keysym>	1297	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1312		1298
1313	Sets the hotkey that starts the incremental scrollback buffer search	1299	This resource is deprecated and will be removed. Use a B<keysym> resource
1314	(default: C<M-s>).	1300	instead, e.g.:
1315		1301
		1302	URxvt.keysym.M-s: searchable-scrollback:start
		1303
1316	=item B<urlLauncher>: I<string>	1304	=item B<url-launcher>: I<string>
1317		1305
1318	Specifies the program to be started with a URL argument. Used by the	1306	Specifies the program to be started with a URL argument. Used by the
1319	C<selection-popup> and C<matcher> perl extensions.	1307	C<selection-popup> and C<matcher> perl extensions.
1320		1308
1321	=item B<transient-for>: I<windowid>	1309	=item B<transient-for>: I<windowid>
…		…
1332	Turn on/off ISO 14755 (default enabled).	1320	Turn on/off ISO 14755 (default enabled).
1333		1321
1334	=item B<iso14755_52:> I<boolean>	1322	=item B<iso14755_52:> I<boolean>
1335		1323
1336	Turn on/off ISO 14755 5.2 mode (default enabled).	1324	Turn on/off ISO 14755 5.2 mode (default enabled).
		1325
		1326	=back
		1327
		1328	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1329
		1330	=over 4
		1331
		1332	=item B<-pixmap> I<file[;oplist]>
		1333
		1334	=item B<backgroundPixmap:> I<file[;oplist]>
		1335
		1336	Compile I<pixbuf>: Use the specified image file as the window's
		1337	background and also optionally specify a colon separated list of
		1338	operations to modify it. Note that you may need to quote the C<;>
		1339	character when using the command line option, as C<;> is usually a
		1340	metacharacter in shells. Supported operations are:
		1341
		1342	=over 4
		1343
		1344	=item B<WxH+X+Y>
		1345
		1346	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1347	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1348	scale of 0 disables scaling.
		1349
		1350	=item B<op=tile>
		1351
		1352	enables tiling
		1353
		1354	=item B<op=keep-aspect>
		1355
		1356	maintain the image aspect ratio when scaling
		1357
		1358	=item B<op=root-align>
		1359
		1360	use the position of the terminal window relative to the root window as
		1361	the image offset, simulating a root window background
		1362
		1363	=back
		1364
		1365	The default scale and position setting is C<100x100+50+50>.
		1366	Alternatively, a predefined set of templates can be used to achieve
		1367	the most common setups:
		1368
		1369	=over 4
		1370
		1371	=item B<style=tiled>
		1372
		1373	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1374
		1375	=item B<style=aspect-stretched>
		1376
		1377	the image is scaled to fill the whole window maintaining the aspect
		1378	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1379
		1380	=item B<style=stretched>
		1381
		1382	the image is scaled to fill the whole window. Equivalent to 100x100
		1383
		1384	=item B<style=centered>
		1385
		1386	the image is centered with no scaling. Equivalent to 0x0+50+50
		1387
		1388	=item B<style=root-tiled>
		1389
		1390	the image is tiled with no scaling and using 'root' positioning.
		1391	Equivalent to 0x0:op=tile:op=root-align
		1392
		1393	=back
		1394
		1395	If multiple templates are specified the last one wins. Note that a
		1396	template overrides all the scale, position and operations settings.
		1397
		1398	If used in conjunction with pseudo-transparency, the specified pixmap
		1399	will be blended over the transparent background using alpha-blending.
		1400
		1401	=item B<-tr>\|B<+tr>
		1402
		1403	=item B<transparent:> I<boolean>
		1404
		1405	Turn on/off pseudo-transparency by using the root pixmap as background.
		1406
		1407	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1408	will be removed in future versions.
		1409
		1410	=item B<-tint> I<colour>
		1411
		1412	=item B<tintColor:> I<colour>
		1413
		1414	Tint the transparent background with the given colour. Note that a
		1415	black tint yields a completely black image while a white tint yields
		1416	the image unchanged.
		1417
		1418	=item B<-sh> I<number>
		1419
		1420	=item B<shading:> I<number>
		1421
		1422	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1423	A value of 100 means no shading.
		1424
		1425	=item B<-blr> I<HxV>
		1426
		1427	=item B<blurRadius:> I<HxV>
		1428
		1429	Apply gaussian blur with the specified radius to the transparent
		1430	background. If a single number is specified, the vertical and
		1431	horizontal radii are considered to be the same. Setting one of the
		1432	radii to 1 and the other to a large number creates interesting effects
		1433	on some backgrounds. The maximum radius value is 128. An horizontal or
		1434	vertical radius of 0 disables blurring.
		1435
		1436	=item B<path:> I<path>
		1437
		1438	Specify the colon-delimited search path for finding background image files.
1337		1439
1338	=back	1440	=back
1339		1441
1340	=head1 THE SCROLLBAR	1442	=head1 THE SCROLLBAR
1341		1443
…		…
1389	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1491	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.	1492	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1391		1493
1392	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1494	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1393	inserted too.	1495	inserted too.
		1496
		1497	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1498	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1499	binding causes the value of the internal selection to be copied to the
		1500	CLIPBOARD selection, while the second binding causes the value of the
		1501	CLIPBOARD selection to be inserted.
1394		1502
1395	=back	1503	=back
1396		1504
1397	=head1 CHANGING FONTS	1505	=head1 CHANGING FONTS
1398		1506
…		…
1487	In addition to the default foreground and background colours,	1595	In addition to the default foreground and background colours,
1488	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1596	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1489	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1597	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1490	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1598	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1491	cube plus a 8 (24) colour greyscale ramp.	1599	cube plus a 8 (24) colour greyscale ramp.
		1600
		1601	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1602	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1603	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1604	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1605	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1606	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1607	use many similar 24-bit colours. It's typically not a problem in common
		1608	scenarios.
1492		1609
1493	Here is a list of the ANSI colours with their names.	1610	Here is a list of the ANSI colours with their names.
1494		1611
1495	=begin table	1612	=begin table
1496		1613
…		…
1523	The following text gives values for the standard 88 colour mode (and	1640	The following text gives values for the standard 88 colour mode (and
1524	values for the 256 colour mode in parentheses).	1641	values for the 256 colour mode in parentheses).
1525		1642
1526	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1643	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1527		1644
1528	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1645	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	1646	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1530		1647
1531	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1648	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	1649	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1533	the RGB cube.	1650	the RGB cube.
1534		1651
…		…
1688		1805
1689	=back	1806	=back
1690		1807
1691	=head1 SEE ALSO	1808	=head1 SEE ALSO
1692		1809
1693	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1810	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
		1811	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1694		1812
1695	=head1 CURRENT PROJECT COORDINATOR	1813	=head1 CURRENT PROJECT COORDINATOR
1696		1814
1697	=over 4	1815	=over 4
1698		1816
1699	=item Project Coordinator	1817	=item Project Coordinator
1700		1818
1701	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1819	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1702		1820
1703	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1821	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1704		1822
1705	=back	1823	=back
1706		1824
…		…
1710		1828
1711	=item John Bovey	1829	=item John Bovey
1712		1830
1713	University of Kent, 1992, wrote the original Xvt.	1831	University of Kent, 1992, wrote the original Xvt.
1714		1832
1715	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1833	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1716		1834
1717	very heavily modified Xvt and came up with Rxvt	1835	very heavily modified Xvt and came up with Rxvt
1718		1836
1719	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1837	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1720		1838
1721	wrote the Greek Keyboard Input (no longer in code)	1839	wrote the Greek Keyboard Input (no longer in code)
1722		1840
1723	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1841	=item mj olesen <olesen@me.QueensU.CA>
1724		1842
1725	Wrote the menu system.	1843	Wrote the menu system.
1726		1844
1727	Project Coordinator (changes.txt 2.11 to 2.21)	1845	Project Coordinator (changes.txt 2.11 to 2.21)
1728		1846
1729	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1847	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1730		1848
1731	Project Coordinator (changes.txt 2.21a to 2.4.5)	1849	Project Coordinator (changes.txt 2.21a to 2.4.5)
1732		1850
1733	=item Geoff Wing L<< <gcw@pobox.com> >>	1851	=item Geoff Wing <gcw@pobox.com>
1734		1852
1735	Rewrote screen display and text selection routines.	1853	Rewrote screen display and text selection routines.
1736		1854
1737	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1855	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1738		1856
1739	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1857	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1740		1858
1741	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1859	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1742	extension, random hacks, numerous bugfixes and extensions.	1860	extension, random hacks, numerous bugfixes and extensions.
1743		1861
1744	Project Coordinator (Changes 1.0 -)	1862	Project Coordinator (Changes 1.0 -)
1745		1863
1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1864	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1747		1865
1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1866	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1749		1867
1750	=back	1868	=back
1751		1869

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.219 by root, Thu Jun 7 16:06:23 2012 UTC vs. Revision 1.246 by sf-exg, Tue Jun 21 12:03:55 2016 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.219 by root, Thu Jun 7 16:06:23 2012 UTC vs.
Revision 1.246 by sf-exg, Tue Jun 21 12:03:55 2016 UTC