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.29 by root, Sat Dec 24 12:55:17 2005 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 "2005-12-24" "6.0" "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 .
… …
1672.IX Item "Ps = 1011 (rxvt)" 1744.IX Item "Ps = 1011 (rxvt)"
1673.TS 1745.TS
1674l l . 1746l l .
1675h Scroll to bottom when a key is pressed 1747h Scroll to bottom when a key is pressed
1676l Don't scroll to bottom when a key is pressed 1748l Don't scroll to bottom when a key is pressed
1749.TE
1750
1751.ie n .IP "\fB\fB""Ps = 1021""\fB\fR (\fBrxvt\fR)" 4
1752.el .IP "\fB\f(CBPs = 1021\fB\fR (\fBrxvt\fR)" 4
1753.IX Item "Ps = 1021 (rxvt)"
1754.TS
1755l l .
1756h Bold/italic implies high intensity (see option -is)
1757l Font styles have no effect on intensity (Compile styles)
1677.TE 1758.TE
1678 1759
1679.ie n .IP "\fB\fB""Ps = 1047""\fB\fR" 4 1760.ie n .IP "\fB\fB""Ps = 1047""\fB\fR" 4
1680.el .IP "\fB\f(CBPs = 1047\fB\fR" 4 1761.el .IP "\fB\f(CBPs = 1047\fB\fR" 4
1681.IX Item "Ps = 1047" 1762.IX Item "Ps = 1047"
… …
1728Ps = 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)
1729Ps = 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)
1730Ps = 12 Change colour of text cursor foreground to Pt 1811Ps = 12 Change colour of text cursor foreground to Pt
1731Ps = 13 Change colour of mouse foreground to Pt 1812Ps = 13 Change colour of mouse foreground to Pt
1732Ps = 17 Change colour of highlight characters to Pt 1813Ps = 17 Change colour of highlight characters to Pt
1733Ps = 18 Change colour of bold characters to Pt 1814Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1734Ps = 19 Change colour of underlined characters to Pt 1815Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1735Ps = 20 Change default background to Pt 1816Ps = 20 Change default background to Pt
1736Ps = 39 Change default foreground colour to Pt. 1817Ps = 39 Change default foreground colour to Pt.
1737Ps = 46 Change Log File to Pt unimplemented 1818Ps = 46 Change Log File to Pt unimplemented
1738Ps = 49 Change default background colour to Pt. 1819Ps = 49 Change default background colour to Pt.
1739Ps = 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
1740Ps = 55 Log all scrollback buffer and all of screen to Pt 1821Ps = 55 Log all scrollback buffer and all of screen to Pt
1741Ps = 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).
1742Ps = 703 Menubar command Pt (Compile menubar).
1743Ps = 704 Change colour of italic characters to Pt 1823Ps = 704 Change colour of italic characters to Pt
1744Ps = 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
1745Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1827Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1746Ps = 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).
1747Ps = 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).
1748Ps = 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).
1749Ps = 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).
1750Ps = 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).
1751.TE 1834.TE
1752 1835
1753.PP 1836.PP
1754 1837
1755.IX Xref "menuBar" 1838.IX Xref "XPM"
1756.SH "menuBar"
1757.IX Header "menuBar"
1758\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1759In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1760menuBar.
1761.PP
1762Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1763omitted: use \fB./\fR to specify a menu relative to the current menu.
1764.Sh "Overview of menuBar operation"
1765.IX Subsection "Overview of menuBar operation"
1766For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1767of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1768.PP
1769At the top level is the current menuBar which is a member of a circular
1770linked-list of other such menuBars.
1771.PP
1772The menuBar acts as a parent for the various drop-down menus, which in
1773turn, may have labels, separator lines, menuItems and subMenus.
1774.PP
1775The menuItems are the useful bits: you can use them to mimic keyboard
1776input or even to send text or escape sequences back to rxvt.
1777.PP
1778The menuBar syntax is intended to provide a simple yet robust method of
1779constructing and manipulating menus and navigating through the
1780menuBars.
1781.PP
1782The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1783the menuBar called \fIname\fR and allows access. You may now or menus,
1784subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1785menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1786menus. To re-access the current menuBar for alterations, use the tag
1787\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1788.PP
1789
1790.IX Xref "menuBarCommands"
1791.Sh "Commands"
1792.IX Subsection "Commands"
1793.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1794.IX Item "[menu:+name]"
1795access the named menuBar for creation or alteration. If a new menuBar
1796is created, it is called \fIname\fR (max of 15 chars) and the current
1797menuBar is pushed onto the stack
1798.IP "\fB[menu]\fR" 4
1799.IX Item "[menu]"
1800access the current menuBar for alteration
1801.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1802.IX Item "[title:+string]"
1803set the current menuBar's title to \fIstring\fR, which may contain the
1804following format specifiers:
1805.Sp
1806.Vb 3
1807\& B<%n> rxvt name (as per the B<-name> command-line option)
1808\& B<%v> rxvt version
1809\& B<%%> literal B<%> character
1810.Ve
1811.IP "\fB[done]\fR" 4
1812.IX Item "[done]"
1813set menuBar access as \fBreadonly\fR.
1814End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1815.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1816.IX Item "[read:+file]"
1817read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1818appended 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.
1819.Sp
1820Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1821since any invalid menu commands are also ignored, almost anything could
1822be construed as a comment line, but this may be tightened up in the
1823future ... so don't count on it!.
1824.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1825.IX Item "[read:+file;+name]"
1826The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1827\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1828\&\fB[done]\fR is encountered.
1829.IP "\fB[dump]\fR" 4
1830.IX Item "[dump]"
1831dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1832later rereading.
1833.IP "\fB[rm:name]\fR" 4
1834.IX Item "[rm:name]"
1835remove the named menuBar
1836.IP "\fB[rm] [rm:]\fR" 4
1837.IX Item "[rm] [rm:]"
1838remove the current menuBar
1839.IP "\fB[rm*] [rm:*]\fR" 4
1840.IX Item "[rm*] [rm:*]"
1841remove all menuBars
1842.IP "\fB[swap]\fR" 4
1843.IX Item "[swap]"
1844swap the top two menuBars
1845.IP "\fB[prev]\fR" 4
1846.IX Item "[prev]"
1847access the previous menuBar
1848.IP "\fB[next]\fR" 4
1849.IX Item "[next]"
1850access the next menuBar
1851.IP "\fB[show]\fR" 4
1852.IX Item "[show]"
1853Enable display of the menuBar
1854.IP "\fB[hide]\fR" 4
1855.IX Item "[hide]"
1856Disable display of the menuBar
1857.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1858.IX Item "[pixmap:+name]"
1859.PD 0
1860.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1861.IX Item "[pixmap:+name;scaling]"
1862.PD
1863(set the background pixmap globally
1864.Sp
1865\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1866.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1867.IX Item "[:+command:]"
1868ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1869menuitem or change the ; a useful shortcut for setting the quick arrows
1870from a menuBar.
1871.PP
1872
1873.IX Xref "menuBarAdd"
1874.Sh "Adding and accessing menus"
1875.IX Subsection "Adding and accessing menus"
1876The following commands may also be \fB+\fR prefixed.
1877.IP "\fB/+\fR" 4
1878.IX Item "/+"
1879access menuBar top level
1880.IP "\fB./+\fR" 4
1881.IX Item "./+"
1882access current menu level
1883.IP "\fB../+\fR" 4
1884.IX Item "../+"
1885access parent menu (1 level up)
1886.IP "\fB../../\fR" 4
1887.IX Item "../../"
1888access parent menu (multiple levels up)
1889.IP "\fB\f(BI/path/\fBmenu\fR" 4
1890.IX Item "/path/menu"
1891add/access menu
1892.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1893.IX Item "/path/menu/*"
1894add/access menu and clear it if it exists
1895.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1896.IX Item "/path/{-}"
1897add separator
1898.IP "\fB\f(BI/path/\fB{item}\fR" 4
1899.IX Item "/path/{item}"
1900add \fBitem\fR as a label
1901.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1902.IX Item "/path/{item} action"
1903add/alter \fImenuitem\fR with an associated \fIaction\fR
1904.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1905.IX Item "/path/{item}{right-text}"
1906add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1907and as the associated \fIaction\fR
1908.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1909.IX Item "/path/{item}{rtext} action"
1910add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
1911the right-justified text.
1912.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
1913.IX Item "Special characters in action must be backslash-escaped:"
1914\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
1915.IP "or in control-character notation:" 4
1916.IX Item "or in control-character notation:"
1917\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
1918.PP
1919To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
1920program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
1921the first of which will be stripped off and the balance directed to the
1922program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
1923non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
1924balance is sent back to rxvt.
1925.PP
1926As a convenience for the many Emacs-type editors, \fIaction\fR may start
1927with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
1928appended if missed from \fBM\-x\fR commands.
1929.PP
1930As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
1931quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
1932.IP "For example," 4
1933.IX Item "For example,"
1934\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
1935.IP "and" 4
1936.IX Item "and"
1937\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
1938.PP
1939The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
1940absence of a specified action, this text will be used as the \fIaction\fR
1941as well.
1942.IP "For example," 4
1943.IX Item "For example,"
1944\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
1945.PP
1946The left label \fIis\fR necessary, since it's used for matching, but
1947implicitly hiding the left label (by using same name for both left and
1948right labels), or explicitly hiding the left label (by preceeding it
1949with a dot), makes it possible to have right-justified text only.
1950.IP "For example," 4
1951.IX Item "For example,"
1952\&\fB/File/{Open}{Open} Open-File-Action\fR
1953.IP "or hiding it" 4
1954.IX Item "or hiding it"
1955\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
1956.PP
1957
1958.IX Xref "menuBarRemove"
1959.Sh "Removing menus"
1960.IX Subsection "Removing menus"
1961.IP "\fB\-/*+\fR" 4
1962.IX Item "-/*+"
1963remove all menus from the menuBar, the same as \fB[clear]\fR
1964.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
1965.IX Item "-+/pathmenu+"
1966remove menu
1967.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
1968.IX Item "-+/path{item}+"
1969remove item
1970.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
1971.IX Item "-+/path{-}"
1972remove separator)
1973.IP "\fB\-/path/menu/*\fR" 4
1974.IX Item "-/path/menu/*"
1975remove all items, separators and submenus from menu
1976.PP
1977
1978.IX Xref "menuBarArrows"
1979.Sh "Quick Arrows"
1980.IX Subsection "Quick Arrows"
1981The menus also provide a hook for \fIquick arrows\fR to provide easier
1982user access. If nothing has been explicitly set, the default is to
1983emulate the curror keys. The syntax permits each arrow to be altered
1984individually or all four at once without re-entering their common
1985beginning/end text. For example, to explicitly associate cursor actions
1986with the arrows, any of the following forms could be used:
1987.IP "\fB<r>+\f(BIRight\fB\fR" 4
1988.IX Item "<r>+Right"
1989.PD 0
1990.IP "\fB<l>+\f(BILeft\fB\fR" 4
1991.IX Item "<l>+Left"
1992.IP "\fB<u>+\f(BIUp\fB\fR" 4
1993.IX Item "<u>+Up"
1994.IP "\fB<d>+\f(BIDown\fB\fR" 4
1995.IX Item "<d>+Down"
1996.PD
1997Define actions for the respective arrow buttons
1998.IP "\fB<b>+\f(BIBegin\fB\fR" 4
1999.IX Item "<b>+Begin"
2000.PD 0
2001.IP "\fB<e>+\f(BIEnd\fB\fR" 4
2002.IX Item "<e>+End"
2003.PD
2004Define common beginning/end parts for \fIquick arrows\fR which used in
2005conjunction with the above <r> <l> <u> <d> constructs
2006.IP "For example, define arrows individually," 4
2007.IX Item "For example, define arrows individually,"
2008.Vb 1
2009\& <u>\eE[A
2010.Ve
2011.Sp
2012.Vb 1
2013\& <d>\eE[B
2014.Ve
2015.Sp
2016.Vb 1
2017\& <r>\eE[C
2018.Ve
2019.Sp
2020.Vb 1
2021\& <l>\eE[D
2022.Ve
2023.IP "or all at once" 4
2024.IX Item "or all at once"
2025.Vb 1
2026\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
2027.Ve
2028.IP "or more compactly (factoring out common parts)" 4
2029.IX Item "or more compactly (factoring out common parts)"
2030.Vb 1
2031\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
2032.Ve
2033.PP
2034
2035.IX Xref "menuBarSummary"
2036.Sh "Command Summary"
2037.IX Subsection "Command Summary"
2038A short summary of the most \fIcommon\fR commands:
2039.IP "[menu:name]" 4
2040.IX Item "[menu:name]"
2041use an existing named menuBar or start a new one
2042.IP "[menu]" 4
2043.IX Item "[menu]"
2044use the current menuBar
2045.IP "[title:string]" 4
2046.IX Item "[title:string]"
2047set menuBar title
2048.IP "[done]" 4
2049.IX Item "[done]"
2050set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
2051.IP "[done:name]" 4
2052.IX Item "[done:name]"
2053if reading from a file using [read:file;name] signal \s-1EOF\s0
2054.IP "[rm:name]" 4
2055.IX Item "[rm:name]"
2056remove named menuBar(s)
2057.IP "[rm] [rm:]" 4
2058.IX Item "[rm] [rm:]"
2059remove current menuBar
2060.IP "[rm*] [rm:*]" 4
2061.IX Item "[rm*] [rm:*]"
2062remove all menuBar(s)
2063.IP "[swap]" 4
2064.IX Item "[swap]"
2065swap top two menuBars
2066.IP "[prev]" 4
2067.IX Item "[prev]"
2068access the previous menuBar
2069.IP "[next]" 4
2070.IX Item "[next]"
2071access the next menuBar
2072.IP "[show]" 4
2073.IX Item "[show]"
2074map menuBar
2075.IP "[hide]" 4
2076.IX Item "[hide]"
2077unmap menuBar
2078.IP "[pixmap;file]" 4
2079.IX Item "[pixmap;file]"
2080.PD 0
2081.IP "[pixmap;file;scaling]" 4
2082.IX Item "[pixmap;file;scaling]"
2083.PD
2084set a background pixmap
2085.IP "[read:file]" 4
2086.IX Item "[read:file]"
2087.PD 0
2088.IP "[read:file;name]" 4
2089.IX Item "[read:file;name]"
2090.PD
2091read in a menu from a file
2092.IP "[dump]" 4
2093.IX Item "[dump]"
2094dump out all menuBars to /tmp/rxvt\-PID
2095.IP "/" 4
2096access menuBar top level
2097.IP "./" 4
2098.PD 0
2099.IP "../" 4
2100.IP "../../" 4
2101.PD
2102access current or parent menu level
2103.IP "/path/menu" 4
2104.IX Item "/path/menu"
2105add/access menu
2106.IP "/path/{\-}" 4
2107.IX Item "/path/{-}"
2108add separator
2109.IP "/path/{item}{rtext} action" 4
2110.IX Item "/path/{item}{rtext} action"
2111add/alter menu item
2112.IP "\-/*" 4
2113remove all menus from the menuBar
2114.IP "\-/path/menu" 4
2115.IX Item "-/path/menu"
2116remove menu items, separators and submenus from menu
2117.IP "\-/path/menu" 4
2118.IX Item "-/path/menu"
2119remove menu
2120.IP "\-/path/{item}" 4
2121.IX Item "-/path/{item}"
2122remove item
2123.IP "\-/path/{\-}" 4
2124.IX Item "-/path/{-}"
2125remove separator
2126.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2127.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2128menu quick arrows
2129.SH "XPM" 1839.SH "XPM"
2130.IX Header "XPM" 1840.IX Header "XPM"
2131For 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
2132of \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
2133sequence of scaling/positioning commands separated by semi\-colons. The 1843sequence of scaling/positioning commands separated by semi\-colons. The
… …
2390.IP "\-\-enable\-lastlog (default: on)" 4 2100.IP "\-\-enable\-lastlog (default: on)" 4
2391.IX Item "--enable-lastlog (default: on)" 2101.IX Item "--enable-lastlog (default: on)"
2392Write user and tty to lastlog file (used by programs like 2102Write user and tty to lastlog file (used by programs like
2393\&\fIlastlogin\fR) at start of rxvt execution. This option requires 2103\&\fIlastlogin\fR) at start of rxvt execution. This option requires
2394\&\-\-enable\-utmp to also be specified. 2104\&\-\-enable\-utmp to also be specified.
2395.IP "\-\-enable\-xpm\-background (default: off)" 4 2105.IP "\-\-enable\-xpm\-background (default: on)" 4
2396.IX Item "--enable-xpm-background (default: off)" 2106.IX Item "--enable-xpm-background (default: on)"
2397Add support for \s-1XPM\s0 background pixmaps. 2107Add support for \s-1XPM\s0 background pixmaps.
2398.IP "\-\-enable\-transparency (default: off)" 4 2108.IP "\-\-enable\-transparency (default: on)" 4
2399.IX Item "--enable-transparency (default: off)" 2109.IX Item "--enable-transparency (default: on)"
2400Add support for inheriting parent backgrounds thus giving a fake 2110Add support for inheriting parent backgrounds thus giving a fake
2401transparency to the term. 2111transparency to the term.
2402.IP "\-\-enable\-fading (default: on)" 4 2112.IP "\-\-enable\-fading (default: on)" 4
2403.IX Item "--enable-fading (default: on)" 2113.IX Item "--enable-fading (default: on)"
2404Add 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).
2405.IP "\-\-enable\-tinting (default: on)" 4 2115.IP "\-\-enable\-tinting (default: on)" 4
2406.IX Item "--enable-tinting (default: on)" 2116.IX Item "--enable-tinting (default: on)"
2407Add 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).
2408.IP "\-\-enable\-menubar (default: off)" 4
2409.IX Item "--enable-menubar (default: off)"
2410Add support for our menu bar system (this interacts badly with
2411dynamic locale switching currently).
2412.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2118.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2413.IX Item "--enable-rxvt-scroll (default: on)" 2119.IX Item "--enable-rxvt-scroll (default: on)"
2414Add support for the original rxvt scrollbar. 2120Add support for the original rxvt scrollbar.
2415.IP "\-\-enable\-next\-scroll (default: on)" 4 2121.IP "\-\-enable\-next\-scroll (default: on)" 4
2416.IX Item "--enable-next-scroll (default: on)" 2122.IX Item "--enable-next-scroll (default: on)"
… …
2439Removes 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
2440do it. 2146do it.
2441.IP "\-\-disable\-resources" 4 2147.IP "\-\-disable\-resources" 4
2442.IX Item "--disable-resources" 2148.IX Item "--disable-resources"
2443Removes any support for resource checking. 2149Removes any support for resource checking.
2444.IP "\-\-enable\-xgetdefault" 4
2445.IX Item "--enable-xgetdefault"
2446Make resources checking via \fIXGetDefault()\fR instead of our small
2447version which only checks ~/.Xdefaults, or if that doesn't exist then
2448~/.Xresources.
2449.Sp
2450Please note that nowadays, things like \s-1XIM\s0 will automatically pull in and
2451use the full X resource manager, so the overhead of using it might be very
2452small, if nonexistant.
2453.IP "\-\-enable\-strings (default: off)" 4
2454.IX Item "--enable-strings (default: off)"
2455Add support for our possibly faster \fImemset()\fR function and other
2456various routines, overriding your system's versions which may
2457have been hand-crafted in assembly or may require extra libraries
2458to link in. (this breaks ANSI-C rules and has problems on many
2459GNU/Linux systems).
2460.IP "\-\-disable\-swapscreen" 4 2150.IP "\-\-disable\-swapscreen" 4
2461.IX Item "--disable-swapscreen" 2151.IX Item "--disable-swapscreen"
2462Remove support for secondary/swap screen. 2152Remove support for secondary/swap screen.
2463.IP "\-\-enable\-frills (default: on)" 4 2153.IP "\-\-enable\-frills (default: on)" 4
2464.IX Item "--enable-frills (default: on)" 2154.IX Item "--enable-frills (default: on)"
… …
2467disable this. 2157disable this.
2468.Sp 2158.Sp
2469A 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
2470in combination with other switches) is: 2160in combination with other switches) is:
2471.Sp 2161.Sp
2472.Vb 13 2162.Vb 17
2473\& MWM-hints 2163\& MWM-hints
2474\& EWMH-hints (pid, utf8 names) and protocols (ping) 2164\& EWMH-hints (pid, utf8 names) and protocols (ping)
2475\& seperate underline colour 2165\& seperate underline colour (-underlineColor)
2476\& settable border widths and borderless switch 2166\& settable border widths and borderless switch (-w, -b, -bl)
2477\& settable extra linespacing 2167\& settable extra linespacing /-lsp)
2478\& iso-14755-2 and -3, and visual feedback 2168\& iso-14755-2 and -3, and visual feedback
2479\& backindex and forwardindex escape sequence 2169\& backindex and forwardindex escape sequence
2480\& window op and some xterm/OSC escape sequences 2170\& window op and some xterm/OSC escape sequences
2481\& tripleclickwords 2171\& tripleclickwords (-tcw)
2482\& settable insecure mode 2172\& settable insecure mode (-insecure)
2483\& keysym remapping support 2173\& keysym remapping support
2484\& cursor blinking and underline cursor 2174\& cursor blinking and underline cursor (-cb, -uc)
2485\& -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
2486.Ve 2180.Ve
2487.IP "\-\-enable\-iso14755 (default: on)" 4 2181.IP "\-\-enable\-iso14755 (default: on)" 4
2488.IX Item "--enable-iso14755 (default: on)" 2182.IX Item "--enable-iso14755 (default: on)"
2489Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or 2183Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
2490\&\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
… …
2524keys. 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
2525the screen in a fixed position. 2219the screen in a fixed position.
2526.IP "\-\-enable\-pointer\-blank (default: on)" 4 2220.IP "\-\-enable\-pointer\-blank (default: on)" 4
2527.IX Item "--enable-pointer-blank (default: on)" 2221.IX Item "--enable-pointer-blank (default: on)"
2528Add 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.
2529.IP "\-\-with\-name=NAME (default: urxvt)" 4 2230.IP "\-\-with\-name=NAME (default: urxvt)" 4
2530.IX Item "--with-name=NAME (default: urxvt)" 2231.IX Item "--with-name=NAME (default: urxvt)"
2531Set the basename for the installed binaries, resulting 2232Set the basename for the installed binaries, resulting
2532in \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
2533\&\f(CW\*(C`rxvt\*(C'\fR. 2234\&\f(CW\*(C`rxvt\*(C'\fR.

Diff Legend

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