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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.51 by root, Mon Feb 21 19:26:06 2005 UTC vs.
Revision 1.90 by root, Mon Jan 23 01:46:55 2006 UTC

 =head1 FREQUENTLY ASKED QUESTIONS
 =over 4
+=item The new selection selects pieces that are too big, how can I select
+single words?
+Yes. For example, if you want to select alphanumeric words, you can use
+the following resource:
+   URxvt.selection.pattern-0: ([[:word:]]+)
+If you click more than twice, the selection will be extended
+more and more.
+To get a selection that is very similar to the old code, try this pattern:
+   URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
+Please also note that the I<LeftClick Shift-LeftClik> combination also
+selects words like the old code.
+=item I don't like the new selection/popups/hotkeys/perl, how do I
+change/disable it?
+You can disable the perl extension completely by setting the
+B<perl-ext-common> resource to the empty string, which also keeps
+rxvt-unicode from initialising perl, saving memory.
+If you only want to disable specific features, you first have to
+identify which perl extension is responsible. For this, read the section
+B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
+example, to disable the B<selection-popup> and B<option-popup>, specify
+this B<perl-ext-common> resource:
+   URxvt.perl-ext-common: default,-selection-popup,-option-popup
+This will keep the default extensions, but disable the two popup
+extensions. Some extensions can also be configured, for example,
+scrollback search mode is triggered by B<M-s>. You can move it to any
+other combination either by setting the B<searchable-scrollback> resource:
+   URxvt.searchable-scrollback: CM-s
+=item Isn't rxvt supposed to be small? Don't all those features bloat?
+I often get asked about this, and I think, no, they didn't cause extra
+bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
+that the urxvt binary is larger (due to some encoding tables always being
+compiled in), but it actually uses less memory (RSS) after startup. Even
+with C<--disable-everything>, this comparison is a bit unfair, as many
+features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
+already in use in this mode.
+    text    data     bss     drs     rss filename
+   98398    1664      24   15695    1824 rxvt --disable-everything
+  188985    9048   66616   18222    1788 urxvt --disable-everything
+When you C<--enable-everything> (which _is_ unfair, as this involves xft
+and full locale/XIM support which are quite bloaty inside libX11 and my
+libc), the two diverge, but not unreasnobaly so.
+    text    data     bss     drs     rss filename
+  163431    2152      24   20123    2060 rxvt --enable-everything
+ 1035683   49680   66648   29096    3680 urxvt --enable-everything
+The very large size of the text section is explained by the east-asian
+encoding tables, which, if unused, take up disk space but nothing else
+and can be compiled out unless you rely on X11 core fonts that use those
+encodings. The BSS size comes from the 64k emergency buffer that my c++
+compiler allocates (but of course doesn't use unless you are out of
+memory). Also, using an xft font instead of a core font immediately adds a
+few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
+not used.
+Of course, due to every character using two or four bytes instead of one,
+a large scrollback buffer will ultimately make rxvt-unicode use more
+memory.
+Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
+still fares rather well. And compared to some monsters like gnome-terminal
+(21152k + extra 4204k in separate processes) or konsole (22200k + extra
+43180k in daemons that stay around after exit, plus half a minute of
+startup time, including the hundreds of warnings it spits out), it fares
+extremely well *g*.
+=item Why C++, isn't that unportable/bloated/uncool?
+Is this a question? :) It comes up very often. The simple answer is: I had
+to write it, and C++ allowed me to write and maintain it in a fraction
+of the time and effort (which is a scarce resource for me). Put even
+shorter: It simply wouldn't exist without C++.
+My personal stance on this is that C++ is less portable than C, but in
+the case of rxvt-unicode this hardly matters, as its portability limits
+are defined by things like X11, pseudo terminals, locale support and unix
+domain sockets, which are all less portable than C++ itself.
+Regarding the bloat, see the above question: It's easy to write programs
+in C that use gobs of memory, an certainly possible to write programs in
+C++ that don't. C++ also often comes with large libraries, but this is
+not necessarily the case with GCC. Here is what rxvt links against on my
+system with a minimal config:
+   libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
+   libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
+   libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
+   /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
+And here is rxvt-unicode:
+   libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
+   libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
+   libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
+   libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
+   /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
+No large bloated libraries (of course, none were linked in statically),
+except maybe libX11 :)
+=item Does it support tabs, can I have a tabbed rxvt-unicode?
+rxvt-unicode does not directly support tabs. It will work fine with
+tabbing functionality of many window managers or similar tabbing programs,
+and its embedding-features allow it to be embedded into other programs,
+as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
+module, which features a tabbed urxvt (murxvt) terminal as an example
+embedding application.
 =item How do I know which rxvt-unicode version I'm using?
 The version number is displayed with the usage (-h). Also the escape
-sequence C<ESC [ 8 n> sets the window title to the version number.
+sequence C<ESC [ 8 n> sets the window title to the version number. When
+using the @@RXVT_NAME@@c client, the version displayed is that of the
+daemon.
 =item I am using Debian GNU/Linux and have a problem...
-The Debian GNU/Linux package of rxvt-unicode contains large patches that
+The Debian GNU/Linux package of rxvt-unicode in sarge contains large
-considerably change the behaviour of rxvt-unicode. Before reporting a
+patches that considerably change the behaviour of rxvt-unicode (but
+unfortunately this notice has been removed). Before reporting a bug to
-bug to the original rxvt-unicode author please download and install the
+the original rxvt-unicode author please download and install the genuine
-genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to
+version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
-reproduce the problem. If you cannot, chances are that the problems are
+the problem. If you cannot, chances are that the problems are specific to
-specific to Debian GNU/Linux, in which case it should be reported via the
+Debian GNU/Linux, in which case it should be reported via the Debian Bug
-Debian Bug Tracking System (use C<reportbug> to report the bug).
+Tracking System (use C<reportbug> to report the bug).
 For other problems that also affect the Debian package, you can and
 probably should use the Debian BTS, too, because, after all, it's also a
 bug in the Debian version and it serves as a reminder for other users that
 might encounter the same issue.
+=item I am maintaining rxvt-unicode for distribution/OS XXX, any
+recommendation?
+You should build one binary with the default options. F<configure>
+now enables most useful options, and the trend goes to making them
+runtime-switchable, too, so there is usually no drawback to enbaling them,
+except higher disk and possibly memory usage. The perl interpreter should
+be enabled, as important functionality (menus, selection, likely more in
+the future) depends on it.
+You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
+system-wide (except maybe with C<defaults>). This will result in useful
+behaviour. If your distribution aims at low memory, add an empty
+C<perl-ext-common> resource to the app-defaults file. This will keep the
+perl interpreter disabled until the user enables it.
+If you can/want build more binaries, I recommend building a minimal
+one with C<--disable-everything> (very useful) and a maximal one with
+C<--enable-everything> (less useful, it will be very big due to a lot of
+encodings built-in that increase download times and are rarely used).
+=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
+It should be, starting with release 7.1. You are encouraged to properly
+install urxvt with privileges necessary for your OS now.
+When rxvt-unicode detects that it runs setuid or setgid, it will fork
+into a helper process for privileged operations (pty handling on some
+systems, utmp/wtmp/lastlog handling on others) and drop privileges
+immediately. This is much safer than most other terminals that keep
+privileges while running (but is more relevant to urxvt, as it contains
+things as perl interpreters, which might be "helpful" to attackers).
+This forking is done as the very first within main(), which is very early
+and reduces possible bugs to initialisation code run before main(), or
+things like the dynamic loader of your system, which should result in very
+little risk.
 =item When I log-in to another system it tells me about missing terminfo data?
 The terminal description used by rxvt-unicode is not as widely available
 as that for xterm, or even rxvt (for which the same problem often arises).
    URxvt.termName: rxvt
 If you don't plan to use B<rxvt> (quite common...) you could also replace
 the rxvt terminfo file with the rxvt-unicode one.
+=item C<tic> outputs some error when compiling the terminfo entry.
+Most likely it's the empty definition for C<enacs=>. Just replace it by
+C<enacs=\E[0@> and try again.
 =item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
 =item I need a termcap file entry.
 might be forced to use a different font.
 All of this is not a problem when using X11 core fonts, as their bounding
 box data is correct.
+=item On Solaris 9, many line-drawing characters are too wide.
+Seems to be a known bug, read
+L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
+following ugly workaround to get non-double-wide-characters working:
+   #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
 =item My Compose (Multi_key) key is no longer working.
 The most common causes for this are that either your locale is not set
 correctly, or you specified a B<preeditStyle> that is not supported by
 your input method. For example, if you specified B<OverTheSpot> and
 As you might have guessed, FreeBSD does neither define this symobl nor
 does it support it. Instead, it uses it's own internal representation of
 B<wchar_t>. This is, of course, completely fine with respect to standards.
+However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
+C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
-However, C<__STDC_ISO_10646__> is the only sane way to support
+C<__STDC_ISO_10646__> is the only sane way to support multi-language
-multi-language apps in an OS, as using a locale-dependent (and
+apps in an OS, as using a locale-dependent (and non-standardized)
-non-standardized) representation of B<wchar_t> makes it impossible to
+representation of B<wchar_t> makes it impossible to convert between
-convert between B<wchar_t> (as used by X11 and your applications) and any
+B<wchar_t> (as used by X11 and your applications) and any other encoding
-other encoding without implementing OS-specific-wrappers for each and
+without implementing OS-specific-wrappers for each and every locale. There
-every locale. There simply are no APIs to convert B<wchar_t> into anything
+simply are no APIs to convert B<wchar_t> into anything except the current
-except the current locale encoding.
+locale encoding.
 Some applications (such as the formidable B<mlterm>) work around this
 by carrying their own replacement functions for character set handling
 with them, and either implementing OS-dependent hacks or doing multiple
 conversions (which is slow and unreliable in case the OS implements
 encodings slightly different than the terminal emulator).
 The rxvt-unicode author insists that the right way to fix this is in the
 system libraries once and for all, instead of forcing every app to carry
 complete replacements for them :)
+=item I use Solaris 9 and it doesn't compile/work/etc.
+Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
+problems with C<wcwidth> and a compile problem.
+=item How can I use rxvt-unicode under cygwin?
+rxvt-unicode should compile and run out of the box on cygwin, using
+the X11 libraries that come with cygwin. libW11 emulation is no
+longer supported (and makes no sense, either, as it only supported a
+single font). I recommend starting the X-server in C<-multiwindow> or
+C<-rootless> mode instead, which will result in similar look&feel as the
+old libW11 emulation.
+At the time of this writing, cygwin didn't seem to support any multi-byte
+encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
+to 8-bit encodings.
 =item How does rxvt-unicode determine the encoding to use?
 =item Is there an option to switch encodings?
 =item My input method wants <some encoding> but I want UTF-8, what can I do?
 You can specify separate locales for the input method and the rest of the
 terminal, using the resource C<imlocale>:
-   URxvt*imlocale: ja_JP.EUC-JP
+   URxvt.imlocale: ja_JP.EUC-JP
 Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
 use your input method. Please note, however, that you will not be able to
 input characters outside C<EUC-JP> in a normal way then, as your input
 method limits you.
 =item Can I speed up Xft rendering somehow?
 Yes, the most obvious way to speed it up is to avoid Xft entirely, as
 it is simply slow. If you still want Xft fonts you might try to disable
-antialiasing (by appending C<:antialiasing=false>), which saves lots of
+antialiasing (by appending C<:antialias=false>), which saves lots of
 memory and also speeds up rendering considerably.
 =item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
 Rxvt-unicode will use whatever you specify as a font. If it needs to
 Make sure that mouse reporting is actually turned off since killing
 some editors prematurely may leave the mouse in mouse report mode. I've
 heard that tcsh may use mouse reporting unless it otherwise specified. A
 quick check is to see if cut/paste works when the Alt or Shift keys are
-depressed. See @@RXVT_NAME@@(7)
+depressed.
 =item What's with this bold/blink stuff?
 If no bold colour is set via C<colorBD:>, bold will invert text using the
 standard foreground colour.
    URxvt.color7:       #e1dddd
    URxvt.color15:      #e1dddd
 =item How can I start @@RXVT_NAME@@d in a race-free way?
-Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
+Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
-server that answers @@RXVT_NAME@@c's requests, so it doesn't background
+display, create the listening socket and then fork.
-itself.
-To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
-following method to wait for the startup message before continuing:
-  { @@RXVT_NAME@@d & } | read
 =item What's with the strange Backspace/Delete key behaviour?
 Assuming that the physical Backspace key corresponds to the
 BackSpace keysym (not likely for Linux ... see the following
    # use Backspace = ^?
    $ stty erase ^?
    $ @@RXVT_NAME@@
-Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
+Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
 For an existing rxvt-unicode:
    # use Backspace = ^H
    $ stty erase ^H
 =head1 DESCRIPTION
 The rest of this document describes various technical aspects of
 B<rxvt-unicode>. First the description of supported command sequences,
-followed by menu and pixmap support and last by a description of all
+followed by pixmap support and last by a description of all features
-features selectable at C<configure> time.
+selectable at C<configure> time.
 =head1 Definitions
 =over 4
 	B<< C<h> >>	Send Mouse X & Y on button press.
 	B<< C<l> >>	No mouse reporting.
 =end table
-=item B<< C<Ps = 10> >> (B<rxvt>)
-=begin table
-	B<< C<h> >>	menuBar visible
-	B<< C<l> >>	menuBar invisible
-=end table
 =item B<< C<Ps = 25> >>
 =begin table
 	B<< C<h> >>	Visible cursor {cnorm/cvvis}
 =begin table
 	B<< C<h> >>	Scroll to bottom when a key is pressed
 	B<< C<l> >>	Don't scroll to bottom when a key is pressed
+=end table
+=item B<< C<Ps = 1021> >> (B<rxvt>)
+=begin table
+	B<< C<h> >>	Bold/italic implies high intensity (see option B<-is>)
+	B<< C<l> >>	Font styles have no effect on intensity (Compile styles)
 =end table
 =item B<< C<Ps = 1047> >>
 	B<< C<Ps = 10> >>	Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
 	B<< C<Ps = 11> >>	Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
 	B<< C<Ps = 12> >>	Change colour of text cursor foreground to B<< C<Pt> >>
 	B<< C<Ps = 13> >>	Change colour of mouse foreground to B<< C<Pt> >>
 	B<< C<Ps = 17> >>	Change colour of highlight characters to B<< C<Pt> >>
-	B<< C<Ps = 18> >>	Change colour of bold characters to B<< C<Pt> >>
+	B<< C<Ps = 18> >>	Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
-	B<< C<Ps = 19> >>	Change colour of underlined characters to B<< C<Pt> >>
+	B<< C<Ps = 19> >>	Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
-	B<< C<Ps = 20> >>	Change default background to B<< C<Pt> >>
+	B<< C<Ps = 20> >>	Change background pixmap parameters (see section XPM) (Compile XPM).
 	B<< C<Ps = 39> >>	Change default foreground colour to B<< C<Pt> >>.
 	B<< C<Ps = 46> >>	Change Log File to B<< C<Pt> >> I<unimplemented>
 	B<< C<Ps = 49> >>	Change default background colour to B<< C<Pt> >>.
 	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> >>
 	B<< C<Ps = 55> >>	Log all scrollback buffer and all of screen to B<< C<Pt> >>
 	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).
-	B<< C<Ps = 703> >>	Menubar command B<< C<Pt> >> (Compile menubar).
 	B<< C<Ps = 704> >>	Change colour of italic characters to B<< C<Pt> >>
 	B<< C<Ps = 705> >>	Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
+	B<< C<Ps = 706> >>	Change colour of bold characters to B<< C<Pt> >>
+	B<< C<Ps = 707> >>	Change colour of underlined characters to B<< C<Pt> >>
 	B<< C<Ps = 710> >>	Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
 	B<< C<Ps = 711> >>	Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
 	B<< C<Ps = 712> >>	Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
 	B<< C<Ps = 713> >>	Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
 	B<< C<Ps = 720> >>	Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
 	B<< C<Ps = 721> >>	Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
+	B<< C<Ps = 777> >>	Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
 =end table
 =back
-X<menuBar>
-=head1 menuBar
-B<< The exact syntax used is I<almost> solidified. >>
-In the menus, B<DON'T> try to use menuBar commands that add or remove a
-menuBar.
-Note that in all of the commands, the B<< I</path/> >> I<cannot> be
-omitted: use B<./> to specify a menu relative to the current menu.
-=head2 Overview of menuBar operation
-For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
-of C<Pt> can be used for a variety of tasks:
-At the top level is the current menuBar which is a member of a circular
-linked-list of other such menuBars.
-The menuBar acts as a parent for the various drop-down menus, which in
-turn, may have labels, separator lines, menuItems and subMenus.
-The menuItems are the useful bits: you can use them to mimic keyboard
-input or even to send text or escape sequences back to rxvt.
-The menuBar syntax is intended to provide a simple yet robust method of
-constructing and manipulating menus and navigating through the
-menuBars.
-The first step is to use the tag B<< [menu:I<name>] >> which creates
-the menuBar called I<name> and allows access. You may now or menus,
-subMenus, and menuItems. Finally, use the tag B<[done]> to set the
-menuBar access as B<readonly> to prevent accidental corruption of the
-menus. To re-access the current menuBar for alterations, use the tag
-B<[menu]>, make the alterations and then use B<[done]>
-X<menuBarCommands>
-=head2 Commands
-=over 4
-=item B<< [menu:+I<name>] >>
-access the named menuBar for creation or alteration. If a new menuBar
-is created, it is called I<name> (max of 15 chars) and the current
-menuBar is pushed onto the stack
-=item B<[menu]>
-access the current menuBar for alteration
-=item B<< [title:+I<string>] >>
-set the current menuBar's title to I<string>, which may contain the
-following format specifiers:
-   B<%n>  rxvt name (as per the B<-name> command-line option)
-   B<%v>  rxvt version
-   B<%%>  literal B<%> character
-=item B<[done]>
-set menuBar access as B<readonly>.
-End-of-file tag for B<< [read:+I<file>] >> operations.
-=item B<< [read:+I<file>] >>
-read menu commands directly from I<file> (extension ".menu" will be
-appended if required.) Start reading at a line with B<[menu]> or B<<
-[menu:+I<name> >> and continuing until B<[done]> is encountered.
-Blank and comment lines (starting with B<#>) are ignored. Actually,
-since any invalid menu commands are also ignored, almost anything could
-be construed as a comment line, but this may be tightened up in the
-future ... so don't count on it!.
-=item B<< [read:+I<file>;+I<name>] >>
-The same as B<< [read:+I<file>] >>, but start reading at a line with
-B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
-B<[done]> is encountered.
-=item B<[dump]>
-dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
-later rereading.
-=item B<[rm:name]>
-remove the named menuBar
-=item B<[rm] [rm:]>
-remove the current menuBar
-=item B<[rm*] [rm:*]>
-remove all menuBars
-=item B<[swap]>
-swap the top two menuBars
-=item B<[prev]>
-access the previous menuBar
-=item B<[next]>
-access the next menuBar
-=item B<[show]>
-Enable display of the menuBar
-=item B<[hide]>
-Disable display of the menuBar
-=item B<< [pixmap:+I<name>] >>
-=item B<< [pixmap:+I<name>;I<scaling>] >>
-(set the background pixmap globally
-B<< A Future implementation I<may> make this local to the menubar >>)
-=item B<< [:+I<command>:] >>
-ignore the menu readonly status and issue a I<command> to or a menu or
-menuitem or change the ; a useful shortcut for setting the quick arrows
-from a menuBar.
-=back
-X<menuBarAdd>
-=head2 Adding and accessing menus
-The following commands may also be B<+> prefixed.
-=over 4
-=item B</+>
-access menuBar top level
-=item B<./+>
-access current menu level
-=item B<../+>
-access parent menu (1 level up)
-=item B<../../>
-access parent menu (multiple levels up)
-=item B<< I</path/>menu >>
-add/access menu
-=item B<< I</path/>menu/* >>
-add/access menu and clear it if it exists
-=item B<< I</path/>{-} >>
-add separator
-=item B<< I</path/>{item} >>
-add B<item> as a label
-=item B<< I</path/>{item} action >>
-add/alter I<menuitem> with an associated I<action>
-=item B<< I</path/>{item}{right-text} >>
-add/alter I<menuitem> with B<right-text> as the right-justified text
-and as the associated I<action>
-=item B<< I</path/>{item}{rtext} action >>
-add/alter I<menuitem> with an associated I<action> and with B<rtext> as
-the right-justified text.
-=back
-=over 4
-=item Special characters in I<action> must be backslash-escaped:
-B<\a \b \E \e \n \r \t \octal>
-=item or in control-character notation:
-B<^@, ^A .. ^Z .. ^_, ^?>
-=back
-To send a string starting with a B<NUL> (B<^@>) character to the
-program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
-the first of which will be stripped off and the balance directed to the
-program. Otherwise if I<action> begins with B<NUL> followed by
-non-+B<NUL> characters, the leading B<NUL> is stripped off and the
-balance is sent back to rxvt.
-As a convenience for the many Emacs-type editors, I<action> may start
-with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
-appended if missed from B<M-x> commands.
-As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
-quick arrow), a B<BEL> (B<^G>) will be appended if needed.
-=over 4
-=item For example,
-B<M-xapropos> is equivalent to B<\Exapropos\r>
-=item and
-B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
-=back
-The option B<< {I<right-rtext>} >> will be right-justified. In the
-absence of a specified action, this text will be used as the I<action>
-as well.
-=over 4
-=item For example,
-B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
-=back
-The left label I<is> necessary, since it's used for matching, but
-implicitly hiding the left label (by using same name for both left and
-right labels), or explicitly hiding the left label (by preceeding it
-with a dot), makes it possible to have right-justified text only.
-=over 4
-=item For example,
-B</File/{Open}{Open} Open-File-Action>
-=item or hiding it
-B</File/{.anylabel}{Open} Open-File-Action>
-=back
-X<menuBarRemove>
-=head2 Removing menus
-=over 4
-=item B<< -/*+ >>
-remove all menus from the menuBar, the same as B<[clear]>
-=item B<< -+I</path>menu+ >>
-remove menu
-=item B<< -+I</path>{item}+ >>
-remove item
-=item B<< -+I</path>{-} >>
-remove separator)
-=item B<-/path/menu/*>
-remove all items, separators and submenus from menu
-=back
-X<menuBarArrows>
-=head2 Quick Arrows
-The menus also provide a hook for I<quick arrows> to provide easier
-user access. If nothing has been explicitly set, the default is to
-emulate the curror keys. The syntax permits each arrow to be altered
-individually or all four at once without re-entering their common
-beginning/end text. For example, to explicitly associate cursor actions
-with the arrows, any of the following forms could be used:
-=over 4
-=item B<< <r>+I<Right> >>
-=item B<< <l>+I<Left> >>
-=item B<< <u>+I<Up> >>
-=item B<< <d>+I<Down> >>
-Define actions for the respective arrow buttons
-=item B<< <b>+I<Begin> >>
-=item B<< <e>+I<End> >>
-Define common beginning/end parts for I<quick arrows> which used in
-conjunction with the above <r> <l> <u> <d> constructs
-=back
-=over 4
-=item For example, define arrows individually,
- <u>\E[A
- <d>\E[B
- <r>\E[C
- <l>\E[D
-=item or all at once
- <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
-=item or more compactly (factoring out common parts)
- <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
-=back
-X<menuBarSummary>
-=head2 Command Summary
-A short summary of the most I<common> commands:
-=over 4
-=item [menu:name]
-use an existing named menuBar or start a new one
-=item [menu]
-use the current menuBar
-=item [title:string]
-set menuBar title
-=item [done]
-set menu access to readonly and, if reading from a file, signal EOF
-=item [done:name]
-if reading from a file using [read:file;name] signal EOF
-=item [rm:name]
-remove named menuBar(s)
-=item [rm] [rm:]
-remove current menuBar
-=item [rm*] [rm:*]
-remove all menuBar(s)
-=item [swap]
-swap top two menuBars
-=item [prev]
-access the previous menuBar
-=item [next]
-access the next menuBar
-=item [show]
-map menuBar
-=item [hide]
-unmap menuBar
-=item [pixmap;file]
-=item [pixmap;file;scaling]
-set a background pixmap
-=item [read:file]
-=item [read:file;name]
-read in a menu from a file
-=item [dump]
-dump out all menuBars to /tmp/rxvt-PID
-=item /
-access menuBar top level
-=item ./
-=item ../
-=item ../../
-access current or parent menu level
-=item /path/menu
-add/access menu
-=item /path/{-}
-add separator
-=item /path/{item}{rtext} action
-add/alter menu item
-=item -/*
-remove all menus from the menuBar
-=item -/path/menu
-remove menu items, separators and submenus from menu
-=item -/path/menu
-remove menu
-=item -/path/{item}
-remove item
-=item -/path/{-}
-remove separator
-=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
-menu quick arrows
-=back
 X<XPM>
 =head1 XPM
 For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
 =end table
 =head1 CONFIGURE OPTIONS
 General hint: if you get compile errors, then likely your configuration
-hasn't been tested well. Either try with --enable-everything or use the
+hasn't been tested well. Either try with C<--enable-everything> or use
-./reconf script as a base for experiments. ./reconf is used by myself,
+the F<./reconf> script as a base for experiments. F<./reconf> is used by
-so it should generally be a working config. Of course, you should always
+myself, so it should generally be a working config. Of course, you should
-report when a combination doesn't work, so it can be fixed. Marc Lehmann
+always report when a combination doesn't work, so it can be fixed. Marc
-<rxvt@schmorp.de>.
+Lehmann <rxvt@schmorp.de>.
+All
 =over 4
 =item --enable-everything
-Add support for all non-multichoice options listed in "./configure
+Add (or remove) support for all non-multichoice options listed in "./configure
---help". Note that unlike other enable options this is order dependant.
+--help".
-You can specify this and then disable options which this enables by
+You can specify this and then disable options you do not like by
-I<following> this with the appropriate commands.
+I<following> this with the appropriate C<--disable-...> arguments,
+or you can start with a minimal configuration by specifying
+C<--disable-everything> and than adding just the C<--enable-...> arguments
+you want.
-=item --enable-xft
+=item --enable-xft (default: enabled)
 Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
 slower and require lots of memory, but as long as you don't use them, you
 don't pay for them.
-=item --enable-font-styles
+=item --enable-font-styles (default: on)
 Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
 styles. The fonts can be set manually or automatically.
-=item --with-codesets=NAME,...
+=item --with-codesets=NAME,... (default: all)
-Compile in support for additional codeset (encoding) groups (eu, vn are
+Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
-always compiled in, which includes most 8-bit character sets). These
+are always compiled in, which includes most 8-bit character sets). These
-codeset tables are currently only used for driving X11 core fonts, they
+codeset tables are used for driving X11 core fonts, they are not required
-are not required for Xft fonts. Compiling them in will make your binary
+for Xft fonts, although having them compiled in lets rxvt-unicode choose
-bigger (together about 700kB), but it doesn't increase memory usage unless
+replacement fonts more intelligently. Compiling them in will make your
+binary bigger (all of together cost about 700kB), but it doesn't increase
-you use an X11 font requiring one of these encodings.
+memory usage unless you use a font requiring one of these encodings.
 =begin table
 	all	all available codeset groups
 	zh	common chinese encodings
 	jp_ext	rarely used but big japanese encodings
 	kr	korean encodings
 =end table
-=item --enable-xim
+=item --enable-xim (default: on)
 Add support for XIM (X Input Method) protocol. This allows using
 alternative input methods (e.g. kinput2) and will also correctly
 set up the input for people using dead keys or compose keys.
-=item --enable-unicode3
+=item --enable-unicode3 (default: off)
+Recommended to stay off unless you really need non-BMP characters.
 Enable direct support for displaying unicode codepoints above
 65535 (the basic multilingual page). This increases storage
 requirements per character from 2 to 4 bytes. X11 fonts do not yet
 support these extra characters, but Xft does.
 even without this flag, but the number of such characters is
 limited to a view thousand (shared with combining characters,
 see next switch), and right now rxvt-unicode cannot display them
 (input/output and cut&paste still work, though).
-=item --enable-combining
+=item --enable-combining (default: on)
 Enable automatic composition of combining characters into
 composite characters. This is required for proper viewing of text
 where accents are encoded as seperate unicode characters. This is
 done by using precomposited characters when available or creating
 new pseudo-characters when no precomposed form exists.
-Without --enable-unicode3, the number of additional precomposed characters
+Without --enable-unicode3, the number of additional precomposed
-is rather limited (2048, if this is full, rxvt-unicode will use the
+characters is somewhat limited (the 6400 private use characters will be
-private use area, extending the number of combinations to 8448). With
---enable-unicode3, no practical limit exists.
+(ab-)used). With --enable-unicode3, no practical limit exists.
 This option will also enable storage (but not display) of characters
 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
 The combining table also contains entries for arabic presentation forms,
 but these are not currently used. Bug me if you want these to be used (and
 tell me how these are to be used...).
-=item --enable-fallback(=CLASS)
+=item --enable-fallback(=CLASS) (default: Rxvt)
-When reading resource settings, also read settings for class CLASS
+When reading resource settings, also read settings for class CLASS. To
-(default: Rxvt). To disable resource fallback use --disable-fallback.
+disable resource fallback use --disable-fallback.
-=item --with-res-name=NAME
+=item --with-res-name=NAME (default: urxvt)
-Use the given name (default: urxvt) as default application name when
+Use the given name as default application name when
 reading resources. Specify --with-res-name=rxvt to replace rxvt.
-=item --with-res-class=CLASS
+=item --with-res-class=CLASS /default: URxvt)
-Use the given class (default: URxvt) as default application class
+Use the given class as default application class
-when reading resources.  Specify --with-res-class=Rxvt to replace
+when reading resources. Specify --with-res-class=Rxvt to replace
 rxvt.
-=item --enable-utmp
+=item --enable-utmp (default: on)
 Write user and tty to utmp file (used by programs like F<w>) at
 start of rxvt execution and delete information when rxvt exits.
-=item --enable-wtmp
+=item --enable-wtmp (default: on)
 Write user and tty to wtmp file (used by programs like F<last>) at
 start of rxvt execution and write logout when rxvt exits.  This
 option requires --enable-utmp to also be specified.
-=item --enable-lastlog
+=item --enable-lastlog (default: on)
 Write user and tty to lastlog file (used by programs like
 F<lastlogin>) at start of rxvt execution.  This option requires
 --enable-utmp to also be specified.
-=item --enable-xpm-background
+=item --enable-xpm-background (default: on)
 Add support for XPM background pixmaps.
-=item --enable-transparency
+=item --enable-transparency (default: on)
 Add support for inheriting parent backgrounds thus giving a fake
 transparency to the term.
-=item --enable-fading
+=item --enable-fading (default: on)
-Add support for fading the text when focus is lost.
+Add support for fading the text when focus is lost (requires C<--enable-transparency>).
-=item --enable-tinting
+=item --enable-tinting (default: on)
-Add support for tinting of transparent backgrounds.
+Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
-=item --enable-menubar
-Add support for our menu bar system (this interacts badly with
-dynamic locale switching currently).
-=item --enable-rxvt-scroll
+=item --enable-rxvt-scroll (default: on)
 Add support for the original rxvt scrollbar.
-=item --enable-next-scroll
+=item --enable-next-scroll (default: on)
 Add support for a NeXT-like scrollbar.
-=item --enable-xterm-scroll
+=item --enable-xterm-scroll (default: on)
 Add support for an Xterm-like scrollbar.
-=item --enable-plain-scroll
+=item --enable-plain-scroll (default: on)
 Add support for a very unobtrusive, plain-looking scrollbar that
 is the favourite of the rxvt-unicode author, having used it for
 many years.
-=item --enable-half-shadow
+=item --enable-ttygid (default: off)
-Make shadows on the scrollbar only half the normal width & height.
-only applicable to rxvt scrollbars.
-=item --enable-ttygid
 Change tty device setting to group "tty" - only use this if
 your system uses this type of security.
 =item --disable-backspace-key
-Disable any handling of the backspace key by us - let the X server
+Removes any handling of the backspace key by us - let the X server do it.
+=item --disable-delete-key
+Removes any handling of the delete key by us - let the X server
 do it.
-=item --disable-delete-key
-Disable any handling of the delete key by us - let the X server
-do it.
 =item --disable-resources
-Remove all resources checking.
+Removes any support for resource checking.
-=item --enable-xgetdefault
-Make resources checking via XGetDefault() instead of our small
-version which only checks ~/.Xdefaults, or if that doesn't exist then
-~/.Xresources.
-Please note that nowadays, things like XIM will automatically pull in and
-use the full X resource manager, so the overhead of using it might be very
-small, if nonexistant.
-=item --enable-strings
-Add support for our possibly faster memset() function and other
-various routines, overriding your system's versions which may
-have been hand-crafted in assembly or may require extra libraries
-to link in. (this breaks ANSI-C rules and has problems on many
-GNU/Linux systems).
 =item --disable-swapscreen
-Remove support for swap screen.
+Remove support for secondary/swap screen.
-=item --enable-frills
+=item --enable-frills (default: on)
 Add support for many small features that are not essential but nice to
 have. Normally you want this, but for very small binaries you may want to
 disable this.
 A non-exhaustive list of features enabled by C<--enable-frills> (possibly
 in combination with other switches) is:
   MWM-hints
   EWMH-hints (pid, utf8 names) and protocols (ping)
-  seperate underline colour
+  seperate underline colour (-underlineColor)
-  settable border widths and borderless switch
+  settable border widths and borderless switch (-w, -b, -bl)
-  settable extra linespacing
+  settable extra linespacing /-lsp)
   iso-14755-2 and -3, and visual feedback
   backindex and forwardindex escape sequence
   window op and some xterm/OSC escape sequences
-  tripleclickwords
+  tripleclickwords (-tcw)
-  settable insecure mode
+  settable insecure mode (-insecure)
   keysym remapping support
-  -embed and -pty-fd options
+  cursor blinking and underline cursor (-cb, -uc)
+  XEmbed support (-embed)
+  user-pty (-pty-fd)
+  hold on exit (-hold)
+  skip builtin block graphics (-sbg)
+  sgr modes 90..97 and 100..107
-=item --enable-iso14755
+=item --enable-iso14755 (default: on)
 Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
 F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
 C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
 this switch.
-=item --enable-keepscrolling
+=item --enable-keepscrolling (default: on)
 Add support for continual scrolling of the display when you hold
 the mouse button down on a scrollbar arrow.
-=item --enable-mousewheel
+=item --enable-mousewheel (default: on)
 Add support for scrolling via mouse wheel or buttons 4 & 5.
-=item --enable-slipwheeling
+=item --enable-slipwheeling (default: on)
 Add support for continual scrolling (using the mouse wheel as an
 accelerator) while the control key is held down.  This option
 requires --enable-mousewheel to also be specified.
 =item --disable-new-selection
 Remove support for mouse selection style like that of xterm.
-=item --enable-dmalloc
+=item --enable-dmalloc (default: off)
 Use Gray Watson's malloc - which is good for debugging See
 http://www.letters.com/dmalloc/ for details If you use either this or the
 next option, you may need to edit src/Makefile after compiling to point
 DINCLUDE and DLIB to the right places.
 You can only use either this option and the following (should
 you use either) .
-=item --enable-dlmalloc
+=item --enable-dlmalloc (default: off)
 Use Doug Lea's malloc - which is good for a production version
 See L<http://g.oswego.edu/dl/html/malloc.html> for details.
-=item --enable-smart-resize
+=item --enable-smart-resize (default: on)
-Add smart growth/shrink behaviour when changing font size via from hot
+Add smart growth/shrink behaviour when changing font size via hot
-keys. This should keep in a fixed position the rxvt corner which is
+keys. This should keep the window corner which is closest to a corner of
-closest to a corner of the screen.
+the screen in a fixed position.
-=item --enable-cursor-blink
-Add support for a blinking cursor.
-=item --enable-pointer-blank
+=item --enable-pointer-blank (default: on)
 Add support to have the pointer disappear when typing or inactive.
-=item --with-name=NAME
+=item --enable-perl (default: on)
+Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
+manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
+in F<src/perl-ext/> for the extensions that are installed by default. The
+perl interpreter that is used can be specified via the C<PERL> environment
+variable when running configure.
+=item --with-name=NAME (default: urxvt)
-Set the basename for the installed binaries (default: C<urxvt>, resulting
+Set the basename for the installed binaries, resulting
 in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
 C<rxvt>.
-=item --with-term=NAME
+=item --with-term=NAME (default: rxvt-unicode)
-Change the environmental variable for the terminal to NAME (default
+Change the environmental variable for the terminal to NAME.
-C<rxvt-unicode>)
 =item --with-terminfo=PATH
 Change the environmental variable for the path to the terminfo tree to
 PATH.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.51 by root, Mon Feb 21 19:26:06 2005 UTC vs. Revision 1.90 by root, Mon Jan 23 01:46:55 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.51 by root, Mon Feb 21 19:26:06 2005 UTC vs.
Revision 1.90 by root, Mon Jan 23 01:46:55 2006 UTC