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.68 by root, Thu Aug 11 02:05:07 2005 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
20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
16 23
17=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
18 25
19Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
24like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
25scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are left-to-right scripts, such
27as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
29such as cursor-movement while editing -- break othwerwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
30change. 37change.
31 38
32If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
33me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very userfriendly, lean and clean
34terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
53drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
55 62
56It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
57been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
58reference documentation (escape sequences etc.) and the FAQ section at the 65reference documentation (escape sequences etc.).
59end of this document.
60 66
61=head1 OPTIONS 67=head1 OPTIONS
62 68
63The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The 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 70below. In keeping with the smaller-is-better philosophy, options may be
106Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
107B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
108 114
109=item B<-fade> I<number> 115=item B<-fade> I<number>
110 116
111Fade the text by the given percentage when focus is lost. 117Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>.
120
121=item B<-fadecolor> I<colour>
122
123Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>.
112 125
113=item B<-tint> I<colour> 126=item B<-tint> I<colour>
114 127
115Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
116transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 129transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
117option that can be used to brighten or darken the image in addition to 130option that can be used to brighten or darken the image in addition to
118tinting it. 131tinting it; resource I<tintColor>.
119 132
120=item B<-sh> 133=item B<-sh>
121 134
122I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 135I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
123background image in addition to tinting it (i.e. B<-tint> must be 136background image in addition to tinting it (i.e. B<-tint> must be
124specified, too). 137specified, too, e.g. C<-tint white>).
125 138
126=item B<-bg> I<colour> 139=item B<-bg> I<colour>
127 140
128Window background colour; resource B<background>. 141Window background colour; resource B<background>.
129 142
132Window foreground colour; resource B<foreground>. 145Window foreground colour; resource B<foreground>.
133 146
134=item B<-pixmap> I<file[;geom]> 147=item B<-pixmap> I<file[;geom]>
135 148
136Compile I<XPM>: Specify XPM file for the background and also optionally 149Compile I<XPM>: Specify XPM file for the background and also optionally
137specify its scaling with a geometry string. Note you may need to add 150specify its scaling with a geometry string. Note you may need to
138quotes to avoid special shell interpretation of the `;' in the 151add quotes to avoid special shell interpretation of the C<;> in the
139command-line; resource B<backgroundPixmap>. 152command-line; resource B<backgroundPixmap>.
140 153
141=item B<-cr> I<colour> 154=item B<-cr> I<colour>
142 155
143The cursor colour; resource B<cursorColor>. 156The cursor colour; resource B<cursorColor>.
150 163
151The mouse pointer background colour; resource B<pointerColor2>. 164The mouse pointer background colour; resource B<pointerColor2>.
152 165
153=item B<-bd> I<colour> 166=item B<-bd> I<colour>
154 167
155The colour of the border between the xterm scrollbar and the text; 168The colour of the border around the text area and between the scrollbar and the text;
156resource B<borderColor>. 169resource B<borderColor>.
157 170
158=item B<-fn> I<fontname> 171=item B<-fn> I<fontlist>
159 172
160Select the fonts to be used. This is a comma seperated list of font 173Select 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. 174that are used in turn when trying to display Unicode characters. The
162The first font defines the cell size for characters; other fonts might 175first font defines the cell size for characters; other fonts might be
163be smaller, but not larger. A reasonable default font list is always 176smaller, but not (in general) larger. A (hopefully) reasonable default
164appended to it. resource B<font>. 177font list is always appended to it. See resource B<font> for more details.
178
179In short, to specify an X11 core font, just specify it's name or prefix it
180with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
181e.g.:
182
183 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
184 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165 185
166See also the question "How does rxvt-unicode choose fonts?" in the FAQ 186See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167section. 187section of @@RXVT_NAME@@(7).
168 188
169=item B<-rb>|B<+rb> 189=item B<-fb> I<fontlist>
170 190
171Enable "real bold" support. When this option is on, bold text will be 191Compile 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 192be printed. See resource B<boldFont> for details.
173fonts should thus be specified in the font list after their 193
174corresponding regular fonts. If no bold font can be found, a regular 194=item B<-fi> I<fontlist>
175font will be used. resource B<realBold>. 195
196Compile font-styles: The italic font list to use when bold characters are to
197be printed. See resource B<italicFont> for details.
198
199=item B<-fbi> I<fontlist>
200
201Compile font-styles: The bold italic font list to use when bold characters are to
202be printed. See resource B<boldItalicFont> for details.
176 203
177=item B<-name> I<name> 204=item B<-name> I<name>
178 205
179Specify the application name under which resources are to be obtained, 206Specify the application name under which resources are to be obtained,
180rather than the default executable file name. Name should not contain 207rather than the default executable file name. Name should not contain
218 245
219Put scrollbar on right/left; resource B<scrollBar_right>. 246Put scrollbar on right/left; resource B<scrollBar_right>.
220 247
221=item B<-st>|B<+st> 248=item B<-st>|B<+st>
222 249
223Display normal (non XTerm/NeXT) scrollbar without/with a trough; 250Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
224resource B<scrollBar_floating>. 251resource B<scrollBar_floating>.
252
253=item B<-ptab>|B<+ptab>
254
255If enabled (default), "Horizontal Tab" characters are being stored as
256actual wide characters in the screen buffer, which makes it possible to
257select and paste them. Since a horizontal tab is a cursor movement and
258not an actual glyph, this can sometimes be visually annoying as the cursor
259on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
225 260
226=item B<-bc>|B<+bc> 261=item B<-bc>|B<+bc>
227 262
228Blink the cursor; resource B<cursorBlink>. 263Blink the cursor; resource B<cursorBlink>.
229 264
254if honoured by the WM, the rxvt-unicode window will not have window 289if honoured by the WM, the rxvt-unicode window will not have window
255decorations; resource B<borderLess>. 290decorations; resource B<borderLess>.
256 291
257=item B<-lsp> I<number> 292=item B<-lsp> I<number>
258 293
259Compile I<linespace>: Lines (pixel height) to insert between each row 294Compile I<frills>: Lines (pixel height) to insert between each row of
260of the display; resource B<linespace>. 295the display. Useful to work around font rendering problems; resource
296B<linespace>.
261 297
262=item B<-tn> I<termname> 298=item B<-tn> I<termname>
263 299
264This option specifies the name of the terminal type to be set in the 300This option specifies the name of the terminal type to be set in the
265B<TERM> environment variable. This terminal type must exist in the 301B<TERM> environment variable. This terminal type must exist in the
301 337
302Compile I<XIM>: input method name. resource B<inputMethod>. 338Compile I<XIM>: input method name. resource B<inputMethod>.
303 339
304=item B<-imlocale> I<string> 340=item B<-imlocale> I<string>
305 341
306The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 342The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
307de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 343C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
308extension to be able to input japanese characters while staying in 344input extension to be able to input japanese characters while staying in
309another locale. 345another locale. resource B<imLocale>.
346
347=item B<-imfont> I<fontset>
348
349Set the font set to use for the X Input Method, see resource B<imFont>
350for more info.
351
352=item B<-tcw>
353
354Change the meaning of triple-click selection with the left mouse
355button. Instead of selecting a full line it will extend the selection the
356end of the logical line only. resource B<tripleclickwords>.
310 357
311=item B<-insecure> 358=item B<-insecure>
312 359
313Enable "insecure" mode, which currently enables most of the escape 360Enable "insecure" mode, which currently enables most of the escape
314sequences that echo strings. See the resource B<insecure> for more 361sequences that echo strings. See the resource B<insecure> for more
328=item B<-ssr>|B<+ssr> 375=item B<-ssr>|B<+ssr>
329 376
330Turn on/off secondary screen scroll (default enabled); resource 377Turn on/off secondary screen scroll (default enabled); resource
331B<secondaryScroll>. 378B<secondaryScroll>.
332 379
333=item B<-xrm> I<resourcestring> 380=item B<-keysym.>I<sym> I<string>
334 381
335No effect on rxvt-unicode. Simply passes through an argument to be made 382Remap a key symbol. See resource B<keysym>.
336available in the instance's argument list. Appears in I<WM_COMMAND> in 383
337some window managers. 384=item B<-embed> I<windowid>
385
386Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
387which enables applications to easily embed a terminal.
388
389Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
390shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
391quite a bit, so don't expect it to keep some specific state. It's best to
392create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
393
394The window will not be destroyed when @@RXVT_NAME@@ exits.
395
396It might be useful to know that @@RXVT_NAME@@ will not close file
397descriptors passed to it (except for stdin/out/err, of course), so you
398can use file descriptors to communicate with the programs within the
399terminal. This works regardless of wether the C<-embed> option was used or
400not.
401
402Here is a short Gtk2-perl snippet that illustrates how this option can be
403used (a longer example is in F<doc/embed>):
404
405 my $rxvt = new Gtk2::Socket;
406 $rxvt->signal_connect_after (realize => sub {
407 my $xid = $_[0]->window->get_xid;
408 system "@@RXVT_NAME@@ -embed $xid &";
409 });
410
411=item B<-pty-fd> I<fileno>
412
413Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
414pair but instead use the given filehandle as the tty master. This is
415useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
416without having to run a program within it.
417
418If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
419entries and will not tinker with pty/tty permissions - you have to do that
420yourself if you want that.
421
422Here is a example in perl that illustrates how this option can be used (a
423longer example is in F<doc/pty-fd>):
424
425 use IO::Pty;
426 use Fcntl;
427
428 my $pty = new IO::Pty;
429 fcntl $pty, F_SETFD, 0; # clear close-on-exec
430 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
431 close $pty;
432
433 # now communicate with rxvt
434 my $slave = $pty->slave;
435 while (<$slave>) { print $slave "got <$_>\n" }
338 436
339=back 437=back
340 438
341=head1 RESOURCES (available also as long-options) 439=head1 RESOURCES (available also as long-options)
342 440
345 443
346There are two different methods that @@RXVT_NAME@@ can use to get the 444There are two different methods that @@RXVT_NAME@@ can use to get the
347Xresource data: using the X libraries (Xrm*-functions) or internal 445Xresource data: using the X libraries (Xrm*-functions) or internal
348Xresources reader (B<~/.Xdefaults>). For the first method (ie. 446Xresources reader (B<~/.Xdefaults>). For the first method (ie.
349B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 447B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
350resources using X11 tools like B<xset>. Many distribution do also load 448resources using X11 tools like B<xrdb>. Many distribution do also load
351settings from the B<~/.Xresources> file when X starts. 449settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
450will consult the following files/resources in order, with later settings
451overwriting earlier ones:
452
453 1. system-wide app-defaults file, either locale-dependent OR global
454 2. app-defaults file in $XAPPLRESDIR
455 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
456 4. SCREEN_RESOURCES for the current screen
457 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
352 458
353If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 459If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
354lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 460lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
355set in XAPPLOADDIR/URxvt (compile-time defined: usually 461set in XAPPLOADDIR/URxvt (compile-time defined: usually
356B</usr/lib/X11/app-defaults/URxvt>) and resources set in 462B</usr/lib/X11/app-defaults/URxvt>) and resources set in
389high-intensity (bold = bright foreground, blink = bright background) 495high-intensity (bold = bright foreground, blink = bright background)
390colours. The canonical names are as follows: 0=black, 1=red, 2=green, 496colours. 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 4973=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
392names used are listed in the B<COLORS AND GRAPHICS> section. 498names used are listed in the B<COLORS AND GRAPHICS> section.
393 499
500Colours higher than 15 cannot be set using resources (yet), but can be
501changed using an escape command (see @@RXVT_NAME@@(7)).
502
503Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
50488 colour support). Colours 80-87 are evenly spaces grey steps.
505
394=item B<colorBD:> I<colour> 506=item B<colorBD:> I<colour>
395 507
508=item B<colorIT:> I<colour>
509
396Use the specified colour to display bold characters when the foreground 510Use the specified colour to display bold or italic characters when the
397colour is the default. This option will be ignored if B<realBold> is 511foreground colour is the default. If font styles are not available
398enabled. 512(Compile I<styles>) and this option is unset, reverse video is used instead.
399 513
400=item B<colorUL:> I<colour> 514=item B<colorUL:> I<colour>
401 515
402Use the specified colour to display underlined characters when the 516Use the specified colour to display underlined characters when the
403foreground colour is the default. 517foreground colour is the default.
404 518
405=item B<colorRV:> I<colour> 519=item B<colorRV:> I<colour>
406 520
407Use the specified colour as the background for reverse video 521Use the specified colour as the background for reverse video
408characters. 522characters.
523
524=item B<underlineColor:> I<colour>
525
526If set, use the specified colour as the colour for the underline
527itself. If unset, use the foreground colour.
409 528
410=item B<cursorColor:> I<colour> 529=item B<cursorColor:> I<colour>
411 530
412Use the specified colour for the cursor. The default is to use the 531Use the specified colour for the cursor. The default is to use the
413foreground colour; option B<-cr>. 532foreground colour; option B<-cr>.
436artificial transparency. B<False>: do not inherit the parent windows' 555artificial transparency. B<False>: do not inherit the parent windows'
437pixmap. 556pixmap.
438 557
439=item B<fading:> I<number> 558=item B<fading:> I<number>
440 559
441Fade the text by the given percentage when focus is lost. 560Fade the text by the given percentage when focus is lost; option B<-fade>.
561
562=item B<fadeColor:> I<colour>
563
564Fade to this colour, when fading is used (see B<fading:>). The default
565colour is black; option B<-fadecolor>.
442 566
443=item B<tintColor:> I<colour> 567=item B<tintColor:> I<colour>
444 568
445Tint the transparent background pixmap with the given colour. 569Tint the transparent background pixmap with the given colour; option
570B<-tint>.
446 571
447=item B<shading:> I<number> 572=item B<shading:> I<number>
448 573
449Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 574Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
450image in addition to tinting it. 575image in addition to tinting it.
451 576
452=item B<fading:> I<number>
453
454Scale the tint colour by the given percentage.
455
456=item B<scrollColor:> I<colour> 577=item B<scrollColor:> I<colour>
457 578
458Use the specified colour for the scrollbar [default #B2B2B2]. 579Use the specified colour for the scrollbar [default #B2B2B2].
459 580
460=item B<troughColor:> I<colour> 581=item B<troughColor:> I<colour>
461 582
462Use the specified colour for the scrollbar's trough area [default 583Use the specified colour for the scrollbar's trough area [default
463#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 584#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
585
586=item B<borderColor:> I<colour>
587
588The colour of the border around the text area and between the scrollbar
589and the text.
464 590
465=item B<backgroundPixmap:> I<file[;geom]> 591=item B<backgroundPixmap:> I<file[;geom]>
466 592
467Use the specified XPM file (note the `.xpm' extension is optional) for 593Use the specified XPM file (note the `.xpm' extension is optional) for
468the background and also optionally specify its scaling with a geometry 594the background and also optionally specify its scaling with a geometry
484 610
485Specify the colon-delimited search path for finding files (XPM and 611Specify the colon-delimited search path for finding files (XPM and
486menus), in addition to the paths specified by the B<RXVTPATH> and 612menus), in addition to the paths specified by the B<RXVTPATH> and
487B<PATH> environment variables. 613B<PATH> environment variables.
488 614
489=item B<font:> I<fontname> 615=item B<font:> I<fontlist>
490 616
491Select the fonts to be used. This is a comma seperated list of font 617Select 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. 618names that are used in turn when trying to display Unicode characters.
493The first font defines the cell size for characters; other fonts might 619The first font defines the cell size for characters; other fonts might
494be smaller, but not larger. A reasonable default font list is always 620be smaller, but not larger. A reasonable default font list is always
495appended to it. option B<-fn>. 621appended to it. option B<-fn>.
496 622
497=item B<realBold:> I<boolean> 623Each font can either be a standard X11 core font (XLFD) name, with
624optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
498 625
499B<True>: Enable "real bold" support. When this option is on, bold text 626In addition, each font can be prefixed with additional hints and
500will be displayed using the first available bold font in the font list. 627specifications enclosed in square brackets (C<[]>). The only available
501Bold fonts should thus be specified in the font list after their 628hint 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 629fonts.
503font will be used. option B<-rb>. B<False>: Display bold text in a 630
504regular font, using the color specified with B<colorBD>; option B<+rb>. 631For example, this font resource
632
633 URxvt*font: 9x15bold,\
634 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
635 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
636 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
637 xft:Code2000:antialias=false
638
639specifies five fonts to be used. The first one is C<9x15bold> (actually
640the iso8859-1 version of the second font), which is the base font (because
641it is named first) and thus defines the character cell grid to be 9 pixels
642wide and 15 pixels high.
643
644The second font is just used to add additional unicode characters not in
645the base font, likewise the third, which is unfortunately non-bold, but
646the bold version of the font does contain less characters, so this is a
647useful supplement.
648
649The third font is an Xft font with aliasing turned off, and the characters
650are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
651contains other characters, but we are not interested in them.
652
653The last font is a useful catch-all font that supplies most of the
654remaining unicode characters.
655
656=item B<boldFont:> I<fontlist>
657
658=item B<italicFont:> I<fontlist>
659
660=item B<boldItalicFont:> I<fontlist>
661
662The font list to use for displaying B<bold>, I<italic> or B<< I<bold
663italic> >> characters, respectively.
664
665If specified and non-empty, then the syntax is the same as for the
666B<font>-resource, and the given font list will be used as is, which makes
667it possible to substitute completely different font styles for bold and
668italic.
669
670If unset (the default), a suitable font list will be synthesized by
671"morphing" the normal text font list into the desired shape. If that is
672not possible, replacement fonts of the desired shape will be tried.
673
674If set, but empty, then this specific style is disabled and the normal
675text font will being used for the given style.
505 676
506=item B<selectstyle:> I<mode> 677=item B<selectstyle:> I<mode>
507 678
508Set mouse selection style to B<old> which is 2.20, B<oldword> which is 679Set 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 680xterm style with 2.20 old word selection, or anything else which gives
510xterm style selection. 681xterm style selection.
511 682
512=item B<scrollstyle:> I<mode> 683=item B<scrollstyle:> I<mode>
513 684
514Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 685Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
515the author's favourite.. 686the author's favourite.
516 687
517=item B<title:> I<string> 688=item B<title:> I<string>
518 689
519Set window title string, the default title is the command-line 690Set window title string, the default title is the command-line
520specified after the B<-e> option, if any, otherwise the application 691specified after the B<-e> option, if any, otherwise the application
552 723
553Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 724Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
554B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 725B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
555B<Shift-Print> to include the scrollback as well. 726B<Shift-Print> to include the scrollback as well.
556 727
728The string will be interpreted as if typed into the shell as-is.
729
730Example:
731
732 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
733
734This creates a new file in your home directory with the screen contents
735everytime you hit C<Print>.
736
557=item B<scrollBar:> I<boolean> 737=item B<scrollBar:> I<boolean>
558 738
559B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 739B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
560disable the scrollbar; option B<+sb>. 740disable the scrollbar; option B<+sb>.
561 741
580B<False>: do not scroll to bottom when tty receives output; option 760B<False>: do not scroll to bottom when tty receives output; option
581B<+si>. 761B<+si>.
582 762
583=item B<scrollWithBuffer:> I<boolean> 763=item B<scrollWithBuffer:> I<boolean>
584 764
585B<True>: scroll with scrollback buffer when tty recieves new lines (and 765B<True>: scroll with scrollback buffer when tty receives new lines (and
586B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 766B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
587with scrollback buffer when tty recieves new lines; option B<-sw>. 767with scrollback buffer when tty recieves new lines; option B<+sw>.
588 768
589=item B<scrollTtyKeypress:> I<boolean> 769=item B<scrollTtyKeypress:> I<boolean>
590 770
591B<True>: scroll to bottom when a non-special key is pressed. Special keys 771B<True>: scroll to bottom when a non-special key is pressed. Special keys
592are those which are intercepted by rxvt-unicode for special handling and 772are those which are intercepted by rxvt-unicode for special handling and
631=item B<mouseWheelScrollPage:> I<boolean> 811=item B<mouseWheelScrollPage:> I<boolean>
632 812
633B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 813B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
634scrolls five lines [default]. 814scrolls five lines [default].
635 815
816=item B<pastableTabs:> I<boolean>
817
818B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
819movement only; option C<-ptab>.
820
636=item B<cursorBlink:> I<boolean> 821=item B<cursorBlink:> I<boolean>
637 822
638B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 823B<True>: blink the cursor. B<False>: do not blink the cursor [default];
639option B<-bc>. 824option B<-bc>.
640 825
652 837
653Mouse pointer background colour. 838Mouse pointer background colour.
654 839
655=item B<pointerBlankDelay:> I<number> 840=item B<pointerBlankDelay:> I<number>
656 841
657Specifies number of seconds before blanking the pointer [default 2]. 842Specifies number of seconds before blanking the pointer [default 2]. Use a
843large number (e.g. C<987654321>) to effectively disable the timeout.
658 844
659=item B<backspacekey:> I<string> 845=item B<backspacekey:> I<string>
660 846
661The string to send when the backspace key is pressed. If set to B<DEC> 847The string to send when the backspace key is pressed. If set to B<DEC>
662or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 848or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
684 870
685I<name> of inputMethod to use; option B<-im>. 871I<name> of inputMethod to use; option B<-im>.
686 872
687=item B<imLocale:> I<name> 873=item B<imLocale:> I<name>
688 874
689The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 875The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
690de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 876C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
691extension to be able to input japanese characters while staying in 877input extension to be able to input japanese characters while staying in
692another locale. option B<-imlocale>. 878another locale. option B<-imlocale>.
693 879
694=item B<insecure> 880=item B<imFont:> I<fontset>
881
882Specify the font-set used for XIM styles C<OverTheSpot> or
883C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
884by commas), i.e. it's not in the same format as the other font lists used
885in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
886found, preferably one or two pixels differing in size to the base font.
887option B<-imfont>.
888
889=item B<tripleclickwords:> I<boolean>
890
891Change the meaning of triple-click selection with the left mouse
892button. Instead of selecting a full line it will extend the selection to
893the end of the logical line only. option B<-tcw>.
894
895=item B<insecure:> I<boolean>
695 896
696Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 897Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697echo arbitrary strings like the icon name or the locale. This could be 898echo arbitrary strings like the icon name or the locale. This could be
698abused if somebody gets 8-bit-clean access to your display, wether 899abused if somebody gets 8-bit-clean access to your display, whether
699throuh a mail client displaying mail bodies unfiltered or though 900throuh a mail client displaying mail bodies unfiltered or though
700write(1). Therefore, these sequences are disabled by default. (Note 901write(1). Therefore, these sequences are disabled by default. (Note
701that other terminals, including xterm, have these sequences 902that other terminals, including xterm, have these sequences
702enabled by default). You can enable them by setting this boolean 903enabled by default). You can enable them by setting this boolean
703resource or specifying B<-insecure> as an option. At the moment, this 904resource or specifying B<-insecure> as an option. At the moment, this
727scrollback buffer and switching to/from the secondary screen will 928scrollback buffer and switching to/from the secondary screen will
728instead scroll the screen up. 929instead scroll the screen up.
729 930
730=item B<keysym.>I<sym>: I<string> 931=item B<keysym.>I<sym>: I<string>
731 932
732Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 933Compile I<frills>: Associate I<string> with keysym I<sym>. The
733contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 934intervening resource name B<keysym.> cannot be omitted.
734newline, \r: return, \t: 935
936The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
937any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
938B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
939and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
940B<2>, B<3>, B<4>, B<5>.
941
942The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
943whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
944keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
945current application keymap mode state.
946
947The spellings of I<key> can be obtained by using B<xev>(1) command or
948searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
949omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
950keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
951performed in an exact manner; however, the closest match is assured.
952
953I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
954C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
735tab, \000: octal number) or control characters (^?: delete, ^@: null, 955C<\000>: octal number) or verbatim control characters (C<^?>: delete,
736^A ...) and may enclosed with double quotes so that it can start or end 956C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
737with whitespace. The intervening resource name B<keysym.> cannot be 957can start or end with whitespace.
738omitted. This resource is only available when compiled with 958
739KEYSYM_RESOURCE. 959Please note that you need to double the C<\> when using
960C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
961use C<\033> instead of C<\e> (and so on), which will work with both Xt and
962@@RXVT_NAME@@'s own processing).
963
964You can define a range of keysyms in one shot by providing a I<string>
965with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
966should be a character not used by the strings.
967
968Its usage can be demonstrated by an example:
969
970 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
971
972The above line is equivalent to the following three lines:
973
974 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
975 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
976 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
977
978If I<string> takes the form of C<command:STRING>, the specified B<STRING>
979is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
980example the following means "change the current locale to C<zh_CN.GBK>
981when Control-Meta-c is being pressed":
982
983 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
984
985Due the the large number of modifier combinations, a defined key mapping
986will match if at I<at least> the specified identifiers are being set, and
987no other key mappings with those and more bits are being defined. That
988means that defining a key map for C<a> will automatically provide
989definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
990mappings themselves.
991
992Unfortunately, this will override built-in key mappings. For example
993if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
994C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
995user-defined keymap using the C<builtin:> replacement:
996
997 URxvt.keysym.Insert: <my insert key sequence>
998 URxvt.keysym.S-Insert: builtin:
999
1000The first line defines a mapping for C<Insert> and I<any> combination
1001of modifiers. The second line re-establishes the default mapping for
1002C<Shift-Insert>.
1003
1004The following example will map Control-Meta-1 and Control-Meta-2 to
1005the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1006font-switching at runtime:
1007
1008 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1009 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1010
1011Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1012info):
1013
1014 URxvt.keysym.M-C-3: command:\033[8;25;80t
1015 URxvt.keysym.M-C-4: command:\033[8;48;110t
740 1016
741=back 1017=back
742 1018
743=head1 THE SCROLLBAR 1019=head1 THE SCROLLBAR
744 1020
758the normal text selection/insertion, hold either the Shift or the Meta 1034the normal text selection/insertion, hold either the Shift or the Meta
759(Alt) key while performing the desired mouse action. 1035(Alt) key while performing the desired mouse action.
760 1036
761If mouse reporting mode is active, the normal scrollbar actions are 1037If mouse reporting mode is active, the normal scrollbar actions are
762disabled -- on the assumption that we are using a fullscreen 1038disabled -- on the assumption that we are using a fullscreen
763application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1039application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
764(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1040(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
765up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1041up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
766respectively. 1042respectively.
767 1043
768=head1 TEXT SELECTION AND INSERTION 1044=head1 TEXT SELECTION AND INSERTION
769 1045
770The behaviour of text selection and insertion mechanism is similar to 1046The behaviour of text selection and insertion mechanism is similar to
772 1048
773=over 4 1049=over 4
774 1050
775=item B<Selection>: 1051=item B<Selection>:
776 1052
777Left click at the beginning of the region, drag to the end of the 1053Left click at the beginning of the region, drag to the end of the region
778region and release; Right click to extend the marked region; Left 1054and release; Right click to extend the marked region; Left double-click
779double-click to select a word; Left triple-click to select the entire 1055to select a word; Left triple-click to select the entire logical line
780line. 1056(which can span multiple screen lines), unless modified by resource
1057B<tripleclickwords>.
1058
1059Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1060(Compile: I<frills>) will create a rectangular selection instead of a normal
1061one.
781 1062
782=item B<Insertion>: 1063=item B<Insertion>:
783 1064
784Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1065Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
785an B<@@RXVT_NAME@@> window causes the current text selection to be 1066an B<@@RXVT_NAME@@> window causes the current text selection to be
807C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1088C<--enable-frills>, the rest is available when rxvt-unicode was compiled
808with C<--enable-iso14755>. 1089with C<--enable-iso14755>.
809 1090
810=over 4 1091=over 4
811 1092
812=item 5.1: Basic method 1093=item * 5.1: Basic method
813 1094
814This allows you to enter unicode characters using their hexcode. 1095This allows you to enter unicode characters using their hexcode.
815 1096
816Start by pressing and holding both C<Control> and C<Shift>, then enter 1097Start by pressing and holding both C<Control> and C<Shift>, then enter
817hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1098hex-digits (between one and six). Releasing C<Control> and C<Shift> will
824address, which you cannot type. Fortunately, the card has the e-mail 1105address, which you cannot type. Fortunately, the card has the e-mail
825address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1106address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
826by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1107by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
827followed by releasing the modifier keys. 1108followed by releasing the modifier keys.
828 1109
829=item 5.2: Keyboard symbols entry method 1110=item * 5.2: Keyboard symbols entry method
830 1111
831This mode lets you input characters representing the keycap symbols of 1112This mode lets you input characters representing the keycap symbols of
832your keyboard, if representable in the current locale encoding. 1113your keyboard, if representable in the current locale encoding.
833 1114
834Start by pressing C<Control> and C<Shift> together, then releasing 1115Start by pressing C<Control> and C<Shift> together, then releasing
835them. The next special key (cursor keys, home etc.) you enter will not 1116them. The next special key (cursor keys, home etc.) you enter will not
836invoke it's usual function but instead will insert the corresponding 1117invoke it's usual function but instead will insert the corresponding
837keycap symbol. The symbol will only be entered when the key has been 1118keycap symbol. The symbol will only be entered when the key has been
838released, otherwise pressing e.g. C<Shift> would enter the symbol for 1119released, 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 1120C<ISO Level 2 Switch>, although your intention might have been to enter a
840reverse tab (Shift-Tab). 1121reverse tab (Shift-Tab).
841 1122
842=item 5.3: Screen-selection entry method 1123=item * 5.3: Screen-selection entry method
843 1124
844While this is implemented already (it's basically the selection 1125While this is implemented already (it's basically the selection
845mechanism), it could be extended by displaying a unicode character map. 1126mechanism), it could be extended by displaying a unicode character map.
846 1127
847=item 5.4: Feedback method for identifying displayed characters for later input 1128=item * 5.4: Feedback method for identifying displayed characters for later input
848 1129
849This method lets you display the unicode character code associated with 1130This method lets you display the unicode character code associated with
850characters already displayed. 1131characters already displayed.
851 1132
852You enter this mode by holding down C<Control> and C<Shift> together, then 1133You 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 1134pressing 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 1135hex code(s) (it might be a combining character) of the character under the
855pointer is displayed until you release C<Control> and C<Shift>. 1136pointer is displayed until you release C<Control> and C<Shift>.
856 1137
1138In addition to the hex codes it will display the font used to draw this
1139character - due to implementation reasons, characters combined with
1140combining characters, line drawing characters and unknown characters will
1141always be drawn using the built-in support font.
1142
857=back 1143=back
858 1144
859With respect to conformance, rxvt-unicode is supposed to be compliant to 1145With respect to conformance, rxvt-unicode is supposed to be compliant to
860both scenario A and B of ISO 14755, including part 5.2. 1146both scenario A and B of ISO 14755, including part 5.2.
861 1147
862=head1 LOGIN STAMP 1148=head1 LOGIN STAMP
863 1149
864B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1150B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
865that it can be seen via the I<who(1)> command, and can accept messages. 1151it can be seen via the I<who(1)> command, and can accept messages. To
866To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1152allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
867some systems. 1153on some systems or setgid to root or to some other group on others.
868 1154
869=head1 COLORS AND GRAPHICS 1155=head1 COLORS AND GRAPHICS
870 1156
871In addition to the default foreground and background colours, 1157In addition to the default foreground and background colours,
872B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1158B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
913would yield White on Black, while on I<xterm>(1) it would yield Black 1199would yield White on Black, while on I<xterm>(1) it would yield Black
914on White. 1200on White.
915 1201
916=back 1202=back
917 1203
918=head1 FREQUENTLY ASKED QUESTIONS (FAQ) 1204=head1 ENVIRONMENT
1205
1206B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
919 1207
920=over 4 1208=over 4
921 1209
922=item How do I know which rxvt-unicode version I'm using? 1210=item B<TERM>
923 1211
924The version number is displayed with the usage (-h). For rxvt-unicode 1212Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
925version 2.14 and later, the escape sequence C<ESC[8n> sets the window 1213resources or on the commandline.
926title to the version number.
927 1214
928=item Rxvt-unicode does not seem to understand the selected encoding? 1215=item B<COLORTERM>
929 1216
930=item Unicode does not seem to work? 1217Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1218compiled with XPM support, and optionally with the added extension
1219C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
931 1220
932If you encounter strange problems like typing an accented character but 1221=item B<COLORFGBG>
933getting two unrelated other characters or similar, or if program output is
934subtly garbled, then you should check your locale settings.
935 1222
936Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 1223Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
937programs. Often rxvt-unicode is started in the C<C> locale, while the 1224the colour code used as default foreground/text colour (or the string
938login script running within the rxvt-unicode window changes the locale to 1225C<default> to indicate that the default-colour escape sequence is to be
939sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work. 1226used), C<bg> is the colour code used as default background colour (or the
1227string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1228was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1229(and do) use this information to optimize screen output.
940 1230
941The best thing is to fix your startup environment, as you will likely run 1231=item B<WINDOWID>
942into other problems. If nothing works you can try this in your .profile.
943 1232
944 printf '\e]701;%s\007' "$LC_CTYPE" 1233Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1234window, which usually has subwindows for the scrollbar, the terminal
1235window and so on).
945 1236
946If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 1237=item B<TERMINFO>
947supported on your systems. Some systems have a C<locale> comamnd which
948displays this. If it displays sth. like:
949 1238
950 locale: Cannot set LC_CTYPE to default locale: ... 1239Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1240C<--with-terminfo=PATH>.
951 1241
952Then the locale you specified is not supported on your system. 1242=item B<DISPLAY>
953 1243
954If nothing works and you are sure that everything is set correctly then 1244Used by @@RXVT_NAME@@ to connect to the display and set to the correct
955you will need to remember a little known fact: Some programs just don't 1245display in it's child processes.
956support locales :(
957 1246
958=item Why do the characters look ugly? 1247=item B<SHELL>
959 1248
960=item How does rxvt-unicode choose fonts? 1249The shell to be used for command execution, defaults to C</bin/sh>.
961 1250
962Most fonts do not contain the full range of Unicode, which is 1251=item B<RXVTPATH>
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 1252
967B<rxvt-unicode> makes a best-effort try at finding a replacement 1253The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
968font. Often the result is fine, but sometimes the chosen font looks 1254files.
969bad. In that case, select a font of your taste and add it to the font
970list, e.g.:
971 1255
972 @@RXVT_NAME@@ -fn basefont,font2,font3... 1256=item B<PATH>
973 1257
974When rxvt-unicode sees a character, it will first look at the base 1258Used in the same way as C<RXVTPATH>.
975font. If the base font does not contain the character, it will go to the
976next font, and so on.
977 1259
978The only limitation is that all the fonts must not be larger than the base 1260=item B<RXVT_SOCKET>
979font, as the base font defines the principial cell size, which must be the
980same due to the way terminals work.
981 1261
982=item Why do some chinese characters look so different than others? 1262The unix domain socket path used by @@RXVT_NAME@@c(1) and
1263@@RXVT_NAME@@d(1).
983 1264
984This is because there is a difference between script and language -- 1265Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
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 1266
994The workaround is easy: just tag a chinese font at the end of your font 1267=item B<HOME>
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 1268
999In the future it might be possible to switch preferences at runtime (the 1269Used to locate the default directory for the unix domain socket for
1000internal data structure has no problem with using different fonts for 1270daemon communications and to locate various resource files (such as
1001the same character at the same time, but no interface for this has been 1271C<.Xdefaults>)
1002designed yet).
1003 1272
1004=item How does rxvt-unicode determine the encoding to use? 1273=item B<XAPPLRESDIR>
1005 1274
1006=item Is there an option to switch encodings? 1275Directory where various X resource files are being located.
1007 1276
1008Unlike some other terminals, rxvt-unicode has no encoding switch, and no 1277=item B<XENVIRONMENT>
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 1278
1012The reasons is that there exists a perfectly fine mechanism for selecting 1279If set and accessible, gives the name of a X resource file to be loaded by
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@@ 1280@@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 1281
1277=back 1282=back
1278 1283
1279=head1 ENVIRONMENT
1280
1281B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1282and 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
1284sets the environment variable B<DISPLAY> to specify which display
1285terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1286B<RXVTPATH> and B<PATH> to find XPM files.
1287
1288=head1 FILES 1284=head1 FILES
1289 1285
1290=over 4 1286=over 4
1291 1287
1292=item B</etc/utmp>
1293
1294System file for login records.
1295
1296=item B</usr/lib/X11/rgb.txt> 1288=item B</usr/lib/X11/rgb.txt>
1297 1289
1298Color names. 1290Color names.
1299 1291
1300=back 1292=back
1301 1293
1302=head1 SEE ALSO 1294=head1 SEE ALSO
1303 1295
1304@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1296@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1305 1297
1306=head1 BUGS 1298=head1 BUGS
1307 1299
1308Check the BUGS file for an up-to-date list. 1300Check the BUGS file for an up-to-date list.
1309 1301
1315 1307
1316=over 4 1308=over 4
1317 1309
1318=item Project Coordinator 1310=item Project Coordinator
1319 1311
1320@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1312Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1321 1313
1322=item Web page maintainter 1314L<http://software.schmorp.de/#rxvt-unicode>
1323
1324@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1325
1326L<@@RXVT_WEBPAGE@@>
1327 1315
1328=back 1316=back
1329 1317
1330=head1 AUTHORS 1318=head1 AUTHORS
1331 1319
1356=item Geoff Wing L<< <gcw@pobox.com> >> 1344=item Geoff Wing L<< <gcw@pobox.com> >>
1357 1345
1358Rewrote screen display and text selection routines. Project Coordinator 1346Rewrote screen display and text selection routines. Project Coordinator
1359(changes.txt 2.4.6 - rxvt-unicode) 1347(changes.txt 2.4.6 - rxvt-unicode)
1360 1348
1361=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1349=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1362 1350
1363Forked rxvt-unicode, rewrote most of the display code and internal 1351Forked rxvt-unicode, rewrote most of the display code and internal
1364character handling to store text in unicode, improve xterm 1352character handling to store text in unicode, improve xterm
1365compatibility and apply numerous other bugfixes and extensions. 1353compatibility and apply numerous other bugfixes and extensions.
1366 1354

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines