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.245 by root, Wed Jun 17 11:59:37 2015 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 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
127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
128 128
129=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
130 130
131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
132
133=item B<-fps> I<number>
134
135Compile I<frills>: Set the refresh interval (in frames per second or
136negative seconds); resource B<refreshRate>.
132 137
133=item B<-fade> I<number> 138=item B<-fade> I<number>
134 139
135Fade the text by the given percentage when focus is lost. Small values 140Fade the text by the given percentage when focus is lost. Small values
136fade a little only, 100 completely replaces all colours by the fade 141fade a little only, 100 completely replaces all colours by the fade
406Change the meaning of triple-click selection with the left mouse 411Change the meaning of triple-click selection with the left mouse
407button. Only effective when the original (non-perl) selection code is 412button. Only effective when the original (non-perl) selection code is
408in-use. Instead of selecting a full line it will extend the selection to 413in-use. Instead of selecting a full line it will extend the selection to
409the end of the logical line only. resource B<tripleclickwords>. 414the end of the logical line only. resource B<tripleclickwords>.
410 415
416=item B<-dpb>|B<+dpb>
417
418Compile frills: Disable (or enable) emitting bracketed paste mode
419sequences (default enabled). Bracketed paste mode allows programs
420to detect when something is pasted. Since more and more programs
421abuse this, these sequences can be disabled. The command sequences to
422enable and query paste mode will still work, but the actual bracket
423sequences will no longer be emitted. You can also toggle this from the
424ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
425
411=item B<-insecure> 426=item B<-insecure>
412 427
413Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
414sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
415info. 430info.
427 442
428=item B<-ssr>|B<+ssr> 443=item B<-ssr>|B<+ssr>
429 444
430Turn on/off secondary screen scroll (default enabled); resource 445Turn on/off secondary screen scroll (default enabled); resource
431B<secondaryScroll>. 446B<secondaryScroll>.
447
448=item B<-rm> I<mode>
449
450Compile I<frills>: Sets long line rewrapping behaviour on window resizes
451to one of B<auto> (the default), B<always> or B<never>. The latter two
452modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
453is non-empty, and wings lines (acts like B<never>) otherwise; resource
454B<rewrapMode>.
432 455
433=item B<-hold>|B<+hold> 456=item B<-hold>|B<+hold>
434 457
435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 458Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
436will not immediately destroy its window when the program executed within 459will not immediately destroy its window when the program executed within
514 close $pty; 537 close $pty;
515 538
516 # now communicate with rxvt 539 # now communicate with rxvt
517 my $slave = $pty->slave; 540 my $slave = $pty->slave;
518 while (<$slave>) { print $slave "got <$_>\n" } 541 while (<$slave>) { print $slave "got <$_>\n" }
542
543Note that, despite what the name might imply, the file descriptor does not
544need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
545domain or tcp socket). While tty operations cannot be done in this case,
546B<@@RXVT_NAME@@> can still be remote controlled with it:
547
548 use Socket;
549 use Fcntl;
550
551 socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
552 fcntl $slave, Fcntl::F_SETFD, 0;
553 system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
554 close $slave;
555
556 syswrite $URXVT, "Type a secret password: ";
557 my $secret = do { local $/ = "\r"; <$URXVT> };
558 print "Not so secret anymore: $secret\n";
519 559
520=item B<-pe> I<string> 560=item B<-pe> I<string>
521 561
522Comma-separated list of perl extension scripts to use (or not to use) in 562Comma-separated list of perl extension scripts to use (or not to use) in
523this terminal instance. See resource B<perl-ext> for details. 563this terminal instance. See resource B<perl-ext> for details.
551be used. Command-line arguments can be used to override resource 591be used. Command-line arguments can be used to override resource
552settings. The following resources are supported (you might want to 592settings. The following resources are supported (you might want to
553check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 593check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554extensions not documented here): 594extensions not documented here):
555 595
556=over 4 596=over
557 597
558=item B<depth:> I<bitdepth> 598=item B<depth:> I<bitdepth>
559 599
560Compile I<xft>: Attempt to find a visual with the given bit depth; 600Compile I<xft>: Attempt to find a visual with the given bit depth;
561option B<-depth>. 601option B<-depth>.
662 702
663B<False>: specify that everything is to be displayed, even 703B<False>: specify that everything is to be displayed, even
664if the refresh is too fast for the human eye to read anything (or the 704if the refresh is too fast for the human eye to read anything (or the
665monitor to display anything); option B<+ss>. 705monitor to display anything); option B<+ss>.
666 706
707=item B<refreshRate:> I<number>
708
709Compile I<frills>: When positive, sets the maximum refreshes per second
710(the default is C<60>). When zero or negative, sets the minimum interval
711between refreshes, negated. That is, positive numbers limit the number
712of refreshes per second to that number, similar to a fps limiter in
713games. Zero or negative numbers get negated and directly set the minimum
714interval between refreshs, that is, C<10> and C<-0.1> both specify the
715same refresh interval (likewise C<50> and C<0.02>). Fractional values are
716supported; option B<-fps>.
717
667=item B<fading:> I<number> 718=item B<fading:> I<number>
668 719
669Fade the text by the given percentage when focus is lost; option B<-fade>. 720Fade the text by the given percentage when focus is lost; option B<-fade>.
670 721
671=item B<fadeColor:> I<colour> 722=item B<fadeColor:> I<colour>
1013 1064
1014Change the meaning of triple-click selection with the left mouse 1065Change the meaning of triple-click selection with the left mouse
1015button. Instead of selecting a full line it will extend the selection to 1066button. Instead of selecting a full line it will extend the selection to
1016the end of the logical line only; option B<-tcw>. 1067the end of the logical line only; option B<-tcw>.
1017 1068
1069=item B<disablePasteBrackets:> I<boolean>
1070
1071Prevent emission of paste bracket sequences; option B<-dpb>.
1072
1018=item B<insecure:> I<boolean> 1073=item B<insecure:> I<boolean>
1019 1074
1020Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1075Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1021echo arbitrary strings like the icon name or the locale. This could be 1076echo arbitrary strings like the icon name or the locale. This could be
1022abused if somebody gets 8-bit-clean access to your display, whether 1077abused if somebody gets 8-bit-clean access to your display, whether
1023through a mail client displaying mail bodies unfiltered or through 1078through a mail client displaying mail bodies unfiltered or through
1024write(1) or any other means. Therefore, these sequences are disabled by 1079write(1) or any other means. Therefore, these sequences are disabled by
1025default. (Note that many other terminals, including xterm, have these 1080default. (Note that many other terminals, including xterm, have these
1043 1098
1044=item B<secondaryScreen:> I<boolean> 1099=item B<secondaryScreen:> I<boolean>
1045 1100
1046Turn on/off secondary screen (default enabled). 1101Turn on/off secondary screen (default enabled).
1047 1102
1103=item B<rewrapMode:> I<mode>
1104
1105Sets long line rewrap behaviour on window resize to one of B<auto>
1106(default), B<always> or B<never>.
1107
1048=item B<secondaryScroll:> I<boolean> 1108=item B<secondaryScroll:> I<boolean>
1049 1109
1050Turn on/off secondary screen scroll (default enabled). If this 1110Turn on/off secondary screen scroll (default enabled). If this
1051option is enabled, scrolls on the secondary screen will change the 1111option is enabled, scrolls on the secondary screen will change the
1052scrollback buffer and, when secondaryScreen is off, switching 1112scrollback buffer and, when secondaryScreen is off, switching
1079 1139
1080The key combination that triggers the action, I<sym>, has the following format: 1140The key combination that triggers the action, I<sym>, has the following format:
1081 1141
1082 (modifiers-)key 1142 (modifiers-)key
1083 1143
1084Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1144Where I<modifiers> can be any combination of the following full or
1085B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, 1145abbreviated modifier names:
1086B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1146
1087B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. 1147=begin table
1148
1149 B<ISOLevel3> B<I>
1150 B<AppKeypad> B<K>
1151 B<Control> B<C>
1152 B<NumLock> B<N>
1153 B<Shift> B<S>
1154 B<Meta> B<M> I<or> B<A>
1155 B<Lock> B<L>
1156 B<Mod1> B<1>
1157 B<Mod2> B<2>
1158 B<Mod3> B<3>
1159 B<Mod4> B<4>
1160 B<Mod5> B<5>
1161
1162=end table
1088 1163
1089The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1164The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1090whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1165whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1091keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1166keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1092current application keymap mode state. 1167current application keymap mode state.
1115prefixed with C<string:>). 1190prefixed with C<string:>).
1116 1191
1117The following action prefixes are known - extensions can provide 1192The following action prefixes are known - extensions can provide
1118additional prefixes: 1193additional prefixes:
1119 1194
1120=over 4 1195=over
1121 1196
1122=item string:STRING 1197=item string:STRING
1123 1198
1124If the I<action> starts with C<string:> (or otherwise contains no colons), 1199If the I<action> starts with C<string:> (or otherwise contains no colons),
1125then the remaining C<STRING> will be passed to the program running in the 1200then the remaining C<STRING> will be passed to the program running in the
1245=item B<perl-ext>: I<string> 1320=item B<perl-ext>: I<string>
1246 1321
1247Comma-separated list(s) of perl extension scripts (default: C<default>) to 1322Comma-separated list(s) of perl extension scripts (default: C<default>) to
1248use in this terminal instance; option B<-pe>. 1323use in this terminal instance; option B<-pe>.
1249 1324
1250Extension names can be prefixed with a C<-> sign to prohibit using 1325Extension names can be prefixed with a C<-> sign to remove them again, in
1251them. This can be useful to selectively disable some extensions loaded 1326case they had been specified earlier. This can be useful to selectively
1252by default, or specified via the C<perl-ext-common> resource. For 1327disable some extensions loaded by default, or specified via the
1253example, C<default,-selection> will use all the default extensions except 1328C<perl-ext-common> resource. For example, C<default,-selection> will use
1254C<selection>. 1329all the default extensions except C<selection>.
1330
1331To prohibit autoloading of extensions, you can prefix them with C</>,
1332which will make urxvt refuse to automatically load them (this can be
1333overridden, however, by specifying the extension name again without a
1334prefix, though). This does not prohibit extensions themselves loading
1335other extensions. For example, C<default,/background> will keep the
1336C<background> extension from being loaded when a background OSC sequence
1337is received.
1255 1338
1256The default set includes the C<selection>, C<option-popup>, 1339The default set includes the C<selection>, C<option-popup>,
1257C<selection-popup>, C<readline> and C<searchable-scrollback> 1340C<selection-popup>, C<readline>, C<searchable-scrollback> and
1258extensions, and extensions which are mentioned in B<keysym> resources. 1341C<confirm-paste> extensions, as well as any extensions which are mentioned
1342in B<keysym> resources.
1259 1343
1260Any extension such that a corresponding resource is given on the 1344Any extension such that a corresponding resource is given on the
1261command line is automatically appended to B<perl-ext>. 1345command line is automatically appended to B<perl-ext>.
1262 1346
1263Each extension is looked up in the library directories, loaded if 1347Each extension is looked up in the library directories, loaded if
1320Turn on/off ISO 14755 (default enabled). 1404Turn on/off ISO 14755 (default enabled).
1321 1405
1322=item B<iso14755_52:> I<boolean> 1406=item B<iso14755_52:> I<boolean>
1323 1407
1324Turn on/off ISO 14755 5.2 mode (default enabled). 1408Turn 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
1336Compile I<pixbuf>: Use the specified image file as the window's
1337background and also optionally specify a colon separated list of
1338operations to modify it. Note that you may need to quote the C<;>
1339character when using the command line option, as C<;> is usually a
1340metacharacter in shells. Supported operations are:
1341
1342=over 4
1343
1344=item B<WxH+X+Y>
1345
1346sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1347scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1348scale of 0 disables scaling.
1349
1350=item B<op=tile>
1351
1352enables tiling
1353
1354=item B<op=keep-aspect>
1355
1356maintain the image aspect ratio when scaling
1357
1358=item B<op=root-align>
1359
1360use the position of the terminal window relative to the root window as
1361the image offset, simulating a root window background
1362
1363=back
1364
1365The default scale and position setting is C<100x100+50+50>.
1366Alternatively, a predefined set of templates can be used to achieve
1367the most common setups:
1368
1369=over 4
1370
1371=item B<style=tiled>
1372
1373the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1374
1375=item B<style=aspect-stretched>
1376
1377the image is scaled to fill the whole window maintaining the aspect
1378ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1379
1380=item B<style=stretched>
1381
1382the image is scaled to fill the whole window. Equivalent to 100x100
1383
1384=item B<style=centered>
1385
1386the image is centered with no scaling. Equivalent to 0x0+50+50
1387
1388=item B<style=root-tiled>
1389
1390the image is tiled with no scaling and using 'root' positioning.
1391Equivalent to 0x0:op=tile:op=root-align
1392
1393=back
1394
1395If multiple templates are specified the last one wins. Note that a
1396template overrides all the scale, position and operations settings.
1397
1398If used in conjunction with pseudo-transparency, the specified pixmap
1399will be blended over the transparent background using alpha-blending.
1400
1401=item B<-tr>|B<+tr>
1402
1403=item B<transparent:> I<boolean>
1404
1405Turn on/off pseudo-transparency by using the root pixmap as background.
1406
1407B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1408will be removed in future versions.
1409
1410=item B<-tint> I<colour>
1411
1412=item B<tintColor:> I<colour>
1413
1414Tint the transparent background with the given colour. Note that a
1415black tint yields a completely black image while a white tint yields
1416the image unchanged.
1417
1418=item B<-sh> I<number>
1419
1420=item B<shading:> I<number>
1421
1422Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1423A value of 100 means no shading.
1424
1425=item B<-blr> I<HxV>
1426
1427=item B<blurRadius:> I<HxV>
1428
1429Apply gaussian blur with the specified radius to the transparent
1430background. If a single number is specified, the vertical and
1431horizontal radii are considered to be the same. Setting one of the
1432radii to 1 and the other to a large number creates interesting effects
1433on some backgrounds. The maximum radius value is 128. An horizontal or
1434vertical radius of 0 disables blurring.
1435
1436=item B<path:> I<path>
1437
1438Specify the colon-delimited search path for finding background image files.
1439 1409
1440=back 1410=back
1441 1411
1442=head1 THE SCROLLBAR 1412=head1 THE SCROLLBAR
1443 1413
1467=head1 THE SELECTION: SELECTING AND PASTING TEXT 1437=head1 THE SELECTION: SELECTING AND PASTING TEXT
1468 1438
1469The behaviour of text selection and insertion/pasting mechanism is similar 1439The behaviour of text selection and insertion/pasting mechanism is similar
1470to I<xterm>(1). 1440to I<xterm>(1).
1471 1441
1472=over 4 1442=over
1473 1443
1474=item B<Selecting>: 1444=item B<Selecting>:
1475 1445
1476Left click at the beginning of the region, drag to the end of the region 1446Left click at the beginning of the region, drag to the end of the region
1477and release; Right click to extend the marked region; Left double-click 1447and release; Right click to extend the marked region; Left double-click
1524and character codes using the keyboard. It consists of 4 parts. The 1494and character codes using the keyboard. It consists of 4 parts. The
1525first part is available if rxvt-unicode has been compiled with 1495first part is available if rxvt-unicode has been compiled with
1526C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1496C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1527with C<--enable-iso14755>. 1497with C<--enable-iso14755>.
1528 1498
1529=over 4 1499=over
1530 1500
1531=item * 5.1: Basic method 1501=item * 5.1: Basic method
1532 1502
1533This allows you to enter unicode characters using their hexcode. 1503This allows you to enter unicode characters using their hexcode.
1534 1504
1595In addition to the default foreground and background colours, 1565In addition to the default foreground and background colours,
1596B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1566B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1597high-intensity (potentially bold/blink) versions of the same, and 72 (or 1567high-intensity (potentially bold/blink) versions of the same, and 72 (or
1598240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1568240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1599cube plus a 8 (24) colour greyscale ramp. 1569cube plus a 8 (24) colour greyscale ramp.
1570
1571B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1572C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1573number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1574colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
157524-bit colour space. When indexing collisions happen, the nearest old colour in
1576the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1577use many similar 24-bit colours. It's typically not a problem in common
1578scenarios.
1600 1579
1601Here is a list of the ANSI colours with their names. 1580Here is a list of the ANSI colours with their names.
1602 1581
1603=begin table 1582=begin table
1604 1583
1705 1684
1706=head1 ENVIRONMENT 1685=head1 ENVIRONMENT
1707 1686
1708B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1687B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1709 1688
1710=over 4 1689=over
1711 1690
1712=item B<TERM> 1691=item B<TERM>
1713 1692
1714Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1693Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1715resources or on the command line. 1694resources or on the command line.
1786 1765
1787=back 1766=back
1788 1767
1789=head1 FILES 1768=head1 FILES
1790 1769
1791=over 4 1770=over
1792 1771
1793=item B</usr/lib/X11/rgb.txt> 1772=item B</usr/lib/X11/rgb.txt>
1794 1773
1795Colour names. 1774Colour names.
1796 1775
1801@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), 1780@@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) 1781@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1803 1782
1804=head1 CURRENT PROJECT COORDINATOR 1783=head1 CURRENT PROJECT COORDINATOR
1805 1784
1806=over 4 1785=over
1807 1786
1808=item Project Coordinator 1787=item Project Coordinator
1809 1788
1810Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1789Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1811 1790
1813 1792
1814=back 1793=back
1815 1794
1816=head1 AUTHORS 1795=head1 AUTHORS
1817 1796
1818=over 4 1797=over
1819 1798
1820=item John Bovey 1799=item John Bovey
1821 1800
1822University of Kent, 1992, wrote the original Xvt. 1801University of Kent, 1992, wrote the original Xvt.
1823 1802

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines