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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC

…		…
108	of graphical corruption. This is harmless, but we can't do anything about	108	of graphical corruption. This is harmless, but we can't do anything about
109	this, so watch out]	109	this, so watch out]
110		110
111	=item B<-visual> I<visualID>	111	=item B<-visual> I<visualID>
112		112
113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible	113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114	visual ids).	114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
115		116
116	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
117		118
118	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
119		120
…		…
219		220
220	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
221		222
222	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
223		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
224	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
225		230
226	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227	B<utmpInhibit>.	232	B<utmpInhibit>.
228		233
…		…
306		311
307	=item B<-override-redirect>	312	=item B<-override-redirect>
308		313
309	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
310	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.
311		321
312	=item B<-sbg>	322	=item B<-sbg>
313		323
314	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
315	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
…		…
370	=item B<-pt> I<style>	380	=item B<-pt> I<style>
371		381
372	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
373	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
374		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
375	=item B<-im> I<text>	388	=item B<-im> I<text>
376		389
377	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
378		391
379	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
393	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
394	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
395	in-use. Instead of selecting a full line it will extend the selection to	408	in-use. Instead of selecting a full line it will extend the selection to
396	the end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
397		410
		411	=item B<-dpb>\|B<+dpb>
		412
		413	Compile frills: Disables (or enabled) emitting bracketed paste mode
		414	sequences (default enabled). Bracketed paste mode allows programs
		415	to detect when something is pasted. Since more and more programs
		416	abuse this, these sequences can be disabled. The command sequences to
		417	enable and query paste mode will still work, but the actual bracket
		418	sequences will no longer be omitted. You can also toggle this from the
		419	ctrl-middle-mouse-button menu; resource B<disablePAsteBrackets>.
		420
398	=item B<-insecure>	421	=item B<-insecure>
399		422
400	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
401	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
402	info.	425	info.
…		…
414		437
415	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
416		439
417	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
418	B<secondaryScroll>.	441	B<secondaryScroll>.
		442
		443	=item B<-rm> I<mode>
		444
		445	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		446	to one of B<auto> (the default), B<always> or B<never>. The latter two
		447	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		448	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		449	B<rewrapMode>.
419		450
420	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
421		452
422	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	453	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
423	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
…		…
781		812
782	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	813	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
783	the shell; option B<-ls>. B<False>: start as a normal sub-shell	814	the shell; option B<-ls>. B<False>: start as a normal sub-shell
784	[default]; option B<+ls>.	815	[default]; option B<+ls>.
785		816
		817	=item B<multiClickTime:> I<number>
		818
		819	Specify the maximum time in milliseconds between multi-click select
		820	events. The default is 500 milliseconds; option B<-mc>.
		821
786	=item B<utmpInhibit:> I<boolean>	822	=item B<utmpInhibit:> I<boolean>
787		823
788	B<True>: inhibit writing record into the system log file B<utmp>;	824	B<True>: inhibit writing record into the system log file B<utmp>;
789	option B<-ut>. B<False>: write record into the system log file B<utmp>	825	option B<-ut>. B<False>: write record into the system log file B<utmp>
790	[default]; option B<+ut>.	826	[default]; option B<+ut>.
…		…
853	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	889	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
854	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
855		891
856	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
857		893
858	Save I<number> lines in the scrollback buffer [default 64]. This	894	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
859	resource is limited on most machines to 65535; option B<-sl>.
860		895
861	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
862		897
863	Internal border of I<number> pixels. This resource is limited to 100;	898	Internal border of I<number> pixels. This resource is limited to 100;
864	option B<-b>.	899	option B<-b>.
…		…
927		962
928	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
929		964
930	Mouse pointer background colour.	965	Mouse pointer background colour.
931		966
		967	=item B<pointerShape:> I<string>
		968
		969	Compile I<frills>: Specifies the name of the mouse pointer shape
		970	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		971	file for possible values (omit the C<XC_> prefix).
		972
932	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
933		974
934	Specifies number of seconds before blanking the pointer [default 2]. Use a	975	Specifies number of seconds before blanking the pointer [default 2]. Use a
935	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
936		977
…		…
962		1003
963	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1004	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
964		1005
965	=item B<preeditType:> I<style>	1006	=item B<preeditType:> I<style>
966		1007
967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1008	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968		1009
969	=item B<inputMethod:> I<name>	1010	=item B<inputMethod:> I<name>
970		1011
971	I<name> of inputMethod to use; option B<-im>.	1012	I<name> of inputMethod to use; option B<-im>.
972		1013
…		…
989	=item B<tripleclickwords:> I<boolean>	1030	=item B<tripleclickwords:> I<boolean>
990		1031
991	Change the meaning of triple-click selection with the left mouse	1032	Change the meaning of triple-click selection with the left mouse
992	button. Instead of selecting a full line it will extend the selection to	1033	button. Instead of selecting a full line it will extend the selection to
993	the end of the logical line only; option B<-tcw>.	1034	the end of the logical line only; option B<-tcw>.
		1035
		1036	=item B<disablePasteBrackets:> I<boolean>
		1037
		1038	Prevents emission of paste bracket sequences; option B<-dpb>.
994		1039
995	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
996		1041
997	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
998	echo arbitrary strings like the icon name or the locale. This could be	1043	echo arbitrary strings like the icon name or the locale. This could be
…		…
1020		1065
1021	=item B<secondaryScreen:> I<boolean>	1066	=item B<secondaryScreen:> I<boolean>
1022		1067
1023	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
1024		1069
		1070	=item B<rewrapMode:> I<mode>
		1071
		1072	Sets long line rewrap behaviour on window resize to one of B<auto>
		1073	(default), B<always> or B<never>.
		1074
1025	=item B<secondaryScroll:> I<boolean>	1075	=item B<secondaryScroll:> I<boolean>
1026		1076
1027	Turn on/off secondary screen scroll (default enabled). If this	1077	Turn on/off secondary screen scroll (default enabled). If this
1028	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
1029	scrollback buffer and, when secondaryScreen is off, switching	1079	scrollback buffer and, when secondaryScreen is off, switching
…		…
1055	extension might provide.	1105	extension might provide.
1056		1106
1057	The key combination that triggers the action, I<sym>, has the following format:	1107	The key combination that triggers the action, I<sym>, has the following format:
1058		1108
1059	(modifiers-)key	1109	(modifiers-)key
1060		1110
1061	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,	1111	Where I<modifiers> can be any combination of the following full or
1062	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1112	abbreviated modifier names:
1063	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1113
1064	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.	1114	=begin table
		1115
		1116	B<ISOLevel3> B<I>
		1117	B<AppKeypad> B<K>
		1118	B<Control> B<C>
		1119	B<NumLock> B<N>
		1120	B<Shift> B<S>
		1121	B<Meta> B<M> I<or> B<A>
		1122	B<Lock> B<L>
		1123	B<Mod1> B<1>
		1124	B<Mod2> B<2>
		1125	B<Mod3> B<3>
		1126	B<Mod4> B<4>
		1127	B<Mod5> B<5>
		1128
		1129	=end table
1065		1130
1066	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1131	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1067	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1132	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1068	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1133	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1069	current application keymap mode state.	1134	current application keymap mode state.
…		…
1085	As with any resource value, the I<action> string may contain backslash	1150	As with any resource value, the I<action> string may contain backslash
1086	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal	1151	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087	number), see RESOURCES in C<man 7 X> for further details.	1152	number), see RESOURCES in C<man 7 X> for further details.
1088		1153
1089	An action starts with an action prefix that selects a certain type	1154	An action starts with an action prefix that selects a certain type
1090	of action, followed by a colon. An action strings without colons is	1155	of action, followed by a colon. An action string without colons is
1091	interpreted as a literal string to pass to the tty (as if they were	1156	interpreted as a literal string to pass to the tty (as if it was
1092	prefixed with C<string:>).	1157	prefixed with C<string:>).
1093		1158
1094	The following action prefixes are known - extensions can provide	1159	The following action prefixes are known - extensions can provide
1095	additional prefixes:	1160	additional prefixes:
1096		1161
…		…
1104	string C<echo rm -rf /> followed by a newline:	1169	string C<echo rm -rf /> followed by a newline:
1105		1170
1106	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1171	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107		1172
1108	This could in theory be used to completely redefine your keymap.	1173	This could in theory be used to completely redefine your keymap.
		1174
		1175	In addition, for actions of this type, you can define a range of
		1176	keysyms in one shot by loading the C<keysym-list> perl extension and
		1177	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
		1178	the delimiter `/' should be a character not used by the strings.
		1179
		1180	Its usage can be demonstrated by an example:
		1181
		1182	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
		1183
		1184	The above line is equivalent to the following three lines:
		1185
		1186	URxvt.keysym.Meta-Control-0x61: string:\033<a>
		1187	URxvt.keysym.Meta-Control-0x62: string:\033<b>
		1188	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1109		1189
1110	=item command:STRING	1190	=item command:STRING
1111		1191
1112	If I<action> takes the form of C<command:STRING>, the specified B<STRING>	1192	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1113	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically	1193	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
…		…
1149		1229
1150	The first line defines a mapping for C<Insert> and I<any> combination	1230	The first line defines a mapping for C<Insert> and I<any> combination
1151	of modifiers. The second line re-establishes the default mapping for	1231	of modifiers. The second line re-establishes the default mapping for
1152	C<Shift-Insert>.	1232	C<Shift-Insert>.
1153		1233
		1234	=item builtin-string:
		1235
		1236	This action is mainly useful to restore string mappings for keys that
		1237	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1238	difficult to explain - basically, this action will send the string to the
		1239	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1240	action for it.
		1241
		1242	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
		1243	selection when you press C<Shift-Insert>. With the following bindings, it
		1244	would instead emit the (undocumented, but what applications running in the
		1245	terminal might expect) sequence C<ESC [ 2 $> instead:
		1246
		1247	URxvt.keysym.S-Insert: builtin-string:
		1248	URxvt.keysym.C-S-Insert: builtin:
		1249
		1250	The first line disables the paste functionality for that key
		1251	combination, and the second reinstates the default behaviour for
		1252	C<Control-Shift-Insert>, which would otherwise be overridden.
		1253
		1254	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1255	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1256	this:
		1257
		1258	URxvt.keysym.C-M-c: builtin-string:
		1259	URxvt.keysym.C-M-v: builtin-string:
		1260
1154	=item EXTENSION:STRING	1261	=item EXTENSION:STRING
1155		1262
1156	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)	1263	An action of this form invokes the action B<STRING>, if any, provided
1157	extension of the same name. The extension will be loaded automatically if	1264	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1158	neccessary.	1265	be loaded automatically if necessary.
1159		1266
1160	Not all extensions define key actions, but popular extensions that do	1267	Not all extensions define actions, but popular extensions that do
1161	include the I<selection> and I<matcher> extensions (documented in their	1268	include the I<selection> and I<matcher> extensions (documented in their
1162	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1269	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1163	respectively).	1270	respectively).
1164		1271
1165	From the silly examples department, this will rot13-"encrypt"	1272	From the silly examples department, this will rot13-"encrypt"
1166	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC	1273	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1167	keyboards:	1274	keyboards:
1168		1275
1169	URxvt.keysym.M-C-c: selection:rot13	1276	URxvt.keysym.M-C-c: selection:rot13
1170		1277
1171	=item perl:STRING	1278	=item perl:STRING DEPRECATED
1172		1279
1173	This is a deprecated way of passing key mappings to perl extensions. It is	1280	This is a deprecated way of invoking commands provided by perl
1174	still supported, but should not be used anymore.	1281	extensions. It is still supported, but should not be used anymore.
1175		1282
1176	=back	1283	=back
1177
1178	In addition, you can define a range of keysyms in one shot by loading
1179	the C<keysym-list> perl extension and providing a I<string> with pattern
1180	B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1181	character not used by the strings.
1182
1183	Its usage can be demonstrated by an example:
1184
1185	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1186
1187	The above line is equivalent to the following three lines:
1188
1189	URxvt.keysym.Meta-Control-0x61: \033<a>
1190	URxvt.keysym.Meta-Control-0x62: \033<b>
1191	URxvt.keysym.Meta-Control-0x63: \033<c>
1192		1284
1193	=item B<perl-ext-common>: I<string>	1285	=item B<perl-ext-common>: I<string>
1194		1286
1195	=item B<perl-ext>: I<string>	1287	=item B<perl-ext>: I<string>
1196		1288
…		…
1198	use in this terminal instance; option B<-pe>.	1290	use in this terminal instance; option B<-pe>.
1199		1291
1200	Extension names can be prefixed with a C<-> sign to prohibit using	1292	Extension names can be prefixed with a C<-> sign to prohibit using
1201	them. This can be useful to selectively disable some extensions loaded	1293	them. This can be useful to selectively disable some extensions loaded
1202	by default, or specified via the C<perl-ext-common> resource. For	1294	by default, or specified via the C<perl-ext-common> resource. For
1203	example, C<default,-selection> will use all the default extension except	1295	example, C<default,-selection> will use all the default extensions except
1204	C<selection>.	1296	C<selection>.
1205		1297
1206	Extension names can also be followed by an argument in angle brackets	1298	The default set includes the C<selection>, C<option-popup>,
1207	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1299	C<selection-popup>, C<readline> and C<searchable-scrollback>
1208	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1300	extensions, and extensions which are mentioned in B<keysym> resources.
1209	multiple times with different arguments will pass multiple arguments to	1301
1210	the extension.	1302	Any extension such that a corresponding resource is given on the
		1303	command line is automatically appended to B<perl-ext>.
1211		1304
1212	Each extension is looked up in the library directories, loaded if	1305	Each extension is looked up in the library directories, loaded if
1213	necessary, and bound to the current terminal instance.	1306	necessary, and bound to the current terminal instance. When the library
		1307	search path contains multiple extension files of the same name, then the
		1308	first one found will be used.
1214		1309
1215	If both of these resources are the empty string, then the perl	1310	If both of these resources are the empty string, then the perl interpreter
1216	interpreter will not be initialized. The idea behind two options is that	1311	will not be initialized. The rationale for having two options is that
1217	B<perl-ext-common> will be used for extensions that should be available to	1312	B<perl-ext-common> will be used for extensions that should be available to
1218	all instances, while B<perl-ext> is used for specific instances.	1313	all instances, while B<perl-ext> is used for specific instances.
1219		1314
1220	=item B<perl-eval>: I<string>	1315	=item B<perl-eval>: I<string>
1221		1316
…		…
1239	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1334	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1240		1335
1241	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1336	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1242	for details.	1337	for details.
1243		1338
1244	=item B<searchable-scrollback:> I<keysym>	1339	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1245		1340
1246	Sets the hotkey that starts the incremental scrollback buffer search	1341	This resource is deprecated and will be removed. Use a B<keysym> resource
1247	(default: C<M-s>).	1342	instead, e.g.:
		1343
		1344	URxvt.keysym.M-s: searchable-scrollback:start
1248		1345
1249	=item B<url-launcher>: I<string>	1346	=item B<url-launcher>: I<string>
1250		1347
1251	Specifies the program to be started with a URL argument. Used by the	1348	Specifies the program to be started with a URL argument. Used by the
1252	C<selection-popup> and C<matcher> perl extensions.	1349	C<selection-popup> and C<matcher> perl extensions.
…		…
1265	Turn on/off ISO 14755 (default enabled).	1362	Turn on/off ISO 14755 (default enabled).
1266		1363
1267	=item B<iso14755_52:> I<boolean>	1364	=item B<iso14755_52:> I<boolean>
1268		1365
1269	Turn on/off ISO 14755 5.2 mode (default enabled).	1366	Turn on/off ISO 14755 5.2 mode (default enabled).
1270
1271	=back
1272
1273	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1274
1275	=over 4
1276
1277	=item B<-pixmap> I<file[;oplist]>
1278
1279	=item B<backgroundPixmap:> I<file[;oplist]>
1280
1281	Compile I<pixbuf>: Use the specified image file as the window's
1282	background and also optionally specify a colon separated list of
1283	operations to modify it. Note that you may need to quote the C<;>
1284	character when using the command line option, as C<;> is usually a
1285	metacharacter in shells. Supported operations are:
1286
1287	=over 4
1288
1289	=item B<WxH+X+Y>
1290
1291	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1292	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1293	scale of 0 disables scaling.
1294
1295	=item B<op=tile>
1296
1297	enables tiling
1298
1299	=item B<op=keep-aspect>
1300
1301	maintain the image aspect ratio when scaling
1302
1303	=item B<op=root-align>
1304
1305	use the position of the terminal window relative to the root window as
1306	the image offset, simulating a root window background
1307
1308	=back
1309
1310	The default scale and position setting is C<100x100+50+50>.
1311	Alternatively, a predefined set of templates can be used to achieve
1312	the most common setups:
1313
1314	=over 4
1315
1316	=item B<style=tiled>
1317
1318	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1319
1320	=item B<style=aspect-stretched>
1321
1322	the image is scaled to fill the whole window maintaining the aspect
1323	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1324
1325	=item B<style=stretched>
1326
1327	the image is scaled to fill the whole window. Equivalent to 100x100
1328
1329	=item B<style=centered>
1330
1331	the image is centered with no scaling. Equivalent to 0x0+50+50
1332
1333	=item B<style=root-tiled>
1334
1335	the image is tiled with no scaling and using 'root' positioning.
1336	Equivalent to 0x0:op=tile:op=root-align
1337
1338	=back
1339
1340	If multiple templates are specified the last one wins. Note that a
1341	template overrides all the scale, position and operations settings.
1342
1343	If used in conjunction with pseudo-transparency, the specified pixmap
1344	will be blended over the transparent background using alpha-blending.
1345
1346	=item B<-tr>\|B<+tr>
1347
1348	=item B<transparent:> I<boolean>
1349
1350	Turn on/off pseudo-transparency by using the root pixmap as background.
1351
1352	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1353	will be removed in future versions.
1354
1355	=item B<-tint> I<colour>
1356
1357	=item B<tintColor:> I<colour>
1358
1359	Tint the transparent background with the given colour. Note that a
1360	black tint yields a completely black image while a white tint yields
1361	the image unchanged.
1362
1363	=item B<-sh> I<number>
1364
1365	=item B<shading:> I<number>
1366
1367	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1368	A value of 100 means no shading.
1369
1370	=item B<-blr> I<HxV>
1371
1372	=item B<blurRadius:> I<HxV>
1373
1374	Apply gaussian blur with the specified radius to the transparent
1375	background. If a single number is specified, the vertical and
1376	horizontal radii are considered to be the same. Setting one of the
1377	radii to 1 and the other to a large number creates interesting effects
1378	on some backgrounds. The maximum radius value is 128. An horizontal or
1379	vertical radius of 0 disables blurring.
1380
1381	=item B<path:> I<path>
1382
1383	Specify the colon-delimited search path for finding background image files.
1384		1367
1385	=back	1368	=back
1386		1369
1387	=head1 THE SCROLLBAR	1370	=head1 THE SCROLLBAR
1388		1371
…		…
1540	In addition to the default foreground and background colours,	1523	In addition to the default foreground and background colours,
1541	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1524	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1542	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1525	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1543	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1526	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1544	cube plus a 8 (24) colour greyscale ramp.	1527	cube plus a 8 (24) colour greyscale ramp.
		1528
		1529	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1530	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1531	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1532	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1533	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1534	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1535	use many similar 24-bit colours. It's typically not a problem in common
		1536	scenarios.
1545		1537
1546	Here is a list of the ANSI colours with their names.	1538	Here is a list of the ANSI colours with their names.
1547		1539
1548	=begin table	1540	=begin table
1549		1541

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs. Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC