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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.12 by root, Mon Aug 16 02:09:28 2004 UTC vs.
Revision 1.35 by root, Wed Dec 15 00:53:23 2004 UTC

11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal 11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16
17=head1 FREQUENTLY ASKED QUESTIONS
18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently
20asked questions and answer to them and some common problems.
16 21
17=head1 RXVT-UNICODE VS. RXVT 22=head1 RXVT-UNICODE VS. RXVT
18 23
19Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20internally. That means it can store and display most scripts in the 25internally. That means it can store and display most scripts in the
24like tibetan or devenagari. Don't expect pretty output when using these 29like tibetan or devenagari. Don't expect pretty output when using these
25scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 30scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26fine, though. A somewhat difficult case are left-to-right scripts, such 31fine, though. A somewhat difficult case are left-to-right scripts, such
27as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 32as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28belong into the application, not the terminal emulator (too many things -- 33belong into the application, not the terminal emulator (too many things --
29such as cursor-movement while editing -- break othwerwise), but that might 34such as cursor-movement while editing -- break otherwise), but that might
30change. 35change.
31 36
32If you are looking for a terminal that supports more exotic scripts, let 37If you are looking for a terminal that supports more exotic scripts, let
33me recommend C<mlterm>, which is a very userfriendly, lean and clean 38me recommend C<mlterm>, which is a very userfriendly, lean and clean
34terminal emulator. In fact, the reason rxvt-unicode was born was solely 39terminal emulator. In fact, the reason rxvt-unicode was born was solely
53drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 58drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54@@RXVT_NAME@@c(1) (client). 59@@RXVT_NAME@@c(1) (client).
55 60
56It also makes technical information about escape sequences (which have 61It also makes technical information about escape sequences (which have
57been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 62been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
58reference documentation (escape sequences etc.) and the FAQ section at the 63reference documentation (escape sequences etc.).
59end of this document.
60 64
61=head1 OPTIONS 65=head1 OPTIONS
62 66
63The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 67The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
64below. In keeping with the smaller-is-better philosophy, options may be 68below. In keeping with the smaller-is-better philosophy, options may be
150 154
151The mouse pointer background colour; resource B<pointerColor2>. 155The mouse pointer background colour; resource B<pointerColor2>.
152 156
153=item B<-bd> I<colour> 157=item B<-bd> I<colour>
154 158
155The colour of the border between the xterm scrollbar and the text; 159The colour of the border around the text area and between the scrollbar and the text;
156resource B<borderColor>. 160resource B<borderColor>.
157 161
158=item B<-fn> I<fontname> 162=item B<-fn> I<fontlist>
159 163
160Select the fonts to be used. This is a comma seperated list of font 164Select the fonts to be used. This is a comma separated list of font names
161names that are used in turn when trying to display Unicode characters. 165that are used in turn when trying to display Unicode characters. The
162The first font defines the cell size for characters; other fonts might 166first font defines the cell size for characters; other fonts might be
163be smaller, but not larger. A reasonable default font list is always 167smaller, but not (in general) larger. A (hopefully) reasonable default
164appended to it. resource B<font>. 168font list is always appended to it. See resource B<font> for more details.
169
170In short, to specify an X11 core font, just specify it's name or prefix it
171with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172e.g.:
173
174 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165 176
166See also the question "How does rxvt-unicode choose fonts?" in the FAQ 177See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167section. 178section of @@RXVT_NAME@@(7).
168 179
169=item B<-rb>|B<+rb> 180=item B<-fb> I<fontlist>
170 181
171Enable "real bold" support. When this option is on, bold text will be 182Compile font-styles: The bold font list to use when bold characters are to
172displayed using the first available bold font in the font list. Bold 183be printed. See resource B<boldFont> for details.
173fonts should thus be specified in the font list after their 184
174corresponding regular fonts. If no bold font can be found, a regular 185=item B<-fi> I<fontlist>
175font will be used. resource B<realBold>. 186
187Compile font-styles: The italic font list to use when bold characters are to
188be printed. See resource B<italicFont> for details.
189
190=item B<-fbi> I<fontlist>
191
192Compile font-styles: The bold italic font list to use when bold characters are to
193be printed. See resource B<boldItalicFont> for details.
176 194
177=item B<-name> I<name> 195=item B<-name> I<name>
178 196
179Specify the application name under which resources are to be obtained, 197Specify the application name under which resources are to be obtained,
180rather than the default executable file name. Name should not contain 198rather than the default executable file name. Name should not contain
220 238
221=item B<-st>|B<+st> 239=item B<-st>|B<+st>
222 240
223Display normal (non XTerm/NeXT) scrollbar without/with a trough; 241Display normal (non XTerm/NeXT) scrollbar without/with a trough;
224resource B<scrollBar_floating>. 242resource B<scrollBar_floating>.
243
244=item B<-ptab>|B<+ptab>
245
246If enabled (default), "Horizontal Tab" characters are being stored as
247actual wide characters in the screen buffer, which makes it possible to
248select and paste them. Since a horizontal tab is a cursor movement and
249not an actual glyph, this can sometimes be visually annoying as the cursor
250on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
225 251
226=item B<-bc>|B<+bc> 252=item B<-bc>|B<+bc>
227 253
228Blink the cursor; resource B<cursorBlink>. 254Blink the cursor; resource B<cursorBlink>.
229 255
389high-intensity (bold = bright foreground, blink = bright background) 415high-intensity (bold = bright foreground, blink = bright background)
390colours. The canonical names are as follows: 0=black, 1=red, 2=green, 416colours. The canonical names are as follows: 0=black, 1=red, 2=green,
3913=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 4173=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
392names used are listed in the B<COLORS AND GRAPHICS> section. 418names used are listed in the B<COLORS AND GRAPHICS> section.
393 419
420Colours higher than 15 cannot be set using resources (yet), but can be
421changed using an escape command (see @@RXVT_NAME@@(7)).
422
423Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
42488 colour support). Colours 80-87 are evenly spaces grey steps.
425
394=item B<colorBD:> I<colour> 426=item B<colorBD:> I<colour>
395 427
428=item B<colorIT:> I<colour>
429
396Use the specified colour to display bold characters when the foreground 430Use the specified colour to display bold or italic characters when the
397colour is the default. This option will be ignored if B<realBold> is 431foreground colour is the default. If font styles are not available
398enabled. 432(Compile styles) and this option is unset, reverse video is used instead.
399 433
400=item B<colorUL:> I<colour> 434=item B<colorUL:> I<colour>
401 435
402Use the specified colour to display underlined characters when the 436Use the specified colour to display underlined characters when the
403foreground colour is the default. 437foreground colour is the default.
404 438
405=item B<colorRV:> I<colour> 439=item B<colorRV:> I<colour>
406 440
407Use the specified colour as the background for reverse video 441Use the specified colour as the background for reverse video
408characters. 442characters.
443
444=item B<underlineColor:> I<colour>
445
446If set, use the specified colour as the colour for the underline
447itself. If unset, use the foreground colour.
409 448
410=item B<cursorColor:> I<colour> 449=item B<cursorColor:> I<colour>
411 450
412Use the specified colour for the cursor. The default is to use the 451Use the specified colour for the cursor. The default is to use the
413foreground colour; option B<-cr>. 452foreground colour; option B<-cr>.
447=item B<shading:> I<number> 486=item B<shading:> I<number>
448 487
449Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 488Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
450image in addition to tinting it. 489image in addition to tinting it.
451 490
452=item B<fading:> I<number>
453
454Scale the tint colour by the given percentage.
455
456=item B<scrollColor:> I<colour> 491=item B<scrollColor:> I<colour>
457 492
458Use the specified colour for the scrollbar [default #B2B2B2]. 493Use the specified colour for the scrollbar [default #B2B2B2].
459 494
460=item B<troughColor:> I<colour> 495=item B<troughColor:> I<colour>
461 496
462Use the specified colour for the scrollbar's trough area [default 497Use the specified colour for the scrollbar's trough area [default
463#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 498#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
499
500=item B<borderColor:> I<colour>
501
502The colour of the border around the text area and between the scrollbar
503and the text.
464 504
465=item B<backgroundPixmap:> I<file[;geom]> 505=item B<backgroundPixmap:> I<file[;geom]>
466 506
467Use the specified XPM file (note the `.xpm' extension is optional) for 507Use the specified XPM file (note the `.xpm' extension is optional) for
468the background and also optionally specify its scaling with a geometry 508the background and also optionally specify its scaling with a geometry
484 524
485Specify the colon-delimited search path for finding files (XPM and 525Specify the colon-delimited search path for finding files (XPM and
486menus), in addition to the paths specified by the B<RXVTPATH> and 526menus), in addition to the paths specified by the B<RXVTPATH> and
487B<PATH> environment variables. 527B<PATH> environment variables.
488 528
489=item B<font:> I<fontname> 529=item B<font:> I<fontlist>
490 530
491Select the fonts to be used. This is a comma seperated list of font 531Select the fonts to be used. This is a comma separated list of font
492names that are used in turn when trying to display Unicode characters. 532names that are used in turn when trying to display Unicode characters.
493The first font defines the cell size for characters; other fonts might 533The first font defines the cell size for characters; other fonts might
494be smaller, but not larger. A reasonable default font list is always 534be smaller, but not larger. A reasonable default font list is always
495appended to it. option B<-fn>. 535appended to it. option B<-fn>.
496 536
497=item B<realBold:> I<boolean> 537Each font can either be a standard X11 core font (XLFD) name, with
538optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.
498 539
499B<True>: Enable "real bold" support. When this option is on, bold text 540In addition, each font can be prefixed with additional hints and
500will be displayed using the first available bold font in the font list. 541specifications enclosed in square brackets (C<[]>). The only available
501Bold fonts should thus be specified in the font list after their 542hint currently is C<codeset=codeset-name>, and this is only used for Xft
502corresponding regular fonts. If no bold font can be found, a regular 543fonts.
503font will be used. option B<-rb>. B<False>: Display bold text in a 544
504regular font, using the color specified with B<colorBD>; option B<+rb>. 545For example, this font resource
546
547 URxvt*font: 9x15bold,\
548 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
549 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
550 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
551 xft:Code2000:antialias=false
552
553specifies five fonts to be used. The first one is C<9x15bold> (actually
554the iso8859-1 version of the second font), which is the base font (because
555it is named first) and thus defines the character cell grid to be 9 pixels
556wide and 15 pixels high.
557
558The second font is just used to add additional unicode characters not in
559the base font, likewise the third, which is unfortunately non-bold, but
560the bold version of the font does contain less characters, so this is a
561useful supplement.
562
563The third font is an Xft font with aliasing turned off, and the characters
564are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
565contains other characters, but we are not interested in them.
566
567The last font is a useful catch-all font that supplies most of the
568remaining unicode characters.
569
570=item B<boldFont:> I<fontlist>
571
572=item B<italicFont:> I<fontlist>
573
574=item B<boldItalicFont:> I<fontlist>
575
576The font list to use for displaying B<bold>, I<italic> or B<< I<bold
577italic> >> characters, respectively.
578
579If specified and non-empty, then the syntax is the same as for the
580B<font>-resource, and the given font list will be used as is, which makes
581it possible to substitute completely different font styles for bold and
582italic.
583
584If unset (the default), a suitable font list will be synthesized by
585"morphing" the normal text font list into the desired shape. If that is
586not possible, replacement fonts of the desired shape will be tried.
587
588If set, but empty, then this specific style is disabled and the normal
589text font will being used for the given style.
505 590
506=item B<selectstyle:> I<mode> 591=item B<selectstyle:> I<mode>
507 592
508Set mouse selection style to B<old> which is 2.20, B<oldword> which is 593Set mouse selection style to B<old> which is 2.20, B<oldword> which is
509xterm style with 2.20 old word selection, or anything else which gives 594xterm style with 2.20 old word selection, or anything else which gives
580B<False>: do not scroll to bottom when tty receives output; option 665B<False>: do not scroll to bottom when tty receives output; option
581B<+si>. 666B<+si>.
582 667
583=item B<scrollWithBuffer:> I<boolean> 668=item B<scrollWithBuffer:> I<boolean>
584 669
585B<True>: scroll with scrollback buffer when tty recieves new lines (and 670B<True>: scroll with scrollback buffer when tty receives new lines (and
586B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 671B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll
587with scrollback buffer when tty recieves new lines; option B<-sw>. 672with scrollback buffer when tty recieves new lines; option B<-sw>.
588 673
589=item B<scrollTtyKeypress:> I<boolean> 674=item B<scrollTtyKeypress:> I<boolean>
590 675
631=item B<mouseWheelScrollPage:> I<boolean> 716=item B<mouseWheelScrollPage:> I<boolean>
632 717
633B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 718B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
634scrolls five lines [default]. 719scrolls five lines [default].
635 720
721=item B<pastableTabs:> I<boolean>
722
723B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
724movement only; option C<-ptab>.
725
636=item B<cursorBlink:> I<boolean> 726=item B<cursorBlink:> I<boolean>
637 727
638B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 728B<True>: blink the cursor. B<False>: do not blink the cursor [default];
639option B<-bc>. 729option B<-bc>.
640 730
689The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 779The locale to use for opening the IM. You can use an LC_CTYPE of e.g.
690de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 780de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input
691extension to be able to input japanese characters while staying in 781extension to be able to input japanese characters while staying in
692another locale. option B<-imlocale>. 782another locale. option B<-imlocale>.
693 783
694=item B<insecure> 784=item B<insecure:> I<boolean>
695 785
696Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 786Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697echo arbitrary strings like the icon name or the locale. This could be 787echo arbitrary strings like the icon name or the locale. This could be
698abused if somebody gets 8-bit-clean access to your display, wether 788abused if somebody gets 8-bit-clean access to your display, whether
699throuh a mail client displaying mail bodies unfiltered or though 789throuh a mail client displaying mail bodies unfiltered or though
700write(1). Therefore, these sequences are disabled by default. (Note 790write(1). Therefore, these sequences are disabled by default. (Note
701that other terminals, including xterm, have these sequences 791that other terminals, including xterm, have these sequences
702enabled by default). You can enable them by setting this boolean 792enabled by default). You can enable them by setting this boolean
703resource or specifying B<-insecure> as an option. At the moment, this 793resource or specifying B<-insecure> as an option. At the moment, this
777Left click at the beginning of the region, drag to the end of the 867Left click at the beginning of the region, drag to the end of the
778region and release; Right click to extend the marked region; Left 868region and release; Right click to extend the marked region; Left
779double-click to select a word; Left triple-click to select the entire 869double-click to select a word; Left triple-click to select the entire
780line. 870line.
781 871
872Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873(Compile: frills) will create a rectangular selection instead of a normal
874one.
875
782=item B<Insertion>: 876=item B<Insertion>:
783 877
784Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 878Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
785an B<@@RXVT_NAME@@> window causes the current text selection to be 879an B<@@RXVT_NAME@@> window causes the current text selection to be
786inserted as if it had been typed on the keyboard. 880inserted as if it had been typed on the keyboard.
834Start by pressing C<Control> and C<Shift> together, then releasing 928Start by pressing C<Control> and C<Shift> together, then releasing
835them. The next special key (cursor keys, home etc.) you enter will not 929them. The next special key (cursor keys, home etc.) you enter will not
836invoke it's usual function but instead will insert the corresponding 930invoke it's usual function but instead will insert the corresponding
837keycap symbol. The symbol will only be entered when the key has been 931keycap symbol. The symbol will only be entered when the key has been
838released, otherwise pressing e.g. C<Shift> would enter the symbol for 932released, otherwise pressing e.g. C<Shift> would enter the symbol for
839C<ISO Level 2 Switch>, although your intention might have beenm to enter a 933C<ISO Level 2 Switch>, although your intention might have been to enter a
840reverse tab (Shift-Tab). 934reverse tab (Shift-Tab).
841 935
842=item 5.3: Screen-selection entry method 936=item 5.3: Screen-selection entry method
843 937
844While this is implemented already (it's basically the selection 938While this is implemented already (it's basically the selection
851 945
852You enter this mode by holding down C<Control> and C<Shift> together, then 946You enter this mode by holding down C<Control> and C<Shift> together, then
853pressing and holding the left mouse button and moving around. The unicode 947pressing and holding the left mouse button and moving around. The unicode
854hex code(s) (it might be a combining character) of the character under the 948hex code(s) (it might be a combining character) of the character under the
855pointer is displayed until you release C<Control> and C<Shift>. 949pointer is displayed until you release C<Control> and C<Shift>.
950
951In addition to the hex codes it will display the font used to draw this
952character - due to implementation reasons, characters combined with
953combining characters, line drawing characters and unknown characters will
954always be drawn using the built-in support font.
856 955
857=back 956=back
858 957
859With respect to conformance, rxvt-unicode is supposed to be compliant to 958With respect to conformance, rxvt-unicode is supposed to be compliant to
860both scenario A and B of ISO 14755, including part 5.2. 959both scenario A and B of ISO 14755, including part 5.2.
913would yield White on Black, while on I<xterm>(1) it would yield Black 1012would yield White on Black, while on I<xterm>(1) it would yield Black
914on White. 1013on White.
915 1014
916=back 1015=back
917 1016
918=head1 FREQUENTLY ASKED QUESTIONS (FAQ)
919
920=over 4
921
922=item How do I know which rxvt-unicode version I'm using?
923
924The version number is displayed with the usage (-h). For rxvt-unicode
925version 2.14 and later, the escape sequence C<ESC[8n> sets the window
926title to the version number.
927
928=item Rxvt-unicode does not seem to understand the selected encoding?
929
930=item Unicode does not seem to work?
931
932If you encounter strange problems like typing an accented character but
933getting two unrelated other characters or similar, or if program output is
934subtly garbled, then you should check your locale settings.
935
936Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
937programs. Often rxvt-unicode is started in the C<C> locale, while the
938login script running within the rxvt-unicode window changes the locale to
939sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
940
941The best thing is to fix your startup environment, as you will likely run
942into other problems. If nothing works you can try this in your .profile.
943
944 printf '\e]701;%s\007' "$LC_CTYPE"
945
946If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
947supported on your systems. Some systems have a C<locale> comamnd which
948displays this. If it displays sth. like:
949
950 locale: Cannot set LC_CTYPE to default locale: ...
951
952Then the locale you specified is not supported on your system.
953
954If nothing works and you are sure that everything is set correctly then
955you will need to remember a little known fact: Some programs just don't
956support locales :(
957
958=item Why do the characters look ugly?
959
960=item How does rxvt-unicode choose fonts?
961
962Most fonts do not contain the full range of Unicode, which is
963fine. Chances are that the font you (or the admin/package maintainer of
964your system/os) have specified does not cover all the characters you want
965to display.
966
967B<rxvt-unicode> makes a best-effort try at finding a replacement
968font. Often the result is fine, but sometimes the chosen font looks
969bad. In that case, select a font of your taste and add it to the font
970list, e.g.:
971
972 @@RXVT_NAME@@ -fn basefont,font2,font3...
973
974When rxvt-unicode sees a character, it will first look at the base
975font. If the base font does not contain the character, it will go to the
976next font, and so on.
977
978The only limitation is that all the fonts must not be larger than the base
979font, as the base font defines the principial cell size, which must be the
980same due to the way terminals work.
981
982=item Why do some chinese characters look so different than others?
983
984This is because there is a difference between script and language --
985rxvt-unicode does not know which language the text that is output
986is, as it only knows the unicode character codes. If rxvt-unicode
987first sees a japanese character, it might choose a japanese font for
988it. Subseqzuent japanese characters will take that font. Now, many chinese
989characters aren't represented in japanese fonts, so when the first
990non-japanese character comes up, rxvt-unicode will look for a chinese font
991-- unfortunately at this point, it will still use the japanese font for
992japanese characters that are also chinese.
993
994The workaround is easy: just tag a chinese font at the end of your font
995list (see the previous question). The key is to view the font list as
996a preference list: If you expect more japanese, list a japanese font
997first. If you expect more chinese, put a chinese font first.
998
999In the future it might be possible to switch preferences at runtime (the
1000internal data structure has no problem with using different fonts for
1001the same character at the same time, but no interface for this has been
1002designed yet).
1003
1004=item How does rxvt-unicode determine the encoding to use?
1005
1006=item Is there an option to switch encodings?
1007
1008Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1009specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
1010UTF-8 or any other encodings with respect to terminal I/O.
1011
1012The reasons is that there exists a perfectly fine mechanism for selecting
1013the encoding, doing I/O and (most important) communicating this to all
1014applications so everybody agrees on character properties such as width and
1015code number. This mechanism is the I<locale>.
1016
1017Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1018programs doing the same (that is, most) will automatically agree in the
1019interpretation of characters.
1020
1021Unfortunately, there is no system-independent way to select locales, nor
1022is there a standard on how locale specifiers will look like.
1023
1024On most systems, the content of the C<LC_CTYPE> environment variable
1025contains an arbitrary string which corresponds to an already-installed
1026locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1027C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1028(i.e. C<de> or C<german>) are also common.
1029
1030Rxvt-unicode ignores all other locale categories, and except for
1031the encoding, ignores country or language-specific settings,
1032i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
1033
1034If you want to use a specific encoding you have to make sure you start
1035rxvt-unicode with the correct C<LC_CTYPE> category.
1036
1037=item Can I switch locales at runtime?
1038
1039Yes, using an escape sequence. Try sth. like this, which sets
1040rxvt-unicode's idea of C<LC_CTYPE>.
1041
1042 printf '\e]701;%s\007' ja_JP.SJIS
1043
1044See also the previous question.
1045
1046Sometimes this capability is rather handy when you want to work in one
1047locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
1048example, I use this script to start C<xjdic>, which first switches to a
1049locale supported by xjdic and back later:
1050
1051 printf '\e]701;%s\007' ja_JP.SJIS
1052 xjdic -js
1053 printf '\e]701;%s\007' de_DE.UTF-8
1054
1055=item Can I switch the fonts at runtime?
1056
1057Yes, using an escape sequence. Try sth. like this, which has the same
1058effect as using the C<-fn> switch, and takes effect immediately:
1059
1060 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
1061
1062This is useful if you e.g. work primarily with japanese (and prefer a
1063japanese font), but you have to switch to chinese temporarily, where
1064japanese fonts would only be in your way.
1065
1066You can think of this as a kind of manual ISO-2022 switching.
1067
1068=item Mouse cut/paste suddenly no longer works.
1069
1070Make sure that mouse reporting is actually turned off since killing
1071some editors prematurely may leave the mouse in mouse report mode. I've
1072heard that tcsh may use mouse reporting unless it otherwise specified. A
1073quick check is to see if cut/paste works when the Alt or Shift keys are
1074depressed. See @@RXVT_NAME@@(7)
1075
1076=item What's with this bold/blink stuff?
1077
1078If no bold colour is set via C<colorBD:>, bold will invert text using the
1079standard foreground colour.
1080
1081For the standard background colour, blinking will actually make the
1082text blink when compiled with C<--enable-blinking>. with standard
1083colours. Without C<--enable-blinking>, the blink attribute will be
1084ignored.
1085
1086On ANSI colours, bold/blink attributes are used to set high-intensity
1087foreground/background colors.
1088
1089color0-7 are the low-intensity colors.
1090
1091color8-15 are the corresponding high-intensity colors.
1092
1093=item I don't like the screen colors. How do I change them?
1094
1095You can change the screen colors at run-time using F<~/.Xdefaults>
1096resources (or as long-options).
1097
1098Here are values that are supposed to resemble a VGA screen,
1099including the murky brown that passes for low-intensity yellow:
1100
1101 Rxvt*color0: #000000
1102 Rxvt*color1: #A80000
1103 Rxvt*color2: #00A800
1104 Rxvt*color3: #A8A800
1105 Rxvt*color4: #0000A8
1106 Rxvt*color5: #A800A8
1107 Rxvt*color6: #00A8A8
1108 Rxvt*color7: #A8A8A8
1109
1110 Rxvt*color8: #000054
1111 Rxvt*color9: #FF0054
1112 Rxvt*color10: #00FF54
1113 Rxvt*color11: #FFFF54
1114 Rxvt*color12: #0000FF
1115 Rxvt*color13: #FF00FF
1116 Rxvt*color14: #00FFFF
1117 Rxvt*color15: #FFFFFF
1118
1119=item What's with the strange Backspace/Delete key behaviour?
1120
1121Assuming that the physical Backspace key corresponds to the
1122BackSpace keysym (not likely for Linux ... see the following
1123question) there are two standard values that can be used for
1124Backspace: C<^H> and C<^?>.
1125
1126Historically, either value is correct, but rxvt-unicode adopts the debian
1127policy of using C<^?> when unsure, because it's the one only only correct
1128choice :).
1129
1130Rxvt-unicode tries to inherit the current stty settings and uses the value
1131of `erase' to guess the value for backspace. If rxvt-unicode wasn't
1132started from a terminal (say, from a menu or by remote shell), then the
1133system value of `erase', which corresponds to CERASE in <termios.h>, will
1134be used (which may not be the same as your stty setting).
1135
1136For starting a new rxvt-unicode:
1137
1138 # use Backspace = ^H
1139 $ stty erase ^H
1140 $ @@RXVT_NAME@@
1141
1142 # use Backspace = ^?
1143 $ stty erase ^?
1144 $ @@RXVT_NAME@@
1145
1146Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1147
1148For an existing rxvt-unicode:
1149
1150 # use Backspace = ^H
1151 $ stty erase ^H
1152 $ echo -n "^[[36h"
1153
1154 # use Backspace = ^?
1155 $ stty erase ^?
1156 $ echo -n "^[[36l"
1157
1158This helps satisfy some of the Backspace discrepancies that occur, but
1159if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1160properly reflects that.
1161
1162The Delete key is a another casualty of the ill-defined Backspace problem.
1163To avoid confusion between the Backspace and Delete keys, the Delete
1164key has been assigned an escape sequence to match the vt100 for Execute
1165(ESC[3~) and is in the supplied termcap/terminfo.
1166
1167Some other Backspace problems:
1168
1169some editors use termcap/terminfo,
1170some editors (vim I'm told) expect Backspace = ^H,
1171GNU Emacs (and Emacs-like editors) use ^H for help.
1172
1173Perhaps someday this will all be resolved in a consistent manner.
1174
1175=item I don't like the key-bindings. How do I change them?
1176
1177There are some compile-time selections available via configure. Unless
1178you have run "configure" with the C<--disable-resources> option you can
1179use the `keysym' resource to alter the keystrings associated with keysym
11800xFF00 - 0xFFFF (function, cursor keys, etc).
1181
1182Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1183
1184 !# ----- special uses ------:
1185 ! tn3270 login, remap function and arrow keys.
1186 tn3270*font: *clean-bold-*-*--15-*
1187
1188 ! keysym - used by rxvt only
1189 ! Delete - ^D
1190 tn3270*keysym.0xFFFF: \004
1191
1192 ! Home - ^A
1193 tn3270*keysym.0xFF50: \001
1194 ! Left - ^B
1195 tn3270*keysym.0xFF51: \002
1196 ! Up - ^P
1197 tn3270*keysym.0xFF52: \020
1198 ! Right - ^F
1199 tn3270*keysym.0xFF53: \006
1200 ! Down - ^N
1201 tn3270*keysym.0xFF54: \016
1202 ! End - ^E
1203 tn3270*keysym.0xFF57: \005
1204
1205 ! F1 - F12
1206 tn3270*keysym.0xFFBE: \e1
1207 tn3270*keysym.0xFFBF: \e2
1208 tn3270*keysym.0xFFC0: \e3
1209 tn3270*keysym.0xFFC1: \e4
1210 tn3270*keysym.0xFFC2: \e5
1211 tn3270*keysym.0xFFC3: \e6
1212 tn3270*keysym.0xFFC4: \e7
1213 tn3270*keysym.0xFFC5: \e8
1214 tn3270*keysym.0xFFC6: \e9
1215 tn3270*keysym.0xFFC7: \e0
1216 tn3270*keysym.0xFFC8: \e-
1217 tn3270*keysym.0xFFC9: \e=
1218
1219 ! map Prior/Next to F7/F8
1220 tn3270*keysym.0xFF55: \e7
1221 tn3270*keysym.0xFF56: \e8
1222
1223=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1224How do I make use of them? For example, the Sun Keyboard type 4
1225has the following mappings that rxvt-unicode doesn't recognize.
1226
1227 KP_Insert == Insert
1228 F22 == Print
1229 F27 == Home
1230 F29 == Prior
1231 F33 == End
1232 F35 == Next
1233
1234Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1235mappings, it is better to use `xmodmap' to remap the keys as required for
1236your particular machine.
1237
1238=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1239I need this to decide about setting colors etc.
1240
1241rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1242check and see if that is set. Note that several programs, JED, slrn,
1243Midnight Commander automatically check this variable to decide whether or
1244not to use color.
1245
1246=item How do I set the correct, full IP address for the DISPLAY variable?
1247
1248If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1249insecure mode then it is possible to use the following shell script
1250snippets to correctly set the display. If your version of rxvt-unicode
1251wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1252the COLORTERM variable can be used to distinguish rxvt-unicode from a
1253regular xterm.
1254
1255Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1256snippets:
1257
1258 # Bourne/Korn/POSIX family of shells:
1259 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1260 if [ ${TERM:-foo} = xterm ]; then
1261 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1262 echo -n '^[Z'
1263 read term_id
1264 stty icanon echo
1265 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1266 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1267 read DISPLAY # set it in our local shell
1268 fi
1269 fi
1270
1271=item How do I compile the manual pages for myself?
1272
1273You need to have a recent version of perl installed as F</usr/bin/perl>,
1274one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1275the doc subdirectory and enter C<make alldoc>.
1276
1277=back
1278
1279=head1 ENVIRONMENT 1017=head1 ENVIRONMENT
1280 1018
1281B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1019B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1282and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1020and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1283window id number of the B<@@RXVT_NAME@@> window and it also uses and 1021window id number of the B<@@RXVT_NAME@@> window and it also uses and

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines