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.43 by root, Thu Jan 12 23:11:23 2006 UTC vs.
Revision 1.53 by root, Thu Jan 26 00:09:47 2006 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
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-26" "7.3a" "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/too small, can I change this?" 4 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/too small, can I change this?" 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 smaller pieces (\*(L"words\*(R") you can 163Yes. For example, if you want to select alphanumeric words, you can use
164use the following resource: 164the following resource:
165.Sp 165.Sp
166.Vb 1 166.Vb 1
167\& URxvt.selection.pattern-0: ([[:word:]]+) 167\& URxvt.selection.pattern-0: ([[:word:]]+)
168.Ve 168.Ve
169.Sp 169.Sp
173To get a selection that is very similar to the old code, try this pattern: 173To get a selection that is very similar to the old code, try this pattern:
174.Sp 174.Sp
175.Vb 1 175.Vb 1
176\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+) 176\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+)
177.Ve 177.Ve
178.Sp
179Please also note that the \fILeftClick Shift-LeftClik\fR combination also
180selects words like the old code.
178.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4 181.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4
179.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 182.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?"
180You can disable the perl extension completely by setting the 183You can disable the perl extension completely by setting the
181\&\fBperl-ext-common\fR resource to the empty string, which also keeps 184\&\fBperl-ext-common\fR resource to the empty string, which also keeps
182rxvt-unicode from initialising perl, saving memory. 185rxvt-unicode from initialising perl, saving memory.
296using 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
297daemon. 300daemon.
298.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
299.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..."
300The Debian GNU/Linux package of rxvt-unicode in sarge contains large 303The Debian GNU/Linux package of rxvt-unicode in sarge contains large
301patches that considerably change the behaviour of rxvt\-unicode. Before 304patches that considerably change the behaviour of rxvt-unicode (but
302reporting a bug to the original rxvt-unicode author please download and 305unfortunately this notice has been removed). Before reporting a bug to
303install the genuine version (<http://software.schmorp.de#rxvt\-unicode>) 306the original rxvt-unicode author please download and install the genuine
304and try to reproduce the problem. If you cannot, chances are that the 307version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce
305problems 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
306reported 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).
307the bug).
308.Sp 311.Sp
309For other problems that also affect the Debian package, you can and 312For other problems that also affect the Debian package, you can and
310probably 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
311bug 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
312might encounter the same issue. 315might encounter the same issue.
329one 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
330\&\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
331encodings built-in that increase download times and are rarely used). 334encodings built-in that increase download times and are rarely used).
332.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
333.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?"
334Likely 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
335bad at it, I think it is simply unreasonable to expect all of freetype 338install urxvt with privileges necessary for your \s-1OS\s0 now.
336+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
337secure. Also, rxvt-unicode disables some options when it detects that it
338runs setuid or setgid, which is not nice. Besides, with the embedded perl
339interpreter the possibility for security problems easily multiplies.
340.Sp 339.Sp
341Elevated privileges are only required for utmp and pty operations on some 340When rxvt-unicode detects that it runs setuid or setgid, it will fork
342systems (for example, GNU/Linux doesn't need any extra privileges for 341into a helper process for privileged operations (pty handling on some
343ptys, but some need it for utmp support). It is planned to mvoe this into 342systems, utmp/wtmp/lastlog handling on others) and drop privileges
344a 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).
345.Sp 346.Sp
346So, 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
347typical single-user-no-other-logins unix desktop, always remember that 348and reduces possible bugs to initialisation code run before \fImain()\fR, or
348its 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
349regularly. 350little risk.
350.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
351.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?"
352The terminal description used by rxvt-unicode is not as widely available 353The terminal description used by rxvt-unicode is not as widely available
353as 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).
354.Sp 355.Sp
772.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?"
773You 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
774terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR: 775terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
775.Sp 776.Sp
776.Vb 1 777.Vb 1
777\& URxvt*imlocale: ja_JP.EUC-JP 778\& URxvt.imlocale: ja_JP.EUC-JP
778.Ve 779.Ve
779.Sp 780.Sp
780Now 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
781use 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
782input 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
824.IX Item "Mouse cut/paste suddenly no longer works." 825.IX Item "Mouse cut/paste suddenly no longer works."
825Make sure that mouse reporting is actually turned off since killing 826Make sure that mouse reporting is actually turned off since killing
826some editors prematurely may leave the mouse in mouse report mode. I've 827some editors prematurely may leave the mouse in mouse report mode. I've
827heard that tcsh may use mouse reporting unless it otherwise specified. A 828heard that tcsh may use mouse reporting unless it otherwise specified. A
828quick check is to see if cut/paste works when the Alt or Shift keys are 829quick check is to see if cut/paste works when the Alt or Shift keys are
829depressed. See @@RXVT_NAME@@(7) 830depressed.
830.IP "What's with this bold/blink stuff?" 4 831.IP "What's with this bold/blink stuff?" 4
831.IX Item "What's with this bold/blink stuff?" 832.IX Item "What's with this bold/blink stuff?"
832If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the 833If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
833standard foreground colour. 834standard foreground colour.
834.Sp 835.Sp
929\& # use Backspace = ^? 930\& # use Backspace = ^?
930\& $ stty erase ^? 931\& $ stty erase ^?
931\& $ @@RXVT_NAME@@ 932\& $ @@RXVT_NAME@@
932.Ve 933.Ve
933.Sp 934.Sp
934Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR as documented in @@RXVT_NAME@@(7). 935Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR.
935.Sp 936.Sp
936For an existing rxvt\-unicode: 937For an existing rxvt\-unicode:
937.Sp 938.Sp
938.Vb 3 939.Vb 3
939\& # use Backspace = ^H 940\& # use Backspace = ^H
1055.IX Header "RXVT TECHNICAL REFERENCE" 1056.IX Header "RXVT TECHNICAL REFERENCE"
1056.SH "DESCRIPTION" 1057.SH "DESCRIPTION"
1057.IX Header "DESCRIPTION" 1058.IX Header "DESCRIPTION"
1058The rest of this document describes various technical aspects of 1059The rest of this document describes various technical aspects of
1059\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1060\&\fBrxvt-unicode\fR. First the description of supported command sequences,
1060followed by menu and pixmap support and last by a description of all 1061followed by pixmap support and last by a description of all features
1061features selectable at \f(CW\*(C`configure\*(C'\fR time. 1062selectable at \f(CW\*(C`configure\*(C'\fR time.
1062.SH "Definitions" 1063.SH "Definitions"
1063.IX Header "Definitions" 1064.IX Header "Definitions"
1064.ie n .IP "\fB\fB""c""\fB\fR" 4 1065.ie n .IP "\fB\fB""c""\fB\fR" 4
1065.el .IP "\fB\f(CBc\fB\fR" 4 1066.el .IP "\fB\f(CBc\fB\fR" 4
1066.IX Item "c" 1067.IX Item "c"
1613l l . 1614l l .
1614h Send Mouse X & Y on button press. 1615h Send Mouse X & Y on button press.
1615l No mouse reporting. 1616l No mouse reporting.
1616.TE 1617.TE
1617 1618
1618.ie n .IP "\fB\fB""Ps = 10""\fB\fR (\fBrxvt\fR)" 4
1619.el .IP "\fB\f(CBPs = 10\fB\fR (\fBrxvt\fR)" 4
1620.IX Item "Ps = 10 (rxvt)"
1621.TS
1622l l .
1623h menuBar visible
1624l menuBar invisible
1625.TE
1626
1627.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 1619.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4
1628.el .IP "\fB\f(CBPs = 25\fB\fR" 4 1620.el .IP "\fB\f(CBPs = 25\fB\fR" 4
1629.IX Item "Ps = 25" 1621.IX Item "Ps = 25"
1630.TS 1622.TS
1631l l . 1623l l .
1817Ps = 12 Change colour of text cursor foreground to Pt 1809Ps = 12 Change colour of text cursor foreground to Pt
1818Ps = 13 Change colour of mouse foreground to Pt 1810Ps = 13 Change colour of mouse foreground to Pt
1819Ps = 17 Change colour of highlight characters to Pt 1811Ps = 17 Change colour of highlight characters to Pt
1820Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] 1812Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1821Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] 1813Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1822Ps = 20 Change default background to Pt 1814Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1823Ps = 39 Change default foreground colour to Pt. 1815Ps = 39 Change default foreground colour to Pt.
1824Ps = 46 Change Log File to Pt unimplemented 1816Ps = 46 Change Log File to Pt unimplemented
1825Ps = 49 Change default background colour to Pt. 1817Ps = 49 Change default background colour to Pt.
1826Ps = 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
1827Ps = 55 Log all scrollback buffer and all of screen to Pt 1819Ps = 55 Log all scrollback buffer and all of screen to Pt
1828Ps = 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).
1829Ps = 703 Menubar command Pt (Compile menubar).
1830Ps = 704 Change colour of italic characters to Pt 1821Ps = 704 Change colour of italic characters to Pt
1831Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1822Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1832Ps = 706 Change colour of bold characters to Pt 1823Ps = 706 Change colour of bold characters to Pt
1833Ps = 707 Change colour of underlined characters to Pt 1824Ps = 707 Change colour of underlined characters to Pt
1834Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1825Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1840Ps = 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).
1841.TE 1832.TE
1842 1833
1843.PP 1834.PP
1844 1835
1845.IX Xref "menuBar" 1836.IX Xref "XPM"
1846.SH "menuBar"
1847.IX Header "menuBar"
1848\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1849In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1850menuBar.
1851.PP
1852Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1853omitted: use \fB./\fR to specify a menu relative to the current menu.
1854.Sh "Overview of menuBar operation"
1855.IX Subsection "Overview of menuBar operation"
1856For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1857of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1858.PP
1859At the top level is the current menuBar which is a member of a circular
1860linked-list of other such menuBars.
1861.PP
1862The menuBar acts as a parent for the various drop-down menus, which in
1863turn, may have labels, separator lines, menuItems and subMenus.
1864.PP
1865The menuItems are the useful bits: you can use them to mimic keyboard
1866input or even to send text or escape sequences back to rxvt.
1867.PP
1868The menuBar syntax is intended to provide a simple yet robust method of
1869constructing and manipulating menus and navigating through the
1870menuBars.
1871.PP
1872The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1873the menuBar called \fIname\fR and allows access. You may now or menus,
1874subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1875menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1876menus. To re-access the current menuBar for alterations, use the tag
1877\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1878.PP
1879
1880.IX Xref "menuBarCommands"
1881.Sh "Commands"
1882.IX Subsection "Commands"
1883.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1884.IX Item "[menu:+name]"
1885access the named menuBar for creation or alteration. If a new menuBar
1886is created, it is called \fIname\fR (max of 15 chars) and the current
1887menuBar is pushed onto the stack
1888.IP "\fB[menu]\fR" 4
1889.IX Item "[menu]"
1890access the current menuBar for alteration
1891.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1892.IX Item "[title:+string]"
1893set the current menuBar's title to \fIstring\fR, which may contain the
1894following format specifiers:
1895.Sp
1896.Vb 3
1897\& B<%n> rxvt name (as per the B<-name> command-line option)
1898\& B<%v> rxvt version
1899\& B<%%> literal B<%> character
1900.Ve
1901.IP "\fB[done]\fR" 4
1902.IX Item "[done]"
1903set menuBar access as \fBreadonly\fR.
1904End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1905.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1906.IX Item "[read:+file]"
1907read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1908appended 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.
1909.Sp
1910Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1911since any invalid menu commands are also ignored, almost anything could
1912be construed as a comment line, but this may be tightened up in the
1913future ... so don't count on it!.
1914.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1915.IX Item "[read:+file;+name]"
1916The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1917\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1918\&\fB[done]\fR is encountered.
1919.IP "\fB[dump]\fR" 4
1920.IX Item "[dump]"
1921dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1922later rereading.
1923.IP "\fB[rm:name]\fR" 4
1924.IX Item "[rm:name]"
1925remove the named menuBar
1926.IP "\fB[rm] [rm:]\fR" 4
1927.IX Item "[rm] [rm:]"
1928remove the current menuBar
1929.IP "\fB[rm*] [rm:*]\fR" 4
1930.IX Item "[rm*] [rm:*]"
1931remove all menuBars
1932.IP "\fB[swap]\fR" 4
1933.IX Item "[swap]"
1934swap the top two menuBars
1935.IP "\fB[prev]\fR" 4
1936.IX Item "[prev]"
1937access the previous menuBar
1938.IP "\fB[next]\fR" 4
1939.IX Item "[next]"
1940access the next menuBar
1941.IP "\fB[show]\fR" 4
1942.IX Item "[show]"
1943Enable display of the menuBar
1944.IP "\fB[hide]\fR" 4
1945.IX Item "[hide]"
1946Disable display of the menuBar
1947.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1948.IX Item "[pixmap:+name]"
1949.PD 0
1950.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1951.IX Item "[pixmap:+name;scaling]"
1952.PD
1953(set the background pixmap globally
1954.Sp
1955\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1956.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1957.IX Item "[:+command:]"
1958ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1959menuitem or change the ; a useful shortcut for setting the quick arrows
1960from a menuBar.
1961.PP
1962
1963.IX Xref "menuBarAdd"
1964.Sh "Adding and accessing menus"
1965.IX Subsection "Adding and accessing menus"
1966The following commands may also be \fB+\fR prefixed.
1967.IP "\fB/+\fR" 4
1968.IX Item "/+"
1969access menuBar top level
1970.IP "\fB./+\fR" 4
1971.IX Item "./+"
1972access current menu level
1973.IP "\fB../+\fR" 4
1974.IX Item "../+"
1975access parent menu (1 level up)
1976.IP "\fB../../\fR" 4
1977.IX Item "../../"
1978access parent menu (multiple levels up)
1979.IP "\fB\f(BI/path/\fBmenu\fR" 4
1980.IX Item "/path/menu"
1981add/access menu
1982.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1983.IX Item "/path/menu/*"
1984add/access menu and clear it if it exists
1985.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1986.IX Item "/path/{-}"
1987add separator
1988.IP "\fB\f(BI/path/\fB{item}\fR" 4
1989.IX Item "/path/{item}"
1990add \fBitem\fR as a label
1991.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1992.IX Item "/path/{item} action"
1993add/alter \fImenuitem\fR with an associated \fIaction\fR
1994.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1995.IX Item "/path/{item}{right-text}"
1996add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1997and as the associated \fIaction\fR
1998.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1999.IX Item "/path/{item}{rtext} action"
2000add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
2001the right-justified text.
2002.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
2003.IX Item "Special characters in action must be backslash-escaped:"
2004\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
2005.IP "or in control-character notation:" 4
2006.IX Item "or in control-character notation:"
2007\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
2008.PP
2009To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
2010program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
2011the first of which will be stripped off and the balance directed to the
2012program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
2013non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
2014balance is sent back to rxvt.
2015.PP
2016As a convenience for the many Emacs-type editors, \fIaction\fR may start
2017with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
2018appended if missed from \fBM\-x\fR commands.
2019.PP
2020As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
2021quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
2022.IP "For example," 4
2023.IX Item "For example,"
2024\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
2025.IP "and" 4
2026.IX Item "and"
2027\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
2028.PP
2029The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
2030absence of a specified action, this text will be used as the \fIaction\fR
2031as well.
2032.IP "For example," 4
2033.IX Item "For example,"
2034\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
2035.PP
2036The left label \fIis\fR necessary, since it's used for matching, but
2037implicitly hiding the left label (by using same name for both left and
2038right labels), or explicitly hiding the left label (by preceeding it
2039with a dot), makes it possible to have right-justified text only.
2040.IP "For example," 4
2041.IX Item "For example,"
2042\&\fB/File/{Open}{Open} Open-File-Action\fR
2043.IP "or hiding it" 4
2044.IX Item "or hiding it"
2045\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
2046.PP
2047
2048.IX Xref "menuBarRemove"
2049.Sh "Removing menus"
2050.IX Subsection "Removing menus"
2051.IP "\fB\-/*+\fR" 4
2052.IX Item "-/*+"
2053remove all menus from the menuBar, the same as \fB[clear]\fR
2054.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
2055.IX Item "-+/pathmenu+"
2056remove menu
2057.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
2058.IX Item "-+/path{item}+"
2059remove item
2060.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
2061.IX Item "-+/path{-}"
2062remove separator)
2063.IP "\fB\-/path/menu/*\fR" 4
2064.IX Item "-/path/menu/*"
2065remove all items, separators and submenus from menu
2066.PP
2067
2068.IX Xref "menuBarArrows"
2069.Sh "Quick Arrows"
2070.IX Subsection "Quick Arrows"
2071The menus also provide a hook for \fIquick arrows\fR to provide easier
2072user access. If nothing has been explicitly set, the default is to
2073emulate the curror keys. The syntax permits each arrow to be altered
2074individually or all four at once without re-entering their common
2075beginning/end text. For example, to explicitly associate cursor actions
2076with the arrows, any of the following forms could be used:
2077.IP "\fB<r>+\f(BIRight\fB\fR" 4
2078.IX Item "<r>+Right"
2079.PD 0
2080.IP "\fB<l>+\f(BILeft\fB\fR" 4
2081.IX Item "<l>+Left"
2082.IP "\fB<u>+\f(BIUp\fB\fR" 4
2083.IX Item "<u>+Up"
2084.IP "\fB<d>+\f(BIDown\fB\fR" 4
2085.IX Item "<d>+Down"
2086.PD
2087Define actions for the respective arrow buttons
2088.IP "\fB<b>+\f(BIBegin\fB\fR" 4
2089.IX Item "<b>+Begin"
2090.PD 0
2091.IP "\fB<e>+\f(BIEnd\fB\fR" 4
2092.IX Item "<e>+End"
2093.PD
2094Define common beginning/end parts for \fIquick arrows\fR which used in
2095conjunction with the above <r> <l> <u> <d> constructs
2096.IP "For example, define arrows individually," 4
2097.IX Item "For example, define arrows individually,"
2098.Vb 1
2099\& <u>\eE[A
2100.Ve
2101.Sp
2102.Vb 1
2103\& <d>\eE[B
2104.Ve
2105.Sp
2106.Vb 1
2107\& <r>\eE[C
2108.Ve
2109.Sp
2110.Vb 1
2111\& <l>\eE[D
2112.Ve
2113.IP "or all at once" 4
2114.IX Item "or all at once"
2115.Vb 1
2116\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
2117.Ve
2118.IP "or more compactly (factoring out common parts)" 4
2119.IX Item "or more compactly (factoring out common parts)"
2120.Vb 1
2121\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
2122.Ve
2123.PP
2124
2125.IX Xref "menuBarSummary"
2126.Sh "Command Summary"
2127.IX Subsection "Command Summary"
2128A short summary of the most \fIcommon\fR commands:
2129.IP "[menu:name]" 4
2130.IX Item "[menu:name]"
2131use an existing named menuBar or start a new one
2132.IP "[menu]" 4
2133.IX Item "[menu]"
2134use the current menuBar
2135.IP "[title:string]" 4
2136.IX Item "[title:string]"
2137set menuBar title
2138.IP "[done]" 4
2139.IX Item "[done]"
2140set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
2141.IP "[done:name]" 4
2142.IX Item "[done:name]"
2143if reading from a file using [read:file;name] signal \s-1EOF\s0
2144.IP "[rm:name]" 4
2145.IX Item "[rm:name]"
2146remove named menuBar(s)
2147.IP "[rm] [rm:]" 4
2148.IX Item "[rm] [rm:]"
2149remove current menuBar
2150.IP "[rm*] [rm:*]" 4
2151.IX Item "[rm*] [rm:*]"
2152remove all menuBar(s)
2153.IP "[swap]" 4
2154.IX Item "[swap]"
2155swap top two menuBars
2156.IP "[prev]" 4
2157.IX Item "[prev]"
2158access the previous menuBar
2159.IP "[next]" 4
2160.IX Item "[next]"
2161access the next menuBar
2162.IP "[show]" 4
2163.IX Item "[show]"
2164map menuBar
2165.IP "[hide]" 4
2166.IX Item "[hide]"
2167unmap menuBar
2168.IP "[pixmap;file]" 4
2169.IX Item "[pixmap;file]"
2170.PD 0
2171.IP "[pixmap;file;scaling]" 4
2172.IX Item "[pixmap;file;scaling]"
2173.PD
2174set a background pixmap
2175.IP "[read:file]" 4
2176.IX Item "[read:file]"
2177.PD 0
2178.IP "[read:file;name]" 4
2179.IX Item "[read:file;name]"
2180.PD
2181read in a menu from a file
2182.IP "[dump]" 4
2183.IX Item "[dump]"
2184dump out all menuBars to /tmp/rxvt\-PID
2185.IP "/" 4
2186access menuBar top level
2187.IP "./" 4
2188.PD 0
2189.IP "../" 4
2190.IP "../../" 4
2191.PD
2192access current or parent menu level
2193.IP "/path/menu" 4
2194.IX Item "/path/menu"
2195add/access menu
2196.IP "/path/{\-}" 4
2197.IX Item "/path/{-}"
2198add separator
2199.IP "/path/{item}{rtext} action" 4
2200.IX Item "/path/{item}{rtext} action"
2201add/alter menu item
2202.IP "\-/*" 4
2203remove all menus from the menuBar
2204.IP "\-/path/menu" 4
2205.IX Item "-/path/menu"
2206remove menu items, separators and submenus from menu
2207.IP "\-/path/menu" 4
2208.IX Item "-/path/menu"
2209remove menu
2210.IP "\-/path/{item}" 4
2211.IX Item "-/path/{item}"
2212remove item
2213.IP "\-/path/{\-}" 4
2214.IX Item "-/path/{-}"
2215remove separator
2216.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2217.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2218menu quick arrows
2219.SH "XPM" 1837.SH "XPM"
2220.IX Header "XPM" 1838.IX Header "XPM"
2221For 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
2222of \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
2223sequence of scaling/positioning commands separated by semi\-colons. The 1841sequence of scaling/positioning commands separated by semi\-colons. The
2425Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using 2043Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using
2426alternative input methods (e.g. kinput2) and will also correctly 2044alternative input methods (e.g. kinput2) and will also correctly
2427set up the input for people using dead keys or compose keys. 2045set up the input for people using dead keys or compose keys.
2428.IP "\-\-enable\-unicode3 (default: off)" 4 2046.IP "\-\-enable\-unicode3 (default: off)" 4
2429.IX Item "--enable-unicode3 (default: off)" 2047.IX Item "--enable-unicode3 (default: off)"
2048Recommended to stay off unless you really need non-BMP characters.
2049.Sp
2430Enable direct support for displaying unicode codepoints above 2050Enable direct support for displaying unicode codepoints above
243165535 (the basic multilingual page). This increases storage 205165535 (the basic multilingual page). This increases storage
2432requirements per character from 2 to 4 bytes. X11 fonts do not yet 2052requirements per character from 2 to 4 bytes. X11 fonts do not yet
2433support these extra characters, but Xft does. 2053support these extra characters, but Xft does.
2434.Sp 2054.Sp
2443composite characters. This is required for proper viewing of text 2063composite characters. This is required for proper viewing of text
2444where accents are encoded as seperate unicode characters. This is 2064where accents are encoded as seperate unicode characters. This is
2445done by using precomposited characters when available or creating 2065done by using precomposited characters when available or creating
2446new pseudo-characters when no precomposed form exists. 2066new pseudo-characters when no precomposed form exists.
2447.Sp 2067.Sp
2448Without \-\-enable\-unicode3, the number of additional precomposed characters 2068Without \-\-enable\-unicode3, the number of additional precomposed
2449is rather limited (2048, if this is full, rxvt-unicode will use the 2069characters is somewhat limited (the 6400 private use characters will be
2450private use area, extending the number of combinations to 8448). With
2451\&\-\-enable\-unicode3, no practical limit exists. 2070(ab\-)used). With \-\-enable\-unicode3, no practical limit exists.
2452.Sp 2071.Sp
2453This option will also enable storage (but not display) of characters 2072This option will also enable storage (but not display) of characters
2454beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified. 2073beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
2455.Sp 2074.Sp
2456The combining table also contains entries for arabic presentation forms, 2075The combining table also contains entries for arabic presentation forms,
2457but these are not currently used. Bug me if you want these to be used (and 2076but these are not currently used. Bug me if you want these to be used (and
2458tell me how these are to be used...). 2077tell me how these are to be used...).
2459.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4 2078.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4
2460.IX Item "--enable-fallback(=CLASS) (default: Rxvt)" 2079.IX Item "--enable-fallback(=CLASS) (default: Rxvt)"
2461When reading resource settings, also read settings for class \s-1CLASS\s0. To disable resource fallback use \-\-disable\-fallback. 2080When reading resource settings, also read settings for class \s-1CLASS\s0. To
2081disable resource fallback use \-\-disable\-fallback.
2462.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4 2082.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4
2463.IX Item "--with-res-name=NAME (default: urxvt)" 2083.IX Item "--with-res-name=NAME (default: urxvt)"
2464Use the given name as default application name when 2084Use the given name as default application name when
2465reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt. 2085reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
2466.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4 2086.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4
2493.IX Item "--enable-fading (default: on)" 2113.IX Item "--enable-fading (default: on)"
2494Add 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).
2495.IP "\-\-enable\-tinting (default: on)" 4 2115.IP "\-\-enable\-tinting (default: on)" 4
2496.IX Item "--enable-tinting (default: on)" 2116.IX Item "--enable-tinting (default: on)"
2497Add 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).
2498.IP "\-\-enable\-menubar (default: off) [\s-1DEPRECATED\s0]" 4
2499.IX Item "--enable-menubar (default: off) [DEPRECATED]"
2500Add support for our menu bar system (this interacts badly with dynamic
2501locale switching currently). This option is \s-1DEPRECATED\s0 and will be removed
2502in the future.
2503.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2118.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2504.IX Item "--enable-rxvt-scroll (default: on)" 2119.IX Item "--enable-rxvt-scroll (default: on)"
2505Add support for the original rxvt scrollbar. 2120Add support for the original rxvt scrollbar.
2506.IP "\-\-enable\-next\-scroll (default: on)" 4 2121.IP "\-\-enable\-next\-scroll (default: on)" 4
2507.IX Item "--enable-next-scroll (default: on)" 2122.IX Item "--enable-next-scroll (default: on)"
2512.IP "\-\-enable\-plain\-scroll (default: on)" 4 2127.IP "\-\-enable\-plain\-scroll (default: on)" 4
2513.IX Item "--enable-plain-scroll (default: on)" 2128.IX Item "--enable-plain-scroll (default: on)"
2514Add support for a very unobtrusive, plain-looking scrollbar that 2129Add support for a very unobtrusive, plain-looking scrollbar that
2515is the favourite of the rxvt-unicode author, having used it for 2130is the favourite of the rxvt-unicode author, having used it for
2516many years. 2131many years.
2517.IP "\-\-enable\-half\-shadow (default: off)" 4
2518.IX Item "--enable-half-shadow (default: off)"
2519Make shadows on the scrollbar only half the normal width & height.
2520only applicable to rxvt scrollbars.
2521.IP "\-\-enable\-ttygid (default: off)" 4 2132.IP "\-\-enable\-ttygid (default: off)" 4
2522.IX Item "--enable-ttygid (default: off)" 2133.IX Item "--enable-ttygid (default: off)"
2523Change tty device setting to group \*(L"tty\*(R" \- only use this if 2134Change tty device setting to group \*(L"tty\*(R" \- only use this if
2524your system uses this type of security. 2135your system uses this type of security.
2525.IP "\-\-disable\-backspace\-key" 4 2136.IP "\-\-disable\-backspace\-key" 4
2530Removes any handling of the delete key by us \- let the X server 2141Removes any handling of the delete key by us \- let the X server
2531do it. 2142do it.
2532.IP "\-\-disable\-resources" 4 2143.IP "\-\-disable\-resources" 4
2533.IX Item "--disable-resources" 2144.IX Item "--disable-resources"
2534Removes any support for resource checking. 2145Removes any support for resource checking.
2535.IP "\-\-enable\-strings (default: off)" 4
2536.IX Item "--enable-strings (default: off)"
2537Add support for our possibly faster \fImemset()\fR function and other
2538various routines, overriding your system's versions which may
2539have been hand-crafted in assembly or may require extra libraries
2540to link in. (this breaks ANSI-C rules and has problems on many
2541GNU/Linux systems).
2542.IP "\-\-disable\-swapscreen" 4 2146.IP "\-\-disable\-swapscreen" 4
2543.IX Item "--disable-swapscreen" 2147.IX Item "--disable-swapscreen"
2544Remove support for secondary/swap screen. 2148Remove support for secondary/swap screen.
2545.IP "\-\-enable\-frills (default: on)" 4 2149.IP "\-\-enable\-frills (default: on)" 4
2546.IX Item "--enable-frills (default: on)" 2150.IX Item "--enable-frills (default: on)"
2549disable this. 2153disable this.
2550.Sp 2154.Sp
2551A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2155A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2552in combination with other switches) is: 2156in combination with other switches) is:
2553.Sp 2157.Sp
2554.Vb 17 2158.Vb 18
2555\& MWM-hints 2159\& MWM-hints
2556\& EWMH-hints (pid, utf8 names) and protocols (ping) 2160\& EWMH-hints (pid, utf8 names) and protocols (ping)
2557\& seperate underline colour (-underlineColor) 2161\& seperate underline colour (-underlineColor)
2558\& settable border widths and borderless switch (-w, -b, -bl) 2162\& settable border widths and borderless switch (-w, -b, -bl)
2163\& visual selection (-depth)
2559\& settable extra linespacing /-lsp) 2164\& settable extra linespacing /-lsp)
2560\& iso-14755-2 and -3, and visual feedback 2165\& iso-14755-2 and -3, and visual feedback
2561\& backindex and forwardindex escape sequence 2166\& backindex and forwardindex escape sequence
2562\& window op and some xterm/OSC escape sequences 2167\& window op and some xterm/OSC escape sequences
2563\& tripleclickwords (-tcw) 2168\& tripleclickwords (-tcw)
2610keys. This should keep the window corner which is closest to a corner of 2215keys. This should keep the window corner which is closest to a corner of
2611the screen in a fixed position. 2216the screen in a fixed position.
2612.IP "\-\-enable\-pointer\-blank (default: on)" 4 2217.IP "\-\-enable\-pointer\-blank (default: on)" 4
2613.IX Item "--enable-pointer-blank (default: on)" 2218.IX Item "--enable-pointer-blank (default: on)"
2614Add support to have the pointer disappear when typing or inactive. 2219Add support to have the pointer disappear when typing or inactive.
2615.IP "\-\-enable\-perl (default: off)" 4 2220.IP "\-\-enable\-perl (default: on)" 4
2616.IX Item "--enable-perl (default: off)" 2221.IX Item "--enable-perl (default: on)"
2617Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR 2222Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2618manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files 2223manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2619in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The 2224in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2620perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment 2225perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2621variable when running configure. 2226variable when running configure.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines