[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.7.pod

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.74 by root, Mon Jan 9 07:24:43 2006 UTC vs.
Revision 1.92 by root, Sat Jan 28 20:33:30 2006 UTC

…		…
23	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	23	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
24		24
25	=head1 FREQUENTLY ASKED QUESTIONS	25	=head1 FREQUENTLY ASKED QUESTIONS
26		26
27	=over 4	27	=over 4
		28
		29	=item The new selection selects pieces that are too big, how can I select
		30	single words?
		31
		32	Yes. For example, if you want to select alphanumeric words, you can use
		33	the following resource:
		34
		35	URxvt.selection.pattern-0: ([[:word:]]+)
		36
		37	If you click more than twice, the selection will be extended
		38	more and more.
		39
		40	To get a selection that is very similar to the old code, try this pattern:
		41
		42	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{\|})]+)
		43
		44	Please also note that the I<LeftClick Shift-LeftClik> combination also
		45	selects words like the old code.
		46
		47	=item I don't like the new selection/popups/hotkeys/perl, how do I
		48	change/disable it?
		49
		50	You can disable the perl extension completely by setting the
		51	B<perl-ext-common> resource to the empty string, which also keeps
		52	rxvt-unicode from initialising perl, saving memory.
		53
		54	If you only want to disable specific features, you first have to
		55	identify which perl extension is responsible. For this, read the section
		56	B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
		57	example, to disable the B<selection-popup> and B<option-popup>, specify
		58	this B<perl-ext-common> resource:
		59
		60	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		61
		62	This will keep the default extensions, but disable the two popup
		63	extensions. Some extensions can also be configured, for example,
		64	scrollback search mode is triggered by B<M-s>. You can move it to any
		65	other combination either by setting the B<searchable-scrollback> resource:
		66
		67	URxvt.searchable-scrollback: CM-s
28		68
29	=item Isn't rxvt supposed to be small? Don't all those features bloat?	69	=item Isn't rxvt supposed to be small? Don't all those features bloat?
30		70
31	I often get asked about this, and I think, no, they didn't cause extra	71	I often get asked about this, and I think, no, they didn't cause extra
32	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see	72	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
…		…
102	No large bloated libraries (of course, none were linked in statically),	142	No large bloated libraries (of course, none were linked in statically),
103	except maybe libX11 :)	143	except maybe libX11 :)
104		144
105	=item Does it support tabs, can I have a tabbed rxvt-unicode?	145	=item Does it support tabs, can I have a tabbed rxvt-unicode?
106		146
107	rxvt-unicode does not directly support tabs. It will work fine with	147	Beginning with version 7.3, there is a perl extension that implements a
108	tabbing functionality of many window managers or similar tabbing programs,	148	simple tabbed terminal. It is installed by default, so any of these should
109	and its embedding-features allow it to be embedded into other programs,	149	give you tabs:
110	as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl	150
111	module, which features a tabbed urxvt (murxvt) terminal as an example	151	@@RXVT_NAME@@ -pe tabbed
112	embedding application.	152
		153	URxvt.perl-ext-common: default,tabbed
		154
		155	It will also work fine with tabbing functionality of many window managers
		156	or similar tabbing programs, and its embedding-features allow it to be
		157	embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
		158	the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
		159	(murxvt) terminal as an example embedding application.
113		160
114	=item How do I know which rxvt-unicode version I'm using?	161	=item How do I know which rxvt-unicode version I'm using?
115		162
116	The version number is displayed with the usage (-h). Also the escape	163	The version number is displayed with the usage (-h). Also the escape
117	sequence C<ESC [ 8 n> sets the window title to the version number. When	164	sequence C<ESC [ 8 n> sets the window title to the version number. When
…		…
119	daemon.	166	daemon.
120		167
121	=item I am using Debian GNU/Linux and have a problem...	168	=item I am using Debian GNU/Linux and have a problem...
122		169
123	The Debian GNU/Linux package of rxvt-unicode in sarge contains large	170	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
124	patches that considerably change the behaviour of rxvt-unicode. Before	171	patches that considerably change the behaviour of rxvt-unicode (but
125	reporting a bug to the original rxvt-unicode author please download and	172	unfortunately this notice has been removed). Before reporting a bug to
126	install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)	173	the original rxvt-unicode author please download and install the genuine
127	and try to reproduce the problem. If you cannot, chances are that the	174	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
128	problems are specific to Debian GNU/Linux, in which case it should be	175	the problem. If you cannot, chances are that the problems are specific to
129	reported via the Debian Bug Tracking System (use C<reportbug> to report	176	Debian GNU/Linux, in which case it should be reported via the Debian Bug
130	the bug).	177	Tracking System (use C<reportbug> to report the bug).
131		178
132	For other problems that also affect the Debian package, you can and	179	For other problems that also affect the Debian package, you can and
133	probably should use the Debian BTS, too, because, after all, it's also a	180	probably should use the Debian BTS, too, because, after all, it's also a
134	bug in the Debian version and it serves as a reminder for other users that	181	bug in the Debian version and it serves as a reminder for other users that
135	might encounter the same issue.	182	might encounter the same issue.
136		183
137	=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?	184	=item I am maintaining rxvt-unicode for distribution/OS XXX, any
		185	recommendation?
138		186
139	You should build one binary with the default options. F<configure>	187	You should build one binary with the default options. F<configure>
140	now enables most useful options, and the trend goes to making them	188	now enables most useful options, and the trend goes to making them
141	runtime-switchable, too, so there is usually no drawback to enbaling them,	189	runtime-switchable, too, so there is usually no drawback to enbaling them,
142	except higher disk and possibly memory usage. The perl interpreter should	190	except higher disk and possibly memory usage. The perl interpreter should
…		…
154	C<--enable-everything> (less useful, it will be very big due to a lot of	202	C<--enable-everything> (less useful, it will be very big due to a lot of
155	encodings built-in that increase download times and are rarely used).	203	encodings built-in that increase download times and are rarely used).
156		204
157	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?	205	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
158		206
159	Likely not. While I honestly try to make it secure, and am probably	207	It should be, starting with release 7.1. You are encouraged to properly
160	not bad at it, I think it is simply unreasonable to expect all of	208	install urxvt with privileges necessary for your OS now.
161	freetype + fontconfig + xft + xlib + ... + rxvt-unicode itself to all be
162	secure. Also, rxvt-unicode disables some options when it detects that it
163	runs setuid or setgid, which is not nice.
164		209
165	Elevated privileges are only required for utmp and pty operations on some	210	When rxvt-unicode detects that it runs setuid or setgid, it will fork
166	systems (for example, GNU/Linux doesn't need any extra privileges for	211	into a helper process for privileged operations (pty handling on some
167	ptys, but some need it for utmp support). If rxvt-unicode doesn't support	212	systems, utmp/wtmp/lastlog handling on others) and drop privileges
168	the library/setuid helper that your OS needs I'll be happy to assist you	213	immediately. This is much safer than most other terminals that keep
169	in implementing support for it.	214	privileges while running (but is more relevant to urxvt, as it contains
		215	things as perl interpreters, which might be "helpful" to attackers).
170		216
171	So, while setuid/setgid operation is supported and not a problem on your	217	This forking is done as the very first within main(), which is very early
172	typical single-user-no-other-logins unix desktop, always remember that	218	and reduces possible bugs to initialisation code run before main(), or
173	its an awful lot of code, most of which isn't checked for security issues	219	things like the dynamic loader of your system, which should result in very
174	regularly.	220	little risk.
175		221
176	=item When I log-in to another system it tells me about missing terminfo data?	222	=item When I log-in to another system it tells me about missing terminfo data?
177		223
178	The terminal description used by rxvt-unicode is not as widely available	224	The terminal description used by rxvt-unicode is not as widely available
179	as that for xterm, or even rxvt (for which the same problem often arises).	225	as that for xterm, or even rxvt (for which the same problem often arises).
…		…
576	=item My input method wants <some encoding> but I want UTF-8, what can I do?	622	=item My input method wants <some encoding> but I want UTF-8, what can I do?
577		623
578	You can specify separate locales for the input method and the rest of the	624	You can specify separate locales for the input method and the rest of the
579	terminal, using the resource C<imlocale>:	625	terminal, using the resource C<imlocale>:
580		626
581	URxvt*imlocale: ja_JP.EUC-JP	627	URxvt.imlocale: ja_JP.EUC-JP
582		628
583	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still	629	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
584	use your input method. Please note, however, that you will not be able to	630	use your input method. Please note, however, that you will not be able to
585	input characters outside C<EUC-JP> in a normal way then, as your input	631	input characters outside C<EUC-JP> in a normal way then, as your input
586	method limits you.	632	method limits you.
…		…
632		678
633	Make sure that mouse reporting is actually turned off since killing	679	Make sure that mouse reporting is actually turned off since killing
634	some editors prematurely may leave the mouse in mouse report mode. I've	680	some editors prematurely may leave the mouse in mouse report mode. I've
635	heard that tcsh may use mouse reporting unless it otherwise specified. A	681	heard that tcsh may use mouse reporting unless it otherwise specified. A
636	quick check is to see if cut/paste works when the Alt or Shift keys are	682	quick check is to see if cut/paste works when the Alt or Shift keys are
637	depressed. See @@RXVT_NAME@@(7)	683	depressed.
638		684
639	=item What's with this bold/blink stuff?	685	=item What's with this bold/blink stuff?
640		686
641	If no bold colour is set via C<colorBD:>, bold will invert text using the	687	If no bold colour is set via C<colorBD:>, bold will invert text using the
642	standard foreground colour.	688	standard foreground colour.
…		…
731		777
732	# use Backspace = ^?	778	# use Backspace = ^?
733	$ stty erase ^?	779	$ stty erase ^?
734	$ @@RXVT_NAME@@	780	$ @@RXVT_NAME@@
735		781
736	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).	782	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
737		783
738	For an existing rxvt-unicode:	784	For an existing rxvt-unicode:
739		785
740	# use Backspace = ^H	786	# use Backspace = ^H
741	$ stty erase ^H	787	$ stty erase ^H
…		…
859		905
860	=head1 DESCRIPTION	906	=head1 DESCRIPTION
861		907
862	The rest of this document describes various technical aspects of	908	The rest of this document describes various technical aspects of
863	B<rxvt-unicode>. First the description of supported command sequences,	909	B<rxvt-unicode>. First the description of supported command sequences,
864	followed by menu and pixmap support and last by a description of all	910	followed by pixmap support and last by a description of all features
865	features selectable at C<configure> time.	911	selectable at C<configure> time.
866		912
867	=head1 Definitions	913	=head1 Definitions
868		914
869	=over 4	915	=over 4
870		916
…		…
1438	B<< C<h> >> Send Mouse X & Y on button press.	1484	B<< C<h> >> Send Mouse X & Y on button press.
1439	B<< C<l> >> No mouse reporting.	1485	B<< C<l> >> No mouse reporting.
1440		1486
1441	=end table	1487	=end table
1442		1488
1443	=item B<< C<Ps = 10> >> (B<rxvt>)
1444
1445	=begin table
1446
1447	B<< C<h> >> menuBar visible
1448	B<< C<l> >> menuBar invisible
1449
1450	=end table
1451
1452	=item B<< C<Ps = 25> >>	1489	=item B<< C<Ps = 25> >>
1453		1490
1454	=begin table	1491	=begin table
1455		1492
1456	B<< C<h> >> Visible cursor {cnorm/cvvis}	1493	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1636	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1673	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1637	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	1674	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1638	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1675	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1639	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1676	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1640	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1677	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1641	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	1678	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1642	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	1679	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1643	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1680	B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1644	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.	1681	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1645	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1682	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1646	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.	1683	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1647	B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>	1684	B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1648	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	1685	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1649	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).	1686	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1650	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).	1687	B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1651	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	1688	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1652	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).	1689	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		1690	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		1691	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1653	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.	1692	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1654	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	1693	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1655	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	1694	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1656	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	1695	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1657	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).	1696	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
…		…
1660		1699
1661	=end table	1700	=end table
1662		1701
1663	=back	1702	=back
1664		1703
1665	X<menuBar>
1666
1667	=head1 menuBar
1668
1669	B<< The exact syntax used is I<almost> solidified. >>
1670	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1671	menuBar.
1672
1673	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1674	omitted: use B<./> to specify a menu relative to the current menu.
1675
1676	=head2 Overview of menuBar operation
1677
1678	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1679	of C<Pt> can be used for a variety of tasks:
1680
1681	At the top level is the current menuBar which is a member of a circular
1682	linked-list of other such menuBars.
1683
1684	The menuBar acts as a parent for the various drop-down menus, which in
1685	turn, may have labels, separator lines, menuItems and subMenus.
1686
1687	The menuItems are the useful bits: you can use them to mimic keyboard
1688	input or even to send text or escape sequences back to rxvt.
1689
1690	The menuBar syntax is intended to provide a simple yet robust method of
1691	constructing and manipulating menus and navigating through the
1692	menuBars.
1693
1694	The first step is to use the tag B<< [menu:I<name>] >> which creates
1695	the menuBar called I<name> and allows access. You may now or menus,
1696	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1697	menuBar access as B<readonly> to prevent accidental corruption of the
1698	menus. To re-access the current menuBar for alterations, use the tag
1699	B<[menu]>, make the alterations and then use B<[done]>
1700
1701	X<menuBarCommands>
1702
1703	=head2 Commands
1704
1705	=over 4
1706
1707	=item B<< [menu:+I<name>] >>
1708
1709	access the named menuBar for creation or alteration. If a new menuBar
1710	is created, it is called I<name> (max of 15 chars) and the current
1711	menuBar is pushed onto the stack
1712
1713	=item B<[menu]>
1714
1715	access the current menuBar for alteration
1716
1717	=item B<< [title:+I<string>] >>
1718
1719	set the current menuBar's title to I<string>, which may contain the
1720	following format specifiers:
1721
1722	B<%n> rxvt name (as per the B<-name> command-line option)
1723	B<%v> rxvt version
1724	B<%%> literal B<%> character
1725
1726	=item B<[done]>
1727
1728	set menuBar access as B<readonly>.
1729	End-of-file tag for B<< [read:+I<file>] >> operations.
1730
1731	=item B<< [read:+I<file>] >>
1732
1733	read menu commands directly from I<file> (extension ".menu" will be
1734	appended if required.) Start reading at a line with B<[menu]> or B<<
1735	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1736
1737	Blank and comment lines (starting with B<#>) are ignored. Actually,
1738	since any invalid menu commands are also ignored, almost anything could
1739	be construed as a comment line, but this may be tightened up in the
1740	future ... so don't count on it!.
1741
1742	=item B<< [read:+I<file>;+I<name>] >>
1743
1744	The same as B<< [read:+I<file>] >>, but start reading at a line with
1745	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1746	B<[done]> is encountered.
1747
1748	=item B<[dump]>
1749
1750	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1751	later rereading.
1752
1753	=item B<[rm:name]>
1754
1755	remove the named menuBar
1756
1757	=item B<[rm] [rm:]>
1758
1759	remove the current menuBar
1760
1761	=item B<[rm] [rm:]>
1762
1763	remove all menuBars
1764
1765	=item B<[swap]>
1766
1767	swap the top two menuBars
1768
1769	=item B<[prev]>
1770
1771	access the previous menuBar
1772
1773	=item B<[next]>
1774
1775	access the next menuBar
1776
1777	=item B<[show]>
1778
1779	Enable display of the menuBar
1780
1781	=item B<[hide]>
1782
1783	Disable display of the menuBar
1784
1785	=item B<< [pixmap:+I<name>] >>
1786
1787	=item B<< [pixmap:+I<name>;I<scaling>] >>
1788
1789	(set the background pixmap globally
1790
1791	B<< A Future implementation I<may> make this local to the menubar >>)
1792
1793	=item B<< [:+I<command>:] >>
1794
1795	ignore the menu readonly status and issue a I<command> to or a menu or
1796	menuitem or change the ; a useful shortcut for setting the quick arrows
1797	from a menuBar.
1798
1799	=back
1800
1801	X<menuBarAdd>
1802
1803	=head2 Adding and accessing menus
1804
1805	The following commands may also be B<+> prefixed.
1806
1807	=over 4
1808
1809	=item B</+>
1810
1811	access menuBar top level
1812
1813	=item B<./+>
1814
1815	access current menu level
1816
1817	=item B<../+>
1818
1819	access parent menu (1 level up)
1820
1821	=item B<../../>
1822
1823	access parent menu (multiple levels up)
1824
1825	=item B<< I</path/>menu >>
1826
1827	add/access menu
1828
1829	=item B<< I</path/>menu/* >>
1830
1831	add/access menu and clear it if it exists
1832
1833	=item B<< I</path/>{-} >>
1834
1835	add separator
1836
1837	=item B<< I</path/>{item} >>
1838
1839	add B<item> as a label
1840
1841	=item B<< I</path/>{item} action >>
1842
1843	add/alter I<menuitem> with an associated I<action>
1844
1845	=item B<< I</path/>{item}{right-text} >>
1846
1847	add/alter I<menuitem> with B<right-text> as the right-justified text
1848	and as the associated I<action>
1849
1850	=item B<< I</path/>{item}{rtext} action >>
1851
1852	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1853	the right-justified text.
1854
1855	=back
1856
1857	=over 4
1858
1859	=item Special characters in I<action> must be backslash-escaped:
1860
1861	B<\a \b \E \e \n \r \t \octal>
1862
1863	=item or in control-character notation:
1864
1865	B<^@, ^A .. ^Z .. ^_, ^?>
1866
1867	=back
1868
1869	To send a string starting with a B<NUL> (B<^@>) character to the
1870	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1871	the first of which will be stripped off and the balance directed to the
1872	program. Otherwise if I<action> begins with B<NUL> followed by
1873	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1874	balance is sent back to rxvt.
1875
1876	As a convenience for the many Emacs-type editors, I<action> may start
1877	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1878	appended if missed from B<M-x> commands.
1879
1880	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1881	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1882
1883	=over 4
1884
1885	=item For example,
1886
1887	B<M-xapropos> is equivalent to B<\Exapropos\r>
1888
1889	=item and
1890
1891	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1892
1893	=back
1894
1895	The option B<< {I<right-rtext>} >> will be right-justified. In the
1896	absence of a specified action, this text will be used as the I<action>
1897	as well.
1898
1899	=over 4
1900
1901	=item For example,
1902
1903	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1904
1905	=back
1906
1907	The left label I<is> necessary, since it's used for matching, but
1908	implicitly hiding the left label (by using same name for both left and
1909	right labels), or explicitly hiding the left label (by preceeding it
1910	with a dot), makes it possible to have right-justified text only.
1911
1912	=over 4
1913
1914	=item For example,
1915
1916	B</File/{Open}{Open} Open-File-Action>
1917
1918	=item or hiding it
1919
1920	B</File/{.anylabel}{Open} Open-File-Action>
1921
1922	=back
1923
1924	X<menuBarRemove>
1925
1926	=head2 Removing menus
1927
1928	=over 4
1929
1930	=item B<< -/*+ >>
1931
1932	remove all menus from the menuBar, the same as B<[clear]>
1933
1934	=item B<< -+I</path>menu+ >>
1935
1936	remove menu
1937
1938	=item B<< -+I</path>{item}+ >>
1939
1940	remove item
1941
1942	=item B<< -+I</path>{-} >>
1943
1944	remove separator)
1945
1946	=item B<-/path/menu/*>
1947
1948	remove all items, separators and submenus from menu
1949
1950	=back
1951
1952	X<menuBarArrows>
1953
1954	=head2 Quick Arrows
1955
1956	The menus also provide a hook for I<quick arrows> to provide easier
1957	user access. If nothing has been explicitly set, the default is to
1958	emulate the curror keys. The syntax permits each arrow to be altered
1959	individually or all four at once without re-entering their common
1960	beginning/end text. For example, to explicitly associate cursor actions
1961	with the arrows, any of the following forms could be used:
1962
1963	=over 4
1964
1965	=item B<< <r>+I<Right> >>
1966
1967	=item B<< <l>+I<Left> >>
1968
1969	=item B<< <u>+I<Up> >>
1970
1971	=item B<< <d>+I<Down> >>
1972
1973	Define actions for the respective arrow buttons
1974
1975	=item B<< <b>+I<Begin> >>
1976
1977	=item B<< <e>+I<End> >>
1978
1979	Define common beginning/end parts for I<quick arrows> which used in
1980	conjunction with the above <r> <l> <u> <d> constructs
1981
1982	=back
1983
1984	=over 4
1985
1986	=item For example, define arrows individually,
1987
1988	<u>\E[A
1989
1990	<d>\E[B
1991
1992	<r>\E[C
1993
1994	<l>\E[D
1995
1996	=item or all at once
1997
1998	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1999
2000	=item or more compactly (factoring out common parts)
2001
2002	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
2003
2004	=back
2005
2006	X<menuBarSummary>
2007
2008	=head2 Command Summary
2009
2010	A short summary of the most I<common> commands:
2011
2012	=over 4
2013
2014	=item [menu:name]
2015
2016	use an existing named menuBar or start a new one
2017
2018	=item [menu]
2019
2020	use the current menuBar
2021
2022	=item [title:string]
2023
2024	set menuBar title
2025
2026	=item [done]
2027
2028	set menu access to readonly and, if reading from a file, signal EOF
2029
2030	=item [done:name]
2031
2032	if reading from a file using [read:file;name] signal EOF
2033
2034	=item [rm:name]
2035
2036	remove named menuBar(s)
2037
2038	=item [rm] [rm:]
2039
2040	remove current menuBar
2041
2042	=item [rm] [rm:]
2043
2044	remove all menuBar(s)
2045
2046	=item [swap]
2047
2048	swap top two menuBars
2049
2050	=item [prev]
2051
2052	access the previous menuBar
2053
2054	=item [next]
2055
2056	access the next menuBar
2057
2058	=item [show]
2059
2060	map menuBar
2061
2062	=item [hide]
2063
2064	unmap menuBar
2065
2066	=item [pixmap;file]
2067
2068	=item [pixmap;file;scaling]
2069
2070	set a background pixmap
2071
2072	=item [read:file]
2073
2074	=item [read:file;name]
2075
2076	read in a menu from a file
2077
2078	=item [dump]
2079
2080	dump out all menuBars to /tmp/rxvt-PID
2081
2082	=item /
2083
2084	access menuBar top level
2085
2086	=item ./
2087
2088	=item ../
2089
2090	=item ../../
2091
2092	access current or parent menu level
2093
2094	=item /path/menu
2095
2096	add/access menu
2097
2098	=item /path/{-}
2099
2100	add separator
2101
2102	=item /path/{item}{rtext} action
2103
2104	add/alter menu item
2105
2106	=item -/*
2107
2108	remove all menus from the menuBar
2109
2110	=item -/path/menu
2111
2112	remove menu items, separators and submenus from menu
2113
2114	=item -/path/menu
2115
2116	remove menu
2117
2118	=item -/path/{item}
2119
2120	remove item
2121
2122	=item -/path/{-}
2123
2124	remove separator
2125
2126	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2127
2128	menu quick arrows
2129
2130	=back
2131	X<XPM>	1704	X<XPM>
2132		1705
2133	=head1 XPM	1706	=head1 XPM
2134		1707
2135	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1708	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
…		…
2382	alternative input methods (e.g. kinput2) and will also correctly	1955	alternative input methods (e.g. kinput2) and will also correctly
2383	set up the input for people using dead keys or compose keys.	1956	set up the input for people using dead keys or compose keys.
2384		1957
2385	=item --enable-unicode3 (default: off)	1958	=item --enable-unicode3 (default: off)
2386		1959
		1960	Recommended to stay off unless you really need non-BMP characters.
		1961
2387	Enable direct support for displaying unicode codepoints above	1962	Enable direct support for displaying unicode codepoints above
2388	65535 (the basic multilingual page). This increases storage	1963	65535 (the basic multilingual page). This increases storage
2389	requirements per character from 2 to 4 bytes. X11 fonts do not yet	1964	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2390	support these extra characters, but Xft does.	1965	support these extra characters, but Xft does.
2391		1966
…		…
2401	composite characters. This is required for proper viewing of text	1976	composite characters. This is required for proper viewing of text
2402	where accents are encoded as seperate unicode characters. This is	1977	where accents are encoded as seperate unicode characters. This is
2403	done by using precomposited characters when available or creating	1978	done by using precomposited characters when available or creating
2404	new pseudo-characters when no precomposed form exists.	1979	new pseudo-characters when no precomposed form exists.
2405		1980
2406	Without --enable-unicode3, the number of additional precomposed characters	1981	Without --enable-unicode3, the number of additional precomposed
2407	is rather limited (2048, if this is full, rxvt-unicode will use the	1982	characters is somewhat limited (the 6400 private use characters will be
2408	private use area, extending the number of combinations to 8448). With
2409	--enable-unicode3, no practical limit exists.	1983	(ab-)used). With --enable-unicode3, no practical limit exists.
2410		1984
2411	This option will also enable storage (but not display) of characters	1985	This option will also enable storage (but not display) of characters
2412	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	1986	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2413		1987
2414	The combining table also contains entries for arabic presentation forms,	1988	The combining table also contains entries for arabic presentation forms,
2415	but these are not currently used. Bug me if you want these to be used (and	1989	but these are not currently used. Bug me if you want these to be used (and
2416	tell me how these are to be used...).	1990	tell me how these are to be used...).
2417		1991
2418	=item --enable-fallback(=CLASS) (default: Rxvt)	1992	=item --enable-fallback(=CLASS) (default: Rxvt)
2419		1993
2420	When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.	1994	When reading resource settings, also read settings for class CLASS. To
		1995	disable resource fallback use --disable-fallback.
2421		1996
2422	=item --with-res-name=NAME (default: urxvt)	1997	=item --with-res-name=NAME (default: urxvt)
2423		1998
2424	Use the given name as default application name when	1999	Use the given name as default application name when
2425	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2000	reading resources. Specify --with-res-name=rxvt to replace rxvt.
…		…
2462		2037
2463	=item --enable-tinting (default: on)	2038	=item --enable-tinting (default: on)
2464		2039
2465	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).	2040	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2466		2041
2467	=item --enable-menubar (default: off) [DEPRECATED]
2468
2469	Add support for our menu bar system (this interacts badly with dynamic
2470	locale switching currently). This option is DEPRECATED and will be removed
2471	in the future.
2472
2473	=item --enable-rxvt-scroll (default: on)	2042	=item --enable-rxvt-scroll (default: on)
2474		2043
2475	Add support for the original rxvt scrollbar.	2044	Add support for the original rxvt scrollbar.
2476		2045
2477	=item --enable-next-scroll (default: on)	2046	=item --enable-next-scroll (default: on)
…		…
2486		2055
2487	Add support for a very unobtrusive, plain-looking scrollbar that	2056	Add support for a very unobtrusive, plain-looking scrollbar that
2488	is the favourite of the rxvt-unicode author, having used it for	2057	is the favourite of the rxvt-unicode author, having used it for
2489	many years.	2058	many years.
2490		2059
2491	=item --enable-half-shadow (default: off)
2492
2493	Make shadows on the scrollbar only half the normal width & height.
2494	only applicable to rxvt scrollbars.
2495
2496	=item --enable-ttygid (default: off)	2060	=item --enable-ttygid (default: off)
2497		2061
2498	Change tty device setting to group "tty" - only use this if	2062	Change tty device setting to group "tty" - only use this if
2499	your system uses this type of security.	2063	your system uses this type of security.
2500		2064
…		…
2508	do it.	2072	do it.
2509		2073
2510	=item --disable-resources	2074	=item --disable-resources
2511		2075
2512	Removes any support for resource checking.	2076	Removes any support for resource checking.
2513
2514	=item --enable-xgetdefault
2515
2516	Make resources checking via XGetDefault() instead of our small
2517	version which only checks ~/.Xdefaults, or if that doesn't exist then
2518	~/.Xresources.
2519
2520	Please note that nowadays, things like XIM will automatically pull in and
2521	use the full X resource manager, so the overhead of using it might be very
2522	small, if nonexistant.
2523
2524	=item --enable-strings (default: off)
2525
2526	Add support for our possibly faster memset() function and other
2527	various routines, overriding your system's versions which may
2528	have been hand-crafted in assembly or may require extra libraries
2529	to link in. (this breaks ANSI-C rules and has problems on many
2530	GNU/Linux systems).
2531		2077
2532	=item --disable-swapscreen	2078	=item --disable-swapscreen
2533		2079
2534	Remove support for secondary/swap screen.	2080	Remove support for secondary/swap screen.
2535		2081
…		…
2544		2090
2545	MWM-hints	2091	MWM-hints
2546	EWMH-hints (pid, utf8 names) and protocols (ping)	2092	EWMH-hints (pid, utf8 names) and protocols (ping)
2547	seperate underline colour (-underlineColor)	2093	seperate underline colour (-underlineColor)
2548	settable border widths and borderless switch (-w, -b, -bl)	2094	settable border widths and borderless switch (-w, -b, -bl)
		2095	visual selection (-depth)
2549	settable extra linespacing /-lsp)	2096	settable extra linespacing /-lsp)
2550	iso-14755-2 and -3, and visual feedback	2097	iso-14755-2 and -3, and visual feedback
2551	backindex and forwardindex escape sequence	2098	backindex and forwardindex escape sequence
2552	window op and some xterm/OSC escape sequences	2099	window op and some xterm/OSC escape sequences
2553	tripleclickwords (-tcw)	2100	tripleclickwords (-tcw)
…		…
2609		2156
2610	=item --enable-pointer-blank (default: on)	2157	=item --enable-pointer-blank (default: on)
2611		2158
2612	Add support to have the pointer disappear when typing or inactive.	2159	Add support to have the pointer disappear when typing or inactive.
2613		2160
2614	=item --enable-perl (default: off)	2161	=item --enable-perl (default: on)
2615		2162
2616	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>	2163	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2617	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files	2164	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2618	in F<src/perl-ext/> for the extensions that are installed by default. The	2165	in F<src/perl-ext/> for the extensions that are installed by default. The
2619	perl interpreter that is used can be specified via the C<PERL> environment	2166	perl interpreter that is used can be specified via the C<PERL> environment

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.74 by root, Mon Jan 9 07:24:43 2006 UTC vs. Revision 1.92 by root, Sat Jan 28 20:33:30 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.74 by root, Mon Jan 9 07:24:43 2006 UTC vs.
Revision 1.92 by root, Sat Jan 28 20:33:30 2006 UTC