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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC

…		…
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>	111	=item B<-visual> I<visualID>
112		112
113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible	113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114	visual ids).	114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
115		116
116	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
117		118
118	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
119		120
…		…
126	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>.
127		128
128	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
129		130
130	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>.
131
132	=item B<-tr>\|B<+tr>
133
134	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
135
136	B<-ip> is still accepted as an obsolete alias but will be removed in
137	future versions.
138		132
139	=item B<-fade> I<number>	133	=item B<-fade> I<number>
140		134
141	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
142	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
…		…
145	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
146		140
147	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
148	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
149		143
150	=item B<-tint> I<colour>
151
152	Tint the transparent background with the given colour;
153	resource I<tintColor>.
154
155	=item B<-sh> I<number>
156
157	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
158	A value of 100 means no shading; resource I<shading>.
159
160	=item B<-blr> I<HxV>
161
162	Apply Gaussian Blur with the specified radii to the transparent
163	background. If a single number is specified, the vertical and
164	horizontal radii are considered to be the same. Setting one of the
165	radii to 1 and the other to a large number creates interesting effects
166	on some backgrounds. The maximum radius value is 128. An horizontal or
167	vertical radius of 0 disables blurring;
168	resource I<blurRadius>.
169
170	=item B<-icon> I<file>	144	=item B<-icon> I<file>
171		145
172	Compile I<pixbuf>: Use the specified image as application icon. This	146	Compile I<pixbuf>: Use the specified image as application icon. This
173	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
174	application window; resource I<iconFile>.	148	application window; resource I<iconFile>.
…		…
178	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
179		153
180	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
181		155
182	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
183
184	=item B<-pixmap> I<file[;oplist]>
185
186	Compile I<pixbuf>: Specify image file for the background and also
187	optionally specify a list of operations to modify it. Note you may need to
188	add quotes to avoid special shell interpretation of the C<;> in the
189	command-line; for more details see resource B<backgroundPixmap>.
190		157
191	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
192		159
193	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
194		161
…		…
253		220
254	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
255		222
256	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
257		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
258	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
259		230
260	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
261	B<utmpInhibit>.	232	B<utmpInhibit>.
262		233
…		…
340		311
341	=item B<-override-redirect>	312	=item B<-override-redirect>
342		313
343	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
344	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.
345		321
346	=item B<-sbg>	322	=item B<-sbg>
347		323
348	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
349	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
…		…
404	=item B<-pt> I<style>	380	=item B<-pt> I<style>
405		381
406	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
407	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
408		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
409	=item B<-im> I<text>	388	=item B<-im> I<text>
410		389
411	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
412		391
413	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
427	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
428	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
429	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
430	the end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
431		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
432	=item B<-insecure>	421	=item B<-insecure>
433		422
434	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
435	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
436	info.	425	info.
…		…
448		437
449	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
450		439
451	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
452	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>.
453		450
454	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
455		452
456	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@@
457	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
…		…
683		680
684	B<False>: specify that everything is to be displayed, even	681	B<False>: specify that everything is to be displayed, even
685	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
686	monitor to display anything); option B<+ss>.	683	monitor to display anything); option B<+ss>.
687		684
688	=item B<transparent:> I<boolean>
689
690	Turn on/off pseudo-transparency by using the root pixmap as background.
691
692	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
693	future versions.
694
695	=item B<fading:> I<number>	685	=item B<fading:> I<number>
696		686
697	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>.
698		688
699	=item B<fadeColor:> I<colour>	689	=item B<fadeColor:> I<colour>
700		690
701	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
702	colour is black; option B<-fadecolor>.	692	colour is black; option B<-fadecolor>.
703		693
704	=item B<tintColor:> I<colour>
705
706	Tint the transparent background with the given colour. If the RENDER
707	extension is not available only black, red, green, yellow, blue,
708	magenta, cyan and white tints can be performed server-side. Note that
709	a black tint yields a completely black image while a white tint yields
710	the image unchanged; option B<-tint>.
711
712	=item B<shading:> I<number>
713
714	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
715	A value of 100 means no shading; option B<-sh>.
716
717	=item B<blurRadius:> I<number>
718
719	Apply gaussian blur with the specified radius to the transparent
720	background; option B<-blr>.
721
722	=item B<iconFile:> I<file>	694	=item B<iconFile:> I<file>
723		695
724	Set the application icon pixmap; option B<-icon>.	696	Set the application icon pixmap; option B<-icon>.
725		697
726	=item B<scrollColor:> I<colour>	698	=item B<scrollColor:> I<colour>
…		…
734		706
735	=item B<borderColor:> I<colour>	707	=item B<borderColor:> I<colour>
736		708
737	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
738	and the text.	710	and the text.
739
740	=item B<backgroundPixmap:> I<file[;oplist]>
741
742	Use the specified image file for the background and also
743	optionally specify a colon separated list of operations to modify it.
744	Supported operations are:
745
746	=over 4
747
748	=item B<WxH+X+Y>
749
750	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
751	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
752	scale of 0 disables scaling.
753
754	=item B<op=tile>
755
756	enables tiling
757
758	=item B<op=keep-aspect>
759
760	maintain the image aspect ratio when scaling
761
762	=item B<op=root-align>
763
764	use the position of the terminal window relative to the root window as
765	the image offset, simulating a root window background
766
767	=back
768
769	The default scale and position setting is C<100x100+50+50>.
770	Alternatively, a predefined set of templates can be used to achieve
771	the most common setups:
772
773	=over 4
774
775	=item B<style=tiled>
776
777	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
778
779	=item B<style=aspect-stretched>
780
781	the image is scaled to fill the whole window maintaining the aspect
782	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
783
784	=item B<style=stretched>
785
786	the image is scaled to fill the whole window. Equivalent to 100x100
787
788	=item B<style=centered>
789
790	the image is centered with no scaling. Equivalent to 0x0+50+50
791
792	=item B<style=root-tiled>
793
794	the image is tiled with no scaling and using 'root' positioning.
795	Equivalent to 0x0:op=tile:op=root-align
796
797	=back
798
799	If multiple templates are specified the last one wins. Note that a
800	template overrides all the scale, position and operations settings.
801
802	If used in conjunction with B<-tr> option, the specified pixmap will be
803	blended over the transparent background using alpha-blending.
804
805	=item B<path:> I<path>
806
807	Specify the colon-delimited search path for finding background image files.
808		711
809	=item B<font:> I<fontlist>	712	=item B<font:> I<fontlist>
810		713
811	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
812	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
…		…
909		812
910	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
911	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
912	[default]; option B<+ls>.	815	[default]; option B<+ls>.
913		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
914	=item B<utmpInhibit:> I<boolean>	822	=item B<utmpInhibit:> I<boolean>
915		823
916	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>;
917	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>
918	[default]; option B<+ut>.	826	[default]; option B<+ut>.
…		…
981	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
982	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
983		891
984	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
985		893
986	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>.
987	resource is limited on most machines to 65535; option B<-sl>.
988		895
989	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
990		897
991	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;
992	option B<-b>.	899	option B<-b>.
…		…
1055		962
1056	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
1057		964
1058	Mouse pointer background colour.	965	Mouse pointer background colour.
1059		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
1060	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
1061		974
1062	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
1063	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
1064		977
…		…
1090		1003
1091	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1004	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1092		1005
1093	=item B<preeditType:> I<style>	1006	=item B<preeditType:> I<style>
1094		1007
1095	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1008	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1096		1009
1097	=item B<inputMethod:> I<name>	1010	=item B<inputMethod:> I<name>
1098		1011
1099	I<name> of inputMethod to use; option B<-im>.	1012	I<name> of inputMethod to use; option B<-im>.
1100		1013
…		…
1118		1031
1119	Change the meaning of triple-click selection with the left mouse	1032	Change the meaning of triple-click selection with the left mouse
1120	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
1121	the end of the logical line only; option B<-tcw>.	1034	the end of the logical line only; option B<-tcw>.
1122		1035
		1036	=item B<disablePasteBrackets:> I<boolean>
		1037
		1038	Prevent emission of paste bracket sequences; option B<-dpb>.
		1039
1123	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
1124		1041
1125	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1126	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
1127	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
1128	through a mail client displaying mail bodies unfiltered or through	1045	through a mail client displaying mail bodies unfiltered or through
1129	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
1130	default. (Note that many other terminals, including xterm, have these	1047	default. (Note that many other terminals, including xterm, have these
…		…
1148		1065
1149	=item B<secondaryScreen:> I<boolean>	1066	=item B<secondaryScreen:> I<boolean>
1150		1067
1151	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
1152		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
1153	=item B<secondaryScroll:> I<boolean>	1075	=item B<secondaryScroll:> I<boolean>
1154		1076
1155	Turn on/off secondary screen scroll (default enabled). If this	1077	Turn on/off secondary screen scroll (default enabled). If this
1156	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
1157	scrollback buffer and, when secondaryScreen is off, switching	1079	scrollback buffer and, when secondaryScreen is off, switching
…		…
1169	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
1170	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
1171	@@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
1172	directory will be used; option B<-cd>.	1094	directory will be used; option B<-cd>.
1173		1095
1174	=item B<keysym.>I<sym>: I<string>	1096	=item B<keysym.>I<sym>: I<action>
1175		1097
1176	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1098	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1177	intervening resource name B<keysym.> cannot be omitted.	1099	resource name B<keysym.> cannot be omitted.
1178		1100
1179	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
1180	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1102	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1181	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
1182	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
1183	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
1184		1130
1185	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
1186	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
1187	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
1188	current application keymap mode state.	1134	current application keymap mode state.
1189		1135
1190	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
1191	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
1192	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
1193	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1148	value (B<0x0000 - 0xFFFF>).
1194	performed in an exact manner; however, the closest match is assured.
1195		1149
1196	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
1197	number), see RESOURCES in C<man 7 X> for further details.	1152	number), see RESOURCES in C<man 7 X> for further details.
1198		1153
1199	You can define a range of keysyms in one shot by	1154	An action starts with an action prefix that selects a certain type
1200	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
1201	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
1202	should be a character not used by the strings.	1178	the delimiter `/' should be a character not used by the strings.
1203		1179
1204	Its usage can be demonstrated by an example:	1180	Its usage can be demonstrated by an example:
1205		1181
1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1182	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1207		1183
1208	The above line is equivalent to the following three lines:	1184	The above line is equivalent to the following three lines:
1209		1185
1210	URxvt.keysym.Meta-Control-0x61: \033<a>	1186	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1211	URxvt.keysym.Meta-Control-0x62: \033<b>	1187	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1212	URxvt.keysym.Meta-Control-0x63: \033<c>	1188	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1213		1189
		1190	=item command:STRING
		1191
1214	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>
1215	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
1216	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>
1217	when Control-Meta-c is being pressed":	1199	when Control-Meta-c is being pressed":
1218		1200
1219	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
1220		1202
1221	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
1222	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
1223	manpage. For example, the F<selection> extension (activated via	1205	font-switching at runtime:
1224	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1225		1206
1226	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
1227		1209
1228	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
1229	will match if I<at least> the specified identifiers are being set, and	1211	info):
1230	no other key mappings with those and more bits are being defined. That
1231	means that defining a key map for C<a> will automatically provide
1232	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1233	mappings themselves.
1234		1212
1235	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
1236	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
1237	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
1238	user-defined keymap using the C<builtin:> replacement:	1225	"holes" into the user-defined keymap using the C<builtin:> replacement:
1239		1226
1240	URxvt.keysym.Insert: <my insert key sequence>	1227	URxvt.keysym.Insert: <my insert key sequence>
1241	URxvt.keysym.S-Insert: builtin:	1228	URxvt.keysym.S-Insert: builtin:
1242		1229
1243	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
1244	of modifiers. The second line re-establishes the default mapping for	1231	of modifiers. The second line re-establishes the default mapping for
1245	C<Shift-Insert>.	1232	C<Shift-Insert>.
1246		1233
1247	The following example will map Control-Meta-1 and Control-Meta-2 to	1234	=item builtin-string:
1248	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1249	font-switching at runtime:
1250		1235
1251	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1236	This action is mainly useful to restore string mappings for keys that
1252	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.
1253		1241
1254	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
1255	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:
1256		1246
1257	URxvt.keysym.M-C-3: command:\033[8;25;80t	1247	URxvt.keysym.S-Insert: builtin-string:
1258	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
1259		1284
1260	=item B<perl-ext-common>: I<string>	1285	=item B<perl-ext-common>: I<string>
1261		1286
1262	=item B<perl-ext>: I<string>	1287	=item B<perl-ext>: I<string>
1263		1288
…		…
1265	use in this terminal instance; option B<-pe>.	1290	use in this terminal instance; option B<-pe>.
1266		1291
1267	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
1268	them. This can be useful to selectively disable some extensions loaded	1293	them. This can be useful to selectively disable some extensions loaded
1269	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
1270	example, C<default,-selection> will use all the default extension except	1295	example, C<default,-selection> will use all the default extensions except
1271	C<selection>.	1296	C<selection>.
1272		1297
1273	Extension names can also be followed by an argument in angle brackets	1298	The default set includes the C<selection>, C<option-popup>,
1274	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1299	C<selection-popup>, C<readline> and C<searchable-scrollback>
1275	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1300	extensions, and extensions which are mentioned in B<keysym> resources.
1276	multiple times with different arguments will pass multiple arguments to	1301
1277	the extension.	1302	Any extension such that a corresponding resource is given on the
		1303	command line is automatically appended to B<perl-ext>.
1278		1304
1279	Each extension is looked up in the library directories, loaded if	1305	Each extension is looked up in the library directories, loaded if
1280	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.
1281		1309
1282	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
1283	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
1284	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
1285	all instances, while B<perl-ext> is used for specific instances.	1313	all instances, while B<perl-ext> is used for specific instances.
1286		1314
1287	=item B<perl-eval>: I<string>	1315	=item B<perl-eval>: I<string>
1288		1316
…		…
1306	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1334	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1307		1335
1308	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1336	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1309	for details.	1337	for details.
1310		1338
1311	=item B<searchable-scrollback:> I<keysym>	1339	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1312		1340
1313	Sets the hotkey that starts the incremental scrollback buffer search	1341	This resource is deprecated and will be removed. Use a B<keysym> resource
1314	(default: C<M-s>).	1342	instead, e.g.:
1315		1343
		1344	URxvt.keysym.M-s: searchable-scrollback:start
		1345
1316	=item B<urlLauncher>: I<string>	1346	=item B<url-launcher>: I<string>
1317		1347
1318	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
1319	C<selection-popup> and C<matcher> perl extensions.	1349	C<selection-popup> and C<matcher> perl extensions.
1320		1350
1321	=item B<transient-for>: I<windowid>	1351	=item B<transient-for>: I<windowid>
…		…
1389	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
1390	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.
1391		1421
1392	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
1393	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.
1394		1430
1395	=back	1431	=back
1396		1432
1397	=head1 CHANGING FONTS	1433	=head1 CHANGING FONTS
1398		1434
…		…
1487	In addition to the default foreground and background colours,	1523	In addition to the default foreground and background colours,
1488	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
1489	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
1490	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
1491	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.
1492		1537
1493	Here is a list of the ANSI colours with their names.	1538	Here is a list of the ANSI colours with their names.
1494		1539
1495	=begin table	1540	=begin table
1496		1541
…		…
1523	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
1524	values for the 256 colour mode in parentheses).	1569	values for the 256 colour mode in parentheses).
1525		1570
1526	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:
1527		1572
1528	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
1529	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
1530		1575
1531	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%
1532	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
1533	the RGB cube.	1578	the RGB cube.
1534		1579
…		…
1697		1742
1698	=over 4	1743	=over 4
1699		1744
1700	=item Project Coordinator	1745	=item Project Coordinator
1701		1746
1702	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1747	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1703		1748
1704	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1749	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1705		1750
1706	=back	1751	=back
1707		1752
…		…
1711		1756
1712	=item John Bovey	1757	=item John Bovey
1713		1758
1714	University of Kent, 1992, wrote the original Xvt.	1759	University of Kent, 1992, wrote the original Xvt.
1715		1760
1716	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1761	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1717		1762
1718	very heavily modified Xvt and came up with Rxvt	1763	very heavily modified Xvt and came up with Rxvt
1719		1764
1720	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1765	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1721		1766
1722	wrote the Greek Keyboard Input (no longer in code)	1767	wrote the Greek Keyboard Input (no longer in code)
1723		1768
1724	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1769	=item mj olesen <olesen@me.QueensU.CA>
1725		1770
1726	Wrote the menu system.	1771	Wrote the menu system.
1727		1772
1728	Project Coordinator (changes.txt 2.11 to 2.21)	1773	Project Coordinator (changes.txt 2.11 to 2.21)
1729		1774
1730	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1775	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1731		1776
1732	Project Coordinator (changes.txt 2.21a to 2.4.5)	1777	Project Coordinator (changes.txt 2.21a to 2.4.5)
1733		1778
1734	=item Geoff Wing L<< <gcw@pobox.com> >>	1779	=item Geoff Wing <gcw@pobox.com>
1735		1780
1736	Rewrote screen display and text selection routines.	1781	Rewrote screen display and text selection routines.
1737		1782
1738	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1783	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1739		1784
1740	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1785	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1741		1786
1742	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1787	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1743	extension, random hacks, numerous bugfixes and extensions.	1788	extension, random hacks, numerous bugfixes and extensions.
1744		1789
1745	Project Coordinator (Changes 1.0 -)	1790	Project Coordinator (Changes 1.0 -)
1746		1791
1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1792	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1748		1793
1749	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.
1750		1795
1751	=back	1796	=back
1752		1797

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.220 by root, Fri Sep 21 23:31:43 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.220 by root, Fri Sep 21 23:31:43 2012 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC