ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.64 by root, Sat Dec 24 12:55:17 2005 UTC vs.
Revision 1.85 by root, Mon Jan 16 15:12:48 2006 UTC

23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 24
25=head1 FREQUENTLY ASKED QUESTIONS 25=head1 FREQUENTLY ASKED QUESTIONS
26 26
27=over 4 27=over 4
28
29=item The new selection selects pieces that are too big, how can I select
30single words?
31
32Yes. For example, if you want to select alphanumeric words, you can use
33the following resource:
34
35 URxvt.selection.pattern-0: ([[:word:]]+)
36
37If you click more than twice, the selection will be extended
38more and more.
39
40To get a selection that is very similar to the old code, try this pattern:
41
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
43
44Please also note that the I<LeftClick Shift-LeftClik> combination also
45selects words like the old code.
46
47=item I don't like the new selection/popups/hotkeys/perl, how do I
48change/disable it?
49
50You can disable the perl extension completely by setting the
51B<perl-ext-common> resource to the empty string, which also keeps
52rxvt-unicode from initialising perl, saving memory.
53
54If you only want to disable specific features, you first have to
55identify which perl extension is responsible. For this, read the section
56B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
57example, to disable the B<selection-popup> and B<option-popup>, specify
58this B<perl-ext-common> resource:
59
60 URxvt.perl-ext-common: default,-selection-popup,-option-popup
61
62This will keep the default extensions, but disable the two popup
63extensions. Some extensions can also be configured, for example,
64scrollback search mode is triggered by B<M-s>. You can move it to any
65other combination either by setting the B<searchable-scrollback> resource:
66
67 URxvt.searchable-scrollback: CM-s
28 68
29=item Isn't rxvt supposed to be small? Don't all those features bloat? 69=item Isn't rxvt supposed to be small? Don't all those features bloat?
30 70
31I often get asked about this, and I think, no, they didn't cause extra 71I often get asked about this, and I think, no, they didn't cause extra
32bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 72bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
62memory. 102memory.
63 103
64Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this 104Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
65still fares rather well. And compared to some monsters like gnome-terminal 105still fares rather well. And compared to some monsters like gnome-terminal
66(21152k + extra 4204k in separate processes) or konsole (22200k + extra 106(21152k + extra 4204k in separate processes) or konsole (22200k + extra
6743180k in daemons that stay around after exit, plus half aminute of 10743180k in daemons that stay around after exit, plus half a minute of
68startup time, including the hundreds of warnings it spits out), it fares 108startup time, including the hundreds of warnings it spits out), it fares
69extremely well *g*. 109extremely well *g*.
70 110
71=item Why C++, isn't that unportable/bloated/uncool? 111=item Why C++, isn't that unportable/bloated/uncool?
72 112
131 171
132For other problems that also affect the Debian package, you can and 172For other problems that also affect the Debian package, you can and
133probably should use the Debian BTS, too, because, after all, it's also a 173probably should use the Debian BTS, too, because, after all, it's also a
134bug in the Debian version and it serves as a reminder for other users that 174bug in the Debian version and it serves as a reminder for other users that
135might encounter the same issue. 175might encounter the same issue.
176
177=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
178
179You should build one binary with the default options. F<configure>
180now enables most useful options, and the trend goes to making them
181runtime-switchable, too, so there is usually no drawback to enbaling them,
182except higher disk and possibly memory usage. The perl interpreter should
183be enabled, as important functionality (menus, selection, likely more in
184the future) depends on it.
185
186You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
187system-wide (except maybe with C<defaults>). This will result in useful
188behaviour. If your distribution aims at low memory, add an empty
189C<perl-ext-common> resource to the app-defaults file. This will keep the
190perl interpreter disabled until the user enables it.
191
192If you can/want build more binaries, I recommend building a minimal
193one with C<--disable-everything> (very useful) and a maximal one with
194C<--enable-everything> (less useful, it will be very big due to a lot of
195encodings built-in that increase download times and are rarely used).
196
197=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
198
199Likely not. While I honestly try to make it secure, and am probably not
200bad at it, I think it is simply unreasonable to expect all of freetype
201+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
202secure. Also, rxvt-unicode disables some options when it detects that it
203runs setuid or setgid, which is not nice. Besides, with the embedded perl
204interpreter the possibility for security problems easily multiplies.
205
206Elevated privileges are only required for utmp and pty operations on some
207systems (for example, GNU/Linux doesn't need any extra privileges for
208ptys, but some need it for utmp support). It is planned to mvoe this into
209a forked handler process, but this is not yet done.
210
211So, while setuid/setgid operation is supported and not a problem on your
212typical single-user-no-other-logins unix desktop, always remember that
213its an awful lot of code, most of which isn't checked for security issues
214regularly.
136 215
137=item When I log-in to another system it tells me about missing terminfo data? 216=item When I log-in to another system it tells me about missing terminfo data?
138 217
139The terminal description used by rxvt-unicode is not as widely available 218The terminal description used by rxvt-unicode is not as widely available
140as that for xterm, or even rxvt (for which the same problem often arises). 219as that for xterm, or even rxvt (for which the same problem often arises).
537=item My input method wants <some encoding> but I want UTF-8, what can I do? 616=item My input method wants <some encoding> but I want UTF-8, what can I do?
538 617
539You can specify separate locales for the input method and the rest of the 618You can specify separate locales for the input method and the rest of the
540terminal, using the resource C<imlocale>: 619terminal, using the resource C<imlocale>:
541 620
542 URxvt*imlocale: ja_JP.EUC-JP 621 URxvt.imlocale: ja_JP.EUC-JP
543 622
544Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 623Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
545use your input method. Please note, however, that you will not be able to 624use your input method. Please note, however, that you will not be able to
546input characters outside C<EUC-JP> in a normal way then, as your input 625input characters outside C<EUC-JP> in a normal way then, as your input
547method limits you. 626method limits you.
593 672
594Make sure that mouse reporting is actually turned off since killing 673Make sure that mouse reporting is actually turned off since killing
595some editors prematurely may leave the mouse in mouse report mode. I've 674some editors prematurely may leave the mouse in mouse report mode. I've
596heard that tcsh may use mouse reporting unless it otherwise specified. A 675heard that tcsh may use mouse reporting unless it otherwise specified. A
597quick check is to see if cut/paste works when the Alt or Shift keys are 676quick check is to see if cut/paste works when the Alt or Shift keys are
598depressed. See @@RXVT_NAME@@(7) 677depressed.
599 678
600=item What's with this bold/blink stuff? 679=item What's with this bold/blink stuff?
601 680
602If no bold colour is set via C<colorBD:>, bold will invert text using the 681If no bold colour is set via C<colorBD:>, bold will invert text using the
603standard foreground colour. 682standard foreground colour.
692 771
693 # use Backspace = ^? 772 # use Backspace = ^?
694 $ stty erase ^? 773 $ stty erase ^?
695 $ @@RXVT_NAME@@ 774 $ @@RXVT_NAME@@
696 775
697Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). 776Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
698 777
699For an existing rxvt-unicode: 778For an existing rxvt-unicode:
700 779
701 # use Backspace = ^H 780 # use Backspace = ^H
702 $ stty erase ^H 781 $ stty erase ^H
820 899
821=head1 DESCRIPTION 900=head1 DESCRIPTION
822 901
823The rest of this document describes various technical aspects of 902The rest of this document describes various technical aspects of
824B<rxvt-unicode>. First the description of supported command sequences, 903B<rxvt-unicode>. First the description of supported command sequences,
825followed by menu and pixmap support and last by a description of all 904followed by pixmap support and last by a description of all features
826features selectable at C<configure> time. 905selectable at C<configure> time.
827 906
828=head1 Definitions 907=head1 Definitions
829 908
830=over 4 909=over 4
831 910
1399 B<< C<h> >> Send Mouse X & Y on button press. 1478 B<< C<h> >> Send Mouse X & Y on button press.
1400 B<< C<l> >> No mouse reporting. 1479 B<< C<l> >> No mouse reporting.
1401 1480
1402=end table 1481=end table
1403 1482
1404=item B<< C<Ps = 10> >> (B<rxvt>)
1405
1406=begin table
1407
1408 B<< C<h> >> menuBar visible
1409 B<< C<l> >> menuBar invisible
1410
1411=end table
1412
1413=item B<< C<Ps = 25> >> 1483=item B<< C<Ps = 25> >>
1414 1484
1415=begin table 1485=begin table
1416 1486
1417 B<< C<h> >> Visible cursor {cnorm/cvvis} 1487 B<< C<h> >> Visible cursor {cnorm/cvvis}
1530 1600
1531=begin table 1601=begin table
1532 1602
1533 B<< C<h> >> Scroll to bottom when a key is pressed 1603 B<< C<h> >> Scroll to bottom when a key is pressed
1534 B<< C<l> >> Don't scroll to bottom when a key is pressed 1604 B<< C<l> >> Don't scroll to bottom when a key is pressed
1605
1606=end table
1607
1608=item B<< C<Ps = 1021> >> (B<rxvt>)
1609
1610=begin table
1611
1612 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1613 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1535 1614
1536=end table 1615=end table
1537 1616
1538=item B<< C<Ps = 1047> >> 1617=item B<< C<Ps = 1047> >>
1539 1618
1588 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1667 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1589 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1668 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1590 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1669 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1591 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1670 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1592 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1671 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1593 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1672 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1594 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1673 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1595 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1674 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1596 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1675 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1597 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1676 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1598 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1677 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1599 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1678 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1600 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1679 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1601 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 1680 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1602 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1603 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1681 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1604 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1682 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1683 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1684 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1605 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1685 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1606 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1686 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1607 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1687 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1608 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1688 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1609 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1689 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1610 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1690 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1691 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1611 1692
1612=end table 1693=end table
1613 1694
1614=back 1695=back
1615 1696
1616X<menuBar>
1617
1618=head1 menuBar
1619
1620B<< The exact syntax used is I<almost> solidified. >>
1621In the menus, B<DON'T> try to use menuBar commands that add or remove a
1622menuBar.
1623
1624Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1625omitted: use B<./> to specify a menu relative to the current menu.
1626
1627=head2 Overview of menuBar operation
1628
1629For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1630of C<Pt> can be used for a variety of tasks:
1631
1632At the top level is the current menuBar which is a member of a circular
1633linked-list of other such menuBars.
1634
1635The menuBar acts as a parent for the various drop-down menus, which in
1636turn, may have labels, separator lines, menuItems and subMenus.
1637
1638The menuItems are the useful bits: you can use them to mimic keyboard
1639input or even to send text or escape sequences back to rxvt.
1640
1641The menuBar syntax is intended to provide a simple yet robust method of
1642constructing and manipulating menus and navigating through the
1643menuBars.
1644
1645The first step is to use the tag B<< [menu:I<name>] >> which creates
1646the menuBar called I<name> and allows access. You may now or menus,
1647subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1648menuBar access as B<readonly> to prevent accidental corruption of the
1649menus. To re-access the current menuBar for alterations, use the tag
1650B<[menu]>, make the alterations and then use B<[done]>
1651
1652X<menuBarCommands>
1653
1654=head2 Commands
1655
1656=over 4
1657
1658=item B<< [menu:+I<name>] >>
1659
1660access the named menuBar for creation or alteration. If a new menuBar
1661is created, it is called I<name> (max of 15 chars) and the current
1662menuBar is pushed onto the stack
1663
1664=item B<[menu]>
1665
1666access the current menuBar for alteration
1667
1668=item B<< [title:+I<string>] >>
1669
1670set the current menuBar's title to I<string>, which may contain the
1671following format specifiers:
1672
1673 B<%n> rxvt name (as per the B<-name> command-line option)
1674 B<%v> rxvt version
1675 B<%%> literal B<%> character
1676
1677=item B<[done]>
1678
1679set menuBar access as B<readonly>.
1680End-of-file tag for B<< [read:+I<file>] >> operations.
1681
1682=item B<< [read:+I<file>] >>
1683
1684read menu commands directly from I<file> (extension ".menu" will be
1685appended if required.) Start reading at a line with B<[menu]> or B<<
1686[menu:+I<name> >> and continuing until B<[done]> is encountered.
1687
1688Blank and comment lines (starting with B<#>) are ignored. Actually,
1689since any invalid menu commands are also ignored, almost anything could
1690be construed as a comment line, but this may be tightened up in the
1691future ... so don't count on it!.
1692
1693=item B<< [read:+I<file>;+I<name>] >>
1694
1695The same as B<< [read:+I<file>] >>, but start reading at a line with
1696B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1697B<[done]> is encountered.
1698
1699=item B<[dump]>
1700
1701dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1702later rereading.
1703
1704=item B<[rm:name]>
1705
1706remove the named menuBar
1707
1708=item B<[rm] [rm:]>
1709
1710remove the current menuBar
1711
1712=item B<[rm*] [rm:*]>
1713
1714remove all menuBars
1715
1716=item B<[swap]>
1717
1718swap the top two menuBars
1719
1720=item B<[prev]>
1721
1722access the previous menuBar
1723
1724=item B<[next]>
1725
1726access the next menuBar
1727
1728=item B<[show]>
1729
1730Enable display of the menuBar
1731
1732=item B<[hide]>
1733
1734Disable display of the menuBar
1735
1736=item B<< [pixmap:+I<name>] >>
1737
1738=item B<< [pixmap:+I<name>;I<scaling>] >>
1739
1740(set the background pixmap globally
1741
1742B<< A Future implementation I<may> make this local to the menubar >>)
1743
1744=item B<< [:+I<command>:] >>
1745
1746ignore the menu readonly status and issue a I<command> to or a menu or
1747menuitem or change the ; a useful shortcut for setting the quick arrows
1748from a menuBar.
1749
1750=back
1751
1752X<menuBarAdd>
1753
1754=head2 Adding and accessing menus
1755
1756The following commands may also be B<+> prefixed.
1757
1758=over 4
1759
1760=item B</+>
1761
1762access menuBar top level
1763
1764=item B<./+>
1765
1766access current menu level
1767
1768=item B<../+>
1769
1770access parent menu (1 level up)
1771
1772=item B<../../>
1773
1774access parent menu (multiple levels up)
1775
1776=item B<< I</path/>menu >>
1777
1778add/access menu
1779
1780=item B<< I</path/>menu/* >>
1781
1782add/access menu and clear it if it exists
1783
1784=item B<< I</path/>{-} >>
1785
1786add separator
1787
1788=item B<< I</path/>{item} >>
1789
1790add B<item> as a label
1791
1792=item B<< I</path/>{item} action >>
1793
1794add/alter I<menuitem> with an associated I<action>
1795
1796=item B<< I</path/>{item}{right-text} >>
1797
1798add/alter I<menuitem> with B<right-text> as the right-justified text
1799and as the associated I<action>
1800
1801=item B<< I</path/>{item}{rtext} action >>
1802
1803add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1804the right-justified text.
1805
1806=back
1807
1808=over 4
1809
1810=item Special characters in I<action> must be backslash-escaped:
1811
1812B<\a \b \E \e \n \r \t \octal>
1813
1814=item or in control-character notation:
1815
1816B<^@, ^A .. ^Z .. ^_, ^?>
1817
1818=back
1819
1820To send a string starting with a B<NUL> (B<^@>) character to the
1821program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1822the first of which will be stripped off and the balance directed to the
1823program. Otherwise if I<action> begins with B<NUL> followed by
1824non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1825balance is sent back to rxvt.
1826
1827As a convenience for the many Emacs-type editors, I<action> may start
1828with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1829appended if missed from B<M-x> commands.
1830
1831As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1832quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1833
1834=over 4
1835
1836=item For example,
1837
1838B<M-xapropos> is equivalent to B<\Exapropos\r>
1839
1840=item and
1841
1842B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1843
1844=back
1845
1846The option B<< {I<right-rtext>} >> will be right-justified. In the
1847absence of a specified action, this text will be used as the I<action>
1848as well.
1849
1850=over 4
1851
1852=item For example,
1853
1854B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1855
1856=back
1857
1858The left label I<is> necessary, since it's used for matching, but
1859implicitly hiding the left label (by using same name for both left and
1860right labels), or explicitly hiding the left label (by preceeding it
1861with a dot), makes it possible to have right-justified text only.
1862
1863=over 4
1864
1865=item For example,
1866
1867B</File/{Open}{Open} Open-File-Action>
1868
1869=item or hiding it
1870
1871B</File/{.anylabel}{Open} Open-File-Action>
1872
1873=back
1874
1875X<menuBarRemove>
1876
1877=head2 Removing menus
1878
1879=over 4
1880
1881=item B<< -/*+ >>
1882
1883remove all menus from the menuBar, the same as B<[clear]>
1884
1885=item B<< -+I</path>menu+ >>
1886
1887remove menu
1888
1889=item B<< -+I</path>{item}+ >>
1890
1891remove item
1892
1893=item B<< -+I</path>{-} >>
1894
1895remove separator)
1896
1897=item B<-/path/menu/*>
1898
1899remove all items, separators and submenus from menu
1900
1901=back
1902
1903X<menuBarArrows>
1904
1905=head2 Quick Arrows
1906
1907The menus also provide a hook for I<quick arrows> to provide easier
1908user access. If nothing has been explicitly set, the default is to
1909emulate the curror keys. The syntax permits each arrow to be altered
1910individually or all four at once without re-entering their common
1911beginning/end text. For example, to explicitly associate cursor actions
1912with the arrows, any of the following forms could be used:
1913
1914=over 4
1915
1916=item B<< <r>+I<Right> >>
1917
1918=item B<< <l>+I<Left> >>
1919
1920=item B<< <u>+I<Up> >>
1921
1922=item B<< <d>+I<Down> >>
1923
1924Define actions for the respective arrow buttons
1925
1926=item B<< <b>+I<Begin> >>
1927
1928=item B<< <e>+I<End> >>
1929
1930Define common beginning/end parts for I<quick arrows> which used in
1931conjunction with the above <r> <l> <u> <d> constructs
1932
1933=back
1934
1935=over 4
1936
1937=item For example, define arrows individually,
1938
1939 <u>\E[A
1940
1941 <d>\E[B
1942
1943 <r>\E[C
1944
1945 <l>\E[D
1946
1947=item or all at once
1948
1949 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1950
1951=item or more compactly (factoring out common parts)
1952
1953 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1954
1955=back
1956
1957X<menuBarSummary>
1958
1959=head2 Command Summary
1960
1961A short summary of the most I<common> commands:
1962
1963=over 4
1964
1965=item [menu:name]
1966
1967use an existing named menuBar or start a new one
1968
1969=item [menu]
1970
1971use the current menuBar
1972
1973=item [title:string]
1974
1975set menuBar title
1976
1977=item [done]
1978
1979set menu access to readonly and, if reading from a file, signal EOF
1980
1981=item [done:name]
1982
1983if reading from a file using [read:file;name] signal EOF
1984
1985=item [rm:name]
1986
1987remove named menuBar(s)
1988
1989=item [rm] [rm:]
1990
1991remove current menuBar
1992
1993=item [rm*] [rm:*]
1994
1995remove all menuBar(s)
1996
1997=item [swap]
1998
1999swap top two menuBars
2000
2001=item [prev]
2002
2003access the previous menuBar
2004
2005=item [next]
2006
2007access the next menuBar
2008
2009=item [show]
2010
2011map menuBar
2012
2013=item [hide]
2014
2015unmap menuBar
2016
2017=item [pixmap;file]
2018
2019=item [pixmap;file;scaling]
2020
2021set a background pixmap
2022
2023=item [read:file]
2024
2025=item [read:file;name]
2026
2027read in a menu from a file
2028
2029=item [dump]
2030
2031dump out all menuBars to /tmp/rxvt-PID
2032
2033=item /
2034
2035access menuBar top level
2036
2037=item ./
2038
2039=item ../
2040
2041=item ../../
2042
2043access current or parent menu level
2044
2045=item /path/menu
2046
2047add/access menu
2048
2049=item /path/{-}
2050
2051add separator
2052
2053=item /path/{item}{rtext} action
2054
2055add/alter menu item
2056
2057=item -/*
2058
2059remove all menus from the menuBar
2060
2061=item -/path/menu
2062
2063remove menu items, separators and submenus from menu
2064
2065=item -/path/menu
2066
2067remove menu
2068
2069=item -/path/{item}
2070
2071remove item
2072
2073=item -/path/{-}
2074
2075remove separator
2076
2077=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2078
2079menu quick arrows
2080
2081=back
2082X<XPM> 1697X<XPM>
2083 1698
2084=head1 XPM 1699=head1 XPM
2085 1700
2086For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1701For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2396 2011
2397Write user and tty to lastlog file (used by programs like 2012Write user and tty to lastlog file (used by programs like
2398F<lastlogin>) at start of rxvt execution. This option requires 2013F<lastlogin>) at start of rxvt execution. This option requires
2399--enable-utmp to also be specified. 2014--enable-utmp to also be specified.
2400 2015
2401=item --enable-xpm-background (default: off) 2016=item --enable-xpm-background (default: on)
2402 2017
2403Add support for XPM background pixmaps. 2018Add support for XPM background pixmaps.
2404 2019
2405=item --enable-transparency (default: off) 2020=item --enable-transparency (default: on)
2406 2021
2407Add support for inheriting parent backgrounds thus giving a fake 2022Add support for inheriting parent backgrounds thus giving a fake
2408transparency to the term. 2023transparency to the term.
2409 2024
2410=item --enable-fading (default: on) 2025=item --enable-fading (default: on)
2412Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2027Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2413 2028
2414=item --enable-tinting (default: on) 2029=item --enable-tinting (default: on)
2415 2030
2416Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). 2031Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2417
2418=item --enable-menubar (default: off)
2419
2420Add support for our menu bar system (this interacts badly with
2421dynamic locale switching currently).
2422 2032
2423=item --enable-rxvt-scroll (default: on) 2033=item --enable-rxvt-scroll (default: on)
2424 2034
2425Add support for the original rxvt scrollbar. 2035Add support for the original rxvt scrollbar.
2426 2036
2459 2069
2460=item --disable-resources 2070=item --disable-resources
2461 2071
2462Removes any support for resource checking. 2072Removes any support for resource checking.
2463 2073
2464=item --enable-xgetdefault
2465
2466Make resources checking via XGetDefault() instead of our small
2467version which only checks ~/.Xdefaults, or if that doesn't exist then
2468~/.Xresources.
2469
2470Please note that nowadays, things like XIM will automatically pull in and
2471use the full X resource manager, so the overhead of using it might be very
2472small, if nonexistant.
2473
2474=item --enable-strings (default: off)
2475
2476Add support for our possibly faster memset() function and other
2477various routines, overriding your system's versions which may
2478have been hand-crafted in assembly or may require extra libraries
2479to link in. (this breaks ANSI-C rules and has problems on many
2480GNU/Linux systems).
2481
2482=item --disable-swapscreen 2074=item --disable-swapscreen
2483 2075
2484Remove support for secondary/swap screen. 2076Remove support for secondary/swap screen.
2485 2077
2486=item --enable-frills (default: on) 2078=item --enable-frills (default: on)
2492A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2084A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2493in combination with other switches) is: 2085in combination with other switches) is:
2494 2086
2495 MWM-hints 2087 MWM-hints
2496 EWMH-hints (pid, utf8 names) and protocols (ping) 2088 EWMH-hints (pid, utf8 names) and protocols (ping)
2497 seperate underline colour 2089 seperate underline colour (-underlineColor)
2498 settable border widths and borderless switch 2090 settable border widths and borderless switch (-w, -b, -bl)
2499 settable extra linespacing 2091 settable extra linespacing /-lsp)
2500 iso-14755-2 and -3, and visual feedback 2092 iso-14755-2 and -3, and visual feedback
2501 backindex and forwardindex escape sequence 2093 backindex and forwardindex escape sequence
2502 window op and some xterm/OSC escape sequences 2094 window op and some xterm/OSC escape sequences
2503 tripleclickwords 2095 tripleclickwords (-tcw)
2504 settable insecure mode 2096 settable insecure mode (-insecure)
2505 keysym remapping support 2097 keysym remapping support
2506 cursor blinking and underline cursor 2098 cursor blinking and underline cursor (-cb, -uc)
2507 -embed, -pty-fd and -hold options 2099 XEmbed support (-embed)
2100 user-pty (-pty-fd)
2101 hold on exit (-hold)
2102 skip builtin block graphics (-sbg)
2103 sgr modes 90..97 and 100..107
2508 2104
2509=item --enable-iso14755 (default: on) 2105=item --enable-iso14755 (default: on)
2510 2106
2511Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2107Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2512F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2108F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2555 2151
2556=item --enable-pointer-blank (default: on) 2152=item --enable-pointer-blank (default: on)
2557 2153
2558Add support to have the pointer disappear when typing or inactive. 2154Add support to have the pointer disappear when typing or inactive.
2559 2155
2156=item --enable-perl (default: off)
2157
2158Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2159manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2160in F<src/perl-ext/> for the extensions that are installed by default. The
2161perl interpreter that is used can be specified via the C<PERL> environment
2162variable when running configure.
2163
2560=item --with-name=NAME (default: urxvt) 2164=item --with-name=NAME (default: urxvt)
2561 2165
2562Set the basename for the installed binaries, resulting 2166Set the basename for the installed binaries, resulting
2563in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2167in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2564C<rxvt>. 2168C<rxvt>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines