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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC vs.
Revision 1.257 by root, Mon Nov 22 17:01:05 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 "Not 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>.
…		…
871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	906	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>.	907	bottom when a non-special key is pressed; option B<+sk>.
873		908
874	=item B<saveLines:> I<number>	909	=item B<saveLines:> I<number>
875		910
876	Save I<number> lines in the scrollback buffer [default 64]. This	911	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		912
879	=item B<internalBorder:> I<number>	913	=item B<internalBorder:> I<number>
880		914
881	Internal border of I<number> pixels. This resource is limited to 100;	915	Internal border of I<number> pixels. This resource is limited to 100;
882	option B<-b>.	916	option B<-b>.
…		…
1014		1048
1015	Change the meaning of triple-click selection with the left mouse	1049	Change the meaning of triple-click selection with the left mouse
1016	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
1017	the end of the logical line only; option B<-tcw>.	1051	the end of the logical line only; option B<-tcw>.
1018		1052
		1053	=item B<disablePasteBrackets:> I<boolean>
		1054
		1055	Prevent emission of paste bracket sequences; option B<-dpb>.
		1056
1019	=item B<insecure:> I<boolean>	1057	=item B<insecure:> I<boolean>
1020		1058
1021	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1059	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1022	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
1023	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
1024	through a mail client displaying mail bodies unfiltered or through	1062	through a mail client displaying mail bodies unfiltered or through
1025	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
1026	default. (Note that many other terminals, including xterm, have these	1064	default. (Note that many other terminals, including xterm, have these
…		…
1044		1082
1045	=item B<secondaryScreen:> I<boolean>	1083	=item B<secondaryScreen:> I<boolean>
1046		1084
1047	Turn on/off secondary screen (default enabled).	1085	Turn on/off secondary screen (default enabled).
1048		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
1049	=item B<secondaryScroll:> I<boolean>	1092	=item B<secondaryScroll:> I<boolean>
1050		1093
1051	Turn on/off secondary screen scroll (default enabled). If this	1094	Turn on/off secondary screen scroll (default enabled). If this
1052	option is enabled, scrolls on the secondary screen will change the	1095	option is enabled, scrolls on the secondary screen will change the
1053	scrollback buffer and, when secondaryScreen is off, switching	1096	scrollback buffer and, when secondaryScreen is off, switching
…		…
1080		1123
1081	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:
1082		1125
1083	(modifiers-)key	1126	(modifiers-)key
1084		1127
1085	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
1086	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1129	abbreviated modifier names:
1087	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1130
1088	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
1089		1147
1090	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
1091	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
1092	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
1093	current application keymap mode state.	1151	current application keymap mode state.
…		…
1116	prefixed with C<string:>).	1174	prefixed with C<string:>).
1117		1175
1118	The following action prefixes are known - extensions can provide	1176	The following action prefixes are known - extensions can provide
1119	additional prefixes:	1177	additional prefixes:
1120		1178
1121	=over 4	1179	=over
1122		1180
1123	=item string:STRING	1181	=item string:STRING
1124		1182
1125	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),
1126	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
…		…
1246	=item B<perl-ext>: I<string>	1304	=item B<perl-ext>: I<string>
1247		1305
1248	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
1249	use in this terminal instance; option B<-pe>.	1307	use in this terminal instance; option B<-pe>.
1250		1308
1251	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
1252	them. This can be useful to selectively disable some extensions loaded	1310	case they had been specified earlier. This can be useful to selectively
1253	by default, or specified via the C<perl-ext-common> resource. For	1311	disable some extensions loaded by default, or specified via the
1254	example, C<default,-selection> will use all the default extensions except	1312	C<perl-ext-common> resource. For example, C<default,-selection> will use
1255	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.
1256		1322
1257	The default set includes the C<selection>, C<option-popup>,	1323	The default set includes the C<selection>, C<option-popup>,
1258	C<selection-popup>, C<readline> and C<searchable-scrollback>	1324	C<selection-popup>, C<readline>, C<searchable-scrollback> and
1259	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.
1260		1327
1261	Any extension such that a corresponding resource is given on the	1328	Any extension such that a corresponding resource is given on the
1262	command line is automatically appended to B<perl-ext>.	1329	command line is automatically appended to B<perl-ext>.
1263		1330
1264	Each extension is looked up in the library directories, loaded if	1331	Each extension is looked up in the library directories, loaded if
…		…
1321	Turn on/off ISO 14755 (default enabled).	1388	Turn on/off ISO 14755 (default enabled).
1322		1389
1323	=item B<iso14755_52:> I<boolean>	1390	=item B<iso14755_52:> I<boolean>
1324		1391
1325	Turn on/off ISO 14755 5.2 mode (default enabled).	1392	Turn on/off ISO 14755 5.2 mode (default enabled).
1326
1327	=back
1328
1329	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1330
1331	=over 4
1332
1333	=item B<-pixmap> I<file[;oplist]>
1334
1335	=item B<backgroundPixmap:> I<file[;oplist]>
1336
1337	Compile I<pixbuf>: Use the specified image file as the window's
1338	background and also optionally specify a colon separated list of
1339	operations to modify it. Note that you may need to quote the C<;>
1340	character when using the command line option, as C<;> is usually a
1341	metacharacter in shells. Supported operations are:
1342
1343	=over 4
1344
1345	=item B<WxH+X+Y>
1346
1347	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1348	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1349	scale of 0 disables scaling.
1350
1351	=item B<op=tile>
1352
1353	enables tiling
1354
1355	=item B<op=keep-aspect>
1356
1357	maintain the image aspect ratio when scaling
1358
1359	=item B<op=root-align>
1360
1361	use the position of the terminal window relative to the root window as
1362	the image offset, simulating a root window background
1363
1364	=back
1365
1366	The default scale and position setting is C<100x100+50+50>.
1367	Alternatively, a predefined set of templates can be used to achieve
1368	the most common setups:
1369
1370	=over 4
1371
1372	=item B<style=tiled>
1373
1374	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1375
1376	=item B<style=aspect-stretched>
1377
1378	the image is scaled to fill the whole window maintaining the aspect
1379	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1380
1381	=item B<style=stretched>
1382
1383	the image is scaled to fill the whole window. Equivalent to 100x100
1384
1385	=item B<style=centered>
1386
1387	the image is centered with no scaling. Equivalent to 0x0+50+50
1388
1389	=item B<style=root-tiled>
1390
1391	the image is tiled with no scaling and using 'root' positioning.
1392	Equivalent to 0x0:op=tile:op=root-align
1393
1394	=back
1395
1396	If multiple templates are specified the last one wins. Note that a
1397	template overrides all the scale, position and operations settings.
1398
1399	If used in conjunction with pseudo-transparency, the specified pixmap
1400	will be blended over the transparent background using alpha-blending.
1401
1402	=item B<-tr>\|B<+tr>
1403
1404	=item B<transparent:> I<boolean>
1405
1406	Turn on/off pseudo-transparency by using the root pixmap as background.
1407
1408	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1409	will be removed in future versions.
1410
1411	=item B<-tint> I<colour>
1412
1413	=item B<tintColor:> I<colour>
1414
1415	Tint the transparent background with the given colour. Note that a
1416	black tint yields a completely black image while a white tint yields
1417	the image unchanged.
1418
1419	=item B<-sh> I<number>
1420
1421	=item B<shading:> I<number>
1422
1423	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1424	A value of 100 means no shading.
1425
1426	=item B<-blr> I<HxV>
1427
1428	=item B<blurRadius:> I<HxV>
1429
1430	Apply gaussian blur with the specified radius to the transparent
1431	background. If a single number is specified, the vertical and
1432	horizontal radii are considered to be the same. Setting one of the
1433	radii to 1 and the other to a large number creates interesting effects
1434	on some backgrounds. The maximum radius value is 128. An horizontal or
1435	vertical radius of 0 disables blurring.
1436
1437	=item B<path:> I<path>
1438
1439	Specify the colon-delimited search path for finding background image files.
1440		1393
1441	=back	1394	=back
1442		1395
1443	=head1 THE SCROLLBAR	1396	=head1 THE SCROLLBAR
1444		1397
…		…
1468	=head1 THE SELECTION: SELECTING AND PASTING TEXT	1421	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1469		1422
1470	The behaviour of text selection and insertion/pasting mechanism is similar	1423	The behaviour of text selection and insertion/pasting mechanism is similar
1471	to I<xterm>(1).	1424	to I<xterm>(1).
1472		1425
1473	=over 4	1426	=over
1474		1427
1475	=item B<Selecting>:	1428	=item B<Selecting>:
1476		1429
1477	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
1478	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
…		…
1525	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
1526	first part is available if rxvt-unicode has been compiled with	1479	first part is available if rxvt-unicode has been compiled with
1527	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
1528	with C<--enable-iso14755>.	1481	with C<--enable-iso14755>.
1529		1482
1530	=over 4	1483	=over
1531		1484
1532	=item * 5.1: Basic method	1485	=item * 5.1: Basic method
1533		1486
1534	This allows you to enter unicode characters using their hexcode.	1487	This allows you to enter unicode characters using their hexcode.
1535		1488
…		…
1596	In addition to the default foreground and background colours,	1549	In addition to the default foreground and background colours,
1597	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
1598	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
1599	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
1600	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.
1601		1563
1602	Here is a list of the ANSI colours with their names.	1564	Here is a list of the ANSI colours with their names.
1603		1565
1604	=begin table	1566	=begin table
1605		1567
…		…
1706		1668
1707	=head1 ENVIRONMENT	1669	=head1 ENVIRONMENT
1708		1670
1709	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1671	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1710		1672
1711	=over 4	1673	=over
1712		1674
1713	=item B<TERM>	1675	=item B<TERM>
1714		1676
1715	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
1716	resources or on the command line.	1678	resources or on the command line.
…		…
1787		1749
1788	=back	1750	=back
1789		1751
1790	=head1 FILES	1752	=head1 FILES
1791		1753
1792	=over 4	1754	=over
1793		1755
1794	=item B</usr/lib/X11/rgb.txt>	1756	=item B</usr/lib/X11/rgb.txt>
1795		1757
1796	Colour names.	1758	Colour names.
1797		1759
…		…
1802	@@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),
1803	@@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)
1804		1766
1805	=head1 CURRENT PROJECT COORDINATOR	1767	=head1 CURRENT PROJECT COORDINATOR
1806		1768
1807	=over 4	1769	=over
1808		1770
1809	=item Project Coordinator	1771	=item Project Coordinator
1810		1772
1811	Marc A. Lehmann <rxvt-unicode@schmorp.de>.	1773	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1812		1774
…		…
1814		1776
1815	=back	1777	=back
1816		1778
1817	=head1 AUTHORS	1779	=head1 AUTHORS
1818		1780
1819	=over 4	1781	=over
1820		1782
1821	=item John Bovey	1783	=item John Bovey
1822		1784
1823	University of Kent, 1992, wrote the original Xvt.	1785	University of Kent, 1992, wrote the original Xvt.
1824		1786

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC vs. Revision 1.257 by root, Mon Nov 22 17:01:05 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC vs.
Revision 1.257 by root, Mon Nov 22 17:01:05 2021 UTC