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.22 by root, Tue Aug 24 15:46:27 2004 UTC

150 150
151The mouse pointer background colour; resource B<pointerColor2>. 151The mouse pointer background colour; resource B<pointerColor2>.
152 152
153=item B<-bd> I<colour> 153=item B<-bd> I<colour>
154 154
155The colour of the border between the xterm scrollbar and the text; 155The colour of the border around the text area and between the scrollbar and the text;
156resource B<borderColor>. 156resource B<borderColor>.
157 157
158=item B<-fn> I<fontname> 158=item B<-fn> I<fontlist>
159 159
160Select the fonts to be used. This is a comma seperated list of font 160Select 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. 161that are used in turn when trying to display Unicode characters. The
162The first font defines the cell size for characters; other fonts might 162first font defines the cell size for characters; other fonts might be
163be smaller, but not larger. A reasonable default font list is always 163smaller, but not (in general) larger. A reasonable default font list is
164appended to it. resource B<font>. 164always appended to it. See resource B<font> for details.
165 165
166See also the question "How does rxvt-unicode choose fonts?" in the FAQ 166See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167section. 167section.
168 168
169=item B<-rb>|B<+rb> 169=item B<-fb> I<fontlist>
170 170
171Enable "real bold" support. When this option is on, bold text will be 171Compile 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 172be printed. See resource B<boldFont> for details.
173fonts should thus be specified in the font list after their 173
174corresponding regular fonts. If no bold font can be found, a regular 174=item B<-fi> I<fontlist>
175font will be used. resource B<realBold>. 175
176Compile font-styles: The italic font list to use when bold characters are to
177be printed. See resource B<italicFont> for details.
178
179=item B<-fbi> I<fontlist>
180
181Compile font-styles: The bold italic font list to use when bold characters are to
182be printed. See resource B<boldItalicFont> for details.
176 183
177=item B<-name> I<name> 184=item B<-name> I<name>
178 185
179Specify the application name under which resources are to be obtained, 186Specify the application name under which resources are to be obtained,
180rather than the default executable file name. Name should not contain 187rather than the default executable file name. Name should not contain
389high-intensity (bold = bright foreground, blink = bright background) 396high-intensity (bold = bright foreground, blink = bright background)
390colours. The canonical names are as follows: 0=black, 1=red, 2=green, 397colours. 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 3983=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
392names used are listed in the B<COLORS AND GRAPHICS> section. 399names used are listed in the B<COLORS AND GRAPHICS> section.
393 400
401Colours higher than 15 cannot be set using resources (yet), but can be
402changed using an escape command (see @@RXVT_NAME@@(7)).
403
404Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
40588 colour support). Colours 80-87 are evenly spaces grey steps.
406
394=item B<colorBD:> I<colour> 407=item B<colorBD:> I<colour>
395 408
409=item B<colorIT:> I<colour>
410
396Use the specified colour to display bold characters when the foreground 411Use the specified colour to display bold or italic characters when the
397colour is the default. This option will be ignored if B<realBold> is 412foreground colour is the default. If font styles are not available
398enabled. 413(Compile styles) and this option is unset, reverse video is used instead.
399 414
400=item B<colorUL:> I<colour> 415=item B<colorUL:> I<colour>
401 416
402Use the specified colour to display underlined characters when the 417Use the specified colour to display underlined characters when the
403foreground colour is the default. 418foreground colour is the default.
459 474
460=item B<troughColor:> I<colour> 475=item B<troughColor:> I<colour>
461 476
462Use the specified colour for the scrollbar's trough area [default 477Use the specified colour for the scrollbar's trough area [default
463#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 478#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
479
480=item B<borderColor:> I<colour>
481
482The colour of the border around the text area and between the scrollbar
483and the text.
464 484
465=item B<backgroundPixmap:> I<file[;geom]> 485=item B<backgroundPixmap:> I<file[;geom]>
466 486
467Use the specified XPM file (note the `.xpm' extension is optional) for 487Use the specified XPM file (note the `.xpm' extension is optional) for
468the background and also optionally specify its scaling with a geometry 488the background and also optionally specify its scaling with a geometry
484 504
485Specify the colon-delimited search path for finding files (XPM and 505Specify the colon-delimited search path for finding files (XPM and
486menus), in addition to the paths specified by the B<RXVTPATH> and 506menus), in addition to the paths specified by the B<RXVTPATH> and
487B<PATH> environment variables. 507B<PATH> environment variables.
488 508
489=item B<font:> I<fontname> 509=item B<font:> I<fontlist>
490 510
491Select the fonts to be used. This is a comma seperated list of font 511Select 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. 512names that are used in turn when trying to display Unicode characters.
493The first font defines the cell size for characters; other fonts might 513The first font defines the cell size for characters; other fonts might
494be smaller, but not larger. A reasonable default font list is always 514be smaller, but not larger. A reasonable default font list is always
495appended to it. option B<-fn>. 515appended to it. option B<-fn>.
496 516
497=item B<realBold:> I<boolean> 517Each font can either be a standard X11 core font (XLFD) name, with
518optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.
498 519
499B<True>: Enable "real bold" support. When this option is on, bold text 520In addition, each font can be prefixed with additional hints and
500will be displayed using the first available bold font in the font list. 521specifications enclosed in square brackets (C<[]>). The only available
501Bold fonts should thus be specified in the font list after their 522hint 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 523fonts.
503font will be used. option B<-rb>. B<False>: Display bold text in a 524
504regular font, using the color specified with B<colorBD>; option B<+rb>. 525For example, this font resource
526
527 URxvt*font: 9x15bold,\
528 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
529 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
530 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
531 xft:Code2000:antialias=false
532
533specifies five fonts to be used. The first one is C<9x15bold> (actually
534the iso8859-1 version of the second font), which is the base font (because
535it is named first) and thus defines the character cell grid to be 9 pixels
536wide and 15 pixels high.
537
538the second font is just used to add additional unicode characters not in
539the base font, likewise the third, which is unfortunately non-bold, but
540the bold version of the font does contain less characters, so this is a
541useful supplement.
542
543The third font is an Xft font with aliasing turned off, and the characters
544are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
545contains other characters, but we are not interested in them.
546
547The last font is a useful catch-all font that supplies most of the
548remaining unicode characters.
549
550=item B<boldFont:> I<fontlist>
551
552=item B<italicFont:> I<fontlist>
553
554=item B<boldItalicFont:> I<fontlist>
555
556The font list to use for displaying B<bold>, I<italic> or B<< I<bold
557italic> >> characters, respectively.
558
559If specified and non-empty, then the syntax is the same as for the
560B<font>-resource, and the given font list will be used as is, which makes
561it possible to substitute completely different font styles for bold and
562italic.
563
564If unset (the default), a suitable font list will be synthesized by
565"morphing" the normal text font list into the desired shape. If that is
566not possible, replacement fonts of the desired shape will be tried.
567
568If set, but empty, then this specific style is disabled and the normal
569text font will being used for the given style.
505 570
506=item B<selectstyle:> I<mode> 571=item B<selectstyle:> I<mode>
507 572
508Set mouse selection style to B<old> which is 2.20, B<oldword> which is 573Set 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 574xterm style with 2.20 old word selection, or anything else which gives
689The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 754The 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 755de_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 756extension to be able to input japanese characters while staying in
692another locale. option B<-imlocale>. 757another locale. option B<-imlocale>.
693 758
694=item B<insecure> 759=item B<insecure:> I<boolean>
695 760
696Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 761Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697echo arbitrary strings like the icon name or the locale. This could be 762echo arbitrary strings like the icon name or the locale. This could be
698abused if somebody gets 8-bit-clean access to your display, wether 763abused if somebody gets 8-bit-clean access to your display, wether
699throuh a mail client displaying mail bodies unfiltered or though 764throuh a mail client displaying mail bodies unfiltered or though
851 916
852You enter this mode by holding down C<Control> and C<Shift> together, then 917You 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 918pressing 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 919hex code(s) (it might be a combining character) of the character under the
855pointer is displayed until you release C<Control> and C<Shift>. 920pointer is displayed until you release C<Control> and C<Shift>.
921
922In addition to the hex codes it will display the font used to draw this
923character - due to implementation reasons, characters combined with
924combining characters, line drawing characters and unknown characters will
925always be drawn using the built-in support font.
856 926
857=back 927=back
858 928
859With respect to conformance, rxvt-unicode is supposed to be compliant to 929With respect to conformance, rxvt-unicode is supposed to be compliant to
860both scenario A and B of ISO 14755, including part 5.2. 930both scenario A and B of ISO 14755, including part 5.2.
919 989
920=over 4 990=over 4
921 991
922=item How do I know which rxvt-unicode version I'm using? 992=item How do I know which rxvt-unicode version I'm using?
923 993
924The version number is displayed with the usage (-h). For rxvt-unicode 994The version number is displayed with the usage (-h). Also the escape
925version 2.14 and later, the escape sequence C<ESC[8n> sets the window 995sequence C<ESC[8n> sets the window title to the version number.
926title to the version number. 996
997=item When I log-in to another system it tells me about missing terminfo data?
998
999The terminal description used by rxvt-unicode is not as widely available
1000as that for xterm, or even rxvt (for which the same problem often arises).
1001
1002The correct solution for this problem is to install the terminfo, this can be done
1003like this:
1004
1005 infocmp rxvt-unicode >rxvt.unicode.tic
1006 scp rxvt-unicode.tic remotesystem:
1007 ssh remotesystem tic rxvt-unicode.tic
1008
1009... or by installing rxvt-unicode normally on the remote system,
1010
1011If you cannot or do not want to do this, then you can simply set
1012C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
1013problems arising, which includes wrong keymapping, less and different
1014colours and some refresh errors in fullscreen applications. It's a nice
1015quick-and-dirty workaround for rare cases, though.
1016
1017If you always want to do this you can either recompile rxvt-unicode with
1018the desired TERM value or use a resource to set it:
1019
1020 URxvt.termName: rxvt
1021
1022=item How can I configure rxvt-unicode so that it looks similar to the original rxvt?
1023
1024Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode
1025behave similar to the original rxvt:
1026
1027 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1
1028 URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1
927 1029
928=item Rxvt-unicode does not seem to understand the selected encoding? 1030=item Rxvt-unicode does not seem to understand the selected encoding?
929 1031
930=item Unicode does not seem to work? 1032=item Unicode does not seem to work?
931 1033
964your system/os) have specified does not cover all the characters you want 1066your system/os) have specified does not cover all the characters you want
965to display. 1067to display.
966 1068
967B<rxvt-unicode> makes a best-effort try at finding a replacement 1069B<rxvt-unicode> makes a best-effort try at finding a replacement
968font. Often the result is fine, but sometimes the chosen font looks 1070font. Often the result is fine, but sometimes the chosen font looks
1071bad. Many fonts have totally strange characters that don't resemble the
1072correct glyph at all, and rxvt-unicode lacks the artificial intelligence
1073to detetc that a specific glyph is wrong: it has to believe the font that
1074the characters it contains indeed look correct.
1075
969bad. In that case, select a font of your taste and add it to the font 1076In that case, select a font of your taste and add it to the font list,
970list, e.g.: 1077e.g.:
971 1078
972 @@RXVT_NAME@@ -fn basefont,font2,font3... 1079 @@RXVT_NAME@@ -fn basefont,font2,font3...
973 1080
974When rxvt-unicode sees a character, it will first look at the base 1081When 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 1082font. If the base font does not contain the character, it will go to the
976next font, and so on. 1083next font, and so on. Specifying your own fonts will also speed up this
1084search and use less resources within rxvt-unicode and the X-server.
977 1085
978The only limitation is that all the fonts must not be larger than the base 1086The 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 1087font, as the base font defines the principial cell size, which must be the
980same due to the way terminals work. 1088same due to the way terminals work.
981 1089
999In the future it might be possible to switch preferences at runtime (the 1107In the future it might be possible to switch preferences at runtime (the
1000internal data structure has no problem with using different fonts for 1108internal data structure has no problem with using different fonts for
1001the same character at the same time, but no interface for this has been 1109the same character at the same time, but no interface for this has been
1002designed yet). 1110designed yet).
1003 1111
1112=item How can I keep rxvt-unicode from using reverse video so much?
1113
1114First of all, make sure you are running with the right terminfo
1115(C<urxvt>), which will get rid of most of these effects. Then make sure
1116you have specified colours for italic and bold, as otherwise rxvt-unicode
1117might use reverse video to simulate the effect:
1118
1119 URxvt*colorBD: white
1120 URxvt*colorIT: green
1121
1122=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
1123
1124For some unexplainable reason, some programs (i.e. irssi) assume a very
1125weird colour palette when confronted with a terminal with more than the
1126standard 8 colours (rxvt-unicode supports 88). The right fix is, of
1127course, to fix these programs not to assume non-ISO colours without very
1128good reasons.
1129
1130In the meantime, you can either edit your C<urxvt> terminfo definition to
1131only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
1132but keep you from using other rxvt-unicode features.
1133
1004=item How does rxvt-unicode determine the encoding to use? 1134=item How does rxvt-unicode determine the encoding to use?
1005 1135
1006=item Is there an option to switch encodings? 1136=item Is there an option to switch encodings?
1007 1137
1008Unlike some other terminals, rxvt-unicode has no encoding switch, and no 1138Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1062This is useful if you e.g. work primarily with japanese (and prefer a 1192This is useful if you e.g. work primarily with japanese (and prefer a
1063japanese font), but you have to switch to chinese temporarily, where 1193japanese font), but you have to switch to chinese temporarily, where
1064japanese fonts would only be in your way. 1194japanese fonts would only be in your way.
1065 1195
1066You can think of this as a kind of manual ISO-2022 switching. 1196You can think of this as a kind of manual ISO-2022 switching.
1197
1198=item Why do italic characters look as if clipped?
1199
1200Many fonts have difficulties with italic characters and hinting. For
1201example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
1202Mono> completely fails in it's italic face. A workaround is to enable
1203freetype autohinting, i.e. like this:
1204
1205 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
1206 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
1207
1208=item My input method wants <some encoding> but I want UTF-8, what can I do?
1209
1210You cna specify separate locales for the input method and the rest of the
1211terminal, using the resource C<imlocale>:
1212
1213 URxvt*imlocale: ja_JP.EUC-JP
1214
1215Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1216use your input method. Please note, however, that you will not be able to
1217input characters outside C<EUC-JP> in a normal way then, as your input
1218method limits you.
1219
1220=item Rxvt-unicode uses gobs of memory, how can I reduce that?
1221
1222Rxvt-unicode tries to obey the rule of not charging you for sth. you
1223don't use. One thing you should try is to configure out all settings that
1224you don't need, for example, Xft support is a resource hog by design,
1225when used. Compiling it out ensures that no Xft font will be loaded
1226accidentally when rxvt-unicode tries to find a font for your characters.
1227
1228Also, many people (me included) like large windows and even larger
1229scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
12306 bytes per screen cell. For a 160x?? window this amounts to almost a
1231kilobyte per line. A scorllback buffer of 10000 lines will then (if full)
1232use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
1233rxvt-unicode then uses 8 bytes per screen cell.
1234
1235=item Can I speed up Xft rendering somehow?
1236
1237Yes, the most obvious way to speed it up is to avoid Xft entirely, as
1238it is simply slow. If you still want Xft fonts you might try to disable
1239antialiasing (by appending C<:antialiasing=false>), which saves lots of
1240memory and also speeds up rendering considerably.
1241
1242=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
1243
1244Rxvt-unicode will use whatever you specify as a font. If it needs to
1245fall back to it's default font search list it will prefer X11 core
1246fonts, because they are small and fast, and then use Xft fonts. It has
1247antialiaisng disabled for most of them, because the author thinks they
1248look best that way.
1249
1250If you want antialiasing, you have to specify the fonts manually.
1067 1251
1068=item Mouse cut/paste suddenly no longer works. 1252=item Mouse cut/paste suddenly no longer works.
1069 1253
1070Make sure that mouse reporting is actually turned off since killing 1254Make sure that mouse reporting is actually turned off since killing
1071some editors prematurely may leave the mouse in mouse report mode. I've 1255some editors prematurely may leave the mouse in mouse report mode. I've

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines