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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines