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.250 by root, Sat Oct 10 20:06:45 2020 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 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
127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
128 128
129=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
130 130
131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
132
133=item B<-fps> I<number>
134
135Compile I<frills>: Set the refresh interval (in frames per second or
136negative seconds); resource B<refreshRate>.
132 137
133=item B<-fade> I<number> 138=item B<-fade> I<number>
134 139
135Fade the text by the given percentage when focus is lost. Small values 140Fade the text by the given percentage when focus is lost. Small values
136fade a little only, 100 completely replaces all colours by the fade 141fade a little only, 100 completely replaces all colours by the fade
406Change the meaning of triple-click selection with the left mouse 411Change the meaning of triple-click selection with the left mouse
407button. Only effective when the original (non-perl) selection code is 412button. Only effective when the original (non-perl) selection code is
408in-use. Instead of selecting a full line it will extend the selection to 413in-use. Instead of selecting a full line it will extend the selection to
409the end of the logical line only. resource B<tripleclickwords>. 414the end of the logical line only. resource B<tripleclickwords>.
410 415
416=item B<-dpb>|B<+dpb>
417
418Compile frills: Disable (or enable) emitting bracketed paste mode
419sequences (default enabled). Bracketed paste mode allows programs
420to detect when something is pasted. Since more and more programs
421abuse this, these sequences can be disabled. The command sequences to
422enable and query paste mode will still work, but the actual bracket
423sequences will no longer be emitted. You can also toggle this from the
424ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
425
411=item B<-insecure> 426=item B<-insecure>
412 427
413Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
414sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
415info. 430info.
427 442
428=item B<-ssr>|B<+ssr> 443=item B<-ssr>|B<+ssr>
429 444
430Turn on/off secondary screen scroll (default enabled); resource 445Turn on/off secondary screen scroll (default enabled); resource
431B<secondaryScroll>. 446B<secondaryScroll>.
447
448=item B<-rm> I<mode>
449
450Compile I<frills>: Sets long line rewrapping behaviour on window resizes
451to one of B<auto> (the default), B<always> or B<never>. The latter two
452modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
453is non-empty, and wings lines (acts like B<never>) otherwise; resource
454B<rewrapMode>.
432 455
433=item B<-hold>|B<+hold> 456=item B<-hold>|B<+hold>
434 457
435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 458Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
436will not immediately destroy its window when the program executed within 459will not immediately destroy its window when the program executed within
514 close $pty; 537 close $pty;
515 538
516 # now communicate with rxvt 539 # now communicate with rxvt
517 my $slave = $pty->slave; 540 my $slave = $pty->slave;
518 while (<$slave>) { print $slave "got <$_>\n" } 541 while (<$slave>) { print $slave "got <$_>\n" }
542
543Note that, despite what the name might imply, the file descriptor does not
544need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
545domain or tcp socket). While tty operations cannot be done in this case,
546B<@@RXVT_NAME@@> can still be remote controlled with it:
547
548 use Socket;
549 use Fcntl;
550
551 socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
552 fcntl $slave, Fcntl::F_SETFD, 0;
553 system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
554 close $slave;
555
556 syswrite $URXVT, "Type a secret password: ";
557 my $secret = do { local $/ = "\r"; <$URXVT> };
558 print "Not so secret anymore: $secret\n";
519 559
520=item B<-pe> I<string> 560=item B<-pe> I<string>
521 561
522Comma-separated list of perl extension scripts to use (or not to use) in 562Comma-separated list of perl extension scripts to use (or not to use) in
523this terminal instance. See resource B<perl-ext> for details. 563this terminal instance. See resource B<perl-ext> for details.
551be used. Command-line arguments can be used to override resource 591be used. Command-line arguments can be used to override resource
552settings. The following resources are supported (you might want to 592settings. The following resources are supported (you might want to
553check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 593check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554extensions not documented here): 594extensions not documented here):
555 595
556=over 4 596=over
557 597
558=item B<depth:> I<bitdepth> 598=item B<depth:> I<bitdepth>
559 599
560Compile I<xft>: Attempt to find a visual with the given bit depth; 600Compile I<xft>: Attempt to find a visual with the given bit depth;
561option B<-depth>. 601option B<-depth>.
662 702
663B<False>: specify that everything is to be displayed, even 703B<False>: specify that everything is to be displayed, even
664if the refresh is too fast for the human eye to read anything (or the 704if the refresh is too fast for the human eye to read anything (or the
665monitor to display anything); option B<+ss>. 705monitor to display anything); option B<+ss>.
666 706
707=item B<refreshRate:> I<number>
708
709Compile I<frills>: When positive, sets the maximum refreshes per second
710(the default is C<60>). When zero or negative, sets the minimum interval
711between refreshes, negated. That is, positive numbers limit the number
712of refreshes per second to that number, similar to a fps limiter in
713games. Zero or negative numbers get negated and directly set the minimum
714interval between refreshs, that is, C<10> and C<-0.1> both specify the
715same refresh interval (likewise C<50> and C<0.02>). Fractional values are
716supported; option B<-fps>.
717
667=item B<fading:> I<number> 718=item B<fading:> I<number>
668 719
669Fade the text by the given percentage when focus is lost; option B<-fade>. 720Fade the text by the given percentage when focus is lost; option B<-fade>.
670 721
671=item B<fadeColor:> I<colour> 722=item B<fadeColor:> I<colour>
1013 1064
1014Change the meaning of triple-click selection with the left mouse 1065Change the meaning of triple-click selection with the left mouse
1015button. Instead of selecting a full line it will extend the selection to 1066button. Instead of selecting a full line it will extend the selection to
1016the end of the logical line only; option B<-tcw>. 1067the end of the logical line only; option B<-tcw>.
1017 1068
1069=item B<disablePasteBrackets:> I<boolean>
1070
1071Prevent emission of paste bracket sequences; option B<-dpb>.
1072
1018=item B<insecure:> I<boolean> 1073=item B<insecure:> I<boolean>
1019 1074
1020Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1075Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1021echo arbitrary strings like the icon name or the locale. This could be 1076echo arbitrary strings like the icon name or the locale. This could be
1022abused if somebody gets 8-bit-clean access to your display, whether 1077abused if somebody gets 8-bit-clean access to your display, whether
1023through a mail client displaying mail bodies unfiltered or through 1078through a mail client displaying mail bodies unfiltered or through
1024write(1) or any other means. Therefore, these sequences are disabled by 1079write(1) or any other means. Therefore, these sequences are disabled by
1025default. (Note that many other terminals, including xterm, have these 1080default. (Note that many other terminals, including xterm, have these
1042in the entry on B<keysym> following. 1097in the entry on B<keysym> following.
1043 1098
1044=item B<secondaryScreen:> I<boolean> 1099=item B<secondaryScreen:> I<boolean>
1045 1100
1046Turn on/off secondary screen (default enabled). 1101Turn on/off secondary screen (default enabled).
1102
1103=item B<rewrapMode:> I<mode>
1104
1105Sets long line rewrap behaviour on window resize to one of B<auto>
1106(default), B<always> or B<never>.
1047 1107
1048=item B<secondaryScroll:> I<boolean> 1108=item B<secondaryScroll:> I<boolean>
1049 1109
1050Turn on/off secondary screen scroll (default enabled). If this 1110Turn on/off secondary screen scroll (default enabled). If this
1051option is enabled, scrolls on the secondary screen will change the 1111option is enabled, scrolls on the secondary screen will change the
1130prefixed with C<string:>). 1190prefixed with C<string:>).
1131 1191
1132The following action prefixes are known - extensions can provide 1192The following action prefixes are known - extensions can provide
1133additional prefixes: 1193additional prefixes:
1134 1194
1135=over 4 1195=over
1136 1196
1137=item string:STRING 1197=item string:STRING
1138 1198
1139If the I<action> starts with C<string:> (or otherwise contains no colons), 1199If the I<action> starts with C<string:> (or otherwise contains no colons),
1140then the remaining C<STRING> will be passed to the program running in the 1200then the remaining C<STRING> will be passed to the program running in the
1260=item B<perl-ext>: I<string> 1320=item B<perl-ext>: I<string>
1261 1321
1262Comma-separated list(s) of perl extension scripts (default: C<default>) to 1322Comma-separated list(s) of perl extension scripts (default: C<default>) to
1263use in this terminal instance; option B<-pe>. 1323use in this terminal instance; option B<-pe>.
1264 1324
1265Extension names can be prefixed with a C<-> sign to prohibit using 1325Extension names can be prefixed with a C<-> sign to remove them again, in
1266them. This can be useful to selectively disable some extensions loaded 1326case they had been specified earlier. This can be useful to selectively
1267by default, or specified via the C<perl-ext-common> resource. For 1327disable some extensions loaded by default, or specified via the
1268example, C<default,-selection> will use all the default extensions except 1328C<perl-ext-common> resource. For example, C<default,-selection> will use
1269C<selection>. 1329all the default extensions except C<selection>.
1330
1331To prohibit autoloading of extensions, you can prefix them with C</>,
1332which will make urxvt refuse to automatically load them (this can be
1333overridden, however, by specifying the extension name again without a
1334prefix, though). This does not prohibit extensions themselves loading
1335other extensions. For example, C<default,/background> will keep the
1336C<background> extension from being loaded when a background OSC sequence
1337is received.
1270 1338
1271The default set includes the C<selection>, C<option-popup>, 1339The default set includes the C<selection>, C<option-popup>,
1272C<selection-popup>, C<readline> and C<searchable-scrollback> 1340C<selection-popup>, C<readline>, C<searchable-scrollback> and
1273extensions, and extensions which are mentioned in B<keysym> resources. 1341C<confirm-paste> extensions, as well as any extensions which are mentioned
1342in B<keysym> resources.
1274 1343
1275Any extension such that a corresponding resource is given on the 1344Any extension such that a corresponding resource is given on the
1276command line is automatically appended to B<perl-ext>. 1345command line is automatically appended to B<perl-ext>.
1277 1346
1278Each extension is looked up in the library directories, loaded if 1347Each extension is looked up in the library directories, loaded if
1368=head1 THE SELECTION: SELECTING AND PASTING TEXT 1437=head1 THE SELECTION: SELECTING AND PASTING TEXT
1369 1438
1370The behaviour of text selection and insertion/pasting mechanism is similar 1439The behaviour of text selection and insertion/pasting mechanism is similar
1371to I<xterm>(1). 1440to I<xterm>(1).
1372 1441
1373=over 4 1442=over
1374 1443
1375=item B<Selecting>: 1444=item B<Selecting>:
1376 1445
1377Left click at the beginning of the region, drag to the end of the region 1446Left click at the beginning of the region, drag to the end of the region
1378and release; Right click to extend the marked region; Left double-click 1447and release; Right click to extend the marked region; Left double-click
1425and character codes using the keyboard. It consists of 4 parts. The 1494and character codes using the keyboard. It consists of 4 parts. The
1426first part is available if rxvt-unicode has been compiled with 1495first part is available if rxvt-unicode has been compiled with
1427C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1496C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1428with C<--enable-iso14755>. 1497with C<--enable-iso14755>.
1429 1498
1430=over 4 1499=over
1431 1500
1432=item * 5.1: Basic method 1501=item * 5.1: Basic method
1433 1502
1434This allows you to enter unicode characters using their hexcode. 1503This allows you to enter unicode characters using their hexcode.
1435 1504
1615 1684
1616=head1 ENVIRONMENT 1685=head1 ENVIRONMENT
1617 1686
1618B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1687B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1619 1688
1620=over 4 1689=over
1621 1690
1622=item B<TERM> 1691=item B<TERM>
1623 1692
1624Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1693Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1625resources or on the command line. 1694resources or on the command line.
1696 1765
1697=back 1766=back
1698 1767
1699=head1 FILES 1768=head1 FILES
1700 1769
1701=over 4 1770=over
1702 1771
1703=item B</usr/lib/X11/rgb.txt> 1772=item B</usr/lib/X11/rgb.txt>
1704 1773
1705Colour names. 1774Colour names.
1706 1775
1711@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), 1780@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1712@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1781@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1713 1782
1714=head1 CURRENT PROJECT COORDINATOR 1783=head1 CURRENT PROJECT COORDINATOR
1715 1784
1716=over 4 1785=over
1717 1786
1718=item Project Coordinator 1787=item Project Coordinator
1719 1788
1720Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1789Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1721 1790
1723 1792
1724=back 1793=back
1725 1794
1726=head1 AUTHORS 1795=head1 AUTHORS
1727 1796
1728=over 4 1797=over
1729 1798
1730=item John Bovey 1799=item John Bovey
1731 1800
1732University of Kent, 1992, wrote the original Xvt. 1801University of Kent, 1992, wrote the original Xvt.
1733 1802

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines