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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines