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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.79 by root, Thu Jan 12 23:11:23 2006 UTC vs.
Revision 1.162 by ayin, Sat Jan 19 15:00:49 2008 UTC

16=head1 DESCRIPTION 16=head1 DESCRIPTION
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at 22L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
26
25=head1 FREQUENTLY ASKED QUESTIONS 27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
26 28
27=over 4
28 29
29=item The new selection selects pieces that are too big/too small, can I 30=head2 Meta, Features & Commandline Issues
30change this?
31 31
32Yes. For example, if you want to select smaller pieces ("words") you can 32=head3 My question isn't answered here, can I ask a human?
33use the following resource:
34 33
35 URxvt.selection.pattern-0: ([[:word:]]+) 34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
36interested in learning about new and exciting problems (but not FAQs :).
36 37
37If you click more than twice, the selection will be extended 38=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
38more and more.
39 39
40To get a selection that is very similar to the old code, try this pattern: 40Beginning with version 7.3, there is a perl extension that implements a
41simple tabbed terminal. It is installed by default, so any of these should
42give you tabs:
41 43
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 44 @@URXVT_NAME@@ -pe tabbed
43 45
44=item I don't like the new selection/popups/hotkeys/perl, how do I 46 URxvt.perl-ext-common: default,tabbed
45change/disable it?
46 47
47You can disable the perl extension completely by setting the 48It will also work fine with tabbing functionality of many window managers
48B<perl-ext-common> resource to the empty string, which also keeps 49or similar tabbing programs, and its embedding-features allow it to be
49rxvt-unicode from initialising perl, saving memory. 50embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
51the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
52(murxvt) terminal as an example embedding application.
50 53
51If you only want to disable specific features, you first have to 54=head3 How do I know which rxvt-unicode version I'm using?
52identify which perl extension is responsible. For this, read the section
53B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
54example, to disable the B<selection-popup> and B<option-popup>, specify
55this B<perl-ext-common> resource:
56 55
57 URxvt.perl-ext-common: default,-selection-popup,-option-popup 56The version number is displayed with the usage (-h). Also the escape
57sequence C<ESC [ 8 n> sets the window title to the version number. When
58using the @@URXVT_NAME@@c client, the version displayed is that of the
59daemon.
58 60
59This will keep the default extensions, but disable the two popup 61=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
60extensions. Some extensions can also be configured, for example,
61scrollback search mode is triggered by B<M-s>. You can move it to any
62other combination either by setting the B<searchable-scrollback> resource:
63 62
64 URxvt.searchable-scrollback: CM-s 63Rxvt-unicode tries to obey the rule of not charging you for something you
64don't use. One thing you should try is to configure out all settings that
65you don't need, for example, Xft support is a resource hog by design,
66when used. Compiling it out ensures that no Xft font will be loaded
67accidentally when rxvt-unicode tries to find a font for your characters.
65 68
69Also, many people (me included) like large windows and even larger
70scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
716 bytes per screen cell. For a 160x?? window this amounts to almost a
72kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
73use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
74rxvt-unicode then uses 8 bytes per screen cell.
75
76=head3 How can I start @@URXVT_NAME@@d in a race-free way?
77
78Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
79display, create the listening socket and then fork.
80
81=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
82
83If you want to start @@URXVT_NAME@@d automatically whenever you run
84@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
85
86 #!/bin/sh
87 @@URXVT_NAME@@c "$@"
88 if [ $? -eq 2 ]; then
89 @@URXVT_NAME@@d -q -o -f
90 @@URXVT_NAME@@c "$@"
91 fi
92
93This tries to create a new terminal, and if fails with exit status 2,
94meaning it couldn't connect to the daemon, it will start the daemon and
95re-run the command. Subsequent invocations of the script will re-use the
96existing daemon.
97
98=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
99
100The original rxvt and rxvt-unicode always export the variable "COLORTERM",
101so you can check and see if that is set. Note that several programs, JED,
102slrn, Midnight Commander automatically check this variable to decide
103whether or not to use color.
104
105=head3 How do I set the correct, full IP address for the DISPLAY variable?
106
107If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
108insecure mode then it is possible to use the following shell script
109snippets to correctly set the display. If your version of rxvt-unicode
110wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
111the COLORTERM variable can be used to distinguish rxvt-unicode from a
112regular xterm.
113
114Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
115snippets:
116
117 # Bourne/Korn/POSIX family of shells:
118 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
119 if [ ${TERM:-foo} = xterm ]; then
120 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
121 echo -n '^[Z'
122 read term_id
123 stty icanon echo
124 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
125 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
126 read DISPLAY # set it in our local shell
127 fi
128 fi
129
130=head3 How do I compile the manual pages on my own?
131
132You need to have a recent version of perl installed as F</usr/bin/perl>,
133one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
134F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
135
66=item Isn't rxvt supposed to be small? Don't all those features bloat? 136=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
67 137
68I often get asked about this, and I think, no, they didn't cause extra 138I often get asked about this, and I think, no, they didn't cause extra
69bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 139bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
70that the urxvt binary is larger (due to some encoding tables always being 140that the urxvt binary is larger (due to some encoding tables always being
71compiled in), but it actually uses less memory (RSS) after startup. Even 141compiled in), but it actually uses less memory (RSS) after startup. Even
75 145
76 text data bss drs rss filename 146 text data bss drs rss filename
77 98398 1664 24 15695 1824 rxvt --disable-everything 147 98398 1664 24 15695 1824 rxvt --disable-everything
78 188985 9048 66616 18222 1788 urxvt --disable-everything 148 188985 9048 66616 18222 1788 urxvt --disable-everything
79 149
80When you C<--enable-everything> (which _is_ unfair, as this involves xft 150When you C<--enable-everything> (which I<is> unfair, as this involves xft
81and full locale/XIM support which are quite bloaty inside libX11 and my 151and full locale/XIM support which are quite bloaty inside libX11 and my
82libc), the two diverge, but not unreasnobaly so. 152libc), the two diverge, but not unreasonably so.
83 153
84 text data bss drs rss filename 154 text data bss drs rss filename
85 163431 2152 24 20123 2060 rxvt --enable-everything 155 163431 2152 24 20123 2060 rxvt --enable-everything
86 1035683 49680 66648 29096 3680 urxvt --enable-everything 156 1035683 49680 66648 29096 3680 urxvt --enable-everything
87 157
103(21152k + extra 4204k in separate processes) or konsole (22200k + extra 173(21152k + extra 4204k in separate processes) or konsole (22200k + extra
10443180k in daemons that stay around after exit, plus half a minute of 17443180k in daemons that stay around after exit, plus half a minute of
105startup time, including the hundreds of warnings it spits out), it fares 175startup time, including the hundreds of warnings it spits out), it fares
106extremely well *g*. 176extremely well *g*.
107 177
108=item Why C++, isn't that unportable/bloated/uncool? 178=head3 Why C++, isn't that unportable/bloated/uncool?
109 179
110Is this a question? :) It comes up very often. The simple answer is: I had 180Is this a question? :) It comes up very often. The simple answer is: I had
111to write it, and C++ allowed me to write and maintain it in a fraction 181to write it, and C++ allowed me to write and maintain it in a fraction
112of the time and effort (which is a scarce resource for me). Put even 182of the time and effort (which is a scarce resource for me). Put even
113shorter: It simply wouldn't exist without C++. 183shorter: It simply wouldn't exist without C++.
130 200
131And here is rxvt-unicode: 201And here is rxvt-unicode:
132 202
133 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 203 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
134 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 204 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
135 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 205 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
136 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 206 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
137 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 207 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
138 208
139No large bloated libraries (of course, none were linked in statically), 209No large bloated libraries (of course, none were linked in statically),
140except maybe libX11 :) 210except maybe libX11 :)
141 211
142=item Does it support tabs, can I have a tabbed rxvt-unicode?
143 212
144rxvt-unicode does not directly support tabs. It will work fine with 213=head2 Rendering, Font & Look and Feel Issues
145tabbing functionality of many window managers or similar tabbing programs,
146and its embedding-features allow it to be embedded into other programs,
147as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
148module, which features a tabbed urxvt (murxvt) terminal as an example
149embedding application.
150 214
151=item How do I know which rxvt-unicode version I'm using? 215=head3 I can't get transparency working, what am I doing wrong?
152 216
153The version number is displayed with the usage (-h). Also the escape 217First of all, please address all transparency related issues to Sasha Vasko at
154sequence C<ESC [ 8 n> sets the window title to the version number. When 218sasha@aftercode.net and do not bug the author about it. Also, if you can't
155using the @@RXVT_NAME@@c client, the version displayed is that of the 219get it working consider it a rite of passage: ... and you failed.
156daemon.
157 220
158=item I am using Debian GNU/Linux and have a problem... 221Here are four ways to get transparency. B<Do> read the manpage and option
222descriptions for the programs mentioned and rxvt-unicode. Really, do it!
159 223
160The Debian GNU/Linux package of rxvt-unicode in sarge contains large 2241. Use transparent mode:
161patches that considerably change the behaviour of rxvt-unicode. Before
162reporting a bug to the original rxvt-unicode author please download and
163install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
164and try to reproduce the problem. If you cannot, chances are that the
165problems are specific to Debian GNU/Linux, in which case it should be
166reported via the Debian Bug Tracking System (use C<reportbug> to report
167the bug).
168 225
169For other problems that also affect the Debian package, you can and 226 Esetroot wallpaper.jpg
170probably should use the Debian BTS, too, because, after all, it's also a 227 @@URXVT_NAME@@ -tr -tint red -sh 40
171bug in the Debian version and it serves as a reminder for other users that
172might encounter the same issue.
173 228
174=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 229That works. If you think it doesn't, you lack transparency and tinting
230support, or you are unable to read.
175 231
176You should build one binary with the default options. F<configure> 2322. Use a simple pixmap and emulate pseudo-transparency. This enables you
177now enables most useful options, and the trend goes to making them 233to use effects other than tinting and shading: Just shade/tint/whatever
178runtime-switchable, too, so there is usually no drawback to enbaling them, 234your picture with gimp or any other tool:
179except higher disk and possibly memory usage. The perl interpreter should
180be enabled, as important functionality (menus, selection, likely more in
181the future) depends on it.
182 235
183You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 236 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
184system-wide (except maybe with C<defaults>). This will result in useful 237 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
185behaviour. If your distribution aims at low memory, add an empty
186C<perl-ext-common> resource to the app-defaults file. This will keep the
187perl interpreter disabled until the user enables it.
188 238
189If you can/want build more binaries, I recommend building a minimal 239That works. If you think it doesn't, you lack AfterImage support, or you
190one with C<--disable-everything> (very useful) and a maximal one with 240are unable to read.
191C<--enable-everything> (less useful, it will be very big due to a lot of
192encodings built-in that increase download times and are rarely used).
193 241
194=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? 2423. Use an ARGB visual:
195 243
196Likely not. While I honestly try to make it secure, and am probably not 244 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
197bad at it, I think it is simply unreasonable to expect all of freetype
198+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
199secure. Also, rxvt-unicode disables some options when it detects that it
200runs setuid or setgid, which is not nice. Besides, with the embedded perl
201interpreter the possibility for security problems easily multiplies.
202 245
203Elevated privileges are only required for utmp and pty operations on some 246This requires XFT support, and the support of your X-server. If that
204systems (for example, GNU/Linux doesn't need any extra privileges for 247doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
205ptys, but some need it for utmp support). It is planned to mvoe this into 248there yet, no matter what they claim. Rxvt-Unicode contains the necessary
206a forked handler process, but this is not yet done. 249bugfixes and workarounds for Xft and Xlib to make it work, but that
250doesn't mean that your WM has the required kludges in place.
207 251
208So, while setuid/setgid operation is supported and not a problem on your 2524. Use xcompmgr and let it do the job:
209typical single-user-no-other-logins unix desktop, always remember that
210its an awful lot of code, most of which isn't checked for security issues
211regularly.
212 253
254 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
255 -set _NET_WM_WINDOW_OPACITY 0xc0000000
256
257Then click on a window you want to make transparent. Replace C<0xc0000000>
258by other values to change the degree of opacity. If it doesn't work and
259your server crashes, you got to keep the pieces.
260
261=head3 Why does rxvt-unicode sometimes leave pixel droppings?
262
263Most fonts were not designed for terminal use, which means that character
264size varies a lot. A font that is otherwise fine for terminal use might
265contain some characters that are simply too wide. Rxvt-unicode will avoid
266these characters. For characters that are just "a bit" too wide a special
267"careful" rendering mode is used that redraws adjacent characters.
268
269All of this requires that fonts do not lie about character sizes,
270however: Xft fonts often draw glyphs larger than their acclaimed bounding
271box, and rxvt-unicode has no way of detecting this (the correct way is to
272ask for the character bounding box, which unfortunately is wrong in these
273cases).
274
275It's not clear (to me at least), whether this is a bug in Xft, freetype,
276or the respective font. If you encounter this problem you might try using
277the C<-lsp> option to give the font more height. If that doesn't work, you
278might be forced to use a different font.
279
280All of this is not a problem when using X11 core fonts, as their bounding
281box data is correct.
282
283=head3 How can I keep rxvt-unicode from using reverse video so much?
284
285First of all, make sure you are running with the right terminal settings
286(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
287make sure you have specified colours for italic and bold, as otherwise
288rxvt-unicode might use reverse video to simulate the effect:
289
290 URxvt.colorBD: white
291 URxvt.colorIT: green
292
293=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
294
295For some unexplainable reason, some rare programs assume a very weird
296colour palette when confronted with a terminal with more than the standard
2978 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
298these programs not to assume non-ISO colours without very good reasons.
299
300In the meantime, you can either edit your C<rxvt-unicode> terminfo
301definition to only claim 8 colour support or use C<TERM=rxvt>, which will
302fix colours but keep you from using other rxvt-unicode features.
303
304=head3 Can I switch the fonts at runtime?
305
306Yes, using an escape sequence. Try something like this, which has the same
307effect as using the C<-fn> switch, and takes effect immediately:
308
309 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
310
311This is useful if you e.g. work primarily with japanese (and prefer a
312japanese font), but you have to switch to chinese temporarily, where
313japanese fonts would only be in your way.
314
315You can think of this as a kind of manual ISO-2022 switching.
316
317=head3 Why do italic characters look as if clipped?
318
319Many fonts have difficulties with italic characters and hinting. For
320example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
321Mono> completely fails in its italic face. A workaround might be to
322enable freetype autohinting, i.e. like this:
323
324 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
325 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
326
327=head3 Can I speed up Xft rendering somehow?
328
329Yes, the most obvious way to speed it up is to avoid Xft entirely, as
330it is simply slow. If you still want Xft fonts you might try to disable
331antialiasing (by appending C<:antialias=false>), which saves lots of
332memory and also speeds up rendering considerably.
333
334=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
335
336Rxvt-unicode will use whatever you specify as a font. If it needs to
337fall back to its default font search list it will prefer X11 core
338fonts, because they are small and fast, and then use Xft fonts. It has
339antialiasing disabled for most of them, because the author thinks they
340look best that way.
341
342If you want antialiasing, you have to specify the fonts manually.
343
344=head3 What's with this bold/blink stuff?
345
346If no bold colour is set via C<colorBD:>, bold will invert text using the
347standard foreground colour.
348
349For the standard background colour, blinking will actually make
350the text blink when compiled with C<--enable-text-blink>. Without
351C<--enable-text-blink>, the blink attribute will be ignored.
352
353On ANSI colours, bold/blink attributes are used to set high-intensity
354foreground/background colors.
355
356color0-7 are the low-intensity colors.
357
358color8-15 are the corresponding high-intensity colors.
359
360=head3 I don't like the screen colors. How do I change them?
361
362You can change the screen colors at run-time using F<~/.Xdefaults>
363resources (or as long-options).
364
365Here are values that are supposed to resemble a VGA screen,
366including the murky brown that passes for low-intensity yellow:
367
368 URxvt.color0: #000000
369 URxvt.color1: #A80000
370 URxvt.color2: #00A800
371 URxvt.color3: #A8A800
372 URxvt.color4: #0000A8
373 URxvt.color5: #A800A8
374 URxvt.color6: #00A8A8
375 URxvt.color7: #A8A8A8
376
377 URxvt.color8: #000054
378 URxvt.color9: #FF0054
379 URxvt.color10: #00FF54
380 URxvt.color11: #FFFF54
381 URxvt.color12: #0000FF
382 URxvt.color13: #FF00FF
383 URxvt.color14: #00FFFF
384 URxvt.color15: #FFFFFF
385
386And here is a more complete set of non-standard colors.
387
388 URxvt.cursorColor: #dc74d1
389 URxvt.pointerColor: #dc74d1
390 URxvt.background: #0e0e0e
391 URxvt.foreground: #4ad5e1
392 URxvt.color0: #000000
393 URxvt.color8: #8b8f93
394 URxvt.color1: #dc74d1
395 URxvt.color9: #dc74d1
396 URxvt.color2: #0eb8c7
397 URxvt.color10: #0eb8c7
398 URxvt.color3: #dfe37e
399 URxvt.color11: #dfe37e
400 URxvt.color5: #9e88f0
401 URxvt.color13: #9e88f0
402 URxvt.color6: #73f7ff
403 URxvt.color14: #73f7ff
404 URxvt.color7: #e1dddd
405 URxvt.color15: #e1dddd
406
407They have been described (not by me) as "pretty girly".
408
409=head3 Why do some characters look so much different than others?
410
411See next entry.
412
413=head3 How does rxvt-unicode choose fonts?
414
415Most fonts do not contain the full range of Unicode, which is
416fine. Chances are that the font you (or the admin/package maintainer of
417your system/os) have specified does not cover all the characters you want
418to display.
419
420B<rxvt-unicode> makes a best-effort try at finding a replacement
421font. Often the result is fine, but sometimes the chosen font looks
422bad/ugly/wrong. Some fonts have totally strange characters that don't
423resemble the correct glyph at all, and rxvt-unicode lacks the artificial
424intelligence to detect that a specific glyph is wrong: it has to believe
425the font that the characters it claims to contain indeed look correct.
426
427In that case, select a font of your taste and add it to the font list,
428e.g.:
429
430 @@URXVT_NAME@@ -fn basefont,font2,font3...
431
432When rxvt-unicode sees a character, it will first look at the base
433font. If the base font does not contain the character, it will go to the
434next font, and so on. Specifying your own fonts will also speed up this
435search and use less resources within rxvt-unicode and the X-server.
436
437The only limitation is that none of the fonts may be larger than the base
438font, as the base font defines the terminal character cell size, which
439must be the same due to the way terminals work.
440
441=head3 Why do some chinese characters look so different than others?
442
443This is because there is a difference between script and language --
444rxvt-unicode does not know which language the text that is output is,
445as it only knows the unicode character codes. If rxvt-unicode first
446sees a japanese/chinese character, it might choose a japanese font for
447display. Subsequent japanese characters will use that font. Now, many
448chinese characters aren't represented in japanese fonts, so when the first
449non-japanese character comes up, rxvt-unicode will look for a chinese font
450-- unfortunately at this point, it will still use the japanese font for
451chinese characters that are also in the japanese font.
452
453The workaround is easy: just tag a chinese font at the end of your font
454list (see the previous question). The key is to view the font list as
455a preference list: If you expect more japanese, list a japanese font
456first. If you expect more chinese, put a chinese font first.
457
458In the future it might be possible to switch language preferences at
459runtime (the internal data structure has no problem with using different
460fonts for the same character at the same time, but no interface for this
461has been designed yet).
462
463Until then, you might get away with switching fonts at runtime (see L<Can
464I switch the fonts at runtime?> later in this document).
465
466=head3 How can I make mplayer display video correctly?
467
468We are working on it, in the meantime, as a workaround, use something like:
469
470 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
471
472
473=head2 Keyboard, Mouse & User Interaction
474
475=head3 The new selection selects pieces that are too big, how can I select single words?
476
477If you want to select e.g. alphanumeric words, you can use the following
478setting:
479
480 URxvt.selection.pattern-0: ([[:word:]]+)
481
482If you click more than twice, the selection will be extended
483more and more.
484
485To get a selection that is very similar to the old code, try this pattern:
486
487 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
488
489Please also note that the I<LeftClick Shift-LeftClick> combination also
490selects words like the old code.
491
492=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
493
494You can disable the perl extension completely by setting the
495B<perl-ext-common> resource to the empty string, which also keeps
496rxvt-unicode from initialising perl, saving memory.
497
498If you only want to disable specific features, you first have to
499identify which perl extension is responsible. For this, read the section
500B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
501example, to disable the B<selection-popup> and B<option-popup>, specify
502this B<perl-ext-common> resource:
503
504 URxvt.perl-ext-common: default,-selection-popup,-option-popup
505
506This will keep the default extensions, but disable the two popup
507extensions. Some extensions can also be configured, for example,
508scrollback search mode is triggered by B<M-s>. You can move it to any
509other combination either by setting the B<searchable-scrollback> resource:
510
511 URxvt.searchable-scrollback: CM-s
512
513=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
514
515See next entry.
516
517=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
518
519These are caused by the C<readline> perl extension. Under normal
520circumstances, it will move your cursor around when you click into the
521line that contains it. It tries hard not to do this at the wrong moment,
522but when running a program that doesn't parse cursor movements or in some
523cases during rlogin sessions, it fails to detect this properly.
524
525You can permanently switch this feature off by disabling the C<readline>
526extension:
527
528 URxvt.perl-ext-common: default,-readline
529
530=head3 My numerical keypad acts weird and generates differing output?
531
532Some Debian GNUL/Linux users seem to have this problem, although no
533specific details were reported so far. It is possible that this is caused
534by the wrong C<TERM> setting, although the details of whether and how
535this can happen are unknown, as C<TERM=rxvt> should offer a compatible
536keymap. See the answer to the previous question, and please report if that
537helped.
538
539=head3 My Compose (Multi_key) key is no longer working.
540
541The most common causes for this are that either your locale is not set
542correctly, or you specified a B<preeditStyle> that is not supported by
543your input method. For example, if you specified B<OverTheSpot> and
544your input method (e.g. the default input method handling Compose keys)
545does not support this (for instance because it is not visual), then
546rxvt-unicode will continue without an input method.
547
548In this case either do not specify a B<preeditStyle> or specify more than
549one pre-edit style, such as B<OverTheSpot,Root,None>.
550
551=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
552
553Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
554international keyboards) or simply use ISO 14755 support to your
555advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
556codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
557character and so on.
558
559=head3 Mouse cut/paste suddenly no longer works.
560
561Make sure that mouse reporting is actually turned off since killing
562some editors prematurely may leave the mouse in mouse report mode. I've
563heard that tcsh may use mouse reporting unless it otherwise specified. A
564quick check is to see if cut/paste works when the Alt or Shift keys are
565depressed.
566
567=head3 What's with the strange Backspace/Delete key behaviour?
568
569Assuming that the physical Backspace key corresponds to the
570Backspace keysym (not likely for Linux ... see the following
571question) there are two standard values that can be used for
572Backspace: C<^H> and C<^?>.
573
574Historically, either value is correct, but rxvt-unicode adopts the debian
575policy of using C<^?> when unsure, because it's the one and only correct
576choice :).
577
578Rxvt-unicode tries to inherit the current stty settings and uses the value
579of `erase' to guess the value for backspace. If rxvt-unicode wasn't
580started from a terminal (say, from a menu or by remote shell), then the
581system value of `erase', which corresponds to CERASE in <termios.h>, will
582be used (which may not be the same as your stty setting).
583
584For starting a new rxvt-unicode:
585
586 # use Backspace = ^H
587 $ stty erase ^H
588 $ @@URXVT_NAME@@
589
590 # use Backspace = ^?
591 $ stty erase ^?
592 $ @@URXVT_NAME@@
593
594Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
595
596For an existing rxvt-unicode:
597
598 # use Backspace = ^H
599 $ stty erase ^H
600 $ echo -n "^[[36h"
601
602 # use Backspace = ^?
603 $ stty erase ^?
604 $ echo -n "^[[36l"
605
606This helps satisfy some of the Backspace discrepancies that occur, but
607if you use Backspace = C<^H>, make sure that the termcap/terminfo value
608properly reflects that.
609
610The Delete key is a another casualty of the ill-defined Backspace problem.
611To avoid confusion between the Backspace and Delete keys, the Delete
612key has been assigned an escape sequence to match the vt100 for Execute
613(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
614
615Some other Backspace problems:
616
617some editors use termcap/terminfo,
618some editors (vim I'm told) expect Backspace = ^H,
619GNU Emacs (and Emacs-like editors) use ^H for help.
620
621Perhaps someday this will all be resolved in a consistent manner.
622
623=head3 I don't like the key-bindings. How do I change them?
624
625There are some compile-time selections available via configure. Unless
626you have run "configure" with the C<--disable-resources> option you can
627use the `keysym' resource to alter the keystrings associated with keysyms.
628
629Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
630
631 URxvt.keysym.Home: \033[1~
632 URxvt.keysym.End: \033[4~
633 URxvt.keysym.C-apostrophe: \033<C-'>
634 URxvt.keysym.C-slash: \033<C-/>
635 URxvt.keysym.C-semicolon: \033<C-;>
636 URxvt.keysym.C-grave: \033<C-`>
637 URxvt.keysym.C-comma: \033<C-,>
638 URxvt.keysym.C-period: \033<C-.>
639 URxvt.keysym.C-0x60: \033<C-`>
640 URxvt.keysym.C-Tab: \033<C-Tab>
641 URxvt.keysym.C-Return: \033<C-Return>
642 URxvt.keysym.S-Return: \033<S-Return>
643 URxvt.keysym.S-space: \033<S-Space>
644 URxvt.keysym.M-Up: \033<M-Up>
645 URxvt.keysym.M-Down: \033<M-Down>
646 URxvt.keysym.M-Left: \033<M-Left>
647 URxvt.keysym.M-Right: \033<M-Right>
648 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
649 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
650 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
651
652See some more examples in the documentation for the B<keysym> resource.
653
654=head3 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
655
656 KP_Insert == Insert
657 F22 == Print
658 F27 == Home
659 F29 == Prior
660 F33 == End
661 F35 == Next
662
663Rather than have rxvt-unicode try to accommodate all the various possible
664keyboard mappings, it is better to use `xmodmap' to remap the keys as
665required for your particular machine.
666
667
668=head2 Terminal Configuration
669
670=head3 Can I see a typical configuration?
671
672The default configuration tries to be xterm-like, which I don't like that
673much, but it's least surprise to regular users.
674
675As a rxvt or rxvt-unicode user, you are practically supposed to invest
676time into customising your terminal. To get you started, here is the
677author's .Xdefaults entries, with comments on what they do. It's certainly
678not I<typical>, but what's typical...
679
680 URxvt.cutchars: "()*,<>[]{}|'
681 URxvt.print-pipe: cat >/tmp/xxx
682
683These are just for testing stuff.
684
685 URxvt.imLocale: ja_JP.UTF-8
686 URxvt.preeditType: OnTheSpot,None
687
688This tells rxvt-unicode to use a special locale when communicating with
689the X Input Method, and also tells it to only use the OnTheSpot pre-edit
690type, which requires the C<xim-onthespot> perl extension but rewards me
691with correct-looking fonts.
692
693 URxvt.perl-lib: /root/lib/urxvt
694 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
695 URxvt.selection.pattern-0: ( at .*? line \\d+)
696 URxvt.selection.pattern-1: ^(/[^:]+):\
697 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
698 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
699
700This is my perl configuration. The first two set the perl library
701directory and also tells urxvt to use a large number of extensions. I
702develop for myself mostly, so I actually use most of the extensions I
703write.
704
705The selection stuff mainly makes the selection perl-error-message aware
706and tells it to convert perl error messages into vi-commands to load the
707relevant file and go tot he error line number.
708
709 URxvt.scrollstyle: plain
710 URxvt.secondaryScroll: true
711
712As the documentation says: plain is the preferred scrollbar for the
713author. The C<secondaryScroll> configures urxvt to scroll in full-screen
714apps, like screen, so lines scrolled out of screen end up in urxvt's
715scrollback buffer.
716
717 URxvt.background: #000000
718 URxvt.foreground: gray90
719 URxvt.color7: gray90
720 URxvt.colorBD: #ffffff
721 URxvt.cursorColor: #e0e080
722 URxvt.throughColor: #8080f0
723 URxvt.highlightColor: #f0f0f0
724
725Some colours. Not sure which ones are being used or even non-defaults, but
726these are in my .Xdefaults. Most notably, they set foreground/background
727to light gray/black, and also make sure that the colour 7 matches the
728default foreground colour.
729
730 URxvt.underlineColor: yellow
731
732Another colour, makes underline lines look different. Sometimes hurts, but
733is mostly a nice effect.
734
735 URxvt.geometry: 154x36
736 URxvt.loginShell: false
737 URxvt.meta: ignore
738 URxvt.utmpInhibit: true
739
740Uh, well, should be mostly self-explanatory. By specifying some defaults
741manually, I can quickly switch them for testing.
742
743 URxvt.saveLines: 8192
744
745A large scrollback buffer is essential. Really.
746
747 URxvt.mapAlert: true
748
749The only case I use it is for my IRC window, which I like to keep
750iconified till people msg me (which beeps).
751
752 URxvt.visualBell: true
753
754The audible bell is often annoying, especially when in a crowd.
755
756 URxvt.insecure: true
757
758Please don't hack my mutt! Ooops...
759
760 URxvt.pastableTabs: false
761
762I once thought this is a great idea.
763
764 urxvt.font: 9x15bold,\
765 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
766 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
767 [codeset=JISX0208]xft:Kochi Gothic, \
768 xft:Bitstream Vera Sans Mono:autohint=true, \
769 xft:Code2000:antialias=false
770 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
771 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
772 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
773
774I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
775overwhelmed. A special note: the C<9x15bold> mentioned above is actually
776the version from XFree-3.3, as XFree-4 replaced it by a totally different
777font (different glyphs for C<;> and many other harmless characters),
778while the second font is actually the C<9x15bold> from XFree4/XOrg. The
779bold version has less chars than the medium version, so I use it for rare
780characters, too. When editing sources with vim, I use italic for comments
781and other stuff, which looks quite good with Bitstream Vera anti-aliased.
782
783Terminus is a quite bad font (many very wrong glyphs), but for most of my
784purposes, it works, and gives a different look, as my normal (Non-bold)
785font is already bold, and I want to see a difference between bold and
786normal fonts.
787
788Please note that I used the C<urxvt> instance name and not the C<URxvt>
789class name. Thats because I use different configs for different purposes,
790for example, my IRC window is started with C<-name IRC>, and uses these
791defaults:
792
793 IRC*title: IRC
794 IRC*geometry: 87x12+535+542
795 IRC*saveLines: 0
796 IRC*mapAlert: true
797 IRC*font: suxuseuro
798 IRC*boldFont: suxuseuro
799 IRC*colorBD: white
800 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
801 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
802
803C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
804sizes. C<suxuseuro> allows me to keep an eye (and actually read)
805stuff while keeping a very small window. If somebody pastes something
806complicated (e.g. japanese), I temporarily switch to a larger font.
807
808The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
809C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
810file for different hosts, for example, on ym main desktop, I use:
811
812 URxvt.keysym.C-M-q: command:\033[3;5;5t
813 URxvt.keysym.C-M-y: command:\033[3;5;606t
814 URxvt.keysym.C-M-e: command:\033[3;1605;5t
815 URxvt.keysym.C-M-c: command:\033[3;1605;606t
816 URxvt.keysym.C-M-p: perl:test
817
818The first for keysym definitions allow me to quickly bring some windows
819in the layout I like most. Ion users might start laughing but will stop
820immediately when I tell them that I use my own Fvwm2 module for much the
821same effect as Ion provides, and I only very rarely use the above key
822combinations :->
823
824=head3 Why doesn't rxvt-unicode read my resources?
825
826Well, why, indeed? It does, in a way very similar to other X
827applications. Most importantly, this means that if you or your OS loads
828resources into the X display (the right way to do it), rxvt-unicode will
829ignore any resource files in your home directory. It will only read
830F<$HOME/.Xdefaults> when no resources are attached to the display.
831
832If you have or use an F<$HOME/.Xresources> file, chances are that
833resources are loaded into your X-server. In this case, you have to
834re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
835
836Also consider the form resources have to use:
837
838 URxvt.resource: value
839
840If you want to use another form (there are lots of different ways of
841specifying resources), make sure you understand whether and why it
842works. If unsure, use the form above.
843
213=item When I log-in to another system it tells me about missing terminfo data? 844=head3 When I log-in to another system it tells me about missing terminfo data?
214 845
215The terminal description used by rxvt-unicode is not as widely available 846The terminal description used by rxvt-unicode is not as widely available
216as that for xterm, or even rxvt (for which the same problem often arises). 847as that for xterm, or even rxvt (for which the same problem often arises).
217 848
218The correct solution for this problem is to install the terminfo, this can 849The correct solution for this problem is to install the terminfo, this can
219be done like this (with ncurses' infocmp): 850be done like this (with ncurses' infocmp and works as user and admin):
220 851
221 REMOTE=remotesystem.domain 852 REMOTE=remotesystem.domain
222 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 853 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
223 854
224... or by installing rxvt-unicode normally on the remote system, 855... or by installing rxvt-unicode normally on the remote system,
856
857One some systems you might need to set C<$TERMINFO> to the full path of
858F<$HOME/.terminfo> for this to work.
225 859
226If you cannot or do not want to do this, then you can simply set 860If you cannot or do not want to do this, then you can simply set
227C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 861C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
228problems arising, which includes wrong keymapping, less and different 862problems arising, which includes wrong keymapping, less and different
229colours and some refresh errors in fullscreen applications. It's a nice 863colours and some refresh errors in fullscreen applications. It's a nice
234resource to set it: 868resource to set it:
235 869
236 URxvt.termName: rxvt 870 URxvt.termName: rxvt
237 871
238If you don't plan to use B<rxvt> (quite common...) you could also replace 872If you don't plan to use B<rxvt> (quite common...) you could also replace
239the rxvt terminfo file with the rxvt-unicode one. 873the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
240 874
241=item C<tic> outputs some error when compiling the terminfo entry. 875=head3 C<tic> outputs some error when compiling the terminfo entry.
242 876
243Most likely it's the empty definition for C<enacs=>. Just replace it by 877Most likely it's the empty definition for C<enacs=>. Just replace it by
244C<enacs=\E[0@> and try again. 878C<enacs=\E[0@> and try again.
245 879
246=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 880=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
247 881
882See next entry.
883
248=item I need a termcap file entry. 884=head3 I need a termcap file entry.
249 885
250One reason you might want this is that some distributions or operating 886One reason you might want this is that some distributions or operating
251systems still compile some programs using the long-obsoleted termcap 887systems still compile some programs using the long-obsoleted termcap
252library (Fedora Core's bash is one example) and rely on a termcap entry 888library (Fedora Core's bash is one example) and rely on a termcap entry
253for C<rxvt-unicode>. 889for C<rxvt-unicode>.
254 890
255You could use rxvt's termcap entry with resonable results in many cases. 891You could use rxvt's termcap entry with reasonable results in many cases.
256You can also create a termcap entry by using terminfo's infocmp program 892You can also create a termcap entry by using terminfo's infocmp program
257like this: 893like this:
258 894
259 infocmp -C rxvt-unicode 895 infocmp -C rxvt-unicode
260 896
279 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 915 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
280 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 916 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
281 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 917 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
282 :vs=\E[?25h: 918 :vs=\E[?25h:
283 919
284=item Why does C<ls> no longer have coloured output? 920=head3 Why does C<ls> no longer have coloured output?
285 921
286The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 922The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
287decide wether a terminal has colour, but uses it's own configuration 923decide whether a terminal has colour, but uses its own configuration
288file. Needless to say, C<rxvt-unicode> is not in it's default file (among 924file. Needless to say, C<rxvt-unicode> is not in its default file (among
289with most other terminals supporting colour). Either add: 925with most other terminals supporting colour). Either add:
290 926
291 TERM rxvt-unicode 927 TERM rxvt-unicode
292 928
293to C</etc/DIR_COLORS> or simply add: 929to C</etc/DIR_COLORS> or simply add:
294 930
295 alias ls='ls --color=auto' 931 alias ls='ls --color=auto'
296 932
297to your C<.profile> or C<.bashrc>. 933to your C<.profile> or C<.bashrc>.
298 934
299=item Why doesn't vim/emacs etc. use the 88 colour mode? 935=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
300 936
937See next entry.
938
301=item Why doesn't vim/emacs etc. make use of italic? 939=head3 Why doesn't vim/emacs etc. make use of italic?
302 940
941See next entry.
942
303=item Why are the secondary screen-related options not working properly? 943=head3 Why are the secondary screen-related options not working properly?
304 944
305Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 945Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
306distributions (most notably Debian GNU/Linux) break rxvt-unicode 946distributions (most notably Debian GNU/Linux) break rxvt-unicode
307by setting C<TERM> to C<rxvt>, which doesn't have these extra 947by setting C<TERM> to C<rxvt>, which doesn't have these extra
308features. Unfortunately, some of these (most notably, again, Debian 948features. Unfortunately, some of these (most notably, again, Debian
309GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 949GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
310file, so you will need to install it on your own (See the question B<When 950file, so you will need to install it on your own (See the question B<When
311I log-in to another system it tells me about missing terminfo data?> on 951I log-in to another system it tells me about missing terminfo data?> on
312how to do this). 952how to do this).
313 953
314=item My numerical keypad acts weird and generates differing output?
315 954
316Some Debian GNUL/Linux users seem to have this problem, although no 955=head2 Encoding / Locale / Input Method Issues
317specific details were reported so far. It is possible that this is caused
318by the wrong C<TERM> setting, although the details of wether and how
319this can happen are unknown, as C<TERM=rxvt> should offer a compatible
320keymap. See the answer to the previous question, and please report if that
321helped.
322 956
323=item Rxvt-unicode does not seem to understand the selected encoding? 957=head3 Rxvt-unicode does not seem to understand the selected encoding?
324 958
959See next entry.
960
325=item Unicode does not seem to work? 961=head3 Unicode does not seem to work?
326 962
327If you encounter strange problems like typing an accented character but 963If you encounter strange problems like typing an accented character but
328getting two unrelated other characters or similar, or if program output is 964getting two unrelated other characters or similar, or if program output is
329subtly garbled, then you should check your locale settings. 965subtly garbled, then you should check your locale settings.
330 966
331Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 967Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
332programs. Often rxvt-unicode is started in the C<C> locale, while the 968programs running in it. Often rxvt-unicode is started in the C<C> locale,
333login script running within the rxvt-unicode window changes the locale to 969while the login script running within the rxvt-unicode window changes the
334something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 970locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
971not going to work, and is the most common cause for problems.
335 972
336The best thing is to fix your startup environment, as you will likely run 973The best thing is to fix your startup environment, as you will likely run
337into other problems. If nothing works you can try this in your .profile. 974into other problems. If nothing works you can try this in your .profile.
338 975
339 printf '\e]701;%s\007' "$LC_CTYPE" 976 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
340 977
341If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 978If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
342supported on your systems. Some systems have a C<locale> command which 979supported on your systems. Some systems have a C<locale> command which
343displays this (also, C<perl -e0> can be used to check locale settings, as 980displays this (also, C<perl -e0> can be used to check locale settings, as
344it will complain loudly if it cannot set the locale). If it displays something 981it will complain loudly if it cannot set the locale). If it displays something
350 987
351If nothing works and you are sure that everything is set correctly then 988If nothing works and you are sure that everything is set correctly then
352you will need to remember a little known fact: Some programs just don't 989you will need to remember a little known fact: Some programs just don't
353support locales :( 990support locales :(
354 991
355=item Why do some characters look so much different than others? 992=head3 How does rxvt-unicode determine the encoding to use?
356 993
357=item How does rxvt-unicode choose fonts? 994See next entry.
358 995
359Most fonts do not contain the full range of Unicode, which is 996=head3 Is there an option to switch encodings?
360fine. Chances are that the font you (or the admin/package maintainer of
361your system/os) have specified does not cover all the characters you want
362to display.
363 997
364B<rxvt-unicode> makes a best-effort try at finding a replacement 998Unlike some other terminals, rxvt-unicode has no encoding switch, and no
365font. Often the result is fine, but sometimes the chosen font looks 999specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
366bad/ugly/wrong. Some fonts have totally strange characters that don't 1000UTF-8 or any other encodings with respect to terminal I/O.
367resemble the correct glyph at all, and rxvt-unicode lacks the artificial
368intelligence to detect that a specific glyph is wrong: it has to believe
369the font that the characters it claims to contain indeed look correct.
370 1001
371In that case, select a font of your taste and add it to the font list, 1002The reasons is that there exists a perfectly fine mechanism for selecting
372e.g.: 1003the encoding, doing I/O and (most important) communicating this to all
373 1004applications so everybody agrees on character properties such as width
374 @@RXVT_NAME@@ -fn basefont,font2,font3... 1005and code number. This mechanism is the I<locale>. Applications not using
375 1006that info will have problems (for example, C<xterm> gets the width of
376When rxvt-unicode sees a character, it will first look at the base 1007characters wrong as it uses its own, locale-independent table under all
377font. If the base font does not contain the character, it will go to the
378next font, and so on. Specifying your own fonts will also speed up this
379search and use less resources within rxvt-unicode and the X-server.
380
381The only limitation is that none of the fonts may be larger than the base
382font, as the base font defines the terminal character cell size, which
383must be the same due to the way terminals work.
384
385=item Why do some chinese characters look so different than others?
386
387This is because there is a difference between script and language --
388rxvt-unicode does not know which language the text that is output is,
389as it only knows the unicode character codes. If rxvt-unicode first
390sees a japanese/chinese character, it might choose a japanese font for
391display. Subsequent japanese characters will use that font. Now, many
392chinese characters aren't represented in japanese fonts, so when the first
393non-japanese character comes up, rxvt-unicode will look for a chinese font
394-- unfortunately at this point, it will still use the japanese font for
395chinese characters that are also in the japanese font.
396
397The workaround is easy: just tag a chinese font at the end of your font
398list (see the previous question). The key is to view the font list as
399a preference list: If you expect more japanese, list a japanese font
400first. If you expect more chinese, put a chinese font first.
401
402In the future it might be possible to switch language preferences at
403runtime (the internal data structure has no problem with using different
404fonts for the same character at the same time, but no interface for this
405has been designed yet).
406
407Until then, you might get away with switching fonts at runtime (see L<Can
408I switch the fonts at runtime?> later in this document).
409
410=item Why does rxvt-unicode sometimes leave pixel droppings?
411
412Most fonts were not designed for terminal use, which means that character
413size varies a lot. A font that is otherwise fine for terminal use might
414contain some characters that are simply too wide. Rxvt-unicode will avoid
415these characters. For characters that are just "a bit" too wide a special
416"careful" rendering mode is used that redraws adjacent characters.
417
418All of this requires that fonts do not lie about character sizes,
419however: Xft fonts often draw glyphs larger than their acclaimed bounding
420box, and rxvt-unicode has no way of detecting this (the correct way is to
421ask for the character bounding box, which unfortunately is wrong in these
422cases). 1008locales).
423 1009
424It's not clear (to me at least), wether this is a bug in Xft, freetype, 1010Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
425or the respective font. If you encounter this problem you might try using 1011programs doing the same (that is, most) will automatically agree in the
426the C<-lsp> option to give the font more height. If that doesn't work, you 1012interpretation of characters.
427might be forced to use a different font.
428 1013
429All of this is not a problem when using X11 core fonts, as their bounding 1014Unfortunately, there is no system-independent way to select locales, nor
430box data is correct. 1015is there a standard on how locale specifiers will look like.
431 1016
432=item On Solaris 9, many line-drawing characters are too wide. 1017On most systems, the content of the C<LC_CTYPE> environment variable
1018contains an arbitrary string which corresponds to an already-installed
1019locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1020C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1021(i.e. C<de> or C<german>) are also common.
433 1022
434Seems to be a known bug, read 1023Rxvt-unicode ignores all other locale categories, and except for
435L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1024the encoding, ignores country or language-specific settings,
436following ugly workaround to get non-double-wide-characters working: 1025i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1026rxvt-unicode.
437 1027
438 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 1028If you want to use a specific encoding you have to make sure you start
1029rxvt-unicode with the correct C<LC_CTYPE> category.
439 1030
440=item My Compose (Multi_key) key is no longer working. 1031=head3 Can I switch locales at runtime?
441 1032
442The most common causes for this are that either your locale is not set 1033Yes, using an escape sequence. Try something like this, which sets
443correctly, or you specified a B<preeditStyle> that is not supported by 1034rxvt-unicode's idea of C<LC_CTYPE>.
444your input method. For example, if you specified B<OverTheSpot> and
445your input method (e.g. the default input method handling Compose keys)
446does not support this (for instance because it is not visual), then
447rxvt-unicode will continue without an input method.
448 1035
449In this case either do not specify a B<preeditStyle> or specify more than 1036 printf '\33]701;%s\007' ja_JP.SJIS
450one pre-edit style, such as B<OverTheSpot,Root,None>.
451 1037
452=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 1038See also the previous answer.
453 1039
454Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 1040Sometimes this capability is rather handy when you want to work in
455international keyboards) or simply use ISO 14755 support to your 1041one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
456advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 1042(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
457codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 1043first switches to a locale supported by xjdic and back later:
458character and so on.
459 1044
460=item How can I keep rxvt-unicode from using reverse video so much? 1045 printf '\33]701;%s\007' ja_JP.SJIS
1046 xjdic -js
1047 printf '\33]701;%s\007' de_DE.UTF-8
461 1048
462First of all, make sure you are running with the right terminal settings 1049You can also use xterm's C<luit> program, which usually works fine, except
463(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then 1050for some locales where character width differs between program- and
464make sure you have specified colours for italic and bold, as otherwise 1051rxvt-unicode-locales.
465rxvt-unicode might use reverse video to simulate the effect:
466 1052
467 URxvt.colorBD: white 1053=head3 I have problems getting my input method working.
468 URxvt.colorIT: green
469 1054
470=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 1055Try a search engine, as this is slightly different for every input method server.
471 1056
472For some unexplainable reason, some rare programs assume a very weird 1057Here is a checklist:
473colour palette when confronted with a terminal with more than the standard
4748 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
475these programs not to assume non-ISO colours without very good reasons.
476 1058
477In the meantime, you can either edit your C<rxvt-unicode> terminfo 1059=over 4
478definition to only claim 8 colour support or use C<TERM=rxvt>, which will
479fix colours but keep you from using other rxvt-unicode features.
480 1060
1061=item - Make sure your locale I<and> the imLocale are supported on your OS.
1062
1063Try C<locale -a> or check the documentation for your OS.
1064
1065=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1066
1067For example, B<kinput2> does not support UTF-8 locales, you should use
1068C<ja_JP.EUC-JP> or equivalent.
1069
1070=item - Make sure your XIM server is actually running.
1071
1072=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1073
1074When you want to use e.g. B<kinput2>, it must be set to
1075C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1076method servers are running with this command:
1077
1078 xprop -root XIM_SERVERS
1079
1080=item
1081
1082=back
1083
1084=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1085
1086You can specify separate locales for the input method and the rest of the
1087terminal, using the resource C<imlocale>:
1088
1089 URxvt.imlocale: ja_JP.EUC-JP
1090
1091Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1092use your input method. Please note, however, that, depending on your Xlib
1093version, you may not be able to input characters outside C<EUC-JP> in a
1094normal way then, as your input method limits you.
1095
1096=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1097
1098Unfortunately, this is unavoidable, as the XIM protocol is racy by
1099design. Applications can avoid some crashes at the expense of memory
1100leaks, and Input Methods can avoid some crashes by careful ordering at
1101exit time. B<kinput2> (and derived input methods) generally succeeds,
1102while B<SCIM> (or similar input methods) fails. In the end, however,
1103crashes cannot be completely avoided even if both sides cooperate.
1104
1105So the only workaround is not to kill your Input Method Servers.
1106
1107
1108=head2 Operating Systems / Package Maintaining
1109
1110=head3 I am using Debian GNU/Linux and have a problem...
1111
1112The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1113patches that considerably change the behaviour of rxvt-unicode (but
1114unfortunately this notice has been removed). Before reporting a bug to
1115the original rxvt-unicode author please download and install the genuine
1116version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1117the problem. If you cannot, chances are that the problems are specific to
1118Debian GNU/Linux, in which case it should be reported via the Debian Bug
1119Tracking System (use C<reportbug> to report the bug).
1120
1121For other problems that also affect the Debian package, you can and
1122probably should use the Debian BTS, too, because, after all, it's also a
1123bug in the Debian version and it serves as a reminder for other users that
1124might encounter the same issue.
1125
1126=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1127
1128You should build one binary with the default options. F<configure>
1129now enables most useful options, and the trend goes to making them
1130runtime-switchable, too, so there is usually no drawback to enabling them,
1131except higher disk and possibly memory usage. The perl interpreter should
1132be enabled, as important functionality (menus, selection, likely more in
1133the future) depends on it.
1134
1135You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1136system-wide (except maybe with C<defaults>). This will result in useful
1137behaviour. If your distribution aims at low memory, add an empty
1138C<perl-ext-common> resource to the app-defaults file. This will keep the
1139perl interpreter disabled until the user enables it.
1140
1141If you can/want build more binaries, I recommend building a minimal
1142one with C<--disable-everything> (very useful) and a maximal one with
1143C<--enable-everything> (less useful, it will be very big due to a lot of
1144encodings built-in that increase download times and are rarely used).
1145
1146=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1147
1148It should be, starting with release 7.1. You are encouraged to properly
1149install urxvt with privileges necessary for your OS now.
1150
1151When rxvt-unicode detects that it runs setuid or setgid, it will fork
1152into a helper process for privileged operations (pty handling on some
1153systems, utmp/wtmp/lastlog handling on others) and drop privileges
1154immediately. This is much safer than most other terminals that keep
1155privileges while running (but is more relevant to urxvt, as it contains
1156things as perl interpreters, which might be "helpful" to attackers).
1157
1158This forking is done as the very first within main(), which is very early
1159and reduces possible bugs to initialisation code run before main(), or
1160things like the dynamic loader of your system, which should result in very
1161little risk.
1162
481=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 1163=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
482 1164
483Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
484in your compile environment, or an implementation that implements it, 1166in your compile environment, or an implementation that implements it,
485wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1167whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
486B<wchar_t> is represented as unicode. 1168B<wchar_t> is represented as unicode.
487 1169
488As you might have guessed, FreeBSD does neither define this symobl nor 1170As you might have guessed, FreeBSD does neither define this symbol nor
489does it support it. Instead, it uses it's own internal representation of 1171does it support it. Instead, it uses its own internal representation of
490B<wchar_t>. This is, of course, completely fine with respect to standards. 1172B<wchar_t>. This is, of course, completely fine with respect to standards.
491 1173
492However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1174However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
493C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1175C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
494 1176
508 1190
509The rxvt-unicode author insists that the right way to fix this is in the 1191The rxvt-unicode author insists that the right way to fix this is in the
510system libraries once and for all, instead of forcing every app to carry 1192system libraries once and for all, instead of forcing every app to carry
511complete replacements for them :) 1193complete replacements for them :)
512 1194
513=item I use Solaris 9 and it doesn't compile/work/etc.
514
515Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
516problems with C<wcwidth> and a compile problem.
517
518=item How can I use rxvt-unicode under cygwin? 1195=head3 How can I use rxvt-unicode under cygwin?
519 1196
520rxvt-unicode should compile and run out of the box on cygwin, using 1197rxvt-unicode should compile and run out of the box on cygwin, using
521the X11 libraries that come with cygwin. libW11 emulation is no 1198the X11 libraries that come with cygwin. libW11 emulation is no
522longer supported (and makes no sense, either, as it only supported a 1199longer supported (and makes no sense, either, as it only supported a
523single font). I recommend starting the X-server in C<-multiwindow> or 1200single font). I recommend starting the X-server in C<-multiwindow> or
526 1203
527At the time of this writing, cygwin didn't seem to support any multi-byte 1204At the time of this writing, cygwin didn't seem to support any multi-byte
528encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1205encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
529to 8-bit encodings. 1206to 8-bit encodings.
530 1207
531=item How does rxvt-unicode determine the encoding to use? 1208=head3 Character widths are not correct.
532 1209
533=item Is there an option to switch encodings? 1210urxvt uses the system wcwidth function to know the information about
1211the width of characters, so on systems with incorrect locale data you
1212will likely get bad results. Two notorious examples are Solaris 9,
1213where single-width characters like U+2514 are reported as double-width,
1214and Darwin 8, where combining chars are reported having width 1.
534 1215
535Unlike some other terminals, rxvt-unicode has no encoding switch, and no 1216The solution is to upgrade your system or switch to a better one. A
536specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 1217possibly working workaround is to use a wcwidth implementation like
537UTF-8 or any other encodings with respect to terminal I/O.
538 1218
539The reasons is that there exists a perfectly fine mechanism for selecting 1219http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
540the encoding, doing I/O and (most important) communicating this to all
541applications so everybody agrees on character properties such as width
542and code number. This mechanism is the I<locale>. Applications not using
543that info will have problems (for example, C<xterm> gets the width of
544characters wrong as it uses it's own, locale-independent table under all
545locales).
546 1220
547Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
548programs doing the same (that is, most) will automatically agree in the
549interpretation of characters.
550
551Unfortunately, there is no system-independent way to select locales, nor
552is there a standard on how locale specifiers will look like.
553
554On most systems, the content of the C<LC_CTYPE> environment variable
555contains an arbitrary string which corresponds to an already-installed
556locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
557C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
558(i.e. C<de> or C<german>) are also common.
559
560Rxvt-unicode ignores all other locale categories, and except for
561the encoding, ignores country or language-specific settings,
562i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
563rxvt-unicode.
564
565If you want to use a specific encoding you have to make sure you start
566rxvt-unicode with the correct C<LC_CTYPE> category.
567
568=item Can I switch locales at runtime?
569
570Yes, using an escape sequence. Try something like this, which sets
571rxvt-unicode's idea of C<LC_CTYPE>.
572
573 printf '\e]701;%s\007' ja_JP.SJIS
574
575See also the previous answer.
576
577Sometimes this capability is rather handy when you want to work in
578one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
579(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
580first switches to a locale supported by xjdic and back later:
581
582 printf '\e]701;%s\007' ja_JP.SJIS
583 xjdic -js
584 printf '\e]701;%s\007' de_DE.UTF-8
585
586You can also use xterm's C<luit> program, which usually works fine, except
587for some locales where character width differs between program- and
588rxvt-unicode-locales.
589
590=item Can I switch the fonts at runtime?
591
592Yes, using an escape sequence. Try something like this, which has the same
593effect as using the C<-fn> switch, and takes effect immediately:
594
595 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
596
597This is useful if you e.g. work primarily with japanese (and prefer a
598japanese font), but you have to switch to chinese temporarily, where
599japanese fonts would only be in your way.
600
601You can think of this as a kind of manual ISO-2022 switching.
602
603=item Why do italic characters look as if clipped?
604
605Many fonts have difficulties with italic characters and hinting. For
606example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
607Mono> completely fails in it's italic face. A workaround might be to
608enable freetype autohinting, i.e. like this:
609
610 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
611 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
612
613=item My input method wants <some encoding> but I want UTF-8, what can I do?
614
615You can specify separate locales for the input method and the rest of the
616terminal, using the resource C<imlocale>:
617
618 URxvt*imlocale: ja_JP.EUC-JP
619
620Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
621use your input method. Please note, however, that you will not be able to
622input characters outside C<EUC-JP> in a normal way then, as your input
623method limits you.
624
625=item Rxvt-unicode crashes when the X Input Method changes or exits.
626
627Unfortunately, this is unavoidable, as the XIM protocol is racy by
628design. Applications can avoid some crashes at the expense of memory
629leaks, and Input Methods can avoid some crashes by careful ordering at
630exit time. B<kinput2> (and derived input methods) generally succeeds,
631while B<SCIM> (or similar input methods) fails. In the end, however,
632crashes cannot be completely avoided even if both sides cooperate.
633
634So the only workaround is not to kill your Input Method Servers.
635
636=item Rxvt-unicode uses gobs of memory, how can I reduce that?
637
638Rxvt-unicode tries to obey the rule of not charging you for something you
639don't use. One thing you should try is to configure out all settings that
640you don't need, for example, Xft support is a resource hog by design,
641when used. Compiling it out ensures that no Xft font will be loaded
642accidentally when rxvt-unicode tries to find a font for your characters.
643
644Also, many people (me included) like large windows and even larger
645scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6466 bytes per screen cell. For a 160x?? window this amounts to almost a
647kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
648use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
649rxvt-unicode then uses 8 bytes per screen cell.
650
651=item Can I speed up Xft rendering somehow?
652
653Yes, the most obvious way to speed it up is to avoid Xft entirely, as
654it is simply slow. If you still want Xft fonts you might try to disable
655antialiasing (by appending C<:antialias=false>), which saves lots of
656memory and also speeds up rendering considerably.
657
658=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
659
660Rxvt-unicode will use whatever you specify as a font. If it needs to
661fall back to it's default font search list it will prefer X11 core
662fonts, because they are small and fast, and then use Xft fonts. It has
663antialiasing disabled for most of them, because the author thinks they
664look best that way.
665
666If you want antialiasing, you have to specify the fonts manually.
667
668=item Mouse cut/paste suddenly no longer works.
669
670Make sure that mouse reporting is actually turned off since killing
671some editors prematurely may leave the mouse in mouse report mode. I've
672heard that tcsh may use mouse reporting unless it otherwise specified. A
673quick check is to see if cut/paste works when the Alt or Shift keys are
674depressed. See @@RXVT_NAME@@(7)
675
676=item What's with this bold/blink stuff?
677
678If no bold colour is set via C<colorBD:>, bold will invert text using the
679standard foreground colour.
680
681For the standard background colour, blinking will actually make the
682text blink when compiled with C<--enable-blinking>. with standard
683colours. Without C<--enable-blinking>, the blink attribute will be
684ignored.
685
686On ANSI colours, bold/blink attributes are used to set high-intensity
687foreground/background colors.
688
689color0-7 are the low-intensity colors.
690
691color8-15 are the corresponding high-intensity colors.
692
693=item I don't like the screen colors. How do I change them?
694
695You can change the screen colors at run-time using F<~/.Xdefaults>
696resources (or as long-options).
697
698Here are values that are supposed to resemble a VGA screen,
699including the murky brown that passes for low-intensity yellow:
700
701 URxvt.color0: #000000
702 URxvt.color1: #A80000
703 URxvt.color2: #00A800
704 URxvt.color3: #A8A800
705 URxvt.color4: #0000A8
706 URxvt.color5: #A800A8
707 URxvt.color6: #00A8A8
708 URxvt.color7: #A8A8A8
709
710 URxvt.color8: #000054
711 URxvt.color9: #FF0054
712 URxvt.color10: #00FF54
713 URxvt.color11: #FFFF54
714 URxvt.color12: #0000FF
715 URxvt.color13: #FF00FF
716 URxvt.color14: #00FFFF
717 URxvt.color15: #FFFFFF
718
719And here is a more complete set of non-standard colors described (not by
720me) as "pretty girly".
721
722 URxvt.cursorColor: #dc74d1
723 URxvt.pointerColor: #dc74d1
724 URxvt.background: #0e0e0e
725 URxvt.foreground: #4ad5e1
726 URxvt.color0: #000000
727 URxvt.color8: #8b8f93
728 URxvt.color1: #dc74d1
729 URxvt.color9: #dc74d1
730 URxvt.color2: #0eb8c7
731 URxvt.color10: #0eb8c7
732 URxvt.color3: #dfe37e
733 URxvt.color11: #dfe37e
734 URxvt.color5: #9e88f0
735 URxvt.color13: #9e88f0
736 URxvt.color6: #73f7ff
737 URxvt.color14: #73f7ff
738 URxvt.color7: #e1dddd
739 URxvt.color15: #e1dddd
740
741=item How can I start @@RXVT_NAME@@d in a race-free way?
742
743Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
744display, create the listening socket and then fork.
745
746=item What's with the strange Backspace/Delete key behaviour?
747
748Assuming that the physical Backspace key corresponds to the
749BackSpace keysym (not likely for Linux ... see the following
750question) there are two standard values that can be used for
751Backspace: C<^H> and C<^?>.
752
753Historically, either value is correct, but rxvt-unicode adopts the debian
754policy of using C<^?> when unsure, because it's the one only only correct
755choice :).
756
757Rxvt-unicode tries to inherit the current stty settings and uses the value
758of `erase' to guess the value for backspace. If rxvt-unicode wasn't
759started from a terminal (say, from a menu or by remote shell), then the
760system value of `erase', which corresponds to CERASE in <termios.h>, will
761be used (which may not be the same as your stty setting).
762
763For starting a new rxvt-unicode:
764
765 # use Backspace = ^H
766 $ stty erase ^H
767 $ @@RXVT_NAME@@
768
769 # use Backspace = ^?
770 $ stty erase ^?
771 $ @@RXVT_NAME@@
772
773Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
774
775For an existing rxvt-unicode:
776
777 # use Backspace = ^H
778 $ stty erase ^H
779 $ echo -n "^[[36h"
780
781 # use Backspace = ^?
782 $ stty erase ^?
783 $ echo -n "^[[36l"
784
785This helps satisfy some of the Backspace discrepancies that occur, but
786if you use Backspace = C<^H>, make sure that the termcap/terminfo value
787properly reflects that.
788
789The Delete key is a another casualty of the ill-defined Backspace problem.
790To avoid confusion between the Backspace and Delete keys, the Delete
791key has been assigned an escape sequence to match the vt100 for Execute
792(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
793
794Some other Backspace problems:
795
796some editors use termcap/terminfo,
797some editors (vim I'm told) expect Backspace = ^H,
798GNU Emacs (and Emacs-like editors) use ^H for help.
799
800Perhaps someday this will all be resolved in a consistent manner.
801
802=item I don't like the key-bindings. How do I change them?
803
804There are some compile-time selections available via configure. Unless
805you have run "configure" with the C<--disable-resources> option you can
806use the `keysym' resource to alter the keystrings associated with keysyms.
807
808Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
809
810 URxvt.keysym.Home: \033[1~
811 URxvt.keysym.End: \033[4~
812 URxvt.keysym.C-apostrophe: \033<C-'>
813 URxvt.keysym.C-slash: \033<C-/>
814 URxvt.keysym.C-semicolon: \033<C-;>
815 URxvt.keysym.C-grave: \033<C-`>
816 URxvt.keysym.C-comma: \033<C-,>
817 URxvt.keysym.C-period: \033<C-.>
818 URxvt.keysym.C-0x60: \033<C-`>
819 URxvt.keysym.C-Tab: \033<C-Tab>
820 URxvt.keysym.C-Return: \033<C-Return>
821 URxvt.keysym.S-Return: \033<S-Return>
822 URxvt.keysym.S-space: \033<S-Space>
823 URxvt.keysym.M-Up: \033<M-Up>
824 URxvt.keysym.M-Down: \033<M-Down>
825 URxvt.keysym.M-Left: \033<M-Left>
826 URxvt.keysym.M-Right: \033<M-Right>
827 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
828 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
829 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
830
831See some more examples in the documentation for the B<keysym> resource.
832
833=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
834How do I make use of them? For example, the Sun Keyboard type 4
835has the following mappings that rxvt-unicode doesn't recognize.
836
837 KP_Insert == Insert
838 F22 == Print
839 F27 == Home
840 F29 == Prior
841 F33 == End
842 F35 == Next
843
844Rather than have rxvt-unicode try to accommodate all the various possible
845keyboard mappings, it is better to use `xmodmap' to remap the keys as
846required for your particular machine.
847
848=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
849I need this to decide about setting colors etc.
850
851rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
852check and see if that is set. Note that several programs, JED, slrn,
853Midnight Commander automatically check this variable to decide whether or
854not to use color.
855
856=item How do I set the correct, full IP address for the DISPLAY variable?
857
858If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
859insecure mode then it is possible to use the following shell script
860snippets to correctly set the display. If your version of rxvt-unicode
861wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
862the COLORTERM variable can be used to distinguish rxvt-unicode from a
863regular xterm.
864
865Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
866snippets:
867
868 # Bourne/Korn/POSIX family of shells:
869 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
870 if [ ${TERM:-foo} = xterm ]; then
871 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
872 echo -n '^[Z'
873 read term_id
874 stty icanon echo
875 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
876 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
877 read DISPLAY # set it in our local shell
878 fi
879 fi
880
881=item How do I compile the manual pages for myself?
882
883You need to have a recent version of perl installed as F</usr/bin/perl>,
884one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
885the doc subdirectory and enter C<make alldoc>.
886
887=item My question isn't answered here, can I ask a human?
888
889Before sending me mail, you could go to IRC: C<irc.freenode.net>,
890channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
891interested in learning about new and exciting problems (but not FAQs :).
892
893=back
894
895=head1 RXVT TECHNICAL REFERENCE 1221=head1 RXVT-UNICODE TECHNICAL REFERENCE
896
897=head1 DESCRIPTION
898 1222
899The rest of this document describes various technical aspects of 1223The rest of this document describes various technical aspects of
900B<rxvt-unicode>. First the description of supported command sequences, 1224B<rxvt-unicode>. First the description of supported command sequences,
901followed by menu and pixmap support and last by a description of all 1225followed by pixmap support and last by a description of all features
902features selectable at C<configure> time. 1226selectable at C<configure> time.
903 1227
904=head1 Definitions 1228=head2 Definitions
905 1229
906=over 4 1230=over 4
907 1231
908=item B<< C<c> >> 1232=item B<< C<c> >>
909 1233
927 1251
928A text parameter composed of printable characters. 1252A text parameter composed of printable characters.
929 1253
930=back 1254=back
931 1255
932=head1 Values 1256=head2 Values
933 1257
934=over 4 1258=over 4
935 1259
936=item B<< C<ENQ> >> 1260=item B<< C<ENQ> >>
937 1261
980 1304
981Space Character 1305Space Character
982 1306
983=back 1307=back
984 1308
985=head1 Escape Sequences 1309=head2 Escape Sequences
986 1310
987=over 4 1311=over 4
988 1312
989=item B<< C<ESC # 8> >> 1313=item B<< C<ESC # 8> >>
990 1314
1088 1412
1089=back 1413=back
1090 1414
1091X<CSI> 1415X<CSI>
1092 1416
1093=head1 CSI (Command Sequence Introducer) Sequences 1417=head2 CSI (Command Sequence Introducer) Sequences
1094 1418
1095=over 4 1419=over 4
1096 1420
1097=item B<< C<ESC [ Ps @> >> 1421=item B<< C<ESC [ Ps @> >>
1098 1422
1368 1692
1369=back 1693=back
1370 1694
1371X<PrivateModes> 1695X<PrivateModes>
1372 1696
1373=head1 DEC Private Modes 1697=head2 DEC Private Modes
1374 1698
1375=over 4 1699=over 4
1376 1700
1377=item B<< C<ESC [ ? Pm h> >> 1701=item B<< C<ESC [ ? Pm h> >>
1378 1702
1394 1718
1395Toggle DEC Private Mode Values (rxvt extension). I<where> 1719Toggle DEC Private Mode Values (rxvt extension). I<where>
1396 1720
1397=over 4 1721=over 4
1398 1722
1399=item B<< C<Ps = 1> >> (DECCKM) 1723=item B<< C<Pm = 1> >> (DECCKM)
1400 1724
1401=begin table 1725=begin table
1402 1726
1403 B<< C<h> >> Application Cursor Keys 1727 B<< C<h> >> Application Cursor Keys
1404 B<< C<l> >> Normal Cursor Keys 1728 B<< C<l> >> Normal Cursor Keys
1405 1729
1406=end table 1730=end table
1407 1731
1408=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1732=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1409 1733
1410=begin table 1734=begin table
1411 1735
1412 B<< C<h> >> Enter VT52 mode 1736 B<< C<h> >> Enter VT52 mode
1413 B<< C<l> >> Enter VT52 mode 1737 B<< C<l> >> Enter VT52 mode
1414 1738
1415=end table 1739=end table
1416 1740
1417=item B<< C<Ps = 3> >> 1741=item B<< C<Pm = 3> >>
1418 1742
1419=begin table 1743=begin table
1420 1744
1421 B<< C<h> >> 132 Column Mode (DECCOLM) 1745 B<< C<h> >> 132 Column Mode (DECCOLM)
1422 B<< C<l> >> 80 Column Mode (DECCOLM) 1746 B<< C<l> >> 80 Column Mode (DECCOLM)
1423 1747
1424=end table 1748=end table
1425 1749
1426=item B<< C<Ps = 4> >> 1750=item B<< C<Pm = 4> >>
1427 1751
1428=begin table 1752=begin table
1429 1753
1430 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1754 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1431 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1755 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1432 1756
1433=end table 1757=end table
1434 1758
1435=item B<< C<Ps = 5> >> 1759=item B<< C<Pm = 5> >>
1436 1760
1437=begin table 1761=begin table
1438 1762
1439 B<< C<h> >> Reverse Video (DECSCNM) 1763 B<< C<h> >> Reverse Video (DECSCNM)
1440 B<< C<l> >> Normal Video (DECSCNM) 1764 B<< C<l> >> Normal Video (DECSCNM)
1441 1765
1442=end table 1766=end table
1443 1767
1444=item B<< C<Ps = 6> >> 1768=item B<< C<Pm = 6> >>
1445 1769
1446=begin table 1770=begin table
1447 1771
1448 B<< C<h> >> Origin Mode (DECOM) 1772 B<< C<h> >> Origin Mode (DECOM)
1449 B<< C<l> >> Normal Cursor Mode (DECOM) 1773 B<< C<l> >> Normal Cursor Mode (DECOM)
1450 1774
1451=end table 1775=end table
1452 1776
1453=item B<< C<Ps = 7> >> 1777=item B<< C<Pm = 7> >>
1454 1778
1455=begin table 1779=begin table
1456 1780
1457 B<< C<h> >> Wraparound Mode (DECAWM) 1781 B<< C<h> >> Wraparound Mode (DECAWM)
1458 B<< C<l> >> No Wraparound Mode (DECAWM) 1782 B<< C<l> >> No Wraparound Mode (DECAWM)
1459 1783
1460=end table 1784=end table
1461 1785
1462=item B<< C<Ps = 8> >> I<unimplemented> 1786=item B<< C<Pm = 8> >> I<unimplemented>
1463 1787
1464=begin table 1788=begin table
1465 1789
1466 B<< C<h> >> Auto-repeat Keys (DECARM) 1790 B<< C<h> >> Auto-repeat Keys (DECARM)
1467 B<< C<l> >> No Auto-repeat Keys (DECARM) 1791 B<< C<l> >> No Auto-repeat Keys (DECARM)
1468 1792
1469=end table 1793=end table
1470 1794
1471=item B<< C<Ps = 9> >> X10 XTerm 1795=item B<< C<Pm = 9> >> X10 XTerm
1472 1796
1473=begin table 1797=begin table
1474 1798
1475 B<< C<h> >> Send Mouse X & Y on button press. 1799 B<< C<h> >> Send Mouse X & Y on button press.
1476 B<< C<l> >> No mouse reporting. 1800 B<< C<l> >> No mouse reporting.
1477 1801
1478=end table 1802=end table
1479 1803
1480=item B<< C<Ps = 10> >> (B<rxvt>)
1481
1482=begin table
1483
1484 B<< C<h> >> menuBar visible
1485 B<< C<l> >> menuBar invisible
1486
1487=end table
1488
1489=item B<< C<Ps = 25> >> 1804=item B<< C<Pm = 25> >>
1490 1805
1491=begin table 1806=begin table
1492 1807
1493 B<< C<h> >> Visible cursor {cnorm/cvvis} 1808 B<< C<h> >> Visible cursor {cnorm/cvvis}
1494 B<< C<l> >> Invisible cursor {civis} 1809 B<< C<l> >> Invisible cursor {civis}
1495 1810
1496=end table 1811=end table
1497 1812
1498=item B<< C<Ps = 30> >> 1813=item B<< C<Pm = 30> >>
1499 1814
1500=begin table 1815=begin table
1501 1816
1502 B<< C<h> >> scrollBar visisble 1817 B<< C<h> >> scrollBar visible
1503 B<< C<l> >> scrollBar invisisble 1818 B<< C<l> >> scrollBar invisible
1504 1819
1505=end table 1820=end table
1506 1821
1507=item B<< C<Ps = 35> >> (B<rxvt>) 1822=item B<< C<Pm = 35> >> (B<rxvt>)
1508 1823
1509=begin table 1824=begin table
1510 1825
1511 B<< C<h> >> Allow XTerm Shift+key sequences 1826 B<< C<h> >> Allow XTerm Shift+key sequences
1512 B<< C<l> >> Disallow XTerm Shift+key sequences 1827 B<< C<l> >> Disallow XTerm Shift+key sequences
1513 1828
1514=end table 1829=end table
1515 1830
1516=item B<< C<Ps = 38> >> I<unimplemented> 1831=item B<< C<Pm = 38> >> I<unimplemented>
1517 1832
1518Enter Tektronix Mode (DECTEK) 1833Enter Tektronix Mode (DECTEK)
1519 1834
1520=item B<< C<Ps = 40> >> 1835=item B<< C<Pm = 40> >>
1521 1836
1522=begin table 1837=begin table
1523 1838
1524 B<< C<h> >> Allow 80/132 Mode 1839 B<< C<h> >> Allow 80/132 Mode
1525 B<< C<l> >> Disallow 80/132 Mode 1840 B<< C<l> >> Disallow 80/132 Mode
1526 1841
1527=end table 1842=end table
1528 1843
1529=item B<< C<Ps = 44> >> I<unimplemented> 1844=item B<< C<Pm = 44> >> I<unimplemented>
1530 1845
1531=begin table 1846=begin table
1532 1847
1533 B<< C<h> >> Turn On Margin Bell 1848 B<< C<h> >> Turn On Margin Bell
1534 B<< C<l> >> Turn Off Margin Bell 1849 B<< C<l> >> Turn Off Margin Bell
1535 1850
1536=end table 1851=end table
1537 1852
1538=item B<< C<Ps = 45> >> I<unimplemented> 1853=item B<< C<Pm = 45> >> I<unimplemented>
1539 1854
1540=begin table 1855=begin table
1541 1856
1542 B<< C<h> >> Reverse-wraparound Mode 1857 B<< C<h> >> Reverse-wraparound Mode
1543 B<< C<l> >> No Reverse-wraparound Mode 1858 B<< C<l> >> No Reverse-wraparound Mode
1544 1859
1545=end table 1860=end table
1546 1861
1547=item B<< C<Ps = 46> >> I<unimplemented> 1862=item B<< C<Pm = 46> >> I<unimplemented>
1548 1863
1549=item B<< C<Ps = 47> >> 1864=item B<< C<Pm = 47> >>
1550 1865
1551=begin table 1866=begin table
1552 1867
1553 B<< C<h> >> Use Alternate Screen Buffer 1868 B<< C<h> >> Use Alternate Screen Buffer
1554 B<< C<l> >> Use Normal Screen Buffer 1869 B<< C<l> >> Use Normal Screen Buffer
1555 1870
1556=end table 1871=end table
1557 1872
1558X<Priv66> 1873X<Priv66>
1559 1874
1560=item B<< C<Ps = 66> >> 1875=item B<< C<Pm = 66> >>
1561 1876
1562=begin table 1877=begin table
1563 1878
1564 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1879 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1565 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1880 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1566 1881
1567=end table 1882=end table
1568 1883
1569=item B<< C<Ps = 67> >> 1884=item B<< C<Pm = 67> >>
1570 1885
1571=begin table 1886=begin table
1572 1887
1573 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1888 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1574 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1889 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1575 1890
1576=end table 1891=end table
1577 1892
1578=item B<< C<Ps = 1000> >> (X11 XTerm) 1893=item B<< C<Pm = 1000> >> (X11 XTerm)
1579 1894
1580=begin table 1895=begin table
1581 1896
1582 B<< C<h> >> Send Mouse X & Y on button press and release. 1897 B<< C<h> >> Send Mouse X & Y on button press and release.
1583 B<< C<l> >> No mouse reporting. 1898 B<< C<l> >> No mouse reporting.
1584 1899
1585=end table 1900=end table
1586 1901
1587=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1902=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1588 1903
1589=begin table 1904=begin table
1590 1905
1591 B<< C<h> >> Use Hilite Mouse Tracking. 1906 B<< C<h> >> Use Hilite Mouse Tracking.
1592 B<< C<l> >> No mouse reporting. 1907 B<< C<l> >> No mouse reporting.
1593 1908
1594=end table 1909=end table
1595 1910
1911=item B<< C<Pm = 1002> >> (X11 XTerm)
1912
1913=begin table
1914
1915 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1916 B<< C<l> >> No mouse reporting.
1917
1918=end table
1919
1920=item B<< C<Pm = 1003> >> (X11 XTerm)
1921
1922=begin table
1923
1924 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1925 B<< C<l> >> No mouse reporting.
1926
1927=end table
1928
1596=item B<< C<Ps = 1010> >> (B<rxvt>) 1929=item B<< C<Pm = 1010> >> (B<rxvt>)
1597 1930
1598=begin table 1931=begin table
1599 1932
1600 B<< C<h> >> Don't scroll to bottom on TTY output 1933 B<< C<h> >> Don't scroll to bottom on TTY output
1601 B<< C<l> >> Scroll to bottom on TTY output 1934 B<< C<l> >> Scroll to bottom on TTY output
1602 1935
1603=end table 1936=end table
1604 1937
1605=item B<< C<Ps = 1011> >> (B<rxvt>) 1938=item B<< C<Pm = 1011> >> (B<rxvt>)
1606 1939
1607=begin table 1940=begin table
1608 1941
1609 B<< C<h> >> Scroll to bottom when a key is pressed 1942 B<< C<h> >> Scroll to bottom when a key is pressed
1610 B<< C<l> >> Don't scroll to bottom when a key is pressed 1943 B<< C<l> >> Don't scroll to bottom when a key is pressed
1611 1944
1612=end table 1945=end table
1613 1946
1614=item B<< C<Ps = 1021> >> (B<rxvt>) 1947=item B<< C<Pm = 1021> >> (B<rxvt>)
1615 1948
1616=begin table 1949=begin table
1617 1950
1618 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1951 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1619 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1952 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1620 1953
1621=end table 1954=end table
1622 1955
1623=item B<< C<Ps = 1047> >> 1956=item B<< C<Pm = 1047> >>
1624 1957
1625=begin table 1958=begin table
1626 1959
1627 B<< C<h> >> Use Alternate Screen Buffer 1960 B<< C<h> >> Use Alternate Screen Buffer
1628 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1961 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1629 1962
1630=end table 1963=end table
1631 1964
1632=item B<< C<Ps = 1048> >> 1965=item B<< C<Pm = 1048> >>
1633 1966
1634=begin table 1967=begin table
1635 1968
1636 B<< C<h> >> Save cursor position 1969 B<< C<h> >> Save cursor position
1637 B<< C<l> >> Restore cursor position 1970 B<< C<l> >> Restore cursor position
1638 1971
1639=end table 1972=end table
1640 1973
1641=item B<< C<Ps = 1049> >> 1974=item B<< C<Pm = 1049> >>
1642 1975
1643=begin table 1976=begin table
1644 1977
1645 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1978 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1646 B<< C<l> >> Use Normal Screen Buffer 1979 B<< C<l> >> Use Normal Screen Buffer
1651 1984
1652=back 1985=back
1653 1986
1654X<XTerm> 1987X<XTerm>
1655 1988
1656=head1 XTerm Operating System Commands 1989=head2 XTerm Operating System Commands
1657 1990
1658=over 4 1991=over 4
1659 1992
1660=item B<< C<ESC ] Ps;Pt ST> >> 1993=item B<< C<ESC ] Ps;Pt ST> >>
1661 1994
1668 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2001 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1669 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2002 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1670 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2003 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1671 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. 2004 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1672 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 2005 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1673 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2006 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1674 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2007 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1675 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2008 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1676 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2009 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1677 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2010 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1678 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2011 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1679 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2012 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1680 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 2013 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1681 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2014 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1682 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2015 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1683 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2016 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1684 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 2017 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1685 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2018 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1686 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 2019 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1687 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 2020 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1688 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2021 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1689 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2022 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1690 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2023 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1691 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 2024 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1692 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2025 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1699 2032
1700=end table 2033=end table
1701 2034
1702=back 2035=back
1703 2036
1704X<menuBar> 2037=head1 BACKGROUND IMAGE
1705 2038
1706=head1 menuBar
1707
1708B<< The exact syntax used is I<almost> solidified. >>
1709In the menus, B<DON'T> try to use menuBar commands that add or remove a
1710menuBar.
1711
1712Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1713omitted: use B<./> to specify a menu relative to the current menu.
1714
1715=head2 Overview of menuBar operation
1716
1717For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1718of C<Pt> can be used for a variety of tasks:
1719
1720At the top level is the current menuBar which is a member of a circular
1721linked-list of other such menuBars.
1722
1723The menuBar acts as a parent for the various drop-down menus, which in
1724turn, may have labels, separator lines, menuItems and subMenus.
1725
1726The menuItems are the useful bits: you can use them to mimic keyboard
1727input or even to send text or escape sequences back to rxvt.
1728
1729The menuBar syntax is intended to provide a simple yet robust method of
1730constructing and manipulating menus and navigating through the
1731menuBars.
1732
1733The first step is to use the tag B<< [menu:I<name>] >> which creates
1734the menuBar called I<name> and allows access. You may now or menus,
1735subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1736menuBar access as B<readonly> to prevent accidental corruption of the
1737menus. To re-access the current menuBar for alterations, use the tag
1738B<[menu]>, make the alterations and then use B<[done]>
1739
1740X<menuBarCommands>
1741
1742=head2 Commands
1743
1744=over 4
1745
1746=item B<< [menu:+I<name>] >>
1747
1748access the named menuBar for creation or alteration. If a new menuBar
1749is created, it is called I<name> (max of 15 chars) and the current
1750menuBar is pushed onto the stack
1751
1752=item B<[menu]>
1753
1754access the current menuBar for alteration
1755
1756=item B<< [title:+I<string>] >>
1757
1758set the current menuBar's title to I<string>, which may contain the
1759following format specifiers:
1760
1761 B<%n> rxvt name (as per the B<-name> command-line option)
1762 B<%v> rxvt version
1763 B<%%> literal B<%> character
1764
1765=item B<[done]>
1766
1767set menuBar access as B<readonly>.
1768End-of-file tag for B<< [read:+I<file>] >> operations.
1769
1770=item B<< [read:+I<file>] >>
1771
1772read menu commands directly from I<file> (extension ".menu" will be
1773appended if required.) Start reading at a line with B<[menu]> or B<<
1774[menu:+I<name> >> and continuing until B<[done]> is encountered.
1775
1776Blank and comment lines (starting with B<#>) are ignored. Actually,
1777since any invalid menu commands are also ignored, almost anything could
1778be construed as a comment line, but this may be tightened up in the
1779future ... so don't count on it!.
1780
1781=item B<< [read:+I<file>;+I<name>] >>
1782
1783The same as B<< [read:+I<file>] >>, but start reading at a line with
1784B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1785B<[done]> is encountered.
1786
1787=item B<[dump]>
1788
1789dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1790later rereading.
1791
1792=item B<[rm:name]>
1793
1794remove the named menuBar
1795
1796=item B<[rm] [rm:]>
1797
1798remove the current menuBar
1799
1800=item B<[rm*] [rm:*]>
1801
1802remove all menuBars
1803
1804=item B<[swap]>
1805
1806swap the top two menuBars
1807
1808=item B<[prev]>
1809
1810access the previous menuBar
1811
1812=item B<[next]>
1813
1814access the next menuBar
1815
1816=item B<[show]>
1817
1818Enable display of the menuBar
1819
1820=item B<[hide]>
1821
1822Disable display of the menuBar
1823
1824=item B<< [pixmap:+I<name>] >>
1825
1826=item B<< [pixmap:+I<name>;I<scaling>] >>
1827
1828(set the background pixmap globally
1829
1830B<< A Future implementation I<may> make this local to the menubar >>)
1831
1832=item B<< [:+I<command>:] >>
1833
1834ignore the menu readonly status and issue a I<command> to or a menu or
1835menuitem or change the ; a useful shortcut for setting the quick arrows
1836from a menuBar.
1837
1838=back
1839
1840X<menuBarAdd>
1841
1842=head2 Adding and accessing menus
1843
1844The following commands may also be B<+> prefixed.
1845
1846=over 4
1847
1848=item B</+>
1849
1850access menuBar top level
1851
1852=item B<./+>
1853
1854access current menu level
1855
1856=item B<../+>
1857
1858access parent menu (1 level up)
1859
1860=item B<../../>
1861
1862access parent menu (multiple levels up)
1863
1864=item B<< I</path/>menu >>
1865
1866add/access menu
1867
1868=item B<< I</path/>menu/* >>
1869
1870add/access menu and clear it if it exists
1871
1872=item B<< I</path/>{-} >>
1873
1874add separator
1875
1876=item B<< I</path/>{item} >>
1877
1878add B<item> as a label
1879
1880=item B<< I</path/>{item} action >>
1881
1882add/alter I<menuitem> with an associated I<action>
1883
1884=item B<< I</path/>{item}{right-text} >>
1885
1886add/alter I<menuitem> with B<right-text> as the right-justified text
1887and as the associated I<action>
1888
1889=item B<< I</path/>{item}{rtext} action >>
1890
1891add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1892the right-justified text.
1893
1894=back
1895
1896=over 4
1897
1898=item Special characters in I<action> must be backslash-escaped:
1899
1900B<\a \b \E \e \n \r \t \octal>
1901
1902=item or in control-character notation:
1903
1904B<^@, ^A .. ^Z .. ^_, ^?>
1905
1906=back
1907
1908To send a string starting with a B<NUL> (B<^@>) character to the
1909program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1910the first of which will be stripped off and the balance directed to the
1911program. Otherwise if I<action> begins with B<NUL> followed by
1912non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1913balance is sent back to rxvt.
1914
1915As a convenience for the many Emacs-type editors, I<action> may start
1916with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1917appended if missed from B<M-x> commands.
1918
1919As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1920quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1921
1922=over 4
1923
1924=item For example,
1925
1926B<M-xapropos> is equivalent to B<\Exapropos\r>
1927
1928=item and
1929
1930B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1931
1932=back
1933
1934The option B<< {I<right-rtext>} >> will be right-justified. In the
1935absence of a specified action, this text will be used as the I<action>
1936as well.
1937
1938=over 4
1939
1940=item For example,
1941
1942B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1943
1944=back
1945
1946The left label I<is> necessary, since it's used for matching, but
1947implicitly hiding the left label (by using same name for both left and
1948right labels), or explicitly hiding the left label (by preceeding it
1949with a dot), makes it possible to have right-justified text only.
1950
1951=over 4
1952
1953=item For example,
1954
1955B</File/{Open}{Open} Open-File-Action>
1956
1957=item or hiding it
1958
1959B</File/{.anylabel}{Open} Open-File-Action>
1960
1961=back
1962
1963X<menuBarRemove>
1964
1965=head2 Removing menus
1966
1967=over 4
1968
1969=item B<< -/*+ >>
1970
1971remove all menus from the menuBar, the same as B<[clear]>
1972
1973=item B<< -+I</path>menu+ >>
1974
1975remove menu
1976
1977=item B<< -+I</path>{item}+ >>
1978
1979remove item
1980
1981=item B<< -+I</path>{-} >>
1982
1983remove separator)
1984
1985=item B<-/path/menu/*>
1986
1987remove all items, separators and submenus from menu
1988
1989=back
1990
1991X<menuBarArrows>
1992
1993=head2 Quick Arrows
1994
1995The menus also provide a hook for I<quick arrows> to provide easier
1996user access. If nothing has been explicitly set, the default is to
1997emulate the curror keys. The syntax permits each arrow to be altered
1998individually or all four at once without re-entering their common
1999beginning/end text. For example, to explicitly associate cursor actions
2000with the arrows, any of the following forms could be used:
2001
2002=over 4
2003
2004=item B<< <r>+I<Right> >>
2005
2006=item B<< <l>+I<Left> >>
2007
2008=item B<< <u>+I<Up> >>
2009
2010=item B<< <d>+I<Down> >>
2011
2012Define actions for the respective arrow buttons
2013
2014=item B<< <b>+I<Begin> >>
2015
2016=item B<< <e>+I<End> >>
2017
2018Define common beginning/end parts for I<quick arrows> which used in
2019conjunction with the above <r> <l> <u> <d> constructs
2020
2021=back
2022
2023=over 4
2024
2025=item For example, define arrows individually,
2026
2027 <u>\E[A
2028
2029 <d>\E[B
2030
2031 <r>\E[C
2032
2033 <l>\E[D
2034
2035=item or all at once
2036
2037 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
2038
2039=item or more compactly (factoring out common parts)
2040
2041 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
2042
2043=back
2044
2045X<menuBarSummary>
2046
2047=head2 Command Summary
2048
2049A short summary of the most I<common> commands:
2050
2051=over 4
2052
2053=item [menu:name]
2054
2055use an existing named menuBar or start a new one
2056
2057=item [menu]
2058
2059use the current menuBar
2060
2061=item [title:string]
2062
2063set menuBar title
2064
2065=item [done]
2066
2067set menu access to readonly and, if reading from a file, signal EOF
2068
2069=item [done:name]
2070
2071if reading from a file using [read:file;name] signal EOF
2072
2073=item [rm:name]
2074
2075remove named menuBar(s)
2076
2077=item [rm] [rm:]
2078
2079remove current menuBar
2080
2081=item [rm*] [rm:*]
2082
2083remove all menuBar(s)
2084
2085=item [swap]
2086
2087swap top two menuBars
2088
2089=item [prev]
2090
2091access the previous menuBar
2092
2093=item [next]
2094
2095access the next menuBar
2096
2097=item [show]
2098
2099map menuBar
2100
2101=item [hide]
2102
2103unmap menuBar
2104
2105=item [pixmap;file]
2106
2107=item [pixmap;file;scaling]
2108
2109set a background pixmap
2110
2111=item [read:file]
2112
2113=item [read:file;name]
2114
2115read in a menu from a file
2116
2117=item [dump]
2118
2119dump out all menuBars to /tmp/rxvt-PID
2120
2121=item /
2122
2123access menuBar top level
2124
2125=item ./
2126
2127=item ../
2128
2129=item ../../
2130
2131access current or parent menu level
2132
2133=item /path/menu
2134
2135add/access menu
2136
2137=item /path/{-}
2138
2139add separator
2140
2141=item /path/{item}{rtext} action
2142
2143add/alter menu item
2144
2145=item -/*
2146
2147remove all menus from the menuBar
2148
2149=item -/path/menu
2150
2151remove menu items, separators and submenus from menu
2152
2153=item -/path/menu
2154
2155remove menu
2156
2157=item -/path/{item}
2158
2159remove item
2160
2161=item -/path/{-}
2162
2163remove separator
2164
2165=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2166
2167menu quick arrows
2168
2169=back
2170X<XPM>
2171
2172=head1 XPM
2173
2174For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2039For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
2175of B<< C<Pt> >> can be the name of the background pixmap followed by a 2040of B<< C<Pt> >> can be the name of the background image file followed by a
2176sequence of scaling/positioning commands separated by semi-colons. The 2041sequence of scaling/positioning commands separated by semi-colons. The
2177scaling/positioning commands are as follows: 2042scaling/positioning commands are as follows:
2178 2043
2179=over 4 2044=over 4
2180 2045
2218 2083
2219For example: 2084For example:
2220 2085
2221=over 4 2086=over 4
2222 2087
2223=item B<\E]20;funky\a> 2088=item B<\E]20;funky.jpg\a>
2224 2089
2225load B<funky.xpm> as a tiled image 2090load B<funky.jpg> as a tiled image
2226 2091
2227=item B<\E]20;mona;100\a> 2092=item B<\E]20;mona.jpg;100\a>
2228 2093
2229load B<mona.xpm> with a scaling of 100% 2094load B<mona.jpg> with a scaling of 100%
2230 2095
2231=item B<\E]20;;200;?\a> 2096=item B<\E]20;;200;?\a>
2232 2097
2233rescale the current pixmap to 200% and display the image geometry in 2098rescale the current pixmap to 200% and display the image geometry in
2234the title 2099the title
2273=begin table 2138=begin table
2274 2139
2275 4 Shift 2140 4 Shift
2276 8 Meta 2141 8 Meta
2277 16 Control 2142 16 Control
2278 32 Double Click I<(Rxvt extension)> 2143 32 Double Click I<(rxvt extension)>
2279 2144
2280=end table 2145=end table
2281 2146
2282Col = B<< C<< <x> - SPACE >> >> 2147Col = B<< C<< <x> - SPACE >> >>
2283 2148
2361 2226
2362=head1 CONFIGURE OPTIONS 2227=head1 CONFIGURE OPTIONS
2363 2228
2364General hint: if you get compile errors, then likely your configuration 2229General hint: if you get compile errors, then likely your configuration
2365hasn't been tested well. Either try with C<--enable-everything> or use 2230hasn't been tested well. Either try with C<--enable-everything> or use
2366the F<./reconf> script as a base for experiments. F<./reconf> is used by 2231the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2367myself, so it should generally be a working config. Of course, you should 2232switches). Of course, you should always report when a combination doesn't
2368always report when a combination doesn't work, so it can be fixed. Marc 2233work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2369Lehmann <rxvt@schmorp.de>.
2370 2234
2371All 2235All
2372 2236
2373=over 4 2237=over 4
2374 2238
2406 2270
2407=begin table 2271=begin table
2408 2272
2409 all all available codeset groups 2273 all all available codeset groups
2410 zh common chinese encodings 2274 zh common chinese encodings
2411 zh_ext rarely used but very big chinese encodigs 2275 zh_ext rarely used but very big chinese encodings
2412 jp common japanese encodings 2276 jp common japanese encodings
2413 jp_ext rarely used but big japanese encodings 2277 jp_ext rarely used but big japanese encodings
2414 kr korean encodings 2278 kr korean encodings
2415 2279
2416=end table 2280=end table
2420Add support for XIM (X Input Method) protocol. This allows using 2284Add support for XIM (X Input Method) protocol. This allows using
2421alternative input methods (e.g. kinput2) and will also correctly 2285alternative input methods (e.g. kinput2) and will also correctly
2422set up the input for people using dead keys or compose keys. 2286set up the input for people using dead keys or compose keys.
2423 2287
2424=item --enable-unicode3 (default: off) 2288=item --enable-unicode3 (default: off)
2289
2290Recommended to stay off unless you really need non-BMP characters.
2425 2291
2426Enable direct support for displaying unicode codepoints above 2292Enable direct support for displaying unicode codepoints above
242765535 (the basic multilingual page). This increases storage 229365535 (the basic multilingual page). This increases storage
2428requirements per character from 2 to 4 bytes. X11 fonts do not yet 2294requirements per character from 2 to 4 bytes. X11 fonts do not yet
2429support these extra characters, but Xft does. 2295support these extra characters, but Xft does.
2430 2296
2431Please note that rxvt-unicode can store unicode code points >65535 2297Please note that rxvt-unicode can store unicode code points >65535
2432even without this flag, but the number of such characters is 2298even without this flag, but the number of such characters is
2433limited to a view thousand (shared with combining characters, 2299limited to a few thousand (shared with combining characters,
2434see next switch), and right now rxvt-unicode cannot display them 2300see next switch), and right now rxvt-unicode cannot display them
2435(input/output and cut&paste still work, though). 2301(input/output and cut&paste still work, though).
2436 2302
2437=item --enable-combining (default: on) 2303=item --enable-combining (default: on)
2438 2304
2440composite characters. This is required for proper viewing of text 2306composite characters. This is required for proper viewing of text
2441where accents are encoded as seperate unicode characters. This is 2307where accents are encoded as seperate unicode characters. This is
2442done by using precomposited characters when available or creating 2308done by using precomposited characters when available or creating
2443new pseudo-characters when no precomposed form exists. 2309new pseudo-characters when no precomposed form exists.
2444 2310
2445Without --enable-unicode3, the number of additional precomposed characters 2311Without --enable-unicode3, the number of additional precomposed
2446is rather limited (2048, if this is full, rxvt-unicode will use the 2312characters is somewhat limited (the 6400 private use characters will be
2447private use area, extending the number of combinations to 8448). With
2448--enable-unicode3, no practical limit exists. 2313(ab-)used). With --enable-unicode3, no practical limit exists.
2449 2314
2450This option will also enable storage (but not display) of characters 2315This option will also enable storage (but not display) of characters
2451beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2316beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2452 2317
2453The combining table also contains entries for arabic presentation forms, 2318The combining table also contains entries for arabic presentation forms,
2454but these are not currently used. Bug me if you want these to be used (and 2319but these are not currently used. Bug me if you want these to be used (and
2455tell me how these are to be used...). 2320tell me how these are to be used...).
2456 2321
2457=item --enable-fallback(=CLASS) (default: Rxvt) 2322=item --enable-fallback(=CLASS) (default: Rxvt)
2458 2323
2459When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. 2324When reading resource settings, also read settings for class CLASS. To
2325disable resource fallback use --disable-fallback.
2460 2326
2461=item --with-res-name=NAME (default: urxvt) 2327=item --with-res-name=NAME (default: urxvt)
2462 2328
2463Use the given name as default application name when 2329Use the given name as default application name when
2464reading resources. Specify --with-res-name=rxvt to replace rxvt. 2330reading resources. Specify --with-res-name=rxvt to replace rxvt.
2465 2331
2466=item --with-res-class=CLASS /default: URxvt) 2332=item --with-res-class=CLASS (default: URxvt)
2467 2333
2468Use the given class as default application class 2334Use the given class as default application class
2469when reading resources. Specify --with-res-class=Rxvt to replace 2335when reading resources. Specify --with-res-class=Rxvt to replace
2470rxvt. 2336rxvt.
2471 2337
2484 2350
2485Write user and tty to lastlog file (used by programs like 2351Write user and tty to lastlog file (used by programs like
2486F<lastlogin>) at start of rxvt execution. This option requires 2352F<lastlogin>) at start of rxvt execution. This option requires
2487--enable-utmp to also be specified. 2353--enable-utmp to also be specified.
2488 2354
2489=item --enable-xpm-background (default: on) 2355=item --enable-afterimage (default: on)
2490 2356
2491Add support for XPM background pixmaps. 2357Add support for libAfterImage to be used for transparency and background
2358images. It adds support for many file formats including JPG, PNG,
2359SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2360(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2361
2362This option also adds such eye candy as blending an image over the root
2363background, as well as dynamic scaling and bluring of background images.
2364
2365Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2366increase by a few megabytes even if no extra features are used (mostly due
2367to third-party libraries used by libAI). Memory footprint may somewhat be
2368lowered if libAfterImage is configured without support for SVG.
2492 2369
2493=item --enable-transparency (default: on) 2370=item --enable-transparency (default: on)
2494 2371
2495Add support for inheriting parent backgrounds thus giving a fake 2372Add support for backgrounds, creating illusion of transparency in the term.
2496transparency to the term.
2497 2373
2498=item --enable-fading (default: on) 2374=item --enable-fading (default: on)
2499 2375
2500Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2376Add support for fading the text when focus is lost.
2501
2502=item --enable-tinting (default: on)
2503
2504Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2505
2506=item --enable-menubar (default: off) [DEPRECATED]
2507
2508Add support for our menu bar system (this interacts badly with dynamic
2509locale switching currently). This option is DEPRECATED and will be removed
2510in the future.
2511 2377
2512=item --enable-rxvt-scroll (default: on) 2378=item --enable-rxvt-scroll (default: on)
2513 2379
2514Add support for the original rxvt scrollbar. 2380Add support for the original rxvt scrollbar.
2515 2381
2525 2391
2526Add support for a very unobtrusive, plain-looking scrollbar that 2392Add support for a very unobtrusive, plain-looking scrollbar that
2527is the favourite of the rxvt-unicode author, having used it for 2393is the favourite of the rxvt-unicode author, having used it for
2528many years. 2394many years.
2529 2395
2530=item --enable-half-shadow (default: off)
2531
2532Make shadows on the scrollbar only half the normal width & height.
2533only applicable to rxvt scrollbars.
2534
2535=item --enable-ttygid (default: off)
2536
2537Change tty device setting to group "tty" - only use this if
2538your system uses this type of security.
2539
2540=item --disable-backspace-key 2396=item --disable-backspace-key
2541 2397
2542Removes any handling of the backspace key by us - let the X server do it. 2398Removes any handling of the backspace key by us - let the X server do it.
2543 2399
2544=item --disable-delete-key 2400=item --disable-delete-key
2547do it. 2403do it.
2548 2404
2549=item --disable-resources 2405=item --disable-resources
2550 2406
2551Removes any support for resource checking. 2407Removes any support for resource checking.
2552
2553=item --enable-strings (default: off)
2554
2555Add support for our possibly faster memset() function and other
2556various routines, overriding your system's versions which may
2557have been hand-crafted in assembly or may require extra libraries
2558to link in. (this breaks ANSI-C rules and has problems on many
2559GNU/Linux systems).
2560 2408
2561=item --disable-swapscreen 2409=item --disable-swapscreen
2562 2410
2563Remove support for secondary/swap screen. 2411Remove support for secondary/swap screen.
2564 2412
2571A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2419A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2572in combination with other switches) is: 2420in combination with other switches) is:
2573 2421
2574 MWM-hints 2422 MWM-hints
2575 EWMH-hints (pid, utf8 names) and protocols (ping) 2423 EWMH-hints (pid, utf8 names) and protocols (ping)
2424 urgency hint
2576 seperate underline colour (-underlineColor) 2425 seperate underline colour (-underlineColor)
2577 settable border widths and borderless switch (-w, -b, -bl) 2426 settable border widths and borderless switch (-w, -b, -bl)
2427 visual depth selection (-depth)
2578 settable extra linespacing /-lsp) 2428 settable extra linespacing /-lsp)
2579 iso-14755-2 and -3, and visual feedback 2429 iso-14755 5.1 (basic) support
2580 backindex and forwardindex escape sequence
2581 window op and some xterm/OSC escape sequences
2582 tripleclickwords (-tcw) 2430 tripleclickwords (-tcw)
2583 settable insecure mode (-insecure) 2431 settable insecure mode (-insecure)
2584 keysym remapping support 2432 keysym remapping support
2585 cursor blinking and underline cursor (-cb, -uc) 2433 cursor blinking and underline cursor (-cb, -uc)
2586 XEmbed support (-embed) 2434 XEmbed support (-embed)
2587 user-pty (-pty-fd) 2435 user-pty (-pty-fd)
2588 hold on exit (-hold) 2436 hold on exit (-hold)
2437 compile in built-in block graphics
2589 skip builtin block graphics (-sbg) 2438 skip builtin block graphics (-sbg)
2439 separate highlightcolor support (-hc)
2440
2441It also enables some non-essential features otherwise disabled, such as:
2442
2443 some round-trip time optimisations
2444 nearest color allocation on pseudocolor screens
2445 UTF8_STRING support for selection
2590 sgr modes 90..97 and 100..107 2446 sgr modes 90..97 and 100..107
2447 backindex and forwardindex escape sequences
2448 view change/zero scrollback escape sequences
2449 locale switching escape sequence
2450 window op and some xterm/OSC escape sequences
2451 rectangular selections
2452 trailing space removal for selections
2453 verbose X error handling
2591 2454
2592=item --enable-iso14755 (default: on) 2455=item --enable-iso14755 (default: on)
2593 2456
2594Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2457Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2595F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2458F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2599=item --enable-keepscrolling (default: on) 2462=item --enable-keepscrolling (default: on)
2600 2463
2601Add support for continual scrolling of the display when you hold 2464Add support for continual scrolling of the display when you hold
2602the mouse button down on a scrollbar arrow. 2465the mouse button down on a scrollbar arrow.
2603 2466
2467=item --enable-selectionscrolling (default: on)
2468
2469Add support for scrolling when the selection moves to the top or
2470bottom of the screen.
2471
2604=item --enable-mousewheel (default: on) 2472=item --enable-mousewheel (default: on)
2605 2473
2606Add support for scrolling via mouse wheel or buttons 4 & 5. 2474Add support for scrolling via mouse wheel or buttons 4 & 5.
2607 2475
2608=item --enable-slipwheeling (default: on) 2476=item --enable-slipwheeling (default: on)
2609 2477
2610Add support for continual scrolling (using the mouse wheel as an 2478Add support for continual scrolling (using the mouse wheel as an
2611accelerator) while the control key is held down. This option 2479accelerator) while the control key is held down. This option
2612requires --enable-mousewheel to also be specified. 2480requires --enable-mousewheel to also be specified.
2613 2481
2614=item --disable-new-selection
2615
2616Remove support for mouse selection style like that of xterm.
2617
2618=item --enable-dmalloc (default: off)
2619
2620Use Gray Watson's malloc - which is good for debugging See
2621http://www.letters.com/dmalloc/ for details If you use either this or the
2622next option, you may need to edit src/Makefile after compiling to point
2623DINCLUDE and DLIB to the right places.
2624
2625You can only use either this option and the following (should
2626you use either) .
2627
2628=item --enable-dlmalloc (default: off)
2629
2630Use Doug Lea's malloc - which is good for a production version
2631See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2632
2633=item --enable-smart-resize (default: on) 2482=item --enable-smart-resize (default: off)
2634 2483
2635Add smart growth/shrink behaviour when changing font size via hot 2484Add smart growth/shrink behaviour when resizing.
2636keys. This should keep the window corner which is closest to a corner of 2485This should keep the window corner which is closest to a corner of
2637the screen in a fixed position. 2486the screen in a fixed position.
2638 2487
2488=item --enable-text-blink (default: on)
2489
2490Add support for blinking text.
2491
2639=item --enable-pointer-blank (default: on) 2492=item --enable-pointer-blank (default: on)
2640 2493
2641Add support to have the pointer disappear when typing or inactive. 2494Add support to have the pointer disappear when typing or inactive.
2642 2495
2643=item --enable-perl (default: off) 2496=item --enable-perl (default: on)
2644 2497
2645Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2498Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2646manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2499manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2647in F<src/perl-ext/> for the extensions that are installed by default. The 2500files in F<src/perl-ext/> for the extensions that are installed by
2648perl interpreter that is used can be specified via the C<PERL> environment 2501default. The perl interpreter that is used can be specified via the
2649variable when running configure. 2502C<PERL> environment variable when running configure. Even when compiled
2503in, perl will I<not> be initialised when all extensions have been disabled
2504C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2505resource standpoint.
2506
2507=item --with-afterimage-config=DIR
2508
2509Look for the libAfterImage config script in DIR.
2650 2510
2651=item --with-name=NAME (default: urxvt) 2511=item --with-name=NAME (default: urxvt)
2652 2512
2653Set the basename for the installed binaries, resulting 2513Set the basename for the installed binaries, resulting
2654in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2514in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2664PATH. 2524PATH.
2665 2525
2666=item --with-x 2526=item --with-x
2667 2527
2668Use the X Window System (pretty much default, eh?). 2528Use the X Window System (pretty much default, eh?).
2669
2670=item --with-xpm-includes=DIR
2671
2672Look for the XPM includes in DIR.
2673
2674=item --with-xpm-library=DIR
2675
2676Look for the XPM library in DIR.
2677
2678=item --with-xpm
2679
2680Not needed - define via --enable-xpm-background.
2681 2529
2682=back 2530=back
2683 2531
2684=head1 AUTHORS 2532=head1 AUTHORS
2685 2533

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines