[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.245 by root, Wed Jun 17 11:59:37 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>.
…		…
992	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
993	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
994		873
995	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
996		875
997	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>.
998	resource is limited on most machines to 65535; option B<-sl>.
999		877
1000	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
1001		879
1002	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;
1003	option B<-b>.	881	option B<-b>.
…		…
1066		944
1067	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
1068		946
1069	Mouse pointer background colour.	947	Mouse pointer background colour.
1070		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
1071	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
1072		956
1073	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
1074	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
1075		959
…		…
1101		985
1102	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1103		987
1104	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
1105		989
1106	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1107		991
1108	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
1109		993
1110	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
1111		995
…		…
1180	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
1181	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
1182	@@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
1183	directory will be used; option B<-cd>.	1067	directory will be used; option B<-cd>.
1184		1068
1185	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
1186		1070
1187	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1188	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
1189		1073
1190	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
1191	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	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>,	1076	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>,	1077	terminal scroll up or down the way you want it, or any other thing an
1194	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>.
1195		1088
1196	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
1197	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
1198	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
1199	current application keymap mode state.	1092	current application keymap mode state.
1200		1093
1201	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
1202	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
1203	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
1204	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1106	value (B<0x0000 - 0xFFFF>).
1205	performed in an exact manner; however, the closest match is assured.
1206		1107
1207	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
1208	number), see RESOURCES in C<man 7 X> for further details.	1110	number), see RESOURCES in C<man 7 X> for further details.
1209		1111
1210	You can define a range of keysyms in one shot by	1112	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>	1113	of action, followed by a colon. An action string without colons is
1212	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
1213	should be a character not used by the strings.	1136	the delimiter `/' should be a character not used by the strings.
1214		1137
1215	Its usage can be demonstrated by an example:	1138	Its usage can be demonstrated by an example:
1216		1139
1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1140	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1218		1141
1219	The above line is equivalent to the following three lines:	1142	The above line is equivalent to the following three lines:
1220		1143
1221	URxvt.keysym.Meta-Control-0x61: \033<a>	1144	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1222	URxvt.keysym.Meta-Control-0x62: \033<b>	1145	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1223	URxvt.keysym.Meta-Control-0x63: \033<c>	1146	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1224		1147
		1148	=item command:STRING
		1149
1225	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>
1226	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
1227	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>
1228	when Control-Meta-c is being pressed":	1157	when Control-Meta-c is being pressed":
1229		1158
1230	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
1231		1160
1232	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
1233	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
1234	manpage. For example, the F<selection> extension (activated via	1163	font-switching at runtime:
1235	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1236		1164
1237	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
1238		1167
1239	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
1240	will match if I<at least> the specified identifiers are being set, and	1169	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		1170
1246	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
1247	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
1248	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
1249	user-defined keymap using the C<builtin:> replacement:	1183	"holes" into the user-defined keymap using the C<builtin:> replacement:
1250		1184
1251	URxvt.keysym.Insert: <my insert key sequence>	1185	URxvt.keysym.Insert: <my insert key sequence>
1252	URxvt.keysym.S-Insert: builtin:	1186	URxvt.keysym.S-Insert: builtin:
1253		1187
1254	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
1255	of modifiers. The second line re-establishes the default mapping for	1189	of modifiers. The second line re-establishes the default mapping for
1256	C<Shift-Insert>.	1190	C<Shift-Insert>.
1257		1191
1258	The following example will map Control-Meta-1 and Control-Meta-2 to	1192	=item builtin-string:
1259	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1260	font-switching at runtime:
1261		1193
1262	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1194	This action is mainly useful to restore string mappings for keys that
1263	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.
1264		1199
1265	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
1266	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:
1267		1204
1268	URxvt.keysym.M-C-3: command:\033[8;25;80t	1205	URxvt.keysym.S-Insert: builtin-string:
1269	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
1270		1242
1271	=item B<perl-ext-common>: I<string>	1243	=item B<perl-ext-common>: I<string>
1272		1244
1273	=item B<perl-ext>: I<string>	1245	=item B<perl-ext>: I<string>
1274		1246
…		…
1276	use in this terminal instance; option B<-pe>.	1248	use in this terminal instance; option B<-pe>.
1277		1249
1278	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
1279	them. This can be useful to selectively disable some extensions loaded	1251	them. This can be useful to selectively disable some extensions loaded
1280	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
1281	example, C<default,-selection> will use all the default extension except	1253	example, C<default,-selection> will use all the default extensions except
1282	C<selection>.	1254	C<selection>.
1283		1255
1284	Extension names can also be followed by an argument in angle brackets	1256	The default set includes the C<selection>, C<option-popup>,
1285	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1257	C<selection-popup>, C<readline> and C<searchable-scrollback>
1286	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1258	extensions, and extensions which are mentioned in B<keysym> resources.
1287	multiple times with different arguments will pass multiple arguments to	1259
1288	the extension.	1260	Any extension such that a corresponding resource is given on the
		1261	command line is automatically appended to B<perl-ext>.
1289		1262
1290	Each extension is looked up in the library directories, loaded if	1263	Each extension is looked up in the library directories, loaded if
1291	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.
1292		1267
1293	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
1294	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
1295	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
1296	all instances, while B<perl-ext> is used for specific instances.	1271	all instances, while B<perl-ext> is used for specific instances.
1297		1272
1298	=item B<perl-eval>: I<string>	1273	=item B<perl-eval>: I<string>
1299		1274
…		…
1301	the @@RXVT_NAME@@perl(3) manpage.	1276	the @@RXVT_NAME@@perl(3) manpage.
1302		1277
1303	=item B<perl-lib>: I<path>	1278	=item B<perl-lib>: I<path>
1304		1279
1305	Colon-separated list of additional directories that hold extension	1280	Colon-separated list of additional directories that hold extension
1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first	1281	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1307	look in these directories, then in $HOME/.urxvt/ext and lastly in	1282	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1283	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1309		1284
1310	See the @@RXVT_NAME@@perl(3) manpage.	1285	See the @@RXVT_NAME@@perl(3) manpage.
1311		1286
1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1287	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1313		1288
…		…
1317	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1292	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1318		1293
1319	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1294	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1320	for details.	1295	for details.
1321		1296
1322	=item B<searchable-scrollback:> I<keysym>	1297	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1323		1298
1324	Sets the hotkey that starts the incremental scrollback buffer search	1299	This resource is deprecated and will be removed. Use a B<keysym> resource
1325	(default: C<M-s>).	1300	instead, e.g.:
1326		1301
		1302	URxvt.keysym.M-s: searchable-scrollback:start
		1303
1327	=item B<urlLauncher>: I<string>	1304	=item B<url-launcher>: I<string>
1328		1305
1329	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
1330	C<selection-popup> and C<matcher> perl extensions.	1307	C<selection-popup> and C<matcher> perl extensions.
1331		1308
1332	=item B<transient-for>: I<windowid>	1309	=item B<transient-for>: I<windowid>
…		…
1343	Turn on/off ISO 14755 (default enabled).	1320	Turn on/off ISO 14755 (default enabled).
1344		1321
1345	=item B<iso14755_52:> I<boolean>	1322	=item B<iso14755_52:> I<boolean>
1346		1323
1347	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.
1348		1439
1349	=back	1440	=back
1350		1441
1351	=head1 THE SCROLLBAR	1442	=head1 THE SCROLLBAR
1352		1443
…		…
1400	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
1401	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.
1402		1493
1403	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
1404	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.
1405		1502
1406	=back	1503	=back
1407		1504
1408	=head1 CHANGING FONTS	1505	=head1 CHANGING FONTS
1409		1506
…		…
1534	The following text gives values for the standard 88 colour mode (and	1631	The following text gives values for the standard 88 colour mode (and
1535	values for the 256 colour mode in parentheses).	1632	values for the 256 colour mode in parentheses).
1536		1633
1537	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1634	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1538		1635
1539	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1636	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	1637	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1541		1638
1542	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1639	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	1640	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1544	the RGB cube.	1641	the RGB cube.
1545		1642
…		…
1653		1750
1654	=item B<SHELL>	1751	=item B<SHELL>
1655		1752
1656	The shell to be used for command execution, defaults to C</bin/sh>.	1753	The shell to be used for command execution, defaults to C</bin/sh>.
1657		1754
1658	=item B<RXVT_SOCKET>	1755	=item B<RXVT_SOCKET> [I<sic>]
1659		1756
1660	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1757	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1661	@@RXVT_NAME@@d(1).	1758	@@RXVT_NAME@@d(1).
1662		1759
1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.	1760	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1761
		1762	=item B<URXVT_PERL_LIB>
		1763
		1764	Additional F<:>-separated library search path for perl extensions. Will be
		1765	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1766	directory.
		1767
		1768	=item B<URXVT_PERL_VERBOSITY>
		1769
		1770	See L<@@RXVT_NAME@@perl>(3).
1664		1771
1665	=item B<HOME>	1772	=item B<HOME>
1666		1773
1667	Used to locate the default directory for the unix domain socket for	1774	Used to locate the default directory for the unix domain socket for
1668	daemon communications and to locate various resource files (such as	1775	daemon communications and to locate various resource files (such as
…		…
1689		1796
1690	=back	1797	=back
1691		1798
1692	=head1 SEE ALSO	1799	=head1 SEE ALSO
1693		1800
		1801	@@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)	1802	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1695		1803
1696	=head1 CURRENT PROJECT COORDINATOR	1804	=head1 CURRENT PROJECT COORDINATOR
1697		1805
1698	=over 4	1806	=over 4
1699		1807
1700	=item Project Coordinator	1808	=item Project Coordinator
1701		1809
1702	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1810	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1703		1811
1704	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1812	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1705		1813
1706	=back	1814	=back
1707		1815
…		…
1711		1819
1712	=item John Bovey	1820	=item John Bovey
1713		1821
1714	University of Kent, 1992, wrote the original Xvt.	1822	University of Kent, 1992, wrote the original Xvt.
1715		1823
1716	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1824	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1717		1825
1718	very heavily modified Xvt and came up with Rxvt	1826	very heavily modified Xvt and came up with Rxvt
1719		1827
1720	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1828	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1721		1829
1722	wrote the Greek Keyboard Input (no longer in code)	1830	wrote the Greek Keyboard Input (no longer in code)
1723		1831
1724	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1832	=item mj olesen <olesen@me.QueensU.CA>
1725		1833
1726	Wrote the menu system.	1834	Wrote the menu system.
1727		1835
1728	Project Coordinator (changes.txt 2.11 to 2.21)	1836	Project Coordinator (changes.txt 2.11 to 2.21)
1729		1837
1730	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1838	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1731		1839
1732	Project Coordinator (changes.txt 2.21a to 2.4.5)	1840	Project Coordinator (changes.txt 2.21a to 2.4.5)
1733		1841
1734	=item Geoff Wing L<< <gcw@pobox.com> >>	1842	=item Geoff Wing <gcw@pobox.com>
1735		1843
1736	Rewrote screen display and text selection routines.	1844	Rewrote screen display and text selection routines.
1737		1845
1738	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1846	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1739		1847
1740	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1848	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1741		1849
1742	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1850	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1743	extension, random hacks, numerous bugfixes and extensions.	1851	extension, random hacks, numerous bugfixes and extensions.
1744		1852
1745	Project Coordinator (Changes 1.0 -)	1853	Project Coordinator (Changes 1.0 -)
1746		1854
1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1855	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1748		1856
1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1857	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1750		1858
1751	=back	1859	=back
1752		1860

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.245 by root, Wed Jun 17 11:59:37 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.245 by root, Wed Jun 17 11:59:37 2015 UTC