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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.6 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.30 by root, Mon Jan 2 19:36:07 2006 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 4.9, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.2, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
18 20
19RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
20 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
21 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
22 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
… …
91 Turn on/off simulated reverse video; resource reverseVideo. 93 Turn on/off simulated reverse video; resource reverseVideo.
92 94
93 -j|+j 95 -j|+j
94 Turn on/off jump scrolling; resource jumpScroll. 96 Turn on/off jump scrolling; resource jumpScroll.
95 97
96 -ip|+ip 98 -ip|+ip | -tr|+tr
97 Turn on/off inheriting parent window's pixmap. Alternative form is 99 Turn on/off inheriting parent window's pixmap. Alternative form is
98 -tr; resource inheritPixmap. 100 -tr; resource inheritPixmap.
99 101
100 -fade *number* 102 -fade *number*
101 Fade the text by the given percentage when focus is lost. resource 103 Fade the text by the given percentage when focus is lost. Small
102 fading. 104 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading.
106
107 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor.
103 110
104 -tint *colour* 111 -tint *colour*
105 Tint the transparent background pixmap with the given colour when 112 Tint the transparent background pixmap with the given colour when
106 transparency is enabled with -tr or -ip. See also the -sh option 113 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can
107 that can be used to brighten or darken the image in addition to 115 be used to brighten or darken the image in addition to tinting it;
108 tinting it. 116 resource *tintColor*. Example:
117
118 rxvt -tr -tint blue -sh 40
109 119
110 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
111 background image in addition to tinting it (i.e. -tint must be 121 background image in addition to tinting it (i.e. -tint must be
112 specified, too, e.g. "-tint white"). 122 specified, too, e.g. "-tint white").
113 123
… …
165 -fbi *fontlist* 175 -fbi *fontlist*
166 Compile font-styles: The bold italic font list to use when bold 176 Compile font-styles: The bold italic font list to use when bold
167 characters are to be printed. See resource boldItalicFont for 177 characters are to be printed. See resource boldItalicFont for
168 details. 178 details.
169 179
180 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for
183 details.
184
170 -name *name* 185 -name *name*
171 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
172 obtained, rather than the default executable file name. Name should 187 obtained, rather than the default executable file name. Name should
173 not contain `.' or `*' characters. Also sets the icon and title 188 not contain `.' or `*' characters. Also sets the icon and title
174 name. 189 name.
… …
202 217
203 -sr|+sr 218 -sr|+sr
204 Put scrollbar on right/left; resource scrollBar_right. 219 Put scrollbar on right/left; resource scrollBar_right.
205 220
206 -st|+st 221 -st|+st
207 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 222 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
208 resource scrollBar_floating. 223 resource scrollBar_floating.
209 224
210 -ptab|+ptab 225 -ptab|+ptab
211 If enabled (default), "Horizontal Tab" characters are being stored 226 If enabled (default), "Horizontal Tab" characters are being stored
212 as actual wide characters in the screen buffer, which makes it 227 as actual wide characters in the screen buffer, which makes it
… …
257 on the command line. If this option is used, it must be the last on 272 on the command line. If this option is used, it must be the last on
258 the command-line. If there is no -e option then the default is to 273 the command-line. If there is no -e option then the default is to
259 run the program specified by the SHELL environment variable or, 274 run the program specified by the SHELL environment variable or,
260 failing that, *sh(1)*. 275 failing that, *sh(1)*.
261 276
277 Please note that you must specify a program with arguments. If you
278 want to run shell commands, you have to specify the shell, like
279 this:
280
281 rxvt -e sh -c "shell commands"
282
262 -title *text* 283 -title *text*
263 Window title (-T still respected); the default title is the basename 284 Window title (-T still respected); the default title is the basename
264 of the program specified after the -e option, if any, otherwise the 285 of the program specified after the -e option, if any, otherwise the
265 application name; resource title. 286 application name; resource title.
266 287
… …
309 330
310 -ssr|+ssr 331 -ssr|+ssr
311 Turn on/off secondary screen scroll (default enabled); resource 332 Turn on/off secondary screen scroll (default enabled); resource
312 secondaryScroll. 333 secondaryScroll.
313 334
314 -xrm *resourcestring* 335 -hold|+hold
315 No effect on rxvt-unicode. Simply passes through an argument to be 336 Turn on/off hold window after exit support. If enabled, rxvt will
316 made available in the instance's argument list. Appears in 337 not immediately destroy its window when the program executed within
317 *WM_COMMAND* in some window managers. 338 it exits. Instead, it will wait till it is being killed or closed by
339 the user; resource hold.
340
341 -keysym.*sym* *string*
342 Remap a key symbol. See resource keysym.
343
344 -embed *windowid*
345 Tells rxvt to embed it's windows into an already-existing window,
346 which enables applications to easily embed a terminal.
347
348 Right now, rxvt will first unmap/map the specified window, so it
349 shouldn't be a top-level window. rxvt will also reconfigure it quite
350 a bit, so don't expect it to keep some specific state. It's best to
351 create an extra subwindow for rxvt and leave it alone.
352
353 The window will not be destroyed when rxvt exits.
354
355 It might be useful to know that rxvt will not close file descriptors
356 passed to it (except for stdin/out/err, of course), so you can use
357 file descriptors to communicate with the programs within the
358 terminal. This works regardless of wether the "-embed" option was
359 used or not.
360
361 Here is a short Gtk2-perl snippet that illustrates how this option
362 can be used (a longer example is in doc/embed):
363
364 my $rxvt = new Gtk2::Socket;
365 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &";
368 });
369
370 -pty-fd *fileno*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair
372 but instead use the given filehandle as the tty master. This is
373 useful if you want to drive rxvt as a generic terminal emulator
374 without having to run a program within it.
375
376 If this switch is given, rxvt will not create any utmp/wtmp entries
377 and will not tinker with pty/tty permissions - you have to do that
378 yourself if you want that.
379
380 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd):
382
383 use IO::Pty;
384 use Fcntl;
385
386 my $pty = new IO::Pty;
387 fcntl $pty, F_SETFD, 0; # clear close-on-exec
388 system "rxvt -pty-fd " . (fileno $pty) . "&";
389 close $pty;
390
391 # now communicate with rxvt
392 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" }
394
395 -perl *string*
396 Used by perl extension. See resource perl.
318 397
319RESOURCES (available also as long-options) 398RESOURCES (available also as long-options)
320 Note: `rxvt --help' gives a list of all resources (long options) 399 Note: `rxvt --help' gives a list of all resources (long options)
321 compiled into your version. 400 compiled into your version.
322 401
323 There are two different methods that rxvt can use to get the Xresource 402 There are two different methods that rxvt can use to get the Xresource
324 data: using the X libraries (Xrm*-functions) or internal Xresources 403 data: using the X libraries (Xrm*-functions) or internal Xresources
325 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 404 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
326 XGetDefaults), you can set and change the resources using X11 tools like 405 XGetDefaults), you can set and change the resources using X11 tools like
327 xset. Many distribution do also load settings from the ~/.Xresources 406 xrdb. Many distribution do also load settings from the ~/.Xresources
328 file when X starts. 407 file when X starts. rxvt will consult the following files/resources in
408 order, with later settings overwriting earlier ones:
409
410 1. system-wide app-defaults file, either locale-dependent OR global
411 2. app-defaults file in $XAPPLRESDIR
412 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
413 4. SCREEN_RESOURCES for the current screen
414 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
329 415
330 If compiled with internal Xresources support (i.e. rxvt -h lists 416 If compiled with internal Xresources support (i.e. rxvt -h lists
331 .Xdefaults) then rxvt accepts application defaults set in 417 .Xdefaults) then rxvt accepts application defaults set in
332 XAPPLOADDIR/URxvt (compile-time defined: usually 418 XAPPLOADDIR/URxvt (compile-time defined: usually
333 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 419 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
… …
409 True: make the background inherit the parent windows' pixmap, giving 495 True: make the background inherit the parent windows' pixmap, giving
410 artificial transparency. False: do not inherit the parent windows' 496 artificial transparency. False: do not inherit the parent windows'
411 pixmap. 497 pixmap.
412 498
413 fading: *number* 499 fading: *number*
414 Fade the text by the given percentage when focus is lost. 500 Fade the text by the given percentage when focus is lost; option
501 -fade.
502
503 fadeColor: *colour*
504 Fade to this colour, when fading is used (see fading:). The default
505 colour is black; option -fadecolor.
415 506
416 tintColor: *colour* 507 tintColor: *colour*
417 Tint the transparent background pixmap with the given colour. 508 Tint the transparent background pixmap with the given colour; option
509 -tint.
418 510
419 shading: *number* 511 shading: *number*
420 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 512 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
421 image in addition to tinting it. 513 image in addition to tinting it.
422 514
423 scrollColor: *colour* 515 scrollColor: *colour*
424 Use the specified colour for the scrollbar [default #B2B2B2]. 516 Use the specified colour for the scrollbar [default #B2B2B2].
425 517
426 troughColor: *colour* 518 troughColor: *colour*
427 Use the specified colour for the scrollbar's trough area [default 519 Use the specified colour for the scrollbar's trough area [default
428 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 520 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
429 521
430 borderColor: *colour* 522 borderColor: *colour*
431 The colour of the border around the text area and between the 523 The colour of the border around the text area and between the
432 scrollbar and the text. 524 scrollbar and the text.
433 525
… …
456 font: *fontlist* 548 font: *fontlist*
457 Select the fonts to be used. This is a comma separated list of font 549 Select the fonts to be used. This is a comma separated list of font
458 names that are used in turn when trying to display Unicode 550 names that are used in turn when trying to display Unicode
459 characters. The first font defines the cell size for characters; 551 characters. The first font defines the cell size for characters;
460 other fonts might be smaller, but not larger. A reasonable default 552 other fonts might be smaller, but not larger. A reasonable default
461 font list is always appended to it. option -fn. 553 font list is always appended to it; option -fn.
462 554
463 Each font can either be a standard X11 core font (XLFD) name, with 555 Each font can either be a standard X11 core font (XLFD) name, with
464 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 556 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
465 "xft:". 557 "xft:".
466 558
… …
512 tried. 604 tried.
513 605
514 If set, but empty, then this specific style is disabled and the 606 If set, but empty, then this specific style is disabled and the
515 normal text font will being used for the given style. 607 normal text font will being used for the given style.
516 608
609 intensityStyles: *boolean*
610 When font styles are not enabled, or this option is enabled (True,
611 option -is, the default), bold and italic font styles imply high
612 intensity foreground/backround colours. Disabling this option
613 (False, option +is) disables this behaviour, the high intensity
614 colours are not reachable.
615
517 selectstyle: *mode* 616 selectstyle: *mode*
518 Set mouse selection style to old which is 2.20, oldword which is 617 Set mouse selection style to old which is 2.20, oldword which is
519 xterm style with 2.20 old word selection, or anything else which 618 xterm style with 2.20 old word selection, or anything else which
520 gives xterm style selection. 619 gives xterm style selection.
521 620
522 scrollstyle: *mode* 621 scrollstyle: *mode*
523 Set scrollbar style to rxvt, plain, next or xterm. plain is the 622 Set scrollbar style to rxvt, plain, next or xterm. plain is the
524 author's favourite.. 623 author's favourite.
525 624
526 title: *string* 625 title: *string*
527 Set window title string, the default title is the command-line 626 Set window title string, the default title is the command-line
528 specified after the -e option, if any, otherwise the application 627 specified after the -e option, if any, otherwise the application
529 name; option -title. 628 name; option -title.
… …
554 print-pipe: *string* 653 print-pipe: *string*
555 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 654 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
556 Print to initiate a screen dump to the printer and Ctrl-Print or 655 Print to initiate a screen dump to the printer and Ctrl-Print or
557 Shift-Print to include the scrollback as well. 656 Shift-Print to include the scrollback as well.
558 657
658 The string will be interpreted as if typed into the shell as-is.
659
660 Example:
661
662 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
663
664 This creates a new file in your home directory with the screen
665 contents everytime you hit "Print".
666
559 scrollBar: *boolean* 667 scrollBar: *boolean*
560 True: enable the scrollbar [default]; option -sb. False: disable the 668 True: enable the scrollbar [default]; option -sb. False: disable the
561 scrollbar; option +sb. 669 scrollbar; option +sb.
562 670
563 scrollBar_right: *boolean* 671 scrollBar_right: *boolean*
… …
576 True: scroll to bottom when tty receives output; option -si. False: 684 True: scroll to bottom when tty receives output; option -si. False:
577 do not scroll to bottom when tty receives output; option +si. 685 do not scroll to bottom when tty receives output; option +si.
578 686
579 scrollWithBuffer: *boolean* 687 scrollWithBuffer: *boolean*
580 True: scroll with scrollback buffer when tty receives new lines (and 688 True: scroll with scrollback buffer when tty receives new lines (and
581 scrollTtyOutput is False); option +sw. False: do not scroll with 689 scrollTtyOutput is False); option -sw. False: do not scroll with
582 scrollback buffer when tty recieves new lines; option -sw. 690 scrollback buffer when tty recieves new lines; option +sw.
583 691
584 scrollTtyKeypress: *boolean* 692 scrollTtyKeypress: *boolean*
585 True: scroll to bottom when a non-special key is pressed. Special 693 True: scroll to bottom when a non-special key is pressed. Special
586 keys are those which are intercepted by rxvt-unicode for special 694 keys are those which are intercepted by rxvt-unicode for special
587 handling and are not passed onto the shell; option -sk. False: do 695 handling and are not passed onto the shell; option -sk. False: do
… …
639 pointerColor2: *colour* 747 pointerColor2: *colour*
640 Mouse pointer background colour. 748 Mouse pointer background colour.
641 749
642 pointerBlankDelay: *number* 750 pointerBlankDelay: *number*
643 Specifies number of seconds before blanking the pointer [default 2]. 751 Specifies number of seconds before blanking the pointer [default 2].
752 Use a large number (e.g. 987654321) to effectively disable the
753 timeout.
644 754
645 backspacekey: *string* 755 backspacekey: *string*
646 The string to send when the backspace key is pressed. If set to DEC 756 The string to send when the backspace key is pressed. If set to DEC
647 or unset it will send Delete (code 127) or, if shifted, Backspace 757 or unset it will send Delete (code 127) or, if shifted, Backspace
648 (code 8) - which can be reversed with the appropriate DEC private 758 (code 8) - which can be reversed with the appropriate DEC private
… …
667 777
668 imLocale: *name* 778 imLocale: *name*
669 The locale to use for opening the IM. You can use an "LC_CTYPE" of 779 The locale to use for opening the IM. You can use an "LC_CTYPE" of
670 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 780 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
671 the input extension to be able to input japanese characters while 781 the input extension to be able to input japanese characters while
672 staying in another locale. option -imlocale. 782 staying in another locale; option -imlocale.
673 783
674 imFont: *fontset* 784 imFont: *fontset*
675 Specify the font-set used for XIM styles "OverTheSpot" or 785 Specify the font-set used for XIM styles "OverTheSpot" or
676 "OffTheSpot". It must be a standard X font set (XLFD patterns 786 "OffTheSpot". It must be a standard X font set (XLFD patterns
677 separated by commas), i.e. it's not in the same format as the other 787 separated by commas), i.e. it's not in the same format as the other
… …
680 to the base font. option -imfont. 790 to the base font. option -imfont.
681 791
682 tripleclickwords: *boolean* 792 tripleclickwords: *boolean*
683 Change the meaning of triple-click selection with the left mouse 793 Change the meaning of triple-click selection with the left mouse
684 button. Instead of selecting a full line it will extend the 794 button. Instead of selecting a full line it will extend the
685 selection to the end of the logical line only. option -tcw. 795 selection to the end of the logical line only; option -tcw.
686 796
687 insecure: *boolean* 797 insecure: *boolean*
688 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 798 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
689 that echo arbitrary strings like the icon name or the locale. This 799 that echo arbitrary strings like the icon name or the locale. This
690 could be abused if somebody gets 8-bit-clean access to your display, 800 could be abused if somebody gets 8-bit-clean access to your display,
691 whether throuh a mail client displaying mail bodies unfiltered or 801 whether through a mail client displaying mail bodies unfiltered or
692 though write(1). Therefore, these sequences are disabled by default. 802 through write(1) or any other means. Therefore, these sequences are
693 (Note that other terminals, including xterm, have these sequences 803 disabled by default. (Note that many other terminals, including
694 enabled by default). You can enable them by setting this boolean 804 xterm, have these sequences enabled by default, which doesn't make
695 resource or specifying -insecure as an option. At the moment, this 805 it safer, though).
696 enabled display-answer, locale, findfont, icon label and window 806
697 title requests as well as dynamic menubar dispatch. 807 You can enable them by setting this boolean resource or specifying
808 -insecure as an option. At the moment, this enables display-answer,
809 locale, findfont, icon label and window title requests as well as
810 dynamic menubar dispatch.
698 811
699 modifier: *modifier* 812 modifier: *modifier*
700 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 813 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
701 super, mod1, mod2, mod3, mod4, mod5; option -mod. 814 super, mod1, mod2, mod3, mod4, mod5; option -mod.
702 815
… …
711 secondaryScroll: *bool* 824 secondaryScroll: *bool*
712 Turn on/off secondary screen scroll (default enabled). If the this 825 Turn on/off secondary screen scroll (default enabled). If the this
713 option is enabled, scrolls on the secondary screen will change the 826 option is enabled, scrolls on the secondary screen will change the
714 scrollback buffer and switching to/from the secondary screen will 827 scrollback buffer and switching to/from the secondary screen will
715 instead scroll the screen up. 828 instead scroll the screen up.
829
830 hold: *bool*
831 Turn on/off hold window after exit support. If enabled, rxvt will
832 not immediately destroy its window when the program executed within
833 it exits. Instead, it will wait till it is being killed or closed by
834 the user.
716 835
717 keysym.*sym*: *string* 836 keysym.*sym*: *string*
718 Compile *frills*: Associate *string* with keysym *sym*. The 837 Compile *frills*: Associate *string* with keysym *sym*. The
719 intervening resource name keysym. cannot be omitted. 838 intervening resource name keysym. cannot be omitted.
720 839
… …
739 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 858 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
740 "\000": octal number) or verbatim control characters ("^?": delete, 859 "\000": octal number) or verbatim control characters ("^?": delete,
741 "^@": null, "^A" ...) and may be enclosed with double quotes so that 860 "^@": null, "^A" ...) and may be enclosed with double quotes so that
742 it can start or end with whitespace. 861 it can start or end with whitespace.
743 862
863 Please note that you need to double the "\" when using
864 "--enable-xgetdefault", as X itself does it's own de-escaping (you
865 can use "\033" instead of "\e" (and so on), which will work with
866 both Xt and rxvt's own processing).
867
744 You can define a range of keysyms in one shot by providing a 868 You can define a range of keysyms in one shot by providing a
745 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 869 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
746 `/' should be a character not used by the strings. 870 `/' should be a character not used by the strings.
747 871
748 Its usage can be demonstrated by an example: 872 Its usage can be demonstrated by an example:
749 873
750 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 874 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
751 875
752 The above line is equivalent to the following three lines: 876 The above line is equivalent to the following three lines:
753 877
754 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 878 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
755 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 879 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
756 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 880 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
757 881
758 If *string* takes the form of "proto:STRING", the specified STRING 882 If *string* takes the form of "command:STRING", the specified STRING
759 is interpreted and executed as rxvt's control sequence. For example 883 is interpreted and executed as rxvt's control sequence. For example
760 the following means "change the current locale to "zh_CN.GBK" when 884 the following means "change the current locale to "zh_CN.GBK" when
761 Control-Meta-c is being pressed": 885 Control-Meta-c is being pressed":
762 886
763 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007 887 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
888
889 Due the the large number of modifier combinations, a defined key
890 mapping will match if at *at least* the specified identifiers are
891 being set, and no other key mappings with those and more bits are
892 being defined. That means that defining a key map for "a" will
893 automatically provide definitions for "Meta-a", "Shift-a" and so on,
894 unless some of those are defined mappings themselves.
895
896 Unfortunately, this will override built-in key mappings. For example
897 if you overwrite the "Insert" key you will disable rxvt's
898 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
899 the user-defined keymap using the "builtin:" replacement:
900
901 URxvt.keysym.Insert: <my insert key sequence>
902 URxvt.keysym.S-Insert: builtin:
903
904 The first line defines a mapping for "Insert" and *any* combination
905 of modifiers. The second line re-establishes the default mapping for
906 "Shift-Insert".
764 907
765 The following example will map Control-Meta-1 and Control-Meta-2 to 908 The following example will map Control-Meta-1 and Control-Meta-2 to
766 the fonts "suxuseuro" and "9x15bold", so you cna have some limited 909 the fonts "suxuseuro" and "9x15bold", so you can have some limited
767 font-switching at runtime: 910 font-switching at runtime:
768 911
769 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 912 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
770 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007 913 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
771 914
772 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 915 Other things are possible, e.g. resizing (see rxvt(7) for more
773 "zh_CN.GBK". 916 info):
917
918 URxvt.keysym.M-C-3: command:\033[8;25;80t
919 URxvt.keysym.M-C-4: command:\033[8;48;110t
920
921 perl: *string*
922 Used by perl extension and is free for any use, as it is not
923 interpreted by rxvt-unicode itself; option perl.
924
925 perl-eval: *string*
926 Perl code to be evaluated when all extensions have been loaded. See
927 the rxvtperl(3) manpage.
928
929 perl-lib: *path*
930 Additional directory that holds extension scripts that are loaded
931 and enabled for this terminal instance, in addition to scripts
932 stored in /opt/rxvt/lib/urxvt/perl-ext/, which are global to all
933 terminal instances.
934
935 See the rxvtperl(3) manpage.
774 936
775THE SCROLLBAR 937THE SCROLLBAR
776 Lines of text that scroll off the top of the rxvt window (resource: 938 Lines of text that scroll off the top of the rxvt window (resource:
777 saveLines) and can be scrolled back using the scrollbar or by 939 saveLines) and can be scrolled back using the scrollbar or by
778 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 940 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
788 normal text selection/insertion, hold either the Shift or the Meta (Alt) 950 normal text selection/insertion, hold either the Shift or the Meta (Alt)
789 key while performing the desired mouse action. 951 key while performing the desired mouse action.
790 952
791 If mouse reporting mode is active, the normal scrollbar actions are 953 If mouse reporting mode is active, the normal scrollbar actions are
792 disabled -- on the assumption that we are using a fullscreen 954 disabled -- on the assumption that we are using a fullscreen
793 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 955 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
794 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 956 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
795 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 957 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
796 958
797TEXT SELECTION AND INSERTION 959TEXT SELECTION AND INSERTION
798 The behaviour of text selection and insertion mechanism is similar to 960 The behaviour of text selection and insertion mechanism is similar to
799 *xterm*(1). 961 *xterm*(1).
800 962
… …
805 entire logical line (which can span multiple screen lines), unless 967 entire logical line (which can span multiple screen lines), unless
806 modified by resource tripleclickwords. 968 modified by resource tripleclickwords.
807 969
808 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 970 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
809 (Compile: *frills*) will create a rectangular selection instead of a 971 (Compile: *frills*) will create a rectangular selection instead of a
810 normal one. 972 normal one. In this mode, every selected row becomes its own line in
973 the selection, and trailing whitespace is visually underlined and
974 removed from the selection.
811 975
812 Insertion: 976 Insertion:
813 Pressing and releasing the Middle mouse button (or Shift-Insert) in 977 Pressing and releasing the Middle mouse button (or Shift-Insert) in
814 an rxvt window causes the current text selection to be inserted as 978 an rxvt window causes the current text selection to be inserted as
815 if it had been typed on the keyboard. 979 if it had been typed on the keyboard.
… …
819 supported in rxvt-unicode. Bug me if you need this. 983 supported in rxvt-unicode. Bug me if you need this.
820 984
821 You can, however, switch fonts at runtime using escape sequences (and 985 You can, however, switch fonts at runtime using escape sequences (and
822 therefore using the menubar), e.g.: 986 therefore using the menubar), e.g.:
823 987
824 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 988 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
825 989
826 rxvt-unicode will automatically re-apply these fonts to the output so 990 rxvt-unicode will automatically re-apply these fonts to the output so
827 far. 991 far.
828 992
829ISO 14755 SUPPORT 993ISO 14755 SUPPORT
… …
929 rxvt -fg Black -bg White -rv 1093 rxvt -fg Black -bg White -rv
930 would yield White on Black, while on *xterm*(1) it would yield Black 1094 would yield White on Black, while on *xterm*(1) it would yield Black
931 on White. 1095 on White.
932 1096
933ENVIRONMENT 1097ENVIRONMENT
934 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1098 rxvt sets and/or uses the following environment variables:
935 environment variable WINDOWID is set to the X window id number of the 1099
936 rxvt window and it also uses and sets the environment variable DISPLAY 1100 TERM
937 to specify which display terminal to use. rxvt uses the environment 1101 Normally set to "rxvt-unicode", unless overwritten at configure
938 variables RXVTPATH and PATH to find XPM files. 1102 time, via resources or on the commandline.
1103
1104 COLORTERM
1105 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1106 with XPM support, and optionally with the added extension "-mono" to
1107 indicate that rxvt-unicode runs on a monochrome screen.
1108
1109 COLORFGBG
1110 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1111 the colour code used as default foreground/text colour (or the
1112 string "default" to indicate that the default-colour escape sequence
1113 is to be used), "bg" is the colour code used as default background
1114 colour (or the string "default"), and "xpm" is the string "default"
1115 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1116 "slang" can (and do) use this information to optimize screen output.
1117
1118 WINDOWID
1119 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1120 window, which usually has subwindows for the scrollbar, the terminal
1121 window and so on).
1122
1123 TERMINFO
1124 Set to the terminfo directory iff rxvt was configured with
1125 "--with-terminfo=PATH".
1126
1127 DISPLAY
1128 Used by rxvt to connect to the display and set to the correct
1129 display in it's child processes.
1130
1131 SHELL
1132 The shell to be used for command execution, defaults to "/bin/sh".
1133
1134 RXVTPATH
1135 The path where rxvt looks for support files such as menu and xpm
1136 files.
1137
1138 PATH
1139 Used in the same way as "RXVTPATH".
1140
1141 RXVT_SOCKET
1142 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1143
1144 Default $HOME/.rxvt-unicode-*<nodename*.
1145
1146 HOME
1147 Used to locate the default directory for the unix domain socket for
1148 daemon communications and to locate various resource files (such as
1149 ".Xdefaults")
1150
1151 XAPPLRESDIR
1152 Directory where various X resource files are being located.
1153
1154 XENVIRONMENT
1155 If set and accessible, gives the name of a X resource file to be
1156 loaded by rxvt.
939 1157
940FILES 1158FILES
941 /usr/lib/X11/rgb.txt 1159 /usr/lib/X11/rgb.txt
942 Color names. 1160 Color names.
943 1161
944SEE ALSO 1162SEE ALSO
945 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1163 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
946 1164 tty(4), utmp(5)
947BUGS
948 Check the BUGS file for an up-to-date list.
949
950 Cursor change support is not yet implemented.
951
952 Click-and-drag doesn't work with X11 mouse report overriding.
953 1165
954CURRENT PROJECT COORDINATOR 1166CURRENT PROJECT COORDINATOR
955 Project Coordinator 1167 Project Coordinator
956 Marc A. Lehmann rxvt@schmorp.de 1168 Marc A. Lehmann <rxvt-unicode@schmorp.de>
957 1169
958 Web page maintainter
959 Marc A. Lehmann rxvt@schmorp.de
960
961 <http://software.schmorp.de/> 1170 <http://software.schmorp.de/#rxvt-unicode>
962 1171
963AUTHORS 1172AUTHORS
964 John Bovey 1173 John Bovey
965 University of Kent, 1992, wrote the original Xvt. 1174 University of Kent, 1992, wrote the original Xvt.
966 1175
… …
980 1189
981 Geoff Wing <gcw@pobox.com> 1190 Geoff Wing <gcw@pobox.com>
982 Rewrote screen display and text selection routines. Project 1191 Rewrote screen display and text selection routines. Project
983 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1192 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
984 1193
985 Marc Alexander Lehmann <rxvt@schmorp.de> 1194 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
986 Forked rxvt-unicode, rewrote most of the display code and internal 1195 Forked rxvt-unicode, rewrote most of the display code and internal
987 character handling to store text in unicode, improve xterm 1196 character handling to store text in unicode, improve xterm
988 compatibility and apply numerous other bugfixes and extensions. 1197 compatibility and apply numerous other bugfixes and extensions.
989 1198
990 Project Coordinator (Changes 1.0 -) 1199 Project Coordinator (Changes 1.0 -)

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines