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.253 by root, Sat Jul 3 15:34:35 2021 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
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>.
679option B<-ss>. 701option B<-ss>.
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>.
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>.
684 717
685=item B<fading:> I<number> 718=item B<fading:> I<number>
686 719
687Fade 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>.
688 721
1157prefixed with C<string:>). 1190prefixed with C<string:>).
1158 1191
1159The following action prefixes are known - extensions can provide 1192The following action prefixes are known - extensions can provide
1160additional prefixes: 1193additional prefixes:
1161 1194
1162=over 4 1195=over
1163 1196
1164=item string:STRING 1197=item string:STRING
1165 1198
1166If 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),
1167then 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
1287=item B<perl-ext>: I<string> 1320=item B<perl-ext>: I<string>
1288 1321
1289Comma-separated list(s) of perl extension scripts (default: C<default>) to 1322Comma-separated list(s) of perl extension scripts (default: C<default>) to
1290use in this terminal instance; option B<-pe>. 1323use in this terminal instance; option B<-pe>.
1291 1324
1292Extension 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
1293them. This can be useful to selectively disable some extensions loaded 1326case they had been specified earlier. This can be useful to selectively
1294by default, or specified via the C<perl-ext-common> resource. For 1327disable some extensions loaded by default, or specified via the
1295example, C<default,-selection> will use all the default extensions except 1328C<perl-ext-common> resource. For example, C<default,-selection> will use
1296C<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.
1297 1338
1298The default set includes the C<selection>, C<option-popup>, 1339The default set includes the C<selection>, C<option-popup>,
1299C<selection-popup>, C<readline> and C<searchable-scrollback> 1340C<selection-popup>, C<readline>, C<searchable-scrollback> and
1300extensions, 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.
1301 1343
1302Any extension such that a corresponding resource is given on the 1344Any extension such that a corresponding resource is given on the
1303command line is automatically appended to B<perl-ext>. 1345command line is automatically appended to B<perl-ext>.
1304 1346
1305Each extension is looked up in the library directories, loaded if 1347Each extension is looked up in the library directories, loaded if
1395=head1 THE SELECTION: SELECTING AND PASTING TEXT 1437=head1 THE SELECTION: SELECTING AND PASTING TEXT
1396 1438
1397The behaviour of text selection and insertion/pasting mechanism is similar 1439The behaviour of text selection and insertion/pasting mechanism is similar
1398to I<xterm>(1). 1440to I<xterm>(1).
1399 1441
1400=over 4 1442=over
1401 1443
1402=item B<Selecting>: 1444=item B<Selecting>:
1403 1445
1404Left 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
1405and release; Right click to extend the marked region; Left double-click 1447and release; Right click to extend the marked region; Left double-click
1452and character codes using the keyboard. It consists of 4 parts. The 1494and character codes using the keyboard. It consists of 4 parts. The
1453first part is available if rxvt-unicode has been compiled with 1495first part is available if rxvt-unicode has been compiled with
1454C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1496C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1455with C<--enable-iso14755>. 1497with C<--enable-iso14755>.
1456 1498
1457=over 4 1499=over
1458 1500
1459=item * 5.1: Basic method 1501=item * 5.1: Basic method
1460 1502
1461This allows you to enter unicode characters using their hexcode. 1503This allows you to enter unicode characters using their hexcode.
1462 1504
1642 1684
1643=head1 ENVIRONMENT 1685=head1 ENVIRONMENT
1644 1686
1645B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1687B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1646 1688
1647=over 4 1689=over
1648 1690
1649=item B<TERM> 1691=item B<TERM>
1650 1692
1651Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1693Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1652resources or on the command line. 1694resources or on the command line.
1723 1765
1724=back 1766=back
1725 1767
1726=head1 FILES 1768=head1 FILES
1727 1769
1728=over 4 1770=over
1729 1771
1730=item B</usr/lib/X11/rgb.txt> 1772=item B</usr/lib/X11/rgb.txt>
1731 1773
1732Colour names. 1774Colour names.
1733 1775
1738@@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),
1739@@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)
1740 1782
1741=head1 CURRENT PROJECT COORDINATOR 1783=head1 CURRENT PROJECT COORDINATOR
1742 1784
1743=over 4 1785=over
1744 1786
1745=item Project Coordinator 1787=item Project Coordinator
1746 1788
1747Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1789Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1748 1790
1750 1792
1751=back 1793=back
1752 1794
1753=head1 AUTHORS 1795=head1 AUTHORS
1754 1796
1755=over 4 1797=over
1756 1798
1757=item John Bovey 1799=item John Bovey
1758 1800
1759University of Kent, 1992, wrote the original Xvt. 1801University of Kent, 1992, wrote the original Xvt.
1760 1802

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines