ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

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.257 by root, Mon Nov 22 17:01:05 2021 UTC

84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
85Orange'. 85Orange'.
86 86
87The following options are available: 87The 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
93Print out a message describing available options. 93Print out a message describing available options.
94 94
406Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
407button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
408in-use. Instead of selecting a full line it will extend the selection to 408in-use. Instead of selecting a full line it will extend the selection to
409the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
410 410
411=item B<-dpb>|B<+dpb>
412
413Compile frills: Disable (or enable) emitting bracketed paste mode
414sequences (default enabled). Bracketed paste mode allows programs
415to detect when something is pasted. Since more and more programs
416abuse this, these sequences can be disabled. The command sequences to
417enable and query paste mode will still work, but the actual bracket
418sequences will no longer be emitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
420
411=item B<-insecure> 421=item B<-insecure>
412 422
413Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
414sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
415info. 425info.
427 437
428=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
429 439
430Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
431B<secondaryScroll>. 441B<secondaryScroll>.
442
443=item B<-rm> I<mode>
444
445Compile I<frills>: Sets long line rewrapping behaviour on window resizes
446to one of B<auto> (the default), B<always> or B<never>. The latter two
447modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
448is non-empty, and wings lines (acts like B<never>) otherwise; resource
449B<rewrapMode>.
432 450
433=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
434 452
435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
436will not immediately destroy its window when the program executed within 454will 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
538Note that, despite what the name might imply, the file descriptor does not
539need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
540domain or tcp socket). While tty operations cannot be done in this case,
541B<@@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
522Comma-separated list of perl extension scripts to use (or not to use) in 557Comma-separated list of perl extension scripts to use (or not to use) in
523this terminal instance. See resource B<perl-ext> for details. 558this terminal instance. See resource B<perl-ext> for details.
551be used. Command-line arguments can be used to override resource 586be used. Command-line arguments can be used to override resource
552settings. The following resources are supported (you might want to 587settings. The following resources are supported (you might want to
553check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 588check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554extensions not documented here): 589extensions 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
560Compile I<xft>: Attempt to find a visual with the given bit depth; 595Compile I<xft>: Attempt to find a visual with the given bit depth;
561option B<-depth>. 596option B<-depth>.
871are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 906are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
872bottom when a non-special key is pressed; option B<+sk>. 907bottom 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
876Save I<number> lines in the scrollback buffer [default 64]. This 911Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
877resource 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
881Internal border of I<number> pixels. This resource is limited to 100; 915Internal border of I<number> pixels. This resource is limited to 100;
882option B<-b>. 916option B<-b>.
944Mouse pointer foreground colour. 978Mouse pointer foreground colour.
945 979
946=item B<pointerColor2:> I<colour> 980=item B<pointerColor2:> I<colour>
947 981
948Mouse pointer background colour. 982Mouse pointer background colour.
983
984=item B<pointerShape:> I<string>
985
986Compile I<frills>: Specifies the name of the mouse pointer shape
987[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
988file for possible values (omit the C<XC_> prefix).
949 989
950=item B<pointerBlankDelay:> I<number> 990=item B<pointerBlankDelay:> I<number>
951 991
952Specifies number of seconds before blanking the pointer [default 2]. Use a 992Specifies number of seconds before blanking the pointer [default 2]. Use a
953large number (e.g. C<987654321>) to effectively disable the timeout. 993large number (e.g. C<987654321>) to effectively disable the timeout.
1008 1048
1009Change the meaning of triple-click selection with the left mouse 1049Change the meaning of triple-click selection with the left mouse
1010button. Instead of selecting a full line it will extend the selection to 1050button. Instead of selecting a full line it will extend the selection to
1011the end of the logical line only; option B<-tcw>. 1051the end of the logical line only; option B<-tcw>.
1012 1052
1053=item B<disablePasteBrackets:> I<boolean>
1054
1055Prevent emission of paste bracket sequences; option B<-dpb>.
1056
1013=item B<insecure:> I<boolean> 1057=item B<insecure:> I<boolean>
1014 1058
1015Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1059Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1016echo arbitrary strings like the icon name or the locale. This could be 1060echo arbitrary strings like the icon name or the locale. This could be
1017abused if somebody gets 8-bit-clean access to your display, whether 1061abused if somebody gets 8-bit-clean access to your display, whether
1018through a mail client displaying mail bodies unfiltered or through 1062through a mail client displaying mail bodies unfiltered or through
1019write(1) or any other means. Therefore, these sequences are disabled by 1063write(1) or any other means. Therefore, these sequences are disabled by
1020default. (Note that many other terminals, including xterm, have these 1064default. (Note that many other terminals, including xterm, have these
1038 1082
1039=item B<secondaryScreen:> I<boolean> 1083=item B<secondaryScreen:> I<boolean>
1040 1084
1041Turn on/off secondary screen (default enabled). 1085Turn on/off secondary screen (default enabled).
1042 1086
1087=item B<rewrapMode:> I<mode>
1088
1089Sets long line rewrap behaviour on window resize to one of B<auto>
1090(default), B<always> or B<never>.
1091
1043=item B<secondaryScroll:> I<boolean> 1092=item B<secondaryScroll:> I<boolean>
1044 1093
1045Turn on/off secondary screen scroll (default enabled). If this 1094Turn on/off secondary screen scroll (default enabled). If this
1046option is enabled, scrolls on the secondary screen will change the 1095option is enabled, scrolls on the secondary screen will change the
1047scrollback buffer and, when secondaryScreen is off, switching 1096scrollback buffer and, when secondaryScreen is off, switching
1074 1123
1075The key combination that triggers the action, I<sym>, has the following format: 1124The key combination that triggers the action, I<sym>, has the following format:
1076 1125
1077 (modifiers-)key 1126 (modifiers-)key
1078 1127
1079Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1128Where I<modifiers> can be any combination of the following full or
1080B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, 1129abbreviated modifier names:
1081B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1130
1082B<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
1083 1147
1084The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1148The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1085whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1149whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1086keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1150keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1087current application keymap mode state. 1151current application keymap mode state.
1110prefixed with C<string:>). 1174prefixed with C<string:>).
1111 1175
1112The following action prefixes are known - extensions can provide 1176The following action prefixes are known - extensions can provide
1113additional prefixes: 1177additional prefixes:
1114 1178
1115=over 4 1179=over
1116 1180
1117=item string:STRING 1181=item string:STRING
1118 1182
1119If the I<action> starts with C<string:> (or otherwise contains no colons), 1183If the I<action> starts with C<string:> (or otherwise contains no colons),
1120then the remaining C<STRING> will be passed to the program running in the 1184then the remaining C<STRING> will be passed to the program running in the
1240=item B<perl-ext>: I<string> 1304=item B<perl-ext>: I<string>
1241 1305
1242Comma-separated list(s) of perl extension scripts (default: C<default>) to 1306Comma-separated list(s) of perl extension scripts (default: C<default>) to
1243use in this terminal instance; option B<-pe>. 1307use in this terminal instance; option B<-pe>.
1244 1308
1245Extension names can be prefixed with a C<-> sign to prohibit using 1309Extension names can be prefixed with a C<-> sign to remove them again, in
1246them. This can be useful to selectively disable some extensions loaded 1310case they had been specified earlier. This can be useful to selectively
1247by default, or specified via the C<perl-ext-common> resource. For 1311disable some extensions loaded by default, or specified via the
1248example, C<default,-selection> will use all the default extensions except 1312C<perl-ext-common> resource. For example, C<default,-selection> will use
1249C<selection>. 1313all the default extensions except C<selection>.
1314
1315To prohibit autoloading of extensions, you can prefix them with C</>,
1316which will make urxvt refuse to automatically load them (this can be
1317overriden, however, by specifying the extension name again without a
1318prefix, though). This does not prohibit extensions themselves loading
1319other extensions. For example, C<default,/background> will keep the
1320C<background> extension from being loaded when a background OSC sequence
1321is received.
1250 1322
1251The default set includes the C<selection>, C<option-popup>, 1323The default set includes the C<selection>, C<option-popup>,
1252C<selection-popup>, C<readline> and C<searchable-scrollback> 1324C<selection-popup>, C<readline>, C<searchable-scrollback> and
1253extensions, and extensions which are mentioned in B<keysym> resources. 1325C<confirm-paste> extensions, as well as any extensions which are mentioned
1326in B<keysym> resources.
1254 1327
1255Any extension such that a corresponding resource is given on the 1328Any extension such that a corresponding resource is given on the
1256command line is automatically appended to B<perl-ext>. 1329command line is automatically appended to B<perl-ext>.
1257 1330
1258Each extension is looked up in the library directories, loaded if 1331Each extension is looked up in the library directories, loaded if
1315Turn on/off ISO 14755 (default enabled). 1388Turn on/off ISO 14755 (default enabled).
1316 1389
1317=item B<iso14755_52:> I<boolean> 1390=item B<iso14755_52:> I<boolean>
1318 1391
1319Turn on/off ISO 14755 5.2 mode (default enabled). 1392Turn 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
1331Compile I<pixbuf>: Use the specified image file as the window's
1332background and also optionally specify a colon separated list of
1333operations to modify it. Note that you may need to quote the C<;>
1334character when using the command line option, as C<;> is usually a
1335metacharacter in shells. Supported operations are:
1336
1337=over 4
1338
1339=item B<WxH+X+Y>
1340
1341sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1342scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1343scale of 0 disables scaling.
1344
1345=item B<op=tile>
1346
1347enables tiling
1348
1349=item B<op=keep-aspect>
1350
1351maintain the image aspect ratio when scaling
1352
1353=item B<op=root-align>
1354
1355use the position of the terminal window relative to the root window as
1356the image offset, simulating a root window background
1357
1358=back
1359
1360The default scale and position setting is C<100x100+50+50>.
1361Alternatively, a predefined set of templates can be used to achieve
1362the most common setups:
1363
1364=over 4
1365
1366=item B<style=tiled>
1367
1368the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1369
1370=item B<style=aspect-stretched>
1371
1372the image is scaled to fill the whole window maintaining the aspect
1373ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1374
1375=item B<style=stretched>
1376
1377the image is scaled to fill the whole window. Equivalent to 100x100
1378
1379=item B<style=centered>
1380
1381the image is centered with no scaling. Equivalent to 0x0+50+50
1382
1383=item B<style=root-tiled>
1384
1385the image is tiled with no scaling and using 'root' positioning.
1386Equivalent to 0x0:op=tile:op=root-align
1387
1388=back
1389
1390If multiple templates are specified the last one wins. Note that a
1391template overrides all the scale, position and operations settings.
1392
1393If used in conjunction with pseudo-transparency, the specified pixmap
1394will be blended over the transparent background using alpha-blending.
1395
1396=item B<-tr>|B<+tr>
1397
1398=item B<transparent:> I<boolean>
1399
1400Turn on/off pseudo-transparency by using the root pixmap as background.
1401
1402B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1403will be removed in future versions.
1404
1405=item B<-tint> I<colour>
1406
1407=item B<tintColor:> I<colour>
1408
1409Tint the transparent background with the given colour. Note that a
1410black tint yields a completely black image while a white tint yields
1411the image unchanged.
1412
1413=item B<-sh> I<number>
1414
1415=item B<shading:> I<number>
1416
1417Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1418A value of 100 means no shading.
1419
1420=item B<-blr> I<HxV>
1421
1422=item B<blurRadius:> I<HxV>
1423
1424Apply gaussian blur with the specified radius to the transparent
1425background. If a single number is specified, the vertical and
1426horizontal radii are considered to be the same. Setting one of the
1427radii to 1 and the other to a large number creates interesting effects
1428on some backgrounds. The maximum radius value is 128. An horizontal or
1429vertical radius of 0 disables blurring.
1430
1431=item B<path:> I<path>
1432
1433Specify the colon-delimited search path for finding background image files.
1434 1393
1435=back 1394=back
1436 1395
1437=head1 THE SCROLLBAR 1396=head1 THE SCROLLBAR
1438 1397
1462=head1 THE SELECTION: SELECTING AND PASTING TEXT 1421=head1 THE SELECTION: SELECTING AND PASTING TEXT
1463 1422
1464The behaviour of text selection and insertion/pasting mechanism is similar 1423The behaviour of text selection and insertion/pasting mechanism is similar
1465to I<xterm>(1). 1424to I<xterm>(1).
1466 1425
1467=over 4 1426=over
1468 1427
1469=item B<Selecting>: 1428=item B<Selecting>:
1470 1429
1471Left click at the beginning of the region, drag to the end of the region 1430Left click at the beginning of the region, drag to the end of the region
1472and release; Right click to extend the marked region; Left double-click 1431and release; Right click to extend the marked region; Left double-click
1519and character codes using the keyboard. It consists of 4 parts. The 1478and character codes using the keyboard. It consists of 4 parts. The
1520first part is available if rxvt-unicode has been compiled with 1479first part is available if rxvt-unicode has been compiled with
1521C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1480C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1522with C<--enable-iso14755>. 1481with C<--enable-iso14755>.
1523 1482
1524=over 4 1483=over
1525 1484
1526=item * 5.1: Basic method 1485=item * 5.1: Basic method
1527 1486
1528This allows you to enter unicode characters using their hexcode. 1487This allows you to enter unicode characters using their hexcode.
1529 1488
1590In addition to the default foreground and background colours, 1549In addition to the default foreground and background colours,
1591B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1550B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1592high-intensity (potentially bold/blink) versions of the same, and 72 (or 1551high-intensity (potentially bold/blink) versions of the same, and 72 (or
1593240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1552240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1594cube plus a 8 (24) colour greyscale ramp. 1553cube plus a 8 (24) colour greyscale ramp.
1554
1555B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1556C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1557number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1558colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
155924-bit colour space. When indexing collisions happen, the nearest old colour in
1560the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1561use many similar 24-bit colours. It's typically not a problem in common
1562scenarios.
1595 1563
1596Here is a list of the ANSI colours with their names. 1564Here is a list of the ANSI colours with their names.
1597 1565
1598=begin table 1566=begin table
1599 1567
1700 1668
1701=head1 ENVIRONMENT 1669=head1 ENVIRONMENT
1702 1670
1703B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1671B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1704 1672
1705=over 4 1673=over
1706 1674
1707=item B<TERM> 1675=item B<TERM>
1708 1676
1709Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1677Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1710resources or on the command line. 1678resources or on the command line.
1781 1749
1782=back 1750=back
1783 1751
1784=head1 FILES 1752=head1 FILES
1785 1753
1786=over 4 1754=over
1787 1755
1788=item B</usr/lib/X11/rgb.txt> 1756=item B</usr/lib/X11/rgb.txt>
1789 1757
1790Colour names. 1758Colour names.
1791 1759
1796@@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),
1797@@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)
1798 1766
1799=head1 CURRENT PROJECT COORDINATOR 1767=head1 CURRENT PROJECT COORDINATOR
1800 1768
1801=over 4 1769=over
1802 1770
1803=item Project Coordinator 1771=item Project Coordinator
1804 1772
1805Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1773Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1806 1774
1808 1776
1809=back 1777=back
1810 1778
1811=head1 AUTHORS 1779=head1 AUTHORS
1812 1780
1813=over 4 1781=over
1814 1782
1815=item John Bovey 1783=item John Bovey
1816 1784
1817University of Kent, 1992, wrote the original Xvt. 1785University of Kent, 1992, wrote the original Xvt.
1818 1786

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines