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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.23 by root, Thu Jul 7 19:37:47 2005 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.8, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 5.6, 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
202 204
203 -sr|+sr 205 -sr|+sr
204 Put scrollbar on right/left; resource scrollBar_right. 206 Put scrollbar on right/left; resource scrollBar_right.
205 207
206 -st|+st 208 -st|+st
207 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 209 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
208 resource scrollBar_floating. 210 resource scrollBar_floating.
209 211
210 -ptab|+ptab 212 -ptab|+ptab
211 If enabled (default), "Horizontal Tab" characters are being stored 213 If enabled (default), "Horizontal Tab" characters are being stored
212 as actual wide characters in the screen buffer, which makes it 214 as actual wide characters in the screen buffer, which makes it
277 279
278 -im *text* 280 -im *text*
279 Compile *XIM*: input method name. resource inputMethod. 281 Compile *XIM*: input method name. resource inputMethod.
280 282
281 -imlocale *string* 283 -imlocale *string*
282 The locale to use for opening the IM. You can use an LC_CTYPE of 284 The locale to use for opening the IM. You can use an "LC_CTYPE" of
283 e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the 285 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
284 input extension to be able to input japanese characters while 286 the input extension to be able to input japanese characters while
285 staying in another locale. 287 staying in another locale. resource imLocale.
288
289 -imfont *fontset*
290 Set the font set to use for the X Input Method, see resource imFont
291 for more info.
292
293 -tcw
294 Change the meaning of triple-click selection with the left mouse
295 button. Instead of selecting a full line it will extend the
296 selection the end of the logical line only. resource
297 tripleclickwords.
286 298
287 -insecure 299 -insecure
288 Enable "insecure" mode, which currently enables most of the escape 300 Enable "insecure" mode, which currently enables most of the escape
289 sequences that echo strings. See the resource insecure for more 301 sequences that echo strings. See the resource insecure for more
290 info. 302 info.
299 311
300 -ssr|+ssr 312 -ssr|+ssr
301 Turn on/off secondary screen scroll (default enabled); resource 313 Turn on/off secondary screen scroll (default enabled); resource
302 secondaryScroll. 314 secondaryScroll.
303 315
304 -xrm *resourcestring* 316 -keysym.*sym* *string*
305 No effect on rxvt-unicode. Simply passes through an argument to be 317 Remap a key symbol. See resource keysym.
306 made available in the instance's argument list. Appears in 318
307 *WM_COMMAND* in some window managers. 319 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window,
321 which enables applications to easily embed a terminal.
322
323 Right now, rxvt will first unmap/map the specified window, so it
324 shouldn't be a top-level window. rxvt will also reconfigure it quite
325 a bit, so don't expect it to keep some specific state. It's best to
326 create an extra subwindow for rxvt and leave it alone.
327
328 The window will not be destroyed when rxvt exits.
329
330 It might be useful to know that rxvt will not close file descriptors
331 passed to it (except for stdin/out/err, of course), so you can use
332 file descriptors to communicate with the programs within the
333 terminal. This works regardless of wether the "-embed" option was
334 used or not.
335
336 Here is a short Gtk2-perl snippet that illustrates how this option
337 can be used (a longer example is in doc/embed):
338
339 my $rxvt = new Gtk2::Socket;
340 $rxvt->signal_connect_after (realize => sub {
341 my $xid = $_[0]->window->get_xid;
342 system "rxvt -embed $xid &";
343 });
344
345 -pty-fd *fileno*
346 Tells rxvt NOT to execute any commands or create a new pty/tty pair
347 but instead use the given filehandle as the tty master. This is
348 useful if you want to drive rxvt as a generic terminal emulator
349 without having to run a program within it.
350
351 If this switch is given, rxvt will not create any utmp/wtmp entries
352 and will not tinker with pty/tty permissions - you have to do that
353 yourself if you want that.
354
355 Here is a example in perl that illustrates how this option can be
356 used (a longer example is in doc/pty-fd):
357
358 use IO::Pty;
359 use Fcntl;
360
361 my $pty = new IO::Pty;
362 fcntl $pty, F_SETFD, 0; # clear close-on-exec
363 system "rxvt -pty-fd " . (fileno $pty) . "&";
364 close $pty;
365
366 # now communicate with rxvt
367 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" }
308 369
309RESOURCES (available also as long-options) 370RESOURCES (available also as long-options)
310 Note: `rxvt --help' gives a list of all resources (long options) 371 Note: `rxvt --help' gives a list of all resources (long options)
311 compiled into your version. 372 compiled into your version.
312 373
313 There are two different methods that rxvt can use to get the Xresource 374 There are two different methods that rxvt can use to get the Xresource
314 data: using the X libraries (Xrm*-functions) or internal Xresources 375 data: using the X libraries (Xrm*-functions) or internal Xresources
315 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 376 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
316 XGetDefaults), you can set and change the resources using X11 tools like 377 XGetDefaults), you can set and change the resources using X11 tools like
317 xset. Many distribution do also load settings from the ~/.Xresources 378 xrdb. Many distribution do also load settings from the ~/.Xresources
318 file when X starts. 379 file when X starts. rxvt will consult the following files/resources in
380 order, with later settings overwriting earlier ones:
381
382 1. system-wide app-defaults file, either locale-dependent OR global
383 2. app-defaults file in $XAPPLRESDIR
384 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
385 4. SCREEN_RESOURCES for the current screen
386 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
319 387
320 If compiled with internal Xresources support (i.e. rxvt -h lists 388 If compiled with internal Xresources support (i.e. rxvt -h lists
321 .Xdefaults) then rxvt accepts application defaults set in 389 .Xdefaults) then rxvt accepts application defaults set in
322 XAPPLOADDIR/URxvt (compile-time defined: usually 390 XAPPLOADDIR/URxvt (compile-time defined: usually
323 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 391 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
413 scrollColor: *colour* 481 scrollColor: *colour*
414 Use the specified colour for the scrollbar [default #B2B2B2]. 482 Use the specified colour for the scrollbar [default #B2B2B2].
415 483
416 troughColor: *colour* 484 troughColor: *colour*
417 Use the specified colour for the scrollbar's trough area [default 485 Use the specified colour for the scrollbar's trough area [default
418 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 486 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
419 487
420 borderColor: *colour* 488 borderColor: *colour*
421 The colour of the border around the text area and between the 489 The colour of the border around the text area and between the
422 scrollbar and the text. 490 scrollbar and the text.
423 491
509 xterm style with 2.20 old word selection, or anything else which 577 xterm style with 2.20 old word selection, or anything else which
510 gives xterm style selection. 578 gives xterm style selection.
511 579
512 scrollstyle: *mode* 580 scrollstyle: *mode*
513 Set scrollbar style to rxvt, plain, next or xterm. plain is the 581 Set scrollbar style to rxvt, plain, next or xterm. plain is the
514 author's favourite.. 582 author's favourite.
515 583
516 title: *string* 584 title: *string*
517 Set window title string, the default title is the command-line 585 Set window title string, the default title is the command-line
518 specified after the -e option, if any, otherwise the application 586 specified after the -e option, if any, otherwise the application
519 name; option -title. 587 name; option -title.
544 print-pipe: *string* 612 print-pipe: *string*
545 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
546 Print to initiate a screen dump to the printer and Ctrl-Print or 614 Print to initiate a screen dump to the printer and Ctrl-Print or
547 Shift-Print to include the scrollback as well. 615 Shift-Print to include the scrollback as well.
548 616
617 The string will be interpreted as if typed into the shell as-is.
618
619 Example:
620
621 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
622
623 This creates a new file in your home directory with the screen
624 contents everytime you hit "Print".
625
549 scrollBar: *boolean* 626 scrollBar: *boolean*
550 True: enable the scrollbar [default]; option -sb. False: disable the 627 True: enable the scrollbar [default]; option -sb. False: disable the
551 scrollbar; option +sb. 628 scrollbar; option +sb.
552 629
553 scrollBar_right: *boolean* 630 scrollBar_right: *boolean*
566 True: scroll to bottom when tty receives output; option -si. False: 643 True: scroll to bottom when tty receives output; option -si. False:
567 do not scroll to bottom when tty receives output; option +si. 644 do not scroll to bottom when tty receives output; option +si.
568 645
569 scrollWithBuffer: *boolean* 646 scrollWithBuffer: *boolean*
570 True: scroll with scrollback buffer when tty receives new lines (and 647 True: scroll with scrollback buffer when tty receives new lines (and
571 scrollTtyOutput is False); option +sw. False: do not scroll with 648 scrollTtyOutput is False); option -sw. False: do not scroll with
572 scrollback buffer when tty recieves new lines; option -sw. 649 scrollback buffer when tty recieves new lines; option +sw.
573 650
574 scrollTtyKeypress: *boolean* 651 scrollTtyKeypress: *boolean*
575 True: scroll to bottom when a non-special key is pressed. Special 652 True: scroll to bottom when a non-special key is pressed. Special
576 keys are those which are intercepted by rxvt-unicode for special 653 keys are those which are intercepted by rxvt-unicode for special
577 handling and are not passed onto the shell; option -sk. False: do 654 handling and are not passed onto the shell; option -sk. False: do
629 pointerColor2: *colour* 706 pointerColor2: *colour*
630 Mouse pointer background colour. 707 Mouse pointer background colour.
631 708
632 pointerBlankDelay: *number* 709 pointerBlankDelay: *number*
633 Specifies number of seconds before blanking the pointer [default 2]. 710 Specifies number of seconds before blanking the pointer [default 2].
711 Use a large number (e.g. 987654321) to effectively disable the
712 timeout.
634 713
635 backspacekey: *string* 714 backspacekey: *string*
636 The string to send when the backspace key is pressed. If set to DEC 715 The string to send when the backspace key is pressed. If set to DEC
637 or unset it will send Delete (code 127) or, if shifted, Backspace 716 or unset it will send Delete (code 127) or, if shifted, Backspace
638 (code 8) - which can be reversed with the appropriate DEC private 717 (code 8) - which can be reversed with the appropriate DEC private
654 733
655 inputMethod: *name* 734 inputMethod: *name*
656 *name* of inputMethod to use; option -im. 735 *name* of inputMethod to use; option -im.
657 736
658 imLocale: *name* 737 imLocale: *name*
659 The locale to use for opening the IM. You can use an LC_CTYPE of 738 The locale to use for opening the IM. You can use an "LC_CTYPE" of
660 e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the 739 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
661 input extension to be able to input japanese characters while 740 the input extension to be able to input japanese characters while
662 staying in another locale. option -imlocale. 741 staying in another locale. option -imlocale.
742
743 imFont: *fontset*
744 Specify the font-set used for XIM styles "OverTheSpot" or
745 "OffTheSpot". It must be a standard X font set (XLFD patterns
746 separated by commas), i.e. it's not in the same format as the other
747 font lists used in rxvt. The default will be set-up to chose *any*
748 suitable found found, preferably one or two pixels differing in size
749 to the base font. option -imfont.
750
751 tripleclickwords: *boolean*
752 Change the meaning of triple-click selection with the left mouse
753 button. Instead of selecting a full line it will extend the
754 selection to the end of the logical line only. option -tcw.
663 755
664 insecure: *boolean* 756 insecure: *boolean*
665 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 757 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666 that echo arbitrary strings like the icon name or the locale. This 758 that echo arbitrary strings like the icon name or the locale. This
667 could be abused if somebody gets 8-bit-clean access to your display, 759 could be abused if somebody gets 8-bit-clean access to your display,
700 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K, 792 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
701 C, N, S, M, A, L, 1, 2, 3, 4, 5. 793 C, N, S, M, A, L, 1, 2, 3, 4, 5.
702 794
703 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to 795 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
704 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 796 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
705 Shift/AltGr keys are being mapped. AppKeypad is a artificial 797 Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
706 modifier mapped to the current application keymap mode state. 798 mapped to the current application keymap mode state.
707 799
708 The spellings of *key* can be obtained by using xev(1) command or 800 The spellings of *key* can be obtained by using xev(1) command or
709 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and 801 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
710 omitting the prefix XK_. Alternatively you can specify *key* by its 802 omitting the prefix XK_. Alternatively you can specify *key* by its
711 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s 803 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
716 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 808 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
717 "\000": octal number) or verbatim control characters ("^?": delete, 809 "\000": octal number) or verbatim control characters ("^?": delete,
718 "^@": null, "^A" ...) and may be enclosed with double quotes so that 810 "^@": null, "^A" ...) and may be enclosed with double quotes so that
719 it can start or end with whitespace. 811 it can start or end with whitespace.
720 812
813 Please note that you need to double the "\" when using
814 "--enable-xgetdefault", as X itself does it's own de-escaping (you
815 can use "\033" instead of "\e" (and so on), which will work with
816 both Xt and rxvt's own processing).
817
721 You can define a range of keysyms in one shot by providing a 818 You can define a range of keysyms in one shot by providing a
722 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 819 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
723 `/' should be a character not used by the strings. 820 `/' should be a character not used by the strings.
724 821
725 Its usage can be demonstrated by an example: 822 Its usage can be demonstrated by an example:
726 823
727 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 824 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
728 825
729 The above line is equivalent to the following three lines: 826 The above line is equivalent to the following three lines:
730 827
731 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 828 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
732 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 829 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
733 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 830 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
734 831
735 If *string* takes the form of "proto:STRING", the specified STRING 832 If *string* takes the form of "command:STRING", the specified STRING
736 is interpreted and executed as rxvt's control sequence. For example, 833 is interpreted and executed as rxvt's control sequence. For example
737 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 834 the following means "change the current locale to "zh_CN.GBK" when
738 "zh_CN.GBK". 835 Control-Meta-c is being pressed":
836
837 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
838
839 Due the the large number of modifier combinations, a defined key
840 mapping will match if at *at least* the specified identifiers are
841 being set, and no other key mappings with those and more bits are
842 being defined. That means that defining a key map for "a" will
843 automatically provide definitions for "Meta-a", "Shift-a" and so on,
844 unless some of those are defined mappings themselves.
845
846 Unfortunately, this will override built-in key mappings. For example
847 if you overwrite the "Insert" key you will disable rxvt's
848 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
849 the user-defined keymap using the "builtin:" replacement:
850
851 URxvt.keysym.Insert: <my insert key sequence>
852 URxvt.keysym.S-Insert: builtin:
853
854 The first line defines a mapping for "Insert" and *any* combination
855 of modifiers. The second line re-establishes the default mapping for
856 "Shift-Insert".
857
858 The following example will map Control-Meta-1 and Control-Meta-2 to
859 the fonts "suxuseuro" and "9x15bold", so you can have some limited
860 font-switching at runtime:
861
862 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
863 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
864
865 Other things are possible, e.g. resizing (see rxvt(7) for more
866 info):
867
868 URxvt.keysym.M-C-3: command:\033[8;25;80t
869 URxvt.keysym.M-C-4: command:\033[8;48;110t
739 870
740THE SCROLLBAR 871THE SCROLLBAR
741 Lines of text that scroll off the top of the rxvt window (resource: 872 Lines of text that scroll off the top of the rxvt window (resource:
742 saveLines) and can be scrolled back using the scrollbar or by 873 saveLines) and can be scrolled back using the scrollbar or by
743 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 874 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
753 normal text selection/insertion, hold either the Shift or the Meta (Alt) 884 normal text selection/insertion, hold either the Shift or the Meta (Alt)
754 key while performing the desired mouse action. 885 key while performing the desired mouse action.
755 886
756 If mouse reporting mode is active, the normal scrollbar actions are 887 If mouse reporting mode is active, the normal scrollbar actions are
757 disabled -- on the assumption that we are using a fullscreen 888 disabled -- on the assumption that we are using a fullscreen
758 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 889 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
759 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 890 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
760 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 891 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
761 892
762TEXT SELECTION AND INSERTION 893TEXT SELECTION AND INSERTION
763 The behaviour of text selection and insertion mechanism is similar to 894 The behaviour of text selection and insertion mechanism is similar to
764 *xterm*(1). 895 *xterm*(1).
765 896
766 Selection: 897 Selection:
767 Left click at the beginning of the region, drag to the end of the 898 Left click at the beginning of the region, drag to the end of the
768 region and release; Right click to extend the marked region; Left 899 region and release; Right click to extend the marked region; Left
769 double-click to select a word; Left triple-click to select the 900 double-click to select a word; Left triple-click to select the
770 entire line. 901 entire logical line (which can span multiple screen lines), unless
902 modified by resource tripleclickwords.
771 903
772 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 904 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
773 (Compile: *frills*) will create a rectangular selection instead of a 905 (Compile: *frills*) will create a rectangular selection instead of a
774 normal one. 906 normal one.
775 907
795 character codes using the keyboard. It consists of 4 parts. The first 927 character codes using the keyboard. It consists of 4 parts. The first
796 part is available rxvt-unicode has been compiled with "--enable-frills", 928 part is available rxvt-unicode has been compiled with "--enable-frills",
797 the rest is available when rxvt-unicode was compiled with 929 the rest is available when rxvt-unicode was compiled with
798 "--enable-iso14755". 930 "--enable-iso14755".
799 931
800 5.1: Basic method 932 * 5.1: Basic method
801 This allows you to enter unicode characters using their hexcode. 933 This allows you to enter unicode characters using their hexcode.
802 934
803 Start by pressing and holding both "Control" and "Shift", then enter 935 Start by pressing and holding both "Control" and "Shift", then enter
804 hex-digits (between one and six). Releasing "Control" and "Shift" 936 hex-digits (between one and six). Releasing "Control" and "Shift"
805 will commit the character as if it were typed directly. While 937 will commit the character as if it were typed directly. While
811 address, which you cannot type. Fortunately, the card has the e-mail 943 address, which you cannot type. Fortunately, the card has the e-mail
812 address printed as hexcodes, e.g. "671d 65e5". You can enter this 944 address printed as hexcodes, e.g. "671d 65e5". You can enter this
813 easily by pressing "Control" and "Shift", followed by 945 easily by pressing "Control" and "Shift", followed by
814 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 946 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
815 947
816 5.2: Keyboard symbols entry method 948 * 5.2: Keyboard symbols entry method
817 This mode lets you input characters representing the keycap symbols 949 This mode lets you input characters representing the keycap symbols
818 of your keyboard, if representable in the current locale encoding. 950 of your keyboard, if representable in the current locale encoding.
819 951
820 Start by pressing "Control" and "Shift" together, then releasing 952 Start by pressing "Control" and "Shift" together, then releasing
821 them. The next special key (cursor keys, home etc.) you enter will 953 them. The next special key (cursor keys, home etc.) you enter will
823 corresponding keycap symbol. The symbol will only be entered when 955 corresponding keycap symbol. The symbol will only be entered when
824 the key has been released, otherwise pressing e.g. "Shift" would 956 the key has been released, otherwise pressing e.g. "Shift" would
825 enter the symbol for "ISO Level 2 Switch", although your intention 957 enter the symbol for "ISO Level 2 Switch", although your intention
826 might have been to enter a reverse tab (Shift-Tab). 958 might have been to enter a reverse tab (Shift-Tab).
827 959
828 5.3: Screen-selection entry method 960 * 5.3: Screen-selection entry method
829 While this is implemented already (it's basically the selection 961 While this is implemented already (it's basically the selection
830 mechanism), it could be extended by displaying a unicode character 962 mechanism), it could be extended by displaying a unicode character
831 map. 963 map.
832 964
833 5.4: Feedback method for identifying displayed characters for later 965 * 5.4: Feedback method for identifying displayed characters for later
834 input 966 input
835 This method lets you display the unicode character code associated 967 This method lets you display the unicode character code associated
836 with characters already displayed. 968 with characters already displayed.
837 969
838 You enter this mode by holding down "Control" and "Shift" together, 970 You enter this mode by holding down "Control" and "Shift" together,
850 both scenario A and B of ISO 14755, including part 5.2. 982 both scenario A and B of ISO 14755, including part 5.2.
851 983
852LOGIN STAMP 984LOGIN STAMP
853 rxvt tries to write an entry into the *utmp*(5) file so that it can be 985 rxvt tries to write an entry into the *utmp*(5) file so that it can be
854 seen via the *who(1)* command, and can accept messages. To allow this 986 seen via the *who(1)* command, and can accept messages. To allow this
855 feature, rxvt must be installed setuid root on some systems. 987 feature, rxvt may need to be installed setuid root on some systems or
988 setgid to root or to some other group on others.
856 989
857COLORS AND GRAPHICS 990COLORS AND GRAPHICS
858 In addition to the default foreground and background colours, rxvt can 991 In addition to the default foreground and background colours, rxvt can
859 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 992 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
860 versions of the same). Here is a list of the colours with their rgb.txt 993 versions of the same). Here is a list of the colours with their rgb.txt
892 rxvt -fg Black -bg White -rv 1025 rxvt -fg Black -bg White -rv
893 would yield White on Black, while on *xterm*(1) it would yield Black 1026 would yield White on Black, while on *xterm*(1) it would yield Black
894 on White. 1027 on White.
895 1028
896ENVIRONMENT 1029ENVIRONMENT
897 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1030 rxvt sets and/or uses the following environment variables:
898 environment variable WINDOWID is set to the X window id number of the 1031
899 rxvt window and it also uses and sets the environment variable DISPLAY 1032 TERM
900 to specify which display terminal to use. rxvt uses the environment 1033 Normally set to "rxvt-unicode", unless overwritten at configure
901 variables RXVTPATH and PATH to find XPM files. 1034 time, via resources or on the commandline.
1035
1036 COLORTERM
1037 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1038 with XPM support, and optionally with the added extension "-mono" to
1039 indicate that rxvt-unicode runs on a monochrome screen.
1040
1041 COLORFGBG
1042 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1043 the colour code used as default foreground/text colour (or the
1044 string "default" to indicate that the default-colour escape sequence
1045 is to be used), "bg" is the colour code used as default background
1046 colour (or the string "default"), and "xpm" is the string "default"
1047 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1048 "slang" can (and do) use this information to optimize screen output.
1049
1050 WINDOWID
1051 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1052 window, which usually has subwindows for the scrollbar, the terminal
1053 window and so on).
1054
1055 TERMINFO
1056 Set to the terminfo directory iff rxvt was configured with
1057 "--with-terminfo=PATH".
1058
1059 DISPLAY
1060 Used by rxvt to connect to the display and set to the correct
1061 display in it's child processes.
1062
1063 SHELL
1064 The shell to be used for command execution, defaults to "/bin/sh".
1065
1066 RXVTPATH
1067 The path where rxvt looks for support files such as menu and xpm
1068 files.
1069
1070 PATH
1071 Used in the same way as "RXVTPATH".
1072
1073 RXVT_SOCKET
1074 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1075
1076 Default $HOME/.rxvt-unicode-*<nodename*.
1077
1078 HOME
1079 Used to locate the default directory for the unix domain socket for
1080 daemon communications and to locate various resource files (such as
1081 ".Xdefaults")
1082
1083 XAPPLRESDIR
1084 Directory where various X resource files are being located.
1085
1086 XENVIRONMENT
1087 If set and accessible, gives the name of a X resource file to be
1088 loaded by rxvt.
902 1089
903FILES 1090FILES
904 /etc/utmp
905 System file for login records.
906
907 /usr/lib/X11/rgb.txt 1091 /usr/lib/X11/rgb.txt
908 Color names. 1092 Color names.
909 1093
910SEE ALSO 1094SEE ALSO
911 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1095 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1096 tty(4), utmp(5)
912 1097
913BUGS 1098BUGS
914 Check the BUGS file for an up-to-date list. 1099 Check the BUGS file for an up-to-date list.
915 1100
916 Cursor change support is not yet implemented. 1101 Cursor change support is not yet implemented.
917 1102
918 Click-and-drag doesn't work with X11 mouse report overriding. 1103 Click-and-drag doesn't work with X11 mouse report overriding.
919 1104
920CURRENT PROJECT COORDINATOR 1105CURRENT PROJECT COORDINATOR
921 Project Coordinator 1106 Project Coordinator
922 Marc A. Lehmann rxvt@schmorp.de 1107 Marc A. Lehmann <rxvt-unicode@schmorp.de>
923 1108
924 Web page maintainter
925 Marc A. Lehmann rxvt@schmorp.de
926
927 <http://software.schmorp.de/> 1109 <http://software.schmorp.de/#rxvt-unicode>
928 1110
929AUTHORS 1111AUTHORS
930 John Bovey 1112 John Bovey
931 University of Kent, 1992, wrote the original Xvt. 1113 University of Kent, 1992, wrote the original Xvt.
932 1114
946 1128
947 Geoff Wing <gcw@pobox.com> 1129 Geoff Wing <gcw@pobox.com>
948 Rewrote screen display and text selection routines. Project 1130 Rewrote screen display and text selection routines. Project
949 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1131 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
950 1132
951 Marc Alexander Lehmann <rxvt@schmorp.de> 1133 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
952 Forked rxvt-unicode, rewrote most of the display code and internal 1134 Forked rxvt-unicode, rewrote most of the display code and internal
953 character handling to store text in unicode, improve xterm 1135 character handling to store text in unicode, improve xterm
954 compatibility and apply numerous other bugfixes and extensions. 1136 compatibility and apply numerous other bugfixes and extensions.
955 1137
956 Project Coordinator (Changes 1.0 -) 1138 Project Coordinator (Changes 1.0 -)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines