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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.205 by sf-exg, Fri Nov 18 02:15:22 2011 UTC vs.
Revision 1.247 by sf-exg, Thu Jul 14 05:33:25 2016 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 - both vertical and
169	horizontal radii are considered to be the same. Setting one of the
170	radii to 1 and another to a large number creates interesting effects
171	on some backgrounds. Maximum radius value is 128;
172	resource I<blurRadius>.
173
174	=item B<-icon> I<file>	144	=item B<-icon> I<file>
175		145
176	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
177	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
178	application window; resource I<iconFile>.	148	application window; resource I<iconFile>.
179		149
180	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
181		151
182	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
183		153
184	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
185		155
186	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
187
188	=item B<-pixmap> I<file[;oplist]>
189
190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191	optionally specify a list of operations to modify it. Note you may need to
192	add quotes to avoid special shell interpretation of the C<;> in the
193	command-line; for more details see resource B<backgroundPixmap>.
194		157
195	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
196		159
197	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
198		161
…		…
257		220
258	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
259		222
260	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
261		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
262	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
263		230
264	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
265	B<utmpInhibit>.	232	B<utmpInhibit>.
266		233
…		…
344		311
345	=item B<-override-redirect>	312	=item B<-override-redirect>
346		313
347	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
348	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.
349		321
350	=item B<-sbg>	322	=item B<-sbg>
351		323
352	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
353	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
…		…
407		379
408	=item B<-pt> I<style>	380	=item B<-pt> I<style>
409		381
410	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
411	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.
412		387
413	=item B<-im> I<text>	388	=item B<-im> I<text>
414		389
415	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
416		391
…		…
687		662
688	B<False>: specify that everything is to be displayed, even	663	B<False>: specify that everything is to be displayed, even
689	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
690	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
691		666
692	=item B<transparent:> I<boolean>
693
694	Turn on/off pseudo-transparency by using the root pixmap as background.
695
696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
697	future versions.
698
699	=item B<fading:> I<number>	667	=item B<fading:> I<number>
700		668
701	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>.
702		670
703	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
704		672
705	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
706	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
707		675
708	=item B<tintColor:> I<colour>
709
710	Tint the transparent background with the given colour. If the RENDER
711	extension is not available only black, red, green, yellow, blue,
712	magenta, cyan and white tints can be performed server-side. Note that
713	a black tint yields a completely black image while a white tint yields
714	the image unchanged; option B<-tint>.
715
716	=item B<shading:> I<number>
717
718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
719	A value of 100 means no shading; option B<-sh>.
720
721	=item B<blendType:> I<string>
722
723	Specify background blending type; option B<-blt>.
724
725	=item B<blurRadius:> I<number>
726
727	Apply gaussian blur with the specified radius to the transparent
728	background; option B<-blr>.
729
730	=item B<iconFile:> I<file>	676	=item B<iconFile:> I<file>
731		677
732	Set the application icon pixmap; option B<-icon>.	678	Set the application icon pixmap; option B<-icon>.
733		679
734	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
…		…
742		688
743	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
744		690
745	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
746	and the text.	692	and the text.
747
748	=item B<backgroundPixmap:> I<file[;oplist]>
749
750	Use the specified image file for the background and also
751	optionally specify a colon separated list of operations to modify it.
752	Supported operations are:
753
754	=over 4
755
756	=item B<WxH+X+Y>
757
758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
760	scale of 0 disables scaling. The maximum permitted scale is 1000.
761
762	=item B<op=tile>
763
764	enables tiling
765
766	=item B<op=pscale>
767
768	enables proportional scaling
769
770	=item B<op=root>
771
772	use the position of the terminal window relative to the root window as
773	the image offset, simulating a root window background
774
775	=back
776
777	The default scale and position setting is C<100x100+50+50>.
778	Alternatively, a predefined set of templates can be used to achieve
779	the most common setups:
780
781	=over 4
782
783	=item B<style=tiled>
784
785	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786
787	=item B<style=aspect-stretched>
788
789	the image is scaled to fill the whole window maintaining the aspect
790	ratio and centered. Equivalent to 100x100+50+50:op=pscale
791
792	=item B<style=stretched>
793
794	the image is scaled to fill the whole window. Equivalent to 100x100
795
796	=item B<style=centered>
797
798	the image is centered with no scaling. Equivalent to 0x0+50+50
799
800	=item B<style=root-tiled>
801
802	the image is tiled with no scaling and using 'root' positioning.
803	Equivalent to 0x0:op=tile:op=root
804
805	=back
806
807	If multiple templates are specified the last one wins. Note that a
808	template overrides all the scale, position and operations settings.
809
810	If used in conjunction with B<-tr> option, the specified pixmap will be
811	blended over the transparent background using alpha-blending. If I<afterimage>
812	support has been compiled in it is possible to choose other blending
813	types with B<-blt "type"> option.
814
815	=item B<path:> I<path>
816
817	Specify the colon-delimited search path for finding background image files.
818		693
819	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
820		695
821	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
822	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
…		…
919		794
920	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
921	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
922	[default]; option B<+ls>.	797	[default]; option B<+ls>.
923		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
924	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
925		805
926	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>;
927	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>
928	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
991	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
992	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
993		873
994	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
995		875
996	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>.
997	resource is limited on most machines to 65535; option B<-sl>.
998		877
999	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
1000		879
1001	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;
1002	option B<-b>.	881	option B<-b>.
…		…
1065		944
1066	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
1067		946
1068	Mouse pointer background colour.	947	Mouse pointer background colour.
1069		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
1070	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
1071		956
1072	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
1073	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
1074		959
…		…
1100		985
1101	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1102		987
1103	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
1104		989
1105	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1106		991
1107	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
1108		993
1109	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
1110		995
…		…
1179	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
1180	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
1181	@@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
1182	directory will be used; option B<-cd>.	1067	directory will be used; option B<-cd>.
1183		1068
1184	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
1185		1070
1186	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1187	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
1188		1073
1189	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
1190	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1191	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
1192	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
1193	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>.
1194		1088
1195	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
1196	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
1197	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
1198	current application keymap mode state.	1092	current application keymap mode state.
1199		1093
1200	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
1201	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
1202	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
1203	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1106	value (B<0x0000 - 0xFFFF>).
1204	performed in an exact manner; however, the closest match is assured.
1205		1107
1206	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
1207	number), see RESOURCES in C<man 7 X> for further details.	1110	number), see RESOURCES in C<man 7 X> for further details.
1208		1111
1209	You can define a range of keysyms in one shot by providing a I<string>	1112	An action starts with an action prefix that selects a certain type
1210	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1113	of action, followed by a colon. An action string without colons is
		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
1211	should be a character not used by the strings.	1136	the delimiter `/' should be a character not used by the strings.
1212		1137
1213	Its usage can be demonstrated by an example:	1138	Its usage can be demonstrated by an example:
1214		1139
1215	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1140	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1216		1141
1217	The above line is equivalent to the following three lines:	1142	The above line is equivalent to the following three lines:
1218		1143
1219	URxvt.keysym.Meta-Control-0x61: \033<a>	1144	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1220	URxvt.keysym.Meta-Control-0x62: \033<b>	1145	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1221	URxvt.keysym.Meta-Control-0x63: \033<c>	1146	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1222		1147
		1148	=item command:STRING
		1149
1223	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>
1224	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
1225	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>
1226	when Control-Meta-c is being pressed":	1157	when Control-Meta-c is being pressed":
1227		1158
1228	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
1229		1160
1230	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
1231	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
1232	manpage. For example, the F<selection> extension (activated via	1163	font-switching at runtime:
1233	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1234		1164
1235	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
1236		1167
1237	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
1238	will match if I<at least> the specified identifiers are being set, and	1169	info):
1239	no other key mappings with those and more bits are being defined. That
1240	means that defining a key map for C<a> will automatically provide
1241	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1242	mappings themselves.
1243		1170
1244	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
1245	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
1246	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
1247	user-defined keymap using the C<builtin:> replacement:	1183	"holes" into the user-defined keymap using the C<builtin:> replacement:
1248		1184
1249	URxvt.keysym.Insert: <my insert key sequence>	1185	URxvt.keysym.Insert: <my insert key sequence>
1250	URxvt.keysym.S-Insert: builtin:	1186	URxvt.keysym.S-Insert: builtin:
1251		1187
1252	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
1253	of modifiers. The second line re-establishes the default mapping for	1189	of modifiers. The second line re-establishes the default mapping for
1254	C<Shift-Insert>.	1190	C<Shift-Insert>.
1255		1191
1256	The following example will map Control-Meta-1 and Control-Meta-2 to	1192	=item builtin-string:
1257	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1258	font-switching at runtime:
1259		1193
1260	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1194	This action is mainly useful to restore string mappings for keys that
1261	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.
1262		1199
1263	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
1264	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:
1265		1204
1266	URxvt.keysym.M-C-3: command:\033[8;25;80t	1205	URxvt.keysym.S-Insert: builtin-string:
1267	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
1268		1242
1269	=item B<perl-ext-common>: I<string>	1243	=item B<perl-ext-common>: I<string>
1270		1244
1271	=item B<perl-ext>: I<string>	1245	=item B<perl-ext>: I<string>
1272		1246
…		…
1274	use in this terminal instance; option B<-pe>.	1248	use in this terminal instance; option B<-pe>.
1275		1249
1276	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
1277	them. This can be useful to selectively disable some extensions loaded	1251	them. This can be useful to selectively disable some extensions loaded
1278	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
1279	example, C<default,-selection> will use all the default extension except	1253	example, C<default,-selection> will use all the default extensions except
1280	C<selection>.	1254	C<selection>.
1281		1255
1282	Extension names can also be followed by an argument in angle brackets	1256	The default set includes the C<selection>, C<option-popup>,
1283	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1257	C<selection-popup>, C<readline> and C<searchable-scrollback>
1284	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1258	extensions, and extensions which are mentioned in B<keysym> resources.
1285	multiple times with different arguments will pass multiple arguments to	1259
1286	the extension.	1260	Any extension such that a corresponding resource is given on the
		1261	command line is automatically appended to B<perl-ext>.
1287		1262
1288	Each extension is looked up in the library directories, loaded if	1263	Each extension is looked up in the library directories, loaded if
1289	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.
1290		1267
1291	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
1292	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
1293	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
1294	all instances, while B<perl-ext> is used for specific instances.	1271	all instances, while B<perl-ext> is used for specific instances.
1295		1272
1296	=item B<perl-eval>: I<string>	1273	=item B<perl-eval>: I<string>
1297		1274
…		…
1299	the @@RXVT_NAME@@perl(3) manpage.	1276	the @@RXVT_NAME@@perl(3) manpage.
1300		1277
1301	=item B<perl-lib>: I<path>	1278	=item B<perl-lib>: I<path>
1302		1279
1303	Colon-separated list of additional directories that hold extension	1280	Colon-separated list of additional directories that hold extension
1304	scripts. When looking for extensions specified by the C<perl> resource,	1281	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1305	@@RXVT_NAME@@ will first look in these directories and then in	1282	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1306	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1283	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1307		1284
1308	See the @@RXVT_NAME@@perl(3) manpage.	1285	See the @@RXVT_NAME@@perl(3) manpage.
1309		1286
1310	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1287	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1311		1288
…		…
1315	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1292	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1316		1293
1317	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1294	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1318	for details.	1295	for details.
1319		1296
1320	=item B<searchable-scrollback:> I<keysym>	1297	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1321		1298
1322	Sets the hotkey that starts the incremental scrollback buffer search	1299	This resource is deprecated and will be removed. Use a B<keysym> resource
1323	(default: C<M-s>).	1300	instead, e.g.:
1324		1301
		1302	URxvt.keysym.M-s: searchable-scrollback:start
		1303
1325	=item B<urlLauncher>: I<string>	1304	=item B<url-launcher>: I<string>
1326		1305
1327	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
1328	C<selection-popup> and C<matcher> perl extensions.	1307	C<selection-popup> and C<matcher> perl extensions.
1329		1308
1330	=item B<transient-for>: I<windowid>	1309	=item B<transient-for>: I<windowid>
…		…
1398	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1377	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1399	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1378	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1400		1379
1401	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1380	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1402	inserted too.	1381	inserted too.
		1382
		1383	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1384	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1385	binding causes the value of the internal selection to be copied to the
		1386	CLIPBOARD selection, while the second binding causes the value of the
		1387	CLIPBOARD selection to be inserted.
1403		1388
1404	=back	1389	=back
1405		1390
1406	=head1 CHANGING FONTS	1391	=head1 CHANGING FONTS
1407		1392
…		…
1496	In addition to the default foreground and background colours,	1481	In addition to the default foreground and background colours,
1497	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1482	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1498	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1483	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1499	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1484	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1500	cube plus a 8 (24) colour greyscale ramp.	1485	cube plus a 8 (24) colour greyscale ramp.
		1486
		1487	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1488	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1489	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1490	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1491	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1492	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1493	use many similar 24-bit colours. It's typically not a problem in common
		1494	scenarios.
1501		1495
1502	Here is a list of the ANSI colours with their names.	1496	Here is a list of the ANSI colours with their names.
1503		1497
1504	=begin table	1498	=begin table
1505		1499
…		…
1532	The following text gives values for the standard 88 colour mode (and	1526	The following text gives values for the standard 88 colour mode (and
1533	values for the 256 colour mode in parentheses).	1527	values for the 256 colour mode in parentheses).
1534		1528
1535	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1529	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1536		1530
1537	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1531	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1538	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1532	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1539		1533
1540	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1534	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1541	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1535	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1542	the RGB cube.	1536	the RGB cube.
1543		1537
…		…
1559	White.	1553	White.
1560		1554
1561	=head2 ALPHA CHANNEL SUPPORT	1555	=head2 ALPHA CHANNEL SUPPORT
1562		1556
1563	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1557	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1564	their act together, rxvt-unicode will do it's own alpha channel management:	1558	their act together, rxvt-unicode will do its own alpha channel management:
1565		1559
1566	You can prefix any colour with an opaqueness percentage enclosed in	1560	You can prefix any colour with an opaqueness percentage enclosed in
1567	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1561	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1568	(0-100) that specifies the opacity of the colour, where C<0> is completely	1562	(0-100) that specifies the opacity of the colour, where C<0> is completely
1569	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1563	transparent and C<100> is completely opaque. For example, C<[50]red> is a
…		…
1651		1645
1652	=item B<SHELL>	1646	=item B<SHELL>
1653		1647
1654	The shell to be used for command execution, defaults to C</bin/sh>.	1648	The shell to be used for command execution, defaults to C</bin/sh>.
1655		1649
1656	=item B<RXVT_SOCKET>	1650	=item B<RXVT_SOCKET> [I<sic>]
1657		1651
1658	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1652	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1659	@@RXVT_NAME@@d(1).	1653	@@RXVT_NAME@@d(1).
1660		1654
1661	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.	1655	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1656
		1657	=item B<URXVT_PERL_LIB>
		1658
		1659	Additional F<:>-separated library search path for perl extensions. Will be
		1660	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1661	directory.
		1662
		1663	=item B<URXVT_PERL_VERBOSITY>
		1664
		1665	See L<@@RXVT_NAME@@perl>(3).
1662		1666
1663	=item B<HOME>	1667	=item B<HOME>
1664		1668
1665	Used to locate the default directory for the unix domain socket for	1669	Used to locate the default directory for the unix domain socket for
1666	daemon communications and to locate various resource files (such as	1670	daemon communications and to locate various resource files (such as
…		…
1687		1691
1688	=back	1692	=back
1689		1693
1690	=head1 SEE ALSO	1694	=head1 SEE ALSO
1691		1695
		1696	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1692	@@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)	1697	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1693		1698
1694	=head1 CURRENT PROJECT COORDINATOR	1699	=head1 CURRENT PROJECT COORDINATOR
1695		1700
1696	=over 4	1701	=over 4
1697		1702
1698	=item Project Coordinator	1703	=item Project Coordinator
1699		1704
1700	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1705	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1701		1706
1702	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1707	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1703		1708
1704	=back	1709	=back
1705		1710
…		…
1709		1714
1710	=item John Bovey	1715	=item John Bovey
1711		1716
1712	University of Kent, 1992, wrote the original Xvt.	1717	University of Kent, 1992, wrote the original Xvt.
1713		1718
1714	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1719	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1715		1720
1716	very heavily modified Xvt and came up with Rxvt	1721	very heavily modified Xvt and came up with Rxvt
1717		1722
1718	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1723	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1719		1724
1720	wrote the Greek Keyboard Input (no longer in code)	1725	wrote the Greek Keyboard Input (no longer in code)
1721		1726
1722	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1727	=item mj olesen <olesen@me.QueensU.CA>
1723		1728
1724	Wrote the menu system.	1729	Wrote the menu system.
1725		1730
1726	Project Coordinator (changes.txt 2.11 to 2.21)	1731	Project Coordinator (changes.txt 2.11 to 2.21)
1727		1732
1728	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1733	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1729		1734
1730	Project Coordinator (changes.txt 2.21a to 2.4.5)	1735	Project Coordinator (changes.txt 2.21a to 2.4.5)
1731		1736
1732	=item Geoff Wing L<< <gcw@pobox.com> >>	1737	=item Geoff Wing <gcw@pobox.com>
1733		1738
1734	Rewrote screen display and text selection routines.	1739	Rewrote screen display and text selection routines.
1735		1740
1736	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1741	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1737		1742
1738	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1743	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1739		1744
1740	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1745	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1741	extension, random hacks, numerous bugfixes and extensions.	1746	extension, random hacks, numerous bugfixes and extensions.
1742		1747
1743	Project Coordinator (Changes 1.0 -)	1748	Project Coordinator (Changes 1.0 -)
1744		1749
1745	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1750	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1746		1751
1747	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1752	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1748		1753
1749	=back	1754	=back
1750		1755

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.205 by sf-exg, Fri Nov 18 02:15:22 2011 UTC vs. Revision 1.247 by sf-exg, Thu Jul 14 05:33:25 2016 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.205 by sf-exg, Fri Nov 18 02:15:22 2011 UTC vs.
Revision 1.247 by sf-exg, Thu Jul 14 05:33:25 2016 UTC