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

Comparing rxvt-unicode/doc/rxvt.7.man.in (file contents):
Revision 1.38 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.47 by root, Mon Jan 16 15:07:27 2006 UTC

127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 7" 131.IX Title "rxvt 7"
132.TH rxvt 7 "2006-01-10" "6.3" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-16" "7.0" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134RXVT REFERENCE \- FAQ, command sequences and other background information 134RXVT REFERENCE \- FAQ, command sequences and other background information
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 2 137.Vb 2
156The newest version of this document is 156The newest version of this document is
157also available on the World Wide Web at 157also available on the World Wide Web at
158<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>. 158<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
159.SH "FREQUENTLY ASKED QUESTIONS" 159.SH "FREQUENTLY ASKED QUESTIONS"
160.IX Header "FREQUENTLY ASKED QUESTIONS" 160.IX Header "FREQUENTLY ASKED QUESTIONS"
161.IP "The new selection selects pieces that are too big, how can I select single words?" 4
162.IX Item "The new selection selects pieces that are too big, how can I select single words?"
163Yes. For example, if you want to select alphanumeric words, you can use
164the following resource:
165.Sp
166.Vb 1
167\& URxvt.selection.pattern-0: ([[:word:]]+)
168.Ve
169.Sp
170If you click more than twice, the selection will be extended
171more and more.
172.Sp
173To get a selection that is very similar to the old code, try this pattern:
174.Sp
175.Vb 1
176\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+)
177.Ve
178.Sp
179Please also note that the \fILeftClick Shift-LeftClik\fR combination also
180selects words like the old code.
181.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4
182.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?"
183You can disable the perl extension completely by setting the
184\&\fBperl-ext-common\fR resource to the empty string, which also keeps
185rxvt-unicode from initialising perl, saving memory.
186.Sp
187If you only want to disable specific features, you first have to
188identify which perl extension is responsible. For this, read the section
189\&\fB\s-1PREPACKAGED\s0 \s-1EXTENSIONS\s0\fR in the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. For
190example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify
191this \fBperl-ext-common\fR resource:
192.Sp
193.Vb 1
194\& URxvt.perl-ext-common: default,-selection-popup,-option-popup
195.Ve
196.Sp
197This will keep the default extensions, but disable the two popup
198extensions. Some extensions can also be configured, for example,
199scrollback search mode is triggered by \fBM\-s\fR. You can move it to any
200other combination either by setting the \fBsearchable-scrollback\fR resource:
201.Sp
202.Vb 1
203\& URxvt.searchable-scrollback: CM-s
204.Ve
161.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4 205.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4
162.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?" 206.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?"
163I often get asked about this, and I think, no, they didn't cause extra 207I often get asked about this, and I think, no, they didn't cause extra
164bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 208bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
165that the urxvt binary is larger (due to some encoding tables always being 209that the urxvt binary is larger (due to some encoding tables always being
288one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with 332one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with
289\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of 333\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of
290encodings built-in that increase download times and are rarely used). 334encodings built-in that increase download times and are rarely used).
291.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4 335.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4
292.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?" 336.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?"
293Likely not. While I honestly try to make it secure, and am probably 337Likely not. While I honestly try to make it secure, and am probably not
294not bad at it, I think it is simply unreasonable to expect all of 338bad at it, I think it is simply unreasonable to expect all of freetype
295freetype + fontconfig + xft + xlib + ... + rxvt-unicode itself to all be 339+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
296secure. Also, rxvt-unicode disables some options when it detects that it 340secure. Also, rxvt-unicode disables some options when it detects that it
297runs setuid or setgid, which is not nice. 341runs setuid or setgid, which is not nice. Besides, with the embedded perl
342interpreter the possibility for security problems easily multiplies.
298.Sp 343.Sp
299Elevated privileges are only required for utmp and pty operations on some 344Elevated privileges are only required for utmp and pty operations on some
300systems (for example, GNU/Linux doesn't need any extra privileges for 345systems (for example, GNU/Linux doesn't need any extra privileges for
301ptys, but some need it for utmp support). If rxvt-unicode doesn't support 346ptys, but some need it for utmp support). It is planned to mvoe this into
302the library/setuid helper that your \s-1OS\s0 needs I'll be happy to assist you 347a forked handler process, but this is not yet done.
303in implementing support for it.
304.Sp 348.Sp
305So, while setuid/setgid operation is supported and not a problem on your 349So, while setuid/setgid operation is supported and not a problem on your
306typical single-user-no-other-logins unix desktop, always remember that 350typical single-user-no-other-logins unix desktop, always remember that
307its an awful lot of code, most of which isn't checked for security issues 351its an awful lot of code, most of which isn't checked for security issues
308regularly. 352regularly.
731.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?" 775.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?"
732You can specify separate locales for the input method and the rest of the 776You can specify separate locales for the input method and the rest of the
733terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR: 777terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
734.Sp 778.Sp
735.Vb 1 779.Vb 1
736\& URxvt*imlocale: ja_JP.EUC-JP 780\& URxvt.imlocale: ja_JP.EUC-JP
737.Ve 781.Ve
738.Sp 782.Sp
739Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still 783Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
740use your input method. Please note, however, that you will not be able to 784use your input method. Please note, however, that you will not be able to
741input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input 785input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input
783.IX Item "Mouse cut/paste suddenly no longer works." 827.IX Item "Mouse cut/paste suddenly no longer works."
784Make sure that mouse reporting is actually turned off since killing 828Make sure that mouse reporting is actually turned off since killing
785some editors prematurely may leave the mouse in mouse report mode. I've 829some editors prematurely may leave the mouse in mouse report mode. I've
786heard that tcsh may use mouse reporting unless it otherwise specified. A 830heard that tcsh may use mouse reporting unless it otherwise specified. A
787quick check is to see if cut/paste works when the Alt or Shift keys are 831quick check is to see if cut/paste works when the Alt or Shift keys are
788depressed. See @@RXVT_NAME@@(7) 832depressed.
789.IP "What's with this bold/blink stuff?" 4 833.IP "What's with this bold/blink stuff?" 4
790.IX Item "What's with this bold/blink stuff?" 834.IX Item "What's with this bold/blink stuff?"
791If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the 835If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
792standard foreground colour. 836standard foreground colour.
793.Sp 837.Sp
888\& # use Backspace = ^? 932\& # use Backspace = ^?
889\& $ stty erase ^? 933\& $ stty erase ^?
890\& $ @@RXVT_NAME@@ 934\& $ @@RXVT_NAME@@
891.Ve 935.Ve
892.Sp 936.Sp
893Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR as documented in @@RXVT_NAME@@(7). 937Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR.
894.Sp 938.Sp
895For an existing rxvt\-unicode: 939For an existing rxvt\-unicode:
896.Sp 940.Sp
897.Vb 3 941.Vb 3
898\& # use Backspace = ^H 942\& # use Backspace = ^H
1572l l . 1616l l .
1573h Send Mouse X & Y on button press. 1617h Send Mouse X & Y on button press.
1574l No mouse reporting. 1618l No mouse reporting.
1575.TE 1619.TE
1576 1620
1577.ie n .IP "\fB\fB""Ps = 10""\fB\fR (\fBrxvt\fR)" 4
1578.el .IP "\fB\f(CBPs = 10\fB\fR (\fBrxvt\fR)" 4
1579.IX Item "Ps = 10 (rxvt)"
1580.TS
1581l l .
1582h menuBar visible
1583l menuBar invisible
1584.TE
1585
1586.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 1621.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4
1587.el .IP "\fB\f(CBPs = 25\fB\fR" 4 1622.el .IP "\fB\f(CBPs = 25\fB\fR" 4
1588.IX Item "Ps = 25" 1623.IX Item "Ps = 25"
1589.TS 1624.TS
1590l l . 1625l l .
1774Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1809Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1775Ps = 11 Change colour of text background to Pt (NB: may change in future) 1810Ps = 11 Change colour of text background to Pt (NB: may change in future)
1776Ps = 12 Change colour of text cursor foreground to Pt 1811Ps = 12 Change colour of text cursor foreground to Pt
1777Ps = 13 Change colour of mouse foreground to Pt 1812Ps = 13 Change colour of mouse foreground to Pt
1778Ps = 17 Change colour of highlight characters to Pt 1813Ps = 17 Change colour of highlight characters to Pt
1779Ps = 18 Change colour of bold characters to Pt 1814Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1780Ps = 19 Change colour of underlined characters to Pt 1815Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1781Ps = 20 Change default background to Pt 1816Ps = 20 Change default background to Pt
1782Ps = 39 Change default foreground colour to Pt. 1817Ps = 39 Change default foreground colour to Pt.
1783Ps = 46 Change Log File to Pt unimplemented 1818Ps = 46 Change Log File to Pt unimplemented
1784Ps = 49 Change default background colour to Pt. 1819Ps = 49 Change default background colour to Pt.
1785Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n 1820Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1786Ps = 55 Log all scrollback buffer and all of screen to Pt 1821Ps = 55 Log all scrollback buffer and all of screen to Pt
1787Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1822Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1788Ps = 703 Menubar command Pt (Compile menubar).
1789Ps = 704 Change colour of italic characters to Pt 1823Ps = 704 Change colour of italic characters to Pt
1790Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1824Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1825Ps = 706 Change colour of bold characters to Pt
1826Ps = 707 Change colour of underlined characters to Pt
1791Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1827Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1792Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). 1828Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1793Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1829Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1794Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1830Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1795Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1831Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1797Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). 1833Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1798.TE 1834.TE
1799 1835
1800.PP 1836.PP
1801 1837
1802.IX Xref "menuBar" 1838.IX Xref "XPM"
1803.SH "menuBar"
1804.IX Header "menuBar"
1805\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1806In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1807menuBar.
1808.PP
1809Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1810omitted: use \fB./\fR to specify a menu relative to the current menu.
1811.Sh "Overview of menuBar operation"
1812.IX Subsection "Overview of menuBar operation"
1813For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1814of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1815.PP
1816At the top level is the current menuBar which is a member of a circular
1817linked-list of other such menuBars.
1818.PP
1819The menuBar acts as a parent for the various drop-down menus, which in
1820turn, may have labels, separator lines, menuItems and subMenus.
1821.PP
1822The menuItems are the useful bits: you can use them to mimic keyboard
1823input or even to send text or escape sequences back to rxvt.
1824.PP
1825The menuBar syntax is intended to provide a simple yet robust method of
1826constructing and manipulating menus and navigating through the
1827menuBars.
1828.PP
1829The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1830the menuBar called \fIname\fR and allows access. You may now or menus,
1831subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1832menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1833menus. To re-access the current menuBar for alterations, use the tag
1834\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1835.PP
1836
1837.IX Xref "menuBarCommands"
1838.Sh "Commands"
1839.IX Subsection "Commands"
1840.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1841.IX Item "[menu:+name]"
1842access the named menuBar for creation or alteration. If a new menuBar
1843is created, it is called \fIname\fR (max of 15 chars) and the current
1844menuBar is pushed onto the stack
1845.IP "\fB[menu]\fR" 4
1846.IX Item "[menu]"
1847access the current menuBar for alteration
1848.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1849.IX Item "[title:+string]"
1850set the current menuBar's title to \fIstring\fR, which may contain the
1851following format specifiers:
1852.Sp
1853.Vb 3
1854\& B<%n> rxvt name (as per the B<-name> command-line option)
1855\& B<%v> rxvt version
1856\& B<%%> literal B<%> character
1857.Ve
1858.IP "\fB[done]\fR" 4
1859.IX Item "[done]"
1860set menuBar access as \fBreadonly\fR.
1861End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1862.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1863.IX Item "[read:+file]"
1864read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1865appended if required.) Start reading at a line with \fB[menu]\fR or \fB[menu:+\f(BIname\fB\fR and continuing until \fB[done]\fR is encountered.
1866.Sp
1867Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1868since any invalid menu commands are also ignored, almost anything could
1869be construed as a comment line, but this may be tightened up in the
1870future ... so don't count on it!.
1871.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1872.IX Item "[read:+file;+name]"
1873The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1874\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1875\&\fB[done]\fR is encountered.
1876.IP "\fB[dump]\fR" 4
1877.IX Item "[dump]"
1878dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1879later rereading.
1880.IP "\fB[rm:name]\fR" 4
1881.IX Item "[rm:name]"
1882remove the named menuBar
1883.IP "\fB[rm] [rm:]\fR" 4
1884.IX Item "[rm] [rm:]"
1885remove the current menuBar
1886.IP "\fB[rm*] [rm:*]\fR" 4
1887.IX Item "[rm*] [rm:*]"
1888remove all menuBars
1889.IP "\fB[swap]\fR" 4
1890.IX Item "[swap]"
1891swap the top two menuBars
1892.IP "\fB[prev]\fR" 4
1893.IX Item "[prev]"
1894access the previous menuBar
1895.IP "\fB[next]\fR" 4
1896.IX Item "[next]"
1897access the next menuBar
1898.IP "\fB[show]\fR" 4
1899.IX Item "[show]"
1900Enable display of the menuBar
1901.IP "\fB[hide]\fR" 4
1902.IX Item "[hide]"
1903Disable display of the menuBar
1904.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1905.IX Item "[pixmap:+name]"
1906.PD 0
1907.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1908.IX Item "[pixmap:+name;scaling]"
1909.PD
1910(set the background pixmap globally
1911.Sp
1912\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1913.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1914.IX Item "[:+command:]"
1915ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1916menuitem or change the ; a useful shortcut for setting the quick arrows
1917from a menuBar.
1918.PP
1919
1920.IX Xref "menuBarAdd"
1921.Sh "Adding and accessing menus"
1922.IX Subsection "Adding and accessing menus"
1923The following commands may also be \fB+\fR prefixed.
1924.IP "\fB/+\fR" 4
1925.IX Item "/+"
1926access menuBar top level
1927.IP "\fB./+\fR" 4
1928.IX Item "./+"
1929access current menu level
1930.IP "\fB../+\fR" 4
1931.IX Item "../+"
1932access parent menu (1 level up)
1933.IP "\fB../../\fR" 4
1934.IX Item "../../"
1935access parent menu (multiple levels up)
1936.IP "\fB\f(BI/path/\fBmenu\fR" 4
1937.IX Item "/path/menu"
1938add/access menu
1939.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1940.IX Item "/path/menu/*"
1941add/access menu and clear it if it exists
1942.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1943.IX Item "/path/{-}"
1944add separator
1945.IP "\fB\f(BI/path/\fB{item}\fR" 4
1946.IX Item "/path/{item}"
1947add \fBitem\fR as a label
1948.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1949.IX Item "/path/{item} action"
1950add/alter \fImenuitem\fR with an associated \fIaction\fR
1951.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1952.IX Item "/path/{item}{right-text}"
1953add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1954and as the associated \fIaction\fR
1955.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1956.IX Item "/path/{item}{rtext} action"
1957add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
1958the right-justified text.
1959.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
1960.IX Item "Special characters in action must be backslash-escaped:"
1961\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
1962.IP "or in control-character notation:" 4
1963.IX Item "or in control-character notation:"
1964\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
1965.PP
1966To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
1967program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
1968the first of which will be stripped off and the balance directed to the
1969program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
1970non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
1971balance is sent back to rxvt.
1972.PP
1973As a convenience for the many Emacs-type editors, \fIaction\fR may start
1974with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
1975appended if missed from \fBM\-x\fR commands.
1976.PP
1977As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
1978quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
1979.IP "For example," 4
1980.IX Item "For example,"
1981\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
1982.IP "and" 4
1983.IX Item "and"
1984\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
1985.PP
1986The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
1987absence of a specified action, this text will be used as the \fIaction\fR
1988as well.
1989.IP "For example," 4
1990.IX Item "For example,"
1991\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
1992.PP
1993The left label \fIis\fR necessary, since it's used for matching, but
1994implicitly hiding the left label (by using same name for both left and
1995right labels), or explicitly hiding the left label (by preceeding it
1996with a dot), makes it possible to have right-justified text only.
1997.IP "For example," 4
1998.IX Item "For example,"
1999\&\fB/File/{Open}{Open} Open-File-Action\fR
2000.IP "or hiding it" 4
2001.IX Item "or hiding it"
2002\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
2003.PP
2004
2005.IX Xref "menuBarRemove"
2006.Sh "Removing menus"
2007.IX Subsection "Removing menus"
2008.IP "\fB\-/*+\fR" 4
2009.IX Item "-/*+"
2010remove all menus from the menuBar, the same as \fB[clear]\fR
2011.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
2012.IX Item "-+/pathmenu+"
2013remove menu
2014.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
2015.IX Item "-+/path{item}+"
2016remove item
2017.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
2018.IX Item "-+/path{-}"
2019remove separator)
2020.IP "\fB\-/path/menu/*\fR" 4
2021.IX Item "-/path/menu/*"
2022remove all items, separators and submenus from menu
2023.PP
2024
2025.IX Xref "menuBarArrows"
2026.Sh "Quick Arrows"
2027.IX Subsection "Quick Arrows"
2028The menus also provide a hook for \fIquick arrows\fR to provide easier
2029user access. If nothing has been explicitly set, the default is to
2030emulate the curror keys. The syntax permits each arrow to be altered
2031individually or all four at once without re-entering their common
2032beginning/end text. For example, to explicitly associate cursor actions
2033with the arrows, any of the following forms could be used:
2034.IP "\fB<r>+\f(BIRight\fB\fR" 4
2035.IX Item "<r>+Right"
2036.PD 0
2037.IP "\fB<l>+\f(BILeft\fB\fR" 4
2038.IX Item "<l>+Left"
2039.IP "\fB<u>+\f(BIUp\fB\fR" 4
2040.IX Item "<u>+Up"
2041.IP "\fB<d>+\f(BIDown\fB\fR" 4
2042.IX Item "<d>+Down"
2043.PD
2044Define actions for the respective arrow buttons
2045.IP "\fB<b>+\f(BIBegin\fB\fR" 4
2046.IX Item "<b>+Begin"
2047.PD 0
2048.IP "\fB<e>+\f(BIEnd\fB\fR" 4
2049.IX Item "<e>+End"
2050.PD
2051Define common beginning/end parts for \fIquick arrows\fR which used in
2052conjunction with the above <r> <l> <u> <d> constructs
2053.IP "For example, define arrows individually," 4
2054.IX Item "For example, define arrows individually,"
2055.Vb 1
2056\& <u>\eE[A
2057.Ve
2058.Sp
2059.Vb 1
2060\& <d>\eE[B
2061.Ve
2062.Sp
2063.Vb 1
2064\& <r>\eE[C
2065.Ve
2066.Sp
2067.Vb 1
2068\& <l>\eE[D
2069.Ve
2070.IP "or all at once" 4
2071.IX Item "or all at once"
2072.Vb 1
2073\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
2074.Ve
2075.IP "or more compactly (factoring out common parts)" 4
2076.IX Item "or more compactly (factoring out common parts)"
2077.Vb 1
2078\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
2079.Ve
2080.PP
2081
2082.IX Xref "menuBarSummary"
2083.Sh "Command Summary"
2084.IX Subsection "Command Summary"
2085A short summary of the most \fIcommon\fR commands:
2086.IP "[menu:name]" 4
2087.IX Item "[menu:name]"
2088use an existing named menuBar or start a new one
2089.IP "[menu]" 4
2090.IX Item "[menu]"
2091use the current menuBar
2092.IP "[title:string]" 4
2093.IX Item "[title:string]"
2094set menuBar title
2095.IP "[done]" 4
2096.IX Item "[done]"
2097set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
2098.IP "[done:name]" 4
2099.IX Item "[done:name]"
2100if reading from a file using [read:file;name] signal \s-1EOF\s0
2101.IP "[rm:name]" 4
2102.IX Item "[rm:name]"
2103remove named menuBar(s)
2104.IP "[rm] [rm:]" 4
2105.IX Item "[rm] [rm:]"
2106remove current menuBar
2107.IP "[rm*] [rm:*]" 4
2108.IX Item "[rm*] [rm:*]"
2109remove all menuBar(s)
2110.IP "[swap]" 4
2111.IX Item "[swap]"
2112swap top two menuBars
2113.IP "[prev]" 4
2114.IX Item "[prev]"
2115access the previous menuBar
2116.IP "[next]" 4
2117.IX Item "[next]"
2118access the next menuBar
2119.IP "[show]" 4
2120.IX Item "[show]"
2121map menuBar
2122.IP "[hide]" 4
2123.IX Item "[hide]"
2124unmap menuBar
2125.IP "[pixmap;file]" 4
2126.IX Item "[pixmap;file]"
2127.PD 0
2128.IP "[pixmap;file;scaling]" 4
2129.IX Item "[pixmap;file;scaling]"
2130.PD
2131set a background pixmap
2132.IP "[read:file]" 4
2133.IX Item "[read:file]"
2134.PD 0
2135.IP "[read:file;name]" 4
2136.IX Item "[read:file;name]"
2137.PD
2138read in a menu from a file
2139.IP "[dump]" 4
2140.IX Item "[dump]"
2141dump out all menuBars to /tmp/rxvt\-PID
2142.IP "/" 4
2143access menuBar top level
2144.IP "./" 4
2145.PD 0
2146.IP "../" 4
2147.IP "../../" 4
2148.PD
2149access current or parent menu level
2150.IP "/path/menu" 4
2151.IX Item "/path/menu"
2152add/access menu
2153.IP "/path/{\-}" 4
2154.IX Item "/path/{-}"
2155add separator
2156.IP "/path/{item}{rtext} action" 4
2157.IX Item "/path/{item}{rtext} action"
2158add/alter menu item
2159.IP "\-/*" 4
2160remove all menus from the menuBar
2161.IP "\-/path/menu" 4
2162.IX Item "-/path/menu"
2163remove menu items, separators and submenus from menu
2164.IP "\-/path/menu" 4
2165.IX Item "-/path/menu"
2166remove menu
2167.IP "\-/path/{item}" 4
2168.IX Item "-/path/{item}"
2169remove item
2170.IP "\-/path/{\-}" 4
2171.IX Item "-/path/{-}"
2172remove separator
2173.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2174.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2175menu quick arrows
2176.SH "XPM" 1839.SH "XPM"
2177.IX Header "XPM" 1840.IX Header "XPM"
2178For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value 1841For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value
2179of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a 1842of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a
2180sequence of scaling/positioning commands separated by semi\-colons. The 1843sequence of scaling/positioning commands separated by semi\-colons. The
2450.IX Item "--enable-fading (default: on)" 2113.IX Item "--enable-fading (default: on)"
2451Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2114Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2452.IP "\-\-enable\-tinting (default: on)" 4 2115.IP "\-\-enable\-tinting (default: on)" 4
2453.IX Item "--enable-tinting (default: on)" 2116.IX Item "--enable-tinting (default: on)"
2454Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2117Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2455.IP "\-\-enable\-menubar (default: off) [\s-1DEPRECATED\s0]" 4
2456.IX Item "--enable-menubar (default: off) [DEPRECATED]"
2457Add support for our menu bar system (this interacts badly with dynamic
2458locale switching currently). This option is \s-1DEPRECATED\s0 and will be removed
2459in the future.
2460.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2118.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2461.IX Item "--enable-rxvt-scroll (default: on)" 2119.IX Item "--enable-rxvt-scroll (default: on)"
2462Add support for the original rxvt scrollbar. 2120Add support for the original rxvt scrollbar.
2463.IP "\-\-enable\-next\-scroll (default: on)" 4 2121.IP "\-\-enable\-next\-scroll (default: on)" 4
2464.IX Item "--enable-next-scroll (default: on)" 2122.IX Item "--enable-next-scroll (default: on)"
2487Removes any handling of the delete key by us \- let the X server 2145Removes any handling of the delete key by us \- let the X server
2488do it. 2146do it.
2489.IP "\-\-disable\-resources" 4 2147.IP "\-\-disable\-resources" 4
2490.IX Item "--disable-resources" 2148.IX Item "--disable-resources"
2491Removes any support for resource checking. 2149Removes any support for resource checking.
2492.IP "\-\-enable\-xgetdefault" 4
2493.IX Item "--enable-xgetdefault"
2494Make resources checking via \fIXGetDefault()\fR instead of our small
2495version which only checks ~/.Xdefaults, or if that doesn't exist then
2496~/.Xresources.
2497.Sp
2498Please note that nowadays, things like \s-1XIM\s0 will automatically pull in and
2499use the full X resource manager, so the overhead of using it might be very
2500small, if nonexistant.
2501.IP "\-\-enable\-strings (default: off)" 4
2502.IX Item "--enable-strings (default: off)"
2503Add support for our possibly faster \fImemset()\fR function and other
2504various routines, overriding your system's versions which may
2505have been hand-crafted in assembly or may require extra libraries
2506to link in. (this breaks ANSI-C rules and has problems on many
2507GNU/Linux systems).
2508.IP "\-\-disable\-swapscreen" 4 2150.IP "\-\-disable\-swapscreen" 4
2509.IX Item "--disable-swapscreen" 2151.IX Item "--disable-swapscreen"
2510Remove support for secondary/swap screen. 2152Remove support for secondary/swap screen.
2511.IP "\-\-enable\-frills (default: on)" 4 2153.IP "\-\-enable\-frills (default: on)" 4
2512.IX Item "--enable-frills (default: on)" 2154.IX Item "--enable-frills (default: on)"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines