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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines