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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.63 by root, Thu Dec 22 16:44:10 2005 UTC vs.
Revision 1.85 by root, Mon Jan 16 15:12:48 2006 UTC

…		…
24		24
25	=head1 FREQUENTLY ASKED QUESTIONS	25	=head1 FREQUENTLY ASKED QUESTIONS
26		26
27	=over 4	27	=over 4
28		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
		68
		69	=item Isn't rxvt supposed to be small? Don't all those features bloat?
		70
		71	I often get asked about this, and I think, no, they didn't cause extra
		72	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
		73	that the urxvt binary is larger (due to some encoding tables always being
		74	compiled in), but it actually uses less memory (RSS) after startup. Even
		75	with C<--disable-everything>, this comparison is a bit unfair, as many
		76	features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
		77	already in use in this mode.
		78
		79	text data bss drs rss filename
		80	98398 1664 24 15695 1824 rxvt --disable-everything
		81	188985 9048 66616 18222 1788 urxvt --disable-everything
		82
		83	When you C<--enable-everything> (which _is_ unfair, as this involves xft
		84	and full locale/XIM support which are quite bloaty inside libX11 and my
		85	libc), the two diverge, but not unreasnobaly so.
		86
		87	text data bss drs rss filename
		88	163431 2152 24 20123 2060 rxvt --enable-everything
		89	1035683 49680 66648 29096 3680 urxvt --enable-everything
		90
		91	The very large size of the text section is explained by the east-asian
		92	encoding tables, which, if unused, take up disk space but nothing else
		93	and can be compiled out unless you rely on X11 core fonts that use those
		94	encodings. The BSS size comes from the 64k emergency buffer that my c++
		95	compiler allocates (but of course doesn't use unless you are out of
		96	memory). Also, using an xft font instead of a core font immediately adds a
		97	few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
		98	not used.
		99
		100	Of course, due to every character using two or four bytes instead of one,
		101	a large scrollback buffer will ultimately make rxvt-unicode use more
		102	memory.
		103
		104	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
		105	still fares rather well. And compared to some monsters like gnome-terminal
		106	(21152k + extra 4204k in separate processes) or konsole (22200k + extra
		107	43180k in daemons that stay around after exit, plus half a minute of
		108	startup time, including the hundreds of warnings it spits out), it fares
		109	extremely well g.
		110
		111	=item Why C++, isn't that unportable/bloated/uncool?
		112
		113	Is this a question? :) It comes up very often. The simple answer is: I had
		114	to write it, and C++ allowed me to write and maintain it in a fraction
		115	of the time and effort (which is a scarce resource for me). Put even
		116	shorter: It simply wouldn't exist without C++.
		117
		118	My personal stance on this is that C++ is less portable than C, but in
		119	the case of rxvt-unicode this hardly matters, as its portability limits
		120	are defined by things like X11, pseudo terminals, locale support and unix
		121	domain sockets, which are all less portable than C++ itself.
		122
		123	Regarding the bloat, see the above question: It's easy to write programs
		124	in C that use gobs of memory, an certainly possible to write programs in
		125	C++ that don't. C++ also often comes with large libraries, but this is
		126	not necessarily the case with GCC. Here is what rxvt links against on my
		127	system with a minimal config:
		128
		129	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		130	libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
		131	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
		132	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		133
		134	And here is rxvt-unicode:
		135
		136	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		137	libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
		138	libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
		139	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
		140	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		141
		142	No large bloated libraries (of course, none were linked in statically),
		143	except maybe libX11 :)
		144
		145	=item Does it support tabs, can I have a tabbed rxvt-unicode?
		146
		147	rxvt-unicode does not directly support tabs. It will work fine with
		148	tabbing functionality of many window managers or similar tabbing programs,
		149	and its embedding-features allow it to be embedded into other programs,
		150	as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
		151	module, which features a tabbed urxvt (murxvt) terminal as an example
		152	embedding application.
		153
29	=item How do I know which rxvt-unicode version I'm using?	154	=item How do I know which rxvt-unicode version I'm using?
30		155
31	The version number is displayed with the usage (-h). Also the escape	156	The version number is displayed with the usage (-h). Also the escape
32	sequence C<ESC [ 8 n> sets the window title to the version number.	157	sequence C<ESC [ 8 n> sets the window title to the version number. When
		158	using the @@RXVT_NAME@@c client, the version displayed is that of the
		159	daemon.
33		160
34	=item I am using Debian GNU/Linux and have a problem...	161	=item I am using Debian GNU/Linux and have a problem...
35		162
36	The Debian GNU/Linux package of rxvt-unicode in sarge contains large	163	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37	patches that considerably change the behaviour of rxvt-unicode. Before	164	patches that considerably change the behaviour of rxvt-unicode. Before
…		…
44		171
45	For other problems that also affect the Debian package, you can and	172	For other problems that also affect the Debian package, you can and
46	probably should use the Debian BTS, too, because, after all, it's also a	173	probably should use the Debian BTS, too, because, after all, it's also a
47	bug in the Debian version and it serves as a reminder for other users that	174	bug in the Debian version and it serves as a reminder for other users that
48	might encounter the same issue.	175	might encounter the same issue.
		176
		177	=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		178
		179	You should build one binary with the default options. F<configure>
		180	now enables most useful options, and the trend goes to making them
		181	runtime-switchable, too, so there is usually no drawback to enbaling them,
		182	except higher disk and possibly memory usage. The perl interpreter should
		183	be enabled, as important functionality (menus, selection, likely more in
		184	the future) depends on it.
		185
		186	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		187	system-wide (except maybe with C<defaults>). This will result in useful
		188	behaviour. If your distribution aims at low memory, add an empty
		189	C<perl-ext-common> resource to the app-defaults file. This will keep the
		190	perl interpreter disabled until the user enables it.
		191
		192	If you can/want build more binaries, I recommend building a minimal
		193	one with C<--disable-everything> (very useful) and a maximal one with
		194	C<--enable-everything> (less useful, it will be very big due to a lot of
		195	encodings built-in that increase download times and are rarely used).
		196
		197	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		198
		199	Likely not. While I honestly try to make it secure, and am probably not
		200	bad at it, I think it is simply unreasonable to expect all of freetype
		201	+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
		202	secure. Also, rxvt-unicode disables some options when it detects that it
		203	runs setuid or setgid, which is not nice. Besides, with the embedded perl
		204	interpreter the possibility for security problems easily multiplies.
		205
		206	Elevated privileges are only required for utmp and pty operations on some
		207	systems (for example, GNU/Linux doesn't need any extra privileges for
		208	ptys, but some need it for utmp support). It is planned to mvoe this into
		209	a forked handler process, but this is not yet done.
		210
		211	So, while setuid/setgid operation is supported and not a problem on your
		212	typical single-user-no-other-logins unix desktop, always remember that
		213	its an awful lot of code, most of which isn't checked for security issues
		214	regularly.
49		215
50	=item When I log-in to another system it tells me about missing terminfo data?	216	=item When I log-in to another system it tells me about missing terminfo data?
51		217
52	The terminal description used by rxvt-unicode is not as widely available	218	The terminal description used by rxvt-unicode is not as widely available
53	as that for xterm, or even rxvt (for which the same problem often arises).	219	as that for xterm, or even rxvt (for which the same problem often arises).
…		…
450	=item My input method wants <some encoding> but I want UTF-8, what can I do?	616	=item My input method wants <some encoding> but I want UTF-8, what can I do?
451		617
452	You can specify separate locales for the input method and the rest of the	618	You can specify separate locales for the input method and the rest of the
453	terminal, using the resource C<imlocale>:	619	terminal, using the resource C<imlocale>:
454		620
455	URxvt*imlocale: ja_JP.EUC-JP	621	URxvt.imlocale: ja_JP.EUC-JP
456		622
457	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still	623	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
458	use your input method. Please note, however, that you will not be able to	624	use your input method. Please note, however, that you will not be able to
459	input characters outside C<EUC-JP> in a normal way then, as your input	625	input characters outside C<EUC-JP> in a normal way then, as your input
460	method limits you.	626	method limits you.
…		…
506		672
507	Make sure that mouse reporting is actually turned off since killing	673	Make sure that mouse reporting is actually turned off since killing
508	some editors prematurely may leave the mouse in mouse report mode. I've	674	some editors prematurely may leave the mouse in mouse report mode. I've
509	heard that tcsh may use mouse reporting unless it otherwise specified. A	675	heard that tcsh may use mouse reporting unless it otherwise specified. A
510	quick check is to see if cut/paste works when the Alt or Shift keys are	676	quick check is to see if cut/paste works when the Alt or Shift keys are
511	depressed. See @@RXVT_NAME@@(7)	677	depressed.
512		678
513	=item What's with this bold/blink stuff?	679	=item What's with this bold/blink stuff?
514		680
515	If no bold colour is set via C<colorBD:>, bold will invert text using the	681	If no bold colour is set via C<colorBD:>, bold will invert text using the
516	standard foreground colour.	682	standard foreground colour.
…		…
605		771
606	# use Backspace = ^?	772	# use Backspace = ^?
607	$ stty erase ^?	773	$ stty erase ^?
608	$ @@RXVT_NAME@@	774	$ @@RXVT_NAME@@
609		775
610	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).	776	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
611		777
612	For an existing rxvt-unicode:	778	For an existing rxvt-unicode:
613		779
614	# use Backspace = ^H	780	# use Backspace = ^H
615	$ stty erase ^H	781	$ stty erase ^H
…		…
733		899
734	=head1 DESCRIPTION	900	=head1 DESCRIPTION
735		901
736	The rest of this document describes various technical aspects of	902	The rest of this document describes various technical aspects of
737	B<rxvt-unicode>. First the description of supported command sequences,	903	B<rxvt-unicode>. First the description of supported command sequences,
738	followed by menu and pixmap support and last by a description of all	904	followed by pixmap support and last by a description of all features
739	features selectable at C<configure> time.	905	selectable at C<configure> time.
740		906
741	=head1 Definitions	907	=head1 Definitions
742		908
743	=over 4	909	=over 4
744		910
…		…
1312	B<< C<h> >> Send Mouse X & Y on button press.	1478	B<< C<h> >> Send Mouse X & Y on button press.
1313	B<< C<l> >> No mouse reporting.	1479	B<< C<l> >> No mouse reporting.
1314		1480
1315	=end table	1481	=end table
1316		1482
1317	=item B<< C<Ps = 10> >> (B<rxvt>)
1318
1319	=begin table
1320
1321	B<< C<h> >> menuBar visible
1322	B<< C<l> >> menuBar invisible
1323
1324	=end table
1325
1326	=item B<< C<Ps = 25> >>	1483	=item B<< C<Ps = 25> >>
1327		1484
1328	=begin table	1485	=begin table
1329		1486
1330	B<< C<h> >> Visible cursor {cnorm/cvvis}	1487	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1443		1600
1444	=begin table	1601	=begin table
1445		1602
1446	B<< C<h> >> Scroll to bottom when a key is pressed	1603	B<< C<h> >> Scroll to bottom when a key is pressed
1447	B<< C<l> >> Don't scroll to bottom when a key is pressed	1604	B<< C<l> >> Don't scroll to bottom when a key is pressed
		1605
		1606	=end table
		1607
		1608	=item B<< C<Ps = 1021> >> (B<rxvt>)
		1609
		1610	=begin table
		1611
		1612	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1613	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1448		1614
1449	=end table	1615	=end table
1450		1616
1451	=item B<< C<Ps = 1047> >>	1617	=item B<< C<Ps = 1047> >>
1452		1618
…		…
1501	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1667	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1502	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	1668	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1503	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1669	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1504	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1670	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1505	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1671	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1506	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	1672	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1507	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	1673	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1508	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1674	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1509	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.	1675	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1510	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1676	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1511	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.	1677	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1512	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> >>	1678	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> >>
1513	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	1679	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1514	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).	1680	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).
1515	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1516	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	1681	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1517	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).	1682	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		1683	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		1684	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1518	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.	1685	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1519	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	1686	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	1687	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	1688	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1522	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).	1689	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1523	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).	1690	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1691	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1524		1692
1525	=end table	1693	=end table
1526		1694
1527	=back	1695	=back
1528		1696
1529	X<menuBar>
1530
1531	=head1 menuBar
1532
1533	B<< The exact syntax used is I<almost> solidified. >>
1534	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1535	menuBar.
1536
1537	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1538	omitted: use B<./> to specify a menu relative to the current menu.
1539
1540	=head2 Overview of menuBar operation
1541
1542	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1543	of C<Pt> can be used for a variety of tasks:
1544
1545	At the top level is the current menuBar which is a member of a circular
1546	linked-list of other such menuBars.
1547
1548	The menuBar acts as a parent for the various drop-down menus, which in
1549	turn, may have labels, separator lines, menuItems and subMenus.
1550
1551	The menuItems are the useful bits: you can use them to mimic keyboard
1552	input or even to send text or escape sequences back to rxvt.
1553
1554	The menuBar syntax is intended to provide a simple yet robust method of
1555	constructing and manipulating menus and navigating through the
1556	menuBars.
1557
1558	The first step is to use the tag B<< [menu:I<name>] >> which creates
1559	the menuBar called I<name> and allows access. You may now or menus,
1560	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1561	menuBar access as B<readonly> to prevent accidental corruption of the
1562	menus. To re-access the current menuBar for alterations, use the tag
1563	B<[menu]>, make the alterations and then use B<[done]>
1564
1565	X<menuBarCommands>
1566
1567	=head2 Commands
1568
1569	=over 4
1570
1571	=item B<< [menu:+I<name>] >>
1572
1573	access the named menuBar for creation or alteration. If a new menuBar
1574	is created, it is called I<name> (max of 15 chars) and the current
1575	menuBar is pushed onto the stack
1576
1577	=item B<[menu]>
1578
1579	access the current menuBar for alteration
1580
1581	=item B<< [title:+I<string>] >>
1582
1583	set the current menuBar's title to I<string>, which may contain the
1584	following format specifiers:
1585
1586	B<%n> rxvt name (as per the B<-name> command-line option)
1587	B<%v> rxvt version
1588	B<%%> literal B<%> character
1589
1590	=item B<[done]>
1591
1592	set menuBar access as B<readonly>.
1593	End-of-file tag for B<< [read:+I<file>] >> operations.
1594
1595	=item B<< [read:+I<file>] >>
1596
1597	read menu commands directly from I<file> (extension ".menu" will be
1598	appended if required.) Start reading at a line with B<[menu]> or B<<
1599	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1600
1601	Blank and comment lines (starting with B<#>) are ignored. Actually,
1602	since any invalid menu commands are also ignored, almost anything could
1603	be construed as a comment line, but this may be tightened up in the
1604	future ... so don't count on it!.
1605
1606	=item B<< [read:+I<file>;+I<name>] >>
1607
1608	The same as B<< [read:+I<file>] >>, but start reading at a line with
1609	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1610	B<[done]> is encountered.
1611
1612	=item B<[dump]>
1613
1614	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1615	later rereading.
1616
1617	=item B<[rm:name]>
1618
1619	remove the named menuBar
1620
1621	=item B<[rm] [rm:]>
1622
1623	remove the current menuBar
1624
1625	=item B<[rm] [rm:]>
1626
1627	remove all menuBars
1628
1629	=item B<[swap]>
1630
1631	swap the top two menuBars
1632
1633	=item B<[prev]>
1634
1635	access the previous menuBar
1636
1637	=item B<[next]>
1638
1639	access the next menuBar
1640
1641	=item B<[show]>
1642
1643	Enable display of the menuBar
1644
1645	=item B<[hide]>
1646
1647	Disable display of the menuBar
1648
1649	=item B<< [pixmap:+I<name>] >>
1650
1651	=item B<< [pixmap:+I<name>;I<scaling>] >>
1652
1653	(set the background pixmap globally
1654
1655	B<< A Future implementation I<may> make this local to the menubar >>)
1656
1657	=item B<< [:+I<command>:] >>
1658
1659	ignore the menu readonly status and issue a I<command> to or a menu or
1660	menuitem or change the ; a useful shortcut for setting the quick arrows
1661	from a menuBar.
1662
1663	=back
1664
1665	X<menuBarAdd>
1666
1667	=head2 Adding and accessing menus
1668
1669	The following commands may also be B<+> prefixed.
1670
1671	=over 4
1672
1673	=item B</+>
1674
1675	access menuBar top level
1676
1677	=item B<./+>
1678
1679	access current menu level
1680
1681	=item B<../+>
1682
1683	access parent menu (1 level up)
1684
1685	=item B<../../>
1686
1687	access parent menu (multiple levels up)
1688
1689	=item B<< I</path/>menu >>
1690
1691	add/access menu
1692
1693	=item B<< I</path/>menu/* >>
1694
1695	add/access menu and clear it if it exists
1696
1697	=item B<< I</path/>{-} >>
1698
1699	add separator
1700
1701	=item B<< I</path/>{item} >>
1702
1703	add B<item> as a label
1704
1705	=item B<< I</path/>{item} action >>
1706
1707	add/alter I<menuitem> with an associated I<action>
1708
1709	=item B<< I</path/>{item}{right-text} >>
1710
1711	add/alter I<menuitem> with B<right-text> as the right-justified text
1712	and as the associated I<action>
1713
1714	=item B<< I</path/>{item}{rtext} action >>
1715
1716	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1717	the right-justified text.
1718
1719	=back
1720
1721	=over 4
1722
1723	=item Special characters in I<action> must be backslash-escaped:
1724
1725	B<\a \b \E \e \n \r \t \octal>
1726
1727	=item or in control-character notation:
1728
1729	B<^@, ^A .. ^Z .. ^_, ^?>
1730
1731	=back
1732
1733	To send a string starting with a B<NUL> (B<^@>) character to the
1734	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1735	the first of which will be stripped off and the balance directed to the
1736	program. Otherwise if I<action> begins with B<NUL> followed by
1737	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1738	balance is sent back to rxvt.
1739
1740	As a convenience for the many Emacs-type editors, I<action> may start
1741	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1742	appended if missed from B<M-x> commands.
1743
1744	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1745	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1746
1747	=over 4
1748
1749	=item For example,
1750
1751	B<M-xapropos> is equivalent to B<\Exapropos\r>
1752
1753	=item and
1754
1755	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1756
1757	=back
1758
1759	The option B<< {I<right-rtext>} >> will be right-justified. In the
1760	absence of a specified action, this text will be used as the I<action>
1761	as well.
1762
1763	=over 4
1764
1765	=item For example,
1766
1767	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1768
1769	=back
1770
1771	The left label I<is> necessary, since it's used for matching, but
1772	implicitly hiding the left label (by using same name for both left and
1773	right labels), or explicitly hiding the left label (by preceeding it
1774	with a dot), makes it possible to have right-justified text only.
1775
1776	=over 4
1777
1778	=item For example,
1779
1780	B</File/{Open}{Open} Open-File-Action>
1781
1782	=item or hiding it
1783
1784	B</File/{.anylabel}{Open} Open-File-Action>
1785
1786	=back
1787
1788	X<menuBarRemove>
1789
1790	=head2 Removing menus
1791
1792	=over 4
1793
1794	=item B<< -/*+ >>
1795
1796	remove all menus from the menuBar, the same as B<[clear]>
1797
1798	=item B<< -+I</path>menu+ >>
1799
1800	remove menu
1801
1802	=item B<< -+I</path>{item}+ >>
1803
1804	remove item
1805
1806	=item B<< -+I</path>{-} >>
1807
1808	remove separator)
1809
1810	=item B<-/path/menu/*>
1811
1812	remove all items, separators and submenus from menu
1813
1814	=back
1815
1816	X<menuBarArrows>
1817
1818	=head2 Quick Arrows
1819
1820	The menus also provide a hook for I<quick arrows> to provide easier
1821	user access. If nothing has been explicitly set, the default is to
1822	emulate the curror keys. The syntax permits each arrow to be altered
1823	individually or all four at once without re-entering their common
1824	beginning/end text. For example, to explicitly associate cursor actions
1825	with the arrows, any of the following forms could be used:
1826
1827	=over 4
1828
1829	=item B<< <r>+I<Right> >>
1830
1831	=item B<< <l>+I<Left> >>
1832
1833	=item B<< <u>+I<Up> >>
1834
1835	=item B<< <d>+I<Down> >>
1836
1837	Define actions for the respective arrow buttons
1838
1839	=item B<< <b>+I<Begin> >>
1840
1841	=item B<< <e>+I<End> >>
1842
1843	Define common beginning/end parts for I<quick arrows> which used in
1844	conjunction with the above <r> <l> <u> <d> constructs
1845
1846	=back
1847
1848	=over 4
1849
1850	=item For example, define arrows individually,
1851
1852	<u>\E[A
1853
1854	<d>\E[B
1855
1856	<r>\E[C
1857
1858	<l>\E[D
1859
1860	=item or all at once
1861
1862	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1863
1864	=item or more compactly (factoring out common parts)
1865
1866	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1867
1868	=back
1869
1870	X<menuBarSummary>
1871
1872	=head2 Command Summary
1873
1874	A short summary of the most I<common> commands:
1875
1876	=over 4
1877
1878	=item [menu:name]
1879
1880	use an existing named menuBar or start a new one
1881
1882	=item [menu]
1883
1884	use the current menuBar
1885
1886	=item [title:string]
1887
1888	set menuBar title
1889
1890	=item [done]
1891
1892	set menu access to readonly and, if reading from a file, signal EOF
1893
1894	=item [done:name]
1895
1896	if reading from a file using [read:file;name] signal EOF
1897
1898	=item [rm:name]
1899
1900	remove named menuBar(s)
1901
1902	=item [rm] [rm:]
1903
1904	remove current menuBar
1905
1906	=item [rm] [rm:]
1907
1908	remove all menuBar(s)
1909
1910	=item [swap]
1911
1912	swap top two menuBars
1913
1914	=item [prev]
1915
1916	access the previous menuBar
1917
1918	=item [next]
1919
1920	access the next menuBar
1921
1922	=item [show]
1923
1924	map menuBar
1925
1926	=item [hide]
1927
1928	unmap menuBar
1929
1930	=item [pixmap;file]
1931
1932	=item [pixmap;file;scaling]
1933
1934	set a background pixmap
1935
1936	=item [read:file]
1937
1938	=item [read:file;name]
1939
1940	read in a menu from a file
1941
1942	=item [dump]
1943
1944	dump out all menuBars to /tmp/rxvt-PID
1945
1946	=item /
1947
1948	access menuBar top level
1949
1950	=item ./
1951
1952	=item ../
1953
1954	=item ../../
1955
1956	access current or parent menu level
1957
1958	=item /path/menu
1959
1960	add/access menu
1961
1962	=item /path/{-}
1963
1964	add separator
1965
1966	=item /path/{item}{rtext} action
1967
1968	add/alter menu item
1969
1970	=item -/*
1971
1972	remove all menus from the menuBar
1973
1974	=item -/path/menu
1975
1976	remove menu items, separators and submenus from menu
1977
1978	=item -/path/menu
1979
1980	remove menu
1981
1982	=item -/path/{item}
1983
1984	remove item
1985
1986	=item -/path/{-}
1987
1988	remove separator
1989
1990	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1991
1992	menu quick arrows
1993
1994	=back
1995	X<XPM>	1697	X<XPM>
1996		1698
1997	=head1 XPM	1699	=head1 XPM
1998		1700
1999	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1701	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
…		…
2309		2011
2310	Write user and tty to lastlog file (used by programs like	2012	Write user and tty to lastlog file (used by programs like
2311	F<lastlogin>) at start of rxvt execution. This option requires	2013	F<lastlogin>) at start of rxvt execution. This option requires
2312	--enable-utmp to also be specified.	2014	--enable-utmp to also be specified.
2313		2015
2314	=item --enable-xpm-background (default: off)	2016	=item --enable-xpm-background (default: on)
2315		2017
2316	Add support for XPM background pixmaps.	2018	Add support for XPM background pixmaps.
2317		2019
2318	=item --enable-transparency (default: off)	2020	=item --enable-transparency (default: on)
2319		2021
2320	Add support for inheriting parent backgrounds thus giving a fake	2022	Add support for inheriting parent backgrounds thus giving a fake
2321	transparency to the term.	2023	transparency to the term.
2322		2024
2323	=item --enable-fading (default: on)	2025	=item --enable-fading (default: on)
…		…
2325	Add support for fading the text when focus is lost (requires C<--enable-transparency>).	2027	Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2326		2028
2327	=item --enable-tinting (default: on)	2029	=item --enable-tinting (default: on)
2328		2030
2329	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).	2031	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2330
2331	=item --enable-menubar (default: off)
2332
2333	Add support for our menu bar system (this interacts badly with
2334	dynamic locale switching currently).
2335		2032
2336	=item --enable-rxvt-scroll (default: on)	2033	=item --enable-rxvt-scroll (default: on)
2337		2034
2338	Add support for the original rxvt scrollbar.	2035	Add support for the original rxvt scrollbar.
2339		2036
…		…
2372		2069
2373	=item --disable-resources	2070	=item --disable-resources
2374		2071
2375	Removes any support for resource checking.	2072	Removes any support for resource checking.
2376		2073
2377	=item --enable-xgetdefault
2378
2379	Make resources checking via XGetDefault() instead of our small
2380	version which only checks ~/.Xdefaults, or if that doesn't exist then
2381	~/.Xresources.
2382
2383	Please note that nowadays, things like XIM will automatically pull in and
2384	use the full X resource manager, so the overhead of using it might be very
2385	small, if nonexistant.
2386
2387	=item --enable-strings (default: off)
2388
2389	Add support for our possibly faster memset() function and other
2390	various routines, overriding your system's versions which may
2391	have been hand-crafted in assembly or may require extra libraries
2392	to link in. (this breaks ANSI-C rules and has problems on many
2393	GNU/Linux systems).
2394
2395	=item --disable-swapscreen	2074	=item --disable-swapscreen
2396		2075
2397	Remove support for secondary/swap screen.	2076	Remove support for secondary/swap screen.
2398		2077
2399	=item --enable-frills (default: on)	2078	=item --enable-frills (default: on)
…		…
2405	A non-exhaustive list of features enabled by C<--enable-frills> (possibly	2084	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2406	in combination with other switches) is:	2085	in combination with other switches) is:
2407		2086
2408	MWM-hints	2087	MWM-hints
2409	EWMH-hints (pid, utf8 names) and protocols (ping)	2088	EWMH-hints (pid, utf8 names) and protocols (ping)
2410	seperate underline colour	2089	seperate underline colour (-underlineColor)
2411	settable border widths and borderless switch	2090	settable border widths and borderless switch (-w, -b, -bl)
2412	settable extra linespacing	2091	settable extra linespacing /-lsp)
2413	iso-14755-2 and -3, and visual feedback	2092	iso-14755-2 and -3, and visual feedback
2414	backindex and forwardindex escape sequence	2093	backindex and forwardindex escape sequence
2415	window op and some xterm/OSC escape sequences	2094	window op and some xterm/OSC escape sequences
2416	tripleclickwords	2095	tripleclickwords (-tcw)
2417	settable insecure mode	2096	settable insecure mode (-insecure)
2418	keysym remapping support	2097	keysym remapping support
2419	cursor blinking and underline cursor	2098	cursor blinking and underline cursor (-cb, -uc)
2420	-embed, -pty-fd and -hold options	2099	XEmbed support (-embed)
		2100	user-pty (-pty-fd)
		2101	hold on exit (-hold)
		2102	skip builtin block graphics (-sbg)
		2103	sgr modes 90..97 and 100..107
2421		2104
2422	=item --enable-iso14755 (default: on)	2105	=item --enable-iso14755 (default: on)
2423		2106
2424	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2107	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2425	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2108	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
…		…
2468		2151
2469	=item --enable-pointer-blank (default: on)	2152	=item --enable-pointer-blank (default: on)
2470		2153
2471	Add support to have the pointer disappear when typing or inactive.	2154	Add support to have the pointer disappear when typing or inactive.
2472		2155
		2156	=item --enable-perl (default: off)
		2157
		2158	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2159	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
		2160	in F<src/perl-ext/> for the extensions that are installed by default. The
		2161	perl interpreter that is used can be specified via the C<PERL> environment
		2162	variable when running configure.
		2163
2473	=item --with-name=NAME (default: urxvt)	2164	=item --with-name=NAME (default: urxvt)
2474		2165
2475	Set the basename for the installed binaries, resulting	2166	Set the basename for the installed binaries, resulting
2476	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2167	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2477	C<rxvt>.	2168	C<rxvt>.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.63 by root, Thu Dec 22 16:44:10 2005 UTC vs. Revision 1.85 by root, Mon Jan 16 15:12:48 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.63 by root, Thu Dec 22 16:44:10 2005 UTC vs.
Revision 1.85 by root, Mon Jan 16 15:12:48 2006 UTC