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.40 by root, Wed Jan 11 19:55:34 2006 UTC vs.
Revision 1.51 by root, Wed Jan 25 00:57:57 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-11" "6.3" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-25" "7.2" "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
255using 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
256daemon. 300daemon.
257.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
258.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..."
259The Debian GNU/Linux package of rxvt-unicode in sarge contains large 303The Debian GNU/Linux package of rxvt-unicode in sarge contains large
260patches that considerably change the behaviour of rxvt\-unicode. Before 304patches that considerably change the behaviour of rxvt-unicode (but
261reporting a bug to the original rxvt-unicode author please download and 305unfortunately this notice has been removed). Before reporting a bug to
262install the genuine version (<http://software.schmorp.de#rxvt\-unicode>) 306the original rxvt-unicode author please download and install the genuine
263and try to reproduce the problem. If you cannot, chances are that the 307version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce
264problems 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
265reported 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).
266the bug).
267.Sp 311.Sp
268For other problems that also affect the Debian package, you can and 312For other problems that also affect the Debian package, you can and
269probably 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
270bug 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
271might encounter the same issue. 315might encounter the same issue.
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 not 337It should be, starting with release 7.1. You are encouraged to properly
294bad at it, I think it is simply unreasonable to expect all of freetype 338install urxvt with privileges necessary for your \s-1OS\s0 now.
295+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
296secure. Also, rxvt-unicode disables some options when it detects that it
297runs setuid or setgid, which is not nice. Besides, with the embedded perl
298interpreter the possibility for security problems easily multiplies.
299.Sp 339.Sp
300Elevated privileges are only required for utmp and pty operations on some 340When rxvt-unicode detects that it runs setuid or setgid, it will fork
301systems (for example, GNU/Linux doesn't need any extra privileges for 341into a helper process for privileged operations (pty handling on some
302ptys, but some need it for utmp support). It is planned to mvoe this into 342systems, utmp/wtmp/lastlog handling on others) and drop privileges
303a 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).
304.Sp 346.Sp
305So, 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
306typical single-user-no-other-logins unix desktop, always remember that 348and reduces possible bugs to initialisation code run before \fImain()\fR, or
307its 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
308regularly. 350little risk.
309.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
310.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?"
311The terminal description used by rxvt-unicode is not as widely available 353The terminal description used by rxvt-unicode is not as widely available
312as 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).
313.Sp 355.Sp
731.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?"
732You 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
733terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR: 775terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
734.Sp 776.Sp
735.Vb 1 777.Vb 1
736\& URxvt*imlocale: ja_JP.EUC-JP 778\& URxvt.imlocale: ja_JP.EUC-JP
737.Ve 779.Ve
738.Sp 780.Sp
739Now 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
740use 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
741input 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
783.IX Item "Mouse cut/paste suddenly no longer works." 825.IX Item "Mouse cut/paste suddenly no longer works."
784Make sure that mouse reporting is actually turned off since killing 826Make sure that mouse reporting is actually turned off since killing
785some 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
786heard that tcsh may use mouse reporting unless it otherwise specified. A 828heard 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 829quick check is to see if cut/paste works when the Alt or Shift keys are
788depressed. See @@RXVT_NAME@@(7) 830depressed.
789.IP "What's with this bold/blink stuff?" 4 831.IP "What's with this bold/blink stuff?" 4
790.IX Item "What's with this bold/blink stuff?" 832.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 833If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
792standard foreground colour. 834standard foreground colour.
793.Sp 835.Sp
888\& # use Backspace = ^? 930\& # use Backspace = ^?
889\& $ stty erase ^? 931\& $ stty erase ^?
890\& $ @@RXVT_NAME@@ 932\& $ @@RXVT_NAME@@
891.Ve 933.Ve
892.Sp 934.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). 935Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR.
894.Sp 936.Sp
895For an existing rxvt\-unicode: 937For an existing rxvt\-unicode:
896.Sp 938.Sp
897.Vb 3 939.Vb 3
898\& # use Backspace = ^H 940\& # use Backspace = ^H
1014.IX Header "RXVT TECHNICAL REFERENCE" 1056.IX Header "RXVT TECHNICAL REFERENCE"
1015.SH "DESCRIPTION" 1057.SH "DESCRIPTION"
1016.IX Header "DESCRIPTION" 1058.IX Header "DESCRIPTION"
1017The rest of this document describes various technical aspects of 1059The rest of this document describes various technical aspects of
1018\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1060\&\fBrxvt-unicode\fR. First the description of supported command sequences,
1019followed by menu and pixmap support and last by a description of all 1061followed by pixmap support and last by a description of all features
1020features selectable at \f(CW\*(C`configure\*(C'\fR time. 1062selectable at \f(CW\*(C`configure\*(C'\fR time.
1021.SH "Definitions" 1063.SH "Definitions"
1022.IX Header "Definitions" 1064.IX Header "Definitions"
1023.ie n .IP "\fB\fB""c""\fB\fR" 4 1065.ie n .IP "\fB\fB""c""\fB\fR" 4
1024.el .IP "\fB\f(CBc\fB\fR" 4 1066.el .IP "\fB\f(CBc\fB\fR" 4
1025.IX Item "c" 1067.IX Item "c"
1572l l . 1614l l .
1573h Send Mouse X & Y on button press. 1615h Send Mouse X & Y on button press.
1574l No mouse reporting. 1616l No mouse reporting.
1575.TE 1617.TE
1576 1618
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 1619.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4
1587.el .IP "\fB\f(CBPs = 25\fB\fR" 4 1620.el .IP "\fB\f(CBPs = 25\fB\fR" 4
1588.IX Item "Ps = 25" 1621.IX Item "Ps = 25"
1589.TS 1622.TS
1590l l . 1623l l .
1776Ps = 12 Change colour of text cursor foreground to Pt 1809Ps = 12 Change colour of text cursor foreground to Pt
1777Ps = 13 Change colour of mouse foreground to Pt 1810Ps = 13 Change colour of mouse foreground to Pt
1778Ps = 17 Change colour of highlight characters to Pt 1811Ps = 17 Change colour of highlight characters to Pt
1779Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] 1812Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1780Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] 1813Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1781Ps = 20 Change default background to Pt 1814Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1782Ps = 39 Change default foreground colour to Pt. 1815Ps = 39 Change default foreground colour to Pt.
1783Ps = 46 Change Log File to Pt unimplemented 1816Ps = 46 Change Log File to Pt unimplemented
1784Ps = 49 Change default background colour to Pt. 1817Ps = 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 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
1786Ps = 55 Log all scrollback buffer and all of screen to Pt 1819Ps = 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). 1820Ps = 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 1821Ps = 704 Change colour of italic characters to Pt
1790Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1822Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1791Ps = 706 Change colour of bold characters to Pt 1823Ps = 706 Change colour of bold characters to Pt
1792Ps = 707 Change colour of underlined characters to Pt 1824Ps = 707 Change colour of underlined characters to Pt
1793Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1825Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1799Ps = 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).
1800.TE 1832.TE
1801 1833
1802.PP 1834.PP
1803 1835
1804.IX Xref "menuBar" 1836.IX Xref "XPM"
1805.SH "menuBar"
1806.IX Header "menuBar"
1807\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1808In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1809menuBar.
1810.PP
1811Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1812omitted: use \fB./\fR to specify a menu relative to the current menu.
1813.Sh "Overview of menuBar operation"
1814.IX Subsection "Overview of menuBar operation"
1815For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1816of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1817.PP
1818At the top level is the current menuBar which is a member of a circular
1819linked-list of other such menuBars.
1820.PP
1821The menuBar acts as a parent for the various drop-down menus, which in
1822turn, may have labels, separator lines, menuItems and subMenus.
1823.PP
1824The menuItems are the useful bits: you can use them to mimic keyboard
1825input or even to send text or escape sequences back to rxvt.
1826.PP
1827The menuBar syntax is intended to provide a simple yet robust method of
1828constructing and manipulating menus and navigating through the
1829menuBars.
1830.PP
1831The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1832the menuBar called \fIname\fR and allows access. You may now or menus,
1833subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1834menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1835menus. To re-access the current menuBar for alterations, use the tag
1836\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1837.PP
1838
1839.IX Xref "menuBarCommands"
1840.Sh "Commands"
1841.IX Subsection "Commands"
1842.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1843.IX Item "[menu:+name]"
1844access the named menuBar for creation or alteration. If a new menuBar
1845is created, it is called \fIname\fR (max of 15 chars) and the current
1846menuBar is pushed onto the stack
1847.IP "\fB[menu]\fR" 4
1848.IX Item "[menu]"
1849access the current menuBar for alteration
1850.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1851.IX Item "[title:+string]"
1852set the current menuBar's title to \fIstring\fR, which may contain the
1853following format specifiers:
1854.Sp
1855.Vb 3
1856\& B<%n> rxvt name (as per the B<-name> command-line option)
1857\& B<%v> rxvt version
1858\& B<%%> literal B<%> character
1859.Ve
1860.IP "\fB[done]\fR" 4
1861.IX Item "[done]"
1862set menuBar access as \fBreadonly\fR.
1863End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1864.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1865.IX Item "[read:+file]"
1866read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1867appended 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.
1868.Sp
1869Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1870since any invalid menu commands are also ignored, almost anything could
1871be construed as a comment line, but this may be tightened up in the
1872future ... so don't count on it!.
1873.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1874.IX Item "[read:+file;+name]"
1875The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1876\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1877\&\fB[done]\fR is encountered.
1878.IP "\fB[dump]\fR" 4
1879.IX Item "[dump]"
1880dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1881later rereading.
1882.IP "\fB[rm:name]\fR" 4
1883.IX Item "[rm:name]"
1884remove the named menuBar
1885.IP "\fB[rm] [rm:]\fR" 4
1886.IX Item "[rm] [rm:]"
1887remove the current menuBar
1888.IP "\fB[rm*] [rm:*]\fR" 4
1889.IX Item "[rm*] [rm:*]"
1890remove all menuBars
1891.IP "\fB[swap]\fR" 4
1892.IX Item "[swap]"
1893swap the top two menuBars
1894.IP "\fB[prev]\fR" 4
1895.IX Item "[prev]"
1896access the previous menuBar
1897.IP "\fB[next]\fR" 4
1898.IX Item "[next]"
1899access the next menuBar
1900.IP "\fB[show]\fR" 4
1901.IX Item "[show]"
1902Enable display of the menuBar
1903.IP "\fB[hide]\fR" 4
1904.IX Item "[hide]"
1905Disable display of the menuBar
1906.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1907.IX Item "[pixmap:+name]"
1908.PD 0
1909.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1910.IX Item "[pixmap:+name;scaling]"
1911.PD
1912(set the background pixmap globally
1913.Sp
1914\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1915.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1916.IX Item "[:+command:]"
1917ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1918menuitem or change the ; a useful shortcut for setting the quick arrows
1919from a menuBar.
1920.PP
1921
1922.IX Xref "menuBarAdd"
1923.Sh "Adding and accessing menus"
1924.IX Subsection "Adding and accessing menus"
1925The following commands may also be \fB+\fR prefixed.
1926.IP "\fB/+\fR" 4
1927.IX Item "/+"
1928access menuBar top level
1929.IP "\fB./+\fR" 4
1930.IX Item "./+"
1931access current menu level
1932.IP "\fB../+\fR" 4
1933.IX Item "../+"
1934access parent menu (1 level up)
1935.IP "\fB../../\fR" 4
1936.IX Item "../../"
1937access parent menu (multiple levels up)
1938.IP "\fB\f(BI/path/\fBmenu\fR" 4
1939.IX Item "/path/menu"
1940add/access menu
1941.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1942.IX Item "/path/menu/*"
1943add/access menu and clear it if it exists
1944.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1945.IX Item "/path/{-}"
1946add separator
1947.IP "\fB\f(BI/path/\fB{item}\fR" 4
1948.IX Item "/path/{item}"
1949add \fBitem\fR as a label
1950.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1951.IX Item "/path/{item} action"
1952add/alter \fImenuitem\fR with an associated \fIaction\fR
1953.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1954.IX Item "/path/{item}{right-text}"
1955add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1956and as the associated \fIaction\fR
1957.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1958.IX Item "/path/{item}{rtext} action"
1959add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
1960the right-justified text.
1961.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
1962.IX Item "Special characters in action must be backslash-escaped:"
1963\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
1964.IP "or in control-character notation:" 4
1965.IX Item "or in control-character notation:"
1966\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
1967.PP
1968To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
1969program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
1970the first of which will be stripped off and the balance directed to the
1971program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
1972non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
1973balance is sent back to rxvt.
1974.PP
1975As a convenience for the many Emacs-type editors, \fIaction\fR may start
1976with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
1977appended if missed from \fBM\-x\fR commands.
1978.PP
1979As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
1980quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
1981.IP "For example," 4
1982.IX Item "For example,"
1983\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
1984.IP "and" 4
1985.IX Item "and"
1986\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
1987.PP
1988The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
1989absence of a specified action, this text will be used as the \fIaction\fR
1990as well.
1991.IP "For example," 4
1992.IX Item "For example,"
1993\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
1994.PP
1995The left label \fIis\fR necessary, since it's used for matching, but
1996implicitly hiding the left label (by using same name for both left and
1997right labels), or explicitly hiding the left label (by preceeding it
1998with a dot), makes it possible to have right-justified text only.
1999.IP "For example," 4
2000.IX Item "For example,"
2001\&\fB/File/{Open}{Open} Open-File-Action\fR
2002.IP "or hiding it" 4
2003.IX Item "or hiding it"
2004\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
2005.PP
2006
2007.IX Xref "menuBarRemove"
2008.Sh "Removing menus"
2009.IX Subsection "Removing menus"
2010.IP "\fB\-/*+\fR" 4
2011.IX Item "-/*+"
2012remove all menus from the menuBar, the same as \fB[clear]\fR
2013.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
2014.IX Item "-+/pathmenu+"
2015remove menu
2016.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
2017.IX Item "-+/path{item}+"
2018remove item
2019.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
2020.IX Item "-+/path{-}"
2021remove separator)
2022.IP "\fB\-/path/menu/*\fR" 4
2023.IX Item "-/path/menu/*"
2024remove all items, separators and submenus from menu
2025.PP
2026
2027.IX Xref "menuBarArrows"
2028.Sh "Quick Arrows"
2029.IX Subsection "Quick Arrows"
2030The menus also provide a hook for \fIquick arrows\fR to provide easier
2031user access. If nothing has been explicitly set, the default is to
2032emulate the curror keys. The syntax permits each arrow to be altered
2033individually or all four at once without re-entering their common
2034beginning/end text. For example, to explicitly associate cursor actions
2035with the arrows, any of the following forms could be used:
2036.IP "\fB<r>+\f(BIRight\fB\fR" 4
2037.IX Item "<r>+Right"
2038.PD 0
2039.IP "\fB<l>+\f(BILeft\fB\fR" 4
2040.IX Item "<l>+Left"
2041.IP "\fB<u>+\f(BIUp\fB\fR" 4
2042.IX Item "<u>+Up"
2043.IP "\fB<d>+\f(BIDown\fB\fR" 4
2044.IX Item "<d>+Down"
2045.PD
2046Define actions for the respective arrow buttons
2047.IP "\fB<b>+\f(BIBegin\fB\fR" 4
2048.IX Item "<b>+Begin"
2049.PD 0
2050.IP "\fB<e>+\f(BIEnd\fB\fR" 4
2051.IX Item "<e>+End"
2052.PD
2053Define common beginning/end parts for \fIquick arrows\fR which used in
2054conjunction with the above <r> <l> <u> <d> constructs
2055.IP "For example, define arrows individually," 4
2056.IX Item "For example, define arrows individually,"
2057.Vb 1
2058\& <u>\eE[A
2059.Ve
2060.Sp
2061.Vb 1
2062\& <d>\eE[B
2063.Ve
2064.Sp
2065.Vb 1
2066\& <r>\eE[C
2067.Ve
2068.Sp
2069.Vb 1
2070\& <l>\eE[D
2071.Ve
2072.IP "or all at once" 4
2073.IX Item "or all at once"
2074.Vb 1
2075\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
2076.Ve
2077.IP "or more compactly (factoring out common parts)" 4
2078.IX Item "or more compactly (factoring out common parts)"
2079.Vb 1
2080\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
2081.Ve
2082.PP
2083
2084.IX Xref "menuBarSummary"
2085.Sh "Command Summary"
2086.IX Subsection "Command Summary"
2087A short summary of the most \fIcommon\fR commands:
2088.IP "[menu:name]" 4
2089.IX Item "[menu:name]"
2090use an existing named menuBar or start a new one
2091.IP "[menu]" 4
2092.IX Item "[menu]"
2093use the current menuBar
2094.IP "[title:string]" 4
2095.IX Item "[title:string]"
2096set menuBar title
2097.IP "[done]" 4
2098.IX Item "[done]"
2099set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
2100.IP "[done:name]" 4
2101.IX Item "[done:name]"
2102if reading from a file using [read:file;name] signal \s-1EOF\s0
2103.IP "[rm:name]" 4
2104.IX Item "[rm:name]"
2105remove named menuBar(s)
2106.IP "[rm] [rm:]" 4
2107.IX Item "[rm] [rm:]"
2108remove current menuBar
2109.IP "[rm*] [rm:*]" 4
2110.IX Item "[rm*] [rm:*]"
2111remove all menuBar(s)
2112.IP "[swap]" 4
2113.IX Item "[swap]"
2114swap top two menuBars
2115.IP "[prev]" 4
2116.IX Item "[prev]"
2117access the previous menuBar
2118.IP "[next]" 4
2119.IX Item "[next]"
2120access the next menuBar
2121.IP "[show]" 4
2122.IX Item "[show]"
2123map menuBar
2124.IP "[hide]" 4
2125.IX Item "[hide]"
2126unmap menuBar
2127.IP "[pixmap;file]" 4
2128.IX Item "[pixmap;file]"
2129.PD 0
2130.IP "[pixmap;file;scaling]" 4
2131.IX Item "[pixmap;file;scaling]"
2132.PD
2133set a background pixmap
2134.IP "[read:file]" 4
2135.IX Item "[read:file]"
2136.PD 0
2137.IP "[read:file;name]" 4
2138.IX Item "[read:file;name]"
2139.PD
2140read in a menu from a file
2141.IP "[dump]" 4
2142.IX Item "[dump]"
2143dump out all menuBars to /tmp/rxvt\-PID
2144.IP "/" 4
2145access menuBar top level
2146.IP "./" 4
2147.PD 0
2148.IP "../" 4
2149.IP "../../" 4
2150.PD
2151access current or parent menu level
2152.IP "/path/menu" 4
2153.IX Item "/path/menu"
2154add/access menu
2155.IP "/path/{\-}" 4
2156.IX Item "/path/{-}"
2157add separator
2158.IP "/path/{item}{rtext} action" 4
2159.IX Item "/path/{item}{rtext} action"
2160add/alter menu item
2161.IP "\-/*" 4
2162remove all menus from the menuBar
2163.IP "\-/path/menu" 4
2164.IX Item "-/path/menu"
2165remove menu items, separators and submenus from menu
2166.IP "\-/path/menu" 4
2167.IX Item "-/path/menu"
2168remove menu
2169.IP "\-/path/{item}" 4
2170.IX Item "-/path/{item}"
2171remove item
2172.IP "\-/path/{\-}" 4
2173.IX Item "-/path/{-}"
2174remove separator
2175.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2176.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2177menu quick arrows
2178.SH "XPM" 1837.SH "XPM"
2179.IX Header "XPM" 1838.IX Header "XPM"
2180For 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
2181of \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
2182sequence of scaling/positioning commands separated by semi\-colons. The 1841sequence of scaling/positioning commands separated by semi\-colons. The
2384Add 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
2385alternative input methods (e.g. kinput2) and will also correctly 2044alternative input methods (e.g. kinput2) and will also correctly
2386set up the input for people using dead keys or compose keys. 2045set up the input for people using dead keys or compose keys.
2387.IP "\-\-enable\-unicode3 (default: off)" 4 2046.IP "\-\-enable\-unicode3 (default: off)" 4
2388.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
2389Enable direct support for displaying unicode codepoints above 2050Enable direct support for displaying unicode codepoints above
239065535 (the basic multilingual page). This increases storage 205165535 (the basic multilingual page). This increases storage
2391requirements 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
2392support these extra characters, but Xft does. 2053support these extra characters, but Xft does.
2393.Sp 2054.Sp
2402composite characters. This is required for proper viewing of text 2063composite characters. This is required for proper viewing of text
2403where accents are encoded as seperate unicode characters. This is 2064where accents are encoded as seperate unicode characters. This is
2404done by using precomposited characters when available or creating 2065done by using precomposited characters when available or creating
2405new pseudo-characters when no precomposed form exists. 2066new pseudo-characters when no precomposed form exists.
2406.Sp 2067.Sp
2407Without \-\-enable\-unicode3, the number of additional precomposed characters 2068Without \-\-enable\-unicode3, the number of additional precomposed
2408is rather limited (2048, if this is full, rxvt-unicode will use the 2069characters is somewhat limited (the 6400 private use characters will be
2409private use area, extending the number of combinations to 8448). With
2410\&\-\-enable\-unicode3, no practical limit exists. 2070(ab\-)used). With \-\-enable\-unicode3, no practical limit exists.
2411.Sp 2071.Sp
2412This option will also enable storage (but not display) of characters 2072This option will also enable storage (but not display) of characters
2413beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified. 2073beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
2414.Sp 2074.Sp
2415The combining table also contains entries for arabic presentation forms, 2075The combining table also contains entries for arabic presentation forms,
2416but 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
2417tell me how these are to be used...). 2077tell me how these are to be used...).
2418.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4 2078.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4
2419.IX Item "--enable-fallback(=CLASS) (default: Rxvt)" 2079.IX Item "--enable-fallback(=CLASS) (default: Rxvt)"
2420When 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.
2421.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4 2082.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4
2422.IX Item "--with-res-name=NAME (default: urxvt)" 2083.IX Item "--with-res-name=NAME (default: urxvt)"
2423Use the given name as default application name when 2084Use the given name as default application name when
2424reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt. 2085reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
2425.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4 2086.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4
2452.IX Item "--enable-fading (default: on)" 2113.IX Item "--enable-fading (default: on)"
2453Add 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).
2454.IP "\-\-enable\-tinting (default: on)" 4 2115.IP "\-\-enable\-tinting (default: on)" 4
2455.IX Item "--enable-tinting (default: on)" 2116.IX Item "--enable-tinting (default: on)"
2456Add 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).
2457.IP "\-\-enable\-menubar (default: off) [\s-1DEPRECATED\s0]" 4
2458.IX Item "--enable-menubar (default: off) [DEPRECATED]"
2459Add support for our menu bar system (this interacts badly with dynamic
2460locale switching currently). This option is \s-1DEPRECATED\s0 and will be removed
2461in the future.
2462.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2118.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2463.IX Item "--enable-rxvt-scroll (default: on)" 2119.IX Item "--enable-rxvt-scroll (default: on)"
2464Add support for the original rxvt scrollbar. 2120Add support for the original rxvt scrollbar.
2465.IP "\-\-enable\-next\-scroll (default: on)" 4 2121.IP "\-\-enable\-next\-scroll (default: on)" 4
2466.IX Item "--enable-next-scroll (default: on)" 2122.IX Item "--enable-next-scroll (default: on)"
2471.IP "\-\-enable\-plain\-scroll (default: on)" 4 2127.IP "\-\-enable\-plain\-scroll (default: on)" 4
2472.IX Item "--enable-plain-scroll (default: on)" 2128.IX Item "--enable-plain-scroll (default: on)"
2473Add support for a very unobtrusive, plain-looking scrollbar that 2129Add support for a very unobtrusive, plain-looking scrollbar that
2474is the favourite of the rxvt-unicode author, having used it for 2130is the favourite of the rxvt-unicode author, having used it for
2475many years. 2131many years.
2476.IP "\-\-enable\-half\-shadow (default: off)" 4
2477.IX Item "--enable-half-shadow (default: off)"
2478Make shadows on the scrollbar only half the normal width & height.
2479only applicable to rxvt scrollbars.
2480.IP "\-\-enable\-ttygid (default: off)" 4 2132.IP "\-\-enable\-ttygid (default: off)" 4
2481.IX Item "--enable-ttygid (default: off)" 2133.IX Item "--enable-ttygid (default: off)"
2482Change 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
2483your system uses this type of security. 2135your system uses this type of security.
2484.IP "\-\-disable\-backspace\-key" 4 2136.IP "\-\-disable\-backspace\-key" 4
2489Removes 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
2490do it. 2142do it.
2491.IP "\-\-disable\-resources" 4 2143.IP "\-\-disable\-resources" 4
2492.IX Item "--disable-resources" 2144.IX Item "--disable-resources"
2493Removes any support for resource checking. 2145Removes any support for resource checking.
2494.IP "\-\-enable\-xgetdefault" 4
2495.IX Item "--enable-xgetdefault"
2496Make resources checking via \fIXGetDefault()\fR instead of our small
2497version which only checks ~/.Xdefaults, or if that doesn't exist then
2498~/.Xresources.
2499.Sp
2500Please note that nowadays, things like \s-1XIM\s0 will automatically pull in and
2501use the full X resource manager, so the overhead of using it might be very
2502small, if nonexistant.
2503.IP "\-\-enable\-strings (default: off)" 4
2504.IX Item "--enable-strings (default: off)"
2505Add support for our possibly faster \fImemset()\fR function and other
2506various routines, overriding your system's versions which may
2507have been hand-crafted in assembly or may require extra libraries
2508to link in. (this breaks ANSI-C rules and has problems on many
2509GNU/Linux systems).
2510.IP "\-\-disable\-swapscreen" 4 2146.IP "\-\-disable\-swapscreen" 4
2511.IX Item "--disable-swapscreen" 2147.IX Item "--disable-swapscreen"
2512Remove support for secondary/swap screen. 2148Remove support for secondary/swap screen.
2513.IP "\-\-enable\-frills (default: on)" 4 2149.IP "\-\-enable\-frills (default: on)" 4
2514.IX Item "--enable-frills (default: on)" 2150.IX Item "--enable-frills (default: on)"
2578keys. This should keep the window corner which is closest to a corner of 2214keys. This should keep the window corner which is closest to a corner of
2579the screen in a fixed position. 2215the screen in a fixed position.
2580.IP "\-\-enable\-pointer\-blank (default: on)" 4 2216.IP "\-\-enable\-pointer\-blank (default: on)" 4
2581.IX Item "--enable-pointer-blank (default: on)" 2217.IX Item "--enable-pointer-blank (default: on)"
2582Add support to have the pointer disappear when typing or inactive. 2218Add support to have the pointer disappear when typing or inactive.
2583.IP "\-\-enable\-perl (default: off)" 4 2219.IP "\-\-enable\-perl (default: on)" 4
2584.IX Item "--enable-perl (default: off)" 2220.IX Item "--enable-perl (default: on)"
2585Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR 2221Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2586manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files 2222manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2587in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The 2223in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2588perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment 2224perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2589variable when running configure. 2225variable when running configure.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines