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.4 by root, Thu Aug 12 22:23:29 2004 UTC vs.
Revision 1.25 by root, Mon Sep 6 06:20:40 2004 UTC

1=head1 NAME
2
3RXVT REFERENCE - FAQ, command sequences and other background information
4
5=head1 FREQUENTLY ASKED QUESTIONS
6
7=over 4
8
9=item How do I know which rxvt-unicode version I'm using?
10
11The version number is displayed with the usage (-h). Also the escape
12sequence C<ESC[8n> sets the window title to the version number.
13
14=item When I log-in to another system it tells me about missing terminfo data?
15
16The terminal description used by rxvt-unicode is not as widely available
17as that for xterm, or even rxvt (for which the same problem often arises).
18
19The correct solution for this problem is to install the terminfo, this can
20be done like this (with ncurses' infocmp):
21
22 REMOTE=remotesystem.domain
23 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
24
25... or by installing rxvt-unicode normally on the remote system,
26
27If you cannot or do not want to do this, then you can simply set
28C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29problems arising, which includes wrong keymapping, less and different
30colours and some refresh errors in fullscreen applications. It's a nice
31quick-and-dirty workaround for rare cases, though.
32
33If you always want to do this you can either recompile rxvt-unicode with
34the desired TERM value or use a resource to set it:
35
36 URxvt.termName: rxvt
37
38If you don't plan to use B<rxvt> (quite common...) you could also replace
39the rxvt terminfo file with the rxvt-unicode one.
40
41=item I need a termcap file entry.
42
43You could use rxvt's termcap entry with resonable results in many cases.
44You can also create a termcap entry by using terminfo's infocmp program
45like this:
46
47 infocmp -C rxvt-unicode
48
49OR you could this termcap entry:
50
51 rxvt-unicode|rxvt-unicode terminal (X Window System):\
52 :am:bw:eo:km:mi:ms:xn:xo:\
53 :co#80:it#8:li#24:\
54 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
55 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
56 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
57 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
58 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
59 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
60 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
61 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
62 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
63 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
64 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
65 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
66 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
67 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
68 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69 :vs=\E[?25h:
70
71=item How can I configure rxvt-unicode so that it looks similar to the original rxvt?
72
73Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode
74behave similar to the original rxvt:
75
76 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1
77 URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1
78
79=item Rxvt-unicode does not seem to understand the selected encoding?
80
81=item Unicode does not seem to work?
82
83If you encounter strange problems like typing an accented character but
84getting two unrelated other characters or similar, or if program output is
85subtly garbled, then you should check your locale settings.
86
87Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
88programs. Often rxvt-unicode is started in the C<C> locale, while the
89login script running within the rxvt-unicode window changes the locale to
90sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
91
92The best thing is to fix your startup environment, as you will likely run
93into other problems. If nothing works you can try this in your .profile.
94
95 printf '\e]701;%s\007' "$LC_CTYPE"
96
97If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
98supported on your systems. Some systems have a C<locale> command which
99displays this. If it displays sth. like:
100
101 locale: Cannot set LC_CTYPE to default locale: ...
102
103Then the locale you specified is not supported on your system.
104
105If nothing works and you are sure that everything is set correctly then
106you will need to remember a little known fact: Some programs just don't
107support locales :(
108
109=item Why do some characters look so much different than others?
110
111=item How does rxvt-unicode choose fonts?
112
113Most fonts do not contain the full range of Unicode, which is
114fine. Chances are that the font you (or the admin/package maintainer of
115your system/os) have specified does not cover all the characters you want
116to display.
117
118B<rxvt-unicode> makes a best-effort try at finding a replacement
119font. Often the result is fine, but sometimes the chosen font looks
120bad. Many fonts have totally strange characters that don't resemble the
121correct glyph at all, and rxvt-unicode lacks the artificial intelligence
122to detect that a specific glyph is wrong: it has to believe the font that
123the characters it contains indeed look correct.
124
125In that case, select a font of your taste and add it to the font list,
126e.g.:
127
128 @@RXVT_NAME@@ -fn basefont,font2,font3...
129
130When rxvt-unicode sees a character, it will first look at the base
131font. If the base font does not contain the character, it will go to the
132next font, and so on. Specifying your own fonts will also speed up this
133search and use less resources within rxvt-unicode and the X-server.
134
135The only limitation is that all the fonts must not be larger than the base
136font, as the base font defines the principal cell size, which must be the
137same due to the way terminals work.
138
139=item Why do some chinese characters look so different than others?
140
141This is because there is a difference between script and language --
142rxvt-unicode does not know which language the text that is output
143is, as it only knows the unicode character codes. If rxvt-unicode
144first sees a japanese character, it might choose a japanese font for
145it. Subsequent japanese characters will take that font. Now, many chinese
146characters aren't represented in japanese fonts, so when the first
147non-japanese character comes up, rxvt-unicode will look for a chinese font
148-- unfortunately at this point, it will still use the japanese font for
149japanese characters that are also chinese.
150
151The workaround is easy: just tag a chinese font at the end of your font
152list (see the previous question). The key is to view the font list as
153a preference list: If you expect more japanese, list a japanese font
154first. If you expect more chinese, put a chinese font first.
155
156In the future it might be possible to switch preferences at runtime (the
157internal data structure has no problem with using different fonts for
158the same character at the same time, but no interface for this has been
159designed yet).
160
161=item Why does rxvt-unicode sometimes leave pixel droppings?
162
163Most fonts were not designed for terminal use, which means that character
164size varies a lot. A font that is otherwise fine for terminal use might
165contain some characters that are simply too wide. Rxvt-unicode will avoid
166these characters. For characters that are just "a bit" too wide a special
167"careful" rendering mode is used that redraws adjacent characters.
168
169All of this requires that fonts do not lie about character sizes,
170however: Xft fonts often draw glyphs larger than their acclaimed bounding
171box, and rxvt-unicode has no way of detecting this (the correct way is to
172ask for the character bounding box, which unfortunately is wrong in these
173cases).
174
175It's not clear (to me at least), wether this is a bug in Xft, freetype, or
176the respective font. If you encounter this problem there is no way to work
177around this except by using a different font.
178
179All of this is not a problem when using X11 core fonts, as their bounding
180box data is correct.
181
182=item My Compose (Multi_key) key is no longer working.
183
184The most common causes for this are that either your locale is not set
185correctly, or you specified a B<preeditStyle> that is not supported by
186your input method. For example, if you specified B<OverTheSpot> and
187your input method (e.g. the default input method handling Compose keys)
188does not support this (for instance because it is not visual), then
189rxvt-unicode will continue without an input method.
190
191In this case either do not specify a B<preeditStyle> or specify more than
192one pre-edit style, such as B<OverTheSpot,Root,None>.
193
194=item How can I keep rxvt-unicode from using reverse video so much?
195
196First of all, make sure you are running with the right terminfo
197(C<urxvt>), which will get rid of most of these effects. Then make sure
198you have specified colours for italic and bold, as otherwise rxvt-unicode
199might use reverse video to simulate the effect:
200
201 URxvt*colorBD: white
202 URxvt*colorIT: green
203
204=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
205
206For some unexplainable reason, some programs (i.e. irssi) assume a very
207weird colour palette when confronted with a terminal with more than the
208standard 8 colours (rxvt-unicode supports 88). The right fix is, of
209course, to fix these programs not to assume non-ISO colours without very
210good reasons.
211
212In the meantime, you can either edit your C<urxvt> terminfo definition to
213only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
214but keep you from using other rxvt-unicode features.
215
216=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
217
218Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
219in your compile environment, or an implementation that implements it,
220wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
221B<wchar_t> is represented as unicode.
222
223As you might have guessed, FreeBSD does neither define this symobl nor
224does it support it. Instead, it uses it's own internal representation of
225B<wchar_t>. This is, of course, completely legal.
226
227However, C<__STDC_ISO_10646__> is the only sane way to support
228multi-language apps in an OS, as using a locale-dependent (and
229non-standardized) representation of B<wchar_t> makes it impossible to
230convert between B<wchar_t> (as used by X11 and your applications) and any
231other encoding without implementing OS-specific-wrappers for each and
232every locale. There simply are no APIs to convert B<wchar_t> into anything
233except the current locale encoding.
234
235Some applications (such as the formidable B<mlterm>) work around this
236by carrying their own replacement functions for character set handling
237with them, and either implementing OS-dependent hacks or doing multiple
238conversions (which is slow and unreliable in case the OS implements
239encodings slightly different than the terminal emulator).
240
241The rxvt-unicode author insists that the right way to fix this is in the
242system libraries once and for all, instead of forcing every app to carry
243complete replacements.
244
245=item How does rxvt-unicode determine the encoding to use?
246
247=item Is there an option to switch encodings?
248
249Unlike some other terminals, rxvt-unicode has no encoding switch, and no
250specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
251UTF-8 or any other encodings with respect to terminal I/O.
252
253The reasons is that there exists a perfectly fine mechanism for selecting
254the encoding, doing I/O and (most important) communicating this to all
255applications so everybody agrees on character properties such as width and
256code number. This mechanism is the I<locale>.
257
258Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
259programs doing the same (that is, most) will automatically agree in the
260interpretation of characters.
261
262Unfortunately, there is no system-independent way to select locales, nor
263is there a standard on how locale specifiers will look like.
264
265On most systems, the content of the C<LC_CTYPE> environment variable
266contains an arbitrary string which corresponds to an already-installed
267locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
268C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
269(i.e. C<de> or C<german>) are also common.
270
271Rxvt-unicode ignores all other locale categories, and except for
272the encoding, ignores country or language-specific settings,
273i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
274
275If you want to use a specific encoding you have to make sure you start
276rxvt-unicode with the correct C<LC_CTYPE> category.
277
278=item Can I switch locales at runtime?
279
280Yes, using an escape sequence. Try sth. like this, which sets
281rxvt-unicode's idea of C<LC_CTYPE>.
282
283 printf '\e]701;%s\007' ja_JP.SJIS
284
285See also the previous question.
286
287Sometimes this capability is rather handy when you want to work in one
288locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
289example, I use this script to start C<xjdic>, which first switches to a
290locale supported by xjdic and back later:
291
292 printf '\e]701;%s\007' ja_JP.SJIS
293 xjdic -js
294 printf '\e]701;%s\007' de_DE.UTF-8
295
296=item Can I switch the fonts at runtime?
297
298Yes, using an escape sequence. Try sth. like this, which has the same
299effect as using the C<-fn> switch, and takes effect immediately:
300
301 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
302
303This is useful if you e.g. work primarily with japanese (and prefer a
304japanese font), but you have to switch to chinese temporarily, where
305japanese fonts would only be in your way.
306
307You can think of this as a kind of manual ISO-2022 switching.
308
309=item Why do italic characters look as if clipped?
310
311Many fonts have difficulties with italic characters and hinting. For
312example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
313Mono> completely fails in it's italic face. A workaround is to enable
314freetype autohinting, i.e. like this:
315
316 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
317 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
318
319=item My input method wants <some encoding> but I want UTF-8, what can I do?
320
321You can specify separate locales for the input method and the rest of the
322terminal, using the resource C<imlocale>:
323
324 URxvt*imlocale: ja_JP.EUC-JP
325
326Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
327use your input method. Please note, however, that you will not be able to
328input characters outside C<EUC-JP> in a normal way then, as your input
329method limits you.
330
331=item Rxvt-unicode uses gobs of memory, how can I reduce that?
332
333Rxvt-unicode tries to obey the rule of not charging you for sth. you
334don't use. One thing you should try is to configure out all settings that
335you don't need, for example, Xft support is a resource hog by design,
336when used. Compiling it out ensures that no Xft font will be loaded
337accidentally when rxvt-unicode tries to find a font for your characters.
338
339Also, many people (me included) like large windows and even larger
340scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
3416 bytes per screen cell. For a 160x?? window this amounts to almost a
342kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
343use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
344rxvt-unicode then uses 8 bytes per screen cell.
345
346=item Can I speed up Xft rendering somehow?
347
348Yes, the most obvious way to speed it up is to avoid Xft entirely, as
349it is simply slow. If you still want Xft fonts you might try to disable
350antialiasing (by appending C<:antialiasing=false>), which saves lots of
351memory and also speeds up rendering considerably.
352
353=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
354
355Rxvt-unicode will use whatever you specify as a font. If it needs to
356fall back to it's default font search list it will prefer X11 core
357fonts, because they are small and fast, and then use Xft fonts. It has
358antialiasing disabled for most of them, because the author thinks they
359look best that way.
360
361If you want antialiasing, you have to specify the fonts manually.
362
363=item Mouse cut/paste suddenly no longer works.
364
365Make sure that mouse reporting is actually turned off since killing
366some editors prematurely may leave the mouse in mouse report mode. I've
367heard that tcsh may use mouse reporting unless it otherwise specified. A
368quick check is to see if cut/paste works when the Alt or Shift keys are
369depressed. See @@RXVT_NAME@@(7)
370
371=item What's with this bold/blink stuff?
372
373If no bold colour is set via C<colorBD:>, bold will invert text using the
374standard foreground colour.
375
376For the standard background colour, blinking will actually make the
377text blink when compiled with C<--enable-blinking>. with standard
378colours. Without C<--enable-blinking>, the blink attribute will be
379ignored.
380
381On ANSI colours, bold/blink attributes are used to set high-intensity
382foreground/background colors.
383
384color0-7 are the low-intensity colors.
385
386color8-15 are the corresponding high-intensity colors.
387
388=item I don't like the screen colors. How do I change them?
389
390You can change the screen colors at run-time using F<~/.Xdefaults>
391resources (or as long-options).
392
393Here are values that are supposed to resemble a VGA screen,
394including the murky brown that passes for low-intensity yellow:
395
396 Rxvt*color0: #000000
397 Rxvt*color1: #A80000
398 Rxvt*color2: #00A800
399 Rxvt*color3: #A8A800
400 Rxvt*color4: #0000A8
401 Rxvt*color5: #A800A8
402 Rxvt*color6: #00A8A8
403 Rxvt*color7: #A8A8A8
404
405 Rxvt*color8: #000054
406 Rxvt*color9: #FF0054
407 Rxvt*color10: #00FF54
408 Rxvt*color11: #FFFF54
409 Rxvt*color12: #0000FF
410 Rxvt*color13: #FF00FF
411 Rxvt*color14: #00FFFF
412 Rxvt*color15: #FFFFFF
413
414=item What's with the strange Backspace/Delete key behaviour?
415
416Assuming that the physical Backspace key corresponds to the
417BackSpace keysym (not likely for Linux ... see the following
418question) there are two standard values that can be used for
419Backspace: C<^H> and C<^?>.
420
421Historically, either value is correct, but rxvt-unicode adopts the debian
422policy of using C<^?> when unsure, because it's the one only only correct
423choice :).
424
425Rxvt-unicode tries to inherit the current stty settings and uses the value
426of `erase' to guess the value for backspace. If rxvt-unicode wasn't
427started from a terminal (say, from a menu or by remote shell), then the
428system value of `erase', which corresponds to CERASE in <termios.h>, will
429be used (which may not be the same as your stty setting).
430
431For starting a new rxvt-unicode:
432
433 # use Backspace = ^H
434 $ stty erase ^H
435 $ @@RXVT_NAME@@
436
437 # use Backspace = ^?
438 $ stty erase ^?
439 $ @@RXVT_NAME@@
440
441Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
442
443For an existing rxvt-unicode:
444
445 # use Backspace = ^H
446 $ stty erase ^H
447 $ echo -n "^[[36h"
448
449 # use Backspace = ^?
450 $ stty erase ^?
451 $ echo -n "^[[36l"
452
453This helps satisfy some of the Backspace discrepancies that occur, but
454if you use Backspace = C<^H>, make sure that the termcap/terminfo value
455properly reflects that.
456
457The Delete key is a another casualty of the ill-defined Backspace problem.
458To avoid confusion between the Backspace and Delete keys, the Delete
459key has been assigned an escape sequence to match the vt100 for Execute
460(ESC[3~) and is in the supplied termcap/terminfo.
461
462Some other Backspace problems:
463
464some editors use termcap/terminfo,
465some editors (vim I'm told) expect Backspace = ^H,
466GNU Emacs (and Emacs-like editors) use ^H for help.
467
468Perhaps someday this will all be resolved in a consistent manner.
469
470=item I don't like the key-bindings. How do I change them?
471
472There are some compile-time selections available via configure. Unless
473you have run "configure" with the C<--disable-resources> option you can
474use the `keysym' resource to alter the keystrings associated with keysym
4750xFF00 - 0xFFFF (function, cursor keys, etc).
476
477Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
478
479 !# ----- special uses ------:
480 ! tn3270 login, remap function and arrow keys.
481 tn3270*font: *clean-bold-*-*--15-*
482
483 ! keysym - used by rxvt only
484 ! Delete - ^D
485 tn3270*keysym.0xFFFF: \004
486
487 ! Home - ^A
488 tn3270*keysym.0xFF50: \001
489 ! Left - ^B
490 tn3270*keysym.0xFF51: \002
491 ! Up - ^P
492 tn3270*keysym.0xFF52: \020
493 ! Right - ^F
494 tn3270*keysym.0xFF53: \006
495 ! Down - ^N
496 tn3270*keysym.0xFF54: \016
497 ! End - ^E
498 tn3270*keysym.0xFF57: \005
499
500 ! F1 - F12
501 tn3270*keysym.0xFFBE: \e1
502 tn3270*keysym.0xFFBF: \e2
503 tn3270*keysym.0xFFC0: \e3
504 tn3270*keysym.0xFFC1: \e4
505 tn3270*keysym.0xFFC2: \e5
506 tn3270*keysym.0xFFC3: \e6
507 tn3270*keysym.0xFFC4: \e7
508 tn3270*keysym.0xFFC5: \e8
509 tn3270*keysym.0xFFC6: \e9
510 tn3270*keysym.0xFFC7: \e0
511 tn3270*keysym.0xFFC8: \e-
512 tn3270*keysym.0xFFC9: \e=
513
514 ! map Prior/Next to F7/F8
515 tn3270*keysym.0xFF55: \e7
516 tn3270*keysym.0xFF56: \e8
517
518=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
519How do I make use of them? For example, the Sun Keyboard type 4
520has the following mappings that rxvt-unicode doesn't recognize.
521
522 KP_Insert == Insert
523 F22 == Print
524 F27 == Home
525 F29 == Prior
526 F33 == End
527 F35 == Next
528
529Rather than have rxvt-unicode try to accommodate all the various possible keyboard
530mappings, it is better to use `xmodmap' to remap the keys as required for
531your particular machine.
532
533=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
534I need this to decide about setting colors etc.
535
536rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
537check and see if that is set. Note that several programs, JED, slrn,
538Midnight Commander automatically check this variable to decide whether or
539not to use color.
540
541=item How do I set the correct, full IP address for the DISPLAY variable?
542
543If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
544insecure mode then it is possible to use the following shell script
545snippets to correctly set the display. If your version of rxvt-unicode
546wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
547the COLORTERM variable can be used to distinguish rxvt-unicode from a
548regular xterm.
549
550Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
551snippets:
552
553 # Bourne/Korn/POSIX family of shells:
554 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
555 if [ ${TERM:-foo} = xterm ]; then
556 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
557 echo -n '^[Z'
558 read term_id
559 stty icanon echo
560 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
561 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
562 read DISPLAY # set it in our local shell
563 fi
564 fi
565
566=item How do I compile the manual pages for myself?
567
568You need to have a recent version of perl installed as F</usr/bin/perl>,
569one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
570the doc subdirectory and enter C<make alldoc>.
571
572=back
573
574=head1 SYNOPSIS
575
576 # set a new font set
577 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
578
579 # change the locale and tell rxvt-unicode about it
580 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
581
582 # set window title
583 printf '\33]2;%s\007' "new window title"
584
585=head1 DESCRIPTION
586
587The rest of this document describes various technical aspects of
588B<rxvt-unicode>. First the description of supported command sequences,
589followed by menu and pixmap support and last by a description of all
590features selectable at C<configure> time.
591
1=head1 RXVT TECHNICAL REFERENCE 592=head1 RXVT TECHNICAL REFERENCE
2 593
3=head1 Definitions 594=head1 Definitions
4 595
5=over 4 596=over 4
149 740
150=item B<< C<ESC o> >> 741=item B<< C<ESC o> >>
151 742
152Invoke the G3 Character Set (LS3) 743Invoke the G3 Character Set (LS3)
153 744
154=item B<< C<ESC>(C<C> >> 745=item B<< C<ESC> ( C> >>
155 746
156Designate G0 Character Set (ISO 2022), see below for values of C<C>. 747Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157 748
158=item B<< C<ESC>)C<C> >> 749=item B<< C<ESC> ) C> >>
159 750
160Designate G1 Character Set (ISO 2022), see below for values of C<C>. 751Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161 752
162=item B<< C<ESC * C> >> 753=item B<< C<ESC * C> >>
163 754
187 778
188=back 779=back
189 780
190X<CSI> 781X<CSI>
191 782
192=head1 CSI (Code Sequence Introducer) Sequences 783=head1 CSI (Command Sequence Introducer) Sequences
193 784
194=over 4 785=over 4
195 786
196=item B<< C<ESC [ Ps @> >> 787=item B<< C<ESC [ Ps @> >>
197 788
330 B<< C<Ps = 0> >> Clear Current Column (default) 921 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC) 922 B<< C<Ps = 3> >> Clear All (TBC)
332 923
333=end table 924=end table
334 925
926=item B<< C<ESC [ Pm h> >>
927
928Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
929
335=item B<< C<ESC [ Ps i> >> 930=item B<< C<ESC [ Ps i> >>
336 931
337Printing 932Printing. See also the C<print-pipe> resource.
338 933
339=begin table 934=begin table
340 935
936 B<< C<Ps = 0> >> print screen (MC0)
341 B<< C<Ps = 4> >> disable transparent print mode (MC4) 937 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 938 B<< C<Ps = 5> >> enable transparent print mode (MC5)
343 939
344=end table 940=end table
345
346=item B<< C<ESC [ Pm h> >>
347
348Set Mode (SM). See next sequence for description of C<Pm>.
349 941
350=item B<< C<ESC [ Pm l> >> 942=item B<< C<ESC [ Pm l> >>
351 943
352Reset Mode (RM) 944Reset Mode (RM)
353 945
360 B<< C<h> >> Insert Mode (SMIR) 952 B<< C<h> >> Insert Mode (SMIR)
361 B<< C<l> >> Replace Mode (RMIR) 953 B<< C<l> >> Replace Mode (RMIR)
362 954
363=end table 955=end table
364 956
365=item B<< C<Ps = 20> >> I<unimplemented> 957=item B<< C<Ps = 20> >> (partially implemented)
366 958
367=begin table 959=begin table
368 960
369 B<< C<h> >> Automatic Newline (LNM) 961 B<< C<h> >> Automatic Newline (LNM)
370 B<< C<h> >> Normal Linefeed (LNM) 962 B<< C<l> >> Normal Linefeed (LNM)
371 963
372=end table 964=end table
373 965
374=back 966=back
375 967
378Character Attributes (SGR) 970Character Attributes (SGR)
379 971
380=begin table 972=begin table
381 973
382 B<< C<Ps = 0> >> Normal (default) 974 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 975 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
976 B<< C<Ps = 3 / 23> >> On / Off Italic
384 B<< C<Ps = 4 / 24> >> On / Off Underline 977 B<< C<Ps = 4 / 24> >> On / Off Underline
385 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 978 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
979 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
386 B<< C<Ps = 7 / 27> >> On / Off Inverse 980 B<< C<Ps = 7 / 27> >> On / Off Inverse
981 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
387 B<< C<Ps = 30 / 40> >> fg/bg Black 982 B<< C<Ps = 30 / 40> >> fg/bg Black
388 B<< C<Ps = 31 / 41> >> fg/bg Red 983 B<< C<Ps = 31 / 41> >> fg/bg Red
389 B<< C<Ps = 32 / 42> >> fg/bg Green 984 B<< C<Ps = 32 / 42> >> fg/bg Green
390 B<< C<Ps = 33 / 43> >> fg/bg Yellow 985 B<< C<Ps = 33 / 43> >> fg/bg Yellow
391 B<< C<Ps = 34 / 44> >> fg/bg Blue 986 B<< C<Ps = 34 / 44> >> fg/bg Blue
392 B<< C<Ps = 35 / 45> >> fg/bg Magenta 987 B<< C<Ps = 35 / 45> >> fg/bg Magenta
393 B<< C<Ps = 36 / 46> >> fg/bg Cyan 988 B<< C<Ps = 36 / 46> >> fg/bg Cyan
989 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
394 B<< C<Ps = 37 / 47> >> fg/bg White 990 B<< C<Ps = 37 / 47> >> fg/bg White
395 B<< C<Ps = 39 / 49> >> fg/bg Default 991 B<< C<Ps = 39 / 49> >> fg/bg Default
992 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
993 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
994 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
995 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
996 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
997 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
998 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
999 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1000 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
396 1001
397=end table 1002=end table
398 1003
399=item B<< C<ESC [ Ps n> >> 1004=item B<< C<ESC [ Ps n> >>
400 1005
535 B<< C<h> >> Send Mouse X & Y on button press. 1140 B<< C<h> >> Send Mouse X & Y on button press.
536 B<< C<l> >> No mouse reporting. 1141 B<< C<l> >> No mouse reporting.
537 1142
538=end table 1143=end table
539 1144
540X<Priv10>
541
542=item B<< C<Ps = 10> >> (B<rxvt>) 1145=item B<< C<Ps = 10> >> (B<rxvt>)
543 1146
544=begin table 1147=begin table
545 1148
546 B<< C<h> >> visible 1149 B<< C<h> >> menuBar visible
547 B<< C<l> >> invisible 1150 B<< C<l> >> menuBar invisible
548 1151
549=end table 1152=end table
550 1153
551=item B<< C<Ps = 25> >> 1154=item B<< C<Ps = 25> >>
552 1155
653 B<< C<h> >> Use Hilite Mouse Tracking. 1256 B<< C<h> >> Use Hilite Mouse Tracking.
654 B<< C<l> >> No mouse reporting. 1257 B<< C<l> >> No mouse reporting.
655 1258
656=end table 1259=end table
657 1260
658=item B<< C<Ps = 1010> >> 1261=item B<< C<Ps = 1010> >> (B<rxvt>)
659 1262
660=begin table 1263=begin table
661 1264
662 B<< C<h> >> Don't scroll to bottom on TTY output 1265 B<< C<h> >> Don't scroll to bottom on TTY output
663 B<< C<l> >> Scroll to bottom on TTY output 1266 B<< C<l> >> Scroll to bottom on TTY output
664 1267
665=end table 1268=end table
666 1269
667=item B<< C<Ps = 1011> >> 1270=item B<< C<Ps = 1011> >> (B<rxvt>)
668 1271
669=begin table 1272=begin table
670 1273
671 B<< C<h> >> Scroll to bottom when a key is pressed 1274 B<< C<h> >> Scroll to bottom when a key is pressed
672 B<< C<l> >> Don't scroll to bottom when a key is pressed 1275 B<< C<l> >> Don't scroll to bottom when a key is pressed
686 1289
687=begin table 1290=begin table
688 1291
689 B<< C<h> >> Save cursor position 1292 B<< C<h> >> Save cursor position
690 B<< C<l> >> Restore cursor position 1293 B<< C<l> >> Restore cursor position
1294
1295=end table
1296
1297=item B<< C<Ps = 1049> >>
1298
1299=begin table
1300
1301 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1302 B<< C<l> >> Use Normal Screen Buffer
691 1303
692=end table 1304=end table
693 1305
694=back 1306=back
695 1307
726 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1338 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
727 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1339 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>
728 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> >> 1340 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> >>
729 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1341 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
730 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) 1342 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension)
731 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension)
732 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension) 1343 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
1344 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1345 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>
1346 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1347 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
1348 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
1349 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
733 1350
734=end table 1351=end table
735 1352
736=back 1353=back
737 1354
1390 XK_KP_8 8 ESC O x 2007 XK_KP_8 8 ESC O x
1391 XK_KP_9 9 ESC O y 2008 XK_KP_9 9 ESC O y
1392 2009
1393=end table 2010=end table
1394 2011
2012=head1 CONFIGURE OPTIONS
2013
2014General hint: if you get compile errors, then likely your configuration
2015hasn't been tested well. Either try with --enable-everything or use the
2016./reconf script as a base for experiments. ./reconf is used by myself,
2017so it should generally be a working config. Of course, you should always
2018report when a combination doesn't work, so it can be fixed. Marc Lehmann
2019<rxvt@schmorp.de>.
2020
2021=over 4
2022
2023=item --enable-everything
2024
2025Add support for all non-multichoice options listed in "./configure
2026--help". Note that unlike other enable options this is order dependant.
2027You can specify this and then disable options which this enables by
2028I<following> this with the appropriate commands.
2029
2030=item --enable-xft
2031
2032Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2033slower and require lots of memory, but as long as you don't use them, you
2034don't pay for them.
2035
2036=item --enable-font-styles
2037
2038Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2039styles. The fonts can be set manually or automatically.
2040
2041=item --with-codesets=NAME,...
2042
2043Compile in support for additional codeset (encoding) groups (eu, vn are
2044always compiled in, which includes most 8-bit character sets). These
2045codeset tables are currently only used for driving X11 core fonts, they
2046are not required for Xft fonts. Compiling them in will make your binary
2047bigger (together about 700kB), but it doesn't increase memory usage unless
2048you use an X11 font requiring one of these encodings.
2049
2050=begin table
2051
2052 all all available codeset groups
2053 cn common chinese encodings
2054 cn_ext rarely used but very big chinese encodigs
2055 jp common japanese encodings
2056 jp_ext rarely used but big japanese encodings
2057 kr korean encodings
2058
2059=end table
2060
2061=item --enable-xim
2062
2063Add support for XIM (X Input Method) protocol. This allows using
2064alternative input methods (e.g. kinput2) and will also correctly
2065set up the input for people using dead keys or compose keys.
2066
2067=item --enable-unicode3
2068
2069Enable direct support for displaying unicode codepoints above
207065535 (the basic multilingual page). This increases storage
2071requirements per character from 2 to 4 bytes. X11 fonts do not yet
2072support these extra characters, but Xft does.
2073
2074Please note that rxvt-unicode can store unicode code points >65535
2075even without this flag, but the number of such characters is
2076limited to a view thousand (shared with combining characters,
2077see next switch), and right now rxvt-unicode cannot display them
2078(input/output and cut&paste still work, though).
2079
2080=item --enable-combining
2081
2082Enable automatic composition of combining characters into
2083composite characters. This is required for proper viewing of text
2084where accents are encoded as seperate unicode characters. This is
2085done by using precomposited characters when available or creating
2086new pseudo-characters when no precomposed form exists.
2087
2088Without --enable-unicode3, the number of additional precomposed
2089characters is rather limited (2048, if this is full, rxvt will use the
2090private use area, extending the number of combinations to 8448). With
2091--enable-unicode3, no practical limit exists. This will also enable
2092storage of characters >65535.
2093
2094The combining table also contains entries for arabic presentation forms,
2095but these are not currently used. Bug me if you want these to be used.
2096
2097=item --enable-fallback(=CLASS)
2098
2099When reading resource settings, also read settings for class CLASS
2100(default: Rxvt). To disable resource fallback use --disable-fallback.
2101
2102=item --with-res-name=NAME
2103
2104Use the given name (default: urxvt) as default application name when
2105reading resources. Specify --with-res-name=rxvt to replace rxvt.
2106
2107=item --with-res-class=CLASS
2108
2109Use the given class (default: URxvt) as default application class
2110when reading resources. Specify --with-res-class=Rxvt to replace
2111rxvt.
2112
2113=item --enable-utmp
2114
2115Write user and tty to utmp file (used by programs like F<w>) at
2116start of rxvt execution and delete information when rxvt exits.
2117
2118=item --enable-wtmp
2119
2120Write user and tty to wtmp file (used by programs like F<last>) at
2121start of rxvt execution and write logout when rxvt exits. This
2122option requires --enable-utmp to also be specified.
2123
2124=item --enable-lastlog
2125
2126Write user and tty to lastlog file (used by programs like
2127F<lastlogin>) at start of rxvt execution. This option requires
2128--enable-utmp to also be specified.
2129
2130=item --enable-xpm-background
2131
2132Add support for XPM background pixmaps.
2133
2134=item --enable-transparency
2135
2136Add support for inheriting parent backgrounds thus giving a fake
2137transparency to the term.
2138
2139=item --enable-fading
2140
2141Add support for fading the text when focus is lost.
2142
2143=item --enable-tinting
2144
2145Add support for tinting of transparent backgrounds.
2146
2147=item --enable-menubar
2148
2149Add support for our menu bar system (this interacts badly with
2150dynamic locale switching currently).
2151
2152=item --enable-rxvt-scroll
2153
2154Add support for the original rxvt scrollbar.
2155
2156=item --enable-next-scroll
2157
2158Add support for a NeXT-like scrollbar.
2159
2160=item --enable-xterm-scroll
2161
2162Add support for an Xterm-like scrollbar.
2163
2164=item --enable-plain-scroll
2165
2166Add support for a very unobtrusive, plain-looking scrollbar that
2167is the favourite of the rxvt-unicode author, having used it for
2168many years.
2169
2170=item --enable-half-shadow
2171
2172Make shadows on the scrollbar only half the normal width & height.
2173only applicable to rxvt scrollbars.
2174
2175=item --enable-ttygid
2176
2177Change tty device setting to group "tty" - only use this if
2178your system uses this type of security.
2179
2180=item --disable-backspace-key
2181
2182Disable any handling of the backspace key by us - let the X server
2183do it.
2184
2185=item --disable-delete-key
2186
2187Disable any handling of the delete key by us - let the X server
2188do it.
2189
2190=item --disable-resources
2191
2192Remove all resources checking.
2193
2194=item --enable-xgetdefault
2195
2196Make resources checking via XGetDefault() instead of our small
2197version which only checks ~/.Xdefaults, or if that doesn't exist
2198then ~/.Xresources.
2199
2200=item --enable-strings
2201
2202Add support for our possibly faster memset() function and other
2203various routines, overriding your system's versions which may
2204have been hand-crafted in assembly or may require extra libraries
2205to link in. (this breaks ANSI-C rules and has problems on many
2206GNU/Linux systems).
2207
2208=item --disable-swapscreen
2209
2210Remove support for swap screen.
2211
2212=item --enable-frills
2213
2214Add support for many small features that are not essential but nice to
2215have. Normally you want this, but for very small binaries you may want to
2216disable this.
2217
2218=item --enable-iso14755
2219
2220Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2221F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2222C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2223this switch.
2224
2225=item --enable-linespace
2226
2227Add support to provide user specified line spacing between text rows.
2228
2229=item --enable-keepscrolling
2230
2231Add support for continual scrolling of the display when you hold
2232the mouse button down on a scrollbar arrow.
2233
2234=item --enable-mousewheel
2235
2236Add support for scrolling via mouse wheel or buttons 4 & 5.
2237
2238=item --enable-slipwheeling
2239
2240Add support for continual scrolling (using the mouse wheel as an
2241accelerator) while the control key is held down. This option
2242requires --enable-mousewheel to also be specified.
2243
2244=item --disable-new-selection
2245
2246Remove support for mouse selection style like that of xterm.
2247
2248=item --enable-dmalloc
2249
2250Use Gray Watson's malloc - which is good for debugging See
2251http://www.letters.com/dmalloc/ for details If you use either this or the
2252next option, you may need to edit src/Makefile after compiling to point
2253DINCLUDE and DLIB to the right places.
2254
2255You can only use either this option and the following (should
2256you use either) .
2257
2258=item --enable-dlmalloc
2259
2260Use Doug Lea's malloc - which is good for a production version
2261See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2262
2263=item --enable-smart-resize
2264
2265Add smart growth/shrink behaviour when changing font size via from hot
2266keys. This should keep in a fixed position the rxvt corner which is
2267closest to a corner of the screen.
2268
2269=item --enable-cursor-blink
2270
2271Add support for a blinking cursor.
2272
2273=item --enable-pointer-blank
2274
2275Add support to have the pointer disappear when typing or inactive.
2276
2277=item --with-name=NAME
2278
2279Set the basename for the installed binaries (default: urxvt, resulting in
2280urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt.
2281
2282=item --with-term=NAME
2283
2284Change the environmental variable for the terminal to NAME (default
2285"rxvt")
2286
2287=item --with-terminfo=PATH
2288
2289Change the environmental variable for the path to the terminfo tree to
2290PATH.
2291
2292=item --with-x
2293
2294Use the X Window System (pretty much default, eh?).
2295
2296=item --with-xpm-includes=DIR
2297
2298Look for the XPM includes in DIR.
2299
2300=item --with-xpm-library=DIR
2301
2302Look for the XPM library in DIR.
2303
2304=item --with-xpm
2305
2306Not needed - define via --enable-xpm-background.
2307
2308=back
2309
1395=head1 AUTHORS 2310=head1 AUTHORS
1396 2311
1397Marc Lehmann <rxvt@schmorp.de>, converted this document to pod and 2312Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1398reworked it from the original Rxvt documentation, which was done by Geoff 2313reworked it from the original Rxvt documentation, which was done by Geoff
1399Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other 2314Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
1400sources. 2315sources.
1401 2316

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines