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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC vs.
Revision 1.263 by sf-exg, Sat Jan 20 08:00:50 2024 UTC

…		…
84	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1	84	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
85	Orange'.	85	Orange'.
86		86
87	The following options are available:	87	The following options are available:
88		88
89	=over 4	89	=over
90		90
91	=item B<-help>, B<--help>	91	=item B<-help>, B<--help>
92		92
93	Print out a message describing available options.	93	Print out a message describing available options.
94		94
…		…
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>.
		132
		133	=item B<-fps> I<number>
		134
		135	Compile I<frills>: Set the refresh interval (in frames per second or
		136	negative seconds); resource B<refreshRate>.
131		137
132	=item B<-fade> I<number>	138	=item B<-fade> I<number>
133		139
134	Fade the text by the given percentage when focus is lost. Small values	140	Fade the text by the given percentage when focus is lost. Small values
135	fade a little only, 100 completely replaces all colours by the fade	141	fade a little only, 100 completely replaces all colours by the fade
…		…
218	`.' or `*' characters. Also sets the icon and title name.	224	`.' or `*' characters. Also sets the icon and title name.
219		225
220	=item B<-ls>\|B<+ls>	226	=item B<-ls>\|B<+ls>
221		227
222	Start as a login-shell/sub-shell; resource B<loginShell>.	228	Start as a login-shell/sub-shell; resource B<loginShell>.
		229
		230	=item B<-mc> I<milliseconds>
		231
		232	Specify the maximum time between multi-click selections.
223		233
224	=item B<-ut>\|B<+ut>	234	=item B<-ut>\|B<+ut>
225		235
226	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	236	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227	B<utmpInhibit>.	237	B<utmpInhibit>.
…		…
375	=item B<-pt> I<style>	385	=item B<-pt> I<style>
376		386
377	Compile I<XIM>: input style for input method; B<OverTheSpot>,	387	Compile I<XIM>: input style for input method; B<OverTheSpot>,
378	B<OffTheSpot>, B<Root>; resource B<preeditType>.	388	B<OffTheSpot>, B<Root>; resource B<preeditType>.
379		389
		390	If the perl extension C<xim-onthespot> is used (which is the default),
		391	then additionally the C<OnTheSpot> preedit type is available.
		392
380	=item B<-im> I<text>	393	=item B<-im> I<text>
381		394
382	Compile I<XIM>: input method name. resource B<inputMethod>.	395	Compile I<XIM>: input method name. resource B<inputMethod>.
383		396
384	=item B<-imlocale> I<string>	397	=item B<-imlocale> I<string>
…		…
398	Change the meaning of triple-click selection with the left mouse	411	Change the meaning of triple-click selection with the left mouse
399	button. Only effective when the original (non-perl) selection code is	412	button. Only effective when the original (non-perl) selection code is
400	in-use. Instead of selecting a full line it will extend the selection to	413	in-use. Instead of selecting a full line it will extend the selection to
401	the end of the logical line only. resource B<tripleclickwords>.	414	the end of the logical line only. resource B<tripleclickwords>.
402		415
		416	=item B<-dpb>\|B<+dpb>
		417
		418	Compile frills: Disable (or enable) emitting bracketed paste mode
		419	sequences (default enabled). Bracketed paste mode allows programs
		420	to detect when something is pasted. Since more and more programs
		421	abuse this, these sequences can be disabled. The command sequences to
		422	enable and query paste mode will still work, but the actual bracket
		423	sequences will no longer be emitted. You can also toggle this from the
		424	ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
		425
403	=item B<-insecure>	426	=item B<-insecure>
404		427
405	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
406	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
407	info.	430	info.
…		…
419		442
420	=item B<-ssr>\|B<+ssr>	443	=item B<-ssr>\|B<+ssr>
421		444
422	Turn on/off secondary screen scroll (default enabled); resource	445	Turn on/off secondary screen scroll (default enabled); resource
423	B<secondaryScroll>.	446	B<secondaryScroll>.
		447
		448	=item B<-rm> I<mode>
		449
		450	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		451	to one of B<auto> (the default), B<always> or B<never>. The latter two
		452	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		453	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		454	B<rewrapMode>.
424		455
425	=item B<-hold>\|B<+hold>	456	=item B<-hold>\|B<+hold>
426		457
427	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	458	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
428	will not immediately destroy its window when the program executed within	459	will not immediately destroy its window when the program executed within
…		…
506	close $pty;	537	close $pty;
507		538
508	# now communicate with rxvt	539	# now communicate with rxvt
509	my $slave = $pty->slave;	540	my $slave = $pty->slave;
510	while (<$slave>) { print $slave "got <$_>\n" }	541	while (<$slave>) { print $slave "got <$_>\n" }
		542
		543	Note that, despite what the name might imply, the file descriptor does not
		544	need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
		545	domain or tcp socket). While tty operations cannot be done in this case,
		546	B<@@RXVT_NAME@@> can still be remote controlled with it:
		547
		548	use Socket;
		549	use Fcntl;
		550
		551	socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
		552	fcntl $slave, Fcntl::F_SETFD, 0;
		553	system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
		554	close $slave;
		555
		556	syswrite $URXVT, "Type a secret password: ";
		557	my $secret = do { local $/ = "\r"; <$URXVT> };
		558	print "Not so secret anymore: $secret\n";
511		559
512	=item B<-pe> I<string>	560	=item B<-pe> I<string>
513		561
514	Comma-separated list of perl extension scripts to use (or not to use) in	562	Comma-separated list of perl extension scripts to use (or not to use) in
515	this terminal instance. See resource B<perl-ext> for details.	563	this terminal instance. See resource B<perl-ext> for details.
…		…
543	be used. Command-line arguments can be used to override resource	591	be used. Command-line arguments can be used to override resource
544	settings. The following resources are supported (you might want to	592	settings. The following resources are supported (you might want to
545	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	593	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
546	extensions not documented here):	594	extensions not documented here):
547		595
548	=over 4	596	=over
549		597
550	=item B<depth:> I<bitdepth>	598	=item B<depth:> I<bitdepth>
551		599
552	Compile I<xft>: Attempt to find a visual with the given bit depth;	600	Compile I<xft>: Attempt to find a visual with the given bit depth;
553	option B<-depth>.	601	option B<-depth>.
…		…
654		702
655	B<False>: specify that everything is to be displayed, even	703	B<False>: specify that everything is to be displayed, even
656	if the refresh is too fast for the human eye to read anything (or the	704	if the refresh is too fast for the human eye to read anything (or the
657	monitor to display anything); option B<+ss>.	705	monitor to display anything); option B<+ss>.
658		706
		707	=item B<refreshRate:> I<number>
		708
		709	Compile I<frills>: When positive, sets the maximum refreshes per second
		710	(the default is C<60>). When zero or negative, sets the minimum interval
		711	between refreshes, negated. That is, positive numbers limit the number
		712	of refreshes per second to that number, similar to a fps limiter in
		713	games. A negative number gets negated and directly sets the minimum
		714	interval between refreshes, that is, C<10> and C<-0.1> both specify
		715	the same refresh interval (likewise C<50> and C<0.02>). Finally, zero
		716	makes @@RXVT_NAME@@ refresh as fast as possible. Fractional values are
		717	supported; option B<-fps>.
		718
659	=item B<fading:> I<number>	719	=item B<fading:> I<number>
660		720
661	Fade the text by the given percentage when focus is lost; option B<-fade>.	721	Fade the text by the given percentage when focus is lost; option B<-fade>.
662		722
663	=item B<fadeColor:> I<colour>	723	=item B<fadeColor:> I<colour>
…		…
786		846
787	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	847	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
788	the shell; option B<-ls>. B<False>: start as a normal sub-shell	848	the shell; option B<-ls>. B<False>: start as a normal sub-shell
789	[default]; option B<+ls>.	849	[default]; option B<+ls>.
790		850
		851	=item B<multiClickTime:> I<number>
		852
		853	Specify the maximum time in milliseconds between multi-click select
		854	events. The default is 500 milliseconds; option B<-mc>.
		855
791	=item B<utmpInhibit:> I<boolean>	856	=item B<utmpInhibit:> I<boolean>
792		857
793	B<True>: inhibit writing record into the system log file B<utmp>;	858	B<True>: inhibit writing record into the system log file B<utmp>;
794	option B<-ut>. B<False>: write record into the system log file B<utmp>	859	option B<-ut>. B<False>: write record into the system log file B<utmp>
795	[default]; option B<+ut>.	860	[default]; option B<+ut>.
…		…
838	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	903	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
839	thumb with the pointer on middle button press/drag.	904	thumb with the pointer on middle button press/drag.
840		905
841	=item B<scrollTtyOutput:> I<boolean>	906	=item B<scrollTtyOutput:> I<boolean>
842		907
843	B<True>: scroll to bottom when tty receives output; option B<-si>.	908	B<True>: scroll to bottom when tty receives output; option B<+si>.
844	B<False>: do not scroll to bottom when tty receives output; option	909	B<False>: do not scroll to bottom when tty receives output; option
845	B<+si>.	910	B<-si>.
846		911
847	=item B<scrollWithBuffer:> I<boolean>	912	=item B<scrollWithBuffer:> I<boolean>
848		913
849	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.	914	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
850	try to show the same lines) and B<scrollTtyOutput> is False; option	915	try to show the same lines) and B<scrollTtyOutput> is False; option
…		…
858	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	923	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
859	bottom when a non-special key is pressed; option B<+sk>.	924	bottom when a non-special key is pressed; option B<+sk>.
860		925
861	=item B<saveLines:> I<number>	926	=item B<saveLines:> I<number>
862		927
863	Save I<number> lines in the scrollback buffer [default 64]. This	928	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
864	resource is limited on most machines to 65535; option B<-sl>.
865		929
866	=item B<internalBorder:> I<number>	930	=item B<internalBorder:> I<number>
867		931
868	Internal border of I<number> pixels. This resource is limited to 100;	932	Internal border of I<number> pixels. This resource is limited to 100;
869	option B<-b>.	933	option B<-b>.
…		…
932		996
933	=item B<pointerColor2:> I<colour>	997	=item B<pointerColor2:> I<colour>
934		998
935	Mouse pointer background colour.	999	Mouse pointer background colour.
936		1000
		1001	=item B<pointerShape:> I<string>
		1002
		1003	Compile I<frills>: Specifies the name of the mouse pointer shape
		1004	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		1005	file for possible values (omit the C<XC_> prefix).
		1006
937	=item B<pointerBlankDelay:> I<number>	1007	=item B<pointerBlankDelay:> I<number>
938		1008
939	Specifies number of seconds before blanking the pointer [default 2]. Use a	1009	Specifies number of seconds before blanking the pointer [default 2]. Use a
940	large number (e.g. C<987654321>) to effectively disable the timeout.	1010	large number (e.g. C<987654321>) to effectively disable the timeout.
941		1011
…		…
967		1037
968	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1038	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
969		1039
970	=item B<preeditType:> I<style>	1040	=item B<preeditType:> I<style>
971		1041
972	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1042	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
973		1043
974	=item B<inputMethod:> I<name>	1044	=item B<inputMethod:> I<name>
975		1045
976	I<name> of inputMethod to use; option B<-im>.	1046	I<name> of inputMethod to use; option B<-im>.
977		1047
…		…
995		1065
996	Change the meaning of triple-click selection with the left mouse	1066	Change the meaning of triple-click selection with the left mouse
997	button. Instead of selecting a full line it will extend the selection to	1067	button. Instead of selecting a full line it will extend the selection to
998	the end of the logical line only; option B<-tcw>.	1068	the end of the logical line only; option B<-tcw>.
999		1069
		1070	=item B<disablePasteBrackets:> I<boolean>
		1071
		1072	Prevent emission of paste bracket sequences; option B<-dpb>.
		1073
1000	=item B<insecure:> I<boolean>	1074	=item B<insecure:> I<boolean>
1001		1075
1002	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1076	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1003	echo arbitrary strings like the icon name or the locale. This could be	1077	echo arbitrary strings like the icon name or the locale. This could be
1004	abused if somebody gets 8-bit-clean access to your display, whether	1078	abused if somebody gets 8-bit-clean access to your display, whether
1005	through a mail client displaying mail bodies unfiltered or through	1079	through a mail client displaying mail bodies unfiltered or through
1006	write(1) or any other means. Therefore, these sequences are disabled by	1080	write(1) or any other means. Therefore, these sequences are disabled by
1007	default. (Note that many other terminals, including xterm, have these	1081	default. (Note that many other terminals, including xterm, have these
…		…
1025		1099
1026	=item B<secondaryScreen:> I<boolean>	1100	=item B<secondaryScreen:> I<boolean>
1027		1101
1028	Turn on/off secondary screen (default enabled).	1102	Turn on/off secondary screen (default enabled).
1029		1103
		1104	=item B<rewrapMode:> I<mode>
		1105
		1106	Sets long line rewrap behaviour on window resize to one of B<auto>
		1107	(default), B<always> or B<never>.
		1108
1030	=item B<secondaryScroll:> I<boolean>	1109	=item B<secondaryScroll:> I<boolean>
1031		1110
1032	Turn on/off secondary screen scroll (default enabled). If this	1111	Turn on/off secondary screen scroll (default enabled). If this
1033	option is enabled, scrolls on the secondary screen will change the	1112	option is enabled, scrolls on the secondary screen will change the
1034	scrollback buffer and, when secondaryScreen is off, switching	1113	scrollback buffer and, when secondaryScreen is off, switching
…		…
1061		1140
1062	The key combination that triggers the action, I<sym>, has the following format:	1141	The key combination that triggers the action, I<sym>, has the following format:
1063		1142
1064	(modifiers-)key	1143	(modifiers-)key
1065		1144
1066	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,	1145	Where I<modifiers> can be any combination of the following full or
1067	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1146	abbreviated modifier names:
1068	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1147
1069	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.	1148	=begin table
		1149
		1150	B<ISOLevel3> B<I>
		1151	B<AppKeypad> B<K>
		1152	B<Control> B<C>
		1153	B<NumLock> B<N>
		1154	B<Shift> B<S>
		1155	B<Meta> B<M> I<or> B<A>
		1156	B<Lock> B<L>
		1157	B<Mod1> B<1>
		1158	B<Mod2> B<2>
		1159	B<Mod3> B<3>
		1160	B<Mod4> B<4>
		1161	B<Mod5> B<5>
		1162
		1163	=end table
1070		1164
1071	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1165	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1072	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1166	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1073	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1167	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1074	current application keymap mode state.	1168	current application keymap mode state.
…		…
1097	prefixed with C<string:>).	1191	prefixed with C<string:>).
1098		1192
1099	The following action prefixes are known - extensions can provide	1193	The following action prefixes are known - extensions can provide
1100	additional prefixes:	1194	additional prefixes:
1101		1195
1102	=over 4	1196	=over
1103		1197
1104	=item string:STRING	1198	=item string:STRING
1105		1199
1106	If the I<action> starts with C<string:> (or otherwise contains no colons),	1200	If the I<action> starts with C<string:> (or otherwise contains no colons),
1107	then the remaining C<STRING> will be passed to the program running in the	1201	then the remaining C<STRING> will be passed to the program running in the
…		…
1109	string C<echo rm -rf /> followed by a newline:	1203	string C<echo rm -rf /> followed by a newline:
1110		1204
1111	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1205	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1112		1206
1113	This could in theory be used to completely redefine your keymap.	1207	This could in theory be used to completely redefine your keymap.
		1208
		1209	In addition, for actions of this type, you can define a range of
		1210	keysyms in one shot by loading the C<keysym-list> perl extension and
		1211	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
		1212	the delimiter `/' should be a character not used by the strings.
		1213
		1214	Its usage can be demonstrated by an example:
		1215
		1216	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
		1217
		1218	The above line is equivalent to the following three lines:
		1219
		1220	URxvt.keysym.Meta-Control-0x61: string:\033<a>
		1221	URxvt.keysym.Meta-Control-0x62: string:\033<b>
		1222	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1114		1223
1115	=item command:STRING	1224	=item command:STRING
1116		1225
1117	If I<action> takes the form of C<command:STRING>, the specified B<STRING>	1226	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1118	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically	1227	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
…		…
1178		1287
1179	Similarly, to let applications gain access to the C<C-M-c> (copy to	1288	Similarly, to let applications gain access to the C<C-M-c> (copy to
1180	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do	1289	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181	this:	1290	this:
1182		1291
1183	URxvt.keysym.C-S-c: builtin-string:	1292	URxvt.keysym.C-M-c: builtin-string:
1184	URxvt.keysym.C-S-v: builtin-string:	1293	URxvt.keysym.C-M-v: builtin-string:
1185		1294
1186	=item EXTENSION:STRING	1295	=item EXTENSION:STRING
1187		1296
1188	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)	1297	An action of this form invokes the action B<STRING>, if any, provided
1189	extension of the same name. The extension will be loaded automatically if	1298	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1190	necessary.	1299	be loaded automatically if necessary.
1191		1300
1192	Not all extensions define key actions, but popular extensions that do	1301	Not all extensions define actions, but popular extensions that do
1193	include the I<selection> and I<matcher> extensions (documented in their	1302	include the I<selection> and I<matcher> extensions (documented in their
1194	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1303	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195	respectively).	1304	respectively).
1196		1305
1197	From the silly examples department, this will rot13-"encrypt"	1306	From the silly examples department, this will rot13-"encrypt"
…		…
1200		1309
1201	URxvt.keysym.M-C-c: selection:rot13	1310	URxvt.keysym.M-C-c: selection:rot13
1202		1311
1203	=item perl:STRING DEPRECATED	1312	=item perl:STRING DEPRECATED
1204		1313
1205	This is a deprecated way of passing key mappings to perl extensions. It is	1314	This is a deprecated way of invoking commands provided by perl
1206	still supported, but should not be used anymore.	1315	extensions. It is still supported, but should not be used anymore.
1207		1316
1208	=back	1317	=back
1209		1318
1210	=item B<perl-ext-common>: I<string>	1319	=item B<perl-ext-common>: I<string>
1211		1320
1212	=item B<perl-ext>: I<string>	1321	=item B<perl-ext>: I<string>
1213		1322
1214	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1323	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1215	use in this terminal instance; option B<-pe>.	1324	use in this terminal instance; option B<-pe>.
1216		1325
1217	Extension names can be prefixed with a C<-> sign to prohibit using	1326	Extension names can be prefixed with a C<-> sign to remove them again, in
1218	them. This can be useful to selectively disable some extensions loaded	1327	case they had been specified earlier. This can be useful to selectively
1219	by default, or specified via the C<perl-ext-common> resource. For	1328	disable some extensions loaded by default, or specified via the
1220	example, C<default,-selection> will use all the default extensions except	1329	C<perl-ext-common> resource. For example, C<default,-selection> will use
1221	C<selection>.	1330	all the default extensions except C<selection>.
		1331
		1332	To prohibit autoloading of extensions, you can prefix them with C</>,
		1333	which will make urxvt refuse to automatically load them (this can be
		1334	overridden, however, by specifying the extension name again without a
		1335	prefix, though). This does not prohibit extensions themselves loading
		1336	other extensions. For example, C<default,/background> will keep the
		1337	C<background> extension from being loaded when a background OSC sequence
		1338	is received.
1222		1339
1223	The default set includes the C<selection>, C<option-popup>,	1340	The default set includes the C<selection>, C<option-popup>,
1224	C<selection-popup> and C<readline> extensions, any extensions that define	1341	C<selection-popup>, C<readline>, C<searchable-scrollback> and
1225	keybindings via C<BINDING> meta comments, extensions loaded because	1342	C<confirm-paste> extensions, as well as any extensions which are mentioned
1226	their resources/commandline switches were used, and extensions which are
1227	mentioned in B<keysym> resources.	1343	in B<keysym> resources.
		1344
		1345	Any extension such that a corresponding resource is given on the
		1346	command line is automatically appended to B<perl-ext>.
1228		1347
1229	Each extension is looked up in the library directories, loaded if	1348	Each extension is looked up in the library directories, loaded if
1230	necessary, and bound to the current terminal instance. When the library	1349	necessary, and bound to the current terminal instance. When the library
1231	search path contains multiple extension files of the same name, then the	1350	search path contains multiple extension files of the same name, then the
1232	first one found will be used.	1351	first one found will be used.
…		…
1286	Turn on/off ISO 14755 (default enabled).	1405	Turn on/off ISO 14755 (default enabled).
1287		1406
1288	=item B<iso14755_52:> I<boolean>	1407	=item B<iso14755_52:> I<boolean>
1289		1408
1290	Turn on/off ISO 14755 5.2 mode (default enabled).	1409	Turn on/off ISO 14755 5.2 mode (default enabled).
1291
1292	=back
1293
1294	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1295
1296	=over 4
1297
1298	=item B<-pixmap> I<file[;oplist]>
1299
1300	=item B<backgroundPixmap:> I<file[;oplist]>
1301
1302	Compile I<pixbuf>: Use the specified image file as the window's
1303	background and also optionally specify a colon separated list of
1304	operations to modify it. Note that you may need to quote the C<;>
1305	character when using the command line option, as C<;> is usually a
1306	metacharacter in shells. Supported operations are:
1307
1308	=over 4
1309
1310	=item B<WxH+X+Y>
1311
1312	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1313	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1314	scale of 0 disables scaling.
1315
1316	=item B<op=tile>
1317
1318	enables tiling
1319
1320	=item B<op=keep-aspect>
1321
1322	maintain the image aspect ratio when scaling
1323
1324	=item B<op=root-align>
1325
1326	use the position of the terminal window relative to the root window as
1327	the image offset, simulating a root window background
1328
1329	=back
1330
1331	The default scale and position setting is C<100x100+50+50>.
1332	Alternatively, a predefined set of templates can be used to achieve
1333	the most common setups:
1334
1335	=over 4
1336
1337	=item B<style=tiled>
1338
1339	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1340
1341	=item B<style=aspect-stretched>
1342
1343	the image is scaled to fill the whole window maintaining the aspect
1344	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1345
1346	=item B<style=stretched>
1347
1348	the image is scaled to fill the whole window. Equivalent to 100x100
1349
1350	=item B<style=centered>
1351
1352	the image is centered with no scaling. Equivalent to 0x0+50+50
1353
1354	=item B<style=root-tiled>
1355
1356	the image is tiled with no scaling and using 'root' positioning.
1357	Equivalent to 0x0:op=tile:op=root-align
1358
1359	=back
1360
1361	If multiple templates are specified the last one wins. Note that a
1362	template overrides all the scale, position and operations settings.
1363
1364	If used in conjunction with pseudo-transparency, the specified pixmap
1365	will be blended over the transparent background using alpha-blending.
1366
1367	=item B<-tr>\|B<+tr>
1368
1369	=item B<transparent:> I<boolean>
1370
1371	Turn on/off pseudo-transparency by using the root pixmap as background.
1372
1373	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1374	will be removed in future versions.
1375
1376	=item B<-tint> I<colour>
1377
1378	=item B<tintColor:> I<colour>
1379
1380	Tint the transparent background with the given colour. Note that a
1381	black tint yields a completely black image while a white tint yields
1382	the image unchanged.
1383
1384	=item B<-sh> I<number>
1385
1386	=item B<shading:> I<number>
1387
1388	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1389	A value of 100 means no shading.
1390
1391	=item B<-blr> I<HxV>
1392
1393	=item B<blurRadius:> I<HxV>
1394
1395	Apply gaussian blur with the specified radius to the transparent
1396	background. If a single number is specified, the vertical and
1397	horizontal radii are considered to be the same. Setting one of the
1398	radii to 1 and the other to a large number creates interesting effects
1399	on some backgrounds. The maximum radius value is 128. An horizontal or
1400	vertical radius of 0 disables blurring.
1401
1402	=item B<path:> I<path>
1403
1404	Specify the colon-delimited search path for finding background image files.
1405		1410
1406	=back	1411	=back
1407		1412
1408	=head1 THE SCROLLBAR	1413	=head1 THE SCROLLBAR
1409		1414
…		…
1433	=head1 THE SELECTION: SELECTING AND PASTING TEXT	1438	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1434		1439
1435	The behaviour of text selection and insertion/pasting mechanism is similar	1440	The behaviour of text selection and insertion/pasting mechanism is similar
1436	to I<xterm>(1).	1441	to I<xterm>(1).
1437		1442
1438	=over 4	1443	=over
1439		1444
1440	=item B<Selecting>:	1445	=item B<Selecting>:
1441		1446
1442	Left click at the beginning of the region, drag to the end of the region	1447	Left click at the beginning of the region, drag to the end of the region
1443	and release; Right click to extend the marked region; Left double-click	1448	and release; Right click to extend the marked region; Left double-click
…		…
1459		1464
1460	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1465	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1461	inserted too.	1466	inserted too.
1462		1467
1463	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and	1468	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1464	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first	1469	B<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1465	binding causes the value of the internal selection to be copied to the	1470	binding causes the value of the internal selection to be copied to the
1466	CLIPBOARD selection, while the second binding causes the value of the	1471	CLIPBOARD selection, while the second binding causes the value of the
1467	CLIPBOARD selection to be inserted.	1472	CLIPBOARD selection to be inserted.
1468		1473
1469	=back	1474	=back
…		…
1490	and character codes using the keyboard. It consists of 4 parts. The	1495	and character codes using the keyboard. It consists of 4 parts. The
1491	first part is available if rxvt-unicode has been compiled with	1496	first part is available if rxvt-unicode has been compiled with
1492	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1497	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1493	with C<--enable-iso14755>.	1498	with C<--enable-iso14755>.
1494		1499
1495	=over 4	1500	=over
1496		1501
1497	=item * 5.1: Basic method	1502	=item * 5.1: Basic method
1498		1503
1499	This allows you to enter unicode characters using their hexcode.	1504	This allows you to enter unicode characters using their hexcode.
1500		1505
…		…
1561	In addition to the default foreground and background colours,	1566	In addition to the default foreground and background colours,
1562	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1567	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1563	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1568	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1564	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1569	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1565	cube plus a 8 (24) colour greyscale ramp.	1570	cube plus a 8 (24) colour greyscale ramp.
		1571
		1572	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1573	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1574	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1575	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1576	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1577	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1578	use many similar 24-bit colours. It's typically not a problem in common
		1579	scenarios.
1566		1580
1567	Here is a list of the ANSI colours with their names.	1581	Here is a list of the ANSI colours with their names.
1568		1582
1569	=begin table	1583	=begin table
1570		1584
…		…
1671		1685
1672	=head1 ENVIRONMENT	1686	=head1 ENVIRONMENT
1673		1687
1674	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1688	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1675		1689
1676	=over 4	1690	=over
1677		1691
1678	=item B<TERM>	1692	=item B<TERM>
1679		1693
1680	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1694	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1681	resources or on the command line.	1695	resources or on the command line.
…		…
1752		1766
1753	=back	1767	=back
1754		1768
1755	=head1 FILES	1769	=head1 FILES
1756		1770
1757	=over 4	1771	=over
1758		1772
1759	=item B</usr/lib/X11/rgb.txt>	1773	=item B</usr/lib/X11/rgb.txt>
1760		1774
1761	Colour names.	1775	Colour names.
1762		1776
…		…
1767	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),	1781	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1768	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1782	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1769		1783
1770	=head1 CURRENT PROJECT COORDINATOR	1784	=head1 CURRENT PROJECT COORDINATOR
1771		1785
1772	=over 4	1786	=over
1773		1787
1774	=item Project Coordinator	1788	=item Project Coordinator
1775		1789
1776	Marc A. Lehmann <rxvt-unicode@schmorp.de>.	1790	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1777		1791
…		…
1779		1793
1780	=back	1794	=back
1781		1795
1782	=head1 AUTHORS	1796	=head1 AUTHORS
1783		1797
1784	=over 4	1798	=over
1785		1799
1786	=item John Bovey	1800	=item John Bovey
1787		1801
1788	University of Kent, 1992, wrote the original Xvt.	1802	University of Kent, 1992, wrote the original Xvt.
1789		1803

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC vs. Revision 1.263 by sf-exg, Sat Jan 20 08:00:50 2024 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC vs.
Revision 1.263 by sf-exg, Sat Jan 20 08:00:50 2024 UTC