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.29 by root, Mon Jan 2 15:11:05 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" }
318 394
319RESOURCES (available also as long-options) 395RESOURCES (available also as long-options)
320 Note: `rxvt --help' gives a list of all resources (long options) 396 Note: `rxvt --help' gives a list of all resources (long options)
321 compiled into your version. 397 compiled into your version.
322 398
323 There are two different methods that rxvt can use to get the Xresource 399 There are two different methods that rxvt can use to get the Xresource
324 data: using the X libraries (Xrm*-functions) or internal Xresources 400 data: using the X libraries (Xrm*-functions) or internal Xresources
325 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 401 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
326 XGetDefaults), you can set and change the resources using X11 tools like 402 XGetDefaults), you can set and change the resources using X11 tools like
327 xset. Many distribution do also load settings from the ~/.Xresources 403 xrdb. Many distribution do also load settings from the ~/.Xresources
328 file when X starts. 404 file when X starts. rxvt will consult the following files/resources in
405 order, with later settings overwriting earlier ones:
406
407 1. system-wide app-defaults file, either locale-dependent OR global
408 2. app-defaults file in $XAPPLRESDIR
409 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
410 4. SCREEN_RESOURCES for the current screen
411 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
329 412
330 If compiled with internal Xresources support (i.e. rxvt -h lists 413 If compiled with internal Xresources support (i.e. rxvt -h lists
331 .Xdefaults) then rxvt accepts application defaults set in 414 .Xdefaults) then rxvt accepts application defaults set in
332 XAPPLOADDIR/URxvt (compile-time defined: usually 415 XAPPLOADDIR/URxvt (compile-time defined: usually
333 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 416 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
… …
409 True: make the background inherit the parent windows' pixmap, giving 492 True: make the background inherit the parent windows' pixmap, giving
410 artificial transparency. False: do not inherit the parent windows' 493 artificial transparency. False: do not inherit the parent windows'
411 pixmap. 494 pixmap.
412 495
413 fading: *number* 496 fading: *number*
414 Fade the text by the given percentage when focus is lost. 497 Fade the text by the given percentage when focus is lost; option
498 -fade.
499
500 fadeColor: *colour*
501 Fade to this colour, when fading is used (see fading:). The default
502 colour is black; option -fadecolor.
415 503
416 tintColor: *colour* 504 tintColor: *colour*
417 Tint the transparent background pixmap with the given colour. 505 Tint the transparent background pixmap with the given colour; option
506 -tint.
418 507
419 shading: *number* 508 shading: *number*
420 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 509 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
421 image in addition to tinting it. 510 image in addition to tinting it.
422 511
423 scrollColor: *colour* 512 scrollColor: *colour*
424 Use the specified colour for the scrollbar [default #B2B2B2]. 513 Use the specified colour for the scrollbar [default #B2B2B2].
425 514
426 troughColor: *colour* 515 troughColor: *colour*
427 Use the specified colour for the scrollbar's trough area [default 516 Use the specified colour for the scrollbar's trough area [default
428 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 517 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
429 518
430 borderColor: *colour* 519 borderColor: *colour*
431 The colour of the border around the text area and between the 520 The colour of the border around the text area and between the
432 scrollbar and the text. 521 scrollbar and the text.
433 522
… …
512 tried. 601 tried.
513 602
514 If set, but empty, then this specific style is disabled and the 603 If set, but empty, then this specific style is disabled and the
515 normal text font will being used for the given style. 604 normal text font will being used for the given style.
516 605
606 intensityStyles: *boolean*
607 When font styles are not enabled, or this option is enabled (True,
608 option -is, the default), bold and italic font styles imply high
609 intensity foreground/backround colours. Disabling this option
610 (False, option +is) disables this behaviour, the high intensity
611 colours are not reachable.
612
517 selectstyle: *mode* 613 selectstyle: *mode*
518 Set mouse selection style to old which is 2.20, oldword which is 614 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 615 xterm style with 2.20 old word selection, or anything else which
520 gives xterm style selection. 616 gives xterm style selection.
521 617
522 scrollstyle: *mode* 618 scrollstyle: *mode*
523 Set scrollbar style to rxvt, plain, next or xterm. plain is the 619 Set scrollbar style to rxvt, plain, next or xterm. plain is the
524 author's favourite.. 620 author's favourite.
525 621
526 title: *string* 622 title: *string*
527 Set window title string, the default title is the command-line 623 Set window title string, the default title is the command-line
528 specified after the -e option, if any, otherwise the application 624 specified after the -e option, if any, otherwise the application
529 name; option -title. 625 name; option -title.
… …
554 print-pipe: *string* 650 print-pipe: *string*
555 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 651 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 652 Print to initiate a screen dump to the printer and Ctrl-Print or
557 Shift-Print to include the scrollback as well. 653 Shift-Print to include the scrollback as well.
558 654
655 The string will be interpreted as if typed into the shell as-is.
656
657 Example:
658
659 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
660
661 This creates a new file in your home directory with the screen
662 contents everytime you hit "Print".
663
559 scrollBar: *boolean* 664 scrollBar: *boolean*
560 True: enable the scrollbar [default]; option -sb. False: disable the 665 True: enable the scrollbar [default]; option -sb. False: disable the
561 scrollbar; option +sb. 666 scrollbar; option +sb.
562 667
563 scrollBar_right: *boolean* 668 scrollBar_right: *boolean*
… …
576 True: scroll to bottom when tty receives output; option -si. False: 681 True: scroll to bottom when tty receives output; option -si. False:
577 do not scroll to bottom when tty receives output; option +si. 682 do not scroll to bottom when tty receives output; option +si.
578 683
579 scrollWithBuffer: *boolean* 684 scrollWithBuffer: *boolean*
580 True: scroll with scrollback buffer when tty receives new lines (and 685 True: scroll with scrollback buffer when tty receives new lines (and
581 scrollTtyOutput is False); option +sw. False: do not scroll with 686 scrollTtyOutput is False); option -sw. False: do not scroll with
582 scrollback buffer when tty recieves new lines; option -sw. 687 scrollback buffer when tty recieves new lines; option +sw.
583 688
584 scrollTtyKeypress: *boolean* 689 scrollTtyKeypress: *boolean*
585 True: scroll to bottom when a non-special key is pressed. Special 690 True: scroll to bottom when a non-special key is pressed. Special
586 keys are those which are intercepted by rxvt-unicode for special 691 keys are those which are intercepted by rxvt-unicode for special
587 handling and are not passed onto the shell; option -sk. False: do 692 handling and are not passed onto the shell; option -sk. False: do
… …
639 pointerColor2: *colour* 744 pointerColor2: *colour*
640 Mouse pointer background colour. 745 Mouse pointer background colour.
641 746
642 pointerBlankDelay: *number* 747 pointerBlankDelay: *number*
643 Specifies number of seconds before blanking the pointer [default 2]. 748 Specifies number of seconds before blanking the pointer [default 2].
749 Use a large number (e.g. 987654321) to effectively disable the
750 timeout.
644 751
645 backspacekey: *string* 752 backspacekey: *string*
646 The string to send when the backspace key is pressed. If set to DEC 753 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 754 or unset it will send Delete (code 127) or, if shifted, Backspace
648 (code 8) - which can be reversed with the appropriate DEC private 755 (code 8) - which can be reversed with the appropriate DEC private
… …
686 793
687 insecure: *boolean* 794 insecure: *boolean*
688 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 795 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
689 that echo arbitrary strings like the icon name or the locale. This 796 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, 797 could be abused if somebody gets 8-bit-clean access to your display,
691 whether throuh a mail client displaying mail bodies unfiltered or 798 whether through a mail client displaying mail bodies unfiltered or
692 though write(1). Therefore, these sequences are disabled by default. 799 through write(1) or any other means. Therefore, these sequences are
693 (Note that other terminals, including xterm, have these sequences 800 disabled by default. (Note that many other terminals, including
694 enabled by default). You can enable them by setting this boolean 801 xterm, have these sequences enabled by default, which doesn't make
695 resource or specifying -insecure as an option. At the moment, this 802 it safer, though).
696 enabled display-answer, locale, findfont, icon label and window 803
697 title requests as well as dynamic menubar dispatch. 804 You can enable them by setting this boolean resource or specifying
805 -insecure as an option. At the moment, this enables display-answer,
806 locale, findfont, icon label and window title requests as well as
807 dynamic menubar dispatch.
698 808
699 modifier: *modifier* 809 modifier: *modifier*
700 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 810 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
701 super, mod1, mod2, mod3, mod4, mod5; option -mod. 811 super, mod1, mod2, mod3, mod4, mod5; option -mod.
702 812
… …
711 secondaryScroll: *bool* 821 secondaryScroll: *bool*
712 Turn on/off secondary screen scroll (default enabled). If the this 822 Turn on/off secondary screen scroll (default enabled). If the this
713 option is enabled, scrolls on the secondary screen will change the 823 option is enabled, scrolls on the secondary screen will change the
714 scrollback buffer and switching to/from the secondary screen will 824 scrollback buffer and switching to/from the secondary screen will
715 instead scroll the screen up. 825 instead scroll the screen up.
826
827 hold: *bool*
828 Turn on/off hold window after exit support. If enabled, rxvt will
829 not immediately destroy its window when the program executed within
830 it exits. Instead, it will wait till it is being killed or closed by
831 the user.
716 832
717 keysym.*sym*: *string* 833 keysym.*sym*: *string*
718 Compile *frills*: Associate *string* with keysym *sym*. The 834 Compile *frills*: Associate *string* with keysym *sym*. The
719 intervening resource name keysym. cannot be omitted. 835 intervening resource name keysym. cannot be omitted.
720 836
… …
739 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 855 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
740 "\000": octal number) or verbatim control characters ("^?": delete, 856 "\000": octal number) or verbatim control characters ("^?": delete,
741 "^@": null, "^A" ...) and may be enclosed with double quotes so that 857 "^@": null, "^A" ...) and may be enclosed with double quotes so that
742 it can start or end with whitespace. 858 it can start or end with whitespace.
743 859
860 Please note that you need to double the "\" when using
861 "--enable-xgetdefault", as X itself does it's own de-escaping (you
862 can use "\033" instead of "\e" (and so on), which will work with
863 both Xt and rxvt's own processing).
864
744 You can define a range of keysyms in one shot by providing a 865 You can define a range of keysyms in one shot by providing a
745 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 866 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
746 `/' should be a character not used by the strings. 867 `/' should be a character not used by the strings.
747 868
748 Its usage can be demonstrated by an example: 869 Its usage can be demonstrated by an example:
749 870
750 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 871 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
751 872
752 The above line is equivalent to the following three lines: 873 The above line is equivalent to the following three lines:
753 874
754 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 875 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
755 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 876 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
756 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 877 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
757 878
758 If *string* takes the form of "proto:STRING", the specified STRING 879 If *string* takes the form of "command:STRING", the specified STRING
759 is interpreted and executed as rxvt's control sequence. For example 880 is interpreted and executed as rxvt's control sequence. For example
760 the following means "change the current locale to "zh_CN.GBK" when 881 the following means "change the current locale to "zh_CN.GBK" when
761 Control-Meta-c is being pressed": 882 Control-Meta-c is being pressed":
762 883
763 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007 884 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
885
886 Due the the large number of modifier combinations, a defined key
887 mapping will match if at *at least* the specified identifiers are
888 being set, and no other key mappings with those and more bits are
889 being defined. That means that defining a key map for "a" will
890 automatically provide definitions for "Meta-a", "Shift-a" and so on,
891 unless some of those are defined mappings themselves.
892
893 Unfortunately, this will override built-in key mappings. For example
894 if you overwrite the "Insert" key you will disable rxvt's
895 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
896 the user-defined keymap using the "builtin:" replacement:
897
898 URxvt.keysym.Insert: <my insert key sequence>
899 URxvt.keysym.S-Insert: builtin:
900
901 The first line defines a mapping for "Insert" and *any* combination
902 of modifiers. The second line re-establishes the default mapping for
903 "Shift-Insert".
764 904
765 The following example will map Control-Meta-1 and Control-Meta-2 to 905 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 906 the fonts "suxuseuro" and "9x15bold", so you can have some limited
767 font-switching at runtime: 907 font-switching at runtime:
768 908
769 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 909 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
770 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007 910 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
771 911
772 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 912 Other things are possible, e.g. resizing (see rxvt(7) for more
773 "zh_CN.GBK". 913 info):
914
915 URxvt.keysym.M-C-3: command:\033[8;25;80t
916 URxvt.keysym.M-C-4: command:\033[8;48;110t
774 917
775THE SCROLLBAR 918THE SCROLLBAR
776 Lines of text that scroll off the top of the rxvt window (resource: 919 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 920 saveLines) and can be scrolled back using the scrollbar or by
778 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 921 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
788 normal text selection/insertion, hold either the Shift or the Meta (Alt) 931 normal text selection/insertion, hold either the Shift or the Meta (Alt)
789 key while performing the desired mouse action. 932 key while performing the desired mouse action.
790 933
791 If mouse reporting mode is active, the normal scrollbar actions are 934 If mouse reporting mode is active, the normal scrollbar actions are
792 disabled -- on the assumption that we are using a fullscreen 935 disabled -- on the assumption that we are using a fullscreen
793 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 936 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
794 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 937 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
795 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 938 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
796 939
797TEXT SELECTION AND INSERTION 940TEXT SELECTION AND INSERTION
798 The behaviour of text selection and insertion mechanism is similar to 941 The behaviour of text selection and insertion mechanism is similar to
799 *xterm*(1). 942 *xterm*(1).
800 943
… …
805 entire logical line (which can span multiple screen lines), unless 948 entire logical line (which can span multiple screen lines), unless
806 modified by resource tripleclickwords. 949 modified by resource tripleclickwords.
807 950
808 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 951 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
809 (Compile: *frills*) will create a rectangular selection instead of a 952 (Compile: *frills*) will create a rectangular selection instead of a
810 normal one. 953 normal one. In this mode, every selected row becomes its own line in
954 the selection, and trailing whitespace is visually underlined and
955 removed from the selection.
811 956
812 Insertion: 957 Insertion:
813 Pressing and releasing the Middle mouse button (or Shift-Insert) in 958 Pressing and releasing the Middle mouse button (or Shift-Insert) in
814 an rxvt window causes the current text selection to be inserted as 959 an rxvt window causes the current text selection to be inserted as
815 if it had been typed on the keyboard. 960 if it had been typed on the keyboard.
… …
819 supported in rxvt-unicode. Bug me if you need this. 964 supported in rxvt-unicode. Bug me if you need this.
820 965
821 You can, however, switch fonts at runtime using escape sequences (and 966 You can, however, switch fonts at runtime using escape sequences (and
822 therefore using the menubar), e.g.: 967 therefore using the menubar), e.g.:
823 968
824 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 969 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
825 970
826 rxvt-unicode will automatically re-apply these fonts to the output so 971 rxvt-unicode will automatically re-apply these fonts to the output so
827 far. 972 far.
828 973
829ISO 14755 SUPPORT 974ISO 14755 SUPPORT
… …
929 rxvt -fg Black -bg White -rv 1074 rxvt -fg Black -bg White -rv
930 would yield White on Black, while on *xterm*(1) it would yield Black 1075 would yield White on Black, while on *xterm*(1) it would yield Black
931 on White. 1076 on White.
932 1077
933ENVIRONMENT 1078ENVIRONMENT
934 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1079 rxvt sets and/or uses the following environment variables:
935 environment variable WINDOWID is set to the X window id number of the 1080
936 rxvt window and it also uses and sets the environment variable DISPLAY 1081 TERM
937 to specify which display terminal to use. rxvt uses the environment 1082 Normally set to "rxvt-unicode", unless overwritten at configure
938 variables RXVTPATH and PATH to find XPM files. 1083 time, via resources or on the commandline.
1084
1085 COLORTERM
1086 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1087 with XPM support, and optionally with the added extension "-mono" to
1088 indicate that rxvt-unicode runs on a monochrome screen.
1089
1090 COLORFGBG
1091 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1092 the colour code used as default foreground/text colour (or the
1093 string "default" to indicate that the default-colour escape sequence
1094 is to be used), "bg" is the colour code used as default background
1095 colour (or the string "default"), and "xpm" is the string "default"
1096 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1097 "slang" can (and do) use this information to optimize screen output.
1098
1099 WINDOWID
1100 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1101 window, which usually has subwindows for the scrollbar, the terminal
1102 window and so on).
1103
1104 TERMINFO
1105 Set to the terminfo directory iff rxvt was configured with
1106 "--with-terminfo=PATH".
1107
1108 DISPLAY
1109 Used by rxvt to connect to the display and set to the correct
1110 display in it's child processes.
1111
1112 SHELL
1113 The shell to be used for command execution, defaults to "/bin/sh".
1114
1115 RXVTPATH
1116 The path where rxvt looks for support files such as menu and xpm
1117 files.
1118
1119 PATH
1120 Used in the same way as "RXVTPATH".
1121
1122 RXVT_SOCKET
1123 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1124
1125 Default $HOME/.rxvt-unicode-*<nodename*.
1126
1127 HOME
1128 Used to locate the default directory for the unix domain socket for
1129 daemon communications and to locate various resource files (such as
1130 ".Xdefaults")
1131
1132 XAPPLRESDIR
1133 Directory where various X resource files are being located.
1134
1135 XENVIRONMENT
1136 If set and accessible, gives the name of a X resource file to be
1137 loaded by rxvt.
939 1138
940FILES 1139FILES
941 /usr/lib/X11/rgb.txt 1140 /usr/lib/X11/rgb.txt
942 Color names. 1141 Color names.
943 1142
944SEE ALSO 1143SEE ALSO
945 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1144 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
946 1145 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 1146
954CURRENT PROJECT COORDINATOR 1147CURRENT PROJECT COORDINATOR
955 Project Coordinator 1148 Project Coordinator
956 Marc A. Lehmann rxvt@schmorp.de 1149 Marc A. Lehmann <rxvt-unicode@schmorp.de>
957 1150
958 Web page maintainter
959 Marc A. Lehmann rxvt@schmorp.de
960
961 <http://software.schmorp.de/> 1151 <http://software.schmorp.de/#rxvt-unicode>
962 1152
963AUTHORS 1153AUTHORS
964 John Bovey 1154 John Bovey
965 University of Kent, 1992, wrote the original Xvt. 1155 University of Kent, 1992, wrote the original Xvt.
966 1156
… …
980 1170
981 Geoff Wing <gcw@pobox.com> 1171 Geoff Wing <gcw@pobox.com>
982 Rewrote screen display and text selection routines. Project 1172 Rewrote screen display and text selection routines. Project
983 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1173 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
984 1174
985 Marc Alexander Lehmann <rxvt@schmorp.de> 1175 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
986 Forked rxvt-unicode, rewrote most of the display code and internal 1176 Forked rxvt-unicode, rewrote most of the display code and internal
987 character handling to store text in unicode, improve xterm 1177 character handling to store text in unicode, improve xterm
988 compatibility and apply numerous other bugfixes and extensions. 1178 compatibility and apply numerous other bugfixes and extensions.
989 1179
990 Project Coordinator (Changes 1.0 -) 1180 Project Coordinator (Changes 1.0 -)

Diff Legend

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