[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.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

…		…
98	is still respected. but deprecated). In the absence of this option, the	98	is still respected. but deprecated). In the absence of this option, the
99	display specified by the B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
100		100
101	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
102		102
103	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<frills>: Attempt to find a visual with the given bit depth;
104	resource B<depth>.	104	resource B<depth>.
105		105
106	[Please note that many X servers (and libXft) are buggy with	106	[Please note that many X servers (and libXft) are buggy with
107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts	107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108	of graphical corruption. This is harmless, but we can't do anything about	108	of graphical corruption. This is harmless, but we can't do anything about
109	this, so watch out]	109	this, so watch out]
110		110
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
		114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
		116
111	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
112		118
113	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
114		120
115	=item B<-rv>\|B<+rv>	121	=item B<-rv>\|B<+rv>
…		…
121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122		128
123	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
124		130
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127	=item B<-tr>\|B<+tr>
128
129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131	B<-ip> is still accepted as an obsolete alias but will be removed in
132	future versions.
133		132
134	=item B<-fade> I<number>	133	=item B<-fade> I<number>
135		134
136	Fade the text by the given percentage when focus is lost. Small values	135	Fade the text by the given percentage when focus is lost. Small values
137	fade a little only, 100 completely replaces all colours by the fade	136	fade a little only, 100 completely replaces all colours by the fade
…		…
140	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
141		140
142	Fade to this colour when fading is used (see B<-fade>). The default colour	141	Fade to this colour when fading is used (see B<-fade>). The default colour
143	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
144		143
145	=item B<-tint> I<colour>
146
147	Tint the transparent background with the given colour;
148	resource I<tintColor>.
149
150	=item B<-sh> I<number>
151
152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153	A value of 100 means no shading; resource I<shading>.
154
155	=item B<-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>.
…		…
1066		945
1067	=item B<pointerColor2:> I<colour>	946	=item B<pointerColor2:> I<colour>
1068		947
1069	Mouse pointer background colour.	948	Mouse pointer background colour.
1070		949
		950	=item B<pointerShape:> I<string>
		951
		952	Compile I<frills>: Specifies the name of the mouse pointer shape
		953	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		954	file for possible values (omit the C<XC_> prefix).
		955
1071	=item B<pointerBlankDelay:> I<number>	956	=item B<pointerBlankDelay:> I<number>
1072		957
1073	Specifies number of seconds before blanking the pointer [default 2]. Use a	958	Specifies number of seconds before blanking the pointer [default 2]. Use a
1074	large number (e.g. C<987654321>) to effectively disable the timeout.	959	large number (e.g. C<987654321>) to effectively disable the timeout.
1075		960
…		…
1101		986
1102	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	987	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1103		988
1104	=item B<preeditType:> I<style>	989	=item B<preeditType:> I<style>
1105		990
1106	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	991	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1107		992
1108	=item B<inputMethod:> I<name>	993	=item B<inputMethod:> I<name>
1109		994
1110	I<name> of inputMethod to use; option B<-im>.	995	I<name> of inputMethod to use; option B<-im>.
1111		996
…		…
1180	Sets the working directory for the shell (or the command specified via	1065	Sets the working directory for the shell (or the command specified via
1181	B<-e>). The I<path> must be an absolute path and it must exist for	1066	B<-e>). The I<path> must be an absolute path and it must exist for
1182	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1067	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1183	directory will be used; option B<-cd>.	1068	directory will be used; option B<-cd>.
1184		1069
1185	=item B<keysym.>I<sym>: I<string>	1070	=item B<keysym.>I<sym>: I<action>
1186		1071
1187	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1072	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1188	intervening resource name B<keysym.> cannot be omitted.	1073	resource name B<keysym.> cannot be omitted.
1189		1074
1190	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1075	Using this resource, you can map key combinations such as
1191	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1076	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>,	1077	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>,	1078	terminal scroll up or down the way you want it, or any other thing an
1194	B<2>, B<3>, B<4>, B<5>.	1079	extension might provide.
		1080
		1081	The key combination that triggers the action, I<sym>, has the following format:
		1082
		1083	(modifiers-)key
		1084
		1085	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1086	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1087	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1088	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1195		1089
1196	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1090	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1197	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1091	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1198	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1092	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1199	current application keymap mode state.	1093	current application keymap mode state.
1200		1094
1201	The spellings of I<key> can be obtained by using B<xev>(1) command or	1095	Due the the large number of modifier combinations, a key mapping will
1202	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1096	match if I<at least> the specified identifiers are being set, and no other
		1097	key mappings with those and more bits are being defined. That means that
		1098	defining a mapping for C<a> will automatically provide definitions for
		1099	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1100	themselves. See the C<builtin:> action, below, for a way to work around
		1101	this when this is a problem.
		1102
		1103	The spelling of I<key> depends on your implementation of X. An easy way to
		1104	find a key name is to use the B<xev>(1) command. You can find a list by
		1105	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1203	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1106	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1204	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1107	value (B<0x0000 - 0xFFFF>).
1205	performed in an exact manner; however, the closest match is assured.
1206		1108
1207	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1109	As with any resource value, the I<action> string may contain backslash
		1110	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1208	number), see RESOURCES in C<man 7 X> for further details.	1111	number), see RESOURCES in C<man 7 X> for further details.
1209		1112
1210	You can define a range of keysyms in one shot by	1113	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>	1114	of action, followed by a colon. An action string without colons is
1212	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1115	interpreted as a literal string to pass to the tty (as if it was
		1116	prefixed with C<string:>).
		1117
		1118	The following action prefixes are known - extensions can provide
		1119	additional prefixes:
		1120
		1121	=over 4
		1122
		1123	=item string:STRING
		1124
		1125	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1126	then the remaining C<STRING> will be passed to the program running in the
		1127	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1128	string C<echo rm -rf /> followed by a newline:
		1129
		1130	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1131
		1132	This could in theory be used to completely redefine your keymap.
		1133
		1134	In addition, for actions of this type, you can define a range of
		1135	keysyms in one shot by loading the C<keysym-list> perl extension and
		1136	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1213	should be a character not used by the strings.	1137	the delimiter `/' should be a character not used by the strings.
1214		1138
1215	Its usage can be demonstrated by an example:	1139	Its usage can be demonstrated by an example:
1216		1140
1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1141	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1218		1142
1219	The above line is equivalent to the following three lines:	1143	The above line is equivalent to the following three lines:
1220		1144
1221	URxvt.keysym.Meta-Control-0x61: \033<a>	1145	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1222	URxvt.keysym.Meta-Control-0x62: \033<b>	1146	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1223	URxvt.keysym.Meta-Control-0x63: \033<c>	1147	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1224		1148
		1149	=item command:STRING
		1150
1225	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1151	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1226	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1152	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1153	the opposite of C<string:> - instead of sending it to the program running
		1154	in the terminal, it will be treated as if it were program output). This is
		1155	most useful to feed command sequences into @@RXVT_NAME@@.
		1156
1227	example the following means "change the current locale to C<zh_CN.GBK>	1157	For example the following means "change the current locale to C<zh_CN.GBK>
1228	when Control-Meta-c is being pressed":	1158	when Control-Meta-c is being pressed":
1229		1159
1230	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1160	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1231		1161
1232	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1162	The following example will map Control-Meta-1 and Control-Meta-2 to
1233	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1163	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1234	manpage. For example, the F<selection> extension (activated via	1164	font-switching at runtime:
1235	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1236		1165
1237	URxvt.keysym.M-C-c: perl:selection:rot13	1166	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1167	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1238		1168
1239	Due the the large number of modifier combinations, a defined key mapping	1169	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1240	will match if I<at least> the specified identifiers are being set, and	1170	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		1171
1246	Unfortunately, this will override built-in key mappings. For example	1172	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1173	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1174
		1175	=item builtin:
		1176
		1177	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1178	key binding existed for the key combination. The obvious use is to undo
		1179	the effect of existing bindings. The not so obvious use is to reinstate
		1180	bindings when another binding overrides too many modifiers.
		1181
1247	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1182	For example if you overwrite the C<Insert> key you will disable
1248	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1183	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1249	user-defined keymap using the C<builtin:> replacement:	1184	"holes" into the user-defined keymap using the C<builtin:> replacement:
1250		1185
1251	URxvt.keysym.Insert: <my insert key sequence>	1186	URxvt.keysym.Insert: <my insert key sequence>
1252	URxvt.keysym.S-Insert: builtin:	1187	URxvt.keysym.S-Insert: builtin:
1253		1188
1254	The first line defines a mapping for C<Insert> and I<any> combination	1189	The first line defines a mapping for C<Insert> and I<any> combination
1255	of modifiers. The second line re-establishes the default mapping for	1190	of modifiers. The second line re-establishes the default mapping for
1256	C<Shift-Insert>.	1191	C<Shift-Insert>.
1257		1192
1258	The following example will map Control-Meta-1 and Control-Meta-2 to	1193	=item builtin-string:
1259	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1260	font-switching at runtime:
1261		1194
1262	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1195	This action is mainly useful to restore string mappings for keys that
1263	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1196	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1197	difficult to explain - basically, this action will send the string to the
		1198	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1199	action for it.
1264		1200
1265	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1201	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1266	info):	1202	selection when you press C<Shift-Insert>. With the following bindings, it
		1203	would instead emit the (undocumented, but what applications running in the
		1204	terminal might expect) sequence C<ESC [ 2 $> instead:
1267		1205
1268	URxvt.keysym.M-C-3: command:\033[8;25;80t	1206	URxvt.keysym.S-Insert: builtin-string:
1269	URxvt.keysym.M-C-4: command:\033[8;48;110t	1207	URxvt.keysym.C-S-Insert: builtin:
		1208
		1209	The first line disables the paste functionality for that key
		1210	combination, and the second reinstates the default behaviour for
		1211	C<Control-Shift-Insert>, which would otherwise be overridden.
		1212
		1213	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1214	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1215	this:
		1216
		1217	URxvt.keysym.C-M-c: builtin-string:
		1218	URxvt.keysym.C-M-v: builtin-string:
		1219
		1220	=item EXTENSION:STRING
		1221
		1222	An action of this form invokes the action B<STRING>, if any, provided
		1223	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1224	be loaded automatically if necessary.
		1225
		1226	Not all extensions define actions, but popular extensions that do
		1227	include the I<selection> and I<matcher> extensions (documented in their
		1228	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1229	respectively).
		1230
		1231	From the silly examples department, this will rot13-"encrypt"
		1232	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1233	keyboards:
		1234
		1235	URxvt.keysym.M-C-c: selection:rot13
		1236
		1237	=item perl:STRING DEPRECATED
		1238
		1239	This is a deprecated way of invoking commands provided by perl
		1240	extensions. It is still supported, but should not be used anymore.
		1241
		1242	=back
1270		1243
1271	=item B<perl-ext-common>: I<string>	1244	=item B<perl-ext-common>: I<string>
1272		1245
1273	=item B<perl-ext>: I<string>	1246	=item B<perl-ext>: I<string>
1274		1247
…		…
1276	use in this terminal instance; option B<-pe>.	1249	use in this terminal instance; option B<-pe>.
1277		1250
1278	Extension names can be prefixed with a C<-> sign to prohibit using	1251	Extension names can be prefixed with a C<-> sign to prohibit using
1279	them. This can be useful to selectively disable some extensions loaded	1252	them. This can be useful to selectively disable some extensions loaded
1280	by default, or specified via the C<perl-ext-common> resource. For	1253	by default, or specified via the C<perl-ext-common> resource. For
1281	example, C<default,-selection> will use all the default extension except	1254	example, C<default,-selection> will use all the default extensions except
1282	C<selection>.	1255	C<selection>.
1283		1256
1284	Extension names can also be followed by an argument in angle brackets	1257	The default set includes the C<selection>, C<option-popup>,
1285	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1258	C<selection-popup>, C<readline> and C<searchable-scrollback>
1286	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1259	extensions, and extensions which are mentioned in B<keysym> resources.
1287	multiple times with different arguments will pass multiple arguments to	1260
1288	the extension.	1261	Any extension such that a corresponding resource is given on the
		1262	command line is automatically appended to B<perl-ext>.
1289		1263
1290	Each extension is looked up in the library directories, loaded if	1264	Each extension is looked up in the library directories, loaded if
1291	necessary, and bound to the current terminal instance.	1265	necessary, and bound to the current terminal instance. When the library
		1266	search path contains multiple extension files of the same name, then the
		1267	first one found will be used.
1292		1268
1293	If both of these resources are the empty string, then the perl	1269	If both of these resources are the empty string, then the perl interpreter
1294	interpreter will not be initialized. The idea behind two options is that	1270	will not be initialized. The rationale for having two options is that
1295	B<perl-ext-common> will be used for extensions that should be available to	1271	B<perl-ext-common> will be used for extensions that should be available to
1296	all instances, while B<perl-ext> is used for specific instances.	1272	all instances, while B<perl-ext> is used for specific instances.
1297		1273
1298	=item B<perl-eval>: I<string>	1274	=item B<perl-eval>: I<string>
1299		1275
…		…
1301	the @@RXVT_NAME@@perl(3) manpage.	1277	the @@RXVT_NAME@@perl(3) manpage.
1302		1278
1303	=item B<perl-lib>: I<path>	1279	=item B<perl-lib>: I<path>
1304		1280
1305	Colon-separated list of additional directories that hold extension	1281	Colon-separated list of additional directories that hold extension
1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first	1282	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1307	look in these directories, then in $HOME/.urxvt/ext and lastly in	1283	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1284	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1309		1285
1310	See the @@RXVT_NAME@@perl(3) manpage.	1286	See the @@RXVT_NAME@@perl(3) manpage.
1311		1287
1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1288	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1313		1289
…		…
1317	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1293	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1318		1294
1319	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1295	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1320	for details.	1296	for details.
1321		1297
1322	=item B<searchable-scrollback:> I<keysym>	1298	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1323		1299
1324	Sets the hotkey that starts the incremental scrollback buffer search	1300	This resource is deprecated and will be removed. Use a B<keysym> resource
1325	(default: C<M-s>).	1301	instead, e.g.:
1326		1302
		1303	URxvt.keysym.M-s: searchable-scrollback:start
		1304
1327	=item B<urlLauncher>: I<string>	1305	=item B<url-launcher>: I<string>
1328		1306
1329	Specifies the program to be started with a URL argument. Used by the	1307	Specifies the program to be started with a URL argument. Used by the
1330	C<selection-popup> and C<matcher> perl extensions.	1308	C<selection-popup> and C<matcher> perl extensions.
1331		1309
1332	=item B<transient-for>: I<windowid>	1310	=item B<transient-for>: I<windowid>
…		…
1343	Turn on/off ISO 14755 (default enabled).	1321	Turn on/off ISO 14755 (default enabled).
1344		1322
1345	=item B<iso14755_52:> I<boolean>	1323	=item B<iso14755_52:> I<boolean>
1346		1324
1347	Turn on/off ISO 14755 5.2 mode (default enabled).	1325	Turn on/off ISO 14755 5.2 mode (default enabled).
		1326
		1327	=back
		1328
		1329	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1330
		1331	=over 4
		1332
		1333	=item B<-pixmap> I<file[;oplist]>
		1334
		1335	=item B<backgroundPixmap:> I<file[;oplist]>
		1336
		1337	Compile I<pixbuf>: Use the specified image file as the window's
		1338	background and also optionally specify a colon separated list of
		1339	operations to modify it. Note that you may need to quote the C<;>
		1340	character when using the command line option, as C<;> is usually a
		1341	metacharacter in shells. Supported operations are:
		1342
		1343	=over 4
		1344
		1345	=item B<WxH+X+Y>
		1346
		1347	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1348	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1349	scale of 0 disables scaling.
		1350
		1351	=item B<op=tile>
		1352
		1353	enables tiling
		1354
		1355	=item B<op=keep-aspect>
		1356
		1357	maintain the image aspect ratio when scaling
		1358
		1359	=item B<op=root-align>
		1360
		1361	use the position of the terminal window relative to the root window as
		1362	the image offset, simulating a root window background
		1363
		1364	=back
		1365
		1366	The default scale and position setting is C<100x100+50+50>.
		1367	Alternatively, a predefined set of templates can be used to achieve
		1368	the most common setups:
		1369
		1370	=over 4
		1371
		1372	=item B<style=tiled>
		1373
		1374	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1375
		1376	=item B<style=aspect-stretched>
		1377
		1378	the image is scaled to fill the whole window maintaining the aspect
		1379	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1380
		1381	=item B<style=stretched>
		1382
		1383	the image is scaled to fill the whole window. Equivalent to 100x100
		1384
		1385	=item B<style=centered>
		1386
		1387	the image is centered with no scaling. Equivalent to 0x0+50+50
		1388
		1389	=item B<style=root-tiled>
		1390
		1391	the image is tiled with no scaling and using 'root' positioning.
		1392	Equivalent to 0x0:op=tile:op=root-align
		1393
		1394	=back
		1395
		1396	If multiple templates are specified the last one wins. Note that a
		1397	template overrides all the scale, position and operations settings.
		1398
		1399	If used in conjunction with pseudo-transparency, the specified pixmap
		1400	will be blended over the transparent background using alpha-blending.
		1401
		1402	=item B<-tr>\|B<+tr>
		1403
		1404	=item B<transparent:> I<boolean>
		1405
		1406	Turn on/off pseudo-transparency by using the root pixmap as background.
		1407
		1408	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1409	will be removed in future versions.
		1410
		1411	=item B<-tint> I<colour>
		1412
		1413	=item B<tintColor:> I<colour>
		1414
		1415	Tint the transparent background with the given colour. Note that a
		1416	black tint yields a completely black image while a white tint yields
		1417	the image unchanged.
		1418
		1419	=item B<-sh> I<number>
		1420
		1421	=item B<shading:> I<number>
		1422
		1423	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1424	A value of 100 means no shading.
		1425
		1426	=item B<-blr> I<HxV>
		1427
		1428	=item B<blurRadius:> I<HxV>
		1429
		1430	Apply gaussian blur with the specified radius to the transparent
		1431	background. If a single number is specified, the vertical and
		1432	horizontal radii are considered to be the same. Setting one of the
		1433	radii to 1 and the other to a large number creates interesting effects
		1434	on some backgrounds. The maximum radius value is 128. An horizontal or
		1435	vertical radius of 0 disables blurring.
		1436
		1437	=item B<path:> I<path>
		1438
		1439	Specify the colon-delimited search path for finding background image files.
1348		1440
1349	=back	1441	=back
1350		1442
1351	=head1 THE SCROLLBAR	1443	=head1 THE SCROLLBAR
1352		1444
…		…
1400	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1492	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1401	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1493	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1402		1494
1403	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1495	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1404	inserted too.	1496	inserted too.
		1497
		1498	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1499	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1500	binding causes the value of the internal selection to be copied to the
		1501	CLIPBOARD selection, while the second binding causes the value of the
		1502	CLIPBOARD selection to be inserted.
1405		1503
1406	=back	1504	=back
1407		1505
1408	=head1 CHANGING FONTS	1506	=head1 CHANGING FONTS
1409		1507
…		…
1534	The following text gives values for the standard 88 colour mode (and	1632	The following text gives values for the standard 88 colour mode (and
1535	values for the 256 colour mode in parentheses).	1633	values for the 256 colour mode in parentheses).
1536		1634
1537	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1635	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1538		1636
1539	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1637	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1540	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1638	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1541		1639
1542	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1640	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1543	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1641	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1544	the RGB cube.	1642	the RGB cube.
1545		1643
…		…
1653		1751
1654	=item B<SHELL>	1752	=item B<SHELL>
1655		1753
1656	The shell to be used for command execution, defaults to C</bin/sh>.	1754	The shell to be used for command execution, defaults to C</bin/sh>.
1657		1755
1658	=item B<RXVT_SOCKET>	1756	=item B<RXVT_SOCKET> [I<sic>]
1659		1757
1660	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1758	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1661	@@RXVT_NAME@@d(1).	1759	@@RXVT_NAME@@d(1).
1662		1760
1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.	1761	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1762
		1763	=item B<URXVT_PERL_LIB>
		1764
		1765	Additional F<:>-separated library search path for perl extensions. Will be
		1766	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1767	directory.
		1768
		1769	=item B<URXVT_PERL_VERBOSITY>
		1770
		1771	See L<@@RXVT_NAME@@perl>(3).
1664		1772
1665	=item B<HOME>	1773	=item B<HOME>
1666		1774
1667	Used to locate the default directory for the unix domain socket for	1775	Used to locate the default directory for the unix domain socket for
1668	daemon communications and to locate various resource files (such as	1776	daemon communications and to locate various resource files (such as
…		…
1689		1797
1690	=back	1798	=back
1691		1799
1692	=head1 SEE ALSO	1800	=head1 SEE ALSO
1693		1801
		1802	@@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)	1803	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1695		1804
1696	=head1 CURRENT PROJECT COORDINATOR	1805	=head1 CURRENT PROJECT COORDINATOR
1697		1806
1698	=over 4	1807	=over 4
1699		1808
1700	=item Project Coordinator	1809	=item Project Coordinator
1701		1810
1702	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1811	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1703		1812
1704	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1813	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1705		1814
1706	=back	1815	=back
1707		1816
…		…
1711		1820
1712	=item John Bovey	1821	=item John Bovey
1713		1822
1714	University of Kent, 1992, wrote the original Xvt.	1823	University of Kent, 1992, wrote the original Xvt.
1715		1824
1716	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1825	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1717		1826
1718	very heavily modified Xvt and came up with Rxvt	1827	very heavily modified Xvt and came up with Rxvt
1719		1828
1720	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1829	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1721		1830
1722	wrote the Greek Keyboard Input (no longer in code)	1831	wrote the Greek Keyboard Input (no longer in code)
1723		1832
1724	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1833	=item mj olesen <olesen@me.QueensU.CA>
1725		1834
1726	Wrote the menu system.	1835	Wrote the menu system.
1727		1836
1728	Project Coordinator (changes.txt 2.11 to 2.21)	1837	Project Coordinator (changes.txt 2.11 to 2.21)
1729		1838
1730	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1839	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1731		1840
1732	Project Coordinator (changes.txt 2.21a to 2.4.5)	1841	Project Coordinator (changes.txt 2.21a to 2.4.5)
1733		1842
1734	=item Geoff Wing L<< <gcw@pobox.com> >>	1843	=item Geoff Wing <gcw@pobox.com>
1735		1844
1736	Rewrote screen display and text selection routines.	1845	Rewrote screen display and text selection routines.
1737		1846
1738	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1847	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1739		1848
1740	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1849	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1741		1850
1742	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1851	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1743	extension, random hacks, numerous bugfixes and extensions.	1852	extension, random hacks, numerous bugfixes and extensions.
1744		1853
1745	Project Coordinator (Changes 1.0 -)	1854	Project Coordinator (Changes 1.0 -)
1746		1855
1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1856	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1748		1857
1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1858	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1750		1859
1751	=back	1860	=back
1752		1861

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.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC