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.42 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.49 by root, Tue Jan 17 16:22:41 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-12" "7.0" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-17" "7.1" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134RXVT REFERENCE \- FAQ, command sequences and other background information 134RXVT REFERENCE \- FAQ, command sequences and other background information
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 2 137.Vb 2
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.
161.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4 181.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4
162.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 182.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?"
163You can disable the perl extension completely by setting the 183You can disable the perl extension completely by setting the
164\&\fBperl-ext-common\fR resource to the empty string, which also keeps 184\&\fBperl-ext-common\fR resource to the empty string, which also keeps
165rxvt-unicode from initialising perl, saving memory. 185rxvt-unicode from initialising perl, saving memory.
312one 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
313\&\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
314encodings built-in that increase download times and are rarely used). 334encodings built-in that increase download times and are rarely used).
315.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
316.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?"
317Likely 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
318bad at it, I think it is simply unreasonable to expect all of freetype 338install urxvt with privileges necessary for your \s-1OS\s0 now.
319+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
320secure. Also, rxvt-unicode disables some options when it detects that it
321runs setuid or setgid, which is not nice. Besides, with the embedded perl
322interpreter the possibility for security problems easily multiplies.
323.Sp 339.Sp
324Elevated privileges are only required for utmp and pty operations on some 340When rxvt-unicode detects that it runs setuid or setgid, it will fork
325systems (for example, GNU/Linux doesn't need any extra privileges for 341into a helper process for privileged operations (pty handling on some
326ptys, but some need it for utmp support). It is planned to mvoe this into 342systems, utmp/wtmp/lastlog handling on others) and drop privileges
327a 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).
328.Sp 346.Sp
329So, 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
330typical single-user-no-other-logins unix desktop, always remember that 348and reduces possible bugs to initialisation code run before \fImain()\fR, or
331its 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
332regularly. 350little risk.
333.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
334.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?"
335The terminal description used by rxvt-unicode is not as widely available 353The terminal description used by rxvt-unicode is not as widely available
336as 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).
337.Sp 355.Sp
755.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?"
756You 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
757terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR: 775terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
758.Sp 776.Sp
759.Vb 1 777.Vb 1
760\& URxvt*imlocale: ja_JP.EUC-JP 778\& URxvt.imlocale: ja_JP.EUC-JP
761.Ve 779.Ve
762.Sp 780.Sp
763Now 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
764use 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
765input 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
807.IX Item "Mouse cut/paste suddenly no longer works." 825.IX Item "Mouse cut/paste suddenly no longer works."
808Make sure that mouse reporting is actually turned off since killing 826Make sure that mouse reporting is actually turned off since killing
809some 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
810heard that tcsh may use mouse reporting unless it otherwise specified. A 828heard that tcsh may use mouse reporting unless it otherwise specified. A
811quick 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
812depressed. See @@RXVT_NAME@@(7) 830depressed.
813.IP "What's with this bold/blink stuff?" 4 831.IP "What's with this bold/blink stuff?" 4
814.IX Item "What's with this bold/blink stuff?" 832.IX Item "What's with this bold/blink stuff?"
815If 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
816standard foreground colour. 834standard foreground colour.
817.Sp 835.Sp
912\& # use Backspace = ^? 930\& # use Backspace = ^?
913\& $ stty erase ^? 931\& $ stty erase ^?
914\& $ @@RXVT_NAME@@ 932\& $ @@RXVT_NAME@@
915.Ve 933.Ve
916.Sp 934.Sp
917Toggle 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.
918.Sp 936.Sp
919For an existing rxvt\-unicode: 937For an existing rxvt\-unicode:
920.Sp 938.Sp
921.Vb 3 939.Vb 3
922\& # use Backspace = ^H 940\& # use Backspace = ^H
1038.IX Header "RXVT TECHNICAL REFERENCE" 1056.IX Header "RXVT TECHNICAL REFERENCE"
1039.SH "DESCRIPTION" 1057.SH "DESCRIPTION"
1040.IX Header "DESCRIPTION" 1058.IX Header "DESCRIPTION"
1041The rest of this document describes various technical aspects of 1059The rest of this document describes various technical aspects of
1042\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1060\&\fBrxvt-unicode\fR. First the description of supported command sequences,
1043followed by menu and pixmap support and last by a description of all 1061followed by pixmap support and last by a description of all features
1044features selectable at \f(CW\*(C`configure\*(C'\fR time. 1062selectable at \f(CW\*(C`configure\*(C'\fR time.
1045.SH "Definitions" 1063.SH "Definitions"
1046.IX Header "Definitions" 1064.IX Header "Definitions"
1047.ie n .IP "\fB\fB""c""\fB\fR" 4 1065.ie n .IP "\fB\fB""c""\fB\fR" 4
1048.el .IP "\fB\f(CBc\fB\fR" 4 1066.el .IP "\fB\f(CBc\fB\fR" 4
1049.IX Item "c" 1067.IX Item "c"
1596l l . 1614l l .
1597h Send Mouse X & Y on button press. 1615h Send Mouse X & Y on button press.
1598l No mouse reporting. 1616l No mouse reporting.
1599.TE 1617.TE
1600 1618
1601.ie n .IP "\fB\fB""Ps = 10""\fB\fR (\fBrxvt\fR)" 4
1602.el .IP "\fB\f(CBPs = 10\fB\fR (\fBrxvt\fR)" 4
1603.IX Item "Ps = 10 (rxvt)"
1604.TS
1605l l .
1606h menuBar visible
1607l menuBar invisible
1608.TE
1609
1610.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 1619.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4
1611.el .IP "\fB\f(CBPs = 25\fB\fR" 4 1620.el .IP "\fB\f(CBPs = 25\fB\fR" 4
1612.IX Item "Ps = 25" 1621.IX Item "Ps = 25"
1613.TS 1622.TS
1614l l . 1623l l .
1807Ps = 46 Change Log File to Pt unimplemented 1816Ps = 46 Change Log File to Pt unimplemented
1808Ps = 49 Change default background colour to Pt. 1817Ps = 49 Change default background colour to Pt.
1809Ps = 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
1810Ps = 55 Log all scrollback buffer and all of screen to Pt 1819Ps = 55 Log all scrollback buffer and all of screen to Pt
1811Ps = 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).
1812Ps = 703 Menubar command Pt (Compile menubar).
1813Ps = 704 Change colour of italic characters to Pt 1821Ps = 704 Change colour of italic characters to Pt
1814Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1822Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1815Ps = 706 Change colour of bold characters to Pt 1823Ps = 706 Change colour of bold characters to Pt
1816Ps = 707 Change colour of underlined characters to Pt 1824Ps = 707 Change colour of underlined characters to Pt
1817Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1825Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1823Ps = 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).
1824.TE 1832.TE
1825 1833
1826.PP 1834.PP
1827 1835
1828.IX Xref "menuBar" 1836.IX Xref "XPM"
1829.SH "menuBar"
1830.IX Header "menuBar"
1831\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1832In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1833menuBar.
1834.PP
1835Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1836omitted: use \fB./\fR to specify a menu relative to the current menu.
1837.Sh "Overview of menuBar operation"
1838.IX Subsection "Overview of menuBar operation"
1839For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1840of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1841.PP
1842At the top level is the current menuBar which is a member of a circular
1843linked-list of other such menuBars.
1844.PP
1845The menuBar acts as a parent for the various drop-down menus, which in
1846turn, may have labels, separator lines, menuItems and subMenus.
1847.PP
1848The menuItems are the useful bits: you can use them to mimic keyboard
1849input or even to send text or escape sequences back to rxvt.
1850.PP
1851The menuBar syntax is intended to provide a simple yet robust method of
1852constructing and manipulating menus and navigating through the
1853menuBars.
1854.PP
1855The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1856the menuBar called \fIname\fR and allows access. You may now or menus,
1857subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1858menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1859menus. To re-access the current menuBar for alterations, use the tag
1860\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1861.PP
1862
1863.IX Xref "menuBarCommands"
1864.Sh "Commands"
1865.IX Subsection "Commands"
1866.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1867.IX Item "[menu:+name]"
1868access the named menuBar for creation or alteration. If a new menuBar
1869is created, it is called \fIname\fR (max of 15 chars) and the current
1870menuBar is pushed onto the stack
1871.IP "\fB[menu]\fR" 4
1872.IX Item "[menu]"
1873access the current menuBar for alteration
1874.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1875.IX Item "[title:+string]"
1876set the current menuBar's title to \fIstring\fR, which may contain the
1877following format specifiers:
1878.Sp
1879.Vb 3
1880\& B<%n> rxvt name (as per the B<-name> command-line option)
1881\& B<%v> rxvt version
1882\& B<%%> literal B<%> character
1883.Ve
1884.IP "\fB[done]\fR" 4
1885.IX Item "[done]"
1886set menuBar access as \fBreadonly\fR.
1887End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1888.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1889.IX Item "[read:+file]"
1890read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1891appended 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.
1892.Sp
1893Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1894since any invalid menu commands are also ignored, almost anything could
1895be construed as a comment line, but this may be tightened up in the
1896future ... so don't count on it!.
1897.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1898.IX Item "[read:+file;+name]"
1899The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1900\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1901\&\fB[done]\fR is encountered.
1902.IP "\fB[dump]\fR" 4
1903.IX Item "[dump]"
1904dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1905later rereading.
1906.IP "\fB[rm:name]\fR" 4
1907.IX Item "[rm:name]"
1908remove the named menuBar
1909.IP "\fB[rm] [rm:]\fR" 4
1910.IX Item "[rm] [rm:]"
1911remove the current menuBar
1912.IP "\fB[rm*] [rm:*]\fR" 4
1913.IX Item "[rm*] [rm:*]"
1914remove all menuBars
1915.IP "\fB[swap]\fR" 4
1916.IX Item "[swap]"
1917swap the top two menuBars
1918.IP "\fB[prev]\fR" 4
1919.IX Item "[prev]"
1920access the previous menuBar
1921.IP "\fB[next]\fR" 4
1922.IX Item "[next]"
1923access the next menuBar
1924.IP "\fB[show]\fR" 4
1925.IX Item "[show]"
1926Enable display of the menuBar
1927.IP "\fB[hide]\fR" 4
1928.IX Item "[hide]"
1929Disable display of the menuBar
1930.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1931.IX Item "[pixmap:+name]"
1932.PD 0
1933.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1934.IX Item "[pixmap:+name;scaling]"
1935.PD
1936(set the background pixmap globally
1937.Sp
1938\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1939.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1940.IX Item "[:+command:]"
1941ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1942menuitem or change the ; a useful shortcut for setting the quick arrows
1943from a menuBar.
1944.PP
1945
1946.IX Xref "menuBarAdd"
1947.Sh "Adding and accessing menus"
1948.IX Subsection "Adding and accessing menus"
1949The following commands may also be \fB+\fR prefixed.
1950.IP "\fB/+\fR" 4
1951.IX Item "/+"
1952access menuBar top level
1953.IP "\fB./+\fR" 4
1954.IX Item "./+"
1955access current menu level
1956.IP "\fB../+\fR" 4
1957.IX Item "../+"
1958access parent menu (1 level up)
1959.IP "\fB../../\fR" 4
1960.IX Item "../../"
1961access parent menu (multiple levels up)
1962.IP "\fB\f(BI/path/\fBmenu\fR" 4
1963.IX Item "/path/menu"
1964add/access menu
1965.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1966.IX Item "/path/menu/*"
1967add/access menu and clear it if it exists
1968.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1969.IX Item "/path/{-}"
1970add separator
1971.IP "\fB\f(BI/path/\fB{item}\fR" 4
1972.IX Item "/path/{item}"
1973add \fBitem\fR as a label
1974.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1975.IX Item "/path/{item} action"
1976add/alter \fImenuitem\fR with an associated \fIaction\fR
1977.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1978.IX Item "/path/{item}{right-text}"
1979add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1980and as the associated \fIaction\fR
1981.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1982.IX Item "/path/{item}{rtext} action"
1983add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
1984the right-justified text.
1985.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
1986.IX Item "Special characters in action must be backslash-escaped:"
1987\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
1988.IP "or in control-character notation:" 4
1989.IX Item "or in control-character notation:"
1990\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
1991.PP
1992To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
1993program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
1994the first of which will be stripped off and the balance directed to the
1995program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
1996non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
1997balance is sent back to rxvt.
1998.PP
1999As a convenience for the many Emacs-type editors, \fIaction\fR may start
2000with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
2001appended if missed from \fBM\-x\fR commands.
2002.PP
2003As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
2004quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
2005.IP "For example," 4
2006.IX Item "For example,"
2007\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
2008.IP "and" 4
2009.IX Item "and"
2010\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
2011.PP
2012The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
2013absence of a specified action, this text will be used as the \fIaction\fR
2014as well.
2015.IP "For example," 4
2016.IX Item "For example,"
2017\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
2018.PP
2019The left label \fIis\fR necessary, since it's used for matching, but
2020implicitly hiding the left label (by using same name for both left and
2021right labels), or explicitly hiding the left label (by preceeding it
2022with a dot), makes it possible to have right-justified text only.
2023.IP "For example," 4
2024.IX Item "For example,"
2025\&\fB/File/{Open}{Open} Open-File-Action\fR
2026.IP "or hiding it" 4
2027.IX Item "or hiding it"
2028\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
2029.PP
2030
2031.IX Xref "menuBarRemove"
2032.Sh "Removing menus"
2033.IX Subsection "Removing menus"
2034.IP "\fB\-/*+\fR" 4
2035.IX Item "-/*+"
2036remove all menus from the menuBar, the same as \fB[clear]\fR
2037.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
2038.IX Item "-+/pathmenu+"
2039remove menu
2040.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
2041.IX Item "-+/path{item}+"
2042remove item
2043.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
2044.IX Item "-+/path{-}"
2045remove separator)
2046.IP "\fB\-/path/menu/*\fR" 4
2047.IX Item "-/path/menu/*"
2048remove all items, separators and submenus from menu
2049.PP
2050
2051.IX Xref "menuBarArrows"
2052.Sh "Quick Arrows"
2053.IX Subsection "Quick Arrows"
2054The menus also provide a hook for \fIquick arrows\fR to provide easier
2055user access. If nothing has been explicitly set, the default is to
2056emulate the curror keys. The syntax permits each arrow to be altered
2057individually or all four at once without re-entering their common
2058beginning/end text. For example, to explicitly associate cursor actions
2059with the arrows, any of the following forms could be used:
2060.IP "\fB<r>+\f(BIRight\fB\fR" 4
2061.IX Item "<r>+Right"
2062.PD 0
2063.IP "\fB<l>+\f(BILeft\fB\fR" 4
2064.IX Item "<l>+Left"
2065.IP "\fB<u>+\f(BIUp\fB\fR" 4
2066.IX Item "<u>+Up"
2067.IP "\fB<d>+\f(BIDown\fB\fR" 4
2068.IX Item "<d>+Down"
2069.PD
2070Define actions for the respective arrow buttons
2071.IP "\fB<b>+\f(BIBegin\fB\fR" 4
2072.IX Item "<b>+Begin"
2073.PD 0
2074.IP "\fB<e>+\f(BIEnd\fB\fR" 4
2075.IX Item "<e>+End"
2076.PD
2077Define common beginning/end parts for \fIquick arrows\fR which used in
2078conjunction with the above <r> <l> <u> <d> constructs
2079.IP "For example, define arrows individually," 4
2080.IX Item "For example, define arrows individually,"
2081.Vb 1
2082\& <u>\eE[A
2083.Ve
2084.Sp
2085.Vb 1
2086\& <d>\eE[B
2087.Ve
2088.Sp
2089.Vb 1
2090\& <r>\eE[C
2091.Ve
2092.Sp
2093.Vb 1
2094\& <l>\eE[D
2095.Ve
2096.IP "or all at once" 4
2097.IX Item "or all at once"
2098.Vb 1
2099\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
2100.Ve
2101.IP "or more compactly (factoring out common parts)" 4
2102.IX Item "or more compactly (factoring out common parts)"
2103.Vb 1
2104\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
2105.Ve
2106.PP
2107
2108.IX Xref "menuBarSummary"
2109.Sh "Command Summary"
2110.IX Subsection "Command Summary"
2111A short summary of the most \fIcommon\fR commands:
2112.IP "[menu:name]" 4
2113.IX Item "[menu:name]"
2114use an existing named menuBar or start a new one
2115.IP "[menu]" 4
2116.IX Item "[menu]"
2117use the current menuBar
2118.IP "[title:string]" 4
2119.IX Item "[title:string]"
2120set menuBar title
2121.IP "[done]" 4
2122.IX Item "[done]"
2123set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
2124.IP "[done:name]" 4
2125.IX Item "[done:name]"
2126if reading from a file using [read:file;name] signal \s-1EOF\s0
2127.IP "[rm:name]" 4
2128.IX Item "[rm:name]"
2129remove named menuBar(s)
2130.IP "[rm] [rm:]" 4
2131.IX Item "[rm] [rm:]"
2132remove current menuBar
2133.IP "[rm*] [rm:*]" 4
2134.IX Item "[rm*] [rm:*]"
2135remove all menuBar(s)
2136.IP "[swap]" 4
2137.IX Item "[swap]"
2138swap top two menuBars
2139.IP "[prev]" 4
2140.IX Item "[prev]"
2141access the previous menuBar
2142.IP "[next]" 4
2143.IX Item "[next]"
2144access the next menuBar
2145.IP "[show]" 4
2146.IX Item "[show]"
2147map menuBar
2148.IP "[hide]" 4
2149.IX Item "[hide]"
2150unmap menuBar
2151.IP "[pixmap;file]" 4
2152.IX Item "[pixmap;file]"
2153.PD 0
2154.IP "[pixmap;file;scaling]" 4
2155.IX Item "[pixmap;file;scaling]"
2156.PD
2157set a background pixmap
2158.IP "[read:file]" 4
2159.IX Item "[read:file]"
2160.PD 0
2161.IP "[read:file;name]" 4
2162.IX Item "[read:file;name]"
2163.PD
2164read in a menu from a file
2165.IP "[dump]" 4
2166.IX Item "[dump]"
2167dump out all menuBars to /tmp/rxvt\-PID
2168.IP "/" 4
2169access menuBar top level
2170.IP "./" 4
2171.PD 0
2172.IP "../" 4
2173.IP "../../" 4
2174.PD
2175access current or parent menu level
2176.IP "/path/menu" 4
2177.IX Item "/path/menu"
2178add/access menu
2179.IP "/path/{\-}" 4
2180.IX Item "/path/{-}"
2181add separator
2182.IP "/path/{item}{rtext} action" 4
2183.IX Item "/path/{item}{rtext} action"
2184add/alter menu item
2185.IP "\-/*" 4
2186remove all menus from the menuBar
2187.IP "\-/path/menu" 4
2188.IX Item "-/path/menu"
2189remove menu items, separators and submenus from menu
2190.IP "\-/path/menu" 4
2191.IX Item "-/path/menu"
2192remove menu
2193.IP "\-/path/{item}" 4
2194.IX Item "-/path/{item}"
2195remove item
2196.IP "\-/path/{\-}" 4
2197.IX Item "-/path/{-}"
2198remove separator
2199.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2200.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2201menu quick arrows
2202.SH "XPM" 1837.SH "XPM"
2203.IX Header "XPM" 1838.IX Header "XPM"
2204For 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
2205of \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
2206sequence of scaling/positioning commands separated by semi\-colons. The 1841sequence of scaling/positioning commands separated by semi\-colons. The
2476.IX Item "--enable-fading (default: on)" 2111.IX Item "--enable-fading (default: on)"
2477Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2112Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2478.IP "\-\-enable\-tinting (default: on)" 4 2113.IP "\-\-enable\-tinting (default: on)" 4
2479.IX Item "--enable-tinting (default: on)" 2114.IX Item "--enable-tinting (default: on)"
2480Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2115Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2481.IP "\-\-enable\-menubar (default: off) [\s-1DEPRECATED\s0]" 4
2482.IX Item "--enable-menubar (default: off) [DEPRECATED]"
2483Add support for our menu bar system (this interacts badly with dynamic
2484locale switching currently). This option is \s-1DEPRECATED\s0 and will be removed
2485in the future.
2486.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2116.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2487.IX Item "--enable-rxvt-scroll (default: on)" 2117.IX Item "--enable-rxvt-scroll (default: on)"
2488Add support for the original rxvt scrollbar. 2118Add support for the original rxvt scrollbar.
2489.IP "\-\-enable\-next\-scroll (default: on)" 4 2119.IP "\-\-enable\-next\-scroll (default: on)" 4
2490.IX Item "--enable-next-scroll (default: on)" 2120.IX Item "--enable-next-scroll (default: on)"
2495.IP "\-\-enable\-plain\-scroll (default: on)" 4 2125.IP "\-\-enable\-plain\-scroll (default: on)" 4
2496.IX Item "--enable-plain-scroll (default: on)" 2126.IX Item "--enable-plain-scroll (default: on)"
2497Add support for a very unobtrusive, plain-looking scrollbar that 2127Add support for a very unobtrusive, plain-looking scrollbar that
2498is the favourite of the rxvt-unicode author, having used it for 2128is the favourite of the rxvt-unicode author, having used it for
2499many years. 2129many years.
2500.IP "\-\-enable\-half\-shadow (default: off)" 4
2501.IX Item "--enable-half-shadow (default: off)"
2502Make shadows on the scrollbar only half the normal width & height.
2503only applicable to rxvt scrollbars.
2504.IP "\-\-enable\-ttygid (default: off)" 4 2130.IP "\-\-enable\-ttygid (default: off)" 4
2505.IX Item "--enable-ttygid (default: off)" 2131.IX Item "--enable-ttygid (default: off)"
2506Change tty device setting to group \*(L"tty\*(R" \- only use this if 2132Change tty device setting to group \*(L"tty\*(R" \- only use this if
2507your system uses this type of security. 2133your system uses this type of security.
2508.IP "\-\-disable\-backspace\-key" 4 2134.IP "\-\-disable\-backspace\-key" 4
2513Removes any handling of the delete key by us \- let the X server 2139Removes any handling of the delete key by us \- let the X server
2514do it. 2140do it.
2515.IP "\-\-disable\-resources" 4 2141.IP "\-\-disable\-resources" 4
2516.IX Item "--disable-resources" 2142.IX Item "--disable-resources"
2517Removes any support for resource checking. 2143Removes any support for resource checking.
2518.IP "\-\-enable\-strings (default: off)" 4
2519.IX Item "--enable-strings (default: off)"
2520Add support for our possibly faster \fImemset()\fR function and other
2521various routines, overriding your system's versions which may
2522have been hand-crafted in assembly or may require extra libraries
2523to link in. (this breaks ANSI-C rules and has problems on many
2524GNU/Linux systems).
2525.IP "\-\-disable\-swapscreen" 4 2144.IP "\-\-disable\-swapscreen" 4
2526.IX Item "--disable-swapscreen" 2145.IX Item "--disable-swapscreen"
2527Remove support for secondary/swap screen. 2146Remove support for secondary/swap screen.
2528.IP "\-\-enable\-frills (default: on)" 4 2147.IP "\-\-enable\-frills (default: on)" 4
2529.IX Item "--enable-frills (default: on)" 2148.IX Item "--enable-frills (default: on)"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines