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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.245 by root, Wed Jun 17 11:59:37 2015 UTC vs.
Revision 1.256 by root, Mon Nov 22 17:00:49 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
…		…
514	close $pty;	532	close $pty;
515		533
516	# now communicate with rxvt	534	# now communicate with rxvt
517	my $slave = $pty->slave;	535	my $slave = $pty->slave;
518	while (<$slave>) { print $slave "got <$_>\n" }	536	while (<$slave>) { print $slave "got <$_>\n" }
		537
		538	Note that, despite what the name might imply, the file descriptor does not
		539	need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
		540	domain or tcp socket). While tty operations cannot be done in this case,
		541	B<@@RXVT_NAME@@> can still be remote controlled with it:
		542
		543	use Socket;
		544	use Fcntl;
		545
		546	socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
		547	fcntl $slave, Fcntl::F_SETFD, 0;
		548	system "exec @@RXVT_NAME\|\| -pty-fd " . (fileno $slave) . " &";
		549	close $slave;
		550
		551	syswrite $URXVT, "Type a secret password: ";
		552	my $secret = do { local $/ = "\r"; <$URXVT> };
		553	print "No so secret anymore: $secret\n";
519		554
520	=item B<-pe> I<string>	555	=item B<-pe> I<string>
521		556
522	Comma-separated list of perl extension scripts to use (or not to use) in	557	Comma-separated list of perl extension scripts to use (or not to use) in
523	this terminal instance. See resource B<perl-ext> for details.	558	this terminal instance. See resource B<perl-ext> for details.
…		…
551	be used. Command-line arguments can be used to override resource	586	be used. Command-line arguments can be used to override resource
552	settings. The following resources are supported (you might want to	587	settings. The following resources are supported (you might want to
553	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	588	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554	extensions not documented here):	589	extensions not documented here):
555		590
556	=over 4	591	=over
557		592
558	=item B<depth:> I<bitdepth>	593	=item B<depth:> I<bitdepth>
559		594
560	Compile I<xft>: Attempt to find a visual with the given bit depth;	595	Compile I<xft>: Attempt to find a visual with the given bit depth;
561	option B<-depth>.	596	option B<-depth>.
…		…
1013		1048
1014	Change the meaning of triple-click selection with the left mouse	1049	Change the meaning of triple-click selection with the left mouse
1015	button. Instead of selecting a full line it will extend the selection to	1050	button. Instead of selecting a full line it will extend the selection to
1016	the end of the logical line only; option B<-tcw>.	1051	the end of the logical line only; option B<-tcw>.
1017		1052
		1053	=item B<disablePasteBrackets:> I<boolean>
		1054
		1055	Prevent emission of paste bracket sequences; option B<-dpb>.
		1056
1018	=item B<insecure:> I<boolean>	1057	=item B<insecure:> I<boolean>
1019		1058
1020	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1059	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1021	echo arbitrary strings like the icon name or the locale. This could be	1060	echo arbitrary strings like the icon name or the locale. This could be
1022	abused if somebody gets 8-bit-clean access to your display, whether	1061	abused if somebody gets 8-bit-clean access to your display, whether
1023	through a mail client displaying mail bodies unfiltered or through	1062	through a mail client displaying mail bodies unfiltered or through
1024	write(1) or any other means. Therefore, these sequences are disabled by	1063	write(1) or any other means. Therefore, these sequences are disabled by
1025	default. (Note that many other terminals, including xterm, have these	1064	default. (Note that many other terminals, including xterm, have these
…		…
1043		1082
1044	=item B<secondaryScreen:> I<boolean>	1083	=item B<secondaryScreen:> I<boolean>
1045		1084
1046	Turn on/off secondary screen (default enabled).	1085	Turn on/off secondary screen (default enabled).
1047		1086
		1087	=item B<rewrapMode:> I<mode>
		1088
		1089	Sets long line rewrap behaviour on window resize to one of B<auto>
		1090	(default), B<always> or B<never>.
		1091
1048	=item B<secondaryScroll:> I<boolean>	1092	=item B<secondaryScroll:> I<boolean>
1049		1093
1050	Turn on/off secondary screen scroll (default enabled). If this	1094	Turn on/off secondary screen scroll (default enabled). If this
1051	option is enabled, scrolls on the secondary screen will change the	1095	option is enabled, scrolls on the secondary screen will change the
1052	scrollback buffer and, when secondaryScreen is off, switching	1096	scrollback buffer and, when secondaryScreen is off, switching
…		…
1079		1123
1080	The key combination that triggers the action, I<sym>, has the following format:	1124	The key combination that triggers the action, I<sym>, has the following format:
1081		1125
1082	(modifiers-)key	1126	(modifiers-)key
1083		1127
1084	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,	1128	Where I<modifiers> can be any combination of the following full or
1085	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1129	abbreviated modifier names:
1086	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1130
1087	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.	1131	=begin table
		1132
		1133	B<ISOLevel3> B<I>
		1134	B<AppKeypad> B<K>
		1135	B<Control> B<C>
		1136	B<NumLock> B<N>
		1137	B<Shift> B<S>
		1138	B<Meta> B<M> I<or> B<A>
		1139	B<Lock> B<L>
		1140	B<Mod1> B<1>
		1141	B<Mod2> B<2>
		1142	B<Mod3> B<3>
		1143	B<Mod4> B<4>
		1144	B<Mod5> B<5>
		1145
		1146	=end table
1088		1147
1089	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1148	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1090	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1149	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1091	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1150	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1092	current application keymap mode state.	1151	current application keymap mode state.
…		…
1115	prefixed with C<string:>).	1174	prefixed with C<string:>).
1116		1175
1117	The following action prefixes are known - extensions can provide	1176	The following action prefixes are known - extensions can provide
1118	additional prefixes:	1177	additional prefixes:
1119		1178
1120	=over 4	1179	=over
1121		1180
1122	=item string:STRING	1181	=item string:STRING
1123		1182
1124	If the I<action> starts with C<string:> (or otherwise contains no colons),	1183	If the I<action> starts with C<string:> (or otherwise contains no colons),
1125	then the remaining C<STRING> will be passed to the program running in the	1184	then the remaining C<STRING> will be passed to the program running in the
…		…
1245	=item B<perl-ext>: I<string>	1304	=item B<perl-ext>: I<string>
1246		1305
1247	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1306	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1248	use in this terminal instance; option B<-pe>.	1307	use in this terminal instance; option B<-pe>.
1249		1308
1250	Extension names can be prefixed with a C<-> sign to prohibit using	1309	Extension names can be prefixed with a C<-> sign to remove them again, in
1251	them. This can be useful to selectively disable some extensions loaded	1310	case they had been specified earlier. This can be useful to selectively
1252	by default, or specified via the C<perl-ext-common> resource. For	1311	disable some extensions loaded by default, or specified via the
1253	example, C<default,-selection> will use all the default extensions except	1312	C<perl-ext-common> resource. For example, C<default,-selection> will use
1254	C<selection>.	1313	all the default extensions except C<selection>.
		1314
		1315	To prohibit autoloading of extensions, you can prefix them with C</>,
		1316	which will make urxvt refuse to automatically load them (this can be
		1317	overriden, however, by specifying the extension name again without a
		1318	prefix, though). This does not prohibit extensions themselves loading
		1319	other extensions. For example, C<default,/background> will keep the
		1320	C<background> extension from being loaded when a background OSC sequence
		1321	is received.
1255		1322
1256	The default set includes the C<selection>, C<option-popup>,	1323	The default set includes the C<selection>, C<option-popup>,
1257	C<selection-popup>, C<readline> and C<searchable-scrollback>	1324	C<selection-popup>, C<readline>, C<searchable-scrollback> and
1258	extensions, and extensions which are mentioned in B<keysym> resources.	1325	C<confirm-paste> extensions, as well as any extensions which are mentioned
		1326	in B<keysym> resources.
1259		1327
1260	Any extension such that a corresponding resource is given on the	1328	Any extension such that a corresponding resource is given on the
1261	command line is automatically appended to B<perl-ext>.	1329	command line is automatically appended to B<perl-ext>.
1262		1330
1263	Each extension is looked up in the library directories, loaded if	1331	Each extension is looked up in the library directories, loaded if
…		…
1320	Turn on/off ISO 14755 (default enabled).	1388	Turn on/off ISO 14755 (default enabled).
1321		1389
1322	=item B<iso14755_52:> I<boolean>	1390	=item B<iso14755_52:> I<boolean>
1323		1391
1324	Turn on/off ISO 14755 5.2 mode (default enabled).	1392	Turn on/off ISO 14755 5.2 mode (default enabled).
1325
1326	=back
1327
1328	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1329
1330	=over 4
1331
1332	=item B<-pixmap> I<file[;oplist]>
1333
1334	=item B<backgroundPixmap:> I<file[;oplist]>
1335
1336	Compile I<pixbuf>: Use the specified image file as the window's
1337	background and also optionally specify a colon separated list of
1338	operations to modify it. Note that you may need to quote the C<;>
1339	character when using the command line option, as C<;> is usually a
1340	metacharacter in shells. Supported operations are:
1341
1342	=over 4
1343
1344	=item B<WxH+X+Y>
1345
1346	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1347	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1348	scale of 0 disables scaling.
1349
1350	=item B<op=tile>
1351
1352	enables tiling
1353
1354	=item B<op=keep-aspect>
1355
1356	maintain the image aspect ratio when scaling
1357
1358	=item B<op=root-align>
1359
1360	use the position of the terminal window relative to the root window as
1361	the image offset, simulating a root window background
1362
1363	=back
1364
1365	The default scale and position setting is C<100x100+50+50>.
1366	Alternatively, a predefined set of templates can be used to achieve
1367	the most common setups:
1368
1369	=over 4
1370
1371	=item B<style=tiled>
1372
1373	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1374
1375	=item B<style=aspect-stretched>
1376
1377	the image is scaled to fill the whole window maintaining the aspect
1378	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1379
1380	=item B<style=stretched>
1381
1382	the image is scaled to fill the whole window. Equivalent to 100x100
1383
1384	=item B<style=centered>
1385
1386	the image is centered with no scaling. Equivalent to 0x0+50+50
1387
1388	=item B<style=root-tiled>
1389
1390	the image is tiled with no scaling and using 'root' positioning.
1391	Equivalent to 0x0:op=tile:op=root-align
1392
1393	=back
1394
1395	If multiple templates are specified the last one wins. Note that a
1396	template overrides all the scale, position and operations settings.
1397
1398	If used in conjunction with pseudo-transparency, the specified pixmap
1399	will be blended over the transparent background using alpha-blending.
1400
1401	=item B<-tr>\|B<+tr>
1402
1403	=item B<transparent:> I<boolean>
1404
1405	Turn on/off pseudo-transparency by using the root pixmap as background.
1406
1407	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1408	will be removed in future versions.
1409
1410	=item B<-tint> I<colour>
1411
1412	=item B<tintColor:> I<colour>
1413
1414	Tint the transparent background with the given colour. Note that a
1415	black tint yields a completely black image while a white tint yields
1416	the image unchanged.
1417
1418	=item B<-sh> I<number>
1419
1420	=item B<shading:> I<number>
1421
1422	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1423	A value of 100 means no shading.
1424
1425	=item B<-blr> I<HxV>
1426
1427	=item B<blurRadius:> I<HxV>
1428
1429	Apply gaussian blur with the specified radius to the transparent
1430	background. If a single number is specified, the vertical and
1431	horizontal radii are considered to be the same. Setting one of the
1432	radii to 1 and the other to a large number creates interesting effects
1433	on some backgrounds. The maximum radius value is 128. An horizontal or
1434	vertical radius of 0 disables blurring.
1435
1436	=item B<path:> I<path>
1437
1438	Specify the colon-delimited search path for finding background image files.
1439		1393
1440	=back	1394	=back
1441		1395
1442	=head1 THE SCROLLBAR	1396	=head1 THE SCROLLBAR
1443		1397
…		…
1467	=head1 THE SELECTION: SELECTING AND PASTING TEXT	1421	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1468		1422
1469	The behaviour of text selection and insertion/pasting mechanism is similar	1423	The behaviour of text selection and insertion/pasting mechanism is similar
1470	to I<xterm>(1).	1424	to I<xterm>(1).
1471		1425
1472	=over 4	1426	=over
1473		1427
1474	=item B<Selecting>:	1428	=item B<Selecting>:
1475		1429
1476	Left click at the beginning of the region, drag to the end of the region	1430	Left click at the beginning of the region, drag to the end of the region
1477	and release; Right click to extend the marked region; Left double-click	1431	and release; Right click to extend the marked region; Left double-click
…		…
1524	and character codes using the keyboard. It consists of 4 parts. The	1478	and character codes using the keyboard. It consists of 4 parts. The
1525	first part is available if rxvt-unicode has been compiled with	1479	first part is available if rxvt-unicode has been compiled with
1526	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1480	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1527	with C<--enable-iso14755>.	1481	with C<--enable-iso14755>.
1528		1482
1529	=over 4	1483	=over
1530		1484
1531	=item * 5.1: Basic method	1485	=item * 5.1: Basic method
1532		1486
1533	This allows you to enter unicode characters using their hexcode.	1487	This allows you to enter unicode characters using their hexcode.
1534		1488
…		…
1595	In addition to the default foreground and background colours,	1549	In addition to the default foreground and background colours,
1596	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1550	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1597	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1551	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1598	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1552	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1599	cube plus a 8 (24) colour greyscale ramp.	1553	cube plus a 8 (24) colour greyscale ramp.
		1554
		1555	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1556	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1557	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1558	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1559	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1560	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1561	use many similar 24-bit colours. It's typically not a problem in common
		1562	scenarios.
1600		1563
1601	Here is a list of the ANSI colours with their names.	1564	Here is a list of the ANSI colours with their names.
1602		1565
1603	=begin table	1566	=begin table
1604		1567
…		…
1705		1668
1706	=head1 ENVIRONMENT	1669	=head1 ENVIRONMENT
1707		1670
1708	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1671	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1709		1672
1710	=over 4	1673	=over
1711		1674
1712	=item B<TERM>	1675	=item B<TERM>
1713		1676
1714	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1677	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1715	resources or on the command line.	1678	resources or on the command line.
…		…
1786		1749
1787	=back	1750	=back
1788		1751
1789	=head1 FILES	1752	=head1 FILES
1790		1753
1791	=over 4	1754	=over
1792		1755
1793	=item B</usr/lib/X11/rgb.txt>	1756	=item B</usr/lib/X11/rgb.txt>
1794		1757
1795	Colour names.	1758	Colour names.
1796		1759
…		…
1801	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),	1764	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1802	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1765	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1803		1766
1804	=head1 CURRENT PROJECT COORDINATOR	1767	=head1 CURRENT PROJECT COORDINATOR
1805		1768
1806	=over 4	1769	=over
1807		1770
1808	=item Project Coordinator	1771	=item Project Coordinator
1809		1772
1810	Marc A. Lehmann <rxvt-unicode@schmorp.de>.	1773	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1811		1774
…		…
1813		1776
1814	=back	1777	=back
1815		1778
1816	=head1 AUTHORS	1779	=head1 AUTHORS
1817		1780
1818	=over 4	1781	=over
1819		1782
1820	=item John Bovey	1783	=item John Bovey
1821		1784
1822	University of Kent, 1992, wrote the original Xvt.	1785	University of Kent, 1992, wrote the original Xvt.
1823		1786

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.245 by root, Wed Jun 17 11:59:37 2015 UTC vs. Revision 1.256 by root, Mon Nov 22 17:00:49 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.245 by root, Wed Jun 17 11:59:37 2015 UTC vs.
Revision 1.256 by root, Mon Nov 22 17:00:49 2021 UTC