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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 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<-blt> I<string>
156
157	Specify background blending type. If background pixmap is specified
158	at the same time as transparency - such pixmap will be blended over
159	the transparent background, using the method specified. Supported values are:
160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165	=item B<-blr> I<HxV>
166
167	Apply Gaussian Blur with the specified radii to the transparent
168	background. If a single number is specified, the vertical and
169	horizontal radii are considered to be the same. Setting one of the
170	radii to 1 and the other to a large number creates interesting effects
171	on some backgrounds. The maximum radius value is 128. An horizontal or
172	vertical radius of 0 disables blurring;
173	resource I<blurRadius>.
174
175	=item B<-icon> I<file>	144	=item B<-icon> I<file>
176		145
177	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This	146	Compile I<pixbuf>: Use the specified image as application icon. This
178	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
179	application window; resource I<iconFile>.	148	application window; resource I<iconFile>.
180		149
181	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
182		151
183	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
184		153
185	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
186		155
187	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
188
189	=item B<-pixmap> I<file[;oplist]>
190
191	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
192	optionally specify a list of operations to modify it. Note you may need to
193	add quotes to avoid special shell interpretation of the C<;> in the
194	command-line; for more details see resource B<backgroundPixmap>.
195		157
196	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
197		159
198	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
199		161
…		…
258		220
259	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
260		222
261	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
262		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
263	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
264		230
265	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
266	B<utmpInhibit>.	232	B<utmpInhibit>.
267		233
…		…
345		311
346	=item B<-override-redirect>	312	=item B<-override-redirect>
347		313
348	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
349	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.
350		321
351	=item B<-sbg>	322	=item B<-sbg>
352		323
353	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
354	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
…		…
408		379
409	=item B<-pt> I<style>	380	=item B<-pt> I<style>
410		381
411	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
412	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.
413		387
414	=item B<-im> I<text>	388	=item B<-im> I<text>
415		389
416	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
417		391
…		…
688		662
689	B<False>: specify that everything is to be displayed, even	663	B<False>: specify that everything is to be displayed, even
690	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
691	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
692		666
693	=item B<transparent:> I<boolean>
694
695	Turn on/off pseudo-transparency by using the root pixmap as background.
696
697	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
698	future versions.
699
700	=item B<fading:> I<number>	667	=item B<fading:> I<number>
701		668
702	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>.
703		670
704	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
705		672
706	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
707	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
708		675
709	=item B<tintColor:> I<colour>
710
711	Tint the transparent background with the given colour. If the RENDER
712	extension is not available only black, red, green, yellow, blue,
713	magenta, cyan and white tints can be performed server-side. Note that
714	a black tint yields a completely black image while a white tint yields
715	the image unchanged; option B<-tint>.
716
717	=item B<shading:> I<number>
718
719	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
720	A value of 100 means no shading; option B<-sh>.
721
722	=item B<blendType:> I<string>
723
724	Specify background blending type; option B<-blt>.
725
726	=item B<blurRadius:> I<number>
727
728	Apply gaussian blur with the specified radius to the transparent
729	background; option B<-blr>.
730
731	=item B<iconFile:> I<file>	676	=item B<iconFile:> I<file>
732		677
733	Set the application icon pixmap; option B<-icon>.	678	Set the application icon pixmap; option B<-icon>.
734		679
735	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
…		…
743		688
744	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
745		690
746	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
747	and the text.	692	and the text.
748
749	=item B<backgroundPixmap:> I<file[;oplist]>
750
751	Use the specified image file for the background and also
752	optionally specify a colon separated list of operations to modify it.
753	Supported operations are:
754
755	=over 4
756
757	=item B<WxH+X+Y>
758
759	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
760	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
761	scale of 0 disables scaling. The maximum permitted scale is 1000.
762
763	=item B<op=tile>
764
765	enables tiling
766
767	=item B<op=keep-aspect>
768
769	maintain the image aspect ratio when scaling
770
771	=item B<op=root-align>
772
773	use the position of the terminal window relative to the root window as
774	the image offset, simulating a root window background
775
776	=back
777
778	The default scale and position setting is C<100x100+50+50>.
779	Alternatively, a predefined set of templates can be used to achieve
780	the most common setups:
781
782	=over 4
783
784	=item B<style=tiled>
785
786	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
787
788	=item B<style=aspect-stretched>
789
790	the image is scaled to fill the whole window maintaining the aspect
791	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
792
793	=item B<style=stretched>
794
795	the image is scaled to fill the whole window. Equivalent to 100x100
796
797	=item B<style=centered>
798
799	the image is centered with no scaling. Equivalent to 0x0+50+50
800
801	=item B<style=root-tiled>
802
803	the image is tiled with no scaling and using 'root' positioning.
804	Equivalent to 0x0:op=tile:op=root-align
805
806	=back
807
808	If multiple templates are specified the last one wins. Note that a
809	template overrides all the scale, position and operations settings.
810
811	If used in conjunction with B<-tr> option, the specified pixmap will be
812	blended over the transparent background using alpha-blending. If I<afterimage>
813	support has been compiled in it is possible to choose other blending
814	types with B<-blt "type"> option.
815
816	=item B<path:> I<path>
817
818	Specify the colon-delimited search path for finding background image files.
819		693
820	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
821		695
822	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
823	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
…		…
920		794
921	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
922	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
923	[default]; option B<+ls>.	797	[default]; option B<+ls>.
924		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
925	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
926		805
927	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>;
928	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>
929	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
1101		980
1102	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	981	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1103		982
1104	=item B<preeditType:> I<style>	983	=item B<preeditType:> I<style>
1105		984
1106	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	985	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1107		986
1108	=item B<inputMethod:> I<name>	987	=item B<inputMethod:> I<name>
1109		988
1110	I<name> of inputMethod to use; option B<-im>.	989	I<name> of inputMethod to use; option B<-im>.
1111		990
…		…
1180	Sets the working directory for the shell (or the command specified via	1059	Sets the working directory for the shell (or the command specified via
1181	B<-e>). The I<path> must be an absolute path and it must exist for	1060	B<-e>). The I<path> must be an absolute path and it must exist for
1182	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1061	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1183	directory will be used; option B<-cd>.	1062	directory will be used; option B<-cd>.
1184		1063
1185	=item B<keysym.>I<sym>: I<string>	1064	=item B<keysym.>I<sym>: I<action>
1186		1065
1187	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1066	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1188	intervening resource name B<keysym.> cannot be omitted.	1067	resource name B<keysym.> cannot be omitted.
1189		1068
1190	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1069	Using this resource, you can map key combinations such as
1191	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1070	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1192	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1071	string than would normally result from that combination, making the
1193	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1072	terminal scroll up or down the way you want it, or any other thing an
1194	B<2>, B<3>, B<4>, B<5>.	1073	extension might provide.
		1074
		1075	The key combination that triggers the action, I<sym>, has the following format:
		1076
		1077	(modifiers-)key
		1078
		1079	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1080	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1081	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1082	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1195		1083
1196	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1084	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1197	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1085	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1198	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1086	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1199	current application keymap mode state.	1087	current application keymap mode state.
1200		1088
1201	The spellings of I<key> can be obtained by using B<xev>(1) command or	1089	Due the the large number of modifier combinations, a key mapping will
1202	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1090	match if I<at least> the specified identifiers are being set, and no other
		1091	key mappings with those and more bits are being defined. That means that
		1092	defining a mapping for C<a> will automatically provide definitions for
		1093	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1094	themselves. See the C<builtin:> action, below, for a way to work around
		1095	this when this is a problem.
		1096
		1097	The spelling of I<key> depends on your implementation of X. An easy way to
		1098	find a key name is to use the B<xev>(1) command. You can find a list by
		1099	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1203	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1100	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1204	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1101	value (B<0x0000 - 0xFFFF>).
1205	performed in an exact manner; however, the closest match is assured.
1206		1102
1207	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1103	As with any resource value, the I<action> string may contain backslash
		1104	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1208	number), see RESOURCES in C<man 7 X> for further details.	1105	number), see RESOURCES in C<man 7 X> for further details.
1209		1106
1210	You can define a range of keysyms in one shot by	1107	An action starts with an action prefix that selects a certain type
1211	loading the C<keysym-list> perl extension and providing a I<string>	1108	of action, followed by a colon. An action string without colons is
1212	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1109	interpreted as a literal string to pass to the tty (as if it was
		1110	prefixed with C<string:>).
		1111
		1112	The following action prefixes are known - extensions can provide
		1113	additional prefixes:
		1114
		1115	=over 4
		1116
		1117	=item string:STRING
		1118
		1119	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1120	then the remaining C<STRING> will be passed to the program running in the
		1121	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1122	string C<echo rm -rf /> followed by a newline:
		1123
		1124	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1125
		1126	This could in theory be used to completely redefine your keymap.
		1127
		1128	In addition, for actions of this type, you can define a range of
		1129	keysyms in one shot by loading the C<keysym-list> perl extension and
		1130	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1213	should be a character not used by the strings.	1131	the delimiter `/' should be a character not used by the strings.
1214		1132
1215	Its usage can be demonstrated by an example:	1133	Its usage can be demonstrated by an example:
1216		1134
1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1135	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1218		1136
1219	The above line is equivalent to the following three lines:	1137	The above line is equivalent to the following three lines:
1220		1138
1221	URxvt.keysym.Meta-Control-0x61: \033<a>	1139	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1222	URxvt.keysym.Meta-Control-0x62: \033<b>	1140	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1223	URxvt.keysym.Meta-Control-0x63: \033<c>	1141	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1224		1142
		1143	=item command:STRING
		1144
1225	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1145	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1226	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1146	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1147	the opposite of C<string:> - instead of sending it to the program running
		1148	in the terminal, it will be treated as if it were program output). This is
		1149	most useful to feed command sequences into @@RXVT_NAME@@.
		1150
1227	example the following means "change the current locale to C<zh_CN.GBK>	1151	For example the following means "change the current locale to C<zh_CN.GBK>
1228	when Control-Meta-c is being pressed":	1152	when Control-Meta-c is being pressed":
1229		1153
1230	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1154	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1231		1155
1232	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1156	The following example will map Control-Meta-1 and Control-Meta-2 to
1233	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1157	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1234	manpage. For example, the F<selection> extension (activated via	1158	font-switching at runtime:
1235	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1236		1159
1237	URxvt.keysym.M-C-c: perl:selection:rot13	1160	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1161	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1238		1162
1239	Due the the large number of modifier combinations, a defined key mapping	1163	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1240	will match if I<at least> the specified identifiers are being set, and	1164	info):
1241	no other key mappings with those and more bits are being defined. That
1242	means that defining a key map for C<a> will automatically provide
1243	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1244	mappings themselves.
1245		1165
1246	Unfortunately, this will override built-in key mappings. For example	1166	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1167	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1168
		1169	=item builtin:
		1170
		1171	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1172	key binding existed for the key combination. The obvious use is to undo
		1173	the effect of existing bindings. The not so obvious use is to reinstate
		1174	bindings when another binding overrides too many modifiers.
		1175
1247	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1176	For example if you overwrite the C<Insert> key you will disable
1248	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1177	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1249	user-defined keymap using the C<builtin:> replacement:	1178	"holes" into the user-defined keymap using the C<builtin:> replacement:
1250		1179
1251	URxvt.keysym.Insert: <my insert key sequence>	1180	URxvt.keysym.Insert: <my insert key sequence>
1252	URxvt.keysym.S-Insert: builtin:	1181	URxvt.keysym.S-Insert: builtin:
1253		1182
1254	The first line defines a mapping for C<Insert> and I<any> combination	1183	The first line defines a mapping for C<Insert> and I<any> combination
1255	of modifiers. The second line re-establishes the default mapping for	1184	of modifiers. The second line re-establishes the default mapping for
1256	C<Shift-Insert>.	1185	C<Shift-Insert>.
1257		1186
1258	The following example will map Control-Meta-1 and Control-Meta-2 to	1187	=item builtin-string:
1259	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1260	font-switching at runtime:
1261		1188
1262	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1189	This action is mainly useful to restore string mappings for keys that
1263	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1190	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1191	difficult to explain - basically, this action will send the string to the
		1192	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1193	action for it.
1264		1194
1265	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1195	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1266	info):	1196	selection when you press C<Shift-Insert>. With the following bindings, it
		1197	would instead emit the (undocumented, but what applications running in the
		1198	terminal might expect) sequence C<ESC [ 2 $> instead:
1267		1199
1268	URxvt.keysym.M-C-3: command:\033[8;25;80t	1200	URxvt.keysym.S-Insert: builtin-string:
1269	URxvt.keysym.M-C-4: command:\033[8;48;110t	1201	URxvt.keysym.C-S-Insert: builtin:
		1202
		1203	The first line disables the paste functionality for that key
		1204	combination, and the second reinstates the default behaviour for
		1205	C<Control-Shift-Insert>, which would otherwise be overridden.
		1206
		1207	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1208	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1209	this:
		1210
		1211	URxvt.keysym.C-M-c: builtin-string:
		1212	URxvt.keysym.C-M-v: builtin-string:
		1213
		1214	=item EXTENSION:STRING
		1215
		1216	An action of this form invokes the action B<STRING>, if any, provided
		1217	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1218	be loaded automatically if necessary.
		1219
		1220	Not all extensions define actions, but popular extensions that do
		1221	include the I<selection> and I<matcher> extensions (documented in their
		1222	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1223	respectively).
		1224
		1225	From the silly examples department, this will rot13-"encrypt"
		1226	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1227	keyboards:
		1228
		1229	URxvt.keysym.M-C-c: selection:rot13
		1230
		1231	=item perl:STRING DEPRECATED
		1232
		1233	This is a deprecated way of invoking commands provided by perl
		1234	extensions. It is still supported, but should not be used anymore.
		1235
		1236	=back
1270		1237
1271	=item B<perl-ext-common>: I<string>	1238	=item B<perl-ext-common>: I<string>
1272		1239
1273	=item B<perl-ext>: I<string>	1240	=item B<perl-ext>: I<string>
1274		1241
…		…
1276	use in this terminal instance; option B<-pe>.	1243	use in this terminal instance; option B<-pe>.
1277		1244
1278	Extension names can be prefixed with a C<-> sign to prohibit using	1245	Extension names can be prefixed with a C<-> sign to prohibit using
1279	them. This can be useful to selectively disable some extensions loaded	1246	them. This can be useful to selectively disable some extensions loaded
1280	by default, or specified via the C<perl-ext-common> resource. For	1247	by default, or specified via the C<perl-ext-common> resource. For
1281	example, C<default,-selection> will use all the default extension except	1248	example, C<default,-selection> will use all the default extensions except
1282	C<selection>.	1249	C<selection>.
1283		1250
1284	Extension names can also be followed by an argument in angle brackets	1251	The default set includes the C<selection>, C<option-popup>,
1285	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1252	C<selection-popup>, C<readline> and C<searchable-scrollback>
1286	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1253	extensions, and extensions which are mentioned in B<keysym> resources.
1287	multiple times with different arguments will pass multiple arguments to	1254
1288	the extension.	1255	Any extension such that a corresponding resource is given on the
		1256	command line is automatically appended to B<perl-ext>.
1289		1257
1290	Each extension is looked up in the library directories, loaded if	1258	Each extension is looked up in the library directories, loaded if
1291	necessary, and bound to the current terminal instance.	1259	necessary, and bound to the current terminal instance. When the library
		1260	search path contains multiple extension files of the same name, then the
		1261	first one found will be used.
1292		1262
1293	If both of these resources are the empty string, then the perl	1263	If both of these resources are the empty string, then the perl interpreter
1294	interpreter will not be initialized. The idea behind two options is that	1264	will not be initialized. The rationale for having two options is that
1295	B<perl-ext-common> will be used for extensions that should be available to	1265	B<perl-ext-common> will be used for extensions that should be available to
1296	all instances, while B<perl-ext> is used for specific instances.	1266	all instances, while B<perl-ext> is used for specific instances.
1297		1267
1298	=item B<perl-eval>: I<string>	1268	=item B<perl-eval>: I<string>
1299		1269
…		…
1301	the @@RXVT_NAME@@perl(3) manpage.	1271	the @@RXVT_NAME@@perl(3) manpage.
1302		1272
1303	=item B<perl-lib>: I<path>	1273	=item B<perl-lib>: I<path>
1304		1274
1305	Colon-separated list of additional directories that hold extension	1275	Colon-separated list of additional directories that hold extension
1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first	1276	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1307	look in these directories, then in $HOME/.urxvt/ext and lastly in	1277	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1278	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1309		1279
1310	See the @@RXVT_NAME@@perl(3) manpage.	1280	See the @@RXVT_NAME@@perl(3) manpage.
1311		1281
1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1282	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1313		1283
…		…
1317	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1287	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1318		1288
1319	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1289	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1320	for details.	1290	for details.
1321		1291
1322	=item B<searchable-scrollback:> I<keysym>	1292	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1323		1293
1324	Sets the hotkey that starts the incremental scrollback buffer search	1294	This resource is deprecated and will be removed. Use a B<keysym> resource
1325	(default: C<M-s>).	1295	instead, e.g.:
1326		1296
		1297	URxvt.keysym.M-s: searchable-scrollback:start
		1298
1327	=item B<urlLauncher>: I<string>	1299	=item B<url-launcher>: I<string>
1328		1300
1329	Specifies the program to be started with a URL argument. Used by the	1301	Specifies the program to be started with a URL argument. Used by the
1330	C<selection-popup> and C<matcher> perl extensions.	1302	C<selection-popup> and C<matcher> perl extensions.
1331		1303
1332	=item B<transient-for>: I<windowid>	1304	=item B<transient-for>: I<windowid>
…		…
1343	Turn on/off ISO 14755 (default enabled).	1315	Turn on/off ISO 14755 (default enabled).
1344		1316
1345	=item B<iso14755_52:> I<boolean>	1317	=item B<iso14755_52:> I<boolean>
1346		1318
1347	Turn on/off ISO 14755 5.2 mode (default enabled).	1319	Turn on/off ISO 14755 5.2 mode (default enabled).
		1320
		1321	=back
		1322
		1323	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1324
		1325	=over 4
		1326
		1327	=item B<-pixmap> I<file[;oplist]>
		1328
		1329	=item B<backgroundPixmap:> I<file[;oplist]>
		1330
		1331	Compile I<pixbuf>: Use the specified image file as the window's
		1332	background and also optionally specify a colon separated list of
		1333	operations to modify it. Note that you may need to quote the C<;>
		1334	character when using the command line option, as C<;> is usually a
		1335	metacharacter in shells. Supported operations are:
		1336
		1337	=over 4
		1338
		1339	=item B<WxH+X+Y>
		1340
		1341	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1342	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1343	scale of 0 disables scaling.
		1344
		1345	=item B<op=tile>
		1346
		1347	enables tiling
		1348
		1349	=item B<op=keep-aspect>
		1350
		1351	maintain the image aspect ratio when scaling
		1352
		1353	=item B<op=root-align>
		1354
		1355	use the position of the terminal window relative to the root window as
		1356	the image offset, simulating a root window background
		1357
		1358	=back
		1359
		1360	The default scale and position setting is C<100x100+50+50>.
		1361	Alternatively, a predefined set of templates can be used to achieve
		1362	the most common setups:
		1363
		1364	=over 4
		1365
		1366	=item B<style=tiled>
		1367
		1368	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1369
		1370	=item B<style=aspect-stretched>
		1371
		1372	the image is scaled to fill the whole window maintaining the aspect
		1373	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1374
		1375	=item B<style=stretched>
		1376
		1377	the image is scaled to fill the whole window. Equivalent to 100x100
		1378
		1379	=item B<style=centered>
		1380
		1381	the image is centered with no scaling. Equivalent to 0x0+50+50
		1382
		1383	=item B<style=root-tiled>
		1384
		1385	the image is tiled with no scaling and using 'root' positioning.
		1386	Equivalent to 0x0:op=tile:op=root-align
		1387
		1388	=back
		1389
		1390	If multiple templates are specified the last one wins. Note that a
		1391	template overrides all the scale, position and operations settings.
		1392
		1393	If used in conjunction with pseudo-transparency, the specified pixmap
		1394	will be blended over the transparent background using alpha-blending.
		1395
		1396	=item B<-tr>\|B<+tr>
		1397
		1398	=item B<transparent:> I<boolean>
		1399
		1400	Turn on/off pseudo-transparency by using the root pixmap as background.
		1401
		1402	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1403	will be removed in future versions.
		1404
		1405	=item B<-tint> I<colour>
		1406
		1407	=item B<tintColor:> I<colour>
		1408
		1409	Tint the transparent background with the given colour. Note that a
		1410	black tint yields a completely black image while a white tint yields
		1411	the image unchanged.
		1412
		1413	=item B<-sh> I<number>
		1414
		1415	=item B<shading:> I<number>
		1416
		1417	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1418	A value of 100 means no shading.
		1419
		1420	=item B<-blr> I<HxV>
		1421
		1422	=item B<blurRadius:> I<HxV>
		1423
		1424	Apply gaussian blur with the specified radius to the transparent
		1425	background. If a single number is specified, the vertical and
		1426	horizontal radii are considered to be the same. Setting one of the
		1427	radii to 1 and the other to a large number creates interesting effects
		1428	on some backgrounds. The maximum radius value is 128. An horizontal or
		1429	vertical radius of 0 disables blurring.
		1430
		1431	=item B<path:> I<path>
		1432
		1433	Specify the colon-delimited search path for finding background image files.
1348		1434
1349	=back	1435	=back
1350		1436
1351	=head1 THE SCROLLBAR	1437	=head1 THE SCROLLBAR
1352		1438
…		…
1400	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1486	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1401	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1487	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1402		1488
1403	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1489	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1404	inserted too.	1490	inserted too.
		1491
		1492	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1493	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1494	binding causes the value of the internal selection to be copied to the
		1495	CLIPBOARD selection, while the second binding causes the value of the
		1496	CLIPBOARD selection to be inserted.
1405		1497
1406	=back	1498	=back
1407		1499
1408	=head1 CHANGING FONTS	1500	=head1 CHANGING FONTS
1409		1501
…		…
1534	The following text gives values for the standard 88 colour mode (and	1626	The following text gives values for the standard 88 colour mode (and
1535	values for the 256 colour mode in parentheses).	1627	values for the 256 colour mode in parentheses).
1536		1628
1537	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1629	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1538		1630
1539	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1631	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1540	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1632	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1541		1633
1542	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1634	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1543	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1635	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1544	the RGB cube.	1636	the RGB cube.
1545		1637
…		…
1653		1745
1654	=item B<SHELL>	1746	=item B<SHELL>
1655		1747
1656	The shell to be used for command execution, defaults to C</bin/sh>.	1748	The shell to be used for command execution, defaults to C</bin/sh>.
1657		1749
1658	=item B<RXVT_SOCKET>	1750	=item B<RXVT_SOCKET> [I<sic>]
1659		1751
1660	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1752	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1661	@@RXVT_NAME@@d(1).	1753	@@RXVT_NAME@@d(1).
1662		1754
1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.	1755	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1756
		1757	=item B<URXVT_PERL_LIB>
		1758
		1759	Additional F<:>-separated library search path for perl extensions. Will be
		1760	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1761	directory.
		1762
		1763	=item B<URXVT_PERL_VERBOSITY>
		1764
		1765	See L<@@RXVT_NAME@@perl>(3).
1664		1766
1665	=item B<HOME>	1767	=item B<HOME>
1666		1768
1667	Used to locate the default directory for the unix domain socket for	1769	Used to locate the default directory for the unix domain socket for
1668	daemon communications and to locate various resource files (such as	1770	daemon communications and to locate various resource files (such as
…		…
1689		1791
1690	=back	1792	=back
1691		1793
1692	=head1 SEE ALSO	1794	=head1 SEE ALSO
1693		1795
		1796	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1694	@@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)	1797	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1695		1798
1696	=head1 CURRENT PROJECT COORDINATOR	1799	=head1 CURRENT PROJECT COORDINATOR
1697		1800
1698	=over 4	1801	=over 4
1699		1802
1700	=item Project Coordinator	1803	=item Project Coordinator
1701		1804
1702	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1805	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1703		1806
1704	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1807	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1705		1808
1706	=back	1809	=back
1707		1810
…		…
1711		1814
1712	=item John Bovey	1815	=item John Bovey
1713		1816
1714	University of Kent, 1992, wrote the original Xvt.	1817	University of Kent, 1992, wrote the original Xvt.
1715		1818
1716	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1819	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1717		1820
1718	very heavily modified Xvt and came up with Rxvt	1821	very heavily modified Xvt and came up with Rxvt
1719		1822
1720	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1823	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1721		1824
1722	wrote the Greek Keyboard Input (no longer in code)	1825	wrote the Greek Keyboard Input (no longer in code)
1723		1826
1724	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1827	=item mj olesen <olesen@me.QueensU.CA>
1725		1828
1726	Wrote the menu system.	1829	Wrote the menu system.
1727		1830
1728	Project Coordinator (changes.txt 2.11 to 2.21)	1831	Project Coordinator (changes.txt 2.11 to 2.21)
1729		1832
1730	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1833	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1731		1834
1732	Project Coordinator (changes.txt 2.21a to 2.4.5)	1835	Project Coordinator (changes.txt 2.21a to 2.4.5)
1733		1836
1734	=item Geoff Wing L<< <gcw@pobox.com> >>	1837	=item Geoff Wing <gcw@pobox.com>
1735		1838
1736	Rewrote screen display and text selection routines.	1839	Rewrote screen display and text selection routines.
1737		1840
1738	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1841	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1739		1842
1740	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1843	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1741		1844
1742	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1845	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1743	extension, random hacks, numerous bugfixes and extensions.	1846	extension, random hacks, numerous bugfixes and extensions.
1744		1847
1745	Project Coordinator (Changes 1.0 -)	1848	Project Coordinator (Changes 1.0 -)
1746		1849
1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1850	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1748		1851
1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1852	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1750		1853
1751	=back	1854	=back
1752		1855

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC vs. Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC