ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.man.in (file contents):
Revision 1.14 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.58 by root, Tue Jan 31 00:56:07 2006 UTC

127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 7" 131.IX Title "rxvt 7"
132.TH rxvt 7 "2005-02-14" "" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-31" "7.5" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134RXVT REFERENCE \- FAQ, command sequences and other background information 134RXVT REFERENCE \- FAQ, command sequences and other background information
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 2 137.Vb 2
151.SH "DESCRIPTION" 151.SH "DESCRIPTION"
152.IX Header "DESCRIPTION" 152.IX Header "DESCRIPTION"
153This document contains the \s-1FAQ\s0, the \s-1RXVT\s0 \s-1TECHNICAL\s0 \s-1REFERENCE\s0 documenting 153This document contains the \s-1FAQ\s0, the \s-1RXVT\s0 \s-1TECHNICAL\s0 \s-1REFERENCE\s0 documenting
154all escape sequences, and other background information. 154all escape sequences, and other background information.
155.PP 155.PP
156The newest version of this document is 156The newest version of this document is also available on the World Wide Web at
157also available on the World Wide Web at
158<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>. 157<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
159.SH "FREQUENTLY ASKED QUESTIONS" 158.SH "FREQUENTLY ASKED QUESTIONS"
160.IX Header "FREQUENTLY ASKED QUESTIONS" 159.IX Header "FREQUENTLY ASKED QUESTIONS"
160.Sh "The new selection selects pieces that are too big, how can I select single words?"
161.IX Subsection "The new selection selects pieces that are too big, how can I select single words?"
162Yes. For example, if you want to select alphanumeric words, you can use
163the following resource:
164.PP
165.Vb 1
166\& URxvt.selection.pattern-0: ([[:word:]]+)
167.Ve
168.PP
169If you click more than twice, the selection will be extended
170more and more.
171.PP
172To get a selection that is very similar to the old code, try this pattern:
173.PP
174.Vb 1
175\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+)
176.Ve
177.PP
178Please also note that the \fILeftClick Shift-LeftClik\fR combination also
179selects words like the old code.
180.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4
181.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?"
182You can disable the perl extension completely by setting the
183\&\fBperl-ext-common\fR resource to the empty string, which also keeps
184rxvt-unicode from initialising perl, saving memory.
185.Sp
186If you only want to disable specific features, you first have to
187identify which perl extension is responsible. For this, read the section
188\&\fB\s-1PREPACKAGED\s0 \s-1EXTENSIONS\s0\fR in the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. For
189example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify
190this \fBperl-ext-common\fR resource:
191.Sp
192.Vb 1
193\& URxvt.perl-ext-common: default,-selection-popup,-option-popup
194.Ve
195.Sp
196This will keep the default extensions, but disable the two popup
197extensions. Some extensions can also be configured, for example,
198scrollback search mode is triggered by \fBM\-s\fR. You can move it to any
199other combination either by setting the \fBsearchable-scrollback\fR resource:
200.Sp
201.Vb 1
202\& URxvt.searchable-scrollback: CM-s
203.Ve
204.IP "The cursor moves when selecting text in the current input line, how do I switch this off?" 4
205.IX Item "The cursor moves when selecting text in the current input line, how do I switch this off?"
206.PD 0
207.IP "During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?" 4
208.IX Item "During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?"
209.PD
210These are caused by the \f(CW\*(C`readline\*(C'\fR perl extension. Under normal
211circumstances, it will move your cursor around when you click into the
212line that contains it. It tries hard not to do this at the wrong moment,
213but when running a program that doesn't parse cursor movements or in some
214cases during rlogin sessions, it fails to detect this properly.
215.Sp
216You can permamently switch this feature off by disabling the \f(CW\*(C`readline\*(C'\fR
217extension:
218.Sp
219.Vb 1
220\& URxvt.perl-ext-common: default,-readline
221.Ve
222.IP "Why doesn't rxvt-unicode read my resources?" 4
223.IX Item "Why doesn't rxvt-unicode read my resources?"
224Well, why, indeed? It does, in a way very similar to other X
225applications. Most importantly, this means that if you or your \s-1OS\s0 loads
226resources into the X display (the right way to do it), rxvt-unicode will
227ignore any resource files in your home directory. It will only read
228\&\fI$HOME/.Xdefaults\fR when no resources are attached to the display.
229.Sp
230If you have or use an \fI$HOME/.Xresources\fR file, chances are that
231resources are loaded into your X\-server. In this case, you have to
232re-login after every change (or run \fIxrdb \-merge \f(CI$HOME\fI/.Xresources\fR).
233.Sp
234Also consider the form resources have to use:
235.Sp
236.Vb 1
237\& URxvt.resource: value
238.Ve
239.Sp
240If you want to use another form (there are lots of different ways of
241specifying resources), make sure you understand wether and why it
242works. If unsure, use the form above.
243.IP "I can't get transparency working, what am I doing wrong?" 4
244.IX Item "I can't get transparency working, what am I doing wrong?"
245First of all, transparency isn't officially supported in rxvt\-unicode, so
246you are mostly on your own. Do not bug the author about it (but you may
247bug everybody else). Also, if you can't get it working consider it a rite
248of passage: ... and you failed.
249.Sp
250Here are four ways to get transparency. \fBDo\fR read the manpage and option
251descriptions for the programs mentioned and rxvt\-unicode. Really, do it!
252.Sp
2531. Use inheritPixmap:
254.Sp
255.Vb 2
256\& Esetroot wallpaper.jpg
257\& @@RXVT_NAME@@ -ip -tint red -sh 40
258.Ve
259.Sp
260That works. If you think it doesn't, you lack transparency and tinting
261support, or you are unable to read.
262.Sp
2632. Use a simple pixmap and emulate pseudo\-transparency. This enables you
264to use effects other than tinting and shading: Just shade/tint/whatever
265your picture with gimp:
266.Sp
267.Vb 2
268\& convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
269\& @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
270.Ve
271.Sp
272That works. If you think it doesn't, you lack \s-1XPM\s0 and Perl support, or you
273are unable to read.
274.Sp
2753. Use an \s-1ARGB\s0 visual:
276.Sp
277.Vb 1
278\& @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
279.Ve
280.Sp
281This requires \s-1XFT\s0 support, and the support of your X\-server. If that
282doesn't work for you, blame Xorg and Keith Packard. \s-1ARGB\s0 visuals aren't
283there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
284bugfixes and workarounds for Xft and Xlib to make it work, but that
285doesn't mean that your \s-1WM\s0 has the required kludges in place.
286.Sp
2874. Use xcompmgr and let it do the job:
288.Sp
289.Vb 2
290\& xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \e
291\& -set _NET_WM_WINDOW_OPACITY 0xc0000000
292.Ve
293.Sp
294Then click on a window you want to make transparent. Replace \f(CW0xc0000000\fR
295by other values to change the degree of opacity. If it doesn't work and
296your server crashes, you got to keep the pieces.
297.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4
298.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?"
299I often get asked about this, and I think, no, they didn't cause extra
300bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
301that the urxvt binary is larger (due to some encoding tables always being
302compiled in), but it actually uses less memory (\s-1RSS\s0) after startup. Even
303with \f(CW\*(C`\-\-disable\-everything\*(C'\fR, this comparison is a bit unfair, as many
304features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
305already in use in this mode.
306.Sp
307.Vb 3
308\& text data bss drs rss filename
309\& 98398 1664 24 15695 1824 rxvt --disable-everything
310\& 188985 9048 66616 18222 1788 urxvt --disable-everything
311.Ve
312.Sp
313When you \f(CW\*(C`\-\-enable\-everything\*(C'\fR (which _is_ unfair, as this involves xft
314and full locale/XIM support which are quite bloaty inside libX11 and my
315libc), the two diverge, but not unreasnobaly so.
316.Sp
317.Vb 3
318\& text data bss drs rss filename
319\& 163431 2152 24 20123 2060 rxvt --enable-everything
320\& 1035683 49680 66648 29096 3680 urxvt --enable-everything
321.Ve
322.Sp
323The very large size of the text section is explained by the east-asian
324encoding tables, which, if unused, take up disk space but nothing else
325and can be compiled out unless you rely on X11 core fonts that use those
326encodings. The \s-1BSS\s0 size comes from the 64k emergency buffer that my c++
327compiler allocates (but of course doesn't use unless you are out of
328memory). Also, using an xft font instead of a core font immediately adds a
329few megabytes of \s-1RSS\s0. Xft indeed is responsible for a lot of \s-1RSS\s0 even when
330not used.
331.Sp
332Of course, due to every character using two or four bytes instead of one,
333a large scrollback buffer will ultimately make rxvt-unicode use more
334memory.
335.Sp
336Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
337still fares rather well. And compared to some monsters like gnome-terminal
338(21152k + extra 4204k in separate processes) or konsole (22200k + extra
33943180k in daemons that stay around after exit, plus half a minute of
340startup time, including the hundreds of warnings it spits out), it fares
341extremely well *g*.
342.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4
343.IX Item "Why , isn't that unportable/bloated/uncool?"
344Is this a question? :) It comes up very often. The simple answer is: I had
345to write it, and \*(C+ allowed me to write and maintain it in a fraction
346of the time and effort (which is a scarce resource for me). Put even
347shorter: It simply wouldn't exist without \*(C+.
348.Sp
349My personal stance on this is that \*(C+ is less portable than C, but in
350the case of rxvt-unicode this hardly matters, as its portability limits
351are defined by things like X11, pseudo terminals, locale support and unix
352domain sockets, which are all less portable than \*(C+ itself.
353.Sp
354Regarding the bloat, see the above question: It's easy to write programs
355in C that use gobs of memory, an certainly possible to write programs in
356\&\*(C+ that don't. \*(C+ also often comes with large libraries, but this is
357not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my
358system with a minimal config:
359.Sp
360.Vb 4
361\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
362\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
363\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
364\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
365.Ve
366.Sp
367And here is rxvt\-unicode:
368.Sp
369.Vb 5
370\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
371\& libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
372\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
373\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
374\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
375.Ve
376.Sp
377No large bloated libraries (of course, none were linked in statically),
378except maybe libX11 :)
379.IP "Does it support tabs, can I have a tabbed rxvt\-unicode?" 4
380.IX Item "Does it support tabs, can I have a tabbed rxvt-unicode?"
381Beginning with version 7.3, there is a perl extension that implements a
382simple tabbed terminal. It is installed by default, so any of these should
383give you tabs:
384.Sp
385.Vb 1
386\& @@RXVT_NAME@@ -pe tabbed
387.Ve
388.Sp
389.Vb 1
390\& URxvt.perl-ext-common: default,tabbed
391.Ve
392.Sp
393It will also work fine with tabbing functionality of many window managers
394or similar tabbing programs, and its embedding-features allow it to be
395embedded into other programs, as witnessed by \fIdoc/rxvt\-tabbed\fR or
396the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl module, which features a tabbed urxvt
397(murxvt) terminal as an example embedding application.
161.IP "How do I know which rxvt-unicode version I'm using?" 4 398.IP "How do I know which rxvt-unicode version I'm using?" 4
162.IX Item "How do I know which rxvt-unicode version I'm using?" 399.IX Item "How do I know which rxvt-unicode version I'm using?"
163The version number is displayed with the usage (\-h). Also the escape 400The version number is displayed with the usage (\-h). Also the escape
164sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. 401sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When
402using the @@RXVT_NAME@@c client, the version displayed is that of the
403daemon.
165.IP "I am using Debian GNU/Linux and have a problem..." 4 404.IP "I am using Debian GNU/Linux and have a problem..." 4
166.IX Item "I am using Debian GNU/Linux and have a problem..." 405.IX Item "I am using Debian GNU/Linux and have a problem..."
167The Debian GNU/Linux package of rxvt-unicode contains large patches that 406The Debian GNU/Linux package of rxvt-unicode in sarge contains large
168considerably change the behaviour of rxvt\-unicode. Before reporting a 407patches that considerably change the behaviour of rxvt-unicode (but
408unfortunately this notice has been removed). Before reporting a bug to
169bug to the original rxvt-unicode author please download and install the 409the original rxvt-unicode author please download and install the genuine
170genuine version (<http://software.schmorp.de#rxvt\-unicode>) and try to 410version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce
171reproduce the problem. If you cannot, chances are that the problems are 411the problem. If you cannot, chances are that the problems are specific to
172specific to Debian GNU/Linux, in which case it should be reported via the 412Debian GNU/Linux, in which case it should be reported via the Debian Bug
173Debian Bug Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug). 413Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug).
174.Sp 414.Sp
175For other problems that also affect the Debian package, you can and 415For other problems that also affect the Debian package, you can and
176probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a 416probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a
177bug in the Debian version and it serves as a reminder for other users that 417bug in the Debian version and it serves as a reminder for other users that
178might encounter the same issue. 418might encounter the same issue.
419.IP "I am maintaining rxvt-unicode for distribution/OS \s-1XXX\s0, any recommendation?" 4
420.IX Item "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?"
421You should build one binary with the default options. \fIconfigure\fR
422now enables most useful options, and the trend goes to making them
423runtime\-switchable, too, so there is usually no drawback to enbaling them,
424except higher disk and possibly memory usage. The perl interpreter should
425be enabled, as important functionality (menus, selection, likely more in
426the future) depends on it.
427.Sp
428You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR snd \f(CW\*(C`perl\-ext\*(C'\fR resources
429system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful
430behaviour. If your distribution aims at low memory, add an empty
431\&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the
432perl interpreter disabled until the user enables it.
433.Sp
434If you can/want build more binaries, I recommend building a minimal
435one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with
436\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of
437encodings built-in that increase download times and are rarely used).
438.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4
439.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?"
440It should be, starting with release 7.1. You are encouraged to properly
441install urxvt with privileges necessary for your \s-1OS\s0 now.
442.Sp
443When rxvt-unicode detects that it runs setuid or setgid, it will fork
444into a helper process for privileged operations (pty handling on some
445systems, utmp/wtmp/lastlog handling on others) and drop privileges
446immediately. This is much safer than most other terminals that keep
447privileges while running (but is more relevant to urxvt, as it contains
448things as perl interpreters, which might be \*(L"helpful\*(R" to attackers).
449.Sp
450This forking is done as the very first within \fImain()\fR, which is very early
451and reduces possible bugs to initialisation code run before \fImain()\fR, or
452things like the dynamic loader of your system, which should result in very
453little risk.
179.IP "When I log-in to another system it tells me about missing terminfo data?" 4 454.IP "When I log-in to another system it tells me about missing terminfo data?" 4
180.IX Item "When I log-in to another system it tells me about missing terminfo data?" 455.IX Item "When I log-in to another system it tells me about missing terminfo data?"
181The terminal description used by rxvt-unicode is not as widely available 456The terminal description used by rxvt-unicode is not as widely available
182as that for xterm, or even rxvt (for which the same problem often arises). 457as that for xterm, or even rxvt (for which the same problem often arises).
183.Sp 458.Sp
205\& URxvt.termName: rxvt 480\& URxvt.termName: rxvt
206.Ve 481.Ve
207.Sp 482.Sp
208If you don't plan to use \fBrxvt\fR (quite common...) you could also replace 483If you don't plan to use \fBrxvt\fR (quite common...) you could also replace
209the rxvt terminfo file with the rxvt-unicode one. 484the rxvt terminfo file with the rxvt-unicode one.
485.ie n .IP """tic"" outputs some error when compiling the terminfo entry." 4
486.el .IP "\f(CWtic\fR outputs some error when compiling the terminfo entry." 4
487.IX Item "tic outputs some error when compiling the terminfo entry."
488Most likely it's the empty definition for \f(CW\*(C`enacs=\*(C'\fR. Just replace it by
489\&\f(CW\*(C`enacs=\eE[0@\*(C'\fR and try again.
210.ie n .IP """bash""'s readline does not work correctly under @@RXVT_NAME@@." 4 490.ie n .IP """bash""'s readline does not work correctly under @@RXVT_NAME@@." 4
211.el .IP "\f(CWbash\fR's readline does not work correctly under @@RXVT_NAME@@." 4 491.el .IP "\f(CWbash\fR's readline does not work correctly under @@RXVT_NAME@@." 4
212.IX Item "bash's readline does not work correctly under @@RXVT_NAME@@." 492.IX Item "bash's readline does not work correctly under @@RXVT_NAME@@."
213.PD 0 493.PD 0
214.IP "I need a termcap file entry." 4 494.IP "I need a termcap file entry." 4
215.IX Item "I need a termcap file entry." 495.IX Item "I need a termcap file entry."
216.PD 496.PD
217One reason you might want this is that some distributions or operating 497One reason you might want this is that some distributions or operating
218systems still compile some programs using the long-obsoleted termcap 498systems still compile some programs using the long-obsoleted termcap
219(Fedora Core's bash is one example) and rely on a termcap entry for 499library (Fedora Core's bash is one example) and rely on a termcap entry
220\&\f(CW\*(C`rxvt\-unicode\*(C'\fR. 500for \f(CW\*(C`rxvt\-unicode\*(C'\fR.
221.Sp 501.Sp
222You could use rxvt's termcap entry with resonable results in many cases. 502You could use rxvt's termcap entry with resonable results in many cases.
223You can also create a termcap entry by using terminfo's infocmp program 503You can also create a termcap entry by using terminfo's infocmp program
224like this: 504like this:
225.Sp 505.Sp
227\& infocmp -C rxvt-unicode 507\& infocmp -C rxvt-unicode
228.Ve 508.Ve
229.Sp 509.Sp
230Or you could use this termcap entry, generated by the command above: 510Or you could use this termcap entry, generated by the command above:
231.Sp 511.Sp
232.Vb 19 512.Vb 20
233\& rxvt-unicode|rxvt-unicode terminal (X Window System):\e 513\& rxvt-unicode|rxvt-unicode terminal (X Window System):\e
234\& :am:bw:eo:km:mi:ms:xn:xo:\e 514\& :am:bw:eo:km:mi:ms:xn:xo:\e
235\& :co#80:it#8:li#24:\e 515\& :co#80:it#8:li#24:lm#0:\e
236\& :AL=\eE[%dL:DC=\eE[%dP:DL=\eE[%dM:DO=\eE[%dB:IC=\eE[%d@:\e 516\& :AL=\eE[%dL:DC=\eE[%dP:DL=\eE[%dM:DO=\eE[%dB:IC=\eE[%d@:\e
237\& :K1=\eEOw:K2=\eEOu:K3=\eEOy:K4=\eEOq:K5=\eEOs:LE=\eE[%dD:\e 517\& :K1=\eEOw:K2=\eEOu:K3=\eEOy:K4=\eEOq:K5=\eEOs:LE=\eE[%dD:\e
238\& :RI=\eE[%dC:SF=\eE[%dS:SR=\eE[%dT:UP=\eE[%dA:ae=^O:al=\eE[L:\e 518\& :RI=\eE[%dC:SF=\eE[%dS:SR=\eE[%dT:UP=\eE[%dA:ae=\eE(B:al=\eE[L:\e
239\& :as=^N:bl=^G:cd=\eE[J:ce=\eE[K:cl=\eE[H\eE[2J:cm=\eE[%i%d;%dH:\e 519\& :as=\eE(0:bl=^G:cd=\eE[J:ce=\eE[K:cl=\eE[H\eE[2J:\e
240\& :cr=^M:cs=\eE[%i%d;%dr:ct=\eE[3g:dc=\eE[P:dl=\eE[M:do=^J:\e 520\& :cm=\eE[%i%d;%dH:cr=^M:cs=\eE[%i%d;%dr:ct=\eE[3g:dc=\eE[P:\e
241\& :ec=\eE[%dX:ei=\eE[4l:ho=\eE[H:i1=\eE[?47l\eE=\eE[?1l:ic=\eE[@:\e 521\& :dl=\eE[M:do=^J:ec=\eE[%dX:ei=\eE[4l:ho=\eE[H:\e
522\& :i1=\eE[?47l\eE=\eE[?1l:ic=\eE[@:im=\eE[4h:\e
242\& :im=\eE[4h:is=\eE[r\eE[m\eE[2J\eE[H\eE[?7h\eE[?1;3;4;6l\eE[4l:\e 523\& :is=\eE[r\eE[m\eE[2J\eE[H\eE[?7h\eE[?1;3;4;6l\eE[4l:\e
243\& :k0=\eE[21~:k1=\eE[11~:k2=\eE[12~:k3=\eE[13~:k4=\eE[14~:\e 524\& :k1=\eE[11~:k2=\eE[12~:k3=\eE[13~:k4=\eE[14~:k5=\eE[15~:\e
244\& :k5=\eE[15~:k6=\eE[17~:k7=\eE[18~:k8=\eE[19~:k9=\eE[20~:\e 525\& :k6=\eE[17~:k7=\eE[18~:k8=\eE[19~:k9=\eE[20~:kD=\eE[3~:\e
245\& :kD=\eE[3~:kI=\eE[2~:kN=\eE[6~:kP=\eE[5~:kb=\e177:kd=\eEOB:\e 526\& :kI=\eE[2~:kN=\eE[6~:kP=\eE[5~:kb=\e177:kd=\eEOB:ke=\eE[?1l\eE>:\e
246\& :ke=\eE[?1l\eE>:kh=\eE[7~:kl=\eEOD:kr=\eEOC:ks=\eE[?1h\eE=:\e 527\& :kh=\eE[7~:kl=\eEOD:kr=\eEOC:ks=\eE[?1h\eE=:ku=\eEOA:le=^H:\e
247\& :ku=\eEOA:le=^H:mb=\eE[5m:md=\eE[1m:me=\eE[m\e017:mr=\eE[7m:\e 528\& :mb=\eE[5m:md=\eE[1m:me=\eE[m\e017:mr=\eE[7m:nd=\eE[C:rc=\eE8:\e
248\& :nd=\eE[C:rc=\eE8:sc=\eE7:se=\eE[27m:sf=^J:so=\eE[7m:sr=\eEM:\e 529\& :sc=\eE7:se=\eE[27m:sf=^J:so=\eE[7m:sr=\eEM:st=\eEH:ta=^I:\e
249\& :st=\eEH:ta=^I:te=\eE[r\eE[?1049l:ti=\eE[?1049h:ue=\eE[24m:\e 530\& :te=\eE[r\eE[?1049l:ti=\eE[?1049h:ue=\eE[24m:up=\eE[A:\e
250\& :up=\eE[A:us=\eE[4m:vb=\eE[?5h\eE[?5l:ve=\eE[?25h:vi=\eE[?25l:\e 531\& :us=\eE[4m:vb=\eE[?5h\eE[?5l:ve=\eE[?25h:vi=\eE[?25l:\e
251\& :vs=\eE[?25h: 532\& :vs=\eE[?25h:
252.Ve 533.Ve
253.ie n .IP "Why does ""ls"" no longer have coloured output?" 4 534.ie n .IP "Why does ""ls"" no longer have coloured output?" 4
254.el .IP "Why does \f(CWls\fR no longer have coloured output?" 4 535.el .IP "Why does \f(CWls\fR no longer have coloured output?" 4
255.IX Item "Why does ls no longer have coloured output?" 536.IX Item "Why does ls no longer have coloured output?"
405the \f(CW\*(C`\-lsp\*(C'\fR option to give the font more height. If that doesn't work, you 686the \f(CW\*(C`\-lsp\*(C'\fR option to give the font more height. If that doesn't work, you
406might be forced to use a different font. 687might be forced to use a different font.
407.Sp 688.Sp
408All of this is not a problem when using X11 core fonts, as their bounding 689All of this is not a problem when using X11 core fonts, as their bounding
409box data is correct. 690box data is correct.
691.IP "On Solaris 9, many line-drawing characters are too wide." 4
692.IX Item "On Solaris 9, many line-drawing characters are too wide."
693Seems to be a known bug, read
694<http://nixdoc.net/files/forum/about34198.html>. Some people use the
695following ugly workaround to get non-double-wide-characters working:
696.Sp
697.Vb 1
698\& #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
699.Ve
410.IP "My Compose (Multi_key) key is no longer working." 4 700.IP "My Compose (Multi_key) key is no longer working." 4
411.IX Item "My Compose (Multi_key) key is no longer working." 701.IX Item "My Compose (Multi_key) key is no longer working."
412The most common causes for this are that either your locale is not set 702The most common causes for this are that either your locale is not set
413correctly, or you specified a \fBpreeditStyle\fR that is not supported by 703correctly, or you specified a \fBpreeditStyle\fR that is not supported by
414your input method. For example, if you specified \fBOverTheSpot\fR and 704your input method. For example, if you specified \fBOverTheSpot\fR and
456.Sp 746.Sp
457As you might have guessed, FreeBSD does neither define this symobl nor 747As you might have guessed, FreeBSD does neither define this symobl nor
458does it support it. Instead, it uses it's own internal representation of 748does it support it. Instead, it uses it's own internal representation of
459\&\fBwchar_t\fR. This is, of course, completely fine with respect to standards. 749\&\fBwchar_t\fR. This is, of course, completely fine with respect to standards.
460.Sp 750.Sp
751However, that means rxvt-unicode only works in \f(CW\*(C`POSIX\*(C'\fR, \f(CW\*(C`ISO\-8859\-1\*(C'\fR and
752\&\f(CW\*(C`UTF\-8\*(C'\fR locales under FreeBSD (which all use Unicode as \fBwchar_t\fR.
753.Sp
461However, \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR is the only sane way to support 754\&\f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR is the only sane way to support multi-language
462multi-language apps in an \s-1OS\s0, as using a locale-dependent (and 755apps in an \s-1OS\s0, as using a locale-dependent (and non\-standardized)
463non\-standardized) representation of \fBwchar_t\fR makes it impossible to 756representation of \fBwchar_t\fR makes it impossible to convert between
464convert between \fBwchar_t\fR (as used by X11 and your applications) and any 757\&\fBwchar_t\fR (as used by X11 and your applications) and any other encoding
465other encoding without implementing OS-specific-wrappers for each and 758without implementing OS-specific-wrappers for each and every locale. There
466every locale. There simply are no APIs to convert \fBwchar_t\fR into anything 759simply are no APIs to convert \fBwchar_t\fR into anything except the current
467except the current locale encoding. 760locale encoding.
468.Sp 761.Sp
469Some applications (such as the formidable \fBmlterm\fR) work around this 762Some applications (such as the formidable \fBmlterm\fR) work around this
470by carrying their own replacement functions for character set handling 763by carrying their own replacement functions for character set handling
471with them, and either implementing OS-dependent hacks or doing multiple 764with them, and either implementing OS-dependent hacks or doing multiple
472conversions (which is slow and unreliable in case the \s-1OS\s0 implements 765conversions (which is slow and unreliable in case the \s-1OS\s0 implements
473encodings slightly different than the terminal emulator). 766encodings slightly different than the terminal emulator).
474.Sp 767.Sp
475The rxvt-unicode author insists that the right way to fix this is in the 768The rxvt-unicode author insists that the right way to fix this is in the
476system libraries once and for all, instead of forcing every app to carry 769system libraries once and for all, instead of forcing every app to carry
477complete replacements for them :) 770complete replacements for them :)
771.IP "I use Solaris 9 and it doesn't compile/work/etc." 4
772.IX Item "I use Solaris 9 and it doesn't compile/work/etc."
773Try the diff in \fIdoc/solaris9.patch\fR as a base. It fixes the worst
774problems with \f(CW\*(C`wcwidth\*(C'\fR and a compile problem.
775.IP "How can I use rxvt-unicode under cygwin?" 4
776.IX Item "How can I use rxvt-unicode under cygwin?"
777rxvt-unicode should compile and run out of the box on cygwin, using
778the X11 libraries that come with cygwin. libW11 emulation is no
779longer supported (and makes no sense, either, as it only supported a
780single font). I recommend starting the X\-server in \f(CW\*(C`\-multiwindow\*(C'\fR or
781\&\f(CW\*(C`\-rootless\*(C'\fR mode instead, which will result in similar look&feel as the
782old libW11 emulation.
783.Sp
784At the time of this writing, cygwin didn't seem to support any multi-byte
785encodings (you might try \f(CW\*(C`LC_CTYPE=C\-UTF\-8\*(C'\fR), so you are likely limited
786to 8\-bit encodings.
478.IP "How does rxvt-unicode determine the encoding to use?" 4 787.IP "How does rxvt-unicode determine the encoding to use?" 4
479.IX Item "How does rxvt-unicode determine the encoding to use?" 788.IX Item "How does rxvt-unicode determine the encoding to use?"
480.PD 0 789.PD 0
481.IP "Is there an option to switch encodings?" 4 790.IP "Is there an option to switch encodings?" 4
482.IX Item "Is there an option to switch encodings?" 791.IX Item "Is there an option to switch encodings?"
567.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?" 876.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?"
568You can specify separate locales for the input method and the rest of the 877You can specify separate locales for the input method and the rest of the
569terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR: 878terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
570.Sp 879.Sp
571.Vb 1 880.Vb 1
572\& URxvt*imlocale: ja_JP.EUC-JP 881\& URxvt.imlocale: ja_JP.EUC-JP
573.Ve 882.Ve
574.Sp 883.Sp
575Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still 884Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
576use your input method. Please note, however, that you will not be able to 885use your input method. Please note, however, that you will not be able to
577input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input 886input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input
602rxvt-unicode then uses 8 bytes per screen cell. 911rxvt-unicode then uses 8 bytes per screen cell.
603.IP "Can I speed up Xft rendering somehow?" 4 912.IP "Can I speed up Xft rendering somehow?" 4
604.IX Item "Can I speed up Xft rendering somehow?" 913.IX Item "Can I speed up Xft rendering somehow?"
605Yes, the most obvious way to speed it up is to avoid Xft entirely, as 914Yes, the most obvious way to speed it up is to avoid Xft entirely, as
606it is simply slow. If you still want Xft fonts you might try to disable 915it is simply slow. If you still want Xft fonts you might try to disable
607antialiasing (by appending \f(CW\*(C`:antialiasing=false\*(C'\fR), which saves lots of 916antialiasing (by appending \f(CW\*(C`:antialias=false\*(C'\fR), which saves lots of
608memory and also speeds up rendering considerably. 917memory and also speeds up rendering considerably.
609.IP "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?" 4 918.IP "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?" 4
610.IX Item "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?" 919.IX Item "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?"
611Rxvt-unicode will use whatever you specify as a font. If it needs to 920Rxvt-unicode will use whatever you specify as a font. If it needs to
612fall back to it's default font search list it will prefer X11 core 921fall back to it's default font search list it will prefer X11 core
619.IX Item "Mouse cut/paste suddenly no longer works." 928.IX Item "Mouse cut/paste suddenly no longer works."
620Make sure that mouse reporting is actually turned off since killing 929Make sure that mouse reporting is actually turned off since killing
621some editors prematurely may leave the mouse in mouse report mode. I've 930some editors prematurely may leave the mouse in mouse report mode. I've
622heard that tcsh may use mouse reporting unless it otherwise specified. A 931heard that tcsh may use mouse reporting unless it otherwise specified. A
623quick check is to see if cut/paste works when the Alt or Shift keys are 932quick check is to see if cut/paste works when the Alt or Shift keys are
624depressed. See @@RXVT_NAME@@(7) 933depressed.
625.IP "What's with this bold/blink stuff?" 4 934.IP "What's with this bold/blink stuff?" 4
626.IX Item "What's with this bold/blink stuff?" 935.IX Item "What's with this bold/blink stuff?"
627If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the 936If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
628standard foreground colour. 937standard foreground colour.
629.Sp 938.Sp
691\& URxvt.color7: #e1dddd 1000\& URxvt.color7: #e1dddd
692\& URxvt.color15: #e1dddd 1001\& URxvt.color15: #e1dddd
693.Ve 1002.Ve
694.IP "How can I start @@RXVT_NAME@@d in a race-free way?" 4 1003.IP "How can I start @@RXVT_NAME@@d in a race-free way?" 4
695.IX Item "How can I start @@RXVT_NAME@@d in a race-free way?" 1004.IX Item "How can I start @@RXVT_NAME@@d in a race-free way?"
696Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 1005Try \f(CW\*(C`@@RXVT_NAME@@d \-f \-o\*(C'\fR, which tells @@RXVT_NAME@@d to open the
697server that answers @@RXVT_NAME@@c's requests, so it doesn't background 1006display, create the listening socket and then fork.
698itself.
699.Sp
700To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
701following method to wait for the startup message before continuing:
702.Sp
703.Vb 1
704\& { @@RXVT_NAME@@d & } | read
705.Ve
706.IP "What's with the strange Backspace/Delete key behaviour?" 4 1007.IP "What's with the strange Backspace/Delete key behaviour?" 4
707.IX Item "What's with the strange Backspace/Delete key behaviour?" 1008.IX Item "What's with the strange Backspace/Delete key behaviour?"
708Assuming that the physical Backspace key corresponds to the 1009Assuming that the physical Backspace key corresponds to the
709BackSpace keysym (not likely for Linux ... see the following 1010BackSpace keysym (not likely for Linux ... see the following
710question) there are two standard values that can be used for 1011question) there are two standard values that can be used for
732\& # use Backspace = ^? 1033\& # use Backspace = ^?
733\& $ stty erase ^? 1034\& $ stty erase ^?
734\& $ @@RXVT_NAME@@ 1035\& $ @@RXVT_NAME@@
735.Ve 1036.Ve
736.Sp 1037.Sp
737Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR as documented in @@RXVT_NAME@@(7). 1038Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR.
738.Sp 1039.Sp
739For an existing rxvt\-unicode: 1040For an existing rxvt\-unicode:
740.Sp 1041.Sp
741.Vb 3 1042.Vb 3
742\& # use Backspace = ^H 1043\& # use Backspace = ^H
858.IX Header "RXVT TECHNICAL REFERENCE" 1159.IX Header "RXVT TECHNICAL REFERENCE"
859.SH "DESCRIPTION" 1160.SH "DESCRIPTION"
860.IX Header "DESCRIPTION" 1161.IX Header "DESCRIPTION"
861The rest of this document describes various technical aspects of 1162The rest of this document describes various technical aspects of
862\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1163\&\fBrxvt-unicode\fR. First the description of supported command sequences,
863followed by menu and pixmap support and last by a description of all 1164followed by pixmap support and last by a description of all features
864features selectable at \f(CW\*(C`configure\*(C'\fR time. 1165selectable at \f(CW\*(C`configure\*(C'\fR time.
865.SH "Definitions" 1166.SH "Definitions"
866.IX Header "Definitions" 1167.IX Header "Definitions"
867.ie n .IP "\fB\fB""c""\fB\fR" 4 1168.ie n .IP "\fB\fB""c""\fB\fR" 4
868.el .IP "\fB\f(CBc\fB\fR" 4 1169.el .IP "\fB\f(CBc\fB\fR" 4
869.IX Item "c" 1170.IX Item "c"
1416l l . 1717l l .
1417h Send Mouse X & Y on button press. 1718h Send Mouse X & Y on button press.
1418l No mouse reporting. 1719l No mouse reporting.
1419.TE 1720.TE
1420 1721
1421.ie n .IP "\fB\fB""Ps = 10""\fB\fR (\fBrxvt\fR)" 4
1422.el .IP "\fB\f(CBPs = 10\fB\fR (\fBrxvt\fR)" 4
1423.IX Item "Ps = 10 (rxvt)"
1424.TS
1425l l .
1426h menuBar visible
1427l menuBar invisible
1428.TE
1429
1430.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 1722.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4
1431.el .IP "\fB\f(CBPs = 25\fB\fR" 4 1723.el .IP "\fB\f(CBPs = 25\fB\fR" 4
1432.IX Item "Ps = 25" 1724.IX Item "Ps = 25"
1433.TS 1725.TS
1434l l . 1726l l .
1553.IX Item "Ps = 1011 (rxvt)" 1845.IX Item "Ps = 1011 (rxvt)"
1554.TS 1846.TS
1555l l . 1847l l .
1556h Scroll to bottom when a key is pressed 1848h Scroll to bottom when a key is pressed
1557l Don't scroll to bottom when a key is pressed 1849l Don't scroll to bottom when a key is pressed
1850.TE
1851
1852.ie n .IP "\fB\fB""Ps = 1021""\fB\fR (\fBrxvt\fR)" 4
1853.el .IP "\fB\f(CBPs = 1021\fB\fR (\fBrxvt\fR)" 4
1854.IX Item "Ps = 1021 (rxvt)"
1855.TS
1856l l .
1857h Bold/italic implies high intensity (see option -is)
1858l Font styles have no effect on intensity (Compile styles)
1558.TE 1859.TE
1559 1860
1560.ie n .IP "\fB\fB""Ps = 1047""\fB\fR" 4 1861.ie n .IP "\fB\fB""Ps = 1047""\fB\fR" 4
1561.el .IP "\fB\f(CBPs = 1047\fB\fR" 4 1862.el .IP "\fB\f(CBPs = 1047\fB\fR" 4
1562.IX Item "Ps = 1047" 1863.IX Item "Ps = 1047"
1609Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1910Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1610Ps = 11 Change colour of text background to Pt (NB: may change in future) 1911Ps = 11 Change colour of text background to Pt (NB: may change in future)
1611Ps = 12 Change colour of text cursor foreground to Pt 1912Ps = 12 Change colour of text cursor foreground to Pt
1612Ps = 13 Change colour of mouse foreground to Pt 1913Ps = 13 Change colour of mouse foreground to Pt
1613Ps = 17 Change colour of highlight characters to Pt 1914Ps = 17 Change colour of highlight characters to Pt
1614Ps = 18 Change colour of bold characters to Pt 1915Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1615Ps = 19 Change colour of underlined characters to Pt 1916Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1616Ps = 20 Change default background to Pt 1917Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1617Ps = 39 Change default foreground colour to Pt rxvt compile-time option 1918Ps = 39 Change default foreground colour to Pt.
1618Ps = 46 Change Log File to Pt unimplemented 1919Ps = 46 Change Log File to Pt unimplemented
1619Ps = 49 Change default background colour to Pt rxvt compile-time option 1920Ps = 49 Change default background colour to Pt.
1620Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n 1921Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1621Ps = 55 Log all scrollback buffer and all of screen to Pt 1922Ps = 55 Log all scrollback buffer and all of screen to Pt
1622Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (@@RXVT_NAME@@ extension) 1923Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1623Ps = 703 Menubar command Pt rxvt compile-time option (rxvt-unicode extension) 1924Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.
1624Ps = 704 Change colour of italic characters to Pt 1925Ps = 704 Change colour of italic characters to Pt
1625Ps = 705 Change background pixmap tint colour to Pt 1926Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1927Ps = 706 Change colour of bold characters to Pt
1928Ps = 707 Change colour of underlined characters to Pt
1626Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1929Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1627Ps = 711 Set bold fontset to Pt. Similar to Ps = 50. 1930Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1628Ps = 712 Set italic fontset to Pt. Similar to Ps = 50. 1931Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1629Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50. 1932Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1933Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1934Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1935Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1630.TE 1936.TE
1631 1937
1632.PP 1938.PP
1633 1939
1634.IX Xref "menuBar" 1940.IX Xref "XPM"
1635.SH "menuBar"
1636.IX Header "menuBar"
1637\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1638In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1639menuBar.
1640.PP
1641Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1642omitted: use \fB./\fR to specify a menu relative to the current menu.
1643.Sh "Overview of menuBar operation"
1644.IX Subsection "Overview of menuBar operation"
1645For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1646of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1647.PP
1648At the top level is the current menuBar which is a member of a circular
1649linked-list of other such menuBars.
1650.PP
1651The menuBar acts as a parent for the various drop-down menus, which in
1652turn, may have labels, separator lines, menuItems and subMenus.
1653.PP
1654The menuItems are the useful bits: you can use them to mimic keyboard
1655input or even to send text or escape sequences back to rxvt.
1656.PP
1657The menuBar syntax is intended to provide a simple yet robust method of
1658constructing and manipulating menus and navigating through the
1659menuBars.
1660.PP
1661The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1662the menuBar called \fIname\fR and allows access. You may now or menus,
1663subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1664menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1665menus. To re-access the current menuBar for alterations, use the tag
1666\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1667.PP
1668
1669.IX Xref "menuBarCommands"
1670.Sh "Commands"
1671.IX Subsection "Commands"
1672.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1673.IX Item "[menu:+name]"
1674access the named menuBar for creation or alteration. If a new menuBar
1675is created, it is called \fIname\fR (max of 15 chars) and the current
1676menuBar is pushed onto the stack
1677.IP "\fB[menu]\fR" 4
1678.IX Item "[menu]"
1679access the current menuBar for alteration
1680.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1681.IX Item "[title:+string]"
1682set the current menuBar's title to \fIstring\fR, which may contain the
1683following format specifiers:
1684.Sp
1685.Vb 3
1686\& B<%n> rxvt name (as per the B<-name> command-line option)
1687\& B<%v> rxvt version
1688\& B<%%> literal B<%> character
1689.Ve
1690.IP "\fB[done]\fR" 4
1691.IX Item "[done]"
1692set menuBar access as \fBreadonly\fR.
1693End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1694.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1695.IX Item "[read:+file]"
1696read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1697appended if required.) Start reading at a line with \fB[menu]\fR or \fB[menu:+\f(BIname\fB\fR and continuing until \fB[done]\fR is encountered.
1698.Sp
1699Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1700since any invalid menu commands are also ignored, almost anything could
1701be construed as a comment line, but this may be tightened up in the
1702future ... so don't count on it!.
1703.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1704.IX Item "[read:+file;+name]"
1705The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1706\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1707\&\fB[done]\fR is encountered.
1708.IP "\fB[dump]\fR" 4
1709.IX Item "[dump]"
1710dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1711later rereading.
1712.IP "\fB[rm:name]\fR" 4
1713.IX Item "[rm:name]"
1714remove the named menuBar
1715.IP "\fB[rm] [rm:]\fR" 4
1716.IX Item "[rm] [rm:]"
1717remove the current menuBar
1718.IP "\fB[rm*] [rm:*]\fR" 4
1719.IX Item "[rm*] [rm:*]"
1720remove all menuBars
1721.IP "\fB[swap]\fR" 4
1722.IX Item "[swap]"
1723swap the top two menuBars
1724.IP "\fB[prev]\fR" 4
1725.IX Item "[prev]"
1726access the previous menuBar
1727.IP "\fB[next]\fR" 4
1728.IX Item "[next]"
1729access the next menuBar
1730.IP "\fB[show]\fR" 4
1731.IX Item "[show]"
1732Enable display of the menuBar
1733.IP "\fB[hide]\fR" 4
1734.IX Item "[hide]"
1735Disable display of the menuBar
1736.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1737.IX Item "[pixmap:+name]"
1738.PD 0
1739.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1740.IX Item "[pixmap:+name;scaling]"
1741.PD
1742(set the background pixmap globally
1743.Sp
1744\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1745.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1746.IX Item "[:+command:]"
1747ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1748menuitem or change the ; a useful shortcut for setting the quick arrows
1749from a menuBar.
1750.PP
1751
1752.IX Xref "menuBarAdd"
1753.Sh "Adding and accessing menus"
1754.IX Subsection "Adding and accessing menus"
1755The following commands may also be \fB+\fR prefixed.
1756.IP "\fB/+\fR" 4
1757.IX Item "/+"
1758access menuBar top level
1759.IP "\fB./+\fR" 4
1760.IX Item "./+"
1761access current menu level
1762.IP "\fB../+\fR" 4
1763.IX Item "../+"
1764access parent menu (1 level up)
1765.IP "\fB../../\fR" 4
1766.IX Item "../../"
1767access parent menu (multiple levels up)
1768.IP "\fB\f(BI/path/\fBmenu\fR" 4
1769.IX Item "/path/menu"
1770add/access menu
1771.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1772.IX Item "/path/menu/*"
1773add/access menu and clear it if it exists
1774.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1775.IX Item "/path/{-}"
1776add separator
1777.IP "\fB\f(BI/path/\fB{item}\fR" 4
1778.IX Item "/path/{item}"
1779add \fBitem\fR as a label
1780.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1781.IX Item "/path/{item} action"
1782add/alter \fImenuitem\fR with an associated \fIaction\fR
1783.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1784.IX Item "/path/{item}{right-text}"
1785add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1786and as the associated \fIaction\fR
1787.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1788.IX Item "/path/{item}{rtext} action"
1789add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
1790the right-justified text.
1791.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
1792.IX Item "Special characters in action must be backslash-escaped:"
1793\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
1794.IP "or in control-character notation:" 4
1795.IX Item "or in control-character notation:"
1796\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
1797.PP
1798To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
1799program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
1800the first of which will be stripped off and the balance directed to the
1801program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
1802non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
1803balance is sent back to rxvt.
1804.PP
1805As a convenience for the many Emacs-type editors, \fIaction\fR may start
1806with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
1807appended if missed from \fBM\-x\fR commands.
1808.PP
1809As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
1810quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
1811.IP "For example," 4
1812.IX Item "For example,"
1813\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
1814.IP "and" 4
1815.IX Item "and"
1816\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
1817.PP
1818The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
1819absence of a specified action, this text will be used as the \fIaction\fR
1820as well.
1821.IP "For example," 4
1822.IX Item "For example,"
1823\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
1824.PP
1825The left label \fIis\fR necessary, since it's used for matching, but
1826implicitly hiding the left label (by using same name for both left and
1827right labels), or explicitly hiding the left label (by preceeding it
1828with a dot), makes it possible to have right-justified text only.
1829.IP "For example," 4
1830.IX Item "For example,"
1831\&\fB/File/{Open}{Open} Open-File-Action\fR
1832.IP "or hiding it" 4
1833.IX Item "or hiding it"
1834\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
1835.PP
1836
1837.IX Xref "menuBarRemove"
1838.Sh "Removing menus"
1839.IX Subsection "Removing menus"
1840.IP "\fB\-/*+\fR" 4
1841.IX Item "-/*+"
1842remove all menus from the menuBar, the same as \fB[clear]\fR
1843.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
1844.IX Item "-+/pathmenu+"
1845remove menu
1846.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
1847.IX Item "-+/path{item}+"
1848remove item
1849.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
1850.IX Item "-+/path{-}"
1851remove separator)
1852.IP "\fB\-/path/menu/*\fR" 4
1853.IX Item "-/path/menu/*"
1854remove all items, separators and submenus from menu
1855.PP
1856
1857.IX Xref "menuBarArrows"
1858.Sh "Quick Arrows"
1859.IX Subsection "Quick Arrows"
1860The menus also provide a hook for \fIquick arrows\fR to provide easier
1861user access. If nothing has been explicitly set, the default is to
1862emulate the curror keys. The syntax permits each arrow to be altered
1863individually or all four at once without re-entering their common
1864beginning/end text. For example, to explicitly associate cursor actions
1865with the arrows, any of the following forms could be used:
1866.IP "\fB<r>+\f(BIRight\fB\fR" 4
1867.IX Item "<r>+Right"
1868.PD 0
1869.IP "\fB<l>+\f(BILeft\fB\fR" 4
1870.IX Item "<l>+Left"
1871.IP "\fB<u>+\f(BIUp\fB\fR" 4
1872.IX Item "<u>+Up"
1873.IP "\fB<d>+\f(BIDown\fB\fR" 4
1874.IX Item "<d>+Down"
1875.PD
1876Define actions for the respective arrow buttons
1877.IP "\fB<b>+\f(BIBegin\fB\fR" 4
1878.IX Item "<b>+Begin"
1879.PD 0
1880.IP "\fB<e>+\f(BIEnd\fB\fR" 4
1881.IX Item "<e>+End"
1882.PD
1883Define common beginning/end parts for \fIquick arrows\fR which used in
1884conjunction with the above <r> <l> <u> <d> constructs
1885.IP "For example, define arrows individually," 4
1886.IX Item "For example, define arrows individually,"
1887.Vb 1
1888\& <u>\eE[A
1889.Ve
1890.Sp
1891.Vb 1
1892\& <d>\eE[B
1893.Ve
1894.Sp
1895.Vb 1
1896\& <r>\eE[C
1897.Ve
1898.Sp
1899.Vb 1
1900\& <l>\eE[D
1901.Ve
1902.IP "or all at once" 4
1903.IX Item "or all at once"
1904.Vb 1
1905\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
1906.Ve
1907.IP "or more compactly (factoring out common parts)" 4
1908.IX Item "or more compactly (factoring out common parts)"
1909.Vb 1
1910\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
1911.Ve
1912.PP
1913
1914.IX Xref "menuBarSummary"
1915.Sh "Command Summary"
1916.IX Subsection "Command Summary"
1917A short summary of the most \fIcommon\fR commands:
1918.IP "[menu:name]" 4
1919.IX Item "[menu:name]"
1920use an existing named menuBar or start a new one
1921.IP "[menu]" 4
1922.IX Item "[menu]"
1923use the current menuBar
1924.IP "[title:string]" 4
1925.IX Item "[title:string]"
1926set menuBar title
1927.IP "[done]" 4
1928.IX Item "[done]"
1929set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
1930.IP "[done:name]" 4
1931.IX Item "[done:name]"
1932if reading from a file using [read:file;name] signal \s-1EOF\s0
1933.IP "[rm:name]" 4
1934.IX Item "[rm:name]"
1935remove named menuBar(s)
1936.IP "[rm] [rm:]" 4
1937.IX Item "[rm] [rm:]"
1938remove current menuBar
1939.IP "[rm*] [rm:*]" 4
1940.IX Item "[rm*] [rm:*]"
1941remove all menuBar(s)
1942.IP "[swap]" 4
1943.IX Item "[swap]"
1944swap top two menuBars
1945.IP "[prev]" 4
1946.IX Item "[prev]"
1947access the previous menuBar
1948.IP "[next]" 4
1949.IX Item "[next]"
1950access the next menuBar
1951.IP "[show]" 4
1952.IX Item "[show]"
1953map menuBar
1954.IP "[hide]" 4
1955.IX Item "[hide]"
1956unmap menuBar
1957.IP "[pixmap;file]" 4
1958.IX Item "[pixmap;file]"
1959.PD 0
1960.IP "[pixmap;file;scaling]" 4
1961.IX Item "[pixmap;file;scaling]"
1962.PD
1963set a background pixmap
1964.IP "[read:file]" 4
1965.IX Item "[read:file]"
1966.PD 0
1967.IP "[read:file;name]" 4
1968.IX Item "[read:file;name]"
1969.PD
1970read in a menu from a file
1971.IP "[dump]" 4
1972.IX Item "[dump]"
1973dump out all menuBars to /tmp/rxvt\-PID
1974.IP "/" 4
1975access menuBar top level
1976.IP "./" 4
1977.PD 0
1978.IP "../" 4
1979.IP "../../" 4
1980.PD
1981access current or parent menu level
1982.IP "/path/menu" 4
1983.IX Item "/path/menu"
1984add/access menu
1985.IP "/path/{\-}" 4
1986.IX Item "/path/{-}"
1987add separator
1988.IP "/path/{item}{rtext} action" 4
1989.IX Item "/path/{item}{rtext} action"
1990add/alter menu item
1991.IP "\-/*" 4
1992remove all menus from the menuBar
1993.IP "\-/path/menu" 4
1994.IX Item "-/path/menu"
1995remove menu items, separators and submenus from menu
1996.IP "\-/path/menu" 4
1997.IX Item "-/path/menu"
1998remove menu
1999.IP "\-/path/{item}" 4
2000.IX Item "-/path/{item}"
2001remove item
2002.IP "\-/path/{\-}" 4
2003.IX Item "-/path/{-}"
2004remove separator
2005.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2006.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2007menu quick arrows
2008.SH "XPM" 1941.SH "XPM"
2009.IX Header "XPM" 1942.IX Header "XPM"
2010For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value 1943For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value
2011of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a 1944of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a
2012sequence of scaling/positioning commands separated by semi\-colons. The 1945sequence of scaling/positioning commands separated by semi\-colons. The
2162.TE 2095.TE
2163 2096
2164.SH "CONFIGURE OPTIONS" 2097.SH "CONFIGURE OPTIONS"
2165.IX Header "CONFIGURE OPTIONS" 2098.IX Header "CONFIGURE OPTIONS"
2166General hint: if you get compile errors, then likely your configuration 2099General hint: if you get compile errors, then likely your configuration
2167hasn't been tested well. Either try with \-\-enable\-everything or use the 2100hasn't been tested well. Either try with \f(CW\*(C`\-\-enable\-everything\*(C'\fR or use
2168\&./reconf script as a base for experiments. ./reconf is used by myself, 2101the \fI./reconf\fR script as a base for experiments. \fI./reconf\fR is used by
2169so it should generally be a working config. Of course, you should always 2102myself, so it should generally be a working config. Of course, you should
2170report when a combination doesn't work, so it can be fixed. Marc Lehmann 2103always report when a combination doesn't work, so it can be fixed. Marc
2171<rxvt@schmorp.de>. 2104Lehmann <rxvt@schmorp.de>.
2105.PP
2106All
2172.IP "\-\-enable\-everything" 4 2107.IP "\-\-enable\-everything" 4
2173.IX Item "--enable-everything" 2108.IX Item "--enable-everything"
2174Add support for all non-multichoice options listed in \*(L"./configure 2109Add (or remove) support for all non-multichoice options listed in \*(L"./configure
2175\&\-\-help\*(R". Note that unlike other enable options this is order dependant. 2110\&\-\-help\*(R".
2111.Sp
2176You can specify this and then disable options which this enables by 2112You can specify this and then disable options you do not like by
2177\&\fIfollowing\fR this with the appropriate commands. 2113\&\fIfollowing\fR this with the appropriate \f(CW\*(C`\-\-disable\-...\*(C'\fR arguments,
2178.IP "\-\-enable\-xft" 4 2114or you can start with a minimal configuration by specifying
2179.IX Item "--enable-xft" 2115\&\f(CW\*(C`\-\-disable\-everything\*(C'\fR and than adding just the \f(CW\*(C`\-\-enable\-...\*(C'\fR arguments
2116you want.
2117.IP "\-\-enable\-xft (default: enabled)" 4
2118.IX Item "--enable-xft (default: enabled)"
2180Add support for Xft (anti\-aliases, among others) fonts. Xft fonts are 2119Add support for Xft (anti\-aliases, among others) fonts. Xft fonts are
2181slower and require lots of memory, but as long as you don't use them, you 2120slower and require lots of memory, but as long as you don't use them, you
2182don't pay for them. 2121don't pay for them.
2183.IP "\-\-enable\-font\-styles" 4 2122.IP "\-\-enable\-font\-styles (default: on)" 4
2184.IX Item "--enable-font-styles" 2123.IX Item "--enable-font-styles (default: on)"
2185Add support for \fBbold\fR, \fIitalic\fR and \fB\f(BIbold italic\fB\fR font 2124Add support for \fBbold\fR, \fIitalic\fR and \fB\f(BIbold italic\fB\fR font
2186styles. The fonts can be set manually or automatically. 2125styles. The fonts can be set manually or automatically.
2187.IP "\-\-with\-codesets=NAME,..." 4 2126.IP "\-\-with\-codesets=NAME,... (default: all)" 4
2188.IX Item "--with-codesets=NAME,..." 2127.IX Item "--with-codesets=NAME,... (default: all)"
2189Compile in support for additional codeset (encoding) groups (eu, vn are 2128Compile in support for additional codeset (encoding) groups (\f(CW\*(C`eu\*(C'\fR, \f(CW\*(C`vn\*(C'\fR
2190always compiled in, which includes most 8\-bit character sets). These 2129are always compiled in, which includes most 8\-bit character sets). These
2191codeset tables are currently only used for driving X11 core fonts, they 2130codeset tables are used for driving X11 core fonts, they are not required
2192are not required for Xft fonts. Compiling them in will make your binary 2131for Xft fonts, although having them compiled in lets rxvt-unicode choose
2193bigger (together about 700kB), but it doesn't increase memory usage unless 2132replacement fonts more intelligently. Compiling them in will make your
2133binary bigger (all of together cost about 700kB), but it doesn't increase
2194you use an X11 font requiring one of these encodings. 2134memory usage unless you use a font requiring one of these encodings.
2195.TS 2135.TS
2196l l . 2136l l .
2197all all available codeset groups 2137all all available codeset groups
2198zh common chinese encodings 2138zh common chinese encodings
2199zh_ext rarely used but very big chinese encodigs 2139zh_ext rarely used but very big chinese encodigs
2200jp common japanese encodings 2140jp common japanese encodings
2201jp_ext rarely used but big japanese encodings 2141jp_ext rarely used but big japanese encodings
2202kr korean encodings 2142kr korean encodings
2203.TE 2143.TE
2204 2144
2205.IP "\-\-enable\-xim" 4 2145.IP "\-\-enable\-xim (default: on)" 4
2206.IX Item "--enable-xim" 2146.IX Item "--enable-xim (default: on)"
2207Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using 2147Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using
2208alternative input methods (e.g. kinput2) and will also correctly 2148alternative input methods (e.g. kinput2) and will also correctly
2209set up the input for people using dead keys or compose keys. 2149set up the input for people using dead keys or compose keys.
2210.IP "\-\-enable\-unicode3" 4 2150.IP "\-\-enable\-unicode3 (default: off)" 4
2211.IX Item "--enable-unicode3" 2151.IX Item "--enable-unicode3 (default: off)"
2152Recommended to stay off unless you really need non-BMP characters.
2153.Sp
2212Enable direct support for displaying unicode codepoints above 2154Enable direct support for displaying unicode codepoints above
221365535 (the basic multilingual page). This increases storage 215565535 (the basic multilingual page). This increases storage
2214requirements per character from 2 to 4 bytes. X11 fonts do not yet 2156requirements per character from 2 to 4 bytes. X11 fonts do not yet
2215support these extra characters, but Xft does. 2157support these extra characters, but Xft does.
2216.Sp 2158.Sp
2217Please note that rxvt-unicode can store unicode code points >65535 2159Please note that rxvt-unicode can store unicode code points >65535
2218even without this flag, but the number of such characters is 2160even without this flag, but the number of such characters is
2219limited to a view thousand (shared with combining characters, 2161limited to a view thousand (shared with combining characters,
2220see next switch), and right now rxvt-unicode cannot display them 2162see next switch), and right now rxvt-unicode cannot display them
2221(input/output and cut&paste still work, though). 2163(input/output and cut&paste still work, though).
2222.IP "\-\-enable\-combining" 4 2164.IP "\-\-enable\-combining (default: on)" 4
2223.IX Item "--enable-combining" 2165.IX Item "--enable-combining (default: on)"
2224Enable automatic composition of combining characters into 2166Enable automatic composition of combining characters into
2225composite characters. This is required for proper viewing of text 2167composite characters. This is required for proper viewing of text
2226where accents are encoded as seperate unicode characters. This is 2168where accents are encoded as seperate unicode characters. This is
2227done by using precomposited characters when available or creating 2169done by using precomposited characters when available or creating
2228new pseudo-characters when no precomposed form exists. 2170new pseudo-characters when no precomposed form exists.
2229.Sp 2171.Sp
2230Without \-\-enable\-unicode3, the number of additional precomposed characters 2172Without \-\-enable\-unicode3, the number of additional precomposed
2231is rather limited (2048, if this is full, rxvt-unicode will use the 2173characters is somewhat limited (the 6400 private use characters will be
2232private use area, extending the number of combinations to 8448). With
2233\&\-\-enable\-unicode3, no practical limit exists. 2174(ab\-)used). With \-\-enable\-unicode3, no practical limit exists.
2234.Sp 2175.Sp
2235This option will also enable storage (but not display) of characters 2176This option will also enable storage (but not display) of characters
2236beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified. 2177beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
2237.Sp 2178.Sp
2238The combining table also contains entries for arabic presentation forms, 2179The combining table also contains entries for arabic presentation forms,
2239but these are not currently used. Bug me if you want these to be used (and 2180but these are not currently used. Bug me if you want these to be used (and
2240tell me how these are to be used...). 2181tell me how these are to be used...).
2241.IP "\-\-enable\-fallback(=CLASS)" 4 2182.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4
2242.IX Item "--enable-fallback(=CLASS)" 2183.IX Item "--enable-fallback(=CLASS) (default: Rxvt)"
2243When reading resource settings, also read settings for class \s-1CLASS\s0 2184When reading resource settings, also read settings for class \s-1CLASS\s0. To
2244(default: Rxvt). To disable resource fallback use \-\-disable\-fallback. 2185disable resource fallback use \-\-disable\-fallback.
2245.IP "\-\-with\-res\-name=NAME" 4 2186.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4
2246.IX Item "--with-res-name=NAME" 2187.IX Item "--with-res-name=NAME (default: urxvt)"
2247Use the given name (default: urxvt) as default application name when 2188Use the given name as default application name when
2248reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt. 2189reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
2249.IP "\-\-with\-res\-class=CLASS" 4 2190.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4
2250.IX Item "--with-res-class=CLASS" 2191.IX Item "--with-res-class=CLASS /default: URxvt)"
2251Use the given class (default: URxvt) as default application class 2192Use the given class as default application class
2252when reading resources. Specify \-\-with\-res\-class=Rxvt to replace 2193when reading resources. Specify \-\-with\-res\-class=Rxvt to replace
2253rxvt. 2194rxvt.
2254.IP "\-\-enable\-utmp" 4 2195.IP "\-\-enable\-utmp (default: on)" 4
2255.IX Item "--enable-utmp" 2196.IX Item "--enable-utmp (default: on)"
2256Write user and tty to utmp file (used by programs like \fIw\fR) at 2197Write user and tty to utmp file (used by programs like \fIw\fR) at
2257start of rxvt execution and delete information when rxvt exits. 2198start of rxvt execution and delete information when rxvt exits.
2258.IP "\-\-enable\-wtmp" 4 2199.IP "\-\-enable\-wtmp (default: on)" 4
2259.IX Item "--enable-wtmp" 2200.IX Item "--enable-wtmp (default: on)"
2260Write user and tty to wtmp file (used by programs like \fIlast\fR) at 2201Write user and tty to wtmp file (used by programs like \fIlast\fR) at
2261start of rxvt execution and write logout when rxvt exits. This 2202start of rxvt execution and write logout when rxvt exits. This
2262option requires \-\-enable\-utmp to also be specified. 2203option requires \-\-enable\-utmp to also be specified.
2263.IP "\-\-enable\-lastlog" 4 2204.IP "\-\-enable\-lastlog (default: on)" 4
2264.IX Item "--enable-lastlog" 2205.IX Item "--enable-lastlog (default: on)"
2265Write user and tty to lastlog file (used by programs like 2206Write user and tty to lastlog file (used by programs like
2266\&\fIlastlogin\fR) at start of rxvt execution. This option requires 2207\&\fIlastlogin\fR) at start of rxvt execution. This option requires
2267\&\-\-enable\-utmp to also be specified. 2208\&\-\-enable\-utmp to also be specified.
2268.IP "\-\-enable\-xpm\-background" 4 2209.IP "\-\-enable\-xpm\-background (default: on)" 4
2269.IX Item "--enable-xpm-background" 2210.IX Item "--enable-xpm-background (default: on)"
2270Add support for \s-1XPM\s0 background pixmaps. 2211Add support for \s-1XPM\s0 background pixmaps.
2271.IP "\-\-enable\-transparency" 4 2212.IP "\-\-enable\-transparency (default: on)" 4
2272.IX Item "--enable-transparency" 2213.IX Item "--enable-transparency (default: on)"
2273Add support for inheriting parent backgrounds thus giving a fake 2214Add support for inheriting parent backgrounds thus giving a fake
2274transparency to the term. 2215transparency to the term.
2275.IP "\-\-enable\-fading" 4 2216.IP "\-\-enable\-fading (default: on)" 4
2276.IX Item "--enable-fading" 2217.IX Item "--enable-fading (default: on)"
2277Add support for fading the text when focus is lost. 2218Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2278.IP "\-\-enable\-tinting" 4 2219.IP "\-\-enable\-tinting (default: on)" 4
2279.IX Item "--enable-tinting" 2220.IX Item "--enable-tinting (default: on)"
2280Add support for tinting of transparent backgrounds. 2221Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2281.IP "\-\-enable\-menubar" 4
2282.IX Item "--enable-menubar"
2283Add support for our menu bar system (this interacts badly with
2284dynamic locale switching currently).
2285.IP "\-\-enable\-rxvt\-scroll" 4 2222.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2286.IX Item "--enable-rxvt-scroll" 2223.IX Item "--enable-rxvt-scroll (default: on)"
2287Add support for the original rxvt scrollbar. 2224Add support for the original rxvt scrollbar.
2288.IP "\-\-enable\-next\-scroll" 4 2225.IP "\-\-enable\-next\-scroll (default: on)" 4
2289.IX Item "--enable-next-scroll" 2226.IX Item "--enable-next-scroll (default: on)"
2290Add support for a NeXT-like scrollbar. 2227Add support for a NeXT-like scrollbar.
2291.IP "\-\-enable\-xterm\-scroll" 4 2228.IP "\-\-enable\-xterm\-scroll (default: on)" 4
2292.IX Item "--enable-xterm-scroll" 2229.IX Item "--enable-xterm-scroll (default: on)"
2293Add support for an Xterm-like scrollbar. 2230Add support for an Xterm-like scrollbar.
2294.IP "\-\-enable\-plain\-scroll" 4 2231.IP "\-\-enable\-plain\-scroll (default: on)" 4
2295.IX Item "--enable-plain-scroll" 2232.IX Item "--enable-plain-scroll (default: on)"
2296Add support for a very unobtrusive, plain-looking scrollbar that 2233Add support for a very unobtrusive, plain-looking scrollbar that
2297is the favourite of the rxvt-unicode author, having used it for 2234is the favourite of the rxvt-unicode author, having used it for
2298many years. 2235many years.
2299.IP "\-\-enable\-half\-shadow" 4
2300.IX Item "--enable-half-shadow"
2301Make shadows on the scrollbar only half the normal width & height.
2302only applicable to rxvt scrollbars.
2303.IP "\-\-enable\-ttygid" 4 2236.IP "\-\-enable\-ttygid (default: off)" 4
2304.IX Item "--enable-ttygid" 2237.IX Item "--enable-ttygid (default: off)"
2305Change tty device setting to group \*(L"tty\*(R" \- only use this if 2238Change tty device setting to group \*(L"tty\*(R" \- only use this if
2306your system uses this type of security. 2239your system uses this type of security.
2307.IP "\-\-disable\-backspace\-key" 4 2240.IP "\-\-disable\-backspace\-key" 4
2308.IX Item "--disable-backspace-key" 2241.IX Item "--disable-backspace-key"
2309Disable any handling of the backspace key by us \- let the X server 2242Removes any handling of the backspace key by us \- let the X server do it.
2310do it.
2311.IP "\-\-disable\-delete\-key" 4 2243.IP "\-\-disable\-delete\-key" 4
2312.IX Item "--disable-delete-key" 2244.IX Item "--disable-delete-key"
2313Disable any handling of the delete key by us \- let the X server 2245Removes any handling of the delete key by us \- let the X server
2314do it. 2246do it.
2315.IP "\-\-disable\-resources" 4 2247.IP "\-\-disable\-resources" 4
2316.IX Item "--disable-resources" 2248.IX Item "--disable-resources"
2317Remove all resources checking. 2249Removes any support for resource checking.
2318.IP "\-\-enable\-xgetdefault" 4
2319.IX Item "--enable-xgetdefault"
2320Make resources checking via \fIXGetDefault()\fR instead of our small
2321version which only checks ~/.Xdefaults, or if that doesn't exist then
2322~/.Xresources.
2323.Sp
2324Please note that nowadays, things like \s-1XIM\s0 will automatically pull in and
2325use the full X resource manager, so the overhead of using it might be very
2326small, if nonexistant.
2327.IP "\-\-enable\-strings" 4
2328.IX Item "--enable-strings"
2329Add support for our possibly faster \fImemset()\fR function and other
2330various routines, overriding your system's versions which may
2331have been hand-crafted in assembly or may require extra libraries
2332to link in. (this breaks ANSI-C rules and has problems on many
2333GNU/Linux systems).
2334.IP "\-\-disable\-swapscreen" 4 2250.IP "\-\-disable\-swapscreen" 4
2335.IX Item "--disable-swapscreen" 2251.IX Item "--disable-swapscreen"
2336Remove support for swap screen. 2252Remove support for secondary/swap screen.
2337.IP "\-\-enable\-frills" 4 2253.IP "\-\-enable\-frills (default: on)" 4
2338.IX Item "--enable-frills" 2254.IX Item "--enable-frills (default: on)"
2339Add support for many small features that are not essential but nice to 2255Add support for many small features that are not essential but nice to
2340have. Normally you want this, but for very small binaries you may want to 2256have. Normally you want this, but for very small binaries you may want to
2341disable this. 2257disable this.
2342.Sp 2258.Sp
2343A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2259A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2344in combination with other switches) is: 2260in combination with other switches) is:
2345.Sp 2261.Sp
2262.Vb 15
2263\& MWM-hints
2264\& EWMH-hints (pid, utf8 names) and protocols (ping)
2265\& seperate underline colour (-underlineColor)
2266\& settable border widths and borderless switch (-w, -b, -bl)
2267\& visual depth selection (-depth)
2268\& settable extra linespacing /-lsp)
2269\& iso-14755-2 and -3, and visual feedback
2270\& tripleclickwords (-tcw)
2271\& settable insecure mode (-insecure)
2272\& keysym remapping support
2273\& cursor blinking and underline cursor (-cb, -uc)
2274\& XEmbed support (-embed)
2275\& user-pty (-pty-fd)
2276\& hold on exit (-hold)
2277\& skip builtin block graphics (-sbg)
2278.Ve
2279.Sp
2280It also enabled some non-essential features otherwise disabled, such as:
2281.Sp
2346.Vb 11 2282.Vb 11
2347\& MWM-hints 2283\& some round-trip time optimisations
2348\& seperate underline colour 2284\& nearest color allocation on pseudocolor screens
2349\& settable border widths and borderless switch 2285\& UTF8_STRING supporr for selection
2350\& settable extra linespacing 2286\& sgr modes 90..97 and 100..107
2351\& extra window properties (e.g. UTF-8 window names and PID)
2352\& iso-14755-2 and -3, and visual feedback
2353\& backindex and forwardindex escape sequence 2287\& backindex and forwardindex escape sequences
2288\& view change/zero scorllback esacpe sequences
2289\& locale switching escape sequence
2354\& window op and locale change escape sequences 2290\& window op and some xterm/OSC escape sequences
2355\& tripleclickwords 2291\& rectangular selections
2356\& settable insecure mode 2292\& trailing space removal for selections
2357\& keysym remapping support 2293\& verbose X error handling
2358.Ve 2294.Ve
2359.IP "\-\-enable\-iso14755" 4 2295.IP "\-\-enable\-iso14755 (default: on)" 4
2360.IX Item "--enable-iso14755" 2296.IX Item "--enable-iso14755 (default: on)"
2361Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or 2297Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
2362\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by 2298\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by
2363\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, while support for 5.2, 5.3 and 5.4 is enabled with 2299\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, while support for 5.2, 5.3 and 5.4 is enabled with
2364this switch. 2300this switch.
2365.IP "\-\-enable\-keepscrolling" 4 2301.IP "\-\-enable\-keepscrolling (default: on)" 4
2366.IX Item "--enable-keepscrolling" 2302.IX Item "--enable-keepscrolling (default: on)"
2367Add support for continual scrolling of the display when you hold 2303Add support for continual scrolling of the display when you hold
2368the mouse button down on a scrollbar arrow. 2304the mouse button down on a scrollbar arrow.
2369.IP "\-\-enable\-mousewheel" 4 2305.IP "\-\-enable\-mousewheel (default: on)" 4
2370.IX Item "--enable-mousewheel" 2306.IX Item "--enable-mousewheel (default: on)"
2371Add support for scrolling via mouse wheel or buttons 4 & 5. 2307Add support for scrolling via mouse wheel or buttons 4 & 5.
2372.IP "\-\-enable\-slipwheeling" 4 2308.IP "\-\-enable\-slipwheeling (default: on)" 4
2373.IX Item "--enable-slipwheeling" 2309.IX Item "--enable-slipwheeling (default: on)"
2374Add support for continual scrolling (using the mouse wheel as an 2310Add support for continual scrolling (using the mouse wheel as an
2375accelerator) while the control key is held down. This option 2311accelerator) while the control key is held down. This option
2376requires \-\-enable\-mousewheel to also be specified. 2312requires \-\-enable\-mousewheel to also be specified.
2377.IP "\-\-disable\-new\-selection" 4 2313.IP "\-\-disable\-new\-selection" 4
2378.IX Item "--disable-new-selection" 2314.IX Item "--disable-new-selection"
2379Remove support for mouse selection style like that of xterm. 2315Remove support for mouse selection style like that of xterm.
2380.IP "\-\-enable\-dmalloc" 4 2316.IP "\-\-enable\-dmalloc (default: off)" 4
2381.IX Item "--enable-dmalloc" 2317.IX Item "--enable-dmalloc (default: off)"
2382Use Gray Watson's malloc \- which is good for debugging See 2318Use Gray Watson's malloc \- which is good for debugging See
2383http://www.letters.com/dmalloc/ for details If you use either this or the 2319http://www.letters.com/dmalloc/ for details If you use either this or the
2384next option, you may need to edit src/Makefile after compiling to point 2320next option, you may need to edit src/Makefile after compiling to point
2385\&\s-1DINCLUDE\s0 and \s-1DLIB\s0 to the right places. 2321\&\s-1DINCLUDE\s0 and \s-1DLIB\s0 to the right places.
2386.Sp 2322.Sp
2387You can only use either this option and the following (should 2323You can only use either this option and the following (should
2388you use either) . 2324you use either) .
2389.IP "\-\-enable\-dlmalloc" 4 2325.IP "\-\-enable\-dlmalloc (default: off)" 4
2390.IX Item "--enable-dlmalloc" 2326.IX Item "--enable-dlmalloc (default: off)"
2391Use Doug Lea's malloc \- which is good for a production version 2327Use Doug Lea's malloc \- which is good for a production version
2392See <http://g.oswego.edu/dl/html/malloc.html> for details. 2328See <http://g.oswego.edu/dl/html/malloc.html> for details.
2393.IP "\-\-enable\-smart\-resize" 4 2329.IP "\-\-enable\-smart\-resize (default: on)" 4
2394.IX Item "--enable-smart-resize" 2330.IX Item "--enable-smart-resize (default: on)"
2395Add smart growth/shrink behaviour when changing font size via from hot 2331Add smart growth/shrink behaviour when changing font size via hot
2396keys. This should keep in a fixed position the rxvt corner which is 2332keys. This should keep the window corner which is closest to a corner of
2397closest to a corner of the screen. 2333the screen in a fixed position.
2398.IP "\-\-enable\-cursor\-blink" 4
2399.IX Item "--enable-cursor-blink"
2400Add support for a blinking cursor.
2401.IP "\-\-enable\-pointer\-blank" 4 2334.IP "\-\-enable\-pointer\-blank (default: on)" 4
2402.IX Item "--enable-pointer-blank" 2335.IX Item "--enable-pointer-blank (default: on)"
2403Add support to have the pointer disappear when typing or inactive. 2336Add support to have the pointer disappear when typing or inactive.
2337.IP "\-\-enable\-perl (default: on)" 4
2338.IX Item "--enable-perl (default: on)"
2339Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2340manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2341in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2342perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2343variable when running configure.
2404.IP "\-\-with\-name=NAME" 4 2344.IP "\-\-with\-name=NAME (default: urxvt)" 4
2405.IX Item "--with-name=NAME" 2345.IX Item "--with-name=NAME (default: urxvt)"
2406Set the basename for the installed binaries (default: \f(CW\*(C`urxvt\*(C'\fR, resulting 2346Set the basename for the installed binaries, resulting
2407in \f(CW\*(C`urxvt\*(C'\fR, \f(CW\*(C`urxvtd\*(C'\fR etc.). Specify \f(CW\*(C`\-\-with\-name=rxvt\*(C'\fR to replace with 2347in \f(CW\*(C`urxvt\*(C'\fR, \f(CW\*(C`urxvtd\*(C'\fR etc.). Specify \f(CW\*(C`\-\-with\-name=rxvt\*(C'\fR to replace with
2408\&\f(CW\*(C`rxvt\*(C'\fR. 2348\&\f(CW\*(C`rxvt\*(C'\fR.
2409.IP "\-\-with\-term=NAME" 4 2349.IP "\-\-with\-term=NAME (default: rxvt\-unicode)" 4
2410.IX Item "--with-term=NAME" 2350.IX Item "--with-term=NAME (default: rxvt-unicode)"
2411Change the environmental variable for the terminal to \s-1NAME\s0 (default 2351Change the environmental variable for the terminal to \s-1NAME\s0.
2412\&\f(CW\*(C`rxvt\-unicode\*(C'\fR)
2413.IP "\-\-with\-terminfo=PATH" 4 2352.IP "\-\-with\-terminfo=PATH" 4
2414.IX Item "--with-terminfo=PATH" 2353.IX Item "--with-terminfo=PATH"
2415Change the environmental variable for the path to the terminfo tree to 2354Change the environmental variable for the path to the terminfo tree to
2416\&\s-1PATH\s0. 2355\&\s-1PATH\s0.
2417.IP "\-\-with\-x" 4 2356.IP "\-\-with\-x" 4

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines