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.45 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.50 by root, Thu Jan 19 19:26:31 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-13" "7.0" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-19" "7.1" "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
299using the @@RXVT_NAME@@c client, the version displayed is that of the 299using the @@RXVT_NAME@@c client, the version displayed is that of the
300daemon. 300daemon.
301.IP "I am using Debian GNU/Linux and have a problem..." 4 301.IP "I am using Debian GNU/Linux and have a problem..." 4
302.IX Item "I am using Debian GNU/Linux and have a problem..." 302.IX Item "I am using Debian GNU/Linux and have a problem..."
303The Debian GNU/Linux package of rxvt-unicode in sarge contains large 303The Debian GNU/Linux package of rxvt-unicode in sarge contains large
304patches that considerably change the behaviour of rxvt\-unicode. Before 304patches that considerably change the behaviour of rxvt-unicode (but
305reporting a bug to the original rxvt-unicode author please download and 305unfortunately this notice has been removed). Before reporting a bug to
306install the genuine version (<http://software.schmorp.de#rxvt\-unicode>) 306the original rxvt-unicode author please download and install the genuine
307and try to reproduce the problem. If you cannot, chances are that the 307version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce
308problems are specific to Debian GNU/Linux, in which case it should be 308the problem. If you cannot, chances are that the problems are specific to
309Debian GNU/Linux, in which case it should be reported via the Debian Bug
309reported via the Debian Bug Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report 310Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug).
310the bug).
311.Sp 311.Sp
312For other problems that also affect the Debian package, you can and 312For other problems that also affect the Debian package, you can and
313probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a 313probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a
314bug in the Debian version and it serves as a reminder for other users that 314bug in the Debian version and it serves as a reminder for other users that
315might encounter the same issue. 315might encounter the same issue.
332one 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
333\&\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
334encodings built-in that increase download times and are rarely used). 334encodings built-in that increase download times and are rarely used).
335.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
336.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?"
337Likely not. While I honestly try to make it secure, and am probably not 337It should be, starting with release 7.1. You are encouraged to properly
338bad at it, I think it is simply unreasonable to expect all of freetype 338install urxvt with privileges necessary for your \s-1OS\s0 now.
339+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
340secure. Also, rxvt-unicode disables some options when it detects that it
341runs setuid or setgid, which is not nice. Besides, with the embedded perl
342interpreter the possibility for security problems easily multiplies.
343.Sp 339.Sp
344Elevated privileges are only required for utmp and pty operations on some 340When rxvt-unicode detects that it runs setuid or setgid, it will fork
345systems (for example, GNU/Linux doesn't need any extra privileges for 341into a helper process for privileged operations (pty handling on some
346ptys, but some need it for utmp support). It is planned to mvoe this into 342systems, utmp/wtmp/lastlog handling on others) and drop privileges
347a forked handler process, but this is not yet done. 343immediately. This is much safer than most other terminals that keep
344privileges while running (but is more relevant to urxvt, as it contains
345things as perl interpreters, which might be \*(L"helpful\*(R" to attackers).
348.Sp 346.Sp
349So, while setuid/setgid operation is supported and not a problem on your 347This forking is done as the very first within \fImain()\fR, which is very early
350typical single-user-no-other-logins unix desktop, always remember that 348and reduces possible bugs to initialisation code run before \fImain()\fR, or
351its an awful lot of code, most of which isn't checked for security issues 349things like the dynamic loader of your system, which should result in very
352regularly. 350little risk.
353.IP "When I log-in to another system it tells me about missing terminfo data?" 4 351.IP "When I log-in to another system it tells me about missing terminfo data?" 4
354.IX Item "When I log-in to another system it tells me about missing terminfo data?" 352.IX Item "When I log-in to another system it tells me about missing terminfo data?"
355The terminal description used by rxvt-unicode is not as widely available 353The terminal description used by rxvt-unicode is not as widely available
356as that for xterm, or even rxvt (for which the same problem often arises). 354as that for xterm, or even rxvt (for which the same problem often arises).
357.Sp 355.Sp
775.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?" 773.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?"
776You can specify separate locales for the input method and the rest of the 774You can specify separate locales for the input method and the rest of the
777terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR: 775terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
778.Sp 776.Sp
779.Vb 1 777.Vb 1
780\& URxvt*imlocale: ja_JP.EUC-JP 778\& URxvt.imlocale: ja_JP.EUC-JP
781.Ve 779.Ve
782.Sp 780.Sp
783Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still 781Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
784use your input method. Please note, however, that you will not be able to 782use your input method. Please note, however, that you will not be able to
785input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input 783input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input
1058.IX Header "RXVT TECHNICAL REFERENCE" 1056.IX Header "RXVT TECHNICAL REFERENCE"
1059.SH "DESCRIPTION" 1057.SH "DESCRIPTION"
1060.IX Header "DESCRIPTION" 1058.IX Header "DESCRIPTION"
1061The rest of this document describes various technical aspects of 1059The rest of this document describes various technical aspects of
1062\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1060\&\fBrxvt-unicode\fR. First the description of supported command sequences,
1063followed by menu and pixmap support and last by a description of all 1061followed by pixmap support and last by a description of all features
1064features selectable at \f(CW\*(C`configure\*(C'\fR time. 1062selectable at \f(CW\*(C`configure\*(C'\fR time.
1065.SH "Definitions" 1063.SH "Definitions"
1066.IX Header "Definitions" 1064.IX Header "Definitions"
1067.ie n .IP "\fB\fB""c""\fB\fR" 4 1065.ie n .IP "\fB\fB""c""\fB\fR" 4
1068.el .IP "\fB\f(CBc\fB\fR" 4 1066.el .IP "\fB\f(CBc\fB\fR" 4
1069.IX Item "c" 1067.IX Item "c"
1616l l . 1614l l .
1617h Send Mouse X & Y on button press. 1615h Send Mouse X & Y on button press.
1618l No mouse reporting. 1616l No mouse reporting.
1619.TE 1617.TE
1620 1618
1621.ie n .IP "\fB\fB""Ps = 10""\fB\fR (\fBrxvt\fR)" 4
1622.el .IP "\fB\f(CBPs = 10\fB\fR (\fBrxvt\fR)" 4
1623.IX Item "Ps = 10 (rxvt)"
1624.TS
1625l l .
1626h menuBar visible
1627l menuBar invisible
1628.TE
1629
1630.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 1619.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4
1631.el .IP "\fB\f(CBPs = 25\fB\fR" 4 1620.el .IP "\fB\f(CBPs = 25\fB\fR" 4
1632.IX Item "Ps = 25" 1621.IX Item "Ps = 25"
1633.TS 1622.TS
1634l l . 1623l l .
1820Ps = 12 Change colour of text cursor foreground to Pt 1809Ps = 12 Change colour of text cursor foreground to Pt
1821Ps = 13 Change colour of mouse foreground to Pt 1810Ps = 13 Change colour of mouse foreground to Pt
1822Ps = 17 Change colour of highlight characters to Pt 1811Ps = 17 Change colour of highlight characters to Pt
1823Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] 1812Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1824Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] 1813Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1825Ps = 20 Change default background to Pt 1814Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1826Ps = 39 Change default foreground colour to Pt. 1815Ps = 39 Change default foreground colour to Pt.
1827Ps = 46 Change Log File to Pt unimplemented 1816Ps = 46 Change Log File to Pt unimplemented
1828Ps = 49 Change default background colour to Pt. 1817Ps = 49 Change default background colour to Pt.
1829Ps = 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 1818Ps = 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
1830Ps = 55 Log all scrollback buffer and all of screen to Pt 1819Ps = 55 Log all scrollback buffer and all of screen to Pt
1831Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1820Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1832Ps = 703 Menubar command Pt (Compile menubar).
1833Ps = 704 Change colour of italic characters to Pt 1821Ps = 704 Change colour of italic characters to Pt
1834Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1822Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1835Ps = 706 Change colour of bold characters to Pt 1823Ps = 706 Change colour of bold characters to Pt
1836Ps = 707 Change colour of underlined characters to Pt 1824Ps = 707 Change colour of underlined characters to Pt
1837Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1825Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1843Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). 1831Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1844.TE 1832.TE
1845 1833
1846.PP 1834.PP
1847 1835
1848.IX Xref "menuBar" 1836.IX Xref "XPM"
1849.SH "menuBar"
1850.IX Header "menuBar"
1851\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1852In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1853menuBar.
1854.PP
1855Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1856omitted: use \fB./\fR to specify a menu relative to the current menu.
1857.Sh "Overview of menuBar operation"
1858.IX Subsection "Overview of menuBar operation"
1859For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1860of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1861.PP
1862At the top level is the current menuBar which is a member of a circular
1863linked-list of other such menuBars.
1864.PP
1865The menuBar acts as a parent for the various drop-down menus, which in
1866turn, may have labels, separator lines, menuItems and subMenus.
1867.PP
1868The menuItems are the useful bits: you can use them to mimic keyboard
1869input or even to send text or escape sequences back to rxvt.
1870.PP
1871The menuBar syntax is intended to provide a simple yet robust method of
1872constructing and manipulating menus and navigating through the
1873menuBars.
1874.PP
1875The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1876the menuBar called \fIname\fR and allows access. You may now or menus,
1877subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1878menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1879menus. To re-access the current menuBar for alterations, use the tag
1880\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1881.PP
1882
1883.IX Xref "menuBarCommands"
1884.Sh "Commands"
1885.IX Subsection "Commands"
1886.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1887.IX Item "[menu:+name]"
1888access the named menuBar for creation or alteration. If a new menuBar
1889is created, it is called \fIname\fR (max of 15 chars) and the current
1890menuBar is pushed onto the stack
1891.IP "\fB[menu]\fR" 4
1892.IX Item "[menu]"
1893access the current menuBar for alteration
1894.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1895.IX Item "[title:+string]"
1896set the current menuBar's title to \fIstring\fR, which may contain the
1897following format specifiers:
1898.Sp
1899.Vb 3
1900\& B<%n> rxvt name (as per the B<-name> command-line option)
1901\& B<%v> rxvt version
1902\& B<%%> literal B<%> character
1903.Ve
1904.IP "\fB[done]\fR" 4
1905.IX Item "[done]"
1906set menuBar access as \fBreadonly\fR.
1907End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1908.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1909.IX Item "[read:+file]"
1910read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1911appended 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.
1912.Sp
1913Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1914since any invalid menu commands are also ignored, almost anything could
1915be construed as a comment line, but this may be tightened up in the
1916future ... so don't count on it!.
1917.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1918.IX Item "[read:+file;+name]"
1919The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1920\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1921\&\fB[done]\fR is encountered.
1922.IP "\fB[dump]\fR" 4
1923.IX Item "[dump]"
1924dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1925later rereading.
1926.IP "\fB[rm:name]\fR" 4
1927.IX Item "[rm:name]"
1928remove the named menuBar
1929.IP "\fB[rm] [rm:]\fR" 4
1930.IX Item "[rm] [rm:]"
1931remove the current menuBar
1932.IP "\fB[rm*] [rm:*]\fR" 4
1933.IX Item "[rm*] [rm:*]"
1934remove all menuBars
1935.IP "\fB[swap]\fR" 4
1936.IX Item "[swap]"
1937swap the top two menuBars
1938.IP "\fB[prev]\fR" 4
1939.IX Item "[prev]"
1940access the previous menuBar
1941.IP "\fB[next]\fR" 4
1942.IX Item "[next]"
1943access the next menuBar
1944.IP "\fB[show]\fR" 4
1945.IX Item "[show]"
1946Enable display of the menuBar
1947.IP "\fB[hide]\fR" 4
1948.IX Item "[hide]"
1949Disable display of the menuBar
1950.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1951.IX Item "[pixmap:+name]"
1952.PD 0
1953.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1954.IX Item "[pixmap:+name;scaling]"
1955.PD
1956(set the background pixmap globally
1957.Sp
1958\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1959.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1960.IX Item "[:+command:]"
1961ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1962menuitem or change the ; a useful shortcut for setting the quick arrows
1963from a menuBar.
1964.PP
1965
1966.IX Xref "menuBarAdd"
1967.Sh "Adding and accessing menus"
1968.IX Subsection "Adding and accessing menus"
1969The following commands may also be \fB+\fR prefixed.
1970.IP "\fB/+\fR" 4
1971.IX Item "/+"
1972access menuBar top level
1973.IP "\fB./+\fR" 4
1974.IX Item "./+"
1975access current menu level
1976.IP "\fB../+\fR" 4
1977.IX Item "../+"
1978access parent menu (1 level up)
1979.IP "\fB../../\fR" 4
1980.IX Item "../../"
1981access parent menu (multiple levels up)
1982.IP "\fB\f(BI/path/\fBmenu\fR" 4
1983.IX Item "/path/menu"
1984add/access menu
1985.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1986.IX Item "/path/menu/*"
1987add/access menu and clear it if it exists
1988.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1989.IX Item "/path/{-}"
1990add separator
1991.IP "\fB\f(BI/path/\fB{item}\fR" 4
1992.IX Item "/path/{item}"
1993add \fBitem\fR as a label
1994.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1995.IX Item "/path/{item} action"
1996add/alter \fImenuitem\fR with an associated \fIaction\fR
1997.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1998.IX Item "/path/{item}{right-text}"
1999add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
2000and as the associated \fIaction\fR
2001.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
2002.IX Item "/path/{item}{rtext} action"
2003add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
2004the right-justified text.
2005.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
2006.IX Item "Special characters in action must be backslash-escaped:"
2007\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
2008.IP "or in control-character notation:" 4
2009.IX Item "or in control-character notation:"
2010\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
2011.PP
2012To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
2013program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
2014the first of which will be stripped off and the balance directed to the
2015program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
2016non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
2017balance is sent back to rxvt.
2018.PP
2019As a convenience for the many Emacs-type editors, \fIaction\fR may start
2020with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
2021appended if missed from \fBM\-x\fR commands.
2022.PP
2023As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
2024quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
2025.IP "For example," 4
2026.IX Item "For example,"
2027\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
2028.IP "and" 4
2029.IX Item "and"
2030\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
2031.PP
2032The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
2033absence of a specified action, this text will be used as the \fIaction\fR
2034as well.
2035.IP "For example," 4
2036.IX Item "For example,"
2037\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
2038.PP
2039The left label \fIis\fR necessary, since it's used for matching, but
2040implicitly hiding the left label (by using same name for both left and
2041right labels), or explicitly hiding the left label (by preceeding it
2042with a dot), makes it possible to have right-justified text only.
2043.IP "For example," 4
2044.IX Item "For example,"
2045\&\fB/File/{Open}{Open} Open-File-Action\fR
2046.IP "or hiding it" 4
2047.IX Item "or hiding it"
2048\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
2049.PP
2050
2051.IX Xref "menuBarRemove"
2052.Sh "Removing menus"
2053.IX Subsection "Removing menus"
2054.IP "\fB\-/*+\fR" 4
2055.IX Item "-/*+"
2056remove all menus from the menuBar, the same as \fB[clear]\fR
2057.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
2058.IX Item "-+/pathmenu+"
2059remove menu
2060.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
2061.IX Item "-+/path{item}+"
2062remove item
2063.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
2064.IX Item "-+/path{-}"
2065remove separator)
2066.IP "\fB\-/path/menu/*\fR" 4
2067.IX Item "-/path/menu/*"
2068remove all items, separators and submenus from menu
2069.PP
2070
2071.IX Xref "menuBarArrows"
2072.Sh "Quick Arrows"
2073.IX Subsection "Quick Arrows"
2074The menus also provide a hook for \fIquick arrows\fR to provide easier
2075user access. If nothing has been explicitly set, the default is to
2076emulate the curror keys. The syntax permits each arrow to be altered
2077individually or all four at once without re-entering their common
2078beginning/end text. For example, to explicitly associate cursor actions
2079with the arrows, any of the following forms could be used:
2080.IP "\fB<r>+\f(BIRight\fB\fR" 4
2081.IX Item "<r>+Right"
2082.PD 0
2083.IP "\fB<l>+\f(BILeft\fB\fR" 4
2084.IX Item "<l>+Left"
2085.IP "\fB<u>+\f(BIUp\fB\fR" 4
2086.IX Item "<u>+Up"
2087.IP "\fB<d>+\f(BIDown\fB\fR" 4
2088.IX Item "<d>+Down"
2089.PD
2090Define actions for the respective arrow buttons
2091.IP "\fB<b>+\f(BIBegin\fB\fR" 4
2092.IX Item "<b>+Begin"
2093.PD 0
2094.IP "\fB<e>+\f(BIEnd\fB\fR" 4
2095.IX Item "<e>+End"
2096.PD
2097Define common beginning/end parts for \fIquick arrows\fR which used in
2098conjunction with the above <r> <l> <u> <d> constructs
2099.IP "For example, define arrows individually," 4
2100.IX Item "For example, define arrows individually,"
2101.Vb 1
2102\& <u>\eE[A
2103.Ve
2104.Sp
2105.Vb 1
2106\& <d>\eE[B
2107.Ve
2108.Sp
2109.Vb 1
2110\& <r>\eE[C
2111.Ve
2112.Sp
2113.Vb 1
2114\& <l>\eE[D
2115.Ve
2116.IP "or all at once" 4
2117.IX Item "or all at once"
2118.Vb 1
2119\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
2120.Ve
2121.IP "or more compactly (factoring out common parts)" 4
2122.IX Item "or more compactly (factoring out common parts)"
2123.Vb 1
2124\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
2125.Ve
2126.PP
2127
2128.IX Xref "menuBarSummary"
2129.Sh "Command Summary"
2130.IX Subsection "Command Summary"
2131A short summary of the most \fIcommon\fR commands:
2132.IP "[menu:name]" 4
2133.IX Item "[menu:name]"
2134use an existing named menuBar or start a new one
2135.IP "[menu]" 4
2136.IX Item "[menu]"
2137use the current menuBar
2138.IP "[title:string]" 4
2139.IX Item "[title:string]"
2140set menuBar title
2141.IP "[done]" 4
2142.IX Item "[done]"
2143set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
2144.IP "[done:name]" 4
2145.IX Item "[done:name]"
2146if reading from a file using [read:file;name] signal \s-1EOF\s0
2147.IP "[rm:name]" 4
2148.IX Item "[rm:name]"
2149remove named menuBar(s)
2150.IP "[rm] [rm:]" 4
2151.IX Item "[rm] [rm:]"
2152remove current menuBar
2153.IP "[rm*] [rm:*]" 4
2154.IX Item "[rm*] [rm:*]"
2155remove all menuBar(s)
2156.IP "[swap]" 4
2157.IX Item "[swap]"
2158swap top two menuBars
2159.IP "[prev]" 4
2160.IX Item "[prev]"
2161access the previous menuBar
2162.IP "[next]" 4
2163.IX Item "[next]"
2164access the next menuBar
2165.IP "[show]" 4
2166.IX Item "[show]"
2167map menuBar
2168.IP "[hide]" 4
2169.IX Item "[hide]"
2170unmap menuBar
2171.IP "[pixmap;file]" 4
2172.IX Item "[pixmap;file]"
2173.PD 0
2174.IP "[pixmap;file;scaling]" 4
2175.IX Item "[pixmap;file;scaling]"
2176.PD
2177set a background pixmap
2178.IP "[read:file]" 4
2179.IX Item "[read:file]"
2180.PD 0
2181.IP "[read:file;name]" 4
2182.IX Item "[read:file;name]"
2183.PD
2184read in a menu from a file
2185.IP "[dump]" 4
2186.IX Item "[dump]"
2187dump out all menuBars to /tmp/rxvt\-PID
2188.IP "/" 4
2189access menuBar top level
2190.IP "./" 4
2191.PD 0
2192.IP "../" 4
2193.IP "../../" 4
2194.PD
2195access current or parent menu level
2196.IP "/path/menu" 4
2197.IX Item "/path/menu"
2198add/access menu
2199.IP "/path/{\-}" 4
2200.IX Item "/path/{-}"
2201add separator
2202.IP "/path/{item}{rtext} action" 4
2203.IX Item "/path/{item}{rtext} action"
2204add/alter menu item
2205.IP "\-/*" 4
2206remove all menus from the menuBar
2207.IP "\-/path/menu" 4
2208.IX Item "-/path/menu"
2209remove menu items, separators and submenus from menu
2210.IP "\-/path/menu" 4
2211.IX Item "-/path/menu"
2212remove menu
2213.IP "\-/path/{item}" 4
2214.IX Item "-/path/{item}"
2215remove item
2216.IP "\-/path/{\-}" 4
2217.IX Item "-/path/{-}"
2218remove separator
2219.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2220.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2221menu quick arrows
2222.SH "XPM" 1837.SH "XPM"
2223.IX Header "XPM" 1838.IX Header "XPM"
2224For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value 1839For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value
2225of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a 1840of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a
2226sequence of scaling/positioning commands separated by semi\-colons. The 1841sequence of scaling/positioning commands separated by semi\-colons. The
2496.IX Item "--enable-fading (default: on)" 2111.IX Item "--enable-fading (default: on)"
2497Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2112Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2498.IP "\-\-enable\-tinting (default: on)" 4 2113.IP "\-\-enable\-tinting (default: on)" 4
2499.IX Item "--enable-tinting (default: on)" 2114.IX Item "--enable-tinting (default: on)"
2500Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2115Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2501.IP "\-\-enable\-menubar (default: off) [\s-1DEPRECATED\s0]" 4
2502.IX Item "--enable-menubar (default: off) [DEPRECATED]"
2503Add support for our menu bar system (this interacts badly with dynamic
2504locale switching currently). This option is \s-1DEPRECATED\s0 and will be removed
2505in the future.
2506.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2116.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2507.IX Item "--enable-rxvt-scroll (default: on)" 2117.IX Item "--enable-rxvt-scroll (default: on)"
2508Add support for the original rxvt scrollbar. 2118Add support for the original rxvt scrollbar.
2509.IP "\-\-enable\-next\-scroll (default: on)" 4 2119.IP "\-\-enable\-next\-scroll (default: on)" 4
2510.IX Item "--enable-next-scroll (default: on)" 2120.IX Item "--enable-next-scroll (default: on)"
2515.IP "\-\-enable\-plain\-scroll (default: on)" 4 2125.IP "\-\-enable\-plain\-scroll (default: on)" 4
2516.IX Item "--enable-plain-scroll (default: on)" 2126.IX Item "--enable-plain-scroll (default: on)"
2517Add support for a very unobtrusive, plain-looking scrollbar that 2127Add support for a very unobtrusive, plain-looking scrollbar that
2518is the favourite of the rxvt-unicode author, having used it for 2128is the favourite of the rxvt-unicode author, having used it for
2519many years. 2129many years.
2520.IP "\-\-enable\-half\-shadow (default: off)" 4
2521.IX Item "--enable-half-shadow (default: off)"
2522Make shadows on the scrollbar only half the normal width & height.
2523only applicable to rxvt scrollbars.
2524.IP "\-\-enable\-ttygid (default: off)" 4 2130.IP "\-\-enable\-ttygid (default: off)" 4
2525.IX Item "--enable-ttygid (default: off)" 2131.IX Item "--enable-ttygid (default: off)"
2526Change tty device setting to group \*(L"tty\*(R" \- only use this if 2132Change tty device setting to group \*(L"tty\*(R" \- only use this if
2527your system uses this type of security. 2133your system uses this type of security.
2528.IP "\-\-disable\-backspace\-key" 4 2134.IP "\-\-disable\-backspace\-key" 4
2533Removes any handling of the delete key by us \- let the X server 2139Removes any handling of the delete key by us \- let the X server
2534do it. 2140do it.
2535.IP "\-\-disable\-resources" 4 2141.IP "\-\-disable\-resources" 4
2536.IX Item "--disable-resources" 2142.IX Item "--disable-resources"
2537Removes any support for resource checking. 2143Removes any support for resource checking.
2538.IP "\-\-enable\-strings (default: off)" 4
2539.IX Item "--enable-strings (default: off)"
2540Add support for our possibly faster \fImemset()\fR function and other
2541various routines, overriding your system's versions which may
2542have been hand-crafted in assembly or may require extra libraries
2543to link in. (this breaks ANSI-C rules and has problems on many
2544GNU/Linux systems).
2545.IP "\-\-disable\-swapscreen" 4 2144.IP "\-\-disable\-swapscreen" 4
2546.IX Item "--disable-swapscreen" 2145.IX Item "--disable-swapscreen"
2547Remove support for secondary/swap screen. 2146Remove support for secondary/swap screen.
2548.IP "\-\-enable\-frills (default: on)" 4 2147.IP "\-\-enable\-frills (default: on)" 4
2549.IX Item "--enable-frills (default: on)" 2148.IX Item "--enable-frills (default: on)"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines