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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.192 by sf-exg, Sat Dec 18 12:20:18 2010 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 2020 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[;geom[:op1][:op2][...]]>
189
190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191	optionally specify its scaling with a geometry string. 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
…		…
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>.
412		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
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
417	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
558	You can set and change the resources using X11 tools like B<xrdb>. Many	533	You can set and change the resources using X11 tools like B<xrdb>. Many
559	distribution do also load settings from the B<~/.Xresources> file when X	534	distribution do also load settings from the B<~/.Xresources> file when X
560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
562		537
563	1. system-wide app-defaults file, either locale-dependent OR global
564	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
565	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
566	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568	6. resources specified via -xrm on the commandline	543	6. resources specified via -xrm on the commandline
569		544
570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	545	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
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[;geom[:op1][:op2][...]]>
749
750	Use the specified image file for the background and also
751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
754	centre (percent). A scale of 0 displays the image with tiling.
755	The maximum permitted scale is 1000.
756	Additional operations can be specified after colon B<:op1:op2...>.
757	Supported operations are:
758
759	tile force background image to be tiled and not scaled. Equivalent to 0x0
760	propscale will scale image keeping proportions
761	auto will scale image to match window size. Equivalent to 100x100
762	hscale will scale image horizontally to the window size
763	vscale will scale image vertically to the window size
764	scale will scale image to match window size
765	root will tile image as if it was a root window background, auto-adjusting
766	whenever terminal window moves
767
768	If used in conjunction with B<-tr> option, the specified pixmap will be
769	blended over the transparent background using alpha-blending. If I<afterimage>
770	support has been compiled in it is possible to choose other blending
771	types with B<-blt "type"> option.
772
773	=item B<path:> I<path>
774
775	Specify the colon-delimited search path for finding background image files.
776		693
777	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
778		695
779	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
780	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
…		…
877		794
878	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
879	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
880	[default]; option B<+ls>.	797	[default]; option B<+ls>.
881		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
882	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
883		805
884	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>;
885	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>
886	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
903	=item B<scrollstyle:> I<mode>	825	=item B<scrollstyle:> I<mode>
904		826
905	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
906	the author's favourite.	828	the author's favourite.
907		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
		833
908	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
909		835
910	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
911	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
912		838
…		…
931	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
932	B<+si>.	858	B<+si>.
933		859
934	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
935		861
936	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
937	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
938	with scrollback buffer when tty receives new lines; option B<+sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
939		866
940	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
941		868
942	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
943	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
944	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
945	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
946		873
947	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
948		875
949	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>.
950	resource is limited on most machines to 65535; option B<-sl>.
951		877
952	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
953		879
954	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;
955	option B<-b>.	881	option B<-b>.
…		…
1018		944
1019	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
1020		946
1021	Mouse pointer background colour.	947	Mouse pointer background colour.
1022		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
1023	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
1024		956
1025	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
1026	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
1027		959
…		…
1053		985
1054	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1055		987
1056	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
1057		989
1058	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1059		991
1060	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
1061		993
1062	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
1063		995
…		…
1132	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
1133	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
1134	@@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
1135	directory will be used; option B<-cd>.	1067	directory will be used; option B<-cd>.
1136		1068
1137	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
1138		1070
1139	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1140	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
1141		1073
1142	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
1143	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1144	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
1145	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
1146	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 the following full or
		1085	abbreviated modifier names:
		1086
		1087	=begin table
		1088
		1089	B<ISOLevel3> B<I>
		1090	B<AppKeypad> B<K>
		1091	B<Control> B<C>
		1092	B<NumLock> B<N>
		1093	B<Shift> B<S>
		1094	B<Meta> B<M> I<or> B<A>
		1095	B<Lock> B<L>
		1096	B<Mod1> B<1>
		1097	B<Mod2> B<2>
		1098	B<Mod3> B<3>
		1099	B<Mod4> B<4>
		1100	B<Mod5> B<5>
		1101
		1102	=end table
1147		1103
1148	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1104	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1149	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1105	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1150	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1106	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1151	current application keymap mode state.	1107	current application keymap mode state.
1152		1108
1153	The spellings of I<key> can be obtained by using B<xev>(1) command or	1109	Due the the large number of modifier combinations, a key mapping will
1154	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1110	match if I<at least> the specified identifiers are being set, and no other
		1111	key mappings with those and more bits are being defined. That means that
		1112	defining a mapping for C<a> will automatically provide definitions for
		1113	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1114	themselves. See the C<builtin:> action, below, for a way to work around
		1115	this when this is a problem.
		1116
		1117	The spelling of I<key> depends on your implementation of X. An easy way to
		1118	find a key name is to use the B<xev>(1) command. You can find a list by
		1119	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1155	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1120	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1156	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1121	value (B<0x0000 - 0xFFFF>).
1157	performed in an exact manner; however, the closest match is assured.
1158		1122
1159	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1123	As with any resource value, the I<action> string may contain backslash
		1124	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1160	number), see RESOURCES in C<man 7 X> for further details.	1125	number), see RESOURCES in C<man 7 X> for further details.
1161		1126
1162	You can define a range of keysyms in one shot by providing a I<string>	1127	An action starts with an action prefix that selects a certain type
1163	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1128	of action, followed by a colon. An action string without colons is
		1129	interpreted as a literal string to pass to the tty (as if it was
		1130	prefixed with C<string:>).
		1131
		1132	The following action prefixes are known - extensions can provide
		1133	additional prefixes:
		1134
		1135	=over 4
		1136
		1137	=item string:STRING
		1138
		1139	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1140	then the remaining C<STRING> will be passed to the program running in the
		1141	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1142	string C<echo rm -rf /> followed by a newline:
		1143
		1144	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1145
		1146	This could in theory be used to completely redefine your keymap.
		1147
		1148	In addition, for actions of this type, you can define a range of
		1149	keysyms in one shot by loading the C<keysym-list> perl extension and
		1150	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1164	should be a character not used by the strings.	1151	the delimiter `/' should be a character not used by the strings.
1165		1152
1166	Its usage can be demonstrated by an example:	1153	Its usage can be demonstrated by an example:
1167		1154
1168	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1155	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1169		1156
1170	The above line is equivalent to the following three lines:	1157	The above line is equivalent to the following three lines:
1171		1158
1172	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1159	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1173	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1160	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1174	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1161	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1175		1162
		1163	=item command:STRING
		1164
1176	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1165	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1177	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1166	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1167	the opposite of C<string:> - instead of sending it to the program running
		1168	in the terminal, it will be treated as if it were program output). This is
		1169	most useful to feed command sequences into @@RXVT_NAME@@.
		1170
1178	example the following means "change the current locale to C<zh_CN.GBK>	1171	For example the following means "change the current locale to C<zh_CN.GBK>
1179	when Control-Meta-c is being pressed":	1172	when Control-Meta-c is being pressed":
1180		1173
1181	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1174	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1182		1175
1183	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1176	The following example will map Control-Meta-1 and Control-Meta-2 to
1184	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1177	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1185	manpage. For example, the F<selection> extension (activated via	1178	font-switching at runtime:
1186	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187		1179
1188	URxvt.keysym.M-C-c: perl:selection:rot13	1180	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1181	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1189		1182
1190	Due the the large number of modifier combinations, a defined key mapping	1183	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1191	will match if I<at least> the specified identifiers are being set, and	1184	info):
1192	no other key mappings with those and more bits are being defined. That
1193	means that defining a key map for C<a> will automatically provide
1194	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1195	mappings themselves.
1196		1185
1197	Unfortunately, this will override built-in key mappings. For example	1186	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1187	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1188
		1189	=item builtin:
		1190
		1191	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1192	key binding existed for the key combination. The obvious use is to undo
		1193	the effect of existing bindings. The not so obvious use is to reinstate
		1194	bindings when another binding overrides too many modifiers.
		1195
1198	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1196	For example if you overwrite the C<Insert> key you will disable
1199	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1197	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1200	user-defined keymap using the C<builtin:> replacement:	1198	"holes" into the user-defined keymap using the C<builtin:> replacement:
1201		1199
1202	URxvt.keysym.Insert: <my insert key sequence>	1200	URxvt.keysym.Insert: <my insert key sequence>
1203	URxvt.keysym.S-Insert: builtin:	1201	URxvt.keysym.S-Insert: builtin:
1204		1202
1205	The first line defines a mapping for C<Insert> and I<any> combination	1203	The first line defines a mapping for C<Insert> and I<any> combination
1206	of modifiers. The second line re-establishes the default mapping for	1204	of modifiers. The second line re-establishes the default mapping for
1207	C<Shift-Insert>.	1205	C<Shift-Insert>.
1208		1206
1209	The following example will map Control-Meta-1 and Control-Meta-2 to	1207	=item builtin-string:
1210	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1211	font-switching at runtime:
1212		1208
1213	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1209	This action is mainly useful to restore string mappings for keys that
1214	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1210	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1211	difficult to explain - basically, this action will send the string to the
		1212	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1213	action for it.
1215		1214
1216	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1215	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1217	info):	1216	selection when you press C<Shift-Insert>. With the following bindings, it
		1217	would instead emit the (undocumented, but what applications running in the
		1218	terminal might expect) sequence C<ESC [ 2 $> instead:
1218		1219
1219	URxvt.keysym.M-C-3: command:\033[8;25;80t	1220	URxvt.keysym.S-Insert: builtin-string:
1220	URxvt.keysym.M-C-4: command:\033[8;48;110t	1221	URxvt.keysym.C-S-Insert: builtin:
		1222
		1223	The first line disables the paste functionality for that key
		1224	combination, and the second reinstates the default behaviour for
		1225	C<Control-Shift-Insert>, which would otherwise be overridden.
		1226
		1227	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1228	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1229	this:
		1230
		1231	URxvt.keysym.C-M-c: builtin-string:
		1232	URxvt.keysym.C-M-v: builtin-string:
		1233
		1234	=item EXTENSION:STRING
		1235
		1236	An action of this form invokes the action B<STRING>, if any, provided
		1237	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1238	be loaded automatically if necessary.
		1239
		1240	Not all extensions define actions, but popular extensions that do
		1241	include the I<selection> and I<matcher> extensions (documented in their
		1242	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1243	respectively).
		1244
		1245	From the silly examples department, this will rot13-"encrypt"
		1246	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1247	keyboards:
		1248
		1249	URxvt.keysym.M-C-c: selection:rot13
		1250
		1251	=item perl:STRING DEPRECATED
		1252
		1253	This is a deprecated way of invoking commands provided by perl
		1254	extensions. It is still supported, but should not be used anymore.
		1255
		1256	=back
1221		1257
1222	=item B<perl-ext-common>: I<string>	1258	=item B<perl-ext-common>: I<string>
1223		1259
1224	=item B<perl-ext>: I<string>	1260	=item B<perl-ext>: I<string>
1225		1261
…		…
1227	use in this terminal instance; option B<-pe>.	1263	use in this terminal instance; option B<-pe>.
1228		1264
1229	Extension names can be prefixed with a C<-> sign to prohibit using	1265	Extension names can be prefixed with a C<-> sign to prohibit using
1230	them. This can be useful to selectively disable some extensions loaded	1266	them. This can be useful to selectively disable some extensions loaded
1231	by default, or specified via the C<perl-ext-common> resource. For	1267	by default, or specified via the C<perl-ext-common> resource. For
1232	example, C<default,-selection> will use all the default extension except	1268	example, C<default,-selection> will use all the default extensions except
1233	C<selection>.	1269	C<selection>.
1234		1270
1235	Extension names can also be followed by an argument in angle brackets	1271	The default set includes the C<selection>, C<option-popup>,
1236	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1272	C<selection-popup>, C<readline> and C<searchable-scrollback>
1237	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1273	extensions, and extensions which are mentioned in B<keysym> resources.
1238	multiple times with different arguments will pass multiple arguments to	1274
1239	the extension.	1275	Any extension such that a corresponding resource is given on the
		1276	command line is automatically appended to B<perl-ext>.
1240		1277
1241	Each extension is looked up in the library directories, loaded if	1278	Each extension is looked up in the library directories, loaded if
1242	necessary, and bound to the current terminal instance.	1279	necessary, and bound to the current terminal instance. When the library
		1280	search path contains multiple extension files of the same name, then the
		1281	first one found will be used.
1243		1282
1244	If both of these resources are the empty string, then the perl	1283	If both of these resources are the empty string, then the perl interpreter
1245	interpreter will not be initialized. The idea behind two options is that	1284	will not be initialized. The rationale for having two options is that
1246	B<perl-ext-common> will be used for extensions that should be available to	1285	B<perl-ext-common> will be used for extensions that should be available to
1247	all instances, while B<perl-ext> is used for specific instances.	1286	all instances, while B<perl-ext> is used for specific instances.
1248		1287
1249	=item B<perl-eval>: I<string>	1288	=item B<perl-eval>: I<string>
1250		1289
…		…
1252	the @@RXVT_NAME@@perl(3) manpage.	1291	the @@RXVT_NAME@@perl(3) manpage.
1253		1292
1254	=item B<perl-lib>: I<path>	1293	=item B<perl-lib>: I<path>
1255		1294
1256	Colon-separated list of additional directories that hold extension	1295	Colon-separated list of additional directories that hold extension
1257	scripts. When looking for extensions specified by the C<perl> resource,	1296	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1258	@@RXVT_NAME@@ will first look in these directories and then in	1297	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1298	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260		1299
1261	See the @@RXVT_NAME@@perl(3) manpage.	1300	See the @@RXVT_NAME@@perl(3) manpage.
1262		1301
1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1302	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1264		1303
…		…
1268	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1307	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1269		1308
1270	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1309	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1271	for details.	1310	for details.
1272		1311
1273	=item B<searchable-scrollback:> I<keysym>	1312	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1274		1313
1275	Sets the hotkey that starts the incremental scrollback buffer search	1314	This resource is deprecated and will be removed. Use a B<keysym> resource
1276	(default: C<M-s>).	1315	instead, e.g.:
1277		1316
		1317	URxvt.keysym.M-s: searchable-scrollback:start
		1318
1278	=item B<urlLauncher>: I<string>	1319	=item B<url-launcher>: I<string>
1279		1320
1280	Specifies the program to be started with a URL argument. Used by the	1321	Specifies the program to be started with a URL argument. Used by the
1281	C<selection-popup> and C<matcher> perl extensions.	1322	C<selection-popup> and C<matcher> perl extensions.
1282		1323
1283	=item B<transient-for>: I<windowid>	1324	=item B<transient-for>: I<windowid>
…		…
1351	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1392	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1352	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1393	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1353		1394
1354	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1395	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1355	inserted too.	1396	inserted too.
		1397
		1398	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1399	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1400	binding causes the value of the internal selection to be copied to the
		1401	CLIPBOARD selection, while the second binding causes the value of the
		1402	CLIPBOARD selection to be inserted.
1356		1403
1357	=back	1404	=back
1358		1405
1359	=head1 CHANGING FONTS	1406	=head1 CHANGING FONTS
1360		1407
…		…
1449	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
1450	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1497	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1451	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1498	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1452	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1499	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1453	cube plus a 8 (24) colour greyscale ramp.	1500	cube plus a 8 (24) colour greyscale ramp.
		1501
		1502	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1503	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1504	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1505	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1506	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1507	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1508	use many similar 24-bit colours. It's typically not a problem in common
		1509	scenarios.
1454		1510
1455	Here is a list of the ANSI colours with their names.	1511	Here is a list of the ANSI colours with their names.
1456		1512
1457	=begin table	1513	=begin table
1458		1514
…		…
1485	The following text gives values for the standard 88 colour mode (and	1541	The following text gives values for the standard 88 colour mode (and
1486	values for the 256 colour mode in parentheses).	1542	values for the 256 colour mode in parentheses).
1487		1543
1488	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1544	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1489		1545
1490	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1546	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1491	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1547	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1492		1548
1493	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1549	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1494	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1550	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1495	the RGB cube.	1551	the RGB cube.
1496		1552
…		…
1512	White.	1568	White.
1513		1569
1514	=head2 ALPHA CHANNEL SUPPORT	1570	=head2 ALPHA CHANNEL SUPPORT
1515		1571
1516	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1572	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1517	their act together, rxvt-unicode will do it's own alpha channel management:	1573	their act together, rxvt-unicode will do its own alpha channel management:
1518		1574
1519	You can prefix any colour with an opaqueness percentage enclosed in	1575	You can prefix any colour with an opaqueness percentage enclosed in
1520	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1576	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1521	(0-100) that specifies the opacity of the colour, where C<0> is completely	1577	(0-100) that specifies the opacity of the colour, where C<0> is completely
1522	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1578	transparent and C<100> is completely opaque. For example, C<[50]red> is a
…		…
1604		1660
1605	=item B<SHELL>	1661	=item B<SHELL>
1606		1662
1607	The shell to be used for command execution, defaults to C</bin/sh>.	1663	The shell to be used for command execution, defaults to C</bin/sh>.
1608		1664
1609	=item B<RXVT_SOCKET>	1665	=item B<RXVT_SOCKET> [I<sic>]
1610		1666
1611	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1667	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1612	@@RXVT_NAME@@d(1).	1668	@@RXVT_NAME@@d(1).
1613		1669
1614	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.	1670	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1671
		1672	=item B<URXVT_PERL_LIB>
		1673
		1674	Additional F<:>-separated library search path for perl extensions. Will be
		1675	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1676	directory.
		1677
		1678	=item B<URXVT_PERL_VERBOSITY>
		1679
		1680	See L<@@RXVT_NAME@@perl>(3).
1615		1681
1616	=item B<HOME>	1682	=item B<HOME>
1617		1683
1618	Used to locate the default directory for the unix domain socket for	1684	Used to locate the default directory for the unix domain socket for
1619	daemon communications and to locate various resource files (such as	1685	daemon communications and to locate various resource files (such as
…		…
1640		1706
1641	=back	1707	=back
1642		1708
1643	=head1 SEE ALSO	1709	=head1 SEE ALSO
1644		1710
		1711	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1645	@@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)	1712	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1646		1713
1647	=head1 CURRENT PROJECT COORDINATOR	1714	=head1 CURRENT PROJECT COORDINATOR
1648		1715
1649	=over 4	1716	=over 4
1650		1717
1651	=item Project Coordinator	1718	=item Project Coordinator
1652		1719
1653	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1720	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1654		1721
1655	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1722	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1656		1723
1657	=back	1724	=back
1658		1725
…		…
1662		1729
1663	=item John Bovey	1730	=item John Bovey
1664		1731
1665	University of Kent, 1992, wrote the original Xvt.	1732	University of Kent, 1992, wrote the original Xvt.
1666		1733
1667	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1734	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1668		1735
1669	very heavily modified Xvt and came up with Rxvt	1736	very heavily modified Xvt and came up with Rxvt
1670		1737
1671	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1738	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1672		1739
1673	wrote the Greek Keyboard Input (no longer in code)	1740	wrote the Greek Keyboard Input (no longer in code)
1674		1741
1675	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1742	=item mj olesen <olesen@me.QueensU.CA>
1676		1743
1677	Wrote the menu system.	1744	Wrote the menu system.
1678		1745
1679	Project Coordinator (changes.txt 2.11 to 2.21)	1746	Project Coordinator (changes.txt 2.11 to 2.21)
1680		1747
1681	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1748	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1682		1749
1683	Project Coordinator (changes.txt 2.21a to 2.4.5)	1750	Project Coordinator (changes.txt 2.21a to 2.4.5)
1684		1751
1685	=item Geoff Wing L<< <gcw@pobox.com> >>	1752	=item Geoff Wing <gcw@pobox.com>
1686		1753
1687	Rewrote screen display and text selection routines.	1754	Rewrote screen display and text selection routines.
1688		1755
1689	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1756	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1690		1757
1691	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1758	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1692		1759
1693	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1760	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1694	extension, random hacks, numerous bugfixes and extensions.	1761	extension, random hacks, numerous bugfixes and extensions.
1695		1762
1696	Project Coordinator (Changes 1.0 -)	1763	Project Coordinator (Changes 1.0 -)
1697		1764
1698	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1765	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1699		1766
1700	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1767	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1701		1768
1702	=back	1769	=back
1703		1770

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.192 by sf-exg, Sat Dec 18 12:20:18 2010 UTC vs. Revision 1.250 by root, Sat Oct 10 20:06:45 2020 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.192 by sf-exg, Sat Dec 18 12:20:18 2010 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 2020 UTC