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.242 by sf-exg, Fri Dec 26 21:49:11 2014 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
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
511 close $pty; 532 close $pty;
512 533
513 # now communicate with rxvt 534 # now communicate with rxvt
514 my $slave = $pty->slave; 535 my $slave = $pty->slave;
515 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";
516 554
517=item B<-pe> I<string> 555=item B<-pe> I<string>
518 556
519Comma-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
520this terminal instance. See resource B<perl-ext> for details. 558this terminal instance. See resource B<perl-ext> for details.
548be used. Command-line arguments can be used to override resource 586be used. Command-line arguments can be used to override resource
549settings. The following resources are supported (you might want to 587settings. The following resources are supported (you might want to
550check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 588check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
551extensions not documented here): 589extensions not documented here):
552 590
553=over 4 591=over
554 592
555=item B<depth:> I<bitdepth> 593=item B<depth:> I<bitdepth>
556 594
557Compile 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;
558option B<-depth>. 596option B<-depth>.
868are 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
869bottom when a non-special key is pressed; option B<+sk>. 907bottom when a non-special key is pressed; option B<+sk>.
870 908
871=item B<saveLines:> I<number> 909=item B<saveLines:> I<number>
872 910
873Save I<number> lines in the scrollback buffer [default 64]. This 911Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
874resource is limited on most machines to 65535; option B<-sl>.
875 912
876=item B<internalBorder:> I<number> 913=item B<internalBorder:> I<number>
877 914
878Internal border of I<number> pixels. This resource is limited to 100; 915Internal border of I<number> pixels. This resource is limited to 100;
879option B<-b>. 916option B<-b>.
942 979
943=item B<pointerColor2:> I<colour> 980=item B<pointerColor2:> I<colour>
944 981
945Mouse pointer background colour. 982Mouse pointer background colour.
946 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).
989
947=item B<pointerBlankDelay:> I<number> 990=item B<pointerBlankDelay:> I<number>
948 991
949Specifies number of seconds before blanking the pointer [default 2]. Use a 992Specifies number of seconds before blanking the pointer [default 2]. Use a
950large number (e.g. C<987654321>) to effectively disable the timeout. 993large number (e.g. C<987654321>) to effectively disable the timeout.
951 994
977 1020
978B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1021B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
979 1022
980=item B<preeditType:> I<style> 1023=item B<preeditType:> I<style>
981 1024
982B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1025B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
983 1026
984=item B<inputMethod:> I<name> 1027=item B<inputMethod:> I<name>
985 1028
986I<name> of inputMethod to use; option B<-im>. 1029I<name> of inputMethod to use; option B<-im>.
987 1030
1005 1048
1006Change the meaning of triple-click selection with the left mouse 1049Change the meaning of triple-click selection with the left mouse
1007button. 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
1008the end of the logical line only; option B<-tcw>. 1051the end of the logical line only; option B<-tcw>.
1009 1052
1053=item B<disablePasteBrackets:> I<boolean>
1054
1055Prevent emission of paste bracket sequences; option B<-dpb>.
1056
1010=item B<insecure:> I<boolean> 1057=item B<insecure:> I<boolean>
1011 1058
1012Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1059Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1013echo 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
1014abused if somebody gets 8-bit-clean access to your display, whether 1061abused if somebody gets 8-bit-clean access to your display, whether
1015through a mail client displaying mail bodies unfiltered or through 1062through a mail client displaying mail bodies unfiltered or through
1016write(1) or any other means. Therefore, these sequences are disabled by 1063write(1) or any other means. Therefore, these sequences are disabled by
1017default. (Note that many other terminals, including xterm, have these 1064default. (Note that many other terminals, including xterm, have these
1035 1082
1036=item B<secondaryScreen:> I<boolean> 1083=item B<secondaryScreen:> I<boolean>
1037 1084
1038Turn on/off secondary screen (default enabled). 1085Turn on/off secondary screen (default enabled).
1039 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
1040=item B<secondaryScroll:> I<boolean> 1092=item B<secondaryScroll:> I<boolean>
1041 1093
1042Turn on/off secondary screen scroll (default enabled). If this 1094Turn on/off secondary screen scroll (default enabled). If this
1043option is enabled, scrolls on the secondary screen will change the 1095option is enabled, scrolls on the secondary screen will change the
1044scrollback buffer and, when secondaryScreen is off, switching 1096scrollback buffer and, when secondaryScreen is off, switching
1071 1123
1072The 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:
1073 1125
1074 (modifiers-)key 1126 (modifiers-)key
1075 1127
1076Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1128Where 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>, 1129abbreviated modifier names:
1078B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1130
1079B<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
1080 1147
1081The 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
1082whatever 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
1083keys 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
1084current application keymap mode state. 1151current application keymap mode state.
1107prefixed with C<string:>). 1174prefixed with C<string:>).
1108 1175
1109The following action prefixes are known - extensions can provide 1176The following action prefixes are known - extensions can provide
1110additional prefixes: 1177additional prefixes:
1111 1178
1112=over 4 1179=over
1113 1180
1114=item string:STRING 1181=item string:STRING
1115 1182
1116If 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),
1117then 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
1237=item B<perl-ext>: I<string> 1304=item B<perl-ext>: I<string>
1238 1305
1239Comma-separated list(s) of perl extension scripts (default: C<default>) to 1306Comma-separated list(s) of perl extension scripts (default: C<default>) to
1240use in this terminal instance; option B<-pe>. 1307use in this terminal instance; option B<-pe>.
1241 1308
1242Extension 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
1243them. This can be useful to selectively disable some extensions loaded 1310case they had been specified earlier. This can be useful to selectively
1244by default, or specified via the C<perl-ext-common> resource. For 1311disable some extensions loaded by default, or specified via the
1245example, C<default,-selection> will use all the default extensions except 1312C<perl-ext-common> resource. For example, C<default,-selection> will use
1246C<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.
1247 1322
1248The default set includes the C<selection>, C<option-popup>, 1323The default set includes the C<selection>, C<option-popup>,
1249C<selection-popup>, C<readline> and C<searchable-scrollback> 1324C<selection-popup>, C<readline>, C<searchable-scrollback> and
1250extensions, 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.
1251 1327
1252Any extension such that a corresponding resource is given on the 1328Any extension such that a corresponding resource is given on the
1253command line is automatically appended to B<perl-ext>. 1329command line is automatically appended to B<perl-ext>.
1254 1330
1255Each extension is looked up in the library directories, loaded if 1331Each extension is looked up in the library directories, loaded if
1312Turn on/off ISO 14755 (default enabled). 1388Turn on/off ISO 14755 (default enabled).
1313 1389
1314=item B<iso14755_52:> I<boolean> 1390=item B<iso14755_52:> I<boolean>
1315 1391
1316Turn on/off ISO 14755 5.2 mode (default enabled). 1392Turn 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 1393
1432=back 1394=back
1433 1395
1434=head1 THE SCROLLBAR 1396=head1 THE SCROLLBAR
1435 1397
1459=head1 THE SELECTION: SELECTING AND PASTING TEXT 1421=head1 THE SELECTION: SELECTING AND PASTING TEXT
1460 1422
1461The behaviour of text selection and insertion/pasting mechanism is similar 1423The behaviour of text selection and insertion/pasting mechanism is similar
1462to I<xterm>(1). 1424to I<xterm>(1).
1463 1425
1464=over 4 1426=over
1465 1427
1466=item B<Selecting>: 1428=item B<Selecting>:
1467 1429
1468Left 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
1469and release; Right click to extend the marked region; Left double-click 1431and release; Right click to extend the marked region; Left double-click
1516and character codes using the keyboard. It consists of 4 parts. The 1478and character codes using the keyboard. It consists of 4 parts. The
1517first part is available if rxvt-unicode has been compiled with 1479first part is available if rxvt-unicode has been compiled with
1518C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1480C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1519with C<--enable-iso14755>. 1481with C<--enable-iso14755>.
1520 1482
1521=over 4 1483=over
1522 1484
1523=item * 5.1: Basic method 1485=item * 5.1: Basic method
1524 1486
1525This allows you to enter unicode characters using their hexcode. 1487This allows you to enter unicode characters using their hexcode.
1526 1488
1587In addition to the default foreground and background colours, 1549In addition to the default foreground and background colours,
1588B<@@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
1589high-intensity (potentially bold/blink) versions of the same, and 72 (or 1551high-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 1552240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1591cube 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.
1592 1563
1593Here is a list of the ANSI colours with their names. 1564Here is a list of the ANSI colours with their names.
1594 1565
1595=begin table 1566=begin table
1596 1567
1697 1668
1698=head1 ENVIRONMENT 1669=head1 ENVIRONMENT
1699 1670
1700B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1671B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1701 1672
1702=over 4 1673=over
1703 1674
1704=item B<TERM> 1675=item B<TERM>
1705 1676
1706Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1677Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1707resources or on the command line. 1678resources or on the command line.
1778 1749
1779=back 1750=back
1780 1751
1781=head1 FILES 1752=head1 FILES
1782 1753
1783=over 4 1754=over
1784 1755
1785=item B</usr/lib/X11/rgb.txt> 1756=item B</usr/lib/X11/rgb.txt>
1786 1757
1787Colour names. 1758Colour names.
1788 1759
1793@@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),
1794@@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)
1795 1766
1796=head1 CURRENT PROJECT COORDINATOR 1767=head1 CURRENT PROJECT COORDINATOR
1797 1768
1798=over 4 1769=over
1799 1770
1800=item Project Coordinator 1771=item Project Coordinator
1801 1772
1802Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1773Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1803 1774
1805 1776
1806=back 1777=back
1807 1778
1808=head1 AUTHORS 1779=head1 AUTHORS
1809 1780
1810=over 4 1781=over
1811 1782
1812=item John Bovey 1783=item John Bovey
1813 1784
1814University of Kent, 1992, wrote the original Xvt. 1785University of Kent, 1992, wrote the original Xvt.
1815 1786

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines