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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC vs.
Revision 1.255 by root, Sat Jul 24 11:00:58 2021 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
…		…
406	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
407	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
408	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
409	the end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
410		410
		411	=item B<-dpb>\|B<+dpb>
		412
		413	Compile frills: Disable (or enable) emitting bracketed paste mode
		414	sequences (default enabled). Bracketed paste mode allows programs
		415	to detect when something is pasted. Since more and more programs
		416	abuse this, these sequences can be disabled. The command sequences to
		417	enable and query paste mode will still work, but the actual bracket
		418	sequences will no longer be emitted. You can also toggle this from the
		419	ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
		420
411	=item B<-insecure>	421	=item B<-insecure>
412		422
413	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
414	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
415	info.	425	info.
…		…
427		437
428	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
429		439
430	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
431	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>.
432		450
433	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
434		452
435	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@@
436	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
…		…
551	be used. Command-line arguments can be used to override resource	569	be used. Command-line arguments can be used to override resource
552	settings. The following resources are supported (you might want to	570	settings. The following resources are supported (you might want to
553	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	571	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554	extensions not documented here):	572	extensions not documented here):
555		573
556	=over 4	574	=over
557		575
558	=item B<depth:> I<bitdepth>	576	=item B<depth:> I<bitdepth>
559		577
560	Compile I<xft>: Attempt to find a visual with the given bit depth;	578	Compile I<xft>: Attempt to find a visual with the given bit depth;
561	option B<-depth>.	579	option B<-depth>.
…		…
871	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
872	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
873		891
874	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
875		893
876	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>.
877	resource is limited on most machines to 65535; option B<-sl>.
878		895
879	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
880		897
881	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;
882	option B<-b>.	899	option B<-b>.
…		…
944	Mouse pointer foreground colour.	961	Mouse pointer foreground colour.
945		962
946	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
947		964
948	Mouse pointer background colour.	965	Mouse pointer background colour.
		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).
949		972
950	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
951		974
952	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
953	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
…		…
1008		1031
1009	Change the meaning of triple-click selection with the left mouse	1032	Change the meaning of triple-click selection with the left mouse
1010	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
1011	the end of the logical line only; option B<-tcw>.	1034	the end of the logical line only; option B<-tcw>.
1012		1035
		1036	=item B<disablePasteBrackets:> I<boolean>
		1037
		1038	Prevent emission of paste bracket sequences; option B<-dpb>.
		1039
1013	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
1014		1041
1015	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1016	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
1017	abused if somebody gets 8-bit-clean access to your display, whether	1044	abused if somebody gets 8-bit-clean access to your display, whether
1018	through a mail client displaying mail bodies unfiltered or through	1045	through a mail client displaying mail bodies unfiltered or through
1019	write(1) or any other means. Therefore, these sequences are disabled by	1046	write(1) or any other means. Therefore, these sequences are disabled by
1020	default. (Note that many other terminals, including xterm, have these	1047	default. (Note that many other terminals, including xterm, have these
…		…
1038		1065
1039	=item B<secondaryScreen:> I<boolean>	1066	=item B<secondaryScreen:> I<boolean>
1040		1067
1041	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
1042		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
1043	=item B<secondaryScroll:> I<boolean>	1075	=item B<secondaryScroll:> I<boolean>
1044		1076
1045	Turn on/off secondary screen scroll (default enabled). If this	1077	Turn on/off secondary screen scroll (default enabled). If this
1046	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
1047	scrollback buffer and, when secondaryScreen is off, switching	1079	scrollback buffer and, when secondaryScreen is off, switching
…		…
1074		1106
1075	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:
1076		1108
1077	(modifiers-)key	1109	(modifiers-)key
1078		1110
1079	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
1080	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1112	abbreviated modifier names:
1081	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1113
1082	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
1083		1130
1084	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
1085	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
1086	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
1087	current application keymap mode state.	1134	current application keymap mode state.
…		…
1110	prefixed with C<string:>).	1157	prefixed with C<string:>).
1111		1158
1112	The following action prefixes are known - extensions can provide	1159	The following action prefixes are known - extensions can provide
1113	additional prefixes:	1160	additional prefixes:
1114		1161
1115	=over 4	1162	=over
1116		1163
1117	=item string:STRING	1164	=item string:STRING
1118		1165
1119	If the I<action> starts with C<string:> (or otherwise contains no colons),	1166	If the I<action> starts with C<string:> (or otherwise contains no colons),
1120	then the remaining C<STRING> will be passed to the program running in the	1167	then the remaining C<STRING> will be passed to the program running in the
…		…
1240	=item B<perl-ext>: I<string>	1287	=item B<perl-ext>: I<string>
1241		1288
1242	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1289	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1243	use in this terminal instance; option B<-pe>.	1290	use in this terminal instance; option B<-pe>.
1244		1291
1245	Extension names can be prefixed with a C<-> sign to prohibit using	1292	Extension names can be prefixed with a C<-> sign to remove them again, in
1246	them. This can be useful to selectively disable some extensions loaded	1293	case they had been specified earlier. This can be useful to selectively
1247	by default, or specified via the C<perl-ext-common> resource. For	1294	disable some extensions loaded by default, or specified via the
1248	example, C<default,-selection> will use all the default extensions except	1295	C<perl-ext-common> resource. For example, C<default,-selection> will use
1249	C<selection>.	1296	all the default extensions except C<selection>.
		1297
		1298	To prohibit autoloading of extensions, you can prefix them with C</>,
		1299	which will make urxvt refuse to automatically load them (this can be
		1300	overriden, however, by specifying the extension name again without a
		1301	prefix, though). This does not prohibit extensions themselves loading
		1302	other extensions. For example, C<default,/background> will keep the
		1303	C<background> extension from being loaded when a background OSC sequence
		1304	is received.
1250		1305
1251	The default set includes the C<selection>, C<option-popup>,	1306	The default set includes the C<selection>, C<option-popup>,
1252	C<selection-popup>, C<readline> and C<searchable-scrollback>	1307	C<selection-popup>, C<readline>, C<searchable-scrollback> and
1253	extensions, and extensions which are mentioned in B<keysym> resources.	1308	C<confirm-paste> extensions, as well as any extensions which are mentioned
		1309	in B<keysym> resources.
1254		1310
1255	Any extension such that a corresponding resource is given on the	1311	Any extension such that a corresponding resource is given on the
1256	command line is automatically appended to B<perl-ext>.	1312	command line is automatically appended to B<perl-ext>.
1257		1313
1258	Each extension is looked up in the library directories, loaded if	1314	Each extension is looked up in the library directories, loaded if
…		…
1315	Turn on/off ISO 14755 (default enabled).	1371	Turn on/off ISO 14755 (default enabled).
1316		1372
1317	=item B<iso14755_52:> I<boolean>	1373	=item B<iso14755_52:> I<boolean>
1318		1374
1319	Turn on/off ISO 14755 5.2 mode (default enabled).	1375	Turn on/off ISO 14755 5.2 mode (default enabled).
1320
1321	=back
1322
1323	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1324
1325	=over 4
1326
1327	=item B<-pixmap> I<file[;oplist]>
1328
1329	=item B<backgroundPixmap:> I<file[;oplist]>
1330
1331	Compile I<pixbuf>: Use the specified image file as the window's
1332	background and also optionally specify a colon separated list of
1333	operations to modify it. Note that you may need to quote the C<;>
1334	character when using the command line option, as C<;> is usually a
1335	metacharacter in shells. Supported operations are:
1336
1337	=over 4
1338
1339	=item B<WxH+X+Y>
1340
1341	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1342	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1343	scale of 0 disables scaling.
1344
1345	=item B<op=tile>
1346
1347	enables tiling
1348
1349	=item B<op=keep-aspect>
1350
1351	maintain the image aspect ratio when scaling
1352
1353	=item B<op=root-align>
1354
1355	use the position of the terminal window relative to the root window as
1356	the image offset, simulating a root window background
1357
1358	=back
1359
1360	The default scale and position setting is C<100x100+50+50>.
1361	Alternatively, a predefined set of templates can be used to achieve
1362	the most common setups:
1363
1364	=over 4
1365
1366	=item B<style=tiled>
1367
1368	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1369
1370	=item B<style=aspect-stretched>
1371
1372	the image is scaled to fill the whole window maintaining the aspect
1373	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1374
1375	=item B<style=stretched>
1376
1377	the image is scaled to fill the whole window. Equivalent to 100x100
1378
1379	=item B<style=centered>
1380
1381	the image is centered with no scaling. Equivalent to 0x0+50+50
1382
1383	=item B<style=root-tiled>
1384
1385	the image is tiled with no scaling and using 'root' positioning.
1386	Equivalent to 0x0:op=tile:op=root-align
1387
1388	=back
1389
1390	If multiple templates are specified the last one wins. Note that a
1391	template overrides all the scale, position and operations settings.
1392
1393	If used in conjunction with pseudo-transparency, the specified pixmap
1394	will be blended over the transparent background using alpha-blending.
1395
1396	=item B<-tr>\|B<+tr>
1397
1398	=item B<transparent:> I<boolean>
1399
1400	Turn on/off pseudo-transparency by using the root pixmap as background.
1401
1402	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1403	will be removed in future versions.
1404
1405	=item B<-tint> I<colour>
1406
1407	=item B<tintColor:> I<colour>
1408
1409	Tint the transparent background with the given colour. Note that a
1410	black tint yields a completely black image while a white tint yields
1411	the image unchanged.
1412
1413	=item B<-sh> I<number>
1414
1415	=item B<shading:> I<number>
1416
1417	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1418	A value of 100 means no shading.
1419
1420	=item B<-blr> I<HxV>
1421
1422	=item B<blurRadius:> I<HxV>
1423
1424	Apply gaussian blur with the specified radius to the transparent
1425	background. If a single number is specified, the vertical and
1426	horizontal radii are considered to be the same. Setting one of the
1427	radii to 1 and the other to a large number creates interesting effects
1428	on some backgrounds. The maximum radius value is 128. An horizontal or
1429	vertical radius of 0 disables blurring.
1430
1431	=item B<path:> I<path>
1432
1433	Specify the colon-delimited search path for finding background image files.
1434		1376
1435	=back	1377	=back
1436		1378
1437	=head1 THE SCROLLBAR	1379	=head1 THE SCROLLBAR
1438		1380
…		…
1462	=head1 THE SELECTION: SELECTING AND PASTING TEXT	1404	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1463		1405
1464	The behaviour of text selection and insertion/pasting mechanism is similar	1406	The behaviour of text selection and insertion/pasting mechanism is similar
1465	to I<xterm>(1).	1407	to I<xterm>(1).
1466		1408
1467	=over 4	1409	=over
1468		1410
1469	=item B<Selecting>:	1411	=item B<Selecting>:
1470		1412
1471	Left click at the beginning of the region, drag to the end of the region	1413	Left click at the beginning of the region, drag to the end of the region
1472	and release; Right click to extend the marked region; Left double-click	1414	and release; Right click to extend the marked region; Left double-click
…		…
1519	and character codes using the keyboard. It consists of 4 parts. The	1461	and character codes using the keyboard. It consists of 4 parts. The
1520	first part is available if rxvt-unicode has been compiled with	1462	first part is available if rxvt-unicode has been compiled with
1521	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1463	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1522	with C<--enable-iso14755>.	1464	with C<--enable-iso14755>.
1523		1465
1524	=over 4	1466	=over
1525		1467
1526	=item * 5.1: Basic method	1468	=item * 5.1: Basic method
1527		1469
1528	This allows you to enter unicode characters using their hexcode.	1470	This allows you to enter unicode characters using their hexcode.
1529		1471
…		…
1590	In addition to the default foreground and background colours,	1532	In addition to the default foreground and background colours,
1591	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1533	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1592	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1534	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1593	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1535	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1594	cube plus a 8 (24) colour greyscale ramp.	1536	cube plus a 8 (24) colour greyscale ramp.
		1537
		1538	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1539	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1540	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1541	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1542	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1543	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1544	use many similar 24-bit colours. It's typically not a problem in common
		1545	scenarios.
1595		1546
1596	Here is a list of the ANSI colours with their names.	1547	Here is a list of the ANSI colours with their names.
1597		1548
1598	=begin table	1549	=begin table
1599		1550
…		…
1700		1651
1701	=head1 ENVIRONMENT	1652	=head1 ENVIRONMENT
1702		1653
1703	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1654	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1704		1655
1705	=over 4	1656	=over
1706		1657
1707	=item B<TERM>	1658	=item B<TERM>
1708		1659
1709	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1660	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1710	resources or on the command line.	1661	resources or on the command line.
…		…
1781		1732
1782	=back	1733	=back
1783		1734
1784	=head1 FILES	1735	=head1 FILES
1785		1736
1786	=over 4	1737	=over
1787		1738
1788	=item B</usr/lib/X11/rgb.txt>	1739	=item B</usr/lib/X11/rgb.txt>
1789		1740
1790	Colour names.	1741	Colour names.
1791		1742
…		…
1796	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),	1747	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1797	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1748	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1798		1749
1799	=head1 CURRENT PROJECT COORDINATOR	1750	=head1 CURRENT PROJECT COORDINATOR
1800		1751
1801	=over 4	1752	=over
1802		1753
1803	=item Project Coordinator	1754	=item Project Coordinator
1804		1755
1805	Marc A. Lehmann <rxvt-unicode@schmorp.de>.	1756	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1806		1757
…		…
1808		1759
1809	=back	1760	=back
1810		1761
1811	=head1 AUTHORS	1762	=head1 AUTHORS
1812		1763
1813	=over 4	1764	=over
1814		1765
1815	=item John Bovey	1766	=item John Bovey
1816		1767
1817	University of Kent, 1992, wrote the original Xvt.	1768	University of Kent, 1992, wrote the original Xvt.
1818		1769

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC vs. Revision 1.255 by root, Sat Jul 24 11:00:58 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC vs.
Revision 1.255 by root, Sat Jul 24 11:00:58 2021 UTC