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.241 by root, Wed Dec 17 15:22:10 2014 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
380=item B<-pt> I<style> 380=item B<-pt> I<style>
381 381
382Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
383B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
384 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
385=item B<-im> I<text> 388=item B<-im> I<text>
386 389
387Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
388 391
389=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
403Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
404button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
405in-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
406the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
407 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
408=item B<-insecure> 421=item B<-insecure>
409 422
410Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
411sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
412info. 425info.
424 437
425=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
426 439
427Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
428B<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>.
429 450
430=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
431 452
432Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
433will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
548be used. Command-line arguments can be used to override resource 569be used. Command-line arguments can be used to override resource
549settings. The following resources are supported (you might want to 570settings. The following resources are supported (you might want to
550check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 571check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
551extensions not documented here): 572extensions not documented here):
552 573
553=over 4 574=over
554 575
555=item B<depth:> I<bitdepth> 576=item B<depth:> I<bitdepth>
556 577
557Compile 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;
558option B<-depth>. 579option B<-depth>.
868are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 889are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
869bottom when a non-special key is pressed; option B<+sk>. 890bottom when a non-special key is pressed; option B<+sk>.
870 891
871=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
872 893
873Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
874resource is limited on most machines to 65535; option B<-sl>.
875 895
876=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
877 897
878Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
879option B<-b>. 899option B<-b>.
942 962
943=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
944 964
945Mouse pointer background colour. 965Mouse pointer background colour.
946 966
967=item B<pointerShape:> I<string>
968
969Compile I<frills>: Specifies the name of the mouse pointer shape
970[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
971file for possible values (omit the C<XC_> prefix).
972
947=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
948 974
949Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
950large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
951 977
977 1003
978B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
979 1005
980=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
981 1007
982B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
983 1009
984=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
985 1011
986I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
987 1013
1005 1031
1006Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1007button. 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
1008the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1009 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
1010=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1011 1041
1012Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1013echo 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
1014abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1015through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1016write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1017default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
1035 1065
1036=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1037 1067
1038Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1039 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
1040=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1041 1076
1042Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1043option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1044scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
1071 1106
1072The 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:
1073 1108
1074 (modifiers-)key 1109 (modifiers-)key
1075 1110
1076Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1111Where I<modifiers> can be any combination of the following full or
1077B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, 1112abbreviated modifier names:
1078B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1113
1079B<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
1080 1130
1081The 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
1082whatever 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
1083keys 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
1084current application keymap mode state. 1134current application keymap mode state.
1107prefixed with C<string:>). 1157prefixed with C<string:>).
1108 1158
1109The following action prefixes are known - extensions can provide 1159The following action prefixes are known - extensions can provide
1110additional prefixes: 1160additional prefixes:
1111 1161
1112=over 4 1162=over
1113 1163
1114=item string:STRING 1164=item string:STRING
1115 1165
1116If 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),
1117then 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
1237=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1238 1288
1239Comma-separated list(s) of perl extension scripts (default: C<default>) to 1289Comma-separated list(s) of perl extension scripts (default: C<default>) to
1240use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1241 1291
1242Extension 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
1243them. This can be useful to selectively disable some extensions loaded 1293case they had been specified earlier. This can be useful to selectively
1244by default, or specified via the C<perl-ext-common> resource. For 1294disable some extensions loaded by default, or specified via the
1245example, C<default,-selection> will use all the default extensions except 1295C<perl-ext-common> resource. For example, C<default,-selection> will use
1246C<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.
1247 1305
1248The default set includes the C<selection>, C<option-popup>, 1306The default set includes the C<selection>, C<option-popup>,
1249C<selection-popup> and C<readline> extensions, any extensions that 1307C<selection-popup>, C<readline>, C<searchable-scrollback> and
1250define keybindings via C<BINDING> meta comments, and extensions which 1308C<confirm-paste> extensions, as well as any extensions which are mentioned
1251are mentioned in B<keysym> resources. 1309in B<keysym> resources.
1252 1310
1253Any extension such that a corresponding resource is given on the 1311Any extension such that a corresponding resource is given on the
1254command line is automatically appended to B<perl-ext>. 1312command line is automatically appended to B<perl-ext>.
1255 1313
1256Each extension is looked up in the library directories, loaded if 1314Each extension is looked up in the library directories, loaded if
1313Turn on/off ISO 14755 (default enabled). 1371Turn on/off ISO 14755 (default enabled).
1314 1372
1315=item B<iso14755_52:> I<boolean> 1373=item B<iso14755_52:> I<boolean>
1316 1374
1317Turn on/off ISO 14755 5.2 mode (default enabled). 1375Turn on/off ISO 14755 5.2 mode (default enabled).
1318
1319=back
1320
1321=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1322
1323=over 4
1324
1325=item B<-pixmap> I<file[;oplist]>
1326
1327=item B<backgroundPixmap:> I<file[;oplist]>
1328
1329Compile I<pixbuf>: Use the specified image file as the window's
1330background and also optionally specify a colon separated list of
1331operations to modify it. Note that you may need to quote the C<;>
1332character when using the command line option, as C<;> is usually a
1333metacharacter in shells. Supported operations are:
1334
1335=over 4
1336
1337=item B<WxH+X+Y>
1338
1339sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1340scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1341scale of 0 disables scaling.
1342
1343=item B<op=tile>
1344
1345enables tiling
1346
1347=item B<op=keep-aspect>
1348
1349maintain the image aspect ratio when scaling
1350
1351=item B<op=root-align>
1352
1353use the position of the terminal window relative to the root window as
1354the image offset, simulating a root window background
1355
1356=back
1357
1358The default scale and position setting is C<100x100+50+50>.
1359Alternatively, a predefined set of templates can be used to achieve
1360the most common setups:
1361
1362=over 4
1363
1364=item B<style=tiled>
1365
1366the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1367
1368=item B<style=aspect-stretched>
1369
1370the image is scaled to fill the whole window maintaining the aspect
1371ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1372
1373=item B<style=stretched>
1374
1375the image is scaled to fill the whole window. Equivalent to 100x100
1376
1377=item B<style=centered>
1378
1379the image is centered with no scaling. Equivalent to 0x0+50+50
1380
1381=item B<style=root-tiled>
1382
1383the image is tiled with no scaling and using 'root' positioning.
1384Equivalent to 0x0:op=tile:op=root-align
1385
1386=back
1387
1388If multiple templates are specified the last one wins. Note that a
1389template overrides all the scale, position and operations settings.
1390
1391If used in conjunction with pseudo-transparency, the specified pixmap
1392will be blended over the transparent background using alpha-blending.
1393
1394=item B<-tr>|B<+tr>
1395
1396=item B<transparent:> I<boolean>
1397
1398Turn on/off pseudo-transparency by using the root pixmap as background.
1399
1400B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1401will be removed in future versions.
1402
1403=item B<-tint> I<colour>
1404
1405=item B<tintColor:> I<colour>
1406
1407Tint the transparent background with the given colour. Note that a
1408black tint yields a completely black image while a white tint yields
1409the image unchanged.
1410
1411=item B<-sh> I<number>
1412
1413=item B<shading:> I<number>
1414
1415Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1416A value of 100 means no shading.
1417
1418=item B<-blr> I<HxV>
1419
1420=item B<blurRadius:> I<HxV>
1421
1422Apply gaussian blur with the specified radius to the transparent
1423background. If a single number is specified, the vertical and
1424horizontal radii are considered to be the same. Setting one of the
1425radii to 1 and the other to a large number creates interesting effects
1426on some backgrounds. The maximum radius value is 128. An horizontal or
1427vertical radius of 0 disables blurring.
1428
1429=item B<path:> I<path>
1430
1431Specify the colon-delimited search path for finding background image files.
1432 1376
1433=back 1377=back
1434 1378
1435=head1 THE SCROLLBAR 1379=head1 THE SCROLLBAR
1436 1380
1460=head1 THE SELECTION: SELECTING AND PASTING TEXT 1404=head1 THE SELECTION: SELECTING AND PASTING TEXT
1461 1405
1462The behaviour of text selection and insertion/pasting mechanism is similar 1406The behaviour of text selection and insertion/pasting mechanism is similar
1463to I<xterm>(1). 1407to I<xterm>(1).
1464 1408
1465=over 4 1409=over
1466 1410
1467=item B<Selecting>: 1411=item B<Selecting>:
1468 1412
1469Left 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
1470and release; Right click to extend the marked region; Left double-click 1414and release; Right click to extend the marked region; Left double-click
1517and character codes using the keyboard. It consists of 4 parts. The 1461and character codes using the keyboard. It consists of 4 parts. The
1518first part is available if rxvt-unicode has been compiled with 1462first part is available if rxvt-unicode has been compiled with
1519C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1463C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1520with C<--enable-iso14755>. 1464with C<--enable-iso14755>.
1521 1465
1522=over 4 1466=over
1523 1467
1524=item * 5.1: Basic method 1468=item * 5.1: Basic method
1525 1469
1526This allows you to enter unicode characters using their hexcode. 1470This allows you to enter unicode characters using their hexcode.
1527 1471
1588In addition to the default foreground and background colours, 1532In addition to the default foreground and background colours,
1589B<@@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
1590high-intensity (potentially bold/blink) versions of the same, and 72 (or 1534high-intensity (potentially bold/blink) versions of the same, and 72 (or
1591240 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
1592cube 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.
1593 1546
1594Here is a list of the ANSI colours with their names. 1547Here is a list of the ANSI colours with their names.
1595 1548
1596=begin table 1549=begin table
1597 1550
1698 1651
1699=head1 ENVIRONMENT 1652=head1 ENVIRONMENT
1700 1653
1701B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1654B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1702 1655
1703=over 4 1656=over
1704 1657
1705=item B<TERM> 1658=item B<TERM>
1706 1659
1707Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1660Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1708resources or on the command line. 1661resources or on the command line.
1779 1732
1780=back 1733=back
1781 1734
1782=head1 FILES 1735=head1 FILES
1783 1736
1784=over 4 1737=over
1785 1738
1786=item B</usr/lib/X11/rgb.txt> 1739=item B</usr/lib/X11/rgb.txt>
1787 1740
1788Colour names. 1741Colour names.
1789 1742
1794@@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),
1795@@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)
1796 1749
1797=head1 CURRENT PROJECT COORDINATOR 1750=head1 CURRENT PROJECT COORDINATOR
1798 1751
1799=over 4 1752=over
1800 1753
1801=item Project Coordinator 1754=item Project Coordinator
1802 1755
1803Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1756Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1804 1757
1806 1759
1807=back 1760=back
1808 1761
1809=head1 AUTHORS 1762=head1 AUTHORS
1810 1763
1811=over 4 1764=over
1812 1765
1813=item John Bovey 1766=item John Bovey
1814 1767
1815University of Kent, 1992, wrote the original Xvt. 1768University of Kent, 1992, wrote the original Xvt.
1816 1769

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines