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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.237 by sf-exg, Thu Aug 21 19:21:14 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
…		…
379	=item B<-pt> I<style>	385	=item B<-pt> I<style>
380		386
381	Compile I<XIM>: input style for input method; B<OverTheSpot>,	387	Compile I<XIM>: input style for input method; B<OverTheSpot>,
382	B<OffTheSpot>, B<Root>; resource B<preeditType>.	388	B<OffTheSpot>, B<Root>; resource B<preeditType>.
383		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
384	=item B<-im> I<text>	393	=item B<-im> I<text>
385		394
386	Compile I<XIM>: input method name. resource B<inputMethod>.	395	Compile I<XIM>: input method name. resource B<inputMethod>.
387		396
388	=item B<-imlocale> I<string>	397	=item B<-imlocale> I<string>
…		…
402	Change the meaning of triple-click selection with the left mouse	411	Change the meaning of triple-click selection with the left mouse
403	button. Only effective when the original (non-perl) selection code is	412	button. Only effective when the original (non-perl) selection code is
404	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
405	the end of the logical line only. resource B<tripleclickwords>.	414	the end of the logical line only. resource B<tripleclickwords>.
406		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
407	=item B<-insecure>	426	=item B<-insecure>
408		427
409	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
410	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
411	info.	430	info.
…		…
423		442
424	=item B<-ssr>\|B<+ssr>	443	=item B<-ssr>\|B<+ssr>
425		444
426	Turn on/off secondary screen scroll (default enabled); resource	445	Turn on/off secondary screen scroll (default enabled); resource
427	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>.
428		455
429	=item B<-hold>\|B<+hold>	456	=item B<-hold>\|B<+hold>
430		457
431	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@@
432	will not immediately destroy its window when the program executed within	459	will not immediately destroy its window when the program executed within
…		…
510	close $pty;	537	close $pty;
511		538
512	# now communicate with rxvt	539	# now communicate with rxvt
513	my $slave = $pty->slave;	540	my $slave = $pty->slave;
514	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";
515		559
516	=item B<-pe> I<string>	560	=item B<-pe> I<string>
517		561
518	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
519	this terminal instance. See resource B<perl-ext> for details.	563	this terminal instance. See resource B<perl-ext> for details.
…		…
547	be used. Command-line arguments can be used to override resource	591	be used. Command-line arguments can be used to override resource
548	settings. The following resources are supported (you might want to	592	settings. The following resources are supported (you might want to
549	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
550	extensions not documented here):	594	extensions not documented here):
551		595
552	=over 4	596	=over
553		597
554	=item B<depth:> I<bitdepth>	598	=item B<depth:> I<bitdepth>
555		599
556	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;
557	option B<-depth>.	601	option B<-depth>.
…		…
658		702
659	B<False>: specify that everything is to be displayed, even	703	B<False>: specify that everything is to be displayed, even
660	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
661	monitor to display anything); option B<+ss>.	705	monitor to display anything); option B<+ss>.
662		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
663	=item B<fading:> I<number>	719	=item B<fading:> I<number>
664		720
665	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>.
666		722
667	=item B<fadeColor:> I<colour>	723	=item B<fadeColor:> I<colour>
…		…
847	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
848	thumb with the pointer on middle button press/drag.	904	thumb with the pointer on middle button press/drag.
849		905
850	=item B<scrollTtyOutput:> I<boolean>	906	=item B<scrollTtyOutput:> I<boolean>
851		907
852	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>.
853	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
854	B<+si>.	910	B<-si>.
855		911
856	=item B<scrollWithBuffer:> I<boolean>	912	=item B<scrollWithBuffer:> I<boolean>
857		913
858	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.
859	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
…		…
867	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
868	bottom when a non-special key is pressed; option B<+sk>.	924	bottom when a non-special key is pressed; option B<+sk>.
869		925
870	=item B<saveLines:> I<number>	926	=item B<saveLines:> I<number>
871		927
872	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>.
873	resource is limited on most machines to 65535; option B<-sl>.
874		929
875	=item B<internalBorder:> I<number>	930	=item B<internalBorder:> I<number>
876		931
877	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;
878	option B<-b>.	933	option B<-b>.
…		…
941		996
942	=item B<pointerColor2:> I<colour>	997	=item B<pointerColor2:> I<colour>
943		998
944	Mouse pointer background colour.	999	Mouse pointer background colour.
945		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
946	=item B<pointerBlankDelay:> I<number>	1007	=item B<pointerBlankDelay:> I<number>
947		1008
948	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
949	large number (e.g. C<987654321>) to effectively disable the timeout.	1010	large number (e.g. C<987654321>) to effectively disable the timeout.
950		1011
…		…
976		1037
977	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1038	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
978		1039
979	=item B<preeditType:> I<style>	1040	=item B<preeditType:> I<style>
980		1041
981	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1042	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
982		1043
983	=item B<inputMethod:> I<name>	1044	=item B<inputMethod:> I<name>
984		1045
985	I<name> of inputMethod to use; option B<-im>.	1046	I<name> of inputMethod to use; option B<-im>.
986		1047
…		…
1004		1065
1005	Change the meaning of triple-click selection with the left mouse	1066	Change the meaning of triple-click selection with the left mouse
1006	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
1007	the end of the logical line only; option B<-tcw>.	1068	the end of the logical line only; option B<-tcw>.
1008		1069
		1070	=item B<disablePasteBrackets:> I<boolean>
		1071
		1072	Prevent emission of paste bracket sequences; option B<-dpb>.
		1073
1009	=item B<insecure:> I<boolean>	1074	=item B<insecure:> I<boolean>
1010		1075
1011	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1076	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1012	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
1013	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
1014	through a mail client displaying mail bodies unfiltered or through	1079	through a mail client displaying mail bodies unfiltered or through
1015	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
1016	default. (Note that many other terminals, including xterm, have these	1081	default. (Note that many other terminals, including xterm, have these
…		…
1034		1099
1035	=item B<secondaryScreen:> I<boolean>	1100	=item B<secondaryScreen:> I<boolean>
1036		1101
1037	Turn on/off secondary screen (default enabled).	1102	Turn on/off secondary screen (default enabled).
1038		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
1039	=item B<secondaryScroll:> I<boolean>	1109	=item B<secondaryScroll:> I<boolean>
1040		1110
1041	Turn on/off secondary screen scroll (default enabled). If this	1111	Turn on/off secondary screen scroll (default enabled). If this
1042	option is enabled, scrolls on the secondary screen will change the	1112	option is enabled, scrolls on the secondary screen will change the
1043	scrollback buffer and, when secondaryScreen is off, switching	1113	scrollback buffer and, when secondaryScreen is off, switching
…		…
1070		1140
1071	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:
1072		1142
1073	(modifiers-)key	1143	(modifiers-)key
1074		1144
1075	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
1076	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1146	abbreviated modifier names:
1077	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1147
1078	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
1079		1164
1080	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
1081	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
1082	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
1083	current application keymap mode state.	1168	current application keymap mode state.
…		…
1106	prefixed with C<string:>).	1191	prefixed with C<string:>).
1107		1192
1108	The following action prefixes are known - extensions can provide	1193	The following action prefixes are known - extensions can provide
1109	additional prefixes:	1194	additional prefixes:
1110		1195
1111	=over 4	1196	=over
1112		1197
1113	=item string:STRING	1198	=item string:STRING
1114		1199
1115	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),
1116	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
…		…
1118	string C<echo rm -rf /> followed by a newline:	1203	string C<echo rm -rf /> followed by a newline:
1119		1204
1120	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1205	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1121		1206
1122	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>
1123		1223
1124	=item command:STRING	1224	=item command:STRING
1125		1225
1126	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>
1127	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically	1227	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
…		…
1192	URxvt.keysym.C-M-c: builtin-string:	1292	URxvt.keysym.C-M-c: builtin-string:
1193	URxvt.keysym.C-M-v: builtin-string:	1293	URxvt.keysym.C-M-v: builtin-string:
1194		1294
1195	=item EXTENSION:STRING	1295	=item EXTENSION:STRING
1196		1296
1197	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
1198	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
1199	necessary.	1299	be loaded automatically if necessary.
1200		1300
1201	Not all extensions define key actions, but popular extensions that do	1301	Not all extensions define actions, but popular extensions that do
1202	include the I<selection> and I<matcher> extensions (documented in their	1302	include the I<selection> and I<matcher> extensions (documented in their
1203	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1303	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1204	respectively).	1304	respectively).
1205		1305
1206	From the silly examples department, this will rot13-"encrypt"	1306	From the silly examples department, this will rot13-"encrypt"
…		…
1209		1309
1210	URxvt.keysym.M-C-c: selection:rot13	1310	URxvt.keysym.M-C-c: selection:rot13
1211		1311
1212	=item perl:STRING DEPRECATED	1312	=item perl:STRING DEPRECATED
1213		1313
1214	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
1215	still supported, but should not be used anymore.	1315	extensions. It is still supported, but should not be used anymore.
1216		1316
1217	=back	1317	=back
1218		1318
1219	=item B<perl-ext-common>: I<string>	1319	=item B<perl-ext-common>: I<string>
1220		1320
1221	=item B<perl-ext>: I<string>	1321	=item B<perl-ext>: I<string>
1222		1322
1223	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
1224	use in this terminal instance; option B<-pe>.	1324	use in this terminal instance; option B<-pe>.
1225		1325
1226	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
1227	them. This can be useful to selectively disable some extensions loaded	1327	case they had been specified earlier. This can be useful to selectively
1228	by default, or specified via the C<perl-ext-common> resource. For	1328	disable some extensions loaded by default, or specified via the
1229	example, C<default,-selection> will use all the default extensions except	1329	C<perl-ext-common> resource. For example, C<default,-selection> will use
1230	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.
1231		1339
1232	The default set includes the C<selection>, C<option-popup>,	1340	The default set includes the C<selection>, C<option-popup>,
1233	C<selection-popup> and C<readline> extensions, any extensions that define	1341	C<selection-popup>, C<readline>, C<searchable-scrollback> and
1234	keybindings via C<BINDING> meta comments, extensions loaded because	1342	C<confirm-paste> extensions, as well as any extensions which are mentioned
1235	their resources/commandline switches were used, and extensions which are
1236	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>.
1237		1347
1238	Each extension is looked up in the library directories, loaded if	1348	Each extension is looked up in the library directories, loaded if
1239	necessary, and bound to the current terminal instance. When the library	1349	necessary, and bound to the current terminal instance. When the library
1240	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
1241	first one found will be used.	1351	first one found will be used.
…		…
1295	Turn on/off ISO 14755 (default enabled).	1405	Turn on/off ISO 14755 (default enabled).
1296		1406
1297	=item B<iso14755_52:> I<boolean>	1407	=item B<iso14755_52:> I<boolean>
1298		1408
1299	Turn on/off ISO 14755 5.2 mode (default enabled).	1409	Turn on/off ISO 14755 5.2 mode (default enabled).
1300
1301	=back
1302
1303	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1304
1305	=over 4
1306
1307	=item B<-pixmap> I<file[;oplist]>
1308
1309	=item B<backgroundPixmap:> I<file[;oplist]>
1310
1311	Compile I<pixbuf>: Use the specified image file as the window's
1312	background and also optionally specify a colon separated list of
1313	operations to modify it. Note that you may need to quote the C<;>
1314	character when using the command line option, as C<;> is usually a
1315	metacharacter in shells. Supported operations are:
1316
1317	=over 4
1318
1319	=item B<WxH+X+Y>
1320
1321	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1322	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1323	scale of 0 disables scaling.
1324
1325	=item B<op=tile>
1326
1327	enables tiling
1328
1329	=item B<op=keep-aspect>
1330
1331	maintain the image aspect ratio when scaling
1332
1333	=item B<op=root-align>
1334
1335	use the position of the terminal window relative to the root window as
1336	the image offset, simulating a root window background
1337
1338	=back
1339
1340	The default scale and position setting is C<100x100+50+50>.
1341	Alternatively, a predefined set of templates can be used to achieve
1342	the most common setups:
1343
1344	=over 4
1345
1346	=item B<style=tiled>
1347
1348	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1349
1350	=item B<style=aspect-stretched>
1351
1352	the image is scaled to fill the whole window maintaining the aspect
1353	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1354
1355	=item B<style=stretched>
1356
1357	the image is scaled to fill the whole window. Equivalent to 100x100
1358
1359	=item B<style=centered>
1360
1361	the image is centered with no scaling. Equivalent to 0x0+50+50
1362
1363	=item B<style=root-tiled>
1364
1365	the image is tiled with no scaling and using 'root' positioning.
1366	Equivalent to 0x0:op=tile:op=root-align
1367
1368	=back
1369
1370	If multiple templates are specified the last one wins. Note that a
1371	template overrides all the scale, position and operations settings.
1372
1373	If used in conjunction with pseudo-transparency, the specified pixmap
1374	will be blended over the transparent background using alpha-blending.
1375
1376	=item B<-tr>\|B<+tr>
1377
1378	=item B<transparent:> I<boolean>
1379
1380	Turn on/off pseudo-transparency by using the root pixmap as background.
1381
1382	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1383	will be removed in future versions.
1384
1385	=item B<-tint> I<colour>
1386
1387	=item B<tintColor:> I<colour>
1388
1389	Tint the transparent background with the given colour. Note that a
1390	black tint yields a completely black image while a white tint yields
1391	the image unchanged.
1392
1393	=item B<-sh> I<number>
1394
1395	=item B<shading:> I<number>
1396
1397	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1398	A value of 100 means no shading.
1399
1400	=item B<-blr> I<HxV>
1401
1402	=item B<blurRadius:> I<HxV>
1403
1404	Apply gaussian blur with the specified radius to the transparent
1405	background. If a single number is specified, the vertical and
1406	horizontal radii are considered to be the same. Setting one of the
1407	radii to 1 and the other to a large number creates interesting effects
1408	on some backgrounds. The maximum radius value is 128. An horizontal or
1409	vertical radius of 0 disables blurring.
1410
1411	=item B<path:> I<path>
1412
1413	Specify the colon-delimited search path for finding background image files.
1414		1410
1415	=back	1411	=back
1416		1412
1417	=head1 THE SCROLLBAR	1413	=head1 THE SCROLLBAR
1418		1414
…		…
1442	=head1 THE SELECTION: SELECTING AND PASTING TEXT	1438	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1443		1439
1444	The behaviour of text selection and insertion/pasting mechanism is similar	1440	The behaviour of text selection and insertion/pasting mechanism is similar
1445	to I<xterm>(1).	1441	to I<xterm>(1).
1446		1442
1447	=over 4	1443	=over
1448		1444
1449	=item B<Selecting>:	1445	=item B<Selecting>:
1450		1446
1451	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
1452	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
…		…
1468		1464
1469	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
1470	inserted too.	1466	inserted too.
1471		1467
1472	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and	1468	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1473	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first	1469	B<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1474	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
1475	CLIPBOARD selection, while the second binding causes the value of the	1471	CLIPBOARD selection, while the second binding causes the value of the
1476	CLIPBOARD selection to be inserted.	1472	CLIPBOARD selection to be inserted.
1477		1473
1478	=back	1474	=back
…		…
1499	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
1500	first part is available if rxvt-unicode has been compiled with	1496	first part is available if rxvt-unicode has been compiled with
1501	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
1502	with C<--enable-iso14755>.	1498	with C<--enable-iso14755>.
1503		1499
1504	=over 4	1500	=over
1505		1501
1506	=item * 5.1: Basic method	1502	=item * 5.1: Basic method
1507		1503
1508	This allows you to enter unicode characters using their hexcode.	1504	This allows you to enter unicode characters using their hexcode.
1509		1505
…		…
1570	In addition to the default foreground and background colours,	1566	In addition to the default foreground and background colours,
1571	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
1572	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
1573	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
1574	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.
1575		1580
1576	Here is a list of the ANSI colours with their names.	1581	Here is a list of the ANSI colours with their names.
1577		1582
1578	=begin table	1583	=begin table
1579		1584
…		…
1680		1685
1681	=head1 ENVIRONMENT	1686	=head1 ENVIRONMENT
1682		1687
1683	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1688	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1684		1689
1685	=over 4	1690	=over
1686		1691
1687	=item B<TERM>	1692	=item B<TERM>
1688		1693
1689	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
1690	resources or on the command line.	1695	resources or on the command line.
…		…
1761		1766
1762	=back	1767	=back
1763		1768
1764	=head1 FILES	1769	=head1 FILES
1765		1770
1766	=over 4	1771	=over
1767		1772
1768	=item B</usr/lib/X11/rgb.txt>	1773	=item B</usr/lib/X11/rgb.txt>
1769		1774
1770	Colour names.	1775	Colour names.
1771		1776
…		…
1776	@@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),
1777	@@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)
1778		1783
1779	=head1 CURRENT PROJECT COORDINATOR	1784	=head1 CURRENT PROJECT COORDINATOR
1780		1785
1781	=over 4	1786	=over
1782		1787
1783	=item Project Coordinator	1788	=item Project Coordinator
1784		1789
1785	Marc A. Lehmann <rxvt-unicode@schmorp.de>.	1790	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1786		1791
…		…
1788		1793
1789	=back	1794	=back
1790		1795
1791	=head1 AUTHORS	1796	=head1 AUTHORS
1792		1797
1793	=over 4	1798	=over
1794		1799
1795	=item John Bovey	1800	=item John Bovey
1796		1801
1797	University of Kent, 1992, wrote the original Xvt.	1802	University of Kent, 1992, wrote the original Xvt.
1798		1803

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.237 by sf-exg, Thu Aug 21 19:21:14 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.237 by sf-exg, Thu Aug 21 19:21:14 2014 UTC vs.
Revision 1.263 by sf-exg, Sat Jan 20 08:00:50 2024 UTC