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.40 by root, Wed Jan 11 19:55:34 2006 UTC vs.
Revision 1.67 by root, Tue Jan 31 21:04:56 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 "2006-01-11" "6.3" "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 "RXVT\-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
160.IX Header "FREQUENTLY ASKED QUESTIONS" 159.IX Header "RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
160.Sh "Meta, Features & Commandline Issues"
161.IX Subsection "Meta, Features & Commandline Issues"
162\fIMy question isn't answered here, can I ask a human?\fR
163.IX Subsection "My question isn't answered here, can I ask a human?"
164.PP
165Before sending me mail, you could go to \s-1IRC:\s0 \f(CW\*(C`irc.freenode.net\*(C'\fR,
166channel \f(CW\*(C`#rxvt\-unicode\*(C'\fR has some rxvt-unicode enthusiasts that might be
167interested in learning about new and exciting problems (but not FAQs :).
168.PP
169\fIDoes it support tabs, can I have a tabbed rxvt\-unicode?\fR
170.IX Subsection "Does it support tabs, can I have a tabbed rxvt-unicode?"
171.PP
172Beginning with version 7.3, there is a perl extension that implements a
173simple tabbed terminal. It is installed by default, so any of these should
174give you tabs:
175.PP
176.Vb 1
177\& @@URXVT_NAME@@ -pe tabbed
178.Ve
179.PP
180.Vb 1
181\& URxvt.perl-ext-common: default,tabbed
182.Ve
183.PP
184It will also work fine with tabbing functionality of many window managers
185or similar tabbing programs, and its embedding-features allow it to be
186embedded into other programs, as witnessed by \fIdoc/rxvt\-tabbed\fR or
187the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl module, which features a tabbed urxvt
188(murxvt) terminal as an example embedding application.
189.PP
190\fIHow do I know which rxvt-unicode version I'm using?\fR
191.IX Subsection "How do I know which rxvt-unicode version I'm using?"
192.PP
193The version number is displayed with the usage (\-h). Also the escape
194sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When
195using the @@URXVT_NAME@@c client, the version displayed is that of the
196daemon.
197.PP
198\fIRxvt-unicode uses gobs of memory, how can I reduce that?\fR
199.IX Subsection "Rxvt-unicode uses gobs of memory, how can I reduce that?"
200.PP
201Rxvt-unicode tries to obey the rule of not charging you for something you
202don't use. One thing you should try is to configure out all settings that
203you don't need, for example, Xft support is a resource hog by design,
204when used. Compiling it out ensures that no Xft font will be loaded
205accidentally when rxvt-unicode tries to find a font for your characters.
206.PP
207Also, many people (me included) like large windows and even larger
208scrollback buffers: Without \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR, rxvt-unicode will use
2096 bytes per screen cell. For a 160x?? window this amounts to almost a
210kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
211use 10 Megabytes of memory. With \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR it gets worse, as
212rxvt-unicode then uses 8 bytes per screen cell.
213.PP
214\fIHow can I start @@URXVT_NAME@@d in a race-free way?\fR
215.IX Subsection "How can I start @@URXVT_NAME@@d in a race-free way?"
216.PP
217Try \f(CW\*(C`@@URXVT_NAME@@d \-f \-o\*(C'\fR, which tells @@URXVT_NAME@@d to open the
218display, create the listening socket and then fork.
219.PP
220\fIHow do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.\fR
221.IX Subsection "How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc."
222.PP
223The original rxvt and rxvt-unicode always export the variable \*(L"\s-1COLORTERM\s0\*(R",
224so you can check and see if that is set. Note that several programs, \s-1JED\s0,
225slrn, Midnight Commander automatically check this variable to decide
226whether or not to use color.
227.PP
228\fIHow do I set the correct, full \s-1IP\s0 address for the \s-1DISPLAY\s0 variable?\fR
229.IX Subsection "How do I set the correct, full IP address for the DISPLAY variable?"
230.PP
231If you've compiled rxvt-unicode with \s-1DISPLAY_IS_IP\s0 and have enabled
232insecure mode then it is possible to use the following shell script
233snippets to correctly set the display. If your version of rxvt-unicode
234wasn't also compiled with \s-1ESCZ_ANSWER\s0 (as assumed in these snippets) then
235the \s-1COLORTERM\s0 variable can be used to distinguish rxvt-unicode from a
236regular xterm.
237.PP
238Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
239snippets:
240.PP
241.Vb 12
242\& # Bourne/Korn/POSIX family of shells:
243\& [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
244\& if [ ${TERM:-foo} = xterm ]; then
245\& stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
246\& echo -n '^[Z'
247\& read term_id
248\& stty icanon echo
249\& if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
250\& echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
251\& read DISPLAY # set it in our local shell
252\& fi
253\& fi
254.Ve
255.PP
256\fIHow do I compile the manual pages on my own?\fR
257.IX Subsection "How do I compile the manual pages on my own?"
258.PP
259You need to have a recent version of perl installed as \fI/usr/bin/perl\fR,
260one that comes with \fIpod2man\fR, \fIpod2text\fR and \fIpod2html\fR. Then go to
261the doc subdirectory and enter \f(CW\*(C`make alldoc\*(C'\fR.
262.PP
161.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4 263\fIIsn't rxvt-unicode supposed to be small? Don't all those features bloat?\fR
162.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?" 264.IX Subsection "Isn't rxvt-unicode supposed to be small? Don't all those features bloat?"
265.PP
163I often get asked about this, and I think, no, they didn't cause extra 266I often get asked about this, and I think, no, they didn't cause extra
164bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 267bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
165that the urxvt binary is larger (due to some encoding tables always being 268that the urxvt binary is larger (due to some encoding tables always being
166compiled in), but it actually uses less memory (\s-1RSS\s0) after startup. Even 269compiled in), but it actually uses less memory (\s-1RSS\s0) after startup. Even
167with \f(CW\*(C`\-\-disable\-everything\*(C'\fR, this comparison is a bit unfair, as many 270with \f(CW\*(C`\-\-disable\-everything\*(C'\fR, this comparison is a bit unfair, as many
168features unique to urxvt (locale, encoding conversion, iso14755 etc.) are 271features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
169already in use in this mode. 272already in use in this mode.
170.Sp 273.PP
171.Vb 3 274.Vb 3
172\& text data bss drs rss filename 275\& text data bss drs rss filename
173\& 98398 1664 24 15695 1824 rxvt --disable-everything 276\& 98398 1664 24 15695 1824 rxvt --disable-everything
174\& 188985 9048 66616 18222 1788 urxvt --disable-everything 277\& 188985 9048 66616 18222 1788 urxvt --disable-everything
175.Ve 278.Ve
176.Sp 279.PP
177When you \f(CW\*(C`\-\-enable\-everything\*(C'\fR (which _is_ unfair, as this involves xft 280When you \f(CW\*(C`\-\-enable\-everything\*(C'\fR (which \fIis\fR unfair, as this involves xft
178and full locale/XIM support which are quite bloaty inside libX11 and my 281and full locale/XIM support which are quite bloaty inside libX11 and my
179libc), the two diverge, but not unreasnobaly so. 282libc), the two diverge, but not unreasnobaly so.
180.Sp 283.PP
181.Vb 3 284.Vb 3
182\& text data bss drs rss filename 285\& text data bss drs rss filename
183\& 163431 2152 24 20123 2060 rxvt --enable-everything 286\& 163431 2152 24 20123 2060 rxvt --enable-everything
184\& 1035683 49680 66648 29096 3680 urxvt --enable-everything 287\& 1035683 49680 66648 29096 3680 urxvt --enable-everything
185.Ve 288.Ve
186.Sp 289.PP
187The very large size of the text section is explained by the east-asian 290The very large size of the text section is explained by the east-asian
188encoding tables, which, if unused, take up disk space but nothing else 291encoding tables, which, if unused, take up disk space but nothing else
189and can be compiled out unless you rely on X11 core fonts that use those 292and can be compiled out unless you rely on X11 core fonts that use those
190encodings. The \s-1BSS\s0 size comes from the 64k emergency buffer that my c++ 293encodings. The \s-1BSS\s0 size comes from the 64k emergency buffer that my c++
191compiler allocates (but of course doesn't use unless you are out of 294compiler allocates (but of course doesn't use unless you are out of
192memory). Also, using an xft font instead of a core font immediately adds a 295memory). Also, using an xft font instead of a core font immediately adds a
193few megabytes of \s-1RSS\s0. Xft indeed is responsible for a lot of \s-1RSS\s0 even when 296few megabytes of \s-1RSS\s0. Xft indeed is responsible for a lot of \s-1RSS\s0 even when
194not used. 297not used.
195.Sp 298.PP
196Of course, due to every character using two or four bytes instead of one, 299Of course, due to every character using two or four bytes instead of one,
197a large scrollback buffer will ultimately make rxvt-unicode use more 300a large scrollback buffer will ultimately make rxvt-unicode use more
198memory. 301memory.
199.Sp 302.PP
200Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this 303Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
201still fares rather well. And compared to some monsters like gnome-terminal 304still fares rather well. And compared to some monsters like gnome-terminal
202(21152k + extra 4204k in separate processes) or konsole (22200k + extra 305(21152k + extra 4204k in separate processes) or konsole (22200k + extra
20343180k in daemons that stay around after exit, plus half a minute of 30643180k in daemons that stay around after exit, plus half a minute of
204startup time, including the hundreds of warnings it spits out), it fares 307startup time, including the hundreds of warnings it spits out), it fares
205extremely well *g*. 308extremely well *g*.
309.PP
206.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4 310\fIWhy \*(C+, isn't that unportable/bloated/uncool?\fR
207.IX Item "Why , isn't that unportable/bloated/uncool?" 311.IX Subsection "Why , isn't that unportable/bloated/uncool?"
312.PP
208Is this a question? :) It comes up very often. The simple answer is: I had 313Is this a question? :) It comes up very often. The simple answer is: I had
209to write it, and \*(C+ allowed me to write and maintain it in a fraction 314to write it, and \*(C+ allowed me to write and maintain it in a fraction
210of the time and effort (which is a scarce resource for me). Put even 315of the time and effort (which is a scarce resource for me). Put even
211shorter: It simply wouldn't exist without \*(C+. 316shorter: It simply wouldn't exist without \*(C+.
212.Sp 317.PP
213My personal stance on this is that \*(C+ is less portable than C, but in 318My personal stance on this is that \*(C+ is less portable than C, but in
214the case of rxvt-unicode this hardly matters, as its portability limits 319the case of rxvt-unicode this hardly matters, as its portability limits
215are defined by things like X11, pseudo terminals, locale support and unix 320are defined by things like X11, pseudo terminals, locale support and unix
216domain sockets, which are all less portable than \*(C+ itself. 321domain sockets, which are all less portable than \*(C+ itself.
217.Sp 322.PP
218Regarding the bloat, see the above question: It's easy to write programs 323Regarding the bloat, see the above question: It's easy to write programs
219in C that use gobs of memory, an certainly possible to write programs in 324in C that use gobs of memory, an certainly possible to write programs in
220\&\*(C+ that don't. \*(C+ also often comes with large libraries, but this is 325\&\*(C+ that don't. \*(C+ also often comes with large libraries, but this is
221not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my 326not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my
222system with a minimal config: 327system with a minimal config:
223.Sp 328.PP
224.Vb 4 329.Vb 4
225\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 330\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
226\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000) 331\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
227\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000) 332\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
228\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 333\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
229.Ve 334.Ve
230.Sp 335.PP
231And here is rxvt\-unicode: 336And here is rxvt\-unicode:
232.Sp 337.PP
233.Vb 5 338.Vb 5
234\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 339\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
235\& libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 340\& libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
236\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 341\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
237\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 342\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
238\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 343\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
239.Ve 344.Ve
240.Sp 345.PP
241No large bloated libraries (of course, none were linked in statically), 346No large bloated libraries (of course, none were linked in statically),
242except maybe libX11 :) 347except maybe libX11 :)
243.IP "Does it support tabs, can I have a tabbed rxvt\-unicode?" 4 348.Sh "Rendering, Font & Look and Feel Issues"
244.IX Item "Does it support tabs, can I have a tabbed rxvt-unicode?" 349.IX Subsection "Rendering, Font & Look and Feel Issues"
245rxvt-unicode does not directly support tabs. It will work fine with 350\fII can't get transparency working, what am I doing wrong?\fR
246tabbing functionality of many window managers or similar tabbing programs, 351.IX Subsection "I can't get transparency working, what am I doing wrong?"
247and its embedding-features allow it to be embedded into other programs, 352.PP
248as witnessed by \fIdoc/rxvt\-tabbed\fR or the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl 353First of all, transparency isn't officially supported in rxvt\-unicode, so
249module, which features a tabbed urxvt (murxvt) terminal as an example 354you are mostly on your own. Do not bug the author about it (but you may
250embedding application. 355bug everybody else). Also, if you can't get it working consider it a rite
251.IP "How do I know which rxvt-unicode version I'm using?" 4 356of passage: ... and you failed.
252.IX Item "How do I know which rxvt-unicode version I'm using?" 357.PP
253The version number is displayed with the usage (\-h). Also the escape 358Here are four ways to get transparency. \fBDo\fR read the manpage and option
254sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When 359descriptions for the programs mentioned and rxvt\-unicode. Really, do it!
255using the @@RXVT_NAME@@c client, the version displayed is that of the 360.PP
256daemon. 3611. Use inheritPixmap:
257.IP "I am using Debian GNU/Linux and have a problem..." 4 362.PP
258.IX Item "I am using Debian GNU/Linux and have a problem..." 363.Vb 2
259The Debian GNU/Linux package of rxvt-unicode in sarge contains large 364\& Esetroot wallpaper.jpg
260patches that considerably change the behaviour of rxvt\-unicode. Before 365\& @@URXVT_NAME@@ -ip -tint red -sh 40
261reporting a bug to the original rxvt-unicode author please download and 366.Ve
262install the genuine version (<http://software.schmorp.de#rxvt\-unicode>) 367.PP
263and try to reproduce the problem. If you cannot, chances are that the 368That works. If you think it doesn't, you lack transparency and tinting
264problems are specific to Debian GNU/Linux, in which case it should be 369support, or you are unable to read.
265reported via the Debian Bug Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report 370.PP
266the bug). 3712. Use a simple pixmap and emulate pseudo\-transparency. This enables you
267.Sp 372to use effects other than tinting and shading: Just shade/tint/whatever
268For other problems that also affect the Debian package, you can and 373your picture with gimp or any other tool:
269probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a 374.PP
270bug in the Debian version and it serves as a reminder for other users that 375.Vb 2
271might encounter the same issue. 376\& convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
272.IP "I am maintaining rxvt-unicode for distribution/OS \s-1XXX\s0, any recommendation?" 4 377\& @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
273.IX Item "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?" 378.Ve
274You should build one binary with the default options. \fIconfigure\fR 379.PP
275now enables most useful options, and the trend goes to making them 380That works. If you think it doesn't, you lack \s-1XPM\s0 and Perl support, or you
276runtime\-switchable, too, so there is usually no drawback to enbaling them, 381are unable to read.
277except higher disk and possibly memory usage. The perl interpreter should 382.PP
278be enabled, as important functionality (menus, selection, likely more in 3833. Use an \s-1ARGB\s0 visual:
279the future) depends on it. 384.PP
280.Sp 385.Vb 1
281You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR snd \f(CW\*(C`perl\-ext\*(C'\fR resources 386\& @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
282system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful 387.Ve
283behaviour. If your distribution aims at low memory, add an empty 388.PP
284\&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the 389This requires \s-1XFT\s0 support, and the support of your X\-server. If that
285perl interpreter disabled until the user enables it. 390doesn't work for you, blame Xorg and Keith Packard. \s-1ARGB\s0 visuals aren't
286.Sp 391there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
287If you can/want build more binaries, I recommend building a minimal 392bugfixes and workarounds for Xft and Xlib to make it work, but that
288one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with 393doesn't mean that your \s-1WM\s0 has the required kludges in place.
289\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of 394.PP
290encodings built-in that increase download times and are rarely used). 3954. Use xcompmgr and let it do the job:
291.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4 396.PP
292.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?" 397.Vb 2
293Likely not. While I honestly try to make it secure, and am probably not 398\& xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \e
294bad at it, I think it is simply unreasonable to expect all of freetype 399\& -set _NET_WM_WINDOW_OPACITY 0xc0000000
295+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be 400.Ve
296secure. Also, rxvt-unicode disables some options when it detects that it 401.PP
297runs setuid or setgid, which is not nice. Besides, with the embedded perl 402Then click on a window you want to make transparent. Replace \f(CW0xc0000000\fR
298interpreter the possibility for security problems easily multiplies. 403by other values to change the degree of opacity. If it doesn't work and
299.Sp 404your server crashes, you got to keep the pieces.
300Elevated privileges are only required for utmp and pty operations on some 405.PP
301systems (for example, GNU/Linux doesn't need any extra privileges for 406\fIWhy do some chinese characters look so different than others?\fR
302ptys, but some need it for utmp support). It is planned to mvoe this into 407.IX Subsection "Why do some chinese characters look so different than others?"
303a forked handler process, but this is not yet done. 408.PP
304.Sp 409This is because there is a difference between script and language \*(--
305So, while setuid/setgid operation is supported and not a problem on your 410rxvt-unicode does not know which language the text that is output is,
306typical single-user-no-other-logins unix desktop, always remember that 411as it only knows the unicode character codes. If rxvt-unicode first
307its an awful lot of code, most of which isn't checked for security issues 412sees a japanese/chinese character, it might choose a japanese font for
308regularly. 413display. Subsequent japanese characters will use that font. Now, many
414chinese characters aren't represented in japanese fonts, so when the first
415non-japanese character comes up, rxvt-unicode will look for a chinese font
416\&\*(-- unfortunately at this point, it will still use the japanese font for
417chinese characters that are also in the japanese font.
418.PP
419The workaround is easy: just tag a chinese font at the end of your font
420list (see the previous question). The key is to view the font list as
421a preference list: If you expect more japanese, list a japanese font
422first. If you expect more chinese, put a chinese font first.
423.PP
424In the future it might be possible to switch language preferences at
425runtime (the internal data structure has no problem with using different
426fonts for the same character at the same time, but no interface for this
427has been designed yet).
428.PP
429Until then, you might get away with switching fonts at runtime (see \*(L"Can I switch the fonts at runtime?\*(R" later in this document).
430.PP
431\fIWhy does rxvt-unicode sometimes leave pixel droppings?\fR
432.IX Subsection "Why does rxvt-unicode sometimes leave pixel droppings?"
433.PP
434Most fonts were not designed for terminal use, which means that character
435size varies a lot. A font that is otherwise fine for terminal use might
436contain some characters that are simply too wide. Rxvt-unicode will avoid
437these characters. For characters that are just \*(L"a bit\*(R" too wide a special
438\&\*(L"careful\*(R" rendering mode is used that redraws adjacent characters.
439.PP
440All of this requires that fonts do not lie about character sizes,
441however: Xft fonts often draw glyphs larger than their acclaimed bounding
442box, and rxvt-unicode has no way of detecting this (the correct way is to
443ask for the character bounding box, which unfortunately is wrong in these
444cases).
445.PP
446It's not clear (to me at least), wether this is a bug in Xft, freetype,
447or the respective font. If you encounter this problem you might try using
448the \f(CW\*(C`\-lsp\*(C'\fR option to give the font more height. If that doesn't work, you
449might be forced to use a different font.
450.PP
451All of this is not a problem when using X11 core fonts, as their bounding
452box data is correct.
453.PP
454\fIHow can I keep rxvt-unicode from using reverse video so much?\fR
455.IX Subsection "How can I keep rxvt-unicode from using reverse video so much?"
456.PP
457First of all, make sure you are running with the right terminal settings
458(\f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR), which will get rid of most of these effects. Then
459make sure you have specified colours for italic and bold, as otherwise
460rxvt-unicode might use reverse video to simulate the effect:
461.PP
462.Vb 2
463\& URxvt.colorBD: white
464\& URxvt.colorIT: green
465.Ve
466.PP
467\fISome programs assume totally weird colours (red instead of blue), how can I fix that?\fR
468.IX Subsection "Some programs assume totally weird colours (red instead of blue), how can I fix that?"
469.PP
470For some unexplainable reason, some rare programs assume a very weird
471colour palette when confronted with a terminal with more than the standard
4728 colours (rxvt\-unicode supports 88). The right fix is, of course, to fix
473these programs not to assume non-ISO colours without very good reasons.
474.PP
475In the meantime, you can either edit your \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo
476definition to only claim 8 colour support or use \f(CW\*(C`TERM=rxvt\*(C'\fR, which will
477fix colours but keep you from using other rxvt-unicode features.
478.PP
479\fICan I switch the fonts at runtime?\fR
480.IX Subsection "Can I switch the fonts at runtime?"
481.PP
482Yes, using an escape sequence. Try something like this, which has the same
483effect as using the \f(CW\*(C`\-fn\*(C'\fR switch, and takes effect immediately:
484.PP
485.Vb 1
486\& printf '\ee]50;%s\e007' "9x15bold,xft:Kochi Gothic"
487.Ve
488.PP
489This is useful if you e.g. work primarily with japanese (and prefer a
490japanese font), but you have to switch to chinese temporarily, where
491japanese fonts would only be in your way.
492.PP
493You can think of this as a kind of manual \s-1ISO\-2022\s0 switching.
494.PP
495\fIWhy do italic characters look as if clipped?\fR
496.IX Subsection "Why do italic characters look as if clipped?"
497.PP
498Many fonts have difficulties with italic characters and hinting. For
499example, the otherwise very nicely hinted font \f(CW\*(C`xft:Bitstream Vera Sans
500Mono\*(C'\fR completely fails in it's italic face. A workaround might be to
501enable freetype autohinting, i.e. like this:
502.PP
503.Vb 2
504\& URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
505\& URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
506.Ve
507.PP
508\fICan I speed up Xft rendering somehow?\fR
509.IX Subsection "Can I speed up Xft rendering somehow?"
510.PP
511Yes, the most obvious way to speed it up is to avoid Xft entirely, as
512it is simply slow. If you still want Xft fonts you might try to disable
513antialiasing (by appending \f(CW\*(C`:antialias=false\*(C'\fR), which saves lots of
514memory and also speeds up rendering considerably.
515.PP
516\fIRxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?\fR
517.IX Subsection "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?"
518.PP
519Rxvt-unicode will use whatever you specify as a font. If it needs to
520fall back to it's default font search list it will prefer X11 core
521fonts, because they are small and fast, and then use Xft fonts. It has
522antialiasing disabled for most of them, because the author thinks they
523look best that way.
524.PP
525If you want antialiasing, you have to specify the fonts manually.
526.PP
527\fIWhat's with this bold/blink stuff?\fR
528.IX Subsection "What's with this bold/blink stuff?"
529.PP
530If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
531standard foreground colour.
532.PP
533For the standard background colour, blinking will actually make the
534text blink when compiled with \f(CW\*(C`\-\-enable\-blinking\*(C'\fR. with standard
535colours. Without \f(CW\*(C`\-\-enable\-blinking\*(C'\fR, the blink attribute will be
536ignored.
537.PP
538On \s-1ANSI\s0 colours, bold/blink attributes are used to set high-intensity
539foreground/background colors.
540.PP
541color0\-7 are the low-intensity colors.
542.PP
543color8\-15 are the corresponding high-intensity colors.
544.PP
545\fII don't like the screen colors. How do I change them?\fR
546.IX Subsection "I don't like the screen colors. How do I change them?"
547.PP
548You can change the screen colors at run-time using \fI~/.Xdefaults\fR
549resources (or as long\-options).
550.PP
551Here are values that are supposed to resemble a \s-1VGA\s0 screen,
552including the murky brown that passes for low-intensity yellow:
553.PP
554.Vb 8
555\& URxvt.color0: #000000
556\& URxvt.color1: #A80000
557\& URxvt.color2: #00A800
558\& URxvt.color3: #A8A800
559\& URxvt.color4: #0000A8
560\& URxvt.color5: #A800A8
561\& URxvt.color6: #00A8A8
562\& URxvt.color7: #A8A8A8
563.Ve
564.PP
565.Vb 8
566\& URxvt.color8: #000054
567\& URxvt.color9: #FF0054
568\& URxvt.color10: #00FF54
569\& URxvt.color11: #FFFF54
570\& URxvt.color12: #0000FF
571\& URxvt.color13: #FF00FF
572\& URxvt.color14: #00FFFF
573\& URxvt.color15: #FFFFFF
574.Ve
575.PP
576And here is a more complete set of non-standard colors.
577.PP
578.Vb 18
579\& URxvt.cursorColor: #dc74d1
580\& URxvt.pointerColor: #dc74d1
581\& URxvt.background: #0e0e0e
582\& URxvt.foreground: #4ad5e1
583\& URxvt.color0: #000000
584\& URxvt.color8: #8b8f93
585\& URxvt.color1: #dc74d1
586\& URxvt.color9: #dc74d1
587\& URxvt.color2: #0eb8c7
588\& URxvt.color10: #0eb8c7
589\& URxvt.color3: #dfe37e
590\& URxvt.color11: #dfe37e
591\& URxvt.color5: #9e88f0
592\& URxvt.color13: #9e88f0
593\& URxvt.color6: #73f7ff
594\& URxvt.color14: #73f7ff
595\& URxvt.color7: #e1dddd
596\& URxvt.color15: #e1dddd
597.Ve
598.PP
599(They were described (not by me) as \*(L"pretty girly\*(R").
600.PP
601\fIHow does rxvt-unicode choose fonts?\fR
602.IX Subsection "How does rxvt-unicode choose fonts?"
603.PP
604Most fonts do not contain the full range of Unicode, which is
605fine. Chances are that the font you (or the admin/package maintainer of
606your system/os) have specified does not cover all the characters you want
607to display.
608.PP
609\&\fBrxvt-unicode\fR makes a best-effort try at finding a replacement
610font. Often the result is fine, but sometimes the chosen font looks
611bad/ugly/wrong. Some fonts have totally strange characters that don't
612resemble the correct glyph at all, and rxvt-unicode lacks the artificial
613intelligence to detect that a specific glyph is wrong: it has to believe
614the font that the characters it claims to contain indeed look correct.
615.PP
616In that case, select a font of your taste and add it to the font list,
617e.g.:
618.PP
619.Vb 1
620\& @@URXVT_NAME@@ -fn basefont,font2,font3...
621.Ve
622.PP
623When rxvt-unicode sees a character, it will first look at the base
624font. If the base font does not contain the character, it will go to the
625next font, and so on. Specifying your own fonts will also speed up this
626search and use less resources within rxvt-unicode and the X\-server.
627.PP
628The only limitation is that none of the fonts may be larger than the base
629font, as the base font defines the terminal character cell size, which
630must be the same due to the way terminals work.
631.Sh "Keyboard, Mouse & User Interaction"
632.IX Subsection "Keyboard, Mouse & User Interaction"
633\fIThe new selection selects pieces that are too big, how can I select single words?\fR
634.IX Subsection "The new selection selects pieces that are too big, how can I select single words?"
635.PP
636If you want to select e.g. alphanumeric words, you can use the following
637setting:
638.PP
639.Vb 1
640\& URxvt.selection.pattern-0: ([[:word:]]+)
641.Ve
642.PP
643If you click more than twice, the selection will be extended
644more and more.
645.PP
646To get a selection that is very similar to the old code, try this pattern:
647.PP
648.Vb 1
649\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+)
650.Ve
651.PP
652Please also note that the \fILeftClick Shift-LeftClik\fR combination also
653selects words like the old code.
654.PP
655\fII don't like the new selection/popups/hotkeys/perl, how do I change/disable it?\fR
656.IX Subsection "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?"
657.PP
658You can disable the perl extension completely by setting the
659\&\fBperl-ext-common\fR resource to the empty string, which also keeps
660rxvt-unicode from initialising perl, saving memory.
661.PP
662If you only want to disable specific features, you first have to
663identify which perl extension is responsible. For this, read the section
664\&\fB\s-1PREPACKAGED\s0 \s-1EXTENSIONS\s0\fR in the @@URXVT_NAME@@\fIperl\fR\|(3) manpage. For
665example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify
666this \fBperl-ext-common\fR resource:
667.PP
668.Vb 1
669\& URxvt.perl-ext-common: default,-selection-popup,-option-popup
670.Ve
671.PP
672This will keep the default extensions, but disable the two popup
673extensions. Some extensions can also be configured, for example,
674scrollback search mode is triggered by \fBM\-s\fR. You can move it to any
675other combination either by setting the \fBsearchable-scrollback\fR resource:
676.PP
677.Vb 1
678\& URxvt.searchable-scrollback: CM-s
679.Ve
680.PP
681\fIThe cursor moves when selecting text in the current input line, how do I switch this off?\fR
682.IX Subsection "The cursor moves when selecting text in the current input line, how do I switch this off?"
683.PP
684See next entry.
685.PP
686\fIDuring rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?\fR
687.IX Subsection "During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?"
688.PP
689These are caused by the \f(CW\*(C`readline\*(C'\fR perl extension. Under normal
690circumstances, it will move your cursor around when you click into the
691line that contains it. It tries hard not to do this at the wrong moment,
692but when running a program that doesn't parse cursor movements or in some
693cases during rlogin sessions, it fails to detect this properly.
694.PP
695You can permamently switch this feature off by disabling the \f(CW\*(C`readline\*(C'\fR
696extension:
697.PP
698.Vb 1
699\& URxvt.perl-ext-common: default,-readline
700.Ve
701.PP
702\fIMy numerical keypad acts weird and generates differing output?\fR
703.IX Subsection "My numerical keypad acts weird and generates differing output?"
704.PP
705Some Debian GNUL/Linux users seem to have this problem, although no
706specific details were reported so far. It is possible that this is caused
707by the wrong \f(CW\*(C`TERM\*(C'\fR setting, although the details of wether and how
708this can happen are unknown, as \f(CW\*(C`TERM=rxvt\*(C'\fR should offer a compatible
709keymap. See the answer to the previous question, and please report if that
710helped.
711.PP
712\fIMy Compose (Multi_key) key is no longer working.\fR
713.IX Subsection "My Compose (Multi_key) key is no longer working."
714.PP
715The most common causes for this are that either your locale is not set
716correctly, or you specified a \fBpreeditStyle\fR that is not supported by
717your input method. For example, if you specified \fBOverTheSpot\fR and
718your input method (e.g. the default input method handling Compose keys)
719does not support this (for instance because it is not visual), then
720rxvt-unicode will continue without an input method.
721.PP
722In this case either do not specify a \fBpreeditStyle\fR or specify more than
723one pre-edit style, such as \fBOverTheSpot,Root,None\fR.
724.PP
725\fII cannot type \f(CI\*(C`Ctrl\-Shift\-2\*(C'\fI to get an \s-1ASCII\s0 \s-1NUL\s0 character due to \s-1ISO\s0 14755\fR
726.IX Subsection "I cannot type Ctrl-Shift-2 to get an ASCII NUL character due to ISO 14755"
727.PP
728Either try \f(CW\*(C`Ctrl\-2\*(C'\fR alone (it often is mapped to \s-1ASCII\s0 \s-1NUL\s0 even on
729international keyboards) or simply use \s-1ISO\s0 14755 support to your
730advantage, typing <Ctrl\-Shift\-0> to get a \s-1ASCII\s0 \s-1NUL\s0. This works for other
731codes, too, such as \f(CW\*(C`Ctrl\-Shift\-1\-d\*(C'\fR to type the default telnet escape
732character and so on.
733.PP
734\fIMouse cut/paste suddenly no longer works.\fR
735.IX Subsection "Mouse cut/paste suddenly no longer works."
736.PP
737Make sure that mouse reporting is actually turned off since killing
738some editors prematurely may leave the mouse in mouse report mode. I've
739heard that tcsh may use mouse reporting unless it otherwise specified. A
740quick check is to see if cut/paste works when the Alt or Shift keys are
741depressed.
742.PP
743\fIWhat's with the strange Backspace/Delete key behaviour?\fR
744.IX Subsection "What's with the strange Backspace/Delete key behaviour?"
745.PP
746Assuming that the physical Backspace key corresponds to the
747BackSpace keysym (not likely for Linux ... see the following
748question) there are two standard values that can be used for
749Backspace: \f(CW\*(C`^H\*(C'\fR and \f(CW\*(C`^?\*(C'\fR.
750.PP
751Historically, either value is correct, but rxvt-unicode adopts the debian
752policy of using \f(CW\*(C`^?\*(C'\fR when unsure, because it's the one only only correct
753choice :).
754.PP
755Rxvt-unicode tries to inherit the current stty settings and uses the value
756of `erase' to guess the value for backspace. If rxvt-unicode wasn't
757started from a terminal (say, from a menu or by remote shell), then the
758system value of `erase', which corresponds to \s-1CERASE\s0 in <termios.h>, will
759be used (which may not be the same as your stty setting).
760.PP
761For starting a new rxvt\-unicode:
762.PP
763.Vb 3
764\& # use Backspace = ^H
765\& $ stty erase ^H
766\& $ @@URXVT_NAME@@
767.Ve
768.PP
769.Vb 3
770\& # use Backspace = ^?
771\& $ stty erase ^?
772\& $ @@URXVT_NAME@@
773.Ve
774.PP
775Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR.
776.PP
777For an existing rxvt\-unicode:
778.PP
779.Vb 3
780\& # use Backspace = ^H
781\& $ stty erase ^H
782\& $ echo -n "^[[36h"
783.Ve
784.PP
785.Vb 3
786\& # use Backspace = ^?
787\& $ stty erase ^?
788\& $ echo -n "^[[36l"
789.Ve
790.PP
791This helps satisfy some of the Backspace discrepancies that occur, but
792if you use Backspace = \f(CW\*(C`^H\*(C'\fR, make sure that the termcap/terminfo value
793properly reflects that.
794.PP
795The Delete key is a another casualty of the ill-defined Backspace problem.
796To avoid confusion between the Backspace and Delete keys, the Delete
797key has been assigned an escape sequence to match the vt100 for Execute
798(\f(CW\*(C`ESC [ 3 ~\*(C'\fR) and is in the supplied termcap/terminfo.
799.PP
800Some other Backspace problems:
801.PP
802some editors use termcap/terminfo,
803some editors (vim I'm told) expect Backspace = ^H,
804\&\s-1GNU\s0 Emacs (and Emacs-like editors) use ^H for help.
805.PP
806Perhaps someday this will all be resolved in a consistent manner.
807.PP
808\fII don't like the key\-bindings. How do I change them?\fR
809.IX Subsection "I don't like the key-bindings. How do I change them?"
810.PP
811There are some compile-time selections available via configure. Unless
812you have run \*(L"configure\*(R" with the \f(CW\*(C`\-\-disable\-resources\*(C'\fR option you can
813use the `keysym' resource to alter the keystrings associated with keysyms.
814.PP
815Here's an example for a URxvt session started using \f(CW\*(C`@@URXVT_NAME@@ \-name URxvt\*(C'\fR
816.PP
817.Vb 20
818\& URxvt.keysym.Home: \e033[1~
819\& URxvt.keysym.End: \e033[4~
820\& URxvt.keysym.C-apostrophe: \e033<C-'>
821\& URxvt.keysym.C-slash: \e033<C-/>
822\& URxvt.keysym.C-semicolon: \e033<C-;>
823\& URxvt.keysym.C-grave: \e033<C-`>
824\& URxvt.keysym.C-comma: \e033<C-,>
825\& URxvt.keysym.C-period: \e033<C-.>
826\& URxvt.keysym.C-0x60: \e033<C-`>
827\& URxvt.keysym.C-Tab: \e033<C-Tab>
828\& URxvt.keysym.C-Return: \e033<C-Return>
829\& URxvt.keysym.S-Return: \e033<S-Return>
830\& URxvt.keysym.S-space: \e033<S-Space>
831\& URxvt.keysym.M-Up: \e033<M-Up>
832\& URxvt.keysym.M-Down: \e033<M-Down>
833\& URxvt.keysym.M-Left: \e033<M-Left>
834\& URxvt.keysym.M-Right: \e033<M-Right>
835\& URxvt.keysym.M-C-0: list \e033<M-C- 0123456789 >
836\& URxvt.keysym.M-C-a: list \e033<M-C- abcdefghijklmnopqrstuvwxyz >
837\& URxvt.keysym.F12: command:\e033]701;zh_CN.GBK\e007
838.Ve
839.PP
840See some more examples in the documentation for the \fBkeysym\fR resource.
841.PP
842\fII'm using keyboard model \s-1XXX\s0 that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map\fR
843.IX Subsection "I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map"
844.PP
845.Vb 6
846\& KP_Insert == Insert
847\& F22 == Print
848\& F27 == Home
849\& F29 == Prior
850\& F33 == End
851\& F35 == Next
852.Ve
853.PP
854Rather than have rxvt-unicode try to accommodate all the various possible
855keyboard mappings, it is better to use `xmodmap' to remap the keys as
856required for your particular machine.
857.Sh "Terminal Configuration"
858.IX Subsection "Terminal Configuration"
859\fIWhy doesn't rxvt-unicode read my resources?\fR
860.IX Subsection "Why doesn't rxvt-unicode read my resources?"
861.PP
862Well, why, indeed? It does, in a way very similar to other X
863applications. Most importantly, this means that if you or your \s-1OS\s0 loads
864resources into the X display (the right way to do it), rxvt-unicode will
865ignore any resource files in your home directory. It will only read
866\&\fI$HOME/.Xdefaults\fR when no resources are attached to the display.
867.PP
868If you have or use an \fI$HOME/.Xresources\fR file, chances are that
869resources are loaded into your X\-server. In this case, you have to
870re-login after every change (or run \fIxrdb \-merge \f(CI$HOME\fI/.Xresources\fR).
871.PP
872Also consider the form resources have to use:
873.PP
874.Vb 1
875\& URxvt.resource: value
876.Ve
877.PP
878If you want to use another form (there are lots of different ways of
879specifying resources), make sure you understand wether and why it
880works. If unsure, use the form above.
881.PP
309.IP "When I log-in to another system it tells me about missing terminfo data?" 4 882\fIWhen I log-in to another system it tells me about missing terminfo data?\fR
310.IX Item "When I log-in to another system it tells me about missing terminfo data?" 883.IX Subsection "When I log-in to another system it tells me about missing terminfo data?"
884.PP
311The terminal description used by rxvt-unicode is not as widely available 885The terminal description used by rxvt-unicode is not as widely available
312as that for xterm, or even rxvt (for which the same problem often arises). 886as that for xterm, or even rxvt (for which the same problem often arises).
313.Sp 887.PP
314The correct solution for this problem is to install the terminfo, this can 888The correct solution for this problem is to install the terminfo, this can
315be done like this (with ncurses' infocmp): 889be done like this (with ncurses' infocmp):
316.Sp 890.PP
317.Vb 2 891.Vb 2
318\& REMOTE=remotesystem.domain 892\& REMOTE=remotesystem.domain
319\& infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 893\& infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
320.Ve 894.Ve
321.Sp 895.PP
322\&... or by installing rxvt-unicode normally on the remote system, 896\&... or by installing rxvt-unicode normally on the remote system,
323.Sp 897.PP
324If you cannot or do not want to do this, then you can simply set 898If you cannot or do not want to do this, then you can simply set
325\&\f(CW\*(C`TERM=rxvt\*(C'\fR or even \f(CW\*(C`TERM=xterm\*(C'\fR, and live with the small number of 899\&\f(CW\*(C`TERM=rxvt\*(C'\fR or even \f(CW\*(C`TERM=xterm\*(C'\fR, and live with the small number of
326problems arising, which includes wrong keymapping, less and different 900problems arising, which includes wrong keymapping, less and different
327colours and some refresh errors in fullscreen applications. It's a nice 901colours and some refresh errors in fullscreen applications. It's a nice
328quick-and-dirty workaround for rare cases, though. 902quick-and-dirty workaround for rare cases, though.
329.Sp 903.PP
330If you always want to do this (and are fine with the consequences) you 904If you always want to do this (and are fine with the consequences) you
331can either recompile rxvt-unicode with the desired \s-1TERM\s0 value or use a 905can either recompile rxvt-unicode with the desired \s-1TERM\s0 value or use a
332resource to set it: 906resource to set it:
333.Sp 907.PP
334.Vb 1 908.Vb 1
335\& URxvt.termName: rxvt 909\& URxvt.termName: rxvt
336.Ve 910.Ve
337.Sp 911.PP
338If you don't plan to use \fBrxvt\fR (quite common...) you could also replace 912If you don't plan to use \fBrxvt\fR (quite common...) you could also replace
339the rxvt terminfo file with the rxvt-unicode one. 913the rxvt terminfo file with the rxvt-unicode one and use \f(CW\*(C`TERM=rxvt\*(C'\fR.
340.ie n .IP """tic"" outputs some error when compiling the terminfo entry." 4 914.PP
341.el .IP "\f(CWtic\fR outputs some error when compiling the terminfo entry." 4 915\fI\f(CI\*(C`tic\*(C'\fI outputs some error when compiling the terminfo entry.\fR
342.IX Item "tic outputs some error when compiling the terminfo entry." 916.IX Subsection "tic outputs some error when compiling the terminfo entry."
917.PP
343Most likely it's the empty definition for \f(CW\*(C`enacs=\*(C'\fR. Just replace it by 918Most likely it's the empty definition for \f(CW\*(C`enacs=\*(C'\fR. Just replace it by
344\&\f(CW\*(C`enacs=\eE[0@\*(C'\fR and try again. 919\&\f(CW\*(C`enacs=\eE[0@\*(C'\fR and try again.
345.ie n .IP """bash""'s readline does not work correctly under @@RXVT_NAME@@." 4 920.PP
346.el .IP "\f(CWbash\fR's readline does not work correctly under @@RXVT_NAME@@." 4 921\fI\f(CI\*(C`bash\*(C'\fI's readline does not work correctly under @@URXVT_NAME@@.\fR
347.IX Item "bash's readline does not work correctly under @@RXVT_NAME@@." 922.IX Subsection "bash's readline does not work correctly under @@URXVT_NAME@@."
348.PD 0 923.PP
924See next entry.
925.PP
349.IP "I need a termcap file entry." 4 926\fII need a termcap file entry.\fR
350.IX Item "I need a termcap file entry." 927.IX Subsection "I need a termcap file entry."
351.PD 928.PP
352One reason you might want this is that some distributions or operating 929One reason you might want this is that some distributions or operating
353systems still compile some programs using the long-obsoleted termcap 930systems still compile some programs using the long-obsoleted termcap
354library (Fedora Core's bash is one example) and rely on a termcap entry 931library (Fedora Core's bash is one example) and rely on a termcap entry
355for \f(CW\*(C`rxvt\-unicode\*(C'\fR. 932for \f(CW\*(C`rxvt\-unicode\*(C'\fR.
356.Sp 933.PP
357You could use rxvt's termcap entry with resonable results in many cases. 934You could use rxvt's termcap entry with resonable results in many cases.
358You can also create a termcap entry by using terminfo's infocmp program 935You can also create a termcap entry by using terminfo's infocmp program
359like this: 936like this:
360.Sp 937.PP
361.Vb 1 938.Vb 1
362\& infocmp -C rxvt-unicode 939\& infocmp -C rxvt-unicode
363.Ve 940.Ve
364.Sp 941.PP
365Or you could use this termcap entry, generated by the command above: 942Or you could use this termcap entry, generated by the command above:
366.Sp 943.PP
367.Vb 20 944.Vb 20
368\& rxvt-unicode|rxvt-unicode terminal (X Window System):\e 945\& rxvt-unicode|rxvt-unicode terminal (X Window System):\e
369\& :am:bw:eo:km:mi:ms:xn:xo:\e 946\& :am:bw:eo:km:mi:ms:xn:xo:\e
370\& :co#80:it#8:li#24:lm#0:\e 947\& :co#80:it#8:li#24:lm#0:\e
371\& :AL=\eE[%dL:DC=\eE[%dP:DL=\eE[%dM:DO=\eE[%dB:IC=\eE[%d@:\e 948\& :AL=\eE[%dL:DC=\eE[%dP:DL=\eE[%dM:DO=\eE[%dB:IC=\eE[%d@:\e
384\& :sc=\eE7:se=\eE[27m:sf=^J:so=\eE[7m:sr=\eEM:st=\eEH:ta=^I:\e 961\& :sc=\eE7:se=\eE[27m:sf=^J:so=\eE[7m:sr=\eEM:st=\eEH:ta=^I:\e
385\& :te=\eE[r\eE[?1049l:ti=\eE[?1049h:ue=\eE[24m:up=\eE[A:\e 962\& :te=\eE[r\eE[?1049l:ti=\eE[?1049h:ue=\eE[24m:up=\eE[A:\e
386\& :us=\eE[4m:vb=\eE[?5h\eE[?5l:ve=\eE[?25h:vi=\eE[?25l:\e 963\& :us=\eE[4m:vb=\eE[?5h\eE[?5l:ve=\eE[?25h:vi=\eE[?25l:\e
387\& :vs=\eE[?25h: 964\& :vs=\eE[?25h:
388.Ve 965.Ve
389.ie n .IP "Why does ""ls"" no longer have coloured output?" 4 966.PP
390.el .IP "Why does \f(CWls\fR no longer have coloured output?" 4 967\fIWhy does \f(CI\*(C`ls\*(C'\fI no longer have coloured output?\fR
391.IX Item "Why does ls no longer have coloured output?" 968.IX Subsection "Why does ls no longer have coloured output?"
969.PP
392The \f(CW\*(C`ls\*(C'\fR in the \s-1GNU\s0 coreutils unfortunately doesn't use terminfo to 970The \f(CW\*(C`ls\*(C'\fR in the \s-1GNU\s0 coreutils unfortunately doesn't use terminfo to
393decide wether a terminal has colour, but uses it's own configuration 971decide wether a terminal has colour, but uses it's own configuration
394file. Needless to say, \f(CW\*(C`rxvt\-unicode\*(C'\fR is not in it's default file (among 972file. Needless to say, \f(CW\*(C`rxvt\-unicode\*(C'\fR is not in it's default file (among
395with most other terminals supporting colour). Either add: 973with most other terminals supporting colour). Either add:
396.Sp 974.PP
397.Vb 1 975.Vb 1
398\& TERM rxvt-unicode 976\& TERM rxvt-unicode
399.Ve 977.Ve
400.Sp 978.PP
401to \f(CW\*(C`/etc/DIR_COLORS\*(C'\fR or simply add: 979to \f(CW\*(C`/etc/DIR_COLORS\*(C'\fR or simply add:
402.Sp 980.PP
403.Vb 1 981.Vb 1
404\& alias ls='ls --color=auto' 982\& alias ls='ls --color=auto'
405.Ve 983.Ve
406.Sp 984.PP
407to your \f(CW\*(C`.profile\*(C'\fR or \f(CW\*(C`.bashrc\*(C'\fR. 985to your \f(CW\*(C`.profile\*(C'\fR or \f(CW\*(C`.bashrc\*(C'\fR.
986.PP
408.IP "Why doesn't vim/emacs etc. use the 88 colour mode?" 4 987\fIWhy doesn't vim/emacs etc. use the 88 colour mode?\fR
409.IX Item "Why doesn't vim/emacs etc. use the 88 colour mode?" 988.IX Subsection "Why doesn't vim/emacs etc. use the 88 colour mode?"
410.PD 0 989.PP
990See next entry.
991.PP
411.IP "Why doesn't vim/emacs etc. make use of italic?" 4 992\fIWhy doesn't vim/emacs etc. make use of italic?\fR
412.IX Item "Why doesn't vim/emacs etc. make use of italic?" 993.IX Subsection "Why doesn't vim/emacs etc. make use of italic?"
994.PP
995See next entry.
996.PP
413.IP "Why are the secondary screen-related options not working properly?" 4 997\fIWhy are the secondary screen-related options not working properly?\fR
414.IX Item "Why are the secondary screen-related options not working properly?" 998.IX Subsection "Why are the secondary screen-related options not working properly?"
415.PD 999.PP
416Make sure you are using \f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR. Some pre-packaged 1000Make sure you are using \f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR. Some pre-packaged
417distributions (most notably Debian GNU/Linux) break rxvt-unicode 1001distributions (most notably Debian GNU/Linux) break rxvt-unicode
418by setting \f(CW\*(C`TERM\*(C'\fR to \f(CW\*(C`rxvt\*(C'\fR, which doesn't have these extra 1002by setting \f(CW\*(C`TERM\*(C'\fR to \f(CW\*(C`rxvt\*(C'\fR, which doesn't have these extra
419features. Unfortunately, some of these (most notably, again, Debian 1003features. Unfortunately, some of these (most notably, again, Debian
420GNU/Linux) furthermore fail to even install the \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo 1004GNU/Linux) furthermore fail to even install the \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo
421file, so you will need to install it on your own (See the question \fBWhen 1005file, so you will need to install it on your own (See the question \fBWhen
422I log-in to another system it tells me about missing terminfo data?\fR on 1006I log-in to another system it tells me about missing terminfo data?\fR on
423how to do this). 1007how to do this).
424.IP "My numerical keypad acts weird and generates differing output?" 4 1008.Sh "Encoding / Locale / Input Method Issues"
425.IX Item "My numerical keypad acts weird and generates differing output?" 1009.IX Subsection "Encoding / Locale / Input Method Issues"
426Some Debian GNUL/Linux users seem to have this problem, although no
427specific details were reported so far. It is possible that this is caused
428by the wrong \f(CW\*(C`TERM\*(C'\fR setting, although the details of wether and how
429this can happen are unknown, as \f(CW\*(C`TERM=rxvt\*(C'\fR should offer a compatible
430keymap. See the answer to the previous question, and please report if that
431helped.
432.IP "Rxvt-unicode does not seem to understand the selected encoding?" 4 1010\fIRxvt-unicode does not seem to understand the selected encoding?\fR
433.IX Item "Rxvt-unicode does not seem to understand the selected encoding?" 1011.IX Subsection "Rxvt-unicode does not seem to understand the selected encoding?"
434.PD 0 1012.PP
1013See next entry.
1014.PP
435.IP "Unicode does not seem to work?" 4 1015\fIUnicode does not seem to work?\fR
436.IX Item "Unicode does not seem to work?" 1016.IX Subsection "Unicode does not seem to work?"
437.PD 1017.PP
438If you encounter strange problems like typing an accented character but 1018If you encounter strange problems like typing an accented character but
439getting two unrelated other characters or similar, or if program output is 1019getting two unrelated other characters or similar, or if program output is
440subtly garbled, then you should check your locale settings. 1020subtly garbled, then you should check your locale settings.
441.Sp 1021.PP
442Rxvt-unicode must be started with the same \f(CW\*(C`LC_CTYPE\*(C'\fR setting as the 1022Rxvt-unicode must be started with the same \f(CW\*(C`LC_CTYPE\*(C'\fR setting as the
443programs. Often rxvt-unicode is started in the \f(CW\*(C`C\*(C'\fR locale, while the 1023programs. Often rxvt-unicode is started in the \f(CW\*(C`C\*(C'\fR locale, while the
444login script running within the rxvt-unicode window changes the locale to 1024login script running within the rxvt-unicode window changes the locale to
445something else, e.g. \f(CW\*(C`en_GB.UTF\-8\*(C'\fR. Needless to say, this is not going to work. 1025something else, e.g. \f(CW\*(C`en_GB.UTF\-8\*(C'\fR. Needless to say, this is not going to work.
446.Sp 1026.PP
447The best thing is to fix your startup environment, as you will likely run 1027The best thing is to fix your startup environment, as you will likely run
448into other problems. If nothing works you can try this in your .profile. 1028into other problems. If nothing works you can try this in your .profile.
449.Sp 1029.PP
450.Vb 1 1030.Vb 1
451\& printf '\ee]701;%s\e007' "$LC_CTYPE" 1031\& printf '\ee]701;%s\e007' "$LC_CTYPE"
452.Ve 1032.Ve
453.Sp 1033.PP
454If this doesn't work, then maybe you use a \f(CW\*(C`LC_CTYPE\*(C'\fR specification not 1034If this doesn't work, then maybe you use a \f(CW\*(C`LC_CTYPE\*(C'\fR specification not
455supported on your systems. Some systems have a \f(CW\*(C`locale\*(C'\fR command which 1035supported on your systems. Some systems have a \f(CW\*(C`locale\*(C'\fR command which
456displays this (also, \f(CW\*(C`perl \-e0\*(C'\fR can be used to check locale settings, as 1036displays this (also, \f(CW\*(C`perl \-e0\*(C'\fR can be used to check locale settings, as
457it will complain loudly if it cannot set the locale). If it displays something 1037it will complain loudly if it cannot set the locale). If it displays something
458like: 1038like:
459.Sp 1039.PP
460.Vb 1 1040.Vb 1
461\& locale: Cannot set LC_CTYPE to default locale: ... 1041\& locale: Cannot set LC_CTYPE to default locale: ...
462.Ve 1042.Ve
463.Sp 1043.PP
464Then the locale you specified is not supported on your system. 1044Then the locale you specified is not supported on your system.
465.Sp 1045.PP
466If nothing works and you are sure that everything is set correctly then 1046If nothing works and you are sure that everything is set correctly then
467you will need to remember a little known fact: Some programs just don't 1047you will need to remember a little known fact: Some programs just don't
468support locales :( 1048support locales :(
469.IP "Why do some characters look so much different than others?" 4 1049.PP
470.IX Item "Why do some characters look so much different than others?" 1050\fIHow does rxvt-unicode determine the encoding to use?\fR
471.PD 0 1051.IX Subsection "How does rxvt-unicode determine the encoding to use?"
472.IP "How does rxvt-unicode choose fonts?" 4 1052.PP
473.IX Item "How does rxvt-unicode choose fonts?" 1053See next entry.
474.PD 1054.PP
475Most fonts do not contain the full range of Unicode, which is 1055\fIIs there an option to switch encodings?\fR
476fine. Chances are that the font you (or the admin/package maintainer of 1056.IX Subsection "Is there an option to switch encodings?"
477your system/os) have specified does not cover all the characters you want 1057.PP
478to display. 1058Unlike some other terminals, rxvt-unicode has no encoding switch, and no
479.Sp 1059specific \*(L"utf\-8\*(R" mode, such as xterm. In fact, it doesn't even know about
480\&\fBrxvt-unicode\fR makes a best-effort try at finding a replacement 1060\&\s-1UTF\-8\s0 or any other encodings with respect to terminal I/O.
481font. Often the result is fine, but sometimes the chosen font looks 1061.PP
482bad/ugly/wrong. Some fonts have totally strange characters that don't 1062The reasons is that there exists a perfectly fine mechanism for selecting
483resemble the correct glyph at all, and rxvt-unicode lacks the artificial 1063the encoding, doing I/O and (most important) communicating this to all
484intelligence to detect that a specific glyph is wrong: it has to believe 1064applications so everybody agrees on character properties such as width
485the font that the characters it claims to contain indeed look correct. 1065and code number. This mechanism is the \fIlocale\fR. Applications not using
486.Sp 1066that info will have problems (for example, \f(CW\*(C`xterm\*(C'\fR gets the width of
487In that case, select a font of your taste and add it to the font list, 1067characters wrong as it uses it's own, locale-independent table under all
488e.g.: 1068locales).
489.Sp 1069.PP
1070Rxvt-unicode uses the \f(CW\*(C`LC_CTYPE\*(C'\fR locale category to select encoding. All
1071programs doing the same (that is, most) will automatically agree in the
1072interpretation of characters.
1073.PP
1074Unfortunately, there is no system-independent way to select locales, nor
1075is there a standard on how locale specifiers will look like.
1076.PP
1077On most systems, the content of the \f(CW\*(C`LC_CTYPE\*(C'\fR environment variable
1078contains an arbitrary string which corresponds to an already-installed
1079locale. Common names for locales are \f(CW\*(C`en_US.UTF\-8\*(C'\fR, \f(CW\*(C`de_DE.ISO\-8859\-15\*(C'\fR,
1080\&\f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR, i.e. \f(CW\*(C`language_country.encoding\*(C'\fR, but other forms
1081(i.e. \f(CW\*(C`de\*(C'\fR or \f(CW\*(C`german\*(C'\fR) are also common.
1082.PP
1083Rxvt-unicode ignores all other locale categories, and except for
1084the encoding, ignores country or language-specific settings,
1085i.e. \f(CW\*(C`de_DE.UTF\-8\*(C'\fR and \f(CW\*(C`ja_JP.UTF\-8\*(C'\fR are the normally same to
1086rxvt\-unicode.
1087.PP
1088If you want to use a specific encoding you have to make sure you start
1089rxvt-unicode with the correct \f(CW\*(C`LC_CTYPE\*(C'\fR category.
1090.PP
1091\fICan I switch locales at runtime?\fR
1092.IX Subsection "Can I switch locales at runtime?"
1093.PP
1094Yes, using an escape sequence. Try something like this, which sets
1095rxvt\-unicode's idea of \f(CW\*(C`LC_CTYPE\*(C'\fR.
1096.PP
490.Vb 1 1097.Vb 1
491\& @@RXVT_NAME@@ -fn basefont,font2,font3... 1098\& printf '\ee]701;%s\e007' ja_JP.SJIS
492.Ve 1099.Ve
493.Sp 1100.PP
494When rxvt-unicode sees a character, it will first look at the base 1101See also the previous answer.
495font. If the base font does not contain the character, it will go to the 1102.PP
496next font, and so on. Specifying your own fonts will also speed up this 1103Sometimes this capability is rather handy when you want to work in
497search and use less resources within rxvt-unicode and the X\-server. 1104one locale (e.g. \f(CW\*(C`de_DE.UTF\-8\*(C'\fR) but some programs don't support it
498.Sp 1105(e.g. \s-1UTF\-8\s0). For example, I use this script to start \f(CW\*(C`xjdic\*(C'\fR, which
499The only limitation is that none of the fonts may be larger than the base 1106first switches to a locale supported by xjdic and back later:
500font, as the base font defines the terminal character cell size, which 1107.PP
501must be the same due to the way terminals work. 1108.Vb 3
502.IP "Why do some chinese characters look so different than others?" 4 1109\& printf '\ee]701;%s\e007' ja_JP.SJIS
503.IX Item "Why do some chinese characters look so different than others?" 1110\& xjdic -js
504This is because there is a difference between script and language \*(-- 1111\& printf '\ee]701;%s\e007' de_DE.UTF-8
505rxvt-unicode does not know which language the text that is output is, 1112.Ve
506as it only knows the unicode character codes. If rxvt-unicode first 1113.PP
507sees a japanese/chinese character, it might choose a japanese font for 1114You can also use xterm's \f(CW\*(C`luit\*(C'\fR program, which usually works fine, except
508display. Subsequent japanese characters will use that font. Now, many 1115for some locales where character width differs between program\- and
509chinese characters aren't represented in japanese fonts, so when the first 1116rxvt\-unicode\-locales.
510non-japanese character comes up, rxvt-unicode will look for a chinese font 1117.PP
511\&\*(-- unfortunately at this point, it will still use the japanese font for 1118\fIMy input method wants <some encoding> but I want \s-1UTF\-8\s0, what can I do?\fR
512chinese characters that are also in the japanese font. 1119.IX Subsection "My input method wants <some encoding> but I want UTF-8, what can I do?"
513.Sp 1120.PP
514The workaround is easy: just tag a chinese font at the end of your font 1121You can specify separate locales for the input method and the rest of the
515list (see the previous question). The key is to view the font list as 1122terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
516a preference list: If you expect more japanese, list a japanese font 1123.PP
517first. If you expect more chinese, put a chinese font first. 1124.Vb 1
518.Sp 1125\& URxvt.imlocale: ja_JP.EUC-JP
519In the future it might be possible to switch language preferences at 1126.Ve
520runtime (the internal data structure has no problem with using different 1127.PP
521fonts for the same character at the same time, but no interface for this 1128Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
522has been designed yet). 1129use your input method. Please note, however, that you will not be able to
523.Sp 1130input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input
524Until then, you might get away with switching fonts at runtime (see \*(L"Can I switch the fonts at runtime?\*(R" later in this document). 1131method limits you.
525.IP "Why does rxvt-unicode sometimes leave pixel droppings?" 4 1132.PP
526.IX Item "Why does rxvt-unicode sometimes leave pixel droppings?" 1133\fIRxvt-unicode crashes when the X Input Method changes or exits.\fR
527Most fonts were not designed for terminal use, which means that character 1134.IX Subsection "Rxvt-unicode crashes when the X Input Method changes or exits."
528size varies a lot. A font that is otherwise fine for terminal use might 1135.PP
529contain some characters that are simply too wide. Rxvt-unicode will avoid 1136Unfortunately, this is unavoidable, as the \s-1XIM\s0 protocol is racy by
530these characters. For characters that are just \*(L"a bit\*(R" too wide a special 1137design. Applications can avoid some crashes at the expense of memory
531\&\*(L"careful\*(R" rendering mode is used that redraws adjacent characters. 1138leaks, and Input Methods can avoid some crashes by careful ordering at
532.Sp 1139exit time. \fBkinput2\fR (and derived input methods) generally succeeds,
533All of this requires that fonts do not lie about character sizes, 1140while \fB\s-1SCIM\s0\fR (or similar input methods) fails. In the end, however,
534however: Xft fonts often draw glyphs larger than their acclaimed bounding 1141crashes cannot be completely avoided even if both sides cooperate.
535box, and rxvt-unicode has no way of detecting this (the correct way is to 1142.PP
536ask for the character bounding box, which unfortunately is wrong in these 1143So the only workaround is not to kill your Input Method Servers.
537cases). 1144.Sh "Operating Systems / Package Maintaining"
538.Sp 1145.IX Subsection "Operating Systems / Package Maintaining"
539It's not clear (to me at least), wether this is a bug in Xft, freetype, 1146\fII am using Debian GNU/Linux and have a problem...\fR
540or the respective font. If you encounter this problem you might try using 1147.IX Subsection "I am using Debian GNU/Linux and have a problem..."
541the \f(CW\*(C`\-lsp\*(C'\fR option to give the font more height. If that doesn't work, you 1148.PP
542might be forced to use a different font. 1149The Debian GNU/Linux package of rxvt-unicode in sarge contains large
543.Sp 1150patches that considerably change the behaviour of rxvt-unicode (but
544All of this is not a problem when using X11 core fonts, as their bounding 1151unfortunately this notice has been removed). Before reporting a bug to
545box data is correct. 1152the original rxvt-unicode author please download and install the genuine
1153version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce
1154the problem. If you cannot, chances are that the problems are specific to
1155Debian GNU/Linux, in which case it should be reported via the Debian Bug
1156Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug).
1157.PP
1158For other problems that also affect the Debian package, you can and
1159probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a
1160bug in the Debian version and it serves as a reminder for other users that
1161might encounter the same issue.
1162.PP
1163\fII am maintaining rxvt-unicode for distribution/OS \s-1XXX\s0, any recommendation?\fR
1164.IX Subsection "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?"
1165.PP
1166You should build one binary with the default options. \fIconfigure\fR
1167now enables most useful options, and the trend goes to making them
1168runtime\-switchable, too, so there is usually no drawback to enbaling them,
1169except higher disk and possibly memory usage. The perl interpreter should
1170be enabled, as important functionality (menus, selection, likely more in
1171the future) depends on it.
1172.PP
1173You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR snd \f(CW\*(C`perl\-ext\*(C'\fR resources
1174system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful
1175behaviour. If your distribution aims at low memory, add an empty
1176\&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the
1177perl interpreter disabled until the user enables it.
1178.PP
1179If you can/want build more binaries, I recommend building a minimal
1180one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with
1181\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of
1182encodings built-in that increase download times and are rarely used).
1183.PP
1184\fII need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?\fR
1185.IX Subsection "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?"
1186.PP
1187It should be, starting with release 7.1. You are encouraged to properly
1188install urxvt with privileges necessary for your \s-1OS\s0 now.
1189.PP
1190When rxvt-unicode detects that it runs setuid or setgid, it will fork
1191into a helper process for privileged operations (pty handling on some
1192systems, utmp/wtmp/lastlog handling on others) and drop privileges
1193immediately. This is much safer than most other terminals that keep
1194privileges while running (but is more relevant to urxvt, as it contains
1195things as perl interpreters, which might be \*(L"helpful\*(R" to attackers).
1196.PP
1197This forking is done as the very first within \fImain()\fR, which is very early
1198and reduces possible bugs to initialisation code run before \fImain()\fR, or
1199things like the dynamic loader of your system, which should result in very
1200little risk.
1201.PP
546.IP "On Solaris 9, many line-drawing characters are too wide." 4 1202\fIOn Solaris 9, many line-drawing characters are too wide.\fR
547.IX Item "On Solaris 9, many line-drawing characters are too wide." 1203.IX Subsection "On Solaris 9, many line-drawing characters are too wide."
1204.PP
548Seems to be a known bug, read 1205Seems to be a known bug, read
549<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1206<http://nixdoc.net/files/forum/about34198.html>. Some people use the
550following ugly workaround to get non-double-wide-characters working: 1207following ugly workaround to get non-double-wide-characters working:
551.Sp 1208.PP
552.Vb 1 1209.Vb 1
553\& #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 1210\& #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
554.Ve 1211.Ve
555.IP "My Compose (Multi_key) key is no longer working." 4 1212.PP
556.IX Item "My Compose (Multi_key) key is no longer working."
557The most common causes for this are that either your locale is not set
558correctly, or you specified a \fBpreeditStyle\fR that is not supported by
559your input method. For example, if you specified \fBOverTheSpot\fR and
560your input method (e.g. the default input method handling Compose keys)
561does not support this (for instance because it is not visual), then
562rxvt-unicode will continue without an input method.
563.Sp
564In this case either do not specify a \fBpreeditStyle\fR or specify more than
565one pre-edit style, such as \fBOverTheSpot,Root,None\fR.
566.ie n .IP "I cannot type ""Ctrl\-Shift\-2"" to get an \s-1ASCII\s0 \s-1NUL\s0 character due to \s-1ISO\s0 14755" 4
567.el .IP "I cannot type \f(CWCtrl\-Shift\-2\fR to get an \s-1ASCII\s0 \s-1NUL\s0 character due to \s-1ISO\s0 14755" 4
568.IX Item "I cannot type Ctrl-Shift-2 to get an ASCII NUL character due to ISO 14755"
569Either try \f(CW\*(C`Ctrl\-2\*(C'\fR alone (it often is mapped to \s-1ASCII\s0 \s-1NUL\s0 even on
570international keyboards) or simply use \s-1ISO\s0 14755 support to your
571advantage, typing <Ctrl\-Shift\-0> to get a \s-1ASCII\s0 \s-1NUL\s0. This works for other
572codes, too, such as \f(CW\*(C`Ctrl\-Shift\-1\-d\*(C'\fR to type the default telnet escape
573character and so on.
574.IP "How can I keep rxvt-unicode from using reverse video so much?" 4
575.IX Item "How can I keep rxvt-unicode from using reverse video so much?"
576First of all, make sure you are running with the right terminal settings
577(\f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR), which will get rid of most of these effects. Then
578make sure you have specified colours for italic and bold, as otherwise
579rxvt-unicode might use reverse video to simulate the effect:
580.Sp
581.Vb 2
582\& URxvt.colorBD: white
583\& URxvt.colorIT: green
584.Ve
585.IP "Some programs assume totally weird colours (red instead of blue), how can I fix that?" 4
586.IX Item "Some programs assume totally weird colours (red instead of blue), how can I fix that?"
587For some unexplainable reason, some rare programs assume a very weird
588colour palette when confronted with a terminal with more than the standard
5898 colours (rxvt\-unicode supports 88). The right fix is, of course, to fix
590these programs not to assume non-ISO colours without very good reasons.
591.Sp
592In the meantime, you can either edit your \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo
593definition to only claim 8 colour support or use \f(CW\*(C`TERM=rxvt\*(C'\fR, which will
594fix colours but keep you from using other rxvt-unicode features.
595.IP "I am on FreeBSD and rxvt-unicode does not seem to work at all." 4 1213\fII am on FreeBSD and rxvt-unicode does not seem to work at all.\fR
596.IX Item "I am on FreeBSD and rxvt-unicode does not seem to work at all." 1214.IX Subsection "I am on FreeBSD and rxvt-unicode does not seem to work at all."
1215.PP
597Rxvt-unicode requires the symbol \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR to be defined 1216Rxvt-unicode requires the symbol \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR to be defined
598in your compile environment, or an implementation that implements it, 1217in your compile environment, or an implementation that implements it,
599wether it defines the symbol or not. \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR requires that 1218wether it defines the symbol or not. \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR requires that
600\&\fBwchar_t\fR is represented as unicode. 1219\&\fBwchar_t\fR is represented as unicode.
601.Sp 1220.PP
602As you might have guessed, FreeBSD does neither define this symobl nor 1221As you might have guessed, FreeBSD does neither define this symobl nor
603does it support it. Instead, it uses it's own internal representation of 1222does it support it. Instead, it uses it's own internal representation of
604\&\fBwchar_t\fR. This is, of course, completely fine with respect to standards. 1223\&\fBwchar_t\fR. This is, of course, completely fine with respect to standards.
605.Sp 1224.PP
606However, that means rxvt-unicode only works in \f(CW\*(C`POSIX\*(C'\fR, \f(CW\*(C`ISO\-8859\-1\*(C'\fR and 1225However, that means rxvt-unicode only works in \f(CW\*(C`POSIX\*(C'\fR, \f(CW\*(C`ISO\-8859\-1\*(C'\fR and
607\&\f(CW\*(C`UTF\-8\*(C'\fR locales under FreeBSD (which all use Unicode as \fBwchar_t\fR. 1226\&\f(CW\*(C`UTF\-8\*(C'\fR locales under FreeBSD (which all use Unicode as \fBwchar_t\fR.
608.Sp 1227.PP
609\&\f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR is the only sane way to support multi-language 1228\&\f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR is the only sane way to support multi-language
610apps in an \s-1OS\s0, as using a locale-dependent (and non\-standardized) 1229apps in an \s-1OS\s0, as using a locale-dependent (and non\-standardized)
611representation of \fBwchar_t\fR makes it impossible to convert between 1230representation of \fBwchar_t\fR makes it impossible to convert between
612\&\fBwchar_t\fR (as used by X11 and your applications) and any other encoding 1231\&\fBwchar_t\fR (as used by X11 and your applications) and any other encoding
613without implementing OS-specific-wrappers for each and every locale. There 1232without implementing OS-specific-wrappers for each and every locale. There
614simply are no APIs to convert \fBwchar_t\fR into anything except the current 1233simply are no APIs to convert \fBwchar_t\fR into anything except the current
615locale encoding. 1234locale encoding.
616.Sp 1235.PP
617Some applications (such as the formidable \fBmlterm\fR) work around this 1236Some applications (such as the formidable \fBmlterm\fR) work around this
618by carrying their own replacement functions for character set handling 1237by carrying their own replacement functions for character set handling
619with them, and either implementing OS-dependent hacks or doing multiple 1238with them, and either implementing OS-dependent hacks or doing multiple
620conversions (which is slow and unreliable in case the \s-1OS\s0 implements 1239conversions (which is slow and unreliable in case the \s-1OS\s0 implements
621encodings slightly different than the terminal emulator). 1240encodings slightly different than the terminal emulator).
622.Sp 1241.PP
623The rxvt-unicode author insists that the right way to fix this is in the 1242The rxvt-unicode author insists that the right way to fix this is in the
624system libraries once and for all, instead of forcing every app to carry 1243system libraries once and for all, instead of forcing every app to carry
625complete replacements for them :) 1244complete replacements for them :)
1245.PP
626.IP "I use Solaris 9 and it doesn't compile/work/etc." 4 1246\fII use Solaris 9 and it doesn't compile/work/etc.\fR
627.IX Item "I use Solaris 9 and it doesn't compile/work/etc." 1247.IX Subsection "I use Solaris 9 and it doesn't compile/work/etc."
1248.PP
628Try the diff in \fIdoc/solaris9.patch\fR as a base. It fixes the worst 1249Try the diff in \fIdoc/solaris9.patch\fR as a base. It fixes the worst
629problems with \f(CW\*(C`wcwidth\*(C'\fR and a compile problem. 1250problems with \f(CW\*(C`wcwidth\*(C'\fR and a compile problem.
1251.PP
630.IP "How can I use rxvt-unicode under cygwin?" 4 1252\fIHow can I use rxvt-unicode under cygwin?\fR
631.IX Item "How can I use rxvt-unicode under cygwin?" 1253.IX Subsection "How can I use rxvt-unicode under cygwin?"
1254.PP
632rxvt-unicode should compile and run out of the box on cygwin, using 1255rxvt-unicode should compile and run out of the box on cygwin, using
633the X11 libraries that come with cygwin. libW11 emulation is no 1256the X11 libraries that come with cygwin. libW11 emulation is no
634longer supported (and makes no sense, either, as it only supported a 1257longer supported (and makes no sense, either, as it only supported a
635single font). I recommend starting the X\-server in \f(CW\*(C`\-multiwindow\*(C'\fR or 1258single font). I recommend starting the X\-server in \f(CW\*(C`\-multiwindow\*(C'\fR or
636\&\f(CW\*(C`\-rootless\*(C'\fR mode instead, which will result in similar look&feel as the 1259\&\f(CW\*(C`\-rootless\*(C'\fR mode instead, which will result in similar look&feel as the
637old libW11 emulation. 1260old libW11 emulation.
638.Sp 1261.PP
639At the time of this writing, cygwin didn't seem to support any multi-byte 1262At the time of this writing, cygwin didn't seem to support any multi-byte
640encodings (you might try \f(CW\*(C`LC_CTYPE=C\-UTF\-8\*(C'\fR), so you are likely limited 1263encodings (you might try \f(CW\*(C`LC_CTYPE=C\-UTF\-8\*(C'\fR), so you are likely limited
641to 8\-bit encodings. 1264to 8\-bit encodings.
642.IP "How does rxvt-unicode determine the encoding to use?" 4
643.IX Item "How does rxvt-unicode determine the encoding to use?"
644.PD 0
645.IP "Is there an option to switch encodings?" 4
646.IX Item "Is there an option to switch encodings?"
647.PD
648Unlike some other terminals, rxvt-unicode has no encoding switch, and no
649specific \*(L"utf\-8\*(R" mode, such as xterm. In fact, it doesn't even know about
650\&\s-1UTF\-8\s0 or any other encodings with respect to terminal I/O.
651.Sp
652The reasons is that there exists a perfectly fine mechanism for selecting
653the encoding, doing I/O and (most important) communicating this to all
654applications so everybody agrees on character properties such as width
655and code number. This mechanism is the \fIlocale\fR. Applications not using
656that info will have problems (for example, \f(CW\*(C`xterm\*(C'\fR gets the width of
657characters wrong as it uses it's own, locale-independent table under all
658locales).
659.Sp
660Rxvt-unicode uses the \f(CW\*(C`LC_CTYPE\*(C'\fR locale category to select encoding. All
661programs doing the same (that is, most) will automatically agree in the
662interpretation of characters.
663.Sp
664Unfortunately, there is no system-independent way to select locales, nor
665is there a standard on how locale specifiers will look like.
666.Sp
667On most systems, the content of the \f(CW\*(C`LC_CTYPE\*(C'\fR environment variable
668contains an arbitrary string which corresponds to an already-installed
669locale. Common names for locales are \f(CW\*(C`en_US.UTF\-8\*(C'\fR, \f(CW\*(C`de_DE.ISO\-8859\-15\*(C'\fR,
670\&\f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR, i.e. \f(CW\*(C`language_country.encoding\*(C'\fR, but other forms
671(i.e. \f(CW\*(C`de\*(C'\fR or \f(CW\*(C`german\*(C'\fR) are also common.
672.Sp
673Rxvt-unicode ignores all other locale categories, and except for
674the encoding, ignores country or language-specific settings,
675i.e. \f(CW\*(C`de_DE.UTF\-8\*(C'\fR and \f(CW\*(C`ja_JP.UTF\-8\*(C'\fR are the normally same to
676rxvt\-unicode.
677.Sp
678If you want to use a specific encoding you have to make sure you start
679rxvt-unicode with the correct \f(CW\*(C`LC_CTYPE\*(C'\fR category.
680.IP "Can I switch locales at runtime?" 4
681.IX Item "Can I switch locales at runtime?"
682Yes, using an escape sequence. Try something like this, which sets
683rxvt\-unicode's idea of \f(CW\*(C`LC_CTYPE\*(C'\fR.
684.Sp
685.Vb 1
686\& printf '\ee]701;%s\e007' ja_JP.SJIS
687.Ve
688.Sp
689See also the previous answer.
690.Sp
691Sometimes this capability is rather handy when you want to work in
692one locale (e.g. \f(CW\*(C`de_DE.UTF\-8\*(C'\fR) but some programs don't support it
693(e.g. \s-1UTF\-8\s0). For example, I use this script to start \f(CW\*(C`xjdic\*(C'\fR, which
694first switches to a locale supported by xjdic and back later:
695.Sp
696.Vb 3
697\& printf '\ee]701;%s\e007' ja_JP.SJIS
698\& xjdic -js
699\& printf '\ee]701;%s\e007' de_DE.UTF-8
700.Ve
701.Sp
702You can also use xterm's \f(CW\*(C`luit\*(C'\fR program, which usually works fine, except
703for some locales where character width differs between program\- and
704rxvt\-unicode\-locales.
705.IP "Can I switch the fonts at runtime?" 4
706.IX Item "Can I switch the fonts at runtime?"
707Yes, using an escape sequence. Try something like this, which has the same
708effect as using the \f(CW\*(C`\-fn\*(C'\fR switch, and takes effect immediately:
709.Sp
710.Vb 1
711\& printf '\ee]50;%s\e007' "9x15bold,xft:Kochi Gothic"
712.Ve
713.Sp
714This is useful if you e.g. work primarily with japanese (and prefer a
715japanese font), but you have to switch to chinese temporarily, where
716japanese fonts would only be in your way.
717.Sp
718You can think of this as a kind of manual \s-1ISO\-2022\s0 switching.
719.IP "Why do italic characters look as if clipped?" 4
720.IX Item "Why do italic characters look as if clipped?"
721Many fonts have difficulties with italic characters and hinting. For
722example, the otherwise very nicely hinted font \f(CW\*(C`xft:Bitstream Vera Sans
723Mono\*(C'\fR completely fails in it's italic face. A workaround might be to
724enable freetype autohinting, i.e. like this:
725.Sp
726.Vb 2
727\& URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
728\& URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
729.Ve
730.IP "My input method wants <some encoding> but I want \s-1UTF\-8\s0, what can I do?" 4
731.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?"
732You can specify separate locales for the input method and the rest of the
733terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
734.Sp
735.Vb 1
736\& URxvt*imlocale: ja_JP.EUC-JP
737.Ve
738.Sp
739Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
740use your input method. Please note, however, that you will not be able to
741input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input
742method limits you.
743.IP "Rxvt-unicode crashes when the X Input Method changes or exits." 4
744.IX Item "Rxvt-unicode crashes when the X Input Method changes or exits."
745Unfortunately, this is unavoidable, as the \s-1XIM\s0 protocol is racy by
746design. Applications can avoid some crashes at the expense of memory
747leaks, and Input Methods can avoid some crashes by careful ordering at
748exit time. \fBkinput2\fR (and derived input methods) generally succeeds,
749while \fB\s-1SCIM\s0\fR (or similar input methods) fails. In the end, however,
750crashes cannot be completely avoided even if both sides cooperate.
751.Sp
752So the only workaround is not to kill your Input Method Servers.
753.IP "Rxvt-unicode uses gobs of memory, how can I reduce that?" 4
754.IX Item "Rxvt-unicode uses gobs of memory, how can I reduce that?"
755Rxvt-unicode tries to obey the rule of not charging you for something you
756don't use. One thing you should try is to configure out all settings that
757you don't need, for example, Xft support is a resource hog by design,
758when used. Compiling it out ensures that no Xft font will be loaded
759accidentally when rxvt-unicode tries to find a font for your characters.
760.Sp
761Also, many people (me included) like large windows and even larger
762scrollback buffers: Without \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR, rxvt-unicode will use
7636 bytes per screen cell. For a 160x?? window this amounts to almost a
764kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
765use 10 Megabytes of memory. With \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR it gets worse, as
766rxvt-unicode then uses 8 bytes per screen cell.
767.IP "Can I speed up Xft rendering somehow?" 4
768.IX Item "Can I speed up Xft rendering somehow?"
769Yes, the most obvious way to speed it up is to avoid Xft entirely, as
770it is simply slow. If you still want Xft fonts you might try to disable
771antialiasing (by appending \f(CW\*(C`:antialias=false\*(C'\fR), which saves lots of
772memory and also speeds up rendering considerably.
773.IP "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?" 4
774.IX Item "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?"
775Rxvt-unicode will use whatever you specify as a font. If it needs to
776fall back to it's default font search list it will prefer X11 core
777fonts, because they are small and fast, and then use Xft fonts. It has
778antialiasing disabled for most of them, because the author thinks they
779look best that way.
780.Sp
781If you want antialiasing, you have to specify the fonts manually.
782.IP "Mouse cut/paste suddenly no longer works." 4
783.IX Item "Mouse cut/paste suddenly no longer works."
784Make sure that mouse reporting is actually turned off since killing
785some editors prematurely may leave the mouse in mouse report mode. I've
786heard that tcsh may use mouse reporting unless it otherwise specified. A
787quick check is to see if cut/paste works when the Alt or Shift keys are
788depressed. See @@RXVT_NAME@@(7)
789.IP "What's with this bold/blink stuff?" 4
790.IX Item "What's with this bold/blink stuff?"
791If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
792standard foreground colour.
793.Sp
794For the standard background colour, blinking will actually make the
795text blink when compiled with \f(CW\*(C`\-\-enable\-blinking\*(C'\fR. with standard
796colours. Without \f(CW\*(C`\-\-enable\-blinking\*(C'\fR, the blink attribute will be
797ignored.
798.Sp
799On \s-1ANSI\s0 colours, bold/blink attributes are used to set high-intensity
800foreground/background colors.
801.Sp
802color0\-7 are the low-intensity colors.
803.Sp
804color8\-15 are the corresponding high-intensity colors.
805.IP "I don't like the screen colors. How do I change them?" 4
806.IX Item "I don't like the screen colors. How do I change them?"
807You can change the screen colors at run-time using \fI~/.Xdefaults\fR
808resources (or as long\-options).
809.Sp
810Here are values that are supposed to resemble a \s-1VGA\s0 screen,
811including the murky brown that passes for low-intensity yellow:
812.Sp
813.Vb 8
814\& URxvt.color0: #000000
815\& URxvt.color1: #A80000
816\& URxvt.color2: #00A800
817\& URxvt.color3: #A8A800
818\& URxvt.color4: #0000A8
819\& URxvt.color5: #A800A8
820\& URxvt.color6: #00A8A8
821\& URxvt.color7: #A8A8A8
822.Ve
823.Sp
824.Vb 8
825\& URxvt.color8: #000054
826\& URxvt.color9: #FF0054
827\& URxvt.color10: #00FF54
828\& URxvt.color11: #FFFF54
829\& URxvt.color12: #0000FF
830\& URxvt.color13: #FF00FF
831\& URxvt.color14: #00FFFF
832\& URxvt.color15: #FFFFFF
833.Ve
834.Sp
835And here is a more complete set of non-standard colors described (not by
836me) as \*(L"pretty girly\*(R".
837.Sp
838.Vb 18
839\& URxvt.cursorColor: #dc74d1
840\& URxvt.pointerColor: #dc74d1
841\& URxvt.background: #0e0e0e
842\& URxvt.foreground: #4ad5e1
843\& URxvt.color0: #000000
844\& URxvt.color8: #8b8f93
845\& URxvt.color1: #dc74d1
846\& URxvt.color9: #dc74d1
847\& URxvt.color2: #0eb8c7
848\& URxvt.color10: #0eb8c7
849\& URxvt.color3: #dfe37e
850\& URxvt.color11: #dfe37e
851\& URxvt.color5: #9e88f0
852\& URxvt.color13: #9e88f0
853\& URxvt.color6: #73f7ff
854\& URxvt.color14: #73f7ff
855\& URxvt.color7: #e1dddd
856\& URxvt.color15: #e1dddd
857.Ve
858.IP "How can I start @@RXVT_NAME@@d in a race-free way?" 4
859.IX Item "How can I start @@RXVT_NAME@@d in a race-free way?"
860Try \f(CW\*(C`@@RXVT_NAME@@d \-f \-o\*(C'\fR, which tells @@RXVT_NAME@@d to open the
861display, create the listening socket and then fork.
862.IP "What's with the strange Backspace/Delete key behaviour?" 4
863.IX Item "What's with the strange Backspace/Delete key behaviour?"
864Assuming that the physical Backspace key corresponds to the
865BackSpace keysym (not likely for Linux ... see the following
866question) there are two standard values that can be used for
867Backspace: \f(CW\*(C`^H\*(C'\fR and \f(CW\*(C`^?\*(C'\fR.
868.Sp
869Historically, either value is correct, but rxvt-unicode adopts the debian
870policy of using \f(CW\*(C`^?\*(C'\fR when unsure, because it's the one only only correct
871choice :).
872.Sp
873Rxvt-unicode tries to inherit the current stty settings and uses the value
874of `erase' to guess the value for backspace. If rxvt-unicode wasn't
875started from a terminal (say, from a menu or by remote shell), then the
876system value of `erase', which corresponds to \s-1CERASE\s0 in <termios.h>, will
877be used (which may not be the same as your stty setting).
878.Sp
879For starting a new rxvt\-unicode:
880.Sp
881.Vb 3
882\& # use Backspace = ^H
883\& $ stty erase ^H
884\& $ @@RXVT_NAME@@
885.Ve
886.Sp
887.Vb 3
888\& # use Backspace = ^?
889\& $ stty erase ^?
890\& $ @@RXVT_NAME@@
891.Ve
892.Sp
893Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR as documented in @@RXVT_NAME@@(7).
894.Sp
895For an existing rxvt\-unicode:
896.Sp
897.Vb 3
898\& # use Backspace = ^H
899\& $ stty erase ^H
900\& $ echo -n "^[[36h"
901.Ve
902.Sp
903.Vb 3
904\& # use Backspace = ^?
905\& $ stty erase ^?
906\& $ echo -n "^[[36l"
907.Ve
908.Sp
909This helps satisfy some of the Backspace discrepancies that occur, but
910if you use Backspace = \f(CW\*(C`^H\*(C'\fR, make sure that the termcap/terminfo value
911properly reflects that.
912.Sp
913The Delete key is a another casualty of the ill-defined Backspace problem.
914To avoid confusion between the Backspace and Delete keys, the Delete
915key has been assigned an escape sequence to match the vt100 for Execute
916(\f(CW\*(C`ESC [ 3 ~\*(C'\fR) and is in the supplied termcap/terminfo.
917.Sp
918Some other Backspace problems:
919.Sp
920some editors use termcap/terminfo,
921some editors (vim I'm told) expect Backspace = ^H,
922\&\s-1GNU\s0 Emacs (and Emacs-like editors) use ^H for help.
923.Sp
924Perhaps someday this will all be resolved in a consistent manner.
925.IP "I don't like the key\-bindings. How do I change them?" 4
926.IX Item "I don't like the key-bindings. How do I change them?"
927There are some compile-time selections available via configure. Unless
928you have run \*(L"configure\*(R" with the \f(CW\*(C`\-\-disable\-resources\*(C'\fR option you can
929use the `keysym' resource to alter the keystrings associated with keysyms.
930.Sp
931Here's an example for a URxvt session started using \f(CW\*(C`@@RXVT_NAME@@ \-name URxvt\*(C'\fR
932.Sp
933.Vb 20
934\& URxvt.keysym.Home: \e033[1~
935\& URxvt.keysym.End: \e033[4~
936\& URxvt.keysym.C-apostrophe: \e033<C-'>
937\& URxvt.keysym.C-slash: \e033<C-/>
938\& URxvt.keysym.C-semicolon: \e033<C-;>
939\& URxvt.keysym.C-grave: \e033<C-`>
940\& URxvt.keysym.C-comma: \e033<C-,>
941\& URxvt.keysym.C-period: \e033<C-.>
942\& URxvt.keysym.C-0x60: \e033<C-`>
943\& URxvt.keysym.C-Tab: \e033<C-Tab>
944\& URxvt.keysym.C-Return: \e033<C-Return>
945\& URxvt.keysym.S-Return: \e033<S-Return>
946\& URxvt.keysym.S-space: \e033<S-Space>
947\& URxvt.keysym.M-Up: \e033<M-Up>
948\& URxvt.keysym.M-Down: \e033<M-Down>
949\& URxvt.keysym.M-Left: \e033<M-Left>
950\& URxvt.keysym.M-Right: \e033<M-Right>
951\& URxvt.keysym.M-C-0: list \e033<M-C- 0123456789 >
952\& URxvt.keysym.M-C-a: list \e033<M-C- abcdefghijklmnopqrstuvwxyz >
953\& URxvt.keysym.F12: command:\e033]701;zh_CN.GBK\e007
954.Ve
955.Sp
956See some more examples in the documentation for the \fBkeysym\fR resource.
957.IP "I'm using keyboard model \s-1XXX\s0 that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following mappings that rxvt-unicode doesn't recognize." 4
958.IX Item "I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following mappings that rxvt-unicode doesn't recognize."
959.Vb 6
960\& KP_Insert == Insert
961\& F22 == Print
962\& F27 == Home
963\& F29 == Prior
964\& F33 == End
965\& F35 == Next
966.Ve
967.Sp
968Rather than have rxvt-unicode try to accommodate all the various possible
969keyboard mappings, it is better to use `xmodmap' to remap the keys as
970required for your particular machine.
971.IP "How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc." 4
972.IX Item "How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc."
973rxvt and rxvt-unicode always export the variable \*(L"\s-1COLORTERM\s0\*(R", so you can
974check and see if that is set. Note that several programs, \s-1JED\s0, slrn,
975Midnight Commander automatically check this variable to decide whether or
976not to use color.
977.IP "How do I set the correct, full \s-1IP\s0 address for the \s-1DISPLAY\s0 variable?" 4
978.IX Item "How do I set the correct, full IP address for the DISPLAY variable?"
979If you've compiled rxvt-unicode with \s-1DISPLAY_IS_IP\s0 and have enabled
980insecure mode then it is possible to use the following shell script
981snippets to correctly set the display. If your version of rxvt-unicode
982wasn't also compiled with \s-1ESCZ_ANSWER\s0 (as assumed in these snippets) then
983the \s-1COLORTERM\s0 variable can be used to distinguish rxvt-unicode from a
984regular xterm.
985.Sp
986Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
987snippets:
988.Sp
989.Vb 12
990\& # Bourne/Korn/POSIX family of shells:
991\& [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
992\& if [ ${TERM:-foo} = xterm ]; then
993\& stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
994\& echo -n '^[Z'
995\& read term_id
996\& stty icanon echo
997\& if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
998\& echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
999\& read DISPLAY # set it in our local shell
1000\& fi
1001\& fi
1002.Ve
1003.IP "How do I compile the manual pages for myself?" 4
1004.IX Item "How do I compile the manual pages for myself?"
1005You need to have a recent version of perl installed as \fI/usr/bin/perl\fR,
1006one that comes with \fIpod2man\fR, \fIpod2text\fR and \fIpod2html\fR. Then go to
1007the doc subdirectory and enter \f(CW\*(C`make alldoc\*(C'\fR.
1008.IP "My question isn't answered here, can I ask a human?" 4
1009.IX Item "My question isn't answered here, can I ask a human?"
1010Before sending me mail, you could go to \s-1IRC:\s0 \f(CW\*(C`irc.freenode.net\*(C'\fR,
1011channel \f(CW\*(C`#rxvt\-unicode\*(C'\fR has some rxvt-unicode enthusiasts that might be
1012interested in learning about new and exciting problems (but not FAQs :).
1013.SH "RXVT TECHNICAL REFERENCE" 1265.SH "RXVT-UNICODE TECHNICAL REFERENCE"
1014.IX Header "RXVT TECHNICAL REFERENCE" 1266.IX Header "RXVT-UNICODE TECHNICAL REFERENCE"
1015.SH "DESCRIPTION" 1267.SH "DESCRIPTION"
1016.IX Header "DESCRIPTION" 1268.IX Header "DESCRIPTION"
1017The rest of this document describes various technical aspects of 1269The rest of this document describes various technical aspects of
1018\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1270\&\fBrxvt-unicode\fR. First the description of supported command sequences,
1019followed by menu and pixmap support and last by a description of all 1271followed by pixmap support and last by a description of all features
1020features selectable at \f(CW\*(C`configure\*(C'\fR time. 1272selectable at \f(CW\*(C`configure\*(C'\fR time.
1021.SH "Definitions" 1273.SH "Definitions"
1022.IX Header "Definitions" 1274.IX Header "Definitions"
1023.ie n .IP "\fB\fB""c""\fB\fR" 4 1275.ie n .IP "\fB\fB""c""\fB\fR" 4
1024.el .IP "\fB\f(CBc\fB\fR" 4 1276.el .IP "\fB\f(CBc\fB\fR" 4
1025.IX Item "c" 1277.IX Item "c"
1572l l . 1824l l .
1573h Send Mouse X & Y on button press. 1825h Send Mouse X & Y on button press.
1574l No mouse reporting. 1826l No mouse reporting.
1575.TE 1827.TE
1576 1828
1577.ie n .IP "\fB\fB""Ps = 10""\fB\fR (\fBrxvt\fR)" 4
1578.el .IP "\fB\f(CBPs = 10\fB\fR (\fBrxvt\fR)" 4
1579.IX Item "Ps = 10 (rxvt)"
1580.TS
1581l l .
1582h menuBar visible
1583l menuBar invisible
1584.TE
1585
1586.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 1829.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4
1587.el .IP "\fB\f(CBPs = 25\fB\fR" 4 1830.el .IP "\fB\f(CBPs = 25\fB\fR" 4
1588.IX Item "Ps = 25" 1831.IX Item "Ps = 25"
1589.TS 1832.TS
1590l l . 1833l l .
1776Ps = 12 Change colour of text cursor foreground to Pt 2019Ps = 12 Change colour of text cursor foreground to Pt
1777Ps = 13 Change colour of mouse foreground to Pt 2020Ps = 13 Change colour of mouse foreground to Pt
1778Ps = 17 Change colour of highlight characters to Pt 2021Ps = 17 Change colour of highlight characters to Pt
1779Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] 2022Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1780Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] 2023Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1781Ps = 20 Change default background to Pt 2024Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1782Ps = 39 Change default foreground colour to Pt. 2025Ps = 39 Change default foreground colour to Pt.
1783Ps = 46 Change Log File to Pt unimplemented 2026Ps = 46 Change Log File to Pt unimplemented
1784Ps = 49 Change default background colour to Pt. 2027Ps = 49 Change default background colour to Pt.
1785Ps = 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 2028Ps = 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
1786Ps = 55 Log all scrollback buffer and all of screen to Pt 2029Ps = 55 Log all scrollback buffer and all of screen to Pt
1787Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 2030Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1788Ps = 703 Menubar command Pt (Compile menubar). 2031Ps = 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.
1789Ps = 704 Change colour of italic characters to Pt 2032Ps = 704 Change colour of italic characters to Pt
1790Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 2033Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1791Ps = 706 Change colour of bold characters to Pt 2034Ps = 706 Change colour of bold characters to Pt
1792Ps = 707 Change colour of underlined characters to Pt 2035Ps = 707 Change colour of underlined characters to Pt
1793Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 2036Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1799Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). 2042Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1800.TE 2043.TE
1801 2044
1802.PP 2045.PP
1803 2046
1804.IX Xref "menuBar" 2047.IX Xref "XPM"
1805.SH "menuBar"
1806.IX Header "menuBar"
1807\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1808In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1809menuBar.
1810.PP
1811Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1812omitted: use \fB./\fR to specify a menu relative to the current menu.
1813.Sh "Overview of menuBar operation"
1814.IX Subsection "Overview of menuBar operation"
1815For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1816of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1817.PP
1818At the top level is the current menuBar which is a member of a circular
1819linked-list of other such menuBars.
1820.PP
1821The menuBar acts as a parent for the various drop-down menus, which in
1822turn, may have labels, separator lines, menuItems and subMenus.
1823.PP
1824The menuItems are the useful bits: you can use them to mimic keyboard
1825input or even to send text or escape sequences back to rxvt.
1826.PP
1827The menuBar syntax is intended to provide a simple yet robust method of
1828constructing and manipulating menus and navigating through the
1829menuBars.
1830.PP
1831The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1832the menuBar called \fIname\fR and allows access. You may now or menus,
1833subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1834menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1835menus. To re-access the current menuBar for alterations, use the tag
1836\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1837.PP
1838
1839.IX Xref "menuBarCommands"
1840.Sh "Commands"
1841.IX Subsection "Commands"
1842.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1843.IX Item "[menu:+name]"
1844access the named menuBar for creation or alteration. If a new menuBar
1845is created, it is called \fIname\fR (max of 15 chars) and the current
1846menuBar is pushed onto the stack
1847.IP "\fB[menu]\fR" 4
1848.IX Item "[menu]"
1849access the current menuBar for alteration
1850.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1851.IX Item "[title:+string]"
1852set the current menuBar's title to \fIstring\fR, which may contain the
1853following format specifiers:
1854.Sp
1855.Vb 3
1856\& B<%n> rxvt name (as per the B<-name> command-line option)
1857\& B<%v> rxvt version
1858\& B<%%> literal B<%> character
1859.Ve
1860.IP "\fB[done]\fR" 4
1861.IX Item "[done]"
1862set menuBar access as \fBreadonly\fR.
1863End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1864.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1865.IX Item "[read:+file]"
1866read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1867appended 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.
1868.Sp
1869Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1870since any invalid menu commands are also ignored, almost anything could
1871be construed as a comment line, but this may be tightened up in the
1872future ... so don't count on it!.
1873.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1874.IX Item "[read:+file;+name]"
1875The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1876\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1877\&\fB[done]\fR is encountered.
1878.IP "\fB[dump]\fR" 4
1879.IX Item "[dump]"
1880dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1881later rereading.
1882.IP "\fB[rm:name]\fR" 4
1883.IX Item "[rm:name]"
1884remove the named menuBar
1885.IP "\fB[rm] [rm:]\fR" 4
1886.IX Item "[rm] [rm:]"
1887remove the current menuBar
1888.IP "\fB[rm*] [rm:*]\fR" 4
1889.IX Item "[rm*] [rm:*]"
1890remove all menuBars
1891.IP "\fB[swap]\fR" 4
1892.IX Item "[swap]"
1893swap the top two menuBars
1894.IP "\fB[prev]\fR" 4
1895.IX Item "[prev]"
1896access the previous menuBar
1897.IP "\fB[next]\fR" 4
1898.IX Item "[next]"
1899access the next menuBar
1900.IP "\fB[show]\fR" 4
1901.IX Item "[show]"
1902Enable display of the menuBar
1903.IP "\fB[hide]\fR" 4
1904.IX Item "[hide]"
1905Disable display of the menuBar
1906.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1907.IX Item "[pixmap:+name]"
1908.PD 0
1909.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1910.IX Item "[pixmap:+name;scaling]"
1911.PD
1912(set the background pixmap globally
1913.Sp
1914\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1915.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1916.IX Item "[:+command:]"
1917ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1918menuitem or change the ; a useful shortcut for setting the quick arrows
1919from a menuBar.
1920.PP
1921
1922.IX Xref "menuBarAdd"
1923.Sh "Adding and accessing menus"
1924.IX Subsection "Adding and accessing menus"
1925The following commands may also be \fB+\fR prefixed.
1926.IP "\fB/+\fR" 4
1927.IX Item "/+"
1928access menuBar top level
1929.IP "\fB./+\fR" 4
1930.IX Item "./+"
1931access current menu level
1932.IP "\fB../+\fR" 4
1933.IX Item "../+"
1934access parent menu (1 level up)
1935.IP "\fB../../\fR" 4
1936.IX Item "../../"
1937access parent menu (multiple levels up)
1938.IP "\fB\f(BI/path/\fBmenu\fR" 4
1939.IX Item "/path/menu"
1940add/access menu
1941.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1942.IX Item "/path/menu/*"
1943add/access menu and clear it if it exists
1944.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1945.IX Item "/path/{-}"
1946add separator
1947.IP "\fB\f(BI/path/\fB{item}\fR" 4
1948.IX Item "/path/{item}"
1949add \fBitem\fR as a label
1950.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1951.IX Item "/path/{item} action"
1952add/alter \fImenuitem\fR with an associated \fIaction\fR
1953.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1954.IX Item "/path/{item}{right-text}"
1955add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1956and as the associated \fIaction\fR
1957.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1958.IX Item "/path/{item}{rtext} action"
1959add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
1960the right-justified text.
1961.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
1962.IX Item "Special characters in action must be backslash-escaped:"
1963\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
1964.IP "or in control-character notation:" 4
1965.IX Item "or in control-character notation:"
1966\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
1967.PP
1968To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
1969program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
1970the first of which will be stripped off and the balance directed to the
1971program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
1972non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
1973balance is sent back to rxvt.
1974.PP
1975As a convenience for the many Emacs-type editors, \fIaction\fR may start
1976with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
1977appended if missed from \fBM\-x\fR commands.
1978.PP
1979As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
1980quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
1981.IP "For example," 4
1982.IX Item "For example,"
1983\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
1984.IP "and" 4
1985.IX Item "and"
1986\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
1987.PP
1988The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
1989absence of a specified action, this text will be used as the \fIaction\fR
1990as well.
1991.IP "For example," 4
1992.IX Item "For example,"
1993\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
1994.PP
1995The left label \fIis\fR necessary, since it's used for matching, but
1996implicitly hiding the left label (by using same name for both left and
1997right labels), or explicitly hiding the left label (by preceeding it
1998with a dot), makes it possible to have right-justified text only.
1999.IP "For example," 4
2000.IX Item "For example,"
2001\&\fB/File/{Open}{Open} Open-File-Action\fR
2002.IP "or hiding it" 4
2003.IX Item "or hiding it"
2004\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
2005.PP
2006
2007.IX Xref "menuBarRemove"
2008.Sh "Removing menus"
2009.IX Subsection "Removing menus"
2010.IP "\fB\-/*+\fR" 4
2011.IX Item "-/*+"
2012remove all menus from the menuBar, the same as \fB[clear]\fR
2013.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
2014.IX Item "-+/pathmenu+"
2015remove menu
2016.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
2017.IX Item "-+/path{item}+"
2018remove item
2019.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
2020.IX Item "-+/path{-}"
2021remove separator)
2022.IP "\fB\-/path/menu/*\fR" 4
2023.IX Item "-/path/menu/*"
2024remove all items, separators and submenus from menu
2025.PP
2026
2027.IX Xref "menuBarArrows"
2028.Sh "Quick Arrows"
2029.IX Subsection "Quick Arrows"
2030The menus also provide a hook for \fIquick arrows\fR to provide easier
2031user access. If nothing has been explicitly set, the default is to
2032emulate the curror keys. The syntax permits each arrow to be altered
2033individually or all four at once without re-entering their common
2034beginning/end text. For example, to explicitly associate cursor actions
2035with the arrows, any of the following forms could be used:
2036.IP "\fB<r>+\f(BIRight\fB\fR" 4
2037.IX Item "<r>+Right"
2038.PD 0
2039.IP "\fB<l>+\f(BILeft\fB\fR" 4
2040.IX Item "<l>+Left"
2041.IP "\fB<u>+\f(BIUp\fB\fR" 4
2042.IX Item "<u>+Up"
2043.IP "\fB<d>+\f(BIDown\fB\fR" 4
2044.IX Item "<d>+Down"
2045.PD
2046Define actions for the respective arrow buttons
2047.IP "\fB<b>+\f(BIBegin\fB\fR" 4
2048.IX Item "<b>+Begin"
2049.PD 0
2050.IP "\fB<e>+\f(BIEnd\fB\fR" 4
2051.IX Item "<e>+End"
2052.PD
2053Define common beginning/end parts for \fIquick arrows\fR which used in
2054conjunction with the above <r> <l> <u> <d> constructs
2055.IP "For example, define arrows individually," 4
2056.IX Item "For example, define arrows individually,"
2057.Vb 1
2058\& <u>\eE[A
2059.Ve
2060.Sp
2061.Vb 1
2062\& <d>\eE[B
2063.Ve
2064.Sp
2065.Vb 1
2066\& <r>\eE[C
2067.Ve
2068.Sp
2069.Vb 1
2070\& <l>\eE[D
2071.Ve
2072.IP "or all at once" 4
2073.IX Item "or all at once"
2074.Vb 1
2075\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
2076.Ve
2077.IP "or more compactly (factoring out common parts)" 4
2078.IX Item "or more compactly (factoring out common parts)"
2079.Vb 1
2080\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
2081.Ve
2082.PP
2083
2084.IX Xref "menuBarSummary"
2085.Sh "Command Summary"
2086.IX Subsection "Command Summary"
2087A short summary of the most \fIcommon\fR commands:
2088.IP "[menu:name]" 4
2089.IX Item "[menu:name]"
2090use an existing named menuBar or start a new one
2091.IP "[menu]" 4
2092.IX Item "[menu]"
2093use the current menuBar
2094.IP "[title:string]" 4
2095.IX Item "[title:string]"
2096set menuBar title
2097.IP "[done]" 4
2098.IX Item "[done]"
2099set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
2100.IP "[done:name]" 4
2101.IX Item "[done:name]"
2102if reading from a file using [read:file;name] signal \s-1EOF\s0
2103.IP "[rm:name]" 4
2104.IX Item "[rm:name]"
2105remove named menuBar(s)
2106.IP "[rm] [rm:]" 4
2107.IX Item "[rm] [rm:]"
2108remove current menuBar
2109.IP "[rm*] [rm:*]" 4
2110.IX Item "[rm*] [rm:*]"
2111remove all menuBar(s)
2112.IP "[swap]" 4
2113.IX Item "[swap]"
2114swap top two menuBars
2115.IP "[prev]" 4
2116.IX Item "[prev]"
2117access the previous menuBar
2118.IP "[next]" 4
2119.IX Item "[next]"
2120access the next menuBar
2121.IP "[show]" 4
2122.IX Item "[show]"
2123map menuBar
2124.IP "[hide]" 4
2125.IX Item "[hide]"
2126unmap menuBar
2127.IP "[pixmap;file]" 4
2128.IX Item "[pixmap;file]"
2129.PD 0
2130.IP "[pixmap;file;scaling]" 4
2131.IX Item "[pixmap;file;scaling]"
2132.PD
2133set a background pixmap
2134.IP "[read:file]" 4
2135.IX Item "[read:file]"
2136.PD 0
2137.IP "[read:file;name]" 4
2138.IX Item "[read:file;name]"
2139.PD
2140read in a menu from a file
2141.IP "[dump]" 4
2142.IX Item "[dump]"
2143dump out all menuBars to /tmp/rxvt\-PID
2144.IP "/" 4
2145access menuBar top level
2146.IP "./" 4
2147.PD 0
2148.IP "../" 4
2149.IP "../../" 4
2150.PD
2151access current or parent menu level
2152.IP "/path/menu" 4
2153.IX Item "/path/menu"
2154add/access menu
2155.IP "/path/{\-}" 4
2156.IX Item "/path/{-}"
2157add separator
2158.IP "/path/{item}{rtext} action" 4
2159.IX Item "/path/{item}{rtext} action"
2160add/alter menu item
2161.IP "\-/*" 4
2162remove all menus from the menuBar
2163.IP "\-/path/menu" 4
2164.IX Item "-/path/menu"
2165remove menu items, separators and submenus from menu
2166.IP "\-/path/menu" 4
2167.IX Item "-/path/menu"
2168remove menu
2169.IP "\-/path/{item}" 4
2170.IX Item "-/path/{item}"
2171remove item
2172.IP "\-/path/{\-}" 4
2173.IX Item "-/path/{-}"
2174remove separator
2175.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2176.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2177menu quick arrows
2178.SH "XPM" 2048.SH "XPM"
2179.IX Header "XPM" 2049.IX Header "XPM"
2180For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value 2050For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value
2181of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a 2051of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a
2182sequence of scaling/positioning commands separated by semi\-colons. The 2052sequence of scaling/positioning commands separated by semi\-colons. The
2252.TS 2122.TS
2253l l . 2123l l .
22544 Shift 21244 Shift
22558 Meta 21258 Meta
225616 Control 212616 Control
225732 Double Click (Rxvt extension) 212732 Double Click (rxvt extension)
2258.TE 2128.TE
2259 2129
2260Col = \fB\f(CB\*(C`<x> \- SPACE\*(C'\fB\fR 2130Col = \fB\f(CB\*(C`<x> \- SPACE\*(C'\fB\fR
2261.Sp 2131.Sp
2262Row = \fB\f(CB\*(C`<y> \- SPACE\*(C'\fB\fR 2132Row = \fB\f(CB\*(C`<y> \- SPACE\*(C'\fB\fR
2384Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using 2254Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using
2385alternative input methods (e.g. kinput2) and will also correctly 2255alternative input methods (e.g. kinput2) and will also correctly
2386set up the input for people using dead keys or compose keys. 2256set up the input for people using dead keys or compose keys.
2387.IP "\-\-enable\-unicode3 (default: off)" 4 2257.IP "\-\-enable\-unicode3 (default: off)" 4
2388.IX Item "--enable-unicode3 (default: off)" 2258.IX Item "--enable-unicode3 (default: off)"
2259Recommended to stay off unless you really need non-BMP characters.
2260.Sp
2389Enable direct support for displaying unicode codepoints above 2261Enable direct support for displaying unicode codepoints above
239065535 (the basic multilingual page). This increases storage 226265535 (the basic multilingual page). This increases storage
2391requirements per character from 2 to 4 bytes. X11 fonts do not yet 2263requirements per character from 2 to 4 bytes. X11 fonts do not yet
2392support these extra characters, but Xft does. 2264support these extra characters, but Xft does.
2393.Sp 2265.Sp
2402composite characters. This is required for proper viewing of text 2274composite characters. This is required for proper viewing of text
2403where accents are encoded as seperate unicode characters. This is 2275where accents are encoded as seperate unicode characters. This is
2404done by using precomposited characters when available or creating 2276done by using precomposited characters when available or creating
2405new pseudo-characters when no precomposed form exists. 2277new pseudo-characters when no precomposed form exists.
2406.Sp 2278.Sp
2407Without \-\-enable\-unicode3, the number of additional precomposed characters 2279Without \-\-enable\-unicode3, the number of additional precomposed
2408is rather limited (2048, if this is full, rxvt-unicode will use the 2280characters is somewhat limited (the 6400 private use characters will be
2409private use area, extending the number of combinations to 8448). With
2410\&\-\-enable\-unicode3, no practical limit exists. 2281(ab\-)used). With \-\-enable\-unicode3, no practical limit exists.
2411.Sp 2282.Sp
2412This option will also enable storage (but not display) of characters 2283This option will also enable storage (but not display) of characters
2413beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified. 2284beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
2414.Sp 2285.Sp
2415The combining table also contains entries for arabic presentation forms, 2286The combining table also contains entries for arabic presentation forms,
2416but these are not currently used. Bug me if you want these to be used (and 2287but these are not currently used. Bug me if you want these to be used (and
2417tell me how these are to be used...). 2288tell me how these are to be used...).
2418.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4 2289.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4
2419.IX Item "--enable-fallback(=CLASS) (default: Rxvt)" 2290.IX Item "--enable-fallback(=CLASS) (default: Rxvt)"
2420When reading resource settings, also read settings for class \s-1CLASS\s0. To disable resource fallback use \-\-disable\-fallback. 2291When reading resource settings, also read settings for class \s-1CLASS\s0. To
2292disable resource fallback use \-\-disable\-fallback.
2421.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4 2293.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4
2422.IX Item "--with-res-name=NAME (default: urxvt)" 2294.IX Item "--with-res-name=NAME (default: urxvt)"
2423Use the given name as default application name when 2295Use the given name as default application name when
2424reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt. 2296reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
2425.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4 2297.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4
2452.IX Item "--enable-fading (default: on)" 2324.IX Item "--enable-fading (default: on)"
2453Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2325Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2454.IP "\-\-enable\-tinting (default: on)" 4 2326.IP "\-\-enable\-tinting (default: on)" 4
2455.IX Item "--enable-tinting (default: on)" 2327.IX Item "--enable-tinting (default: on)"
2456Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2328Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2457.IP "\-\-enable\-menubar (default: off) [\s-1DEPRECATED\s0]" 4
2458.IX Item "--enable-menubar (default: off) [DEPRECATED]"
2459Add support for our menu bar system (this interacts badly with dynamic
2460locale switching currently). This option is \s-1DEPRECATED\s0 and will be removed
2461in the future.
2462.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2329.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2463.IX Item "--enable-rxvt-scroll (default: on)" 2330.IX Item "--enable-rxvt-scroll (default: on)"
2464Add support for the original rxvt scrollbar. 2331Add support for the original rxvt scrollbar.
2465.IP "\-\-enable\-next\-scroll (default: on)" 4 2332.IP "\-\-enable\-next\-scroll (default: on)" 4
2466.IX Item "--enable-next-scroll (default: on)" 2333.IX Item "--enable-next-scroll (default: on)"
2471.IP "\-\-enable\-plain\-scroll (default: on)" 4 2338.IP "\-\-enable\-plain\-scroll (default: on)" 4
2472.IX Item "--enable-plain-scroll (default: on)" 2339.IX Item "--enable-plain-scroll (default: on)"
2473Add support for a very unobtrusive, plain-looking scrollbar that 2340Add support for a very unobtrusive, plain-looking scrollbar that
2474is the favourite of the rxvt-unicode author, having used it for 2341is the favourite of the rxvt-unicode author, having used it for
2475many years. 2342many years.
2476.IP "\-\-enable\-half\-shadow (default: off)" 4
2477.IX Item "--enable-half-shadow (default: off)"
2478Make shadows on the scrollbar only half the normal width & height.
2479only applicable to rxvt scrollbars.
2480.IP "\-\-enable\-ttygid (default: off)" 4 2343.IP "\-\-enable\-ttygid (default: off)" 4
2481.IX Item "--enable-ttygid (default: off)" 2344.IX Item "--enable-ttygid (default: off)"
2482Change tty device setting to group \*(L"tty\*(R" \- only use this if 2345Change tty device setting to group \*(L"tty\*(R" \- only use this if
2483your system uses this type of security. 2346your system uses this type of security.
2484.IP "\-\-disable\-backspace\-key" 4 2347.IP "\-\-disable\-backspace\-key" 4
2489Removes any handling of the delete key by us \- let the X server 2352Removes any handling of the delete key by us \- let the X server
2490do it. 2353do it.
2491.IP "\-\-disable\-resources" 4 2354.IP "\-\-disable\-resources" 4
2492.IX Item "--disable-resources" 2355.IX Item "--disable-resources"
2493Removes any support for resource checking. 2356Removes any support for resource checking.
2494.IP "\-\-enable\-xgetdefault" 4
2495.IX Item "--enable-xgetdefault"
2496Make resources checking via \fIXGetDefault()\fR instead of our small
2497version which only checks ~/.Xdefaults, or if that doesn't exist then
2498~/.Xresources.
2499.Sp
2500Please note that nowadays, things like \s-1XIM\s0 will automatically pull in and
2501use the full X resource manager, so the overhead of using it might be very
2502small, if nonexistant.
2503.IP "\-\-enable\-strings (default: off)" 4
2504.IX Item "--enable-strings (default: off)"
2505Add support for our possibly faster \fImemset()\fR function and other
2506various routines, overriding your system's versions which may
2507have been hand-crafted in assembly or may require extra libraries
2508to link in. (this breaks ANSI-C rules and has problems on many
2509GNU/Linux systems).
2510.IP "\-\-disable\-swapscreen" 4 2357.IP "\-\-disable\-swapscreen" 4
2511.IX Item "--disable-swapscreen" 2358.IX Item "--disable-swapscreen"
2512Remove support for secondary/swap screen. 2359Remove support for secondary/swap screen.
2513.IP "\-\-enable\-frills (default: on)" 4 2360.IP "\-\-enable\-frills (default: on)" 4
2514.IX Item "--enable-frills (default: on)" 2361.IX Item "--enable-frills (default: on)"
2517disable this. 2364disable this.
2518.Sp 2365.Sp
2519A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2366A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2520in combination with other switches) is: 2367in combination with other switches) is:
2521.Sp 2368.Sp
2522.Vb 17 2369.Vb 15
2523\& MWM-hints 2370\& MWM-hints
2524\& EWMH-hints (pid, utf8 names) and protocols (ping) 2371\& EWMH-hints (pid, utf8 names) and protocols (ping)
2525\& seperate underline colour (-underlineColor) 2372\& seperate underline colour (-underlineColor)
2526\& settable border widths and borderless switch (-w, -b, -bl) 2373\& settable border widths and borderless switch (-w, -b, -bl)
2374\& visual depth selection (-depth)
2527\& settable extra linespacing /-lsp) 2375\& settable extra linespacing /-lsp)
2528\& iso-14755-2 and -3, and visual feedback 2376\& iso-14755-2 and -3, and visual feedback
2529\& backindex and forwardindex escape sequence
2530\& window op and some xterm/OSC escape sequences
2531\& tripleclickwords (-tcw) 2377\& tripleclickwords (-tcw)
2532\& settable insecure mode (-insecure) 2378\& settable insecure mode (-insecure)
2533\& keysym remapping support 2379\& keysym remapping support
2534\& cursor blinking and underline cursor (-cb, -uc) 2380\& cursor blinking and underline cursor (-cb, -uc)
2535\& XEmbed support (-embed) 2381\& XEmbed support (-embed)
2536\& user-pty (-pty-fd) 2382\& user-pty (-pty-fd)
2537\& hold on exit (-hold) 2383\& hold on exit (-hold)
2538\& skip builtin block graphics (-sbg) 2384\& skip builtin block graphics (-sbg)
2385.Ve
2386.Sp
2387It also enabled some non-essential features otherwise disabled, such as:
2388.Sp
2389.Vb 11
2390\& some round-trip time optimisations
2391\& nearest color allocation on pseudocolor screens
2392\& UTF8_STRING supporr for selection
2539\& sgr modes 90..97 and 100..107 2393\& sgr modes 90..97 and 100..107
2394\& backindex and forwardindex escape sequences
2395\& view change/zero scorllback esacpe sequences
2396\& locale switching escape sequence
2397\& window op and some xterm/OSC escape sequences
2398\& rectangular selections
2399\& trailing space removal for selections
2400\& verbose X error handling
2540.Ve 2401.Ve
2541.IP "\-\-enable\-iso14755 (default: on)" 4 2402.IP "\-\-enable\-iso14755 (default: on)" 4
2542.IX Item "--enable-iso14755 (default: on)" 2403.IX Item "--enable-iso14755 (default: on)"
2543Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or 2404Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
2544\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by 2405\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by
2578keys. This should keep the window corner which is closest to a corner of 2439keys. This should keep the window corner which is closest to a corner of
2579the screen in a fixed position. 2440the screen in a fixed position.
2580.IP "\-\-enable\-pointer\-blank (default: on)" 4 2441.IP "\-\-enable\-pointer\-blank (default: on)" 4
2581.IX Item "--enable-pointer-blank (default: on)" 2442.IX Item "--enable-pointer-blank (default: on)"
2582Add support to have the pointer disappear when typing or inactive. 2443Add support to have the pointer disappear when typing or inactive.
2583.IP "\-\-enable\-perl (default: off)" 4 2444.IP "\-\-enable\-perl (default: on)" 4
2584.IX Item "--enable-perl (default: off)" 2445.IX Item "--enable-perl (default: on)"
2585Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR 2446Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2586manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files 2447manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2587in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The 2448in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2588perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment 2449perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2589variable when running configure. 2450variable when running configure.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines