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.30 by root, Mon Jan 2 15:11:05 2006 UTC vs.
Revision 1.48 by root, Mon Jan 16 15:12:48 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-02" "6.2" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-16" "7.0" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134RXVT REFERENCE \- FAQ, command sequences and other background information 134RXVT REFERENCE \- FAQ, command sequences and other background information
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 2 137.Vb 2
… …
156The newest version of this document is 156The newest version of this document is
157also available on the World Wide Web at 157also available on the World Wide Web at
158<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>. 158<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
159.SH "FREQUENTLY ASKED QUESTIONS" 159.SH "FREQUENTLY ASKED QUESTIONS"
160.IX Header "FREQUENTLY ASKED QUESTIONS" 160.IX Header "FREQUENTLY ASKED QUESTIONS"
161.IP "The new selection selects pieces that are too big, how can I select single words?" 4
162.IX Item "The new selection selects pieces that are too big, how can I select single words?"
163Yes. For example, if you want to select alphanumeric words, you can use
164the following resource:
165.Sp
166.Vb 1
167\& URxvt.selection.pattern-0: ([[:word:]]+)
168.Ve
169.Sp
170If you click more than twice, the selection will be extended
171more and more.
172.Sp
173To get a selection that is very similar to the old code, try this pattern:
174.Sp
175.Vb 1
176\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+)
177.Ve
178.Sp
179Please also note that the \fILeftClick Shift-LeftClik\fR combination also
180selects words like the old code.
181.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4
182.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?"
183You can disable the perl extension completely by setting the
184\&\fBperl-ext-common\fR resource to the empty string, which also keeps
185rxvt-unicode from initialising perl, saving memory.
186.Sp
187If you only want to disable specific features, you first have to
188identify which perl extension is responsible. For this, read the section
189\&\fB\s-1PREPACKAGED\s0 \s-1EXTENSIONS\s0\fR in the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. For
190example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify
191this \fBperl-ext-common\fR resource:
192.Sp
193.Vb 1
194\& URxvt.perl-ext-common: default,-selection-popup,-option-popup
195.Ve
196.Sp
197This will keep the default extensions, but disable the two popup
198extensions. Some extensions can also be configured, for example,
199scrollback search mode is triggered by \fBM\-s\fR. You can move it to any
200other combination either by setting the \fBsearchable-scrollback\fR resource:
201.Sp
202.Vb 1
203\& URxvt.searchable-scrollback: CM-s
204.Ve
161.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4 205.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4
162.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?" 206.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?"
163I often get asked about this, and I think, no, they didn't cause extra 207I often get asked about this, and I think, no, they didn't cause extra
164bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 208bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
165that the urxvt binary is larger (due to some encoding tables always being 209that the urxvt binary is larger (due to some encoding tables always being
… …
198memory. 242memory.
199.Sp 243.Sp
200Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this 244Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
201still fares rather well. And compared to some monsters like gnome-terminal 245still fares rather well. And compared to some monsters like gnome-terminal
202(21152k + extra 4204k in separate processes) or konsole (22200k + extra 246(21152k + extra 4204k in separate processes) or konsole (22200k + extra
20343180k in daemons that stay around after exit, plus half aminute of 24743180k in daemons that stay around after exit, plus half a minute of
204startup time, including the hundreds of warnings it spits out), it fares 248startup time, including the hundreds of warnings it spits out), it fares
205extremely well *g*. 249extremely well *g*.
206.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4 250.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4
207.IX Item "Why , isn't that unportable/bloated/uncool?" 251.IX Item "Why , isn't that unportable/bloated/uncool?"
208Is this a question? :) It comes up very often. The simple answer is: I had 252Is this a question? :) It comes up very often. The simple answer is: I had
… …
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.
316.IP "I am maintaining rxvt-unicode for distribution/OS \s-1XXX\s0, any recommendation?" 4
317.IX Item "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?"
318You should build one binary with the default options. \fIconfigure\fR
319now enables most useful options, and the trend goes to making them
320runtime\-switchable, too, so there is usually no drawback to enbaling them,
321except higher disk and possibly memory usage. The perl interpreter should
322be enabled, as important functionality (menus, selection, likely more in
323the future) depends on it.
324.Sp
325You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR snd \f(CW\*(C`perl\-ext\*(C'\fR resources
326system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful
327behaviour. If your distribution aims at low memory, add an empty
328\&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the
329perl interpreter disabled until the user enables it.
330.Sp
331If you can/want build more binaries, I recommend building a minimal
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
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
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
338bad at it, I think it is simply unreasonable to expect all of freetype
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
344Elevated privileges are only required for utmp and pty operations on some
345systems (for example, GNU/Linux doesn't need any extra privileges for
346ptys, but some need it for utmp support). It is planned to mvoe this into
347a forked handler process, but this is not yet done.
348.Sp
349So, while setuid/setgid operation is supported and not a problem on your
350typical single-user-no-other-logins unix desktop, always remember that
351its an awful lot of code, most of which isn't checked for security issues
352regularly.
272.IP "When I log-in to another system it tells me about missing terminfo data?" 4 353.IP "When I log-in to another system it tells me about missing terminfo data?" 4
273.IX Item "When I log-in to another system it tells me about missing terminfo data?" 354.IX Item "When I log-in to another system it tells me about missing terminfo data?"
274The terminal description used by rxvt-unicode is not as widely available 355The terminal description used by rxvt-unicode is not as widely available
275as that for xterm, or even rxvt (for which the same problem often arises). 356as that for xterm, or even rxvt (for which the same problem often arises).
276.Sp 357.Sp
… …
694.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?" 775.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?"
695You can specify separate locales for the input method and the rest of the 776You can specify separate locales for the input method and the rest of the
696terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR: 777terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
697.Sp 778.Sp
698.Vb 1 779.Vb 1
699\& URxvt*imlocale: ja_JP.EUC-JP 780\& URxvt.imlocale: ja_JP.EUC-JP
700.Ve 781.Ve
701.Sp 782.Sp
702Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still 783Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
703use your input method. Please note, however, that you will not be able to 784use your input method. Please note, however, that you will not be able to
704input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input 785input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input
… …
746.IX Item "Mouse cut/paste suddenly no longer works." 827.IX Item "Mouse cut/paste suddenly no longer works."
747Make sure that mouse reporting is actually turned off since killing 828Make sure that mouse reporting is actually turned off since killing
748some editors prematurely may leave the mouse in mouse report mode. I've 829some editors prematurely may leave the mouse in mouse report mode. I've
749heard that tcsh may use mouse reporting unless it otherwise specified. A 830heard that tcsh may use mouse reporting unless it otherwise specified. A
750quick check is to see if cut/paste works when the Alt or Shift keys are 831quick check is to see if cut/paste works when the Alt or Shift keys are
751depressed. See @@RXVT_NAME@@(7) 832depressed.
752.IP "What's with this bold/blink stuff?" 4 833.IP "What's with this bold/blink stuff?" 4
753.IX Item "What's with this bold/blink stuff?" 834.IX Item "What's with this bold/blink stuff?"
754If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the 835If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
755standard foreground colour. 836standard foreground colour.
756.Sp 837.Sp
… …
851\& # use Backspace = ^? 932\& # use Backspace = ^?
852\& $ stty erase ^? 933\& $ stty erase ^?
853\& $ @@RXVT_NAME@@ 934\& $ @@RXVT_NAME@@
854.Ve 935.Ve
855.Sp 936.Sp
856Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR as documented in @@RXVT_NAME@@(7). 937Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR.
857.Sp 938.Sp
858For an existing rxvt\-unicode: 939For an existing rxvt\-unicode:
859.Sp 940.Sp
860.Vb 3 941.Vb 3
861\& # use Backspace = ^H 942\& # use Backspace = ^H
… …
977.IX Header "RXVT TECHNICAL REFERENCE" 1058.IX Header "RXVT TECHNICAL REFERENCE"
978.SH "DESCRIPTION" 1059.SH "DESCRIPTION"
979.IX Header "DESCRIPTION" 1060.IX Header "DESCRIPTION"
980The rest of this document describes various technical aspects of 1061The rest of this document describes various technical aspects of
981\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1062\&\fBrxvt-unicode\fR. First the description of supported command sequences,
982followed by menu and pixmap support and last by a description of all 1063followed by pixmap support and last by a description of all features
983features selectable at \f(CW\*(C`configure\*(C'\fR time. 1064selectable at \f(CW\*(C`configure\*(C'\fR time.
984.SH "Definitions" 1065.SH "Definitions"
985.IX Header "Definitions" 1066.IX Header "Definitions"
986.ie n .IP "\fB\fB""c""\fB\fR" 4 1067.ie n .IP "\fB\fB""c""\fB\fR" 4
987.el .IP "\fB\f(CBc\fB\fR" 4 1068.el .IP "\fB\f(CBc\fB\fR" 4
988.IX Item "c" 1069.IX Item "c"
… …
1535l l . 1616l l .
1536h Send Mouse X & Y on button press. 1617h Send Mouse X & Y on button press.
1537l No mouse reporting. 1618l No mouse reporting.
1538.TE 1619.TE
1539 1620
1540.ie n .IP "\fB\fB""Ps = 10""\fB\fR (\fBrxvt\fR)" 4
1541.el .IP "\fB\f(CBPs = 10\fB\fR (\fBrxvt\fR)" 4
1542.IX Item "Ps = 10 (rxvt)"
1543.TS
1544l l .
1545h menuBar visible
1546l menuBar invisible
1547.TE
1548
1549.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 1621.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4
1550.el .IP "\fB\f(CBPs = 25\fB\fR" 4 1622.el .IP "\fB\f(CBPs = 25\fB\fR" 4
1551.IX Item "Ps = 25" 1623.IX Item "Ps = 25"
1552.TS 1624.TS
1553l l . 1625l l .
… …
1737Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1809Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1738Ps = 11 Change colour of text background to Pt (NB: may change in future) 1810Ps = 11 Change colour of text background to Pt (NB: may change in future)
1739Ps = 12 Change colour of text cursor foreground to Pt 1811Ps = 12 Change colour of text cursor foreground to Pt
1740Ps = 13 Change colour of mouse foreground to Pt 1812Ps = 13 Change colour of mouse foreground to Pt
1741Ps = 17 Change colour of highlight characters to Pt 1813Ps = 17 Change colour of highlight characters to Pt
1742Ps = 18 Change colour of bold characters to Pt 1814Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1743Ps = 19 Change colour of underlined characters to Pt 1815Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1744Ps = 20 Change default background to Pt 1816Ps = 20 Change default background to Pt
1745Ps = 39 Change default foreground colour to Pt. 1817Ps = 39 Change default foreground colour to Pt.
1746Ps = 46 Change Log File to Pt unimplemented 1818Ps = 46 Change Log File to Pt unimplemented
1747Ps = 49 Change default background colour to Pt. 1819Ps = 49 Change default background colour to Pt.
1748Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n 1820Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1749Ps = 55 Log all scrollback buffer and all of screen to Pt 1821Ps = 55 Log all scrollback buffer and all of screen to Pt
1750Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1822Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1751Ps = 703 Menubar command Pt (Compile menubar).
1752Ps = 704 Change colour of italic characters to Pt 1823Ps = 704 Change colour of italic characters to Pt
1753Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1824Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1825Ps = 706 Change colour of bold characters to Pt
1826Ps = 707 Change colour of underlined characters to Pt
1754Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1827Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1755Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). 1828Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1756Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1829Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1757Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1830Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1758Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1831Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1759Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1832Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1833Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1760.TE 1834.TE
1761 1835
1762.PP 1836.PP
1763 1837
1764.IX Xref "menuBar" 1838.IX Xref "XPM"
1765.SH "menuBar"
1766.IX Header "menuBar"
1767\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1768In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1769menuBar.
1770.PP
1771Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1772omitted: use \fB./\fR to specify a menu relative to the current menu.
1773.Sh "Overview of menuBar operation"
1774.IX Subsection "Overview of menuBar operation"
1775For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1776of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1777.PP
1778At the top level is the current menuBar which is a member of a circular
1779linked-list of other such menuBars.
1780.PP
1781The menuBar acts as a parent for the various drop-down menus, which in
1782turn, may have labels, separator lines, menuItems and subMenus.
1783.PP
1784The menuItems are the useful bits: you can use them to mimic keyboard
1785input or even to send text or escape sequences back to rxvt.
1786.PP
1787The menuBar syntax is intended to provide a simple yet robust method of
1788constructing and manipulating menus and navigating through the
1789menuBars.
1790.PP
1791The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1792the menuBar called \fIname\fR and allows access. You may now or menus,
1793subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1794menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1795menus. To re-access the current menuBar for alterations, use the tag
1796\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1797.PP
1798
1799.IX Xref "menuBarCommands"
1800.Sh "Commands"
1801.IX Subsection "Commands"
1802.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1803.IX Item "[menu:+name]"
1804access the named menuBar for creation or alteration. If a new menuBar
1805is created, it is called \fIname\fR (max of 15 chars) and the current
1806menuBar is pushed onto the stack
1807.IP "\fB[menu]\fR" 4
1808.IX Item "[menu]"
1809access the current menuBar for alteration
1810.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1811.IX Item "[title:+string]"
1812set the current menuBar's title to \fIstring\fR, which may contain the
1813following format specifiers:
1814.Sp
1815.Vb 3
1816\& B<%n> rxvt name (as per the B<-name> command-line option)
1817\& B<%v> rxvt version
1818\& B<%%> literal B<%> character
1819.Ve
1820.IP "\fB[done]\fR" 4
1821.IX Item "[done]"
1822set menuBar access as \fBreadonly\fR.
1823End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1824.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1825.IX Item "[read:+file]"
1826read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1827appended 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.
1828.Sp
1829Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1830since any invalid menu commands are also ignored, almost anything could
1831be construed as a comment line, but this may be tightened up in the
1832future ... so don't count on it!.
1833.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1834.IX Item "[read:+file;+name]"
1835The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1836\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1837\&\fB[done]\fR is encountered.
1838.IP "\fB[dump]\fR" 4
1839.IX Item "[dump]"
1840dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1841later rereading.
1842.IP "\fB[rm:name]\fR" 4
1843.IX Item "[rm:name]"
1844remove the named menuBar
1845.IP "\fB[rm] [rm:]\fR" 4
1846.IX Item "[rm] [rm:]"
1847remove the current menuBar
1848.IP "\fB[rm*] [rm:*]\fR" 4
1849.IX Item "[rm*] [rm:*]"
1850remove all menuBars
1851.IP "\fB[swap]\fR" 4
1852.IX Item "[swap]"
1853swap the top two menuBars
1854.IP "\fB[prev]\fR" 4
1855.IX Item "[prev]"
1856access the previous menuBar
1857.IP "\fB[next]\fR" 4
1858.IX Item "[next]"
1859access the next menuBar
1860.IP "\fB[show]\fR" 4
1861.IX Item "[show]"
1862Enable display of the menuBar
1863.IP "\fB[hide]\fR" 4
1864.IX Item "[hide]"
1865Disable display of the menuBar
1866.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1867.IX Item "[pixmap:+name]"
1868.PD 0
1869.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1870.IX Item "[pixmap:+name;scaling]"
1871.PD
1872(set the background pixmap globally
1873.Sp
1874\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1875.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1876.IX Item "[:+command:]"
1877ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1878menuitem or change the ; a useful shortcut for setting the quick arrows
1879from a menuBar.
1880.PP
1881
1882.IX Xref "menuBarAdd"
1883.Sh "Adding and accessing menus"
1884.IX Subsection "Adding and accessing menus"
1885The following commands may also be \fB+\fR prefixed.
1886.IP "\fB/+\fR" 4
1887.IX Item "/+"
1888access menuBar top level
1889.IP "\fB./+\fR" 4
1890.IX Item "./+"
1891access current menu level
1892.IP "\fB../+\fR" 4
1893.IX Item "../+"
1894access parent menu (1 level up)
1895.IP "\fB../../\fR" 4
1896.IX Item "../../"
1897access parent menu (multiple levels up)
1898.IP "\fB\f(BI/path/\fBmenu\fR" 4
1899.IX Item "/path/menu"
1900add/access menu
1901.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1902.IX Item "/path/menu/*"
1903add/access menu and clear it if it exists
1904.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1905.IX Item "/path/{-}"
1906add separator
1907.IP "\fB\f(BI/path/\fB{item}\fR" 4
1908.IX Item "/path/{item}"
1909add \fBitem\fR as a label
1910.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1911.IX Item "/path/{item} action"
1912add/alter \fImenuitem\fR with an associated \fIaction\fR
1913.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1914.IX Item "/path/{item}{right-text}"
1915add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1916and as the associated \fIaction\fR
1917.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1918.IX Item "/path/{item}{rtext} action"
1919add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
1920the right-justified text.
1921.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
1922.IX Item "Special characters in action must be backslash-escaped:"
1923\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
1924.IP "or in control-character notation:" 4
1925.IX Item "or in control-character notation:"
1926\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
1927.PP
1928To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
1929program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
1930the first of which will be stripped off and the balance directed to the
1931program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
1932non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
1933balance is sent back to rxvt.
1934.PP
1935As a convenience for the many Emacs-type editors, \fIaction\fR may start
1936with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
1937appended if missed from \fBM\-x\fR commands.
1938.PP
1939As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
1940quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
1941.IP "For example," 4
1942.IX Item "For example,"
1943\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
1944.IP "and" 4
1945.IX Item "and"
1946\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
1947.PP
1948The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
1949absence of a specified action, this text will be used as the \fIaction\fR
1950as well.
1951.IP "For example," 4
1952.IX Item "For example,"
1953\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
1954.PP
1955The left label \fIis\fR necessary, since it's used for matching, but
1956implicitly hiding the left label (by using same name for both left and
1957right labels), or explicitly hiding the left label (by preceeding it
1958with a dot), makes it possible to have right-justified text only.
1959.IP "For example," 4
1960.IX Item "For example,"
1961\&\fB/File/{Open}{Open} Open-File-Action\fR
1962.IP "or hiding it" 4
1963.IX Item "or hiding it"
1964\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
1965.PP
1966
1967.IX Xref "menuBarRemove"
1968.Sh "Removing menus"
1969.IX Subsection "Removing menus"
1970.IP "\fB\-/*+\fR" 4
1971.IX Item "-/*+"
1972remove all menus from the menuBar, the same as \fB[clear]\fR
1973.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
1974.IX Item "-+/pathmenu+"
1975remove menu
1976.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
1977.IX Item "-+/path{item}+"
1978remove item
1979.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
1980.IX Item "-+/path{-}"
1981remove separator)
1982.IP "\fB\-/path/menu/*\fR" 4
1983.IX Item "-/path/menu/*"
1984remove all items, separators and submenus from menu
1985.PP
1986
1987.IX Xref "menuBarArrows"
1988.Sh "Quick Arrows"
1989.IX Subsection "Quick Arrows"
1990The menus also provide a hook for \fIquick arrows\fR to provide easier
1991user access. If nothing has been explicitly set, the default is to
1992emulate the curror keys. The syntax permits each arrow to be altered
1993individually or all four at once without re-entering their common
1994beginning/end text. For example, to explicitly associate cursor actions
1995with the arrows, any of the following forms could be used:
1996.IP "\fB<r>+\f(BIRight\fB\fR" 4
1997.IX Item "<r>+Right"
1998.PD 0
1999.IP "\fB<l>+\f(BILeft\fB\fR" 4
2000.IX Item "<l>+Left"
2001.IP "\fB<u>+\f(BIUp\fB\fR" 4
2002.IX Item "<u>+Up"
2003.IP "\fB<d>+\f(BIDown\fB\fR" 4
2004.IX Item "<d>+Down"
2005.PD
2006Define actions for the respective arrow buttons
2007.IP "\fB<b>+\f(BIBegin\fB\fR" 4
2008.IX Item "<b>+Begin"
2009.PD 0
2010.IP "\fB<e>+\f(BIEnd\fB\fR" 4
2011.IX Item "<e>+End"
2012.PD
2013Define common beginning/end parts for \fIquick arrows\fR which used in
2014conjunction with the above <r> <l> <u> <d> constructs
2015.IP "For example, define arrows individually," 4
2016.IX Item "For example, define arrows individually,"
2017.Vb 1
2018\& <u>\eE[A
2019.Ve
2020.Sp
2021.Vb 1
2022\& <d>\eE[B
2023.Ve
2024.Sp
2025.Vb 1
2026\& <r>\eE[C
2027.Ve
2028.Sp
2029.Vb 1
2030\& <l>\eE[D
2031.Ve
2032.IP "or all at once" 4
2033.IX Item "or all at once"
2034.Vb 1
2035\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
2036.Ve
2037.IP "or more compactly (factoring out common parts)" 4
2038.IX Item "or more compactly (factoring out common parts)"
2039.Vb 1
2040\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
2041.Ve
2042.PP
2043
2044.IX Xref "menuBarSummary"
2045.Sh "Command Summary"
2046.IX Subsection "Command Summary"
2047A short summary of the most \fIcommon\fR commands:
2048.IP "[menu:name]" 4
2049.IX Item "[menu:name]"
2050use an existing named menuBar or start a new one
2051.IP "[menu]" 4
2052.IX Item "[menu]"
2053use the current menuBar
2054.IP "[title:string]" 4
2055.IX Item "[title:string]"
2056set menuBar title
2057.IP "[done]" 4
2058.IX Item "[done]"
2059set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
2060.IP "[done:name]" 4
2061.IX Item "[done:name]"
2062if reading from a file using [read:file;name] signal \s-1EOF\s0
2063.IP "[rm:name]" 4
2064.IX Item "[rm:name]"
2065remove named menuBar(s)
2066.IP "[rm] [rm:]" 4
2067.IX Item "[rm] [rm:]"
2068remove current menuBar
2069.IP "[rm*] [rm:*]" 4
2070.IX Item "[rm*] [rm:*]"
2071remove all menuBar(s)
2072.IP "[swap]" 4
2073.IX Item "[swap]"
2074swap top two menuBars
2075.IP "[prev]" 4
2076.IX Item "[prev]"
2077access the previous menuBar
2078.IP "[next]" 4
2079.IX Item "[next]"
2080access the next menuBar
2081.IP "[show]" 4
2082.IX Item "[show]"
2083map menuBar
2084.IP "[hide]" 4
2085.IX Item "[hide]"
2086unmap menuBar
2087.IP "[pixmap;file]" 4
2088.IX Item "[pixmap;file]"
2089.PD 0
2090.IP "[pixmap;file;scaling]" 4
2091.IX Item "[pixmap;file;scaling]"
2092.PD
2093set a background pixmap
2094.IP "[read:file]" 4
2095.IX Item "[read:file]"
2096.PD 0
2097.IP "[read:file;name]" 4
2098.IX Item "[read:file;name]"
2099.PD
2100read in a menu from a file
2101.IP "[dump]" 4
2102.IX Item "[dump]"
2103dump out all menuBars to /tmp/rxvt\-PID
2104.IP "/" 4
2105access menuBar top level
2106.IP "./" 4
2107.PD 0
2108.IP "../" 4
2109.IP "../../" 4
2110.PD
2111access current or parent menu level
2112.IP "/path/menu" 4
2113.IX Item "/path/menu"
2114add/access menu
2115.IP "/path/{\-}" 4
2116.IX Item "/path/{-}"
2117add separator
2118.IP "/path/{item}{rtext} action" 4
2119.IX Item "/path/{item}{rtext} action"
2120add/alter menu item
2121.IP "\-/*" 4
2122remove all menus from the menuBar
2123.IP "\-/path/menu" 4
2124.IX Item "-/path/menu"
2125remove menu items, separators and submenus from menu
2126.IP "\-/path/menu" 4
2127.IX Item "-/path/menu"
2128remove menu
2129.IP "\-/path/{item}" 4
2130.IX Item "-/path/{item}"
2131remove item
2132.IP "\-/path/{\-}" 4
2133.IX Item "-/path/{-}"
2134remove separator
2135.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2136.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2137menu quick arrows
2138.SH "XPM" 1839.SH "XPM"
2139.IX Header "XPM" 1840.IX Header "XPM"
2140For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value 1841For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value
2141of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a 1842of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a
2142sequence of scaling/positioning commands separated by semi\-colons. The 1843sequence of scaling/positioning commands separated by semi\-colons. The
… …
2399.IP "\-\-enable\-lastlog (default: on)" 4 2100.IP "\-\-enable\-lastlog (default: on)" 4
2400.IX Item "--enable-lastlog (default: on)" 2101.IX Item "--enable-lastlog (default: on)"
2401Write user and tty to lastlog file (used by programs like 2102Write user and tty to lastlog file (used by programs like
2402\&\fIlastlogin\fR) at start of rxvt execution. This option requires 2103\&\fIlastlogin\fR) at start of rxvt execution. This option requires
2403\&\-\-enable\-utmp to also be specified. 2104\&\-\-enable\-utmp to also be specified.
2404.IP "\-\-enable\-xpm\-background (default: off)" 4 2105.IP "\-\-enable\-xpm\-background (default: on)" 4
2405.IX Item "--enable-xpm-background (default: off)" 2106.IX Item "--enable-xpm-background (default: on)"
2406Add support for \s-1XPM\s0 background pixmaps. 2107Add support for \s-1XPM\s0 background pixmaps.
2407.IP "\-\-enable\-transparency (default: off)" 4 2108.IP "\-\-enable\-transparency (default: on)" 4
2408.IX Item "--enable-transparency (default: off)" 2109.IX Item "--enable-transparency (default: on)"
2409Add support for inheriting parent backgrounds thus giving a fake 2110Add support for inheriting parent backgrounds thus giving a fake
2410transparency to the term. 2111transparency to the term.
2411.IP "\-\-enable\-fading (default: on)" 4 2112.IP "\-\-enable\-fading (default: on)" 4
2412.IX Item "--enable-fading (default: on)" 2113.IX Item "--enable-fading (default: on)"
2413Add 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).
2414.IP "\-\-enable\-tinting (default: on)" 4 2115.IP "\-\-enable\-tinting (default: on)" 4
2415.IX Item "--enable-tinting (default: on)" 2116.IX Item "--enable-tinting (default: on)"
2416Add 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).
2417.IP "\-\-enable\-menubar (default: off)" 4
2418.IX Item "--enable-menubar (default: off)"
2419Add support for our menu bar system (this interacts badly with
2420dynamic locale switching currently).
2421.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2118.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2422.IX Item "--enable-rxvt-scroll (default: on)" 2119.IX Item "--enable-rxvt-scroll (default: on)"
2423Add support for the original rxvt scrollbar. 2120Add support for the original rxvt scrollbar.
2424.IP "\-\-enable\-next\-scroll (default: on)" 4 2121.IP "\-\-enable\-next\-scroll (default: on)" 4
2425.IX Item "--enable-next-scroll (default: on)" 2122.IX Item "--enable-next-scroll (default: on)"
… …
2448Removes any handling of the delete key by us \- let the X server 2145Removes any handling of the delete key by us \- let the X server
2449do it. 2146do it.
2450.IP "\-\-disable\-resources" 4 2147.IP "\-\-disable\-resources" 4
2451.IX Item "--disable-resources" 2148.IX Item "--disable-resources"
2452Removes any support for resource checking. 2149Removes any support for resource checking.
2453.IP "\-\-enable\-xgetdefault" 4
2454.IX Item "--enable-xgetdefault"
2455Make resources checking via \fIXGetDefault()\fR instead of our small
2456version which only checks ~/.Xdefaults, or if that doesn't exist then
2457~/.Xresources.
2458.Sp
2459Please note that nowadays, things like \s-1XIM\s0 will automatically pull in and
2460use the full X resource manager, so the overhead of using it might be very
2461small, if nonexistant.
2462.IP "\-\-enable\-strings (default: off)" 4
2463.IX Item "--enable-strings (default: off)"
2464Add support for our possibly faster \fImemset()\fR function and other
2465various routines, overriding your system's versions which may
2466have been hand-crafted in assembly or may require extra libraries
2467to link in. (this breaks ANSI-C rules and has problems on many
2468GNU/Linux systems).
2469.IP "\-\-disable\-swapscreen" 4 2150.IP "\-\-disable\-swapscreen" 4
2470.IX Item "--disable-swapscreen" 2151.IX Item "--disable-swapscreen"
2471Remove support for secondary/swap screen. 2152Remove support for secondary/swap screen.
2472.IP "\-\-enable\-frills (default: on)" 4 2153.IP "\-\-enable\-frills (default: on)" 4
2473.IX Item "--enable-frills (default: on)" 2154.IX Item "--enable-frills (default: on)"
… …
2476disable this. 2157disable this.
2477.Sp 2158.Sp
2478A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2159A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2479in combination with other switches) is: 2160in combination with other switches) is:
2480.Sp 2161.Sp
2481.Vb 13 2162.Vb 17
2482\& MWM-hints 2163\& MWM-hints
2483\& EWMH-hints (pid, utf8 names) and protocols (ping) 2164\& EWMH-hints (pid, utf8 names) and protocols (ping)
2484\& seperate underline colour 2165\& seperate underline colour (-underlineColor)
2485\& settable border widths and borderless switch 2166\& settable border widths and borderless switch (-w, -b, -bl)
2486\& settable extra linespacing 2167\& settable extra linespacing /-lsp)
2487\& iso-14755-2 and -3, and visual feedback 2168\& iso-14755-2 and -3, and visual feedback
2488\& backindex and forwardindex escape sequence 2169\& backindex and forwardindex escape sequence
2489\& window op and some xterm/OSC escape sequences 2170\& window op and some xterm/OSC escape sequences
2490\& tripleclickwords 2171\& tripleclickwords (-tcw)
2491\& settable insecure mode 2172\& settable insecure mode (-insecure)
2492\& keysym remapping support 2173\& keysym remapping support
2493\& cursor blinking and underline cursor 2174\& cursor blinking and underline cursor (-cb, -uc)
2494\& -embed, -pty-fd and -hold options 2175\& XEmbed support (-embed)
2176\& user-pty (-pty-fd)
2177\& hold on exit (-hold)
2178\& skip builtin block graphics (-sbg)
2179\& sgr modes 90..97 and 100..107
2495.Ve 2180.Ve
2496.IP "\-\-enable\-iso14755 (default: on)" 4 2181.IP "\-\-enable\-iso14755 (default: on)" 4
2497.IX Item "--enable-iso14755 (default: on)" 2182.IX Item "--enable-iso14755 (default: on)"
2498Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or 2183Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
2499\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by 2184\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by
… …
2533keys. This should keep the window corner which is closest to a corner of 2218keys. This should keep the window corner which is closest to a corner of
2534the screen in a fixed position. 2219the screen in a fixed position.
2535.IP "\-\-enable\-pointer\-blank (default: on)" 4 2220.IP "\-\-enable\-pointer\-blank (default: on)" 4
2536.IX Item "--enable-pointer-blank (default: on)" 2221.IX Item "--enable-pointer-blank (default: on)"
2537Add support to have the pointer disappear when typing or inactive. 2222Add support to have the pointer disappear when typing or inactive.
2223.IP "\-\-enable\-perl (default: off)" 4
2224.IX Item "--enable-perl (default: off)"
2225Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2226manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2227in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2228perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2229variable when running configure.
2538.IP "\-\-with\-name=NAME (default: urxvt)" 4 2230.IP "\-\-with\-name=NAME (default: urxvt)" 4
2539.IX Item "--with-name=NAME (default: urxvt)" 2231.IX Item "--with-name=NAME (default: urxvt)"
2540Set the basename for the installed binaries, resulting 2232Set the basename for the installed binaries, resulting
2541in \f(CW\*(C`urxvt\*(C'\fR, \f(CW\*(C`urxvtd\*(C'\fR etc.). Specify \f(CW\*(C`\-\-with\-name=rxvt\*(C'\fR to replace with 2233in \f(CW\*(C`urxvt\*(C'\fR, \f(CW\*(C`urxvtd\*(C'\fR etc.). Specify \f(CW\*(C`\-\-with\-name=rxvt\*(C'\fR to replace with
2542\&\f(CW\*(C`rxvt\*(C'\fR. 2234\&\f(CW\*(C`rxvt\*(C'\fR.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines