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.255 by root, Sat Jul 24 11:00:58 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
551be used. Command-line arguments can be used to override resource 569be used. Command-line arguments can be used to override resource
552settings. The following resources are supported (you might want to 570settings. The following resources are supported (you might want to
553check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 571check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554extensions not documented here): 572extensions 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
560Compile I<xft>: Attempt to find a visual with the given bit depth; 578Compile I<xft>: Attempt to find a visual with the given bit depth;
561option B<-depth>. 579option B<-depth>.
1013 1031
1014Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1015button. Instead of selecting a full line it will extend the selection to 1033button. Instead of selecting a full line it will extend the selection to
1016the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1017 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
1018=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1019 1041
1020Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1021echo arbitrary strings like the icon name or the locale. This could be 1043echo arbitrary strings like the icon name or the locale. This could be
1022abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1023through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1024write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1025default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
1043 1065
1044=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1045 1067
1046Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1047 1069
1070=item B<rewrapMode:> I<mode>
1071
1072Sets long line rewrap behaviour on window resize to one of B<auto>
1073(default), B<always> or B<never>.
1074
1048=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1049 1076
1050Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1051option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1052scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
1079 1106
1080The key combination that triggers the action, I<sym>, has the following format: 1107The key combination that triggers the action, I<sym>, has the following format:
1081 1108
1082 (modifiers-)key 1109 (modifiers-)key
1083 1110
1084Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1111Where 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>, 1112abbreviated modifier names:
1086B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1113
1087B<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
1088 1130
1089The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1131The 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 1132whatever 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 1133keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1092current application keymap mode state. 1134current application keymap mode state.
1115prefixed with C<string:>). 1157prefixed with C<string:>).
1116 1158
1117The following action prefixes are known - extensions can provide 1159The following action prefixes are known - extensions can provide
1118additional prefixes: 1160additional prefixes:
1119 1161
1120=over 4 1162=over
1121 1163
1122=item string:STRING 1164=item string:STRING
1123 1165
1124If the I<action> starts with C<string:> (or otherwise contains no colons), 1166If 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 1167then the remaining C<STRING> will be passed to the program running in the
1245=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1246 1288
1247Comma-separated list(s) of perl extension scripts (default: C<default>) to 1289Comma-separated list(s) of perl extension scripts (default: C<default>) to
1248use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1249 1291
1250Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to remove them again, in
1251them. This can be useful to selectively disable some extensions loaded 1293case they had been specified earlier. This can be useful to selectively
1252by default, or specified via the C<perl-ext-common> resource. For 1294disable some extensions loaded by default, or specified via the
1253example, C<default,-selection> will use all the default extensions except 1295C<perl-ext-common> resource. For example, C<default,-selection> will use
1254C<selection>. 1296all the default extensions except C<selection>.
1297
1298To prohibit autoloading of extensions, you can prefix them with C</>,
1299which will make urxvt refuse to automatically load them (this can be
1300overriden, however, by specifying the extension name again without a
1301prefix, though). This does not prohibit extensions themselves loading
1302other extensions. For example, C<default,/background> will keep the
1303C<background> extension from being loaded when a background OSC sequence
1304is received.
1255 1305
1256The default set includes the C<selection>, C<option-popup>, 1306The default set includes the C<selection>, C<option-popup>,
1257C<selection-popup>, C<readline> and C<searchable-scrollback> 1307C<selection-popup>, C<readline>, C<searchable-scrollback> and
1258extensions, and extensions which are mentioned in B<keysym> resources. 1308C<confirm-paste> extensions, as well as any extensions which are mentioned
1309in B<keysym> resources.
1259 1310
1260Any extension such that a corresponding resource is given on the 1311Any extension such that a corresponding resource is given on the
1261command line is automatically appended to B<perl-ext>. 1312command line is automatically appended to B<perl-ext>.
1262 1313
1263Each extension is looked up in the library directories, loaded if 1314Each extension is looked up in the library directories, loaded if
1320Turn on/off ISO 14755 (default enabled). 1371Turn on/off ISO 14755 (default enabled).
1321 1372
1322=item B<iso14755_52:> I<boolean> 1373=item B<iso14755_52:> I<boolean>
1323 1374
1324Turn on/off ISO 14755 5.2 mode (default enabled). 1375Turn 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 1376
1440=back 1377=back
1441 1378
1442=head1 THE SCROLLBAR 1379=head1 THE SCROLLBAR
1443 1380
1467=head1 THE SELECTION: SELECTING AND PASTING TEXT 1404=head1 THE SELECTION: SELECTING AND PASTING TEXT
1468 1405
1469The behaviour of text selection and insertion/pasting mechanism is similar 1406The behaviour of text selection and insertion/pasting mechanism is similar
1470to I<xterm>(1). 1407to I<xterm>(1).
1471 1408
1472=over 4 1409=over
1473 1410
1474=item B<Selecting>: 1411=item B<Selecting>:
1475 1412
1476Left click at the beginning of the region, drag to the end of the region 1413Left 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 1414and release; Right click to extend the marked region; Left double-click
1524and character codes using the keyboard. It consists of 4 parts. The 1461and character codes using the keyboard. It consists of 4 parts. The
1525first part is available if rxvt-unicode has been compiled with 1462first part is available if rxvt-unicode has been compiled with
1526C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1463C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1527with C<--enable-iso14755>. 1464with C<--enable-iso14755>.
1528 1465
1529=over 4 1466=over
1530 1467
1531=item * 5.1: Basic method 1468=item * 5.1: Basic method
1532 1469
1533This allows you to enter unicode characters using their hexcode. 1470This allows you to enter unicode characters using their hexcode.
1534 1471
1595In addition to the default foreground and background colours, 1532In addition to the default foreground and background colours,
1596B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1533B<@@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 1534high-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 1535240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1599cube plus a 8 (24) colour greyscale ramp. 1536cube plus a 8 (24) colour greyscale ramp.
1537
1538B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1539C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1540number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1541colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
154224-bit colour space. When indexing collisions happen, the nearest old colour in
1543the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1544use many similar 24-bit colours. It's typically not a problem in common
1545scenarios.
1600 1546
1601Here is a list of the ANSI colours with their names. 1547Here is a list of the ANSI colours with their names.
1602 1548
1603=begin table 1549=begin table
1604 1550
1705 1651
1706=head1 ENVIRONMENT 1652=head1 ENVIRONMENT
1707 1653
1708B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1654B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1709 1655
1710=over 4 1656=over
1711 1657
1712=item B<TERM> 1658=item B<TERM>
1713 1659
1714Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1660Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1715resources or on the command line. 1661resources or on the command line.
1786 1732
1787=back 1733=back
1788 1734
1789=head1 FILES 1735=head1 FILES
1790 1736
1791=over 4 1737=over
1792 1738
1793=item B</usr/lib/X11/rgb.txt> 1739=item B</usr/lib/X11/rgb.txt>
1794 1740
1795Colour names. 1741Colour names.
1796 1742
1801@@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),
1802@@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)
1803 1749
1804=head1 CURRENT PROJECT COORDINATOR 1750=head1 CURRENT PROJECT COORDINATOR
1805 1751
1806=over 4 1752=over
1807 1753
1808=item Project Coordinator 1754=item Project Coordinator
1809 1755
1810Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1756Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1811 1757
1813 1759
1814=back 1760=back
1815 1761
1816=head1 AUTHORS 1762=head1 AUTHORS
1817 1763
1818=over 4 1764=over
1819 1765
1820=item John Bovey 1766=item John Bovey
1821 1767
1822University of Kent, 1992, wrote the original Xvt. 1768University of Kent, 1992, wrote the original Xvt.
1823 1769

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines