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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 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<-blr> I<HxV>
156
157	Apply Gaussian Blur with the specified radii to the transparent
158	background. If a single number is specified, the vertical and
159	horizontal radii are considered to be the same. Setting one of the
160	radii to 1 and the other to a large number creates interesting effects
161	on some backgrounds. The maximum radius value is 128. An horizontal or
162	vertical radius of 0 disables blurring;
163	resource I<blurRadius>.
164
165	=item B<-icon> I<file>	144	=item B<-icon> I<file>
166		145
167	Compile I<pixbuf>: Use the specified image as application icon. This	146	Compile I<pixbuf>: Use the specified image as application icon. This
168	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
169	application window; resource I<iconFile>.	148	application window; resource I<iconFile>.
…		…
173	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
174		153
175	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
176		155
177	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
178
179	=item B<-pixmap> I<file[;oplist]>
180
181	Compile I<pixbuf>: Specify image file for the background and also
182	optionally specify a list of operations to modify it. Note you may need to
183	add quotes to avoid special shell interpretation of the C<;> in the
184	command-line; for more details see resource B<backgroundPixmap>.
185		157
186	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
187		159
188	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
189		161
…		…
248		220
249	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
250		222
251	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
252		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
253	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
254		230
255	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
256	B<utmpInhibit>.	232	B<utmpInhibit>.
257		233
…		…
335		311
336	=item B<-override-redirect>	312	=item B<-override-redirect>
337		313
338	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
339	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.
340		321
341	=item B<-sbg>	322	=item B<-sbg>
342		323
343	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
344	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
…		…
399	=item B<-pt> I<style>	380	=item B<-pt> I<style>
400		381
401	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
402	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
403		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.
		387
404	=item B<-im> I<text>	388	=item B<-im> I<text>
405		389
406	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
407		391
408	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
422	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
423	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
424	in-use. Instead of selecting a full line it will extend the selection to	408	in-use. Instead of selecting a full line it will extend the selection to
425	the end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
426		410
		411	=item B<-dpb>\|B<+dpb>
		412
		413	Compile frills: Disable (or enable) emitting bracketed paste mode
		414	sequences (default enabled). Bracketed paste mode allows programs
		415	to detect when something is pasted. Since more and more programs
		416	abuse this, these sequences can be disabled. The command sequences to
		417	enable and query paste mode will still work, but the actual bracket
		418	sequences will no longer be emitted. You can also toggle this from the
		419	ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
		420
427	=item B<-insecure>	421	=item B<-insecure>
428		422
429	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
430	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
431	info.	425	info.
…		…
443		437
444	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
445		439
446	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
447	B<secondaryScroll>.	441	B<secondaryScroll>.
		442
		443	=item B<-rm> I<mode>
		444
		445	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		446	to one of B<auto> (the default), B<always> or B<never>. The latter two
		447	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		448	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		449	B<rewrapMode>.
448		450
449	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
450		452
451	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	453	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
452	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
…		…
678		680
679	B<False>: specify that everything is to be displayed, even	681	B<False>: specify that everything is to be displayed, even
680	if the refresh is too fast for the human eye to read anything (or the	682	if the refresh is too fast for the human eye to read anything (or the
681	monitor to display anything); option B<+ss>.	683	monitor to display anything); option B<+ss>.
682		684
683	=item B<transparent:> I<boolean>
684
685	Turn on/off pseudo-transparency by using the root pixmap as background.
686
687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688	future versions.
689
690	=item B<fading:> I<number>	685	=item B<fading:> I<number>
691		686
692	Fade the text by the given percentage when focus is lost; option B<-fade>.	687	Fade the text by the given percentage when focus is lost; option B<-fade>.
693		688
694	=item B<fadeColor:> I<colour>	689	=item B<fadeColor:> I<colour>
695		690
696	Fade to this colour, when fading is used (see B<fading:>). The default	691	Fade to this colour, when fading is used (see B<fading:>). The default
697	colour is black; option B<-fadecolor>.	692	colour is black; option B<-fadecolor>.
698		693
699	=item B<tintColor:> I<colour>
700
701	Tint the transparent background with the given colour. If the RENDER
702	extension is not available only black, red, green, yellow, blue,
703	magenta, cyan and white tints can be performed server-side. Note that
704	a black tint yields a completely black image while a white tint yields
705	the image unchanged; option B<-tint>.
706
707	=item B<shading:> I<number>
708
709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
710	A value of 100 means no shading; option B<-sh>.
711
712	=item B<blendType:> I<string>
713
714	Specify background blending type; option B<-blt>.
715
716	=item B<blurRadius:> I<number>
717
718	Apply gaussian blur with the specified radius to the transparent
719	background; option B<-blr>.
720
721	=item B<iconFile:> I<file>	694	=item B<iconFile:> I<file>
722		695
723	Set the application icon pixmap; option B<-icon>.	696	Set the application icon pixmap; option B<-icon>.
724		697
725	=item B<scrollColor:> I<colour>	698	=item B<scrollColor:> I<colour>
…		…
733		706
734	=item B<borderColor:> I<colour>	707	=item B<borderColor:> I<colour>
735		708
736	The colour of the border around the text area and between the scrollbar	709	The colour of the border around the text area and between the scrollbar
737	and the text.	710	and the text.
738
739	=item B<backgroundPixmap:> I<file[;oplist]>
740
741	Use the specified image file for the background and also
742	optionally specify a colon separated list of operations to modify it.
743	Supported operations are:
744
745	=over 4
746
747	=item B<WxH+X+Y>
748
749	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
750	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
751	scale of 0 disables scaling. The maximum permitted scale is 1000.
752
753	=item B<op=tile>
754
755	enables tiling
756
757	=item B<op=keep-aspect>
758
759	maintain the image aspect ratio when scaling
760
761	=item B<op=root-align>
762
763	use the position of the terminal window relative to the root window as
764	the image offset, simulating a root window background
765
766	=back
767
768	The default scale and position setting is C<100x100+50+50>.
769	Alternatively, a predefined set of templates can be used to achieve
770	the most common setups:
771
772	=over 4
773
774	=item B<style=tiled>
775
776	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
777
778	=item B<style=aspect-stretched>
779
780	the image is scaled to fill the whole window maintaining the aspect
781	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
782
783	=item B<style=stretched>
784
785	the image is scaled to fill the whole window. Equivalent to 100x100
786
787	=item B<style=centered>
788
789	the image is centered with no scaling. Equivalent to 0x0+50+50
790
791	=item B<style=root-tiled>
792
793	the image is tiled with no scaling and using 'root' positioning.
794	Equivalent to 0x0:op=tile:op=root-align
795
796	=back
797
798	If multiple templates are specified the last one wins. Note that a
799	template overrides all the scale, position and operations settings.
800
801	If used in conjunction with B<-tr> option, the specified pixmap will be
802	blended over the transparent background using alpha-blending.
803
804	=item B<path:> I<path>
805
806	Specify the colon-delimited search path for finding background image files.
807		711
808	=item B<font:> I<fontlist>	712	=item B<font:> I<fontlist>
809		713
810	Select the fonts to be used. This is a comma separated list of font names	714	Select the fonts to be used. This is a comma separated list of font names
811	that are checked in order when trying to find glyphs for characters. The	715	that are checked in order when trying to find glyphs for characters. The
…		…
908		812
909	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	813	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
910	the shell; option B<-ls>. B<False>: start as a normal sub-shell	814	the shell; option B<-ls>. B<False>: start as a normal sub-shell
911	[default]; option B<+ls>.	815	[default]; option B<+ls>.
912		816
		817	=item B<multiClickTime:> I<number>
		818
		819	Specify the maximum time in milliseconds between multi-click select
		820	events. The default is 500 milliseconds; option B<-mc>.
		821
913	=item B<utmpInhibit:> I<boolean>	822	=item B<utmpInhibit:> I<boolean>
914		823
915	B<True>: inhibit writing record into the system log file B<utmp>;	824	B<True>: inhibit writing record into the system log file B<utmp>;
916	option B<-ut>. B<False>: write record into the system log file B<utmp>	825	option B<-ut>. B<False>: write record into the system log file B<utmp>
917	[default]; option B<+ut>.	826	[default]; option B<+ut>.
…		…
980	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	889	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
981	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
982		891
983	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
984		893
985	Save I<number> lines in the scrollback buffer [default 64]. This	894	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
986	resource is limited on most machines to 65535; option B<-sl>.
987		895
988	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
989		897
990	Internal border of I<number> pixels. This resource is limited to 100;	898	Internal border of I<number> pixels. This resource is limited to 100;
991	option B<-b>.	899	option B<-b>.
…		…
1054		962
1055	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
1056		964
1057	Mouse pointer background colour.	965	Mouse pointer background colour.
1058		966
		967	=item B<pointerShape:> I<string>
		968
		969	Compile I<frills>: Specifies the name of the mouse pointer shape
		970	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		971	file for possible values (omit the C<XC_> prefix).
		972
1059	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
1060		974
1061	Specifies number of seconds before blanking the pointer [default 2]. Use a	975	Specifies number of seconds before blanking the pointer [default 2]. Use a
1062	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
1063		977
…		…
1089		1003
1090	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1004	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1091		1005
1092	=item B<preeditType:> I<style>	1006	=item B<preeditType:> I<style>
1093		1007
1094	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1008	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1095		1009
1096	=item B<inputMethod:> I<name>	1010	=item B<inputMethod:> I<name>
1097		1011
1098	I<name> of inputMethod to use; option B<-im>.	1012	I<name> of inputMethod to use; option B<-im>.
1099		1013
…		…
1117		1031
1118	Change the meaning of triple-click selection with the left mouse	1032	Change the meaning of triple-click selection with the left mouse
1119	button. Instead of selecting a full line it will extend the selection to	1033	button. Instead of selecting a full line it will extend the selection to
1120	the end of the logical line only; option B<-tcw>.	1034	the end of the logical line only; option B<-tcw>.
1121		1035
		1036	=item B<disablePasteBrackets:> I<boolean>
		1037
		1038	Prevent emission of paste bracket sequences; option B<-dpb>.
		1039
1122	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
1123		1041
1124	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1125	echo arbitrary strings like the icon name or the locale. This could be	1043	echo arbitrary strings like the icon name or the locale. This could be
1126	abused if somebody gets 8-bit-clean access to your display, whether	1044	abused if somebody gets 8-bit-clean access to your display, whether
1127	through a mail client displaying mail bodies unfiltered or through	1045	through a mail client displaying mail bodies unfiltered or through
1128	write(1) or any other means. Therefore, these sequences are disabled by	1046	write(1) or any other means. Therefore, these sequences are disabled by
1129	default. (Note that many other terminals, including xterm, have these	1047	default. (Note that many other terminals, including xterm, have these
…		…
1147		1065
1148	=item B<secondaryScreen:> I<boolean>	1066	=item B<secondaryScreen:> I<boolean>
1149		1067
1150	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
1151		1069
		1070	=item B<rewrapMode:> I<mode>
		1071
		1072	Sets long line rewrap behaviour on window resize to one of B<auto>
		1073	(default), B<always> or B<never>.
		1074
1152	=item B<secondaryScroll:> I<boolean>	1075	=item B<secondaryScroll:> I<boolean>
1153		1076
1154	Turn on/off secondary screen scroll (default enabled). If this	1077	Turn on/off secondary screen scroll (default enabled). If this
1155	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
1156	scrollback buffer and, when secondaryScreen is off, switching	1079	scrollback buffer and, when secondaryScreen is off, switching
…		…
1168	Sets the working directory for the shell (or the command specified via	1091	Sets the working directory for the shell (or the command specified via
1169	B<-e>). The I<path> must be an absolute path and it must exist for	1092	B<-e>). The I<path> must be an absolute path and it must exist for
1170	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1093	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1171	directory will be used; option B<-cd>.	1094	directory will be used; option B<-cd>.
1172		1095
1173	=item B<keysym.>I<sym>: I<string>	1096	=item B<keysym.>I<sym>: I<action>
1174		1097
1175	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1098	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1176	intervening resource name B<keysym.> cannot be omitted.	1099	resource name B<keysym.> cannot be omitted.
1177		1100
1178	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1101	Using this resource, you can map key combinations such as
1179	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1102	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1180	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1103	string than would normally result from that combination, making the
1181	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1104	terminal scroll up or down the way you want it, or any other thing an
1182	B<2>, B<3>, B<4>, B<5>.	1105	extension might provide.
		1106
		1107	The key combination that triggers the action, I<sym>, has the following format:
		1108
		1109	(modifiers-)key
		1110
		1111	Where I<modifiers> can be any combination of the following full or
		1112	abbreviated modifier names:
		1113
		1114	=begin table
		1115
		1116	B<ISOLevel3> B<I>
		1117	B<AppKeypad> B<K>
		1118	B<Control> B<C>
		1119	B<NumLock> B<N>
		1120	B<Shift> B<S>
		1121	B<Meta> B<M> I<or> B<A>
		1122	B<Lock> B<L>
		1123	B<Mod1> B<1>
		1124	B<Mod2> B<2>
		1125	B<Mod3> B<3>
		1126	B<Mod4> B<4>
		1127	B<Mod5> B<5>
		1128
		1129	=end table
1183		1130
1184	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1131	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1185	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1132	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1186	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1133	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1187	current application keymap mode state.	1134	current application keymap mode state.
1188		1135
1189	The spellings of I<key> can be obtained by using B<xev>(1) command or	1136	Due the the large number of modifier combinations, a key mapping will
1190	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1137	match if I<at least> the specified identifiers are being set, and no other
		1138	key mappings with those and more bits are being defined. That means that
		1139	defining a mapping for C<a> will automatically provide definitions for
		1140	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1141	themselves. See the C<builtin:> action, below, for a way to work around
		1142	this when this is a problem.
		1143
		1144	The spelling of I<key> depends on your implementation of X. An easy way to
		1145	find a key name is to use the B<xev>(1) command. You can find a list by
		1146	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1191	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1147	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1192	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1148	value (B<0x0000 - 0xFFFF>).
1193	performed in an exact manner; however, the closest match is assured.
1194		1149
1195	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1150	As with any resource value, the I<action> string may contain backslash
		1151	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1196	number), see RESOURCES in C<man 7 X> for further details.	1152	number), see RESOURCES in C<man 7 X> for further details.
1197		1153
1198	You can define a range of keysyms in one shot by	1154	An action starts with an action prefix that selects a certain type
1199	loading the C<keysym-list> perl extension and providing a I<string>	1155	of action, followed by a colon. An action string without colons is
1200	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1156	interpreted as a literal string to pass to the tty (as if it was
		1157	prefixed with C<string:>).
		1158
		1159	The following action prefixes are known - extensions can provide
		1160	additional prefixes:
		1161
		1162	=over 4
		1163
		1164	=item string:STRING
		1165
		1166	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1167	then the remaining C<STRING> will be passed to the program running in the
		1168	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1169	string C<echo rm -rf /> followed by a newline:
		1170
		1171	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1172
		1173	This could in theory be used to completely redefine your keymap.
		1174
		1175	In addition, for actions of this type, you can define a range of
		1176	keysyms in one shot by loading the C<keysym-list> perl extension and
		1177	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1201	should be a character not used by the strings.	1178	the delimiter `/' should be a character not used by the strings.
1202		1179
1203	Its usage can be demonstrated by an example:	1180	Its usage can be demonstrated by an example:
1204		1181
1205	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1182	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1206		1183
1207	The above line is equivalent to the following three lines:	1184	The above line is equivalent to the following three lines:
1208		1185
1209	URxvt.keysym.Meta-Control-0x61: \033<a>	1186	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1210	URxvt.keysym.Meta-Control-0x62: \033<b>	1187	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1211	URxvt.keysym.Meta-Control-0x63: \033<c>	1188	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1212		1189
		1190	=item command:STRING
		1191
1213	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1192	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1214	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1193	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1194	the opposite of C<string:> - instead of sending it to the program running
		1195	in the terminal, it will be treated as if it were program output). This is
		1196	most useful to feed command sequences into @@RXVT_NAME@@.
		1197
1215	example the following means "change the current locale to C<zh_CN.GBK>	1198	For example the following means "change the current locale to C<zh_CN.GBK>
1216	when Control-Meta-c is being pressed":	1199	when Control-Meta-c is being pressed":
1217		1200
1218	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1201	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1219		1202
1220	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1203	The following example will map Control-Meta-1 and Control-Meta-2 to
1221	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1204	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1222	manpage. For example, the F<selection> extension (activated via	1205	font-switching at runtime:
1223	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1224		1206
1225	URxvt.keysym.M-C-c: perl:selection:rot13	1207	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1208	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1226		1209
1227	Due the the large number of modifier combinations, a defined key mapping	1210	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1228	will match if I<at least> the specified identifiers are being set, and	1211	info):
1229	no other key mappings with those and more bits are being defined. That
1230	means that defining a key map for C<a> will automatically provide
1231	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1232	mappings themselves.
1233		1212
1234	Unfortunately, this will override built-in key mappings. For example	1213	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1214	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1215
		1216	=item builtin:
		1217
		1218	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1219	key binding existed for the key combination. The obvious use is to undo
		1220	the effect of existing bindings. The not so obvious use is to reinstate
		1221	bindings when another binding overrides too many modifiers.
		1222
1235	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1223	For example if you overwrite the C<Insert> key you will disable
1236	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1224	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1237	user-defined keymap using the C<builtin:> replacement:	1225	"holes" into the user-defined keymap using the C<builtin:> replacement:
1238		1226
1239	URxvt.keysym.Insert: <my insert key sequence>	1227	URxvt.keysym.Insert: <my insert key sequence>
1240	URxvt.keysym.S-Insert: builtin:	1228	URxvt.keysym.S-Insert: builtin:
1241		1229
1242	The first line defines a mapping for C<Insert> and I<any> combination	1230	The first line defines a mapping for C<Insert> and I<any> combination
1243	of modifiers. The second line re-establishes the default mapping for	1231	of modifiers. The second line re-establishes the default mapping for
1244	C<Shift-Insert>.	1232	C<Shift-Insert>.
1245		1233
1246	The following example will map Control-Meta-1 and Control-Meta-2 to	1234	=item builtin-string:
1247	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1248	font-switching at runtime:
1249		1235
1250	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1236	This action is mainly useful to restore string mappings for keys that
1251	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1237	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1238	difficult to explain - basically, this action will send the string to the
		1239	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1240	action for it.
1252		1241
1253	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1242	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1254	info):	1243	selection when you press C<Shift-Insert>. With the following bindings, it
		1244	would instead emit the (undocumented, but what applications running in the
		1245	terminal might expect) sequence C<ESC [ 2 $> instead:
1255		1246
1256	URxvt.keysym.M-C-3: command:\033[8;25;80t	1247	URxvt.keysym.S-Insert: builtin-string:
1257	URxvt.keysym.M-C-4: command:\033[8;48;110t	1248	URxvt.keysym.C-S-Insert: builtin:
		1249
		1250	The first line disables the paste functionality for that key
		1251	combination, and the second reinstates the default behaviour for
		1252	C<Control-Shift-Insert>, which would otherwise be overridden.
		1253
		1254	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1255	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1256	this:
		1257
		1258	URxvt.keysym.C-M-c: builtin-string:
		1259	URxvt.keysym.C-M-v: builtin-string:
		1260
		1261	=item EXTENSION:STRING
		1262
		1263	An action of this form invokes the action B<STRING>, if any, provided
		1264	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1265	be loaded automatically if necessary.
		1266
		1267	Not all extensions define actions, but popular extensions that do
		1268	include the I<selection> and I<matcher> extensions (documented in their
		1269	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1270	respectively).
		1271
		1272	From the silly examples department, this will rot13-"encrypt"
		1273	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1274	keyboards:
		1275
		1276	URxvt.keysym.M-C-c: selection:rot13
		1277
		1278	=item perl:STRING DEPRECATED
		1279
		1280	This is a deprecated way of invoking commands provided by perl
		1281	extensions. It is still supported, but should not be used anymore.
		1282
		1283	=back
1258		1284
1259	=item B<perl-ext-common>: I<string>	1285	=item B<perl-ext-common>: I<string>
1260		1286
1261	=item B<perl-ext>: I<string>	1287	=item B<perl-ext>: I<string>
1262		1288
…		…
1264	use in this terminal instance; option B<-pe>.	1290	use in this terminal instance; option B<-pe>.
1265		1291
1266	Extension names can be prefixed with a C<-> sign to prohibit using	1292	Extension names can be prefixed with a C<-> sign to prohibit using
1267	them. This can be useful to selectively disable some extensions loaded	1293	them. This can be useful to selectively disable some extensions loaded
1268	by default, or specified via the C<perl-ext-common> resource. For	1294	by default, or specified via the C<perl-ext-common> resource. For
1269	example, C<default,-selection> will use all the default extension except	1295	example, C<default,-selection> will use all the default extensions except
1270	C<selection>.	1296	C<selection>.
1271		1297
1272	Extension names can also be followed by an argument in angle brackets	1298	The default set includes the C<selection>, C<option-popup>,
1273	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1299	C<selection-popup>, C<readline> and C<searchable-scrollback>
1274	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1300	extensions, and extensions which are mentioned in B<keysym> resources.
1275	multiple times with different arguments will pass multiple arguments to	1301
1276	the extension.	1302	Any extension such that a corresponding resource is given on the
		1303	command line is automatically appended to B<perl-ext>.
1277		1304
1278	Each extension is looked up in the library directories, loaded if	1305	Each extension is looked up in the library directories, loaded if
1279	necessary, and bound to the current terminal instance.	1306	necessary, and bound to the current terminal instance. When the library
		1307	search path contains multiple extension files of the same name, then the
		1308	first one found will be used.
1280		1309
1281	If both of these resources are the empty string, then the perl	1310	If both of these resources are the empty string, then the perl interpreter
1282	interpreter will not be initialized. The idea behind two options is that	1311	will not be initialized. The rationale for having two options is that
1283	B<perl-ext-common> will be used for extensions that should be available to	1312	B<perl-ext-common> will be used for extensions that should be available to
1284	all instances, while B<perl-ext> is used for specific instances.	1313	all instances, while B<perl-ext> is used for specific instances.
1285		1314
1286	=item B<perl-eval>: I<string>	1315	=item B<perl-eval>: I<string>
1287		1316
…		…
1289	the @@RXVT_NAME@@perl(3) manpage.	1318	the @@RXVT_NAME@@perl(3) manpage.
1290		1319
1291	=item B<perl-lib>: I<path>	1320	=item B<perl-lib>: I<path>
1292		1321
1293	Colon-separated list of additional directories that hold extension	1322	Colon-separated list of additional directories that hold extension
1294	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first	1323	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1295	look in these directories, then in $HOME/.urxvt/ext and lastly in	1324	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1296	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1325	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1297		1326
1298	See the @@RXVT_NAME@@perl(3) manpage.	1327	See the @@RXVT_NAME@@perl(3) manpage.
1299		1328
1300	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1329	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1301		1330
…		…
1305	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1334	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1306		1335
1307	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1336	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1308	for details.	1337	for details.
1309		1338
1310	=item B<searchable-scrollback:> I<keysym>	1339	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1311		1340
1312	Sets the hotkey that starts the incremental scrollback buffer search	1341	This resource is deprecated and will be removed. Use a B<keysym> resource
1313	(default: C<M-s>).	1342	instead, e.g.:
1314		1343
		1344	URxvt.keysym.M-s: searchable-scrollback:start
		1345
1315	=item B<urlLauncher>: I<string>	1346	=item B<url-launcher>: I<string>
1316		1347
1317	Specifies the program to be started with a URL argument. Used by the	1348	Specifies the program to be started with a URL argument. Used by the
1318	C<selection-popup> and C<matcher> perl extensions.	1349	C<selection-popup> and C<matcher> perl extensions.
1319		1350
1320	=item B<transient-for>: I<windowid>	1351	=item B<transient-for>: I<windowid>
…		…
1388	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1419	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1389	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1420	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1390		1421
1391	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1422	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1392	inserted too.	1423	inserted too.
		1424
		1425	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1426	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1427	binding causes the value of the internal selection to be copied to the
		1428	CLIPBOARD selection, while the second binding causes the value of the
		1429	CLIPBOARD selection to be inserted.
1393		1430
1394	=back	1431	=back
1395		1432
1396	=head1 CHANGING FONTS	1433	=head1 CHANGING FONTS
1397		1434
…		…
1486	In addition to the default foreground and background colours,	1523	In addition to the default foreground and background colours,
1487	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1524	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1488	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1525	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1489	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1526	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1490	cube plus a 8 (24) colour greyscale ramp.	1527	cube plus a 8 (24) colour greyscale ramp.
		1528
		1529	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1530	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1531	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1532	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1533	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1534	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1535	use many similar 24-bit colours. It's typically not a problem in common
		1536	scenarios.
1491		1537
1492	Here is a list of the ANSI colours with their names.	1538	Here is a list of the ANSI colours with their names.
1493		1539
1494	=begin table	1540	=begin table
1495		1541
…		…
1522	The following text gives values for the standard 88 colour mode (and	1568	The following text gives values for the standard 88 colour mode (and
1523	values for the 256 colour mode in parentheses).	1569	values for the 256 colour mode in parentheses).
1524		1570
1525	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1571	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1526		1572
1527	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1573	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1528	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1574	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1529		1575
1530	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1576	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1531	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1577	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1532	the RGB cube.	1578	the RGB cube.
1533		1579
…		…
1641		1687
1642	=item B<SHELL>	1688	=item B<SHELL>
1643		1689
1644	The shell to be used for command execution, defaults to C</bin/sh>.	1690	The shell to be used for command execution, defaults to C</bin/sh>.
1645		1691
1646	=item B<RXVT_SOCKET>	1692	=item B<RXVT_SOCKET> [I<sic>]
1647		1693
1648	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1694	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1649	@@RXVT_NAME@@d(1).	1695	@@RXVT_NAME@@d(1).
1650		1696
1651	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.	1697	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1698
		1699	=item B<URXVT_PERL_LIB>
		1700
		1701	Additional F<:>-separated library search path for perl extensions. Will be
		1702	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1703	directory.
		1704
		1705	=item B<URXVT_PERL_VERBOSITY>
		1706
		1707	See L<@@RXVT_NAME@@perl>(3).
1652		1708
1653	=item B<HOME>	1709	=item B<HOME>
1654		1710
1655	Used to locate the default directory for the unix domain socket for	1711	Used to locate the default directory for the unix domain socket for
1656	daemon communications and to locate various resource files (such as	1712	daemon communications and to locate various resource files (such as
…		…
1677		1733
1678	=back	1734	=back
1679		1735
1680	=head1 SEE ALSO	1736	=head1 SEE ALSO
1681		1737
		1738	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1682	@@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)	1739	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1683		1740
1684	=head1 CURRENT PROJECT COORDINATOR	1741	=head1 CURRENT PROJECT COORDINATOR
1685		1742
1686	=over 4	1743	=over 4
1687		1744
1688	=item Project Coordinator	1745	=item Project Coordinator
1689		1746
1690	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1747	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1691		1748
1692	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1749	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1693		1750
1694	=back	1751	=back
1695		1752
…		…
1699		1756
1700	=item John Bovey	1757	=item John Bovey
1701		1758
1702	University of Kent, 1992, wrote the original Xvt.	1759	University of Kent, 1992, wrote the original Xvt.
1703		1760
1704	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1761	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1705		1762
1706	very heavily modified Xvt and came up with Rxvt	1763	very heavily modified Xvt and came up with Rxvt
1707		1764
1708	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1765	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1709		1766
1710	wrote the Greek Keyboard Input (no longer in code)	1767	wrote the Greek Keyboard Input (no longer in code)
1711		1768
1712	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1769	=item mj olesen <olesen@me.QueensU.CA>
1713		1770
1714	Wrote the menu system.	1771	Wrote the menu system.
1715		1772
1716	Project Coordinator (changes.txt 2.11 to 2.21)	1773	Project Coordinator (changes.txt 2.11 to 2.21)
1717		1774
1718	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1775	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1719		1776
1720	Project Coordinator (changes.txt 2.21a to 2.4.5)	1777	Project Coordinator (changes.txt 2.21a to 2.4.5)
1721		1778
1722	=item Geoff Wing L<< <gcw@pobox.com> >>	1779	=item Geoff Wing <gcw@pobox.com>
1723		1780
1724	Rewrote screen display and text selection routines.	1781	Rewrote screen display and text selection routines.
1725		1782
1726	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1783	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1727		1784
1728	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1785	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1729		1786
1730	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1787	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1731	extension, random hacks, numerous bugfixes and extensions.	1788	extension, random hacks, numerous bugfixes and extensions.
1732		1789
1733	Project Coordinator (Changes 1.0 -)	1790	Project Coordinator (Changes 1.0 -)
1734		1791
1735	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1792	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1736		1793
1737	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1794	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1738		1795
1739	=back	1796	=back
1740		1797

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC vs. Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC