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.247 by sf-exg, Thu Jul 14 05:33:25 2016 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
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
514 close $pty; 532 close $pty;
515 533
516 # now communicate with rxvt 534 # now communicate with rxvt
517 my $slave = $pty->slave; 535 my $slave = $pty->slave;
518 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";
519 554
520=item B<-pe> I<string> 555=item B<-pe> I<string>
521 556
522Comma-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
523this terminal instance. See resource B<perl-ext> for details. 558this terminal instance. See resource B<perl-ext> for details.
551be used. Command-line arguments can be used to override resource 586be used. Command-line arguments can be used to override resource
552settings. The following resources are supported (you might want to 587settings. The following resources are supported (you might want to
553check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 588check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554extensions not documented here): 589extensions not documented here):
555 590
556=over 4 591=over
557 592
558=item B<depth:> I<bitdepth> 593=item B<depth:> I<bitdepth>
559 594
560Compile 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;
561option B<-depth>. 596option B<-depth>.
1013 1048
1014Change the meaning of triple-click selection with the left mouse 1049Change the meaning of triple-click selection with the left mouse
1015button. 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
1016the end of the logical line only; option B<-tcw>. 1051the end of the logical line only; option B<-tcw>.
1017 1052
1053=item B<disablePasteBrackets:> I<boolean>
1054
1055Prevent emission of paste bracket sequences; option B<-dpb>.
1056
1018=item B<insecure:> I<boolean> 1057=item B<insecure:> I<boolean>
1019 1058
1020Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1059Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1021echo 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
1022abused if somebody gets 8-bit-clean access to your display, whether 1061abused if somebody gets 8-bit-clean access to your display, whether
1023through a mail client displaying mail bodies unfiltered or through 1062through a mail client displaying mail bodies unfiltered or through
1024write(1) or any other means. Therefore, these sequences are disabled by 1063write(1) or any other means. Therefore, these sequences are disabled by
1025default. (Note that many other terminals, including xterm, have these 1064default. (Note that many other terminals, including xterm, have these
1043 1082
1044=item B<secondaryScreen:> I<boolean> 1083=item B<secondaryScreen:> I<boolean>
1045 1084
1046Turn on/off secondary screen (default enabled). 1085Turn on/off secondary screen (default enabled).
1047 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
1048=item B<secondaryScroll:> I<boolean> 1092=item B<secondaryScroll:> I<boolean>
1049 1093
1050Turn on/off secondary screen scroll (default enabled). If this 1094Turn on/off secondary screen scroll (default enabled). If this
1051option is enabled, scrolls on the secondary screen will change the 1095option is enabled, scrolls on the secondary screen will change the
1052scrollback buffer and, when secondaryScreen is off, switching 1096scrollback buffer and, when secondaryScreen is off, switching
1079 1123
1080The 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:
1081 1125
1082 (modifiers-)key 1126 (modifiers-)key
1083 1127
1084Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1128Where 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>, 1129abbreviated modifier names:
1086B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1130
1087B<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
1088 1147
1089The 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
1090whatever 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
1091keys 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
1092current application keymap mode state. 1151current application keymap mode state.
1115prefixed with C<string:>). 1174prefixed with C<string:>).
1116 1175
1117The following action prefixes are known - extensions can provide 1176The following action prefixes are known - extensions can provide
1118additional prefixes: 1177additional prefixes:
1119 1178
1120=over 4 1179=over
1121 1180
1122=item string:STRING 1181=item string:STRING
1123 1182
1124If 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),
1125then 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
1245=item B<perl-ext>: I<string> 1304=item B<perl-ext>: I<string>
1246 1305
1247Comma-separated list(s) of perl extension scripts (default: C<default>) to 1306Comma-separated list(s) of perl extension scripts (default: C<default>) to
1248use in this terminal instance; option B<-pe>. 1307use in this terminal instance; option B<-pe>.
1249 1308
1250Extension 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
1251them. This can be useful to selectively disable some extensions loaded 1310case they had been specified earlier. This can be useful to selectively
1252by default, or specified via the C<perl-ext-common> resource. For 1311disable some extensions loaded by default, or specified via the
1253example, C<default,-selection> will use all the default extensions except 1312C<perl-ext-common> resource. For example, C<default,-selection> will use
1254C<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.
1255 1322
1256The default set includes the C<selection>, C<option-popup>, 1323The default set includes the C<selection>, C<option-popup>,
1257C<selection-popup>, C<readline> and C<searchable-scrollback> 1324C<selection-popup>, C<readline>, C<searchable-scrollback> and
1258extensions, 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.
1259 1327
1260Any extension such that a corresponding resource is given on the 1328Any extension such that a corresponding resource is given on the
1261command line is automatically appended to B<perl-ext>. 1329command line is automatically appended to B<perl-ext>.
1262 1330
1263Each extension is looked up in the library directories, loaded if 1331Each extension is looked up in the library directories, loaded if
1353=head1 THE SELECTION: SELECTING AND PASTING TEXT 1421=head1 THE SELECTION: SELECTING AND PASTING TEXT
1354 1422
1355The behaviour of text selection and insertion/pasting mechanism is similar 1423The behaviour of text selection and insertion/pasting mechanism is similar
1356to I<xterm>(1). 1424to I<xterm>(1).
1357 1425
1358=over 4 1426=over
1359 1427
1360=item B<Selecting>: 1428=item B<Selecting>:
1361 1429
1362Left 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
1363and release; Right click to extend the marked region; Left double-click 1431and release; Right click to extend the marked region; Left double-click
1410and character codes using the keyboard. It consists of 4 parts. The 1478and character codes using the keyboard. It consists of 4 parts. The
1411first part is available if rxvt-unicode has been compiled with 1479first part is available if rxvt-unicode has been compiled with
1412C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1480C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1413with C<--enable-iso14755>. 1481with C<--enable-iso14755>.
1414 1482
1415=over 4 1483=over
1416 1484
1417=item * 5.1: Basic method 1485=item * 5.1: Basic method
1418 1486
1419This allows you to enter unicode characters using their hexcode. 1487This allows you to enter unicode characters using their hexcode.
1420 1488
1600 1668
1601=head1 ENVIRONMENT 1669=head1 ENVIRONMENT
1602 1670
1603B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1671B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1604 1672
1605=over 4 1673=over
1606 1674
1607=item B<TERM> 1675=item B<TERM>
1608 1676
1609Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1677Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1610resources or on the command line. 1678resources or on the command line.
1681 1749
1682=back 1750=back
1683 1751
1684=head1 FILES 1752=head1 FILES
1685 1753
1686=over 4 1754=over
1687 1755
1688=item B</usr/lib/X11/rgb.txt> 1756=item B</usr/lib/X11/rgb.txt>
1689 1757
1690Colour names. 1758Colour names.
1691 1759
1696@@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),
1697@@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)
1698 1766
1699=head1 CURRENT PROJECT COORDINATOR 1767=head1 CURRENT PROJECT COORDINATOR
1700 1768
1701=over 4 1769=over
1702 1770
1703=item Project Coordinator 1771=item Project Coordinator
1704 1772
1705Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1773Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1706 1774
1708 1776
1709=back 1777=back
1710 1778
1711=head1 AUTHORS 1779=head1 AUTHORS
1712 1780
1713=over 4 1781=over
1714 1782
1715=item John Bovey 1783=item John Bovey
1716 1784
1717University of Kent, 1992, wrote the original Xvt. 1785University of Kent, 1992, wrote the original Xvt.
1718 1786

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines