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.22 by root, Tue Aug 24 15:46:27 2004 UTC vs.
Revision 1.81 by root, Mon Jan 2 21:41:51 2006 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
99 105
100=item B<-j>|B<+j> 106=item B<-j>|B<+j>
101 107
102Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
103 109
104=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
105 111
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>. This only works for
117option that can be used to brighten or darken the image in addition to 130non-tiled backgrounds, currently. See also the B<-sh> option that can be
118tinting it. 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133
134 @@RXVT_NAME@@ -tr -tint blue -sh 40
119 135
120=item B<-sh> 136=item B<-sh>
121 137
122I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
123background image in addition to tinting it (i.e. B<-tint> must be 139background image in addition to tinting it (i.e. B<-tint> must be
124specified, too). 140specified, too, e.g. C<-tint white>).
125 141
126=item B<-bg> I<colour> 142=item B<-bg> I<colour>
127 143
128Window background colour; resource B<background>. 144Window background colour; resource B<background>.
129 145
132Window foreground colour; resource B<foreground>. 148Window foreground colour; resource B<foreground>.
133 149
134=item B<-pixmap> I<file[;geom]> 150=item B<-pixmap> I<file[;geom]>
135 151
136Compile I<XPM>: Specify XPM file for the background and also optionally 152Compile I<XPM>: Specify XPM file for the background and also optionally
137specify its scaling with a geometry string. Note you may need to add 153specify its scaling with a geometry string. Note you may need to
138quotes to avoid special shell interpretation of the `;' in the 154add quotes to avoid special shell interpretation of the C<;> in the
139command-line; resource B<backgroundPixmap>. 155command-line; resource B<backgroundPixmap>.
140 156
141=item B<-cr> I<colour> 157=item B<-cr> I<colour>
142 158
143The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
158=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
159 175
160Select the fonts to be used. This is a comma separated list of font names 176Select the fonts to be used. This is a comma separated list of font names
161that are used in turn when trying to display Unicode characters. The 177that are used in turn when trying to display Unicode characters. The
162first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
163smaller, but not (in general) larger. A reasonable default font list is 179smaller, but not (in general) larger. A (hopefully) reasonable default
164always appended to it. See resource B<font> for details. 180font list is always appended to it. See resource B<font> for more details.
181
182In short, to specify an X11 core font, just specify it's name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.:
185
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165 188
166See also the question "How does rxvt-unicode choose fonts?" in the FAQ 189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167section. 190section of @@RXVT_NAME@@(7).
168 191
169=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
170 193
171Compile font-styles: The bold font list to use when bold characters are to 194Compile font-styles: The bold font list to use when bold characters are to
172be printed. See resource B<boldFont> for details. 195be printed. See resource B<boldFont> for details.
178 201
179=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
180 203
181Compile font-styles: The bold italic font list to use when bold characters are to 204Compile font-styles: The bold italic font list to use when bold characters are to
182be printed. See resource B<boldItalicFont> for details. 205be printed. See resource B<boldItalicFont> for details.
206
207=item B<-is>|B<+is>
208
209Compile font-styles: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for
211details.
183 212
184=item B<-name> I<name> 213=item B<-name> I<name>
185 214
186Specify the application name under which resources are to be obtained, 215Specify the application name under which resources are to be obtained,
187rather than the default executable file name. Name should not contain 216rather than the default executable file name. Name should not contain
225 254
226Put scrollbar on right/left; resource B<scrollBar_right>. 255Put scrollbar on right/left; resource B<scrollBar_right>.
227 256
228=item B<-st>|B<+st> 257=item B<-st>|B<+st>
229 258
230Display normal (non XTerm/NeXT) scrollbar without/with a trough; 259Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
231resource B<scrollBar_floating>. 260resource B<scrollBar_floating>.
261
262=item B<-ptab>|B<+ptab>
263
264If enabled (default), "Horizontal Tab" characters are being stored as
265actual wide characters in the screen buffer, which makes it possible to
266select and paste them. Since a horizontal tab is a cursor movement and
267not an actual glyph, this can sometimes be visually annoying as the cursor
268on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
232 269
233=item B<-bc>|B<+bc> 270=item B<-bc>|B<+bc>
234 271
235Blink the cursor; resource B<cursorBlink>. 272Blink the cursor; resource B<cursorBlink>.
236 273
261if honoured by the WM, the rxvt-unicode window will not have window 298if honoured by the WM, the rxvt-unicode window will not have window
262decorations; resource B<borderLess>. 299decorations; resource B<borderLess>.
263 300
264=item B<-lsp> I<number> 301=item B<-lsp> I<number>
265 302
266Compile I<linespace>: Lines (pixel height) to insert between each row 303Compile I<frills>: Lines (pixel height) to insert between each row of
267of the display; resource B<linespace>. 304the display. Useful to work around font rendering problems; resource
305B<linespace>.
268 306
269=item B<-tn> I<termname> 307=item B<-tn> I<termname>
270 308
271This option specifies the name of the terminal type to be set in the 309This option specifies the name of the terminal type to be set in the
272B<TERM> environment variable. This terminal type must exist in the 310B<TERM> environment variable. This terminal type must exist in the
281given on the command line. If this option is used, it must be the last 319given on the command line. If this option is used, it must be the last
282on the command-line. If there is no B<-e> option then the default is to 320on the command-line. If there is no B<-e> option then the default is to
283run the program specified by the B<SHELL> environment variable or, 321run the program specified by the B<SHELL> environment variable or,
284failing that, I<sh(1)>. 322failing that, I<sh(1)>.
285 323
324Please note that you must specify a program with arguments. If you want to
325run shell commands, you have to specify the shell, like this:
326
327 @@RXVT_NAME@@ -e sh -c "shell commands"
328
286=item B<-title> I<text> 329=item B<-title> I<text>
287 330
288Window title (B<-T> still respected); the default title is the basename 331Window title (B<-T> still respected); the default title is the basename
289of the program specified after the B<-e> option, if any, otherwise the 332of the program specified after the B<-e> option, if any, otherwise the
290application name; resource B<title>. 333application name; resource B<title>.
308 351
309Compile I<XIM>: input method name. resource B<inputMethod>. 352Compile I<XIM>: input method name. resource B<inputMethod>.
310 353
311=item B<-imlocale> I<string> 354=item B<-imlocale> I<string>
312 355
313The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 356The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
314de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 357C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
315extension to be able to input japanese characters while staying in 358input extension to be able to input japanese characters while staying in
316another locale. 359another locale. resource B<imLocale>.
360
361=item B<-imfont> I<fontset>
362
363Set the font set to use for the X Input Method, see resource B<imFont>
364for more info.
365
366=item B<-tcw>
367
368Change the meaning of triple-click selection with the left mouse
369button. Instead of selecting a full line it will extend the selection the
370end of the logical line only. resource B<tripleclickwords>.
317 371
318=item B<-insecure> 372=item B<-insecure>
319 373
320Enable "insecure" mode, which currently enables most of the escape 374Enable "insecure" mode, which currently enables most of the escape
321sequences that echo strings. See the resource B<insecure> for more 375sequences that echo strings. See the resource B<insecure> for more
335=item B<-ssr>|B<+ssr> 389=item B<-ssr>|B<+ssr>
336 390
337Turn on/off secondary screen scroll (default enabled); resource 391Turn on/off secondary screen scroll (default enabled); resource
338B<secondaryScroll>. 392B<secondaryScroll>.
339 393
394=item B<-hold>|B<+hold>
395
396Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397will not immediately destroy its window when the program executed within
398it exits. Instead, it will wait till it is being killed or closed by the
399user; resource B<hold>.
400
401=item B<-keysym.>I<sym> I<string>
402
403Remap a key symbol. See resource B<keysym>.
404
405=item B<-embed> I<windowid>
406
407Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
408which enables applications to easily embed a terminal.
409
410Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
411shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
412quite a bit, so don't expect it to keep some specific state. It's best to
413create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
414
415The window will not be destroyed when @@RXVT_NAME@@ exits.
416
417It might be useful to know that @@RXVT_NAME@@ will not close file
418descriptors passed to it (except for stdin/out/err, of course), so you
419can use file descriptors to communicate with the programs within the
420terminal. This works regardless of wether the C<-embed> option was used or
421not.
422
423Here is a short Gtk2-perl snippet that illustrates how this option can be
424used (a longer example is in F<doc/embed>):
425
426 my $rxvt = new Gtk2::Socket;
427 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &";
430 });
431
432=item B<-pty-fd> I<fileno>
433
434Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
435pair but instead use the given filehandle as the tty master. This is
436useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
437without having to run a program within it.
438
439If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
440entries and will not tinker with pty/tty permissions - you have to do that
441yourself if you want that.
442
443Here is a example in perl that illustrates how this option can be used (a
444longer example is in F<doc/pty-fd>):
445
446 use IO::Pty;
447 use Fcntl;
448
449 my $pty = new IO::Pty;
450 fcntl $pty, F_SETFD, 0; # clear close-on-exec
451 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
452 close $pty;
453
454 # now communicate with rxvt
455 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" }
457
340=item B<-xrm> I<resourcestring> 458=item B<-pe> I<string>
341 459
342No effect on rxvt-unicode. Simply passes through an argument to be made 460Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
343available in the instance's argument list. Appears in I<WM_COMMAND> in
344some window managers.
345 461
346=back 462=back
347 463
348=head1 RESOURCES (available also as long-options) 464=head1 RESOURCES (available also as long-options)
349 465
352 468
353There are two different methods that @@RXVT_NAME@@ can use to get the 469There are two different methods that @@RXVT_NAME@@ can use to get the
354Xresource data: using the X libraries (Xrm*-functions) or internal 470Xresource data: using the X libraries (Xrm*-functions) or internal
355Xresources reader (B<~/.Xdefaults>). For the first method (ie. 471Xresources reader (B<~/.Xdefaults>). For the first method (ie.
356B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 472B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
357resources using X11 tools like B<xset>. Many distribution do also load 473resources using X11 tools like B<xrdb>. Many distribution do also load
358settings from the B<~/.Xresources> file when X starts. 474settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
475will consult the following files/resources in order, with later settings
476overwriting earlier ones:
477
478 1. system-wide app-defaults file, either locale-dependent OR global
479 2. app-defaults file in $XAPPLRESDIR
480 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
481 4. SCREEN_RESOURCES for the current screen
482 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
359 483
360If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 484If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
361lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 485lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
362set in XAPPLOADDIR/URxvt (compile-time defined: usually 486set in XAPPLOADDIR/URxvt (compile-time defined: usually
363B</usr/lib/X11/app-defaults/URxvt>) and resources set in 487B</usr/lib/X11/app-defaults/URxvt>) and resources set in
408 532
409=item B<colorIT:> I<colour> 533=item B<colorIT:> I<colour>
410 534
411Use the specified colour to display bold or italic characters when the 535Use the specified colour to display bold or italic characters when the
412foreground colour is the default. If font styles are not available 536foreground colour is the default. If font styles are not available
413(Compile styles) and this option is unset, reverse video is used instead. 537(Compile I<styles>) and this option is unset, reverse video is used instead.
414 538
415=item B<colorUL:> I<colour> 539=item B<colorUL:> I<colour>
416 540
417Use the specified colour to display underlined characters when the 541Use the specified colour to display underlined characters when the
418foreground colour is the default. 542foreground colour is the default.
419 543
420=item B<colorRV:> I<colour> 544=item B<colorRV:> I<colour>
421 545
422Use the specified colour as the background for reverse video 546Use the specified colour as the background for reverse video
423characters. 547characters.
548
549=item B<underlineColor:> I<colour>
550
551If set, use the specified colour as the colour for the underline
552itself. If unset, use the foreground colour.
424 553
425=item B<cursorColor:> I<colour> 554=item B<cursorColor:> I<colour>
426 555
427Use the specified colour for the cursor. The default is to use the 556Use the specified colour for the cursor. The default is to use the
428foreground colour; option B<-cr>. 557foreground colour; option B<-cr>.
451artificial transparency. B<False>: do not inherit the parent windows' 580artificial transparency. B<False>: do not inherit the parent windows'
452pixmap. 581pixmap.
453 582
454=item B<fading:> I<number> 583=item B<fading:> I<number>
455 584
456Fade the text by the given percentage when focus is lost. 585Fade the text by the given percentage when focus is lost; option B<-fade>.
586
587=item B<fadeColor:> I<colour>
588
589Fade to this colour, when fading is used (see B<fading:>). The default
590colour is black; option B<-fadecolor>.
457 591
458=item B<tintColor:> I<colour> 592=item B<tintColor:> I<colour>
459 593
460Tint the transparent background pixmap with the given colour. 594Tint the transparent background pixmap with the given colour; option
595B<-tint>.
461 596
462=item B<shading:> I<number> 597=item B<shading:> I<number>
463 598
464Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 599Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
465image in addition to tinting it. 600image in addition to tinting it.
466 601
467=item B<fading:> I<number>
468
469Scale the tint colour by the given percentage.
470
471=item B<scrollColor:> I<colour> 602=item B<scrollColor:> I<colour>
472 603
473Use the specified colour for the scrollbar [default #B2B2B2]. 604Use the specified colour for the scrollbar [default #B2B2B2].
474 605
475=item B<troughColor:> I<colour> 606=item B<troughColor:> I<colour>
476 607
477Use the specified colour for the scrollbar's trough area [default 608Use the specified colour for the scrollbar's trough area [default
478#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 609#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479 610
480=item B<borderColor:> I<colour> 611=item B<borderColor:> I<colour>
481 612
482The colour of the border around the text area and between the scrollbar 613The colour of the border around the text area and between the scrollbar
483and the text. 614and the text.
510 641
511Select the fonts to be used. This is a comma separated list of font 642Select the fonts to be used. This is a comma separated list of font
512names that are used in turn when trying to display Unicode characters. 643names that are used in turn when trying to display Unicode characters.
513The first font defines the cell size for characters; other fonts might 644The first font defines the cell size for characters; other fonts might
514be smaller, but not larger. A reasonable default font list is always 645be smaller, but not larger. A reasonable default font list is always
515appended to it. option B<-fn>. 646appended to it; option B<-fn>.
516 647
517Each font can either be a standard X11 core font (XLFD) name, with 648Each 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:>. 649optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519 650
520In addition, each font can be prefixed with additional hints and 651In addition, each font can be prefixed with additional hints and
521specifications enclosed in square brackets (C<[]>). The only available 652specifications enclosed in square brackets (C<[]>). The only available
522hint currently is C<codeset=codeset-name>, and this is only used for Xft 653hint currently is C<codeset=codeset-name>, and this is only used for Xft
523fonts. 654fonts.
533specifies five fonts to be used. The first one is C<9x15bold> (actually 664specifies 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 665the 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 666it is named first) and thus defines the character cell grid to be 9 pixels
536wide and 15 pixels high. 667wide and 15 pixels high.
537 668
538the second font is just used to add additional unicode characters not in 669The second font is just used to add additional unicode characters not in
539the base font, likewise the third, which is unfortunately non-bold, but 670the 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 671the bold version of the font does contain less characters, so this is a
541useful supplement. 672useful supplement.
542 673
543The third font is an Xft font with aliasing turned off, and the characters 674The third font is an Xft font with aliasing turned off, and the characters
566not possible, replacement fonts of the desired shape will be tried. 697not possible, replacement fonts of the desired shape will be tried.
567 698
568If set, but empty, then this specific style is disabled and the normal 699If set, but empty, then this specific style is disabled and the normal
569text font will being used for the given style. 700text font will being used for the given style.
570 701
702=item B<intensityStyles:> I<boolean>
703
704When font styles are not enabled, or this option is enabled (B<True>,
705option B<-is>, the default), bold and italic font styles imply high
706intensity foreground/backround colours. Disabling this option (B<False>,
707option B<+is>) disables this behaviour, the high intensity colours are not
708reachable.
709
571=item B<selectstyle:> I<mode> 710=item B<selectstyle:> I<mode>
572 711
573Set mouse selection style to B<old> which is 2.20, B<oldword> which is 712Set mouse selection style to B<old> which is 2.20, B<oldword> which is
574xterm style with 2.20 old word selection, or anything else which gives 713xterm style with 2.20 old word selection, or anything else which gives
575xterm style selection. 714xterm style selection.
576 715
577=item B<scrollstyle:> I<mode> 716=item B<scrollstyle:> I<mode>
578 717
579Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 718Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580the author's favourite.. 719the author's favourite.
581 720
582=item B<title:> I<string> 721=item B<title:> I<string>
583 722
584Set window title string, the default title is the command-line 723Set window title string, the default title is the command-line
585specified after the B<-e> option, if any, otherwise the application 724specified after the B<-e> option, if any, otherwise the application
617 756
618Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 757Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 758B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620B<Shift-Print> to include the scrollback as well. 759B<Shift-Print> to include the scrollback as well.
621 760
761The string will be interpreted as if typed into the shell as-is.
762
763Example:
764
765 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766
767This creates a new file in your home directory with the screen contents
768everytime you hit C<Print>.
769
622=item B<scrollBar:> I<boolean> 770=item B<scrollBar:> I<boolean>
623 771
624B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 772B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625disable the scrollbar; option B<+sb>. 773disable the scrollbar; option B<+sb>.
626 774
645B<False>: do not scroll to bottom when tty receives output; option 793B<False>: do not scroll to bottom when tty receives output; option
646B<+si>. 794B<+si>.
647 795
648=item B<scrollWithBuffer:> I<boolean> 796=item B<scrollWithBuffer:> I<boolean>
649 797
650B<True>: scroll with scrollback buffer when tty recieves new lines (and 798B<True>: scroll with scrollback buffer when tty receives new lines (and
651B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 799B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652with scrollback buffer when tty recieves new lines; option B<-sw>. 800with scrollback buffer when tty recieves new lines; option B<+sw>.
653 801
654=item B<scrollTtyKeypress:> I<boolean> 802=item B<scrollTtyKeypress:> I<boolean>
655 803
656B<True>: scroll to bottom when a non-special key is pressed. Special keys 804B<True>: scroll to bottom when a non-special key is pressed. Special keys
657are those which are intercepted by rxvt-unicode for special handling and 805are those which are intercepted by rxvt-unicode for special handling and
696=item B<mouseWheelScrollPage:> I<boolean> 844=item B<mouseWheelScrollPage:> I<boolean>
697 845
698B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 846B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699scrolls five lines [default]. 847scrolls five lines [default].
700 848
849=item B<pastableTabs:> I<boolean>
850
851B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
852movement only; option C<-ptab>.
853
701=item B<cursorBlink:> I<boolean> 854=item B<cursorBlink:> I<boolean>
702 855
703B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 856B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704option B<-bc>. 857option B<-bc>.
705 858
717 870
718Mouse pointer background colour. 871Mouse pointer background colour.
719 872
720=item B<pointerBlankDelay:> I<number> 873=item B<pointerBlankDelay:> I<number>
721 874
722Specifies number of seconds before blanking the pointer [default 2]. 875Specifies number of seconds before blanking the pointer [default 2]. Use a
876large number (e.g. C<987654321>) to effectively disable the timeout.
723 877
724=item B<backspacekey:> I<string> 878=item B<backspacekey:> I<string>
725 879
726The string to send when the backspace key is pressed. If set to B<DEC> 880The string to send when the backspace key is pressed. If set to B<DEC>
727or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 881or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
749 903
750I<name> of inputMethod to use; option B<-im>. 904I<name> of inputMethod to use; option B<-im>.
751 905
752=item B<imLocale:> I<name> 906=item B<imLocale:> I<name>
753 907
754The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 908The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 909C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756extension to be able to input japanese characters while staying in 910input extension to be able to input japanese characters while staying in
757another locale. option B<-imlocale>. 911another locale; option B<-imlocale>.
912
913=item B<imFont:> I<fontset>
914
915Specify the font-set used for XIM styles C<OverTheSpot> or
916C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
917by commas), i.e. it's not in the same format as the other font lists used
918in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
919found, preferably one or two pixels differing in size to the base font.
920option B<-imfont>.
921
922=item B<tripleclickwords:> I<boolean>
923
924Change the meaning of triple-click selection with the left mouse
925button. Instead of selecting a full line it will extend the selection to
926the end of the logical line only; option B<-tcw>.
758 927
759=item B<insecure:> I<boolean> 928=item B<insecure:> I<boolean>
760 929
761Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 930Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762echo arbitrary strings like the icon name or the locale. This could be 931echo arbitrary strings like the icon name or the locale. This could be
763abused if somebody gets 8-bit-clean access to your display, wether 932abused if somebody gets 8-bit-clean access to your display, whether
764throuh a mail client displaying mail bodies unfiltered or though 933through a mail client displaying mail bodies unfiltered or through
765write(1). Therefore, these sequences are disabled by default. (Note 934write(1) or any other means. Therefore, these sequences are disabled by
766that other terminals, including xterm, have these sequences 935default. (Note that many other terminals, including xterm, have these
767enabled by default). You can enable them by setting this boolean 936sequences enabled by default, which doesn't make it safer, though).
768resource or specifying B<-insecure> as an option. At the moment, this 937
769enabled display-answer, locale, findfont, icon label and window title 938You can enable them by setting this boolean resource or specifying
770requests as well as dynamic menubar dispatch. 939B<-insecure> as an option. At the moment, this enables display-answer,
940locale, findfont, icon label and window title requests as well as dynamic
941menubar dispatch.
771 942
772=item B<modifier:> I<modifier> 943=item B<modifier:> I<modifier>
773 944
774Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 945Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
775B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 946B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
790Turn on/off secondary screen scroll (default enabled). If the this 961Turn on/off secondary screen scroll (default enabled). If the this
791option is enabled, scrolls on the secondary screen will change the 962option is enabled, scrolls on the secondary screen will change the
792scrollback buffer and switching to/from the secondary screen will 963scrollback buffer and switching to/from the secondary screen will
793instead scroll the screen up. 964instead scroll the screen up.
794 965
966=item B<hold>: I<bool>
967
968Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969will not immediately destroy its window when the program executed within
970it exits. Instead, it will wait till it is being killed or closed by the
971user.
972
795=item B<keysym.>I<sym>: I<string> 973=item B<keysym.>I<sym>: I<string>
796 974
797Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 975Compile I<frills>: Associate I<string> with keysym I<sym>. The
798contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 976intervening resource name B<keysym.> cannot be omitted.
799newline, \r: return, \t: 977
978The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
979any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
980B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
981and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
982B<2>, B<3>, B<4>, B<5>.
983
984The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
985whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
986keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
987current application keymap mode state.
988
989The spellings of I<key> can be obtained by using B<xev>(1) command or
990searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
991omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
992keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
993performed in an exact manner; however, the closest match is assured.
994
995I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
996C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
800tab, \000: octal number) or control characters (^?: delete, ^@: null, 997C<\000>: octal number) or verbatim control characters (C<^?>: delete,
801^A ...) and may enclosed with double quotes so that it can start or end 998C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
802with whitespace. The intervening resource name B<keysym.> cannot be 999can start or end with whitespace.
803omitted. This resource is only available when compiled with 1000
804KEYSYM_RESOURCE. 1001Please note that you need to double the C<\> when using
1002C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1003use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1004@@RXVT_NAME@@'s own processing).
1005
1006You can define a range of keysyms in one shot by providing a I<string>
1007with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1008should be a character not used by the strings.
1009
1010Its usage can be demonstrated by an example:
1011
1012 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1013
1014The above line is equivalent to the following three lines:
1015
1016 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1017 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1018 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1019
1020If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1021is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1022example the following means "change the current locale to C<zh_CN.GBK>
1023when Control-Meta-c is being pressed":
1024
1025 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1026
1027If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1028is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1029manpage. For example, the F<selection> extension (activated via
1030C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1031
1032 URxvt.keysym.M-C-c: perl:selection:rot13
1033
1034Due the the large number of modifier combinations, a defined key mapping
1035will match if at I<at least> the specified identifiers are being set, and
1036no other key mappings with those and more bits are being defined. That
1037means that defining a key map for C<a> will automatically provide
1038definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1039mappings themselves.
1040
1041Unfortunately, this will override built-in key mappings. For example
1042if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1043C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1044user-defined keymap using the C<builtin:> replacement:
1045
1046 URxvt.keysym.Insert: <my insert key sequence>
1047 URxvt.keysym.S-Insert: builtin:
1048
1049The first line defines a mapping for C<Insert> and I<any> combination
1050of modifiers. The second line re-establishes the default mapping for
1051C<Shift-Insert>.
1052
1053The following example will map Control-Meta-1 and Control-Meta-2 to
1054the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1055font-switching at runtime:
1056
1057 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1058 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1059
1060Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1061info):
1062
1063 URxvt.keysym.M-C-3: command:\033[8;25;80t
1064 URxvt.keysym.M-C-4: command:\033[8;48;110t
1065
1066=item B<perl-ext>: I<string>
1067
1068Colon-separated list of perl extension scripts to use in this terminal
1069instance. Each extension is looked up in the library directories, loaded
1070if necessary, and bound to the current terminal instance; option B<-pe>.
1071
1072=item B<perl-eval>: I<string>
1073
1074Perl code to be evaluated when all extensions have been registered. See the
1075@@RXVT_NAME@@perl(3) manpage.
1076
1077=item B<perl-lib>: I<path>
1078
1079Colon-separated list of additional directories that hold extension
1080scripts. When looking for extensions specified by the C<perl> resource,
1081@@RXVT_NAME@@ will first look in these directories and then in
1082F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1083
1084See the @@RXVT_NAME@@perl(3) manpage.
805 1085
806=back 1086=back
807 1087
808=head1 THE SCROLLBAR 1088=head1 THE SCROLLBAR
809 1089
823the normal text selection/insertion, hold either the Shift or the Meta 1103the normal text selection/insertion, hold either the Shift or the Meta
824(Alt) key while performing the desired mouse action. 1104(Alt) key while performing the desired mouse action.
825 1105
826If mouse reporting mode is active, the normal scrollbar actions are 1106If mouse reporting mode is active, the normal scrollbar actions are
827disabled -- on the assumption that we are using a fullscreen 1107disabled -- on the assumption that we are using a fullscreen
828application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1108application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1109(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1110up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831respectively. 1111respectively.
832 1112
833=head1 TEXT SELECTION AND INSERTION 1113=head1 TEXT SELECTION AND INSERTION
834 1114
835The behaviour of text selection and insertion mechanism is similar to 1115The behaviour of text selection and insertion mechanism is similar to
837 1117
838=over 4 1118=over 4
839 1119
840=item B<Selection>: 1120=item B<Selection>:
841 1121
842Left click at the beginning of the region, drag to the end of the 1122Left click at the beginning of the region, drag to the end of the region
843region and release; Right click to extend the marked region; Left 1123and release; Right click to extend the marked region; Left double-click
844double-click to select a word; Left triple-click to select the entire 1124to select a word; Left triple-click to select the entire logical line
845line. 1125(which can span multiple screen lines), unless modified by resource
1126B<tripleclickwords>.
1127
1128Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1129(Compile: I<frills>) will create a rectangular selection instead of a
1130normal one. In this mode, every selected row becomes its own line in the
1131selection, and trailing whitespace is visually underlined and removed from
1132the selection.
846 1133
847=item B<Insertion>: 1134=item B<Insertion>:
848 1135
849Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1136Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
850an B<@@RXVT_NAME@@> window causes the current text selection to be 1137an B<@@RXVT_NAME@@> window causes the current text selection to be
858supported in rxvt-unicode. Bug me if you need this. 1145supported in rxvt-unicode. Bug me if you need this.
859 1146
860You can, however, switch fonts at runtime using escape sequences (and 1147You can, however, switch fonts at runtime using escape sequences (and
861therefore using the menubar), e.g.: 1148therefore using the menubar), e.g.:
862 1149
863 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1150 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
864 1151
865rxvt-unicode will automatically re-apply these fonts to the output so far. 1152rxvt-unicode will automatically re-apply these fonts to the output so far.
866 1153
867=head1 ISO 14755 SUPPORT 1154=head1 ISO 14755 SUPPORT
868 1155
872C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1159C<--enable-frills>, the rest is available when rxvt-unicode was compiled
873with C<--enable-iso14755>. 1160with C<--enable-iso14755>.
874 1161
875=over 4 1162=over 4
876 1163
877=item 5.1: Basic method 1164=item * 5.1: Basic method
878 1165
879This allows you to enter unicode characters using their hexcode. 1166This allows you to enter unicode characters using their hexcode.
880 1167
881Start by pressing and holding both C<Control> and C<Shift>, then enter 1168Start by pressing and holding both C<Control> and C<Shift>, then enter
882hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1169hex-digits (between one and six). Releasing C<Control> and C<Shift> will
889address, which you cannot type. Fortunately, the card has the e-mail 1176address, which you cannot type. Fortunately, the card has the e-mail
890address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1177address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
891by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1178by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
892followed by releasing the modifier keys. 1179followed by releasing the modifier keys.
893 1180
894=item 5.2: Keyboard symbols entry method 1181=item * 5.2: Keyboard symbols entry method
895 1182
896This mode lets you input characters representing the keycap symbols of 1183This mode lets you input characters representing the keycap symbols of
897your keyboard, if representable in the current locale encoding. 1184your keyboard, if representable in the current locale encoding.
898 1185
899Start by pressing C<Control> and C<Shift> together, then releasing 1186Start by pressing C<Control> and C<Shift> together, then releasing
900them. The next special key (cursor keys, home etc.) you enter will not 1187them. The next special key (cursor keys, home etc.) you enter will not
901invoke it's usual function but instead will insert the corresponding 1188invoke it's usual function but instead will insert the corresponding
902keycap symbol. The symbol will only be entered when the key has been 1189keycap symbol. The symbol will only be entered when the key has been
903released, otherwise pressing e.g. C<Shift> would enter the symbol for 1190released, otherwise pressing e.g. C<Shift> would enter the symbol for
904C<ISO Level 2 Switch>, although your intention might have beenm to enter a 1191C<ISO Level 2 Switch>, although your intention might have been to enter a
905reverse tab (Shift-Tab). 1192reverse tab (Shift-Tab).
906 1193
907=item 5.3: Screen-selection entry method 1194=item * 5.3: Screen-selection entry method
908 1195
909While this is implemented already (it's basically the selection 1196While this is implemented already (it's basically the selection
910mechanism), it could be extended by displaying a unicode character map. 1197mechanism), it could be extended by displaying a unicode character map.
911 1198
912=item 5.4: Feedback method for identifying displayed characters for later input 1199=item * 5.4: Feedback method for identifying displayed characters for later input
913 1200
914This method lets you display the unicode character code associated with 1201This method lets you display the unicode character code associated with
915characters already displayed. 1202characters already displayed.
916 1203
917You enter this mode by holding down C<Control> and C<Shift> together, then 1204You enter this mode by holding down C<Control> and C<Shift> together, then
929With respect to conformance, rxvt-unicode is supposed to be compliant to 1216With respect to conformance, rxvt-unicode is supposed to be compliant to
930both scenario A and B of ISO 14755, including part 5.2. 1217both scenario A and B of ISO 14755, including part 5.2.
931 1218
932=head1 LOGIN STAMP 1219=head1 LOGIN STAMP
933 1220
934B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1221B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
935that it can be seen via the I<who(1)> command, and can accept messages. 1222it can be seen via the I<who(1)> command, and can accept messages. To
936To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1223allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
937some systems. 1224on some systems or setgid to root or to some other group on others.
938 1225
939=head1 COLORS AND GRAPHICS 1226=head1 COLORS AND GRAPHICS
940 1227
941In addition to the default foreground and background colours, 1228In addition to the default foreground and background colours,
942B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1229B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
983would yield White on Black, while on I<xterm>(1) it would yield Black 1270would yield White on Black, while on I<xterm>(1) it would yield Black
984on White. 1271on White.
985 1272
986=back 1273=back
987 1274
988=head1 FREQUENTLY ASKED QUESTIONS (FAQ) 1275=head1 ENVIRONMENT
1276
1277B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
989 1278
990=over 4 1279=over 4
991 1280
992=item How do I know which rxvt-unicode version I'm using? 1281=item B<TERM>
993 1282
994The version number is displayed with the usage (-h). Also the escape 1283Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
995sequence C<ESC[8n> sets the window title to the version number. 1284resources or on the commandline.
996 1285
997=item When I log-in to another system it tells me about missing terminfo data? 1286=item B<COLORTERM>
998 1287
999The terminal description used by rxvt-unicode is not as widely available 1288Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1000as that for xterm, or even rxvt (for which the same problem often arises). 1289compiled with XPM support, and optionally with the added extension
1290C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1001 1291
1002The correct solution for this problem is to install the terminfo, this can be done 1292=item B<COLORFGBG>
1003like this:
1004 1293
1005 infocmp rxvt-unicode >rxvt.unicode.tic 1294Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1006 scp rxvt-unicode.tic remotesystem: 1295the colour code used as default foreground/text colour (or the string
1007 ssh remotesystem tic rxvt-unicode.tic 1296C<default> to indicate that the default-colour escape sequence is to be
1008 1297used), C<bg> is the colour code used as default background colour (or the
1009... or by installing rxvt-unicode normally on the remote system, 1298string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1299was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1300(and do) use this information to optimize screen output.
1010 1301
1011If you cannot or do not want to do this, then you can simply set 1302=item B<WINDOWID>
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 1303
1017If you always want to do this you can either recompile rxvt-unicode with 1304Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1018the desired TERM value or use a resource to set it: 1305window, which usually has subwindows for the scrollbar, the terminal
1306window and so on).
1019 1307
1020 URxvt.termName: rxvt 1308=item B<TERMINFO>
1021 1309
1022=item How can I configure rxvt-unicode so that it looks similar to the original rxvt? 1310Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1311C<--with-terminfo=PATH>.
1023 1312
1024Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode 1313=item B<DISPLAY>
1025behave similar to the original rxvt:
1026 1314
1027 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1 1315Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1028 URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1 1316display in it's child processes.
1029 1317
1030=item Rxvt-unicode does not seem to understand the selected encoding? 1318=item B<SHELL>
1031 1319
1032=item Unicode does not seem to work? 1320The shell to be used for command execution, defaults to C</bin/sh>.
1033 1321
1034If you encounter strange problems like typing an accented character but 1322=item B<RXVTPATH>
1035getting two unrelated other characters or similar, or if program output is
1036subtly garbled, then you should check your locale settings.
1037 1323
1038Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 1324The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1039programs. Often rxvt-unicode is started in the C<C> locale, while the 1325files.
1040login script running within the rxvt-unicode window changes the locale to
1041sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
1042 1326
1043The best thing is to fix your startup environment, as you will likely run 1327=item B<PATH>
1044into other problems. If nothing works you can try this in your .profile.
1045 1328
1046 printf '\e]701;%s\007' "$LC_CTYPE" 1329Used in the same way as C<RXVTPATH>.
1047 1330
1048If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 1331=item B<RXVT_SOCKET>
1049supported on your systems. Some systems have a C<locale> comamnd which
1050displays this. If it displays sth. like:
1051 1332
1052 locale: Cannot set LC_CTYPE to default locale: ... 1333The unix domain socket path used by @@RXVT_NAME@@c(1) and
1334@@RXVT_NAME@@d(1).
1053 1335
1054Then the locale you specified is not supported on your system. 1336Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1055 1337
1056If nothing works and you are sure that everything is set correctly then 1338=item B<HOME>
1057you will need to remember a little known fact: Some programs just don't
1058support locales :(
1059 1339
1060=item Why do the characters look ugly? 1340Used to locate the default directory for the unix domain socket for
1341daemon communications and to locate various resource files (such as
1342C<.Xdefaults>)
1061 1343
1062=item How does rxvt-unicode choose fonts? 1344=item B<XAPPLRESDIR>
1063 1345
1064Most fonts do not contain the full range of Unicode, which is 1346Directory where various X resource files are being located.
1065fine. Chances are that the font you (or the admin/package maintainer of
1066your system/os) have specified does not cover all the characters you want
1067to display.
1068 1347
1069B<rxvt-unicode> makes a best-effort try at finding a replacement 1348=item B<XENVIRONMENT>
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 1349
1076In that case, select a font of your taste and add it to the font list, 1350If set and accessible, gives the name of a X resource file to be loaded by
1077e.g.:
1078
1079 @@RXVT_NAME@@ -fn basefont,font2,font3...
1080
1081When rxvt-unicode sees a character, it will first look at the base
1082font. If the base font does not contain the character, it will go to the
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.
1085
1086The only limitation is that all the fonts must not be larger than the base
1087font, as the base font defines the principial cell size, which must be the
1088same due to the way terminals work.
1089
1090=item Why do some chinese characters look so different than others?
1091
1092This is because there is a difference between script and language --
1093rxvt-unicode does not know which language the text that is output
1094is, as it only knows the unicode character codes. If rxvt-unicode
1095first sees a japanese character, it might choose a japanese font for
1096it. Subseqzuent japanese characters will take that font. Now, many chinese
1097characters aren't represented in japanese fonts, so when the first
1098non-japanese character comes up, rxvt-unicode will look for a chinese font
1099-- unfortunately at this point, it will still use the japanese font for
1100japanese characters that are also chinese.
1101
1102The workaround is easy: just tag a chinese font at the end of your font
1103list (see the previous question). The key is to view the font list as
1104a preference list: If you expect more japanese, list a japanese font
1105first. If you expect more chinese, put a chinese font first.
1106
1107In the future it might be possible to switch preferences at runtime (the
1108internal data structure has no problem with using different fonts for
1109the same character at the same time, but no interface for this has been
1110designed yet).
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
1134=item How does rxvt-unicode determine the encoding to use?
1135
1136=item Is there an option to switch encodings?
1137
1138Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1139specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
1140UTF-8 or any other encodings with respect to terminal I/O.
1141
1142The reasons is that there exists a perfectly fine mechanism for selecting
1143the encoding, doing I/O and (most important) communicating this to all
1144applications so everybody agrees on character properties such as width and
1145code number. This mechanism is the I<locale>.
1146
1147Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1148programs doing the same (that is, most) will automatically agree in the
1149interpretation of characters.
1150
1151Unfortunately, there is no system-independent way to select locales, nor
1152is there a standard on how locale specifiers will look like.
1153
1154On most systems, the content of the C<LC_CTYPE> environment variable
1155contains an arbitrary string which corresponds to an already-installed
1156locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1157C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1158(i.e. C<de> or C<german>) are also common.
1159
1160Rxvt-unicode ignores all other locale categories, and except for
1161the encoding, ignores country or language-specific settings,
1162i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
1163
1164If you want to use a specific encoding you have to make sure you start
1165rxvt-unicode with the correct C<LC_CTYPE> category.
1166
1167=item Can I switch locales at runtime?
1168
1169Yes, using an escape sequence. Try sth. like this, which sets
1170rxvt-unicode's idea of C<LC_CTYPE>.
1171
1172 printf '\e]701;%s\007' ja_JP.SJIS
1173
1174See also the previous question.
1175
1176Sometimes this capability is rather handy when you want to work in one
1177locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
1178example, I use this script to start C<xjdic>, which first switches to a
1179locale supported by xjdic and back later:
1180
1181 printf '\e]701;%s\007' ja_JP.SJIS
1182 xjdic -js
1183 printf '\e]701;%s\007' de_DE.UTF-8
1184
1185=item Can I switch the fonts at runtime?
1186
1187Yes, using an escape sequence. Try sth. like this, which has the same
1188effect as using the C<-fn> switch, and takes effect immediately:
1189
1190 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
1191
1192This is useful if you e.g. work primarily with japanese (and prefer a
1193japanese font), but you have to switch to chinese temporarily, where
1194japanese fonts would only be in your way.
1195
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.
1251
1252=item Mouse cut/paste suddenly no longer works.
1253
1254Make sure that mouse reporting is actually turned off since killing
1255some editors prematurely may leave the mouse in mouse report mode. I've
1256heard that tcsh may use mouse reporting unless it otherwise specified. A
1257quick check is to see if cut/paste works when the Alt or Shift keys are
1258depressed. See @@RXVT_NAME@@(7)
1259
1260=item What's with this bold/blink stuff?
1261
1262If no bold colour is set via C<colorBD:>, bold will invert text using the
1263standard foreground colour.
1264
1265For the standard background colour, blinking will actually make the
1266text blink when compiled with C<--enable-blinking>. with standard
1267colours. Without C<--enable-blinking>, the blink attribute will be
1268ignored.
1269
1270On ANSI colours, bold/blink attributes are used to set high-intensity
1271foreground/background colors.
1272
1273color0-7 are the low-intensity colors.
1274
1275color8-15 are the corresponding high-intensity colors.
1276
1277=item I don't like the screen colors. How do I change them?
1278
1279You can change the screen colors at run-time using F<~/.Xdefaults>
1280resources (or as long-options).
1281
1282Here are values that are supposed to resemble a VGA screen,
1283including the murky brown that passes for low-intensity yellow:
1284
1285 Rxvt*color0: #000000
1286 Rxvt*color1: #A80000
1287 Rxvt*color2: #00A800
1288 Rxvt*color3: #A8A800
1289 Rxvt*color4: #0000A8
1290 Rxvt*color5: #A800A8
1291 Rxvt*color6: #00A8A8
1292 Rxvt*color7: #A8A8A8
1293
1294 Rxvt*color8: #000054
1295 Rxvt*color9: #FF0054
1296 Rxvt*color10: #00FF54
1297 Rxvt*color11: #FFFF54
1298 Rxvt*color12: #0000FF
1299 Rxvt*color13: #FF00FF
1300 Rxvt*color14: #00FFFF
1301 Rxvt*color15: #FFFFFF
1302
1303=item What's with the strange Backspace/Delete key behaviour?
1304
1305Assuming that the physical Backspace key corresponds to the
1306BackSpace keysym (not likely for Linux ... see the following
1307question) there are two standard values that can be used for
1308Backspace: C<^H> and C<^?>.
1309
1310Historically, either value is correct, but rxvt-unicode adopts the debian
1311policy of using C<^?> when unsure, because it's the one only only correct
1312choice :).
1313
1314Rxvt-unicode tries to inherit the current stty settings and uses the value
1315of `erase' to guess the value for backspace. If rxvt-unicode wasn't
1316started from a terminal (say, from a menu or by remote shell), then the
1317system value of `erase', which corresponds to CERASE in <termios.h>, will
1318be used (which may not be the same as your stty setting).
1319
1320For starting a new rxvt-unicode:
1321
1322 # use Backspace = ^H
1323 $ stty erase ^H
1324 $ @@RXVT_NAME@@ 1351@@RXVT_NAME@@.
1325
1326 # use Backspace = ^?
1327 $ stty erase ^?
1328 $ @@RXVT_NAME@@
1329
1330Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1331
1332For an existing rxvt-unicode:
1333
1334 # use Backspace = ^H
1335 $ stty erase ^H
1336 $ echo -n "^[[36h"
1337
1338 # use Backspace = ^?
1339 $ stty erase ^?
1340 $ echo -n "^[[36l"
1341
1342This helps satisfy some of the Backspace discrepancies that occur, but
1343if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1344properly reflects that.
1345
1346The Delete key is a another casualty of the ill-defined Backspace problem.
1347To avoid confusion between the Backspace and Delete keys, the Delete
1348key has been assigned an escape sequence to match the vt100 for Execute
1349(ESC[3~) and is in the supplied termcap/terminfo.
1350
1351Some other Backspace problems:
1352
1353some editors use termcap/terminfo,
1354some editors (vim I'm told) expect Backspace = ^H,
1355GNU Emacs (and Emacs-like editors) use ^H for help.
1356
1357Perhaps someday this will all be resolved in a consistent manner.
1358
1359=item I don't like the key-bindings. How do I change them?
1360
1361There are some compile-time selections available via configure. Unless
1362you have run "configure" with the C<--disable-resources> option you can
1363use the `keysym' resource to alter the keystrings associated with keysym
13640xFF00 - 0xFFFF (function, cursor keys, etc).
1365
1366Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1367
1368 !# ----- special uses ------:
1369 ! tn3270 login, remap function and arrow keys.
1370 tn3270*font: *clean-bold-*-*--15-*
1371
1372 ! keysym - used by rxvt only
1373 ! Delete - ^D
1374 tn3270*keysym.0xFFFF: \004
1375
1376 ! Home - ^A
1377 tn3270*keysym.0xFF50: \001
1378 ! Left - ^B
1379 tn3270*keysym.0xFF51: \002
1380 ! Up - ^P
1381 tn3270*keysym.0xFF52: \020
1382 ! Right - ^F
1383 tn3270*keysym.0xFF53: \006
1384 ! Down - ^N
1385 tn3270*keysym.0xFF54: \016
1386 ! End - ^E
1387 tn3270*keysym.0xFF57: \005
1388
1389 ! F1 - F12
1390 tn3270*keysym.0xFFBE: \e1
1391 tn3270*keysym.0xFFBF: \e2
1392 tn3270*keysym.0xFFC0: \e3
1393 tn3270*keysym.0xFFC1: \e4
1394 tn3270*keysym.0xFFC2: \e5
1395 tn3270*keysym.0xFFC3: \e6
1396 tn3270*keysym.0xFFC4: \e7
1397 tn3270*keysym.0xFFC5: \e8
1398 tn3270*keysym.0xFFC6: \e9
1399 tn3270*keysym.0xFFC7: \e0
1400 tn3270*keysym.0xFFC8: \e-
1401 tn3270*keysym.0xFFC9: \e=
1402
1403 ! map Prior/Next to F7/F8
1404 tn3270*keysym.0xFF55: \e7
1405 tn3270*keysym.0xFF56: \e8
1406
1407=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1408How do I make use of them? For example, the Sun Keyboard type 4
1409has the following mappings that rxvt-unicode doesn't recognize.
1410
1411 KP_Insert == Insert
1412 F22 == Print
1413 F27 == Home
1414 F29 == Prior
1415 F33 == End
1416 F35 == Next
1417
1418Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1419mappings, it is better to use `xmodmap' to remap the keys as required for
1420your particular machine.
1421
1422=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1423I need this to decide about setting colors etc.
1424
1425rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1426check and see if that is set. Note that several programs, JED, slrn,
1427Midnight Commander automatically check this variable to decide whether or
1428not to use color.
1429
1430=item How do I set the correct, full IP address for the DISPLAY variable?
1431
1432If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1433insecure mode then it is possible to use the following shell script
1434snippets to correctly set the display. If your version of rxvt-unicode
1435wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1436the COLORTERM variable can be used to distinguish rxvt-unicode from a
1437regular xterm.
1438
1439Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1440snippets:
1441
1442 # Bourne/Korn/POSIX family of shells:
1443 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1444 if [ ${TERM:-foo} = xterm ]; then
1445 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1446 echo -n '^[Z'
1447 read term_id
1448 stty icanon echo
1449 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1450 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1451 read DISPLAY # set it in our local shell
1452 fi
1453 fi
1454
1455=item How do I compile the manual pages for myself?
1456
1457You need to have a recent version of perl installed as F</usr/bin/perl>,
1458one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1459the doc subdirectory and enter C<make alldoc>.
1460 1352
1461=back 1353=back
1462 1354
1463=head1 ENVIRONMENT
1464
1465B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1466and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1467window id number of the B<@@RXVT_NAME@@> window and it also uses and
1468sets the environment variable B<DISPLAY> to specify which display
1469terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1470B<RXVTPATH> and B<PATH> to find XPM files.
1471
1472=head1 FILES 1355=head1 FILES
1473 1356
1474=over 4 1357=over 4
1475 1358
1476=item B</etc/utmp>
1477
1478System file for login records.
1479
1480=item B</usr/lib/X11/rgb.txt> 1359=item B</usr/lib/X11/rgb.txt>
1481 1360
1482Color names. 1361Color names.
1483 1362
1484=back 1363=back
1485 1364
1486=head1 SEE ALSO 1365=head1 SEE ALSO
1487 1366
1488@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1367@@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)
1489
1490=head1 BUGS
1491
1492Check the BUGS file for an up-to-date list.
1493
1494Cursor change support is not yet implemented.
1495
1496Click-and-drag doesn't work with X11 mouse report overriding.
1497 1368
1498=head1 CURRENT PROJECT COORDINATOR 1369=head1 CURRENT PROJECT COORDINATOR
1499 1370
1500=over 4 1371=over 4
1501 1372
1502=item Project Coordinator 1373=item Project Coordinator
1503 1374
1504@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1375Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1505 1376
1506=item Web page maintainter 1377L<http://software.schmorp.de/#rxvt-unicode>
1507
1508@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1509
1510L<@@RXVT_WEBPAGE@@>
1511 1378
1512=back 1379=back
1513 1380
1514=head1 AUTHORS 1381=head1 AUTHORS
1515 1382
1540=item Geoff Wing L<< <gcw@pobox.com> >> 1407=item Geoff Wing L<< <gcw@pobox.com> >>
1541 1408
1542Rewrote screen display and text selection routines. Project Coordinator 1409Rewrote screen display and text selection routines. Project Coordinator
1543(changes.txt 2.4.6 - rxvt-unicode) 1410(changes.txt 2.4.6 - rxvt-unicode)
1544 1411
1545=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1412=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1546 1413
1547Forked rxvt-unicode, rewrote most of the display code and internal 1414Forked rxvt-unicode, rewrote most of the display code and internal
1548character handling to store text in unicode, improve xterm 1415character handling to store text in unicode, improve xterm
1549compatibility and apply numerous other bugfixes and extensions. 1416compatibility and apply numerous other bugfixes and extensions.
1550 1417

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines