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.35 by root, Wed Dec 15 00:53:23 2004 UTC vs.
Revision 1.77 by root, Mon Jan 2 19:36:07 2006 UTC

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 16
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 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>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
103 105
104=item B<-j>|B<+j> 106=item B<-j>|B<+j>
105 107
106Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
107 109
108=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
109 111
110Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
112 114
113=item B<-fade> I<number> 115=item B<-fade> I<number>
114 116
115Fade 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>.
116 125
117=item B<-tint> I<colour> 126=item B<-tint> I<colour>
118 127
119Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
120transparency 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
121option 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
122tinting 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
123 135
124=item B<-sh> 136=item B<-sh>
125 137
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background 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
128specified, too). 140specified, too, e.g. C<-tint white>).
129 141
130=item B<-bg> I<colour> 142=item B<-bg> I<colour>
131 143
132Window background colour; resource B<background>. 144Window background colour; resource B<background>.
133 145
136Window foreground colour; resource B<foreground>. 148Window foreground colour; resource B<foreground>.
137 149
138=item B<-pixmap> I<file[;geom]> 150=item B<-pixmap> I<file[;geom]>
139 151
140Compile I<XPM>: Specify XPM file for the background and also optionally 152Compile I<XPM>: Specify XPM file for the background and also optionally
141specify its scaling with a geometry string. Note you may need to add 153specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 154add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 155command-line; resource B<backgroundPixmap>.
144 156
145=item B<-cr> I<colour> 157=item B<-cr> I<colour>
146 158
147The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
190=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
191 203
192Compile 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
193be printed. See resource B<boldItalicFont> for details. 205be printed. See resource B<boldItalicFont> for details.
194 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.
212
195=item B<-name> I<name> 213=item B<-name> I<name>
196 214
197Specify the application name under which resources are to be obtained, 215Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 216rather than the default executable file name. Name should not contain
199`.' or `*' characters. Also sets the icon and title name. 217`.' or `*' characters. Also sets the icon and title name.
236 254
237Put scrollbar on right/left; resource B<scrollBar_right>. 255Put scrollbar on right/left; resource B<scrollBar_right>.
238 256
239=item B<-st>|B<+st> 257=item B<-st>|B<+st>
240 258
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 259Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 260resource B<scrollBar_floating>.
243 261
244=item B<-ptab>|B<+ptab> 262=item B<-ptab>|B<+ptab>
245 263
246If enabled (default), "Horizontal Tab" characters are being stored as 264If enabled (default), "Horizontal Tab" characters are being stored as
280if 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
281decorations; resource B<borderLess>. 299decorations; resource B<borderLess>.
282 300
283=item B<-lsp> I<number> 301=item B<-lsp> I<number>
284 302
285Compile I<linespace>: Lines (pixel height) to insert between each row 303Compile I<frills>: Lines (pixel height) to insert between each row of
286of the display; resource B<linespace>. 304the display. Useful to work around font rendering problems; resource
305B<linespace>.
287 306
288=item B<-tn> I<termname> 307=item B<-tn> I<termname>
289 308
290This 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
291B<TERM> environment variable. This terminal type must exist in the 310B<TERM> environment variable. This terminal type must exist in the
300given 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
301on 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
302run the program specified by the B<SHELL> environment variable or, 321run the program specified by the B<SHELL> environment variable or,
303failing that, I<sh(1)>. 322failing that, I<sh(1)>.
304 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
305=item B<-title> I<text> 329=item B<-title> I<text>
306 330
307Window title (B<-T> still respected); the default title is the basename 331Window title (B<-T> still respected); the default title is the basename
308of 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
309application name; resource B<title>. 333application name; resource B<title>.
327 351
328Compile I<XIM>: input method name. resource B<inputMethod>. 352Compile I<XIM>: input method name. resource B<inputMethod>.
329 353
330=item B<-imlocale> I<string> 354=item B<-imlocale> I<string>
331 355
332The 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.
333de_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
334extension to be able to input japanese characters while staying in 358input extension to be able to input japanese characters while staying in
335another 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>.
336 371
337=item B<-insecure> 372=item B<-insecure>
338 373
339Enable "insecure" mode, which currently enables most of the escape 374Enable "insecure" mode, which currently enables most of the escape
340sequences that echo strings. See the resource B<insecure> for more 375sequences that echo strings. See the resource B<insecure> for more
354=item B<-ssr>|B<+ssr> 389=item B<-ssr>|B<+ssr>
355 390
356Turn on/off secondary screen scroll (default enabled); resource 391Turn on/off secondary screen scroll (default enabled); resource
357B<secondaryScroll>. 392B<secondaryScroll>.
358 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
359=item B<-xrm> I<resourcestring> 458=item B<-perl> I<string>
360 459
361No effect on rxvt-unicode. Simply passes through an argument to be made 460Used by perl extension. See resource B<perl>.
362available in the instance's argument list. Appears in I<WM_COMMAND> in
363some window managers.
364 461
365=back 462=back
366 463
367=head1 RESOURCES (available also as long-options) 464=head1 RESOURCES (available also as long-options)
368 465
371 468
372There 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
373Xresource data: using the X libraries (Xrm*-functions) or internal 470Xresource data: using the X libraries (Xrm*-functions) or internal
374Xresources reader (B<~/.Xdefaults>). For the first method (ie. 471Xresources reader (B<~/.Xdefaults>). For the first method (ie.
375B<@@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
376resources using X11 tools like B<xset>. Many distribution do also load 473resources using X11 tools like B<xrdb>. Many distribution do also load
377settings 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>
378 483
379If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 484If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
380lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 485lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
381set in XAPPLOADDIR/URxvt (compile-time defined: usually 486set in XAPPLOADDIR/URxvt (compile-time defined: usually
382B</usr/lib/X11/app-defaults/URxvt>) and resources set in 487B</usr/lib/X11/app-defaults/URxvt>) and resources set in
427 532
428=item B<colorIT:> I<colour> 533=item B<colorIT:> I<colour>
429 534
430Use the specified colour to display bold or italic characters when the 535Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 536foreground colour is the default. If font styles are not available
432(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.
433 538
434=item B<colorUL:> I<colour> 539=item B<colorUL:> I<colour>
435 540
436Use the specified colour to display underlined characters when the 541Use the specified colour to display underlined characters when the
437foreground colour is the default. 542foreground colour is the default.
475artificial transparency. B<False>: do not inherit the parent windows' 580artificial transparency. B<False>: do not inherit the parent windows'
476pixmap. 581pixmap.
477 582
478=item B<fading:> I<number> 583=item B<fading:> I<number>
479 584
480Fade 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>.
481 591
482=item B<tintColor:> I<colour> 592=item B<tintColor:> I<colour>
483 593
484Tint the transparent background pixmap with the given colour. 594Tint the transparent background pixmap with the given colour; option
595B<-tint>.
485 596
486=item B<shading:> I<number> 597=item B<shading:> I<number>
487 598
488Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 599Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
489image in addition to tinting it. 600image in addition to tinting it.
493Use the specified colour for the scrollbar [default #B2B2B2]. 604Use the specified colour for the scrollbar [default #B2B2B2].
494 605
495=item B<troughColor:> I<colour> 606=item B<troughColor:> I<colour>
496 607
497Use the specified colour for the scrollbar's trough area [default 608Use the specified colour for the scrollbar's trough area [default
498#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 609#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
499 610
500=item B<borderColor:> I<colour> 611=item B<borderColor:> I<colour>
501 612
502The 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
503and the text. 614and the text.
530 641
531Select 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
532names that are used in turn when trying to display Unicode characters. 643names that are used in turn when trying to display Unicode characters.
533The first font defines the cell size for characters; other fonts might 644The first font defines the cell size for characters; other fonts might
534be smaller, but not larger. A reasonable default font list is always 645be smaller, but not larger. A reasonable default font list is always
535appended to it. option B<-fn>. 646appended to it; option B<-fn>.
536 647
537Each 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
538optional 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:>.
539 650
540In addition, each font can be prefixed with additional hints and 651In addition, each font can be prefixed with additional hints and
541specifications enclosed in square brackets (C<[]>). The only available 652specifications enclosed in square brackets (C<[]>). The only available
542hint 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
543fonts. 654fonts.
586not possible, replacement fonts of the desired shape will be tried. 697not possible, replacement fonts of the desired shape will be tried.
587 698
588If 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
589text font will being used for the given style. 700text font will being used for the given style.
590 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
591=item B<selectstyle:> I<mode> 710=item B<selectstyle:> I<mode>
592 711
593Set 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
594xterm 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
595xterm style selection. 714xterm style selection.
596 715
597=item B<scrollstyle:> I<mode> 716=item B<scrollstyle:> I<mode>
598 717
599Set 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
600the author's favourite.. 719the author's favourite.
601 720
602=item B<title:> I<string> 721=item B<title:> I<string>
603 722
604Set window title string, the default title is the command-line 723Set window title string, the default title is the command-line
605specified after the B<-e> option, if any, otherwise the application 724specified after the B<-e> option, if any, otherwise the application
637 756
638Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 757Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
639B<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
640B<Shift-Print> to include the scrollback as well. 759B<Shift-Print> to include the scrollback as well.
641 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
642=item B<scrollBar:> I<boolean> 770=item B<scrollBar:> I<boolean>
643 771
644B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 772B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645disable the scrollbar; option B<+sb>. 773disable the scrollbar; option B<+sb>.
646 774
666B<+si>. 794B<+si>.
667 795
668=item B<scrollWithBuffer:> I<boolean> 796=item B<scrollWithBuffer:> I<boolean>
669 797
670B<True>: scroll with scrollback buffer when tty receives new lines (and 798B<True>: scroll with scrollback buffer when tty receives new lines (and
671B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 799B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
672with scrollback buffer when tty recieves new lines; option B<-sw>. 800with scrollback buffer when tty recieves new lines; option B<+sw>.
673 801
674=item B<scrollTtyKeypress:> I<boolean> 802=item B<scrollTtyKeypress:> I<boolean>
675 803
676B<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
677are those which are intercepted by rxvt-unicode for special handling and 805are those which are intercepted by rxvt-unicode for special handling and
742 870
743Mouse pointer background colour. 871Mouse pointer background colour.
744 872
745=item B<pointerBlankDelay:> I<number> 873=item B<pointerBlankDelay:> I<number>
746 874
747Specifies 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.
748 877
749=item B<backspacekey:> I<string> 878=item B<backspacekey:> I<string>
750 879
751The 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>
752or 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>
774 903
775I<name> of inputMethod to use; option B<-im>. 904I<name> of inputMethod to use; option B<-im>.
776 905
777=item B<imLocale:> I<name> 906=item B<imLocale:> I<name>
778 907
779The 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.
780de_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
781extension to be able to input japanese characters while staying in 910input extension to be able to input japanese characters while staying in
782another 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>.
783 927
784=item B<insecure:> I<boolean> 928=item B<insecure:> I<boolean>
785 929
786Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 930Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787echo 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
788abused if somebody gets 8-bit-clean access to your display, whether 932abused if somebody gets 8-bit-clean access to your display, whether
789throuh a mail client displaying mail bodies unfiltered or though 933through a mail client displaying mail bodies unfiltered or through
790write(1). Therefore, these sequences are disabled by default. (Note 934write(1) or any other means. Therefore, these sequences are disabled by
791that other terminals, including xterm, have these sequences 935default. (Note that many other terminals, including xterm, have these
792enabled by default). You can enable them by setting this boolean 936sequences enabled by default, which doesn't make it safer, though).
793resource or specifying B<-insecure> as an option. At the moment, this 937
794enabled display-answer, locale, findfont, icon label and window title 938You can enable them by setting this boolean resource or specifying
795requests 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.
796 942
797=item B<modifier:> I<modifier> 943=item B<modifier:> I<modifier>
798 944
799Set 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>,
800B<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
815Turn on/off secondary screen scroll (default enabled). If the this 961Turn on/off secondary screen scroll (default enabled). If the this
816option is enabled, scrolls on the secondary screen will change the 962option is enabled, scrolls on the secondary screen will change the
817scrollback buffer and switching to/from the secondary screen will 963scrollback buffer and switching to/from the secondary screen will
818instead scroll the screen up. 964instead scroll the screen up.
819 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
820=item B<keysym.>I<sym>: I<string> 973=item B<keysym.>I<sym>: I<string>
821 974
822Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 975Compile I<frills>: Associate I<string> with keysym I<sym>. The
823contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 976intervening resource name B<keysym.> cannot be omitted.
824newline, \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,
825tab, \000: octal number) or control characters (^?: delete, ^@: null, 997C<\000>: octal number) or verbatim control characters (C<^?>: delete,
826^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
827with whitespace. The intervening resource name B<keysym.> cannot be 999can start or end with whitespace.
828omitted. This resource is only available when compiled with 1000
829KEYSYM_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
1027Due the the large number of modifier combinations, a defined key mapping
1028will match if at I<at least> the specified identifiers are being set, and
1029no other key mappings with those and more bits are being defined. That
1030means that defining a key map for C<a> will automatically provide
1031definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1032mappings themselves.
1033
1034Unfortunately, this will override built-in key mappings. For example
1035if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1036C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1037user-defined keymap using the C<builtin:> replacement:
1038
1039 URxvt.keysym.Insert: <my insert key sequence>
1040 URxvt.keysym.S-Insert: builtin:
1041
1042The first line defines a mapping for C<Insert> and I<any> combination
1043of modifiers. The second line re-establishes the default mapping for
1044C<Shift-Insert>.
1045
1046The following example will map Control-Meta-1 and Control-Meta-2 to
1047the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1048font-switching at runtime:
1049
1050 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1051 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1052
1053Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1054info):
1055
1056 URxvt.keysym.M-C-3: command:\033[8;25;80t
1057 URxvt.keysym.M-C-4: command:\033[8;48;110t
1058
1059=item B<perl>: I<string>
1060
1061Used by perl extension and is free for any use, as it is not interpreted
1062by rxvt-unicode itself; option B<perl>.
1063
1064=item B<perl-eval>: I<string>
1065
1066Perl code to be evaluated when all extensions have been loaded. See the
1067rxvtperl(3) manpage.
1068
1069=item B<perl-lib>: I<path>
1070
1071Additional directory that holds extension scripts that are loaded and
1072enabled for this terminal instance, in addition to scripts stored in
1073F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, which are global to all terminal
1074instances.
1075
1076See the rxvtperl(3) manpage.
830 1077
831=back 1078=back
832 1079
833=head1 THE SCROLLBAR 1080=head1 THE SCROLLBAR
834 1081
848the normal text selection/insertion, hold either the Shift or the Meta 1095the normal text selection/insertion, hold either the Shift or the Meta
849(Alt) key while performing the desired mouse action. 1096(Alt) key while performing the desired mouse action.
850 1097
851If mouse reporting mode is active, the normal scrollbar actions are 1098If mouse reporting mode is active, the normal scrollbar actions are
852disabled -- on the assumption that we are using a fullscreen 1099disabled -- on the assumption that we are using a fullscreen
853application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1100application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1101(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
855up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1102up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856respectively. 1103respectively.
857 1104
858=head1 TEXT SELECTION AND INSERTION 1105=head1 TEXT SELECTION AND INSERTION
859 1106
860The behaviour of text selection and insertion mechanism is similar to 1107The behaviour of text selection and insertion mechanism is similar to
862 1109
863=over 4 1110=over 4
864 1111
865=item B<Selection>: 1112=item B<Selection>:
866 1113
867Left click at the beginning of the region, drag to the end of the 1114Left click at the beginning of the region, drag to the end of the region
868region and release; Right click to extend the marked region; Left 1115and release; Right click to extend the marked region; Left double-click
869double-click to select a word; Left triple-click to select the entire 1116to select a word; Left triple-click to select the entire logical line
870line. 1117(which can span multiple screen lines), unless modified by resource
1118B<tripleclickwords>.
871 1119
872Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1120Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873(Compile: frills) will create a rectangular selection instead of a normal 1121(Compile: I<frills>) will create a rectangular selection instead of a
874one. 1122normal one. In this mode, every selected row becomes its own line in the
1123selection, and trailing whitespace is visually underlined and removed from
1124the selection.
875 1125
876=item B<Insertion>: 1126=item B<Insertion>:
877 1127
878Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1128Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
879an B<@@RXVT_NAME@@> window causes the current text selection to be 1129an B<@@RXVT_NAME@@> window causes the current text selection to be
887supported in rxvt-unicode. Bug me if you need this. 1137supported in rxvt-unicode. Bug me if you need this.
888 1138
889You can, however, switch fonts at runtime using escape sequences (and 1139You can, however, switch fonts at runtime using escape sequences (and
890therefore using the menubar), e.g.: 1140therefore using the menubar), e.g.:
891 1141
892 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1142 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
893 1143
894rxvt-unicode will automatically re-apply these fonts to the output so far. 1144rxvt-unicode will automatically re-apply these fonts to the output so far.
895 1145
896=head1 ISO 14755 SUPPORT 1146=head1 ISO 14755 SUPPORT
897 1147
901C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1151C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902with C<--enable-iso14755>. 1152with C<--enable-iso14755>.
903 1153
904=over 4 1154=over 4
905 1155
906=item 5.1: Basic method 1156=item * 5.1: Basic method
907 1157
908This allows you to enter unicode characters using their hexcode. 1158This allows you to enter unicode characters using their hexcode.
909 1159
910Start by pressing and holding both C<Control> and C<Shift>, then enter 1160Start by pressing and holding both C<Control> and C<Shift>, then enter
911hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1161hex-digits (between one and six). Releasing C<Control> and C<Shift> will
918address, which you cannot type. Fortunately, the card has the e-mail 1168address, which you cannot type. Fortunately, the card has the e-mail
919address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1169address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
920by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1170by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921followed by releasing the modifier keys. 1171followed by releasing the modifier keys.
922 1172
923=item 5.2: Keyboard symbols entry method 1173=item * 5.2: Keyboard symbols entry method
924 1174
925This mode lets you input characters representing the keycap symbols of 1175This mode lets you input characters representing the keycap symbols of
926your keyboard, if representable in the current locale encoding. 1176your keyboard, if representable in the current locale encoding.
927 1177
928Start by pressing C<Control> and C<Shift> together, then releasing 1178Start by pressing C<Control> and C<Shift> together, then releasing
931keycap symbol. The symbol will only be entered when the key has been 1181keycap symbol. The symbol will only be entered when the key has been
932released, otherwise pressing e.g. C<Shift> would enter the symbol for 1182released, otherwise pressing e.g. C<Shift> would enter the symbol for
933C<ISO Level 2 Switch>, although your intention might have been to enter a 1183C<ISO Level 2 Switch>, although your intention might have been to enter a
934reverse tab (Shift-Tab). 1184reverse tab (Shift-Tab).
935 1185
936=item 5.3: Screen-selection entry method 1186=item * 5.3: Screen-selection entry method
937 1187
938While this is implemented already (it's basically the selection 1188While this is implemented already (it's basically the selection
939mechanism), it could be extended by displaying a unicode character map. 1189mechanism), it could be extended by displaying a unicode character map.
940 1190
941=item 5.4: Feedback method for identifying displayed characters for later input 1191=item * 5.4: Feedback method for identifying displayed characters for later input
942 1192
943This method lets you display the unicode character code associated with 1193This method lets you display the unicode character code associated with
944characters already displayed. 1194characters already displayed.
945 1195
946You enter this mode by holding down C<Control> and C<Shift> together, then 1196You enter this mode by holding down C<Control> and C<Shift> together, then
958With respect to conformance, rxvt-unicode is supposed to be compliant to 1208With respect to conformance, rxvt-unicode is supposed to be compliant to
959both scenario A and B of ISO 14755, including part 5.2. 1209both scenario A and B of ISO 14755, including part 5.2.
960 1210
961=head1 LOGIN STAMP 1211=head1 LOGIN STAMP
962 1212
963B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1213B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
964that it can be seen via the I<who(1)> command, and can accept messages. 1214it can be seen via the I<who(1)> command, and can accept messages. To
965To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1215allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966some systems. 1216on some systems or setgid to root or to some other group on others.
967 1217
968=head1 COLORS AND GRAPHICS 1218=head1 COLORS AND GRAPHICS
969 1219
970In addition to the default foreground and background colours, 1220In addition to the default foreground and background colours,
971B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1221B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1014 1264
1015=back 1265=back
1016 1266
1017=head1 ENVIRONMENT 1267=head1 ENVIRONMENT
1018 1268
1019B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1269B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1020and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1270
1021window id number of the B<@@RXVT_NAME@@> window and it also uses and 1271=over 4
1022sets the environment variable B<DISPLAY> to specify which display 1272
1023terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1273=item B<TERM>
1024B<RXVTPATH> and B<PATH> to find XPM files. 1274
1275Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1276resources or on the commandline.
1277
1278=item B<COLORTERM>
1279
1280Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1281compiled with XPM support, and optionally with the added extension
1282C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1283
1284=item B<COLORFGBG>
1285
1286Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1287the colour code used as default foreground/text colour (or the string
1288C<default> to indicate that the default-colour escape sequence is to be
1289used), C<bg> is the colour code used as default background colour (or the
1290string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1291was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1292(and do) use this information to optimize screen output.
1293
1294=item B<WINDOWID>
1295
1296Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1297window, which usually has subwindows for the scrollbar, the terminal
1298window and so on).
1299
1300=item B<TERMINFO>
1301
1302Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1303C<--with-terminfo=PATH>.
1304
1305=item B<DISPLAY>
1306
1307Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1308display in it's child processes.
1309
1310=item B<SHELL>
1311
1312The shell to be used for command execution, defaults to C</bin/sh>.
1313
1314=item B<RXVTPATH>
1315
1316The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1317files.
1318
1319=item B<PATH>
1320
1321Used in the same way as C<RXVTPATH>.
1322
1323=item B<RXVT_SOCKET>
1324
1325The unix domain socket path used by @@RXVT_NAME@@c(1) and
1326@@RXVT_NAME@@d(1).
1327
1328Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1329
1330=item B<HOME>
1331
1332Used to locate the default directory for the unix domain socket for
1333daemon communications and to locate various resource files (such as
1334C<.Xdefaults>)
1335
1336=item B<XAPPLRESDIR>
1337
1338Directory where various X resource files are being located.
1339
1340=item B<XENVIRONMENT>
1341
1342If set and accessible, gives the name of a X resource file to be loaded by
1343@@RXVT_NAME@@.
1344
1345=back
1025 1346
1026=head1 FILES 1347=head1 FILES
1027 1348
1028=over 4 1349=over 4
1029 1350
1030=item B</etc/utmp>
1031
1032System file for login records.
1033
1034=item B</usr/lib/X11/rgb.txt> 1351=item B</usr/lib/X11/rgb.txt>
1035 1352
1036Color names. 1353Color names.
1037 1354
1038=back 1355=back
1039 1356
1040=head1 SEE ALSO 1357=head1 SEE ALSO
1041 1358
1042@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1359@@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)
1043
1044=head1 BUGS
1045
1046Check the BUGS file for an up-to-date list.
1047
1048Cursor change support is not yet implemented.
1049
1050Click-and-drag doesn't work with X11 mouse report overriding.
1051 1360
1052=head1 CURRENT PROJECT COORDINATOR 1361=head1 CURRENT PROJECT COORDINATOR
1053 1362
1054=over 4 1363=over 4
1055 1364
1056=item Project Coordinator 1365=item Project Coordinator
1057 1366
1058@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1367Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059 1368
1060=item Web page maintainter 1369L<http://software.schmorp.de/#rxvt-unicode>
1061
1062@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064L<@@RXVT_WEBPAGE@@>
1065 1370
1066=back 1371=back
1067 1372
1068=head1 AUTHORS 1373=head1 AUTHORS
1069 1374
1094=item Geoff Wing L<< <gcw@pobox.com> >> 1399=item Geoff Wing L<< <gcw@pobox.com> >>
1095 1400
1096Rewrote screen display and text selection routines. Project Coordinator 1401Rewrote screen display and text selection routines. Project Coordinator
1097(changes.txt 2.4.6 - rxvt-unicode) 1402(changes.txt 2.4.6 - rxvt-unicode)
1098 1403
1099=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1404=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100 1405
1101Forked rxvt-unicode, rewrote most of the display code and internal 1406Forked rxvt-unicode, rewrote most of the display code and internal
1102character handling to store text in unicode, improve xterm 1407character handling to store text in unicode, improve xterm
1103compatibility and apply numerous other bugfixes and extensions. 1408compatibility and apply numerous other bugfixes and extensions.
1104 1409

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines