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.74 by root, Mon Jan 9 07:24:43 2006 UTC vs.
Revision 1.89 by root, Wed Jan 18 21:00:39 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
119daemon. 159daemon.
120 160
121=item I am using Debian GNU/Linux and have a problem... 161=item I am using Debian GNU/Linux and have a problem...
122 162
123The Debian GNU/Linux package of rxvt-unicode in sarge contains large 163The Debian GNU/Linux package of rxvt-unicode in sarge contains large
124patches that considerably change the behaviour of rxvt-unicode. Before 164patches that considerably change the behaviour of rxvt-unicode (but
125reporting a bug to the original rxvt-unicode author please download and 165unfortunately this notice has been removed). Before reporting a bug to
126install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) 166the original rxvt-unicode author please download and install the genuine
127and try to reproduce the problem. If you cannot, chances are that the 167version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
128problems are specific to Debian GNU/Linux, in which case it should be 168the problem. If you cannot, chances are that the problems are specific to
129reported via the Debian Bug Tracking System (use C<reportbug> to report 169Debian GNU/Linux, in which case it should be reported via the Debian Bug
130the bug). 170Tracking System (use C<reportbug> to report the bug).
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.
136 176
137=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 177=item I am maintaining rxvt-unicode for distribution/OS XXX, any
178recommendation?
138 179
139You should build one binary with the default options. F<configure> 180You should build one binary with the default options. F<configure>
140now enables most useful options, and the trend goes to making them 181now enables most useful options, and the trend goes to making them
141runtime-switchable, too, so there is usually no drawback to enbaling them, 182runtime-switchable, too, so there is usually no drawback to enbaling them,
142except higher disk and possibly memory usage. The perl interpreter should 183except higher disk and possibly memory usage. The perl interpreter should
154C<--enable-everything> (less useful, it will be very big due to a lot of 195C<--enable-everything> (less useful, it will be very big due to a lot of
155encodings built-in that increase download times and are rarely used). 196encodings built-in that increase download times and are rarely used).
156 197
157=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? 198=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
158 199
159Likely not. While I honestly try to make it secure, and am probably 200It should be, starting with release 7.1. You are encouraged to properly
160not bad at it, I think it is simply unreasonable to expect all of 201install urxvt with privileges necessary for your OS now.
161freetype + fontconfig + xft + xlib + ... + rxvt-unicode itself to all be
162secure. Also, rxvt-unicode disables some options when it detects that it
163runs setuid or setgid, which is not nice.
164 202
165Elevated privileges are only required for utmp and pty operations on some 203When rxvt-unicode detects that it runs setuid or setgid, it will fork
166systems (for example, GNU/Linux doesn't need any extra privileges for 204into a helper process for privileged operations (pty handling on some
167ptys, but some need it for utmp support). If rxvt-unicode doesn't support 205systems, utmp/wtmp/lastlog handling on others) and drop privileges
168the library/setuid helper that your OS needs I'll be happy to assist you 206immediately. This is much safer than most other terminals that keep
169in implementing support for it. 207privileges while running (but is more relevant to urxvt, as it contains
208things as perl interpreters, which might be "helpful" to attackers).
170 209
171So, while setuid/setgid operation is supported and not a problem on your 210This forking is done as the very first within main(), which is very early
172typical single-user-no-other-logins unix desktop, always remember that 211and reduces possible bugs to initialisation code run before main(), or
173its an awful lot of code, most of which isn't checked for security issues 212things like the dynamic loader of your system, which should result in very
174regularly. 213little risk.
175 214
176=item When I log-in to another system it tells me about missing terminfo data? 215=item When I log-in to another system it tells me about missing terminfo data?
177 216
178The terminal description used by rxvt-unicode is not as widely available 217The terminal description used by rxvt-unicode is not as widely available
179as that for xterm, or even rxvt (for which the same problem often arises). 218as that for xterm, or even rxvt (for which the same problem often arises).
576=item My input method wants <some encoding> but I want UTF-8, what can I do? 615=item My input method wants <some encoding> but I want UTF-8, what can I do?
577 616
578You can specify separate locales for the input method and the rest of the 617You can specify separate locales for the input method and the rest of the
579terminal, using the resource C<imlocale>: 618terminal, using the resource C<imlocale>:
580 619
581 URxvt*imlocale: ja_JP.EUC-JP 620 URxvt.imlocale: ja_JP.EUC-JP
582 621
583Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 622Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
584use your input method. Please note, however, that you will not be able to 623use your input method. Please note, however, that you will not be able to
585input characters outside C<EUC-JP> in a normal way then, as your input 624input characters outside C<EUC-JP> in a normal way then, as your input
586method limits you. 625method limits you.
632 671
633Make sure that mouse reporting is actually turned off since killing 672Make sure that mouse reporting is actually turned off since killing
634some editors prematurely may leave the mouse in mouse report mode. I've 673some editors prematurely may leave the mouse in mouse report mode. I've
635heard that tcsh may use mouse reporting unless it otherwise specified. A 674heard that tcsh may use mouse reporting unless it otherwise specified. A
636quick check is to see if cut/paste works when the Alt or Shift keys are 675quick check is to see if cut/paste works when the Alt or Shift keys are
637depressed. See @@RXVT_NAME@@(7) 676depressed.
638 677
639=item What's with this bold/blink stuff? 678=item What's with this bold/blink stuff?
640 679
641If no bold colour is set via C<colorBD:>, bold will invert text using the 680If no bold colour is set via C<colorBD:>, bold will invert text using the
642standard foreground colour. 681standard foreground colour.
731 770
732 # use Backspace = ^? 771 # use Backspace = ^?
733 $ stty erase ^? 772 $ stty erase ^?
734 $ @@RXVT_NAME@@ 773 $ @@RXVT_NAME@@
735 774
736Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). 775Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
737 776
738For an existing rxvt-unicode: 777For an existing rxvt-unicode:
739 778
740 # use Backspace = ^H 779 # use Backspace = ^H
741 $ stty erase ^H 780 $ stty erase ^H
859 898
860=head1 DESCRIPTION 899=head1 DESCRIPTION
861 900
862The rest of this document describes various technical aspects of 901The rest of this document describes various technical aspects of
863B<rxvt-unicode>. First the description of supported command sequences, 902B<rxvt-unicode>. First the description of supported command sequences,
864followed by menu and pixmap support and last by a description of all 903followed by pixmap support and last by a description of all features
865features selectable at C<configure> time. 904selectable at C<configure> time.
866 905
867=head1 Definitions 906=head1 Definitions
868 907
869=over 4 908=over 4
870 909
1438 B<< C<h> >> Send Mouse X & Y on button press. 1477 B<< C<h> >> Send Mouse X & Y on button press.
1439 B<< C<l> >> No mouse reporting. 1478 B<< C<l> >> No mouse reporting.
1440 1479
1441=end table 1480=end table
1442 1481
1443=item B<< C<Ps = 10> >> (B<rxvt>)
1444
1445=begin table
1446
1447 B<< C<h> >> menuBar visible
1448 B<< C<l> >> menuBar invisible
1449
1450=end table
1451
1452=item B<< C<Ps = 25> >> 1482=item B<< C<Ps = 25> >>
1453 1483
1454=begin table 1484=begin table
1455 1485
1456 B<< C<h> >> Visible cursor {cnorm/cvvis} 1486 B<< C<h> >> Visible cursor {cnorm/cvvis}
1636 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1666 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1637 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1667 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1638 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1668 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1639 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1669 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1640 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1670 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1641 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1671 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1642 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1672 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1643 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1673 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1644 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1674 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1645 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1675 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1646 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1676 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1647 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> >> 1677 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> >>
1648 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1678 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1649 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). 1679 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).
1650 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1651 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1680 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1652 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1681 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1682 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1683 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1653 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1684 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1654 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1685 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1655 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1686 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1656 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1687 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1657 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1688 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1660 1691
1661=end table 1692=end table
1662 1693
1663=back 1694=back
1664 1695
1665X<menuBar>
1666
1667=head1 menuBar
1668
1669B<< The exact syntax used is I<almost> solidified. >>
1670In the menus, B<DON'T> try to use menuBar commands that add or remove a
1671menuBar.
1672
1673Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1674omitted: use B<./> to specify a menu relative to the current menu.
1675
1676=head2 Overview of menuBar operation
1677
1678For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1679of C<Pt> can be used for a variety of tasks:
1680
1681At the top level is the current menuBar which is a member of a circular
1682linked-list of other such menuBars.
1683
1684The menuBar acts as a parent for the various drop-down menus, which in
1685turn, may have labels, separator lines, menuItems and subMenus.
1686
1687The menuItems are the useful bits: you can use them to mimic keyboard
1688input or even to send text or escape sequences back to rxvt.
1689
1690The menuBar syntax is intended to provide a simple yet robust method of
1691constructing and manipulating menus and navigating through the
1692menuBars.
1693
1694The first step is to use the tag B<< [menu:I<name>] >> which creates
1695the menuBar called I<name> and allows access. You may now or menus,
1696subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1697menuBar access as B<readonly> to prevent accidental corruption of the
1698menus. To re-access the current menuBar for alterations, use the tag
1699B<[menu]>, make the alterations and then use B<[done]>
1700
1701X<menuBarCommands>
1702
1703=head2 Commands
1704
1705=over 4
1706
1707=item B<< [menu:+I<name>] >>
1708
1709access the named menuBar for creation or alteration. If a new menuBar
1710is created, it is called I<name> (max of 15 chars) and the current
1711menuBar is pushed onto the stack
1712
1713=item B<[menu]>
1714
1715access the current menuBar for alteration
1716
1717=item B<< [title:+I<string>] >>
1718
1719set the current menuBar's title to I<string>, which may contain the
1720following format specifiers:
1721
1722 B<%n> rxvt name (as per the B<-name> command-line option)
1723 B<%v> rxvt version
1724 B<%%> literal B<%> character
1725
1726=item B<[done]>
1727
1728set menuBar access as B<readonly>.
1729End-of-file tag for B<< [read:+I<file>] >> operations.
1730
1731=item B<< [read:+I<file>] >>
1732
1733read menu commands directly from I<file> (extension ".menu" will be
1734appended if required.) Start reading at a line with B<[menu]> or B<<
1735[menu:+I<name> >> and continuing until B<[done]> is encountered.
1736
1737Blank and comment lines (starting with B<#>) are ignored. Actually,
1738since any invalid menu commands are also ignored, almost anything could
1739be construed as a comment line, but this may be tightened up in the
1740future ... so don't count on it!.
1741
1742=item B<< [read:+I<file>;+I<name>] >>
1743
1744The same as B<< [read:+I<file>] >>, but start reading at a line with
1745B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1746B<[done]> is encountered.
1747
1748=item B<[dump]>
1749
1750dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1751later rereading.
1752
1753=item B<[rm:name]>
1754
1755remove the named menuBar
1756
1757=item B<[rm] [rm:]>
1758
1759remove the current menuBar
1760
1761=item B<[rm*] [rm:*]>
1762
1763remove all menuBars
1764
1765=item B<[swap]>
1766
1767swap the top two menuBars
1768
1769=item B<[prev]>
1770
1771access the previous menuBar
1772
1773=item B<[next]>
1774
1775access the next menuBar
1776
1777=item B<[show]>
1778
1779Enable display of the menuBar
1780
1781=item B<[hide]>
1782
1783Disable display of the menuBar
1784
1785=item B<< [pixmap:+I<name>] >>
1786
1787=item B<< [pixmap:+I<name>;I<scaling>] >>
1788
1789(set the background pixmap globally
1790
1791B<< A Future implementation I<may> make this local to the menubar >>)
1792
1793=item B<< [:+I<command>:] >>
1794
1795ignore the menu readonly status and issue a I<command> to or a menu or
1796menuitem or change the ; a useful shortcut for setting the quick arrows
1797from a menuBar.
1798
1799=back
1800
1801X<menuBarAdd>
1802
1803=head2 Adding and accessing menus
1804
1805The following commands may also be B<+> prefixed.
1806
1807=over 4
1808
1809=item B</+>
1810
1811access menuBar top level
1812
1813=item B<./+>
1814
1815access current menu level
1816
1817=item B<../+>
1818
1819access parent menu (1 level up)
1820
1821=item B<../../>
1822
1823access parent menu (multiple levels up)
1824
1825=item B<< I</path/>menu >>
1826
1827add/access menu
1828
1829=item B<< I</path/>menu/* >>
1830
1831add/access menu and clear it if it exists
1832
1833=item B<< I</path/>{-} >>
1834
1835add separator
1836
1837=item B<< I</path/>{item} >>
1838
1839add B<item> as a label
1840
1841=item B<< I</path/>{item} action >>
1842
1843add/alter I<menuitem> with an associated I<action>
1844
1845=item B<< I</path/>{item}{right-text} >>
1846
1847add/alter I<menuitem> with B<right-text> as the right-justified text
1848and as the associated I<action>
1849
1850=item B<< I</path/>{item}{rtext} action >>
1851
1852add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1853the right-justified text.
1854
1855=back
1856
1857=over 4
1858
1859=item Special characters in I<action> must be backslash-escaped:
1860
1861B<\a \b \E \e \n \r \t \octal>
1862
1863=item or in control-character notation:
1864
1865B<^@, ^A .. ^Z .. ^_, ^?>
1866
1867=back
1868
1869To send a string starting with a B<NUL> (B<^@>) character to the
1870program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1871the first of which will be stripped off and the balance directed to the
1872program. Otherwise if I<action> begins with B<NUL> followed by
1873non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1874balance is sent back to rxvt.
1875
1876As a convenience for the many Emacs-type editors, I<action> may start
1877with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1878appended if missed from B<M-x> commands.
1879
1880As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1881quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1882
1883=over 4
1884
1885=item For example,
1886
1887B<M-xapropos> is equivalent to B<\Exapropos\r>
1888
1889=item and
1890
1891B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1892
1893=back
1894
1895The option B<< {I<right-rtext>} >> will be right-justified. In the
1896absence of a specified action, this text will be used as the I<action>
1897as well.
1898
1899=over 4
1900
1901=item For example,
1902
1903B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1904
1905=back
1906
1907The left label I<is> necessary, since it's used for matching, but
1908implicitly hiding the left label (by using same name for both left and
1909right labels), or explicitly hiding the left label (by preceeding it
1910with a dot), makes it possible to have right-justified text only.
1911
1912=over 4
1913
1914=item For example,
1915
1916B</File/{Open}{Open} Open-File-Action>
1917
1918=item or hiding it
1919
1920B</File/{.anylabel}{Open} Open-File-Action>
1921
1922=back
1923
1924X<menuBarRemove>
1925
1926=head2 Removing menus
1927
1928=over 4
1929
1930=item B<< -/*+ >>
1931
1932remove all menus from the menuBar, the same as B<[clear]>
1933
1934=item B<< -+I</path>menu+ >>
1935
1936remove menu
1937
1938=item B<< -+I</path>{item}+ >>
1939
1940remove item
1941
1942=item B<< -+I</path>{-} >>
1943
1944remove separator)
1945
1946=item B<-/path/menu/*>
1947
1948remove all items, separators and submenus from menu
1949
1950=back
1951
1952X<menuBarArrows>
1953
1954=head2 Quick Arrows
1955
1956The menus also provide a hook for I<quick arrows> to provide easier
1957user access. If nothing has been explicitly set, the default is to
1958emulate the curror keys. The syntax permits each arrow to be altered
1959individually or all four at once without re-entering their common
1960beginning/end text. For example, to explicitly associate cursor actions
1961with the arrows, any of the following forms could be used:
1962
1963=over 4
1964
1965=item B<< <r>+I<Right> >>
1966
1967=item B<< <l>+I<Left> >>
1968
1969=item B<< <u>+I<Up> >>
1970
1971=item B<< <d>+I<Down> >>
1972
1973Define actions for the respective arrow buttons
1974
1975=item B<< <b>+I<Begin> >>
1976
1977=item B<< <e>+I<End> >>
1978
1979Define common beginning/end parts for I<quick arrows> which used in
1980conjunction with the above <r> <l> <u> <d> constructs
1981
1982=back
1983
1984=over 4
1985
1986=item For example, define arrows individually,
1987
1988 <u>\E[A
1989
1990 <d>\E[B
1991
1992 <r>\E[C
1993
1994 <l>\E[D
1995
1996=item or all at once
1997
1998 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1999
2000=item or more compactly (factoring out common parts)
2001
2002 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
2003
2004=back
2005
2006X<menuBarSummary>
2007
2008=head2 Command Summary
2009
2010A short summary of the most I<common> commands:
2011
2012=over 4
2013
2014=item [menu:name]
2015
2016use an existing named menuBar or start a new one
2017
2018=item [menu]
2019
2020use the current menuBar
2021
2022=item [title:string]
2023
2024set menuBar title
2025
2026=item [done]
2027
2028set menu access to readonly and, if reading from a file, signal EOF
2029
2030=item [done:name]
2031
2032if reading from a file using [read:file;name] signal EOF
2033
2034=item [rm:name]
2035
2036remove named menuBar(s)
2037
2038=item [rm] [rm:]
2039
2040remove current menuBar
2041
2042=item [rm*] [rm:*]
2043
2044remove all menuBar(s)
2045
2046=item [swap]
2047
2048swap top two menuBars
2049
2050=item [prev]
2051
2052access the previous menuBar
2053
2054=item [next]
2055
2056access the next menuBar
2057
2058=item [show]
2059
2060map menuBar
2061
2062=item [hide]
2063
2064unmap menuBar
2065
2066=item [pixmap;file]
2067
2068=item [pixmap;file;scaling]
2069
2070set a background pixmap
2071
2072=item [read:file]
2073
2074=item [read:file;name]
2075
2076read in a menu from a file
2077
2078=item [dump]
2079
2080dump out all menuBars to /tmp/rxvt-PID
2081
2082=item /
2083
2084access menuBar top level
2085
2086=item ./
2087
2088=item ../
2089
2090=item ../../
2091
2092access current or parent menu level
2093
2094=item /path/menu
2095
2096add/access menu
2097
2098=item /path/{-}
2099
2100add separator
2101
2102=item /path/{item}{rtext} action
2103
2104add/alter menu item
2105
2106=item -/*
2107
2108remove all menus from the menuBar
2109
2110=item -/path/menu
2111
2112remove menu items, separators and submenus from menu
2113
2114=item -/path/menu
2115
2116remove menu
2117
2118=item -/path/{item}
2119
2120remove item
2121
2122=item -/path/{-}
2123
2124remove separator
2125
2126=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2127
2128menu quick arrows
2129
2130=back
2131X<XPM> 1696X<XPM>
2132 1697
2133=head1 XPM 1698=head1 XPM
2134 1699
2135For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1700For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2462 2027
2463=item --enable-tinting (default: on) 2028=item --enable-tinting (default: on)
2464 2029
2465Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). 2030Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2466 2031
2467=item --enable-menubar (default: off) [DEPRECATED]
2468
2469Add support for our menu bar system (this interacts badly with dynamic
2470locale switching currently). This option is DEPRECATED and will be removed
2471in the future.
2472
2473=item --enable-rxvt-scroll (default: on) 2032=item --enable-rxvt-scroll (default: on)
2474 2033
2475Add support for the original rxvt scrollbar. 2034Add support for the original rxvt scrollbar.
2476 2035
2477=item --enable-next-scroll (default: on) 2036=item --enable-next-scroll (default: on)
2486 2045
2487Add support for a very unobtrusive, plain-looking scrollbar that 2046Add support for a very unobtrusive, plain-looking scrollbar that
2488is the favourite of the rxvt-unicode author, having used it for 2047is the favourite of the rxvt-unicode author, having used it for
2489many years. 2048many years.
2490 2049
2491=item --enable-half-shadow (default: off)
2492
2493Make shadows on the scrollbar only half the normal width & height.
2494only applicable to rxvt scrollbars.
2495
2496=item --enable-ttygid (default: off) 2050=item --enable-ttygid (default: off)
2497 2051
2498Change tty device setting to group "tty" - only use this if 2052Change tty device setting to group "tty" - only use this if
2499your system uses this type of security. 2053your system uses this type of security.
2500 2054
2508do it. 2062do it.
2509 2063
2510=item --disable-resources 2064=item --disable-resources
2511 2065
2512Removes any support for resource checking. 2066Removes any support for resource checking.
2513
2514=item --enable-xgetdefault
2515
2516Make resources checking via XGetDefault() instead of our small
2517version which only checks ~/.Xdefaults, or if that doesn't exist then
2518~/.Xresources.
2519
2520Please note that nowadays, things like XIM will automatically pull in and
2521use the full X resource manager, so the overhead of using it might be very
2522small, if nonexistant.
2523
2524=item --enable-strings (default: off)
2525
2526Add support for our possibly faster memset() function and other
2527various routines, overriding your system's versions which may
2528have been hand-crafted in assembly or may require extra libraries
2529to link in. (this breaks ANSI-C rules and has problems on many
2530GNU/Linux systems).
2531 2067
2532=item --disable-swapscreen 2068=item --disable-swapscreen
2533 2069
2534Remove support for secondary/swap screen. 2070Remove support for secondary/swap screen.
2535 2071

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines