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.251 by root, Sat Jul 3 04:04:12 2021 UTC vs.
Revision 1.261 by root, Fri Dec 23 21:48:24 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
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
411=item B<-dpb>|B<+dpb> 416=item B<-dpb>|B<+dpb>
412 417
413Compile frills: Disables (or enabled) emitting bracketed paste mode 418Compile frills: Disable (or enable) emitting bracketed paste mode
414sequences (default enabled). Bracketed paste mode allows programs 419sequences (default enabled). Bracketed paste mode allows programs
415to detect when something is pasted. Since more and more programs 420to detect when something is pasted. Since more and more programs
416abuse this, these sequences can be disabled. The command sequences to 421abuse this, these sequences can be disabled. The command sequences to
417enable and query paste mode will still work, but the actual bracket 422enable and query paste mode will still work, but the actual bracket
418sequences will no longer be omitted. You can also toggle this from the 423sequences will no longer be emitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePAsteBrackets>. 424ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
420 425
421=item B<-insecure> 426=item B<-insecure>
422 427
423Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
424sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
532 close $pty; 537 close $pty;
533 538
534 # now communicate with rxvt 539 # now communicate with rxvt
535 my $slave = $pty->slave; 540 my $slave = $pty->slave;
536 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";
537 559
538=item B<-pe> I<string> 560=item B<-pe> I<string>
539 561
540Comma-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
541this terminal instance. See resource B<perl-ext> for details. 563this terminal instance. See resource B<perl-ext> for details.
569be used. Command-line arguments can be used to override resource 591be used. Command-line arguments can be used to override resource
570settings. The following resources are supported (you might want to 592settings. The following resources are supported (you might want to
571check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 593check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
572extensions not documented here): 594extensions not documented here):
573 595
574=over 4 596=over
575 597
576=item B<depth:> I<bitdepth> 598=item B<depth:> I<bitdepth>
577 599
578Compile 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;
579option B<-depth>. 601option B<-depth>.
680 702
681B<False>: specify that everything is to be displayed, even 703B<False>: specify that everything is to be displayed, even
682if 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
683monitor to display anything); option B<+ss>. 705monitor to display anything); option B<+ss>.
684 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. A negative number gets negated and directly sets the minimum
714interval between refreshes, that is, C<10> and C<-0.1> both specify
715the same refresh interval (likewise C<50> and C<0.02>). Finally, zero
716makes @@RXVT_NAME@@ refresh as fast as possible. Fractional values are
717supported; option B<-fps>.
718
685=item B<fading:> I<number> 719=item B<fading:> I<number>
686 720
687Fade the text by the given percentage when focus is lost; option B<-fade>. 721Fade the text by the given percentage when focus is lost; option B<-fade>.
688 722
689=item B<fadeColor:> I<colour> 723=item B<fadeColor:> I<colour>
1033button. Instead of selecting a full line it will extend the selection to 1067button. Instead of selecting a full line it will extend the selection to
1034the end of the logical line only; option B<-tcw>. 1068the end of the logical line only; option B<-tcw>.
1035 1069
1036=item B<disablePasteBrackets:> I<boolean> 1070=item B<disablePasteBrackets:> I<boolean>
1037 1071
1038Prevents emission of paste bracket sequences; option B<-dpb>. 1072Prevent emission of paste bracket sequences; option B<-dpb>.
1039 1073
1040=item B<insecure:> I<boolean> 1074=item B<insecure:> I<boolean>
1041 1075
1042Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1076Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1043echo arbitrary strings like the icon name or the locale. This could be 1077echo arbitrary strings like the icon name or the locale. This could be
1044abused if somebody gets 8-bit-clean access to your display, whether 1078abused if somebody gets 8-bit-clean access to your display, whether
1045through a mail client displaying mail bodies unfiltered or through 1079through a mail client displaying mail bodies unfiltered or through
1046write(1) or any other means. Therefore, these sequences are disabled by 1080write(1) or any other means. Therefore, these sequences are disabled by
1047default. (Note that many other terminals, including xterm, have these 1081default. (Note that many other terminals, including xterm, have these
1157prefixed with C<string:>). 1191prefixed with C<string:>).
1158 1192
1159The following action prefixes are known - extensions can provide 1193The following action prefixes are known - extensions can provide
1160additional prefixes: 1194additional prefixes:
1161 1195
1162=over 4 1196=over
1163 1197
1164=item string:STRING 1198=item string:STRING
1165 1199
1166If the I<action> starts with C<string:> (or otherwise contains no colons), 1200If the I<action> starts with C<string:> (or otherwise contains no colons),
1167then the remaining C<STRING> will be passed to the program running in the 1201then the remaining C<STRING> will be passed to the program running in the
1287=item B<perl-ext>: I<string> 1321=item B<perl-ext>: I<string>
1288 1322
1289Comma-separated list(s) of perl extension scripts (default: C<default>) to 1323Comma-separated list(s) of perl extension scripts (default: C<default>) to
1290use in this terminal instance; option B<-pe>. 1324use in this terminal instance; option B<-pe>.
1291 1325
1292Extension names can be prefixed with a C<-> sign to prohibit using 1326Extension names can be prefixed with a C<-> sign to remove them again, in
1293them. This can be useful to selectively disable some extensions loaded 1327case they had been specified earlier. This can be useful to selectively
1294by default, or specified via the C<perl-ext-common> resource. For 1328disable some extensions loaded by default, or specified via the
1295example, C<default,-selection> will use all the default extensions except 1329C<perl-ext-common> resource. For example, C<default,-selection> will use
1296C<selection>. 1330all the default extensions except C<selection>.
1331
1332To prohibit autoloading of extensions, you can prefix them with C</>,
1333which will make urxvt refuse to automatically load them (this can be
1334overridden, however, by specifying the extension name again without a
1335prefix, though). This does not prohibit extensions themselves loading
1336other extensions. For example, C<default,/background> will keep the
1337C<background> extension from being loaded when a background OSC sequence
1338is received.
1297 1339
1298The default set includes the C<selection>, C<option-popup>, 1340The default set includes the C<selection>, C<option-popup>,
1299C<selection-popup>, C<readline> and C<searchable-scrollback> 1341C<selection-popup>, C<readline>, C<searchable-scrollback> and
1300extensions, and extensions which are mentioned in B<keysym> resources. 1342C<confirm-paste> extensions, as well as any extensions which are mentioned
1343in B<keysym> resources.
1301 1344
1302Any extension such that a corresponding resource is given on the 1345Any extension such that a corresponding resource is given on the
1303command line is automatically appended to B<perl-ext>. 1346command line is automatically appended to B<perl-ext>.
1304 1347
1305Each extension is looked up in the library directories, loaded if 1348Each extension is looked up in the library directories, loaded if
1395=head1 THE SELECTION: SELECTING AND PASTING TEXT 1438=head1 THE SELECTION: SELECTING AND PASTING TEXT
1396 1439
1397The behaviour of text selection and insertion/pasting mechanism is similar 1440The behaviour of text selection and insertion/pasting mechanism is similar
1398to I<xterm>(1). 1441to I<xterm>(1).
1399 1442
1400=over 4 1443=over
1401 1444
1402=item B<Selecting>: 1445=item B<Selecting>:
1403 1446
1404Left click at the beginning of the region, drag to the end of the region 1447Left click at the beginning of the region, drag to the end of the region
1405and release; Right click to extend the marked region; Left double-click 1448and release; Right click to extend the marked region; Left double-click
1452and character codes using the keyboard. It consists of 4 parts. The 1495and character codes using the keyboard. It consists of 4 parts. The
1453first part is available if rxvt-unicode has been compiled with 1496first part is available if rxvt-unicode has been compiled with
1454C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1497C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1455with C<--enable-iso14755>. 1498with C<--enable-iso14755>.
1456 1499
1457=over 4 1500=over
1458 1501
1459=item * 5.1: Basic method 1502=item * 5.1: Basic method
1460 1503
1461This allows you to enter unicode characters using their hexcode. 1504This allows you to enter unicode characters using their hexcode.
1462 1505
1642 1685
1643=head1 ENVIRONMENT 1686=head1 ENVIRONMENT
1644 1687
1645B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1688B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1646 1689
1647=over 4 1690=over
1648 1691
1649=item B<TERM> 1692=item B<TERM>
1650 1693
1651Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1694Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1652resources or on the command line. 1695resources or on the command line.
1723 1766
1724=back 1767=back
1725 1768
1726=head1 FILES 1769=head1 FILES
1727 1770
1728=over 4 1771=over
1729 1772
1730=item B</usr/lib/X11/rgb.txt> 1773=item B</usr/lib/X11/rgb.txt>
1731 1774
1732Colour names. 1775Colour names.
1733 1776
1738@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), 1781@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1739@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1782@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1740 1783
1741=head1 CURRENT PROJECT COORDINATOR 1784=head1 CURRENT PROJECT COORDINATOR
1742 1785
1743=over 4 1786=over
1744 1787
1745=item Project Coordinator 1788=item Project Coordinator
1746 1789
1747Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1790Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1748 1791
1750 1793
1751=back 1794=back
1752 1795
1753=head1 AUTHORS 1796=head1 AUTHORS
1754 1797
1755=over 4 1798=over
1756 1799
1757=item John Bovey 1800=item John Bovey
1758 1801
1759University of Kent, 1992, wrote the original Xvt. 1802University of Kent, 1992, wrote the original Xvt.
1760 1803

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines