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.249 by root, Sat Oct 10 20:03:39 2020 UTC vs.
Revision 1.255 by root, Sat Jul 24 11:00:58 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
551be used. Command-line arguments can be used to override resource 569be used. Command-line arguments can be used to override resource
552settings. The following resources are supported (you might want to 570settings. The following resources are supported (you might want to
553check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 571check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554extensions not documented here): 572extensions not documented here):
555 573
556=over 4 574=over
557 575
558=item B<depth:> I<bitdepth> 576=item B<depth:> I<bitdepth>
559 577
560Compile I<xft>: Attempt to find a visual with the given bit depth; 578Compile I<xft>: Attempt to find a visual with the given bit depth;
561option B<-depth>. 579option B<-depth>.
1013 1031
1014Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1015button. Instead of selecting a full line it will extend the selection to 1033button. Instead of selecting a full line it will extend the selection to
1016the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1017 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
1018=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1019 1041
1020Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1021echo arbitrary strings like the icon name or the locale. This could be 1043echo arbitrary strings like the icon name or the locale. This could be
1022abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1023through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1024write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1025default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
1043 1065
1044=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1045 1067
1046Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1047 1069
1070=item B<rewrapMode:> I<mode>
1071
1072Sets long line rewrap behaviour on window resize to one of B<auto>
1073(default), B<always> or B<never>.
1074
1048=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1049 1076
1050Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1051option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1052scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
1089 B<ISOLevel3> B<I> 1116 B<ISOLevel3> B<I>
1090 B<AppKeypad> B<K> 1117 B<AppKeypad> B<K>
1091 B<Control> B<C> 1118 B<Control> B<C>
1092 B<NumLock> B<N> 1119 B<NumLock> B<N>
1093 B<Shift> B<S> 1120 B<Shift> B<S>
1094 B<Meta> B<M>, B<A> 1121 B<Meta> B<M> I<or> B<A>
1095 B<Lock> B<L> 1122 B<Lock> B<L>
1096 B<Mod1> B<1> 1123 B<Mod1> B<1>
1097 B<Mod2> B<2> 1124 B<Mod2> B<2>
1098 B<Mod3> B<3> 1125 B<Mod3> B<3>
1099 B<Mod4> B<4> 1126 B<Mod4> B<4>
1130prefixed with C<string:>). 1157prefixed with C<string:>).
1131 1158
1132The following action prefixes are known - extensions can provide 1159The following action prefixes are known - extensions can provide
1133additional prefixes: 1160additional prefixes:
1134 1161
1135=over 4 1162=over
1136 1163
1137=item string:STRING 1164=item string:STRING
1138 1165
1139If the I<action> starts with C<string:> (or otherwise contains no colons), 1166If 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 1167then the remaining C<STRING> will be passed to the program running in the
1260=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1261 1288
1262Comma-separated list(s) of perl extension scripts (default: C<default>) to 1289Comma-separated list(s) of perl extension scripts (default: C<default>) to
1263use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1264 1291
1265Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to remove them again, in
1266them. This can be useful to selectively disable some extensions loaded 1293case they had been specified earlier. This can be useful to selectively
1267by default, or specified via the C<perl-ext-common> resource. For 1294disable some extensions loaded by default, or specified via the
1268example, C<default,-selection> will use all the default extensions except 1295C<perl-ext-common> resource. For example, C<default,-selection> will use
1269C<selection>. 1296all the default extensions except C<selection>.
1297
1298To prohibit autoloading of extensions, you can prefix them with C</>,
1299which will make urxvt refuse to automatically load them (this can be
1300overriden, however, by specifying the extension name again without a
1301prefix, though). This does not prohibit extensions themselves loading
1302other extensions. For example, C<default,/background> will keep the
1303C<background> extension from being loaded when a background OSC sequence
1304is received.
1270 1305
1271The default set includes the C<selection>, C<option-popup>, 1306The default set includes the C<selection>, C<option-popup>,
1272C<selection-popup>, C<readline> and C<searchable-scrollback> 1307C<selection-popup>, C<readline>, C<searchable-scrollback> and
1273extensions, and extensions which are mentioned in B<keysym> resources. 1308C<confirm-paste> extensions, as well as any extensions which are mentioned
1309in B<keysym> resources.
1274 1310
1275Any extension such that a corresponding resource is given on the 1311Any extension such that a corresponding resource is given on the
1276command line is automatically appended to B<perl-ext>. 1312command line is automatically appended to B<perl-ext>.
1277 1313
1278Each extension is looked up in the library directories, loaded if 1314Each extension is looked up in the library directories, loaded if
1368=head1 THE SELECTION: SELECTING AND PASTING TEXT 1404=head1 THE SELECTION: SELECTING AND PASTING TEXT
1369 1405
1370The behaviour of text selection and insertion/pasting mechanism is similar 1406The behaviour of text selection and insertion/pasting mechanism is similar
1371to I<xterm>(1). 1407to I<xterm>(1).
1372 1408
1373=over 4 1409=over
1374 1410
1375=item B<Selecting>: 1411=item B<Selecting>:
1376 1412
1377Left click at the beginning of the region, drag to the end of the region 1413Left 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 1414and release; Right click to extend the marked region; Left double-click
1425and character codes using the keyboard. It consists of 4 parts. The 1461and character codes using the keyboard. It consists of 4 parts. The
1426first part is available if rxvt-unicode has been compiled with 1462first part is available if rxvt-unicode has been compiled with
1427C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1463C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1428with C<--enable-iso14755>. 1464with C<--enable-iso14755>.
1429 1465
1430=over 4 1466=over
1431 1467
1432=item * 5.1: Basic method 1468=item * 5.1: Basic method
1433 1469
1434This allows you to enter unicode characters using their hexcode. 1470This allows you to enter unicode characters using their hexcode.
1435 1471
1615 1651
1616=head1 ENVIRONMENT 1652=head1 ENVIRONMENT
1617 1653
1618B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1654B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1619 1655
1620=over 4 1656=over
1621 1657
1622=item B<TERM> 1658=item B<TERM>
1623 1659
1624Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1660Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1625resources or on the command line. 1661resources or on the command line.
1696 1732
1697=back 1733=back
1698 1734
1699=head1 FILES 1735=head1 FILES
1700 1736
1701=over 4 1737=over
1702 1738
1703=item B</usr/lib/X11/rgb.txt> 1739=item B</usr/lib/X11/rgb.txt>
1704 1740
1705Colour names. 1741Colour names.
1706 1742
1711@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), 1747@@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) 1748@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1713 1749
1714=head1 CURRENT PROJECT COORDINATOR 1750=head1 CURRENT PROJECT COORDINATOR
1715 1751
1716=over 4 1752=over
1717 1753
1718=item Project Coordinator 1754=item Project Coordinator
1719 1755
1720Marc A. Lehmann <rxvt-unicode@schmorp.de>. 1756Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1721 1757
1723 1759
1724=back 1760=back
1725 1761
1726=head1 AUTHORS 1762=head1 AUTHORS
1727 1763
1728=over 4 1764=over
1729 1765
1730=item John Bovey 1766=item John Bovey
1731 1767
1732University of Kent, 1992, wrote the original Xvt. 1768University of Kent, 1992, wrote the original Xvt.
1733 1769

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines