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.2 by root, Sun Jan 16 15:59:45 2005 UTC vs.
Revision 1.21 by root, Fri Apr 22 02:09:39 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.5, 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
118 Window foreground colour; resource foreground. 120 Window foreground colour; resource foreground.
119 121
120 -pixmap *file[;geom]* 122 -pixmap *file[;geom]*
121 Compile *XPM*: Specify XPM file for the background and also 123 Compile *XPM*: Specify XPM file for the background and also
122 optionally specify its scaling with a geometry string. Note you may 124 optionally specify its scaling with a geometry string. Note you may
123 need to add quotes to avoid special shell interpretation of the `;' 125 need to add quotes to avoid special shell interpretation of the ";"
124 in the command-line; resource backgroundPixmap. 126 in the command-line; resource backgroundPixmap.
125 127
126 -cr *colour* 128 -cr *colour*
127 The cursor colour; resource cursorColor. 129 The cursor colour; resource cursorColor.
128 130
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
359 427
360 colorBD: *colour* 428 colorBD: *colour*
361 colorIT: *colour* 429 colorIT: *colour*
362 Use the specified colour to display bold or italic characters when 430 Use the specified colour to display bold or italic characters when
363 the foreground colour is the default. If font styles are not 431 the foreground colour is the default. If font styles are not
364 available (Compile styles) and this option is unset, reverse video 432 available (Compile *styles*) and this option is unset, reverse video
365 is used instead. 433 is used instead.
366 434
367 colorUL: *colour* 435 colorUL: *colour*
368 Use the specified colour to display underlined characters when the 436 Use the specified colour to display underlined characters when the
369 foreground colour is the default. 437 foreground colour is the default.
449 characters. The first font defines the cell size for characters; 517 characters. The first font defines the cell size for characters;
450 other fonts might be smaller, but not larger. A reasonable default 518 other fonts might be smaller, but not larger. A reasonable default
451 font list is always appended to it. option -fn. 519 font list is always appended to it. option -fn.
452 520
453 Each font can either be a standard X11 core font (XLFD) name, with 521 Each font can either be a standard X11 core font (XLFD) name, with
454 optional prefix "x:" or a Xft font (Compile xft), prefixed with 522 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
455 "xft:". 523 "xft:".
456 524
457 In addition, each font can be prefixed with additional hints and 525 In addition, each font can be prefixed with additional hints and
458 specifications enclosed in square brackets ("[]"). The only 526 specifications enclosed in square brackets ("[]"). The only
459 available hint currently is "codeset=codeset-name", and this is only 527 available hint currently is "codeset=codeset-name", and this is only
566 True: scroll to bottom when tty receives output; option -si. False: 634 True: scroll to bottom when tty receives output; option -si. False:
567 do not scroll to bottom when tty receives output; option +si. 635 do not scroll to bottom when tty receives output; option +si.
568 636
569 scrollWithBuffer: *boolean* 637 scrollWithBuffer: *boolean*
570 True: scroll with scrollback buffer when tty receives new lines (and 638 True: scroll with scrollback buffer when tty receives new lines (and
571 scrollTtyOutput is False); option +sw. False: do not scroll with 639 scrollTtyOutput is False); option -sw. False: do not scroll with
572 scrollback buffer when tty recieves new lines; option -sw. 640 scrollback buffer when tty recieves new lines; option +sw.
573 641
574 scrollTtyKeypress: *boolean* 642 scrollTtyKeypress: *boolean*
575 True: scroll to bottom when a non-special key is pressed. Special 643 True: scroll to bottom when a non-special key is pressed. Special
576 keys are those which are intercepted by rxvt-unicode for special 644 keys are those which are intercepted by rxvt-unicode for special
577 handling and are not passed onto the shell; option -sk. False: do 645 handling and are not passed onto the shell; option -sk. False: do
629 pointerColor2: *colour* 697 pointerColor2: *colour*
630 Mouse pointer background colour. 698 Mouse pointer background colour.
631 699
632 pointerBlankDelay: *number* 700 pointerBlankDelay: *number*
633 Specifies number of seconds before blanking the pointer [default 2]. 701 Specifies number of seconds before blanking the pointer [default 2].
702 Use a large number (e.g. 987654321) to effectively disable the
703 timeout.
634 704
635 backspacekey: *string* 705 backspacekey: *string*
636 The string to send when the backspace key is pressed. If set to DEC 706 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 707 or unset it will send Delete (code 127) or, if shifted, Backspace
638 (code 8) - which can be reversed with the appropriate DEC private 708 (code 8) - which can be reversed with the appropriate DEC private
654 724
655 inputMethod: *name* 725 inputMethod: *name*
656 *name* of inputMethod to use; option -im. 726 *name* of inputMethod to use; option -im.
657 727
658 imLocale: *name* 728 imLocale: *name*
659 The locale to use for opening the IM. You can use an LC_CTYPE of 729 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 730 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 731 the input extension to be able to input japanese characters while
662 staying in another locale. option -imlocale. 732 staying in another locale. option -imlocale.
733
734 imFont: *fontset*
735 Specify the font-set used for XIM styles "OverTheSpot" or
736 "OffTheSpot". It must be a standard X font set (XLFD patterns
737 separated by commas), i.e. it's not in the same format as the other
738 font lists used in rxvt. The default will be set-up to chose *any*
739 suitable found found, preferably one or two pixels differing in size
740 to the base font. option -imfont.
741
742 tripleclickwords: *boolean*
743 Change the meaning of triple-click selection with the left mouse
744 button. Instead of selecting a full line it will extend the
745 selection to the end of the logical line only. option -tcw.
663 746
664 insecure: *boolean* 747 insecure: *boolean*
665 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 748 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666 that echo arbitrary strings like the icon name or the locale. This 749 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, 750 could be abused if somebody gets 8-bit-clean access to your display,
690 option is enabled, scrolls on the secondary screen will change the 773 option is enabled, scrolls on the secondary screen will change the
691 scrollback buffer and switching to/from the secondary screen will 774 scrollback buffer and switching to/from the secondary screen will
692 instead scroll the screen up. 775 instead scroll the screen up.
693 776
694 keysym.*sym*: *string* 777 keysym.*sym*: *string*
695 Associate *string* with keysym *sym*. The intervening resource name 778 Compile *frills*: Associate *string* with keysym *sym*. The
696 keysym. cannot be omitted. This resource is only available when 779 intervening resource name keysym. cannot be omitted.
697 compiled with KEYSYM_RESOURCE.
698 780
699 The format of *sym* is "*(mask-)key*", where *mask* can be any 781 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
700 combination of Control, NumLock, Shift, Meta, Lock, Mod1, Mod2, 782 any combination of ISOLevel3, AppKeypad, Control, NumLock, Shift,
701 Mod3, Mod4, Mod5, and the abbreviated C, N, S, M, A, L, 1, 2, 3, 4, 783 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
784 C, N, S, M, A, L, 1, 2, 3, 4, 5.
785
786 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
787 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
788 Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
789 mapped to the current application keymap mode state.
790
702 5. The spellings of *key* can be obtained by using xev(1) command or 791 The spellings of *key* can be obtained by using xev(1) command or
703 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and 792 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
704 omit the prefix XK_. Alternatively you can specify *key* by its hex 793 omitting the prefix XK_. Alternatively you can specify *key* by its
705 keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s is 794 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
706 not performed in an exact manner; however, the closest match is 795 is not performed in an exact manner; however, the closest match is
707 assured. 796 assured.
708 797
709 *string* may contain escape values (\a: bell, \b: backspace, \e, \E: 798 *string* may contain escape values ("\a": bell, "\b": backspace,
710 escape, \n: newline, \r: return, \t: tab, \000: octal number) or 799 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
711 control characters (^?: delete, ^@: null, ^A ...) and may enclosed 800 "\000": octal number) or verbatim control characters ("^?": delete,
801 "^@": null, "^A" ...) and may be enclosed with double quotes so that
712 with double quotes so that it can start or end with whitespace. 802 it can start or end with whitespace.
803
804 Please note that you need to double the "\" when using
805 "--enable-xgetdefault", as X itself does it's own de-escaping (you
806 can use "\033" instead of "\e" (and so on), which will work with
807 both Xt and rxvt's own processing).
713 808
714 You can define a range of keysyms in one shot by providing a 809 You can define a range of keysyms in one shot by providing a
715 *string* with pattern list/STRING1/STRING2/STRING3, where the 810 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
716 delimeter `/' should be a character not used by the STRINGs. 811 `/' should be a character not used by the strings.
717 812
718 Its usage can be demonstrated by an example: URxvt.keysym.M-C-0x61: 813 Its usage can be demonstrated by an example:
719 list.abc.\e<M-C-.> 814
815 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
720 816
721 The above line is equivalent to the following three lines: 817 The above line is equivalent to the following three lines:
818
722 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 819 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
723 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 820 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
724 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 821 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
725 822
726 If *string* takes the form of proto:STRING, the specified STRING is 823 If *string* takes the form of "command:STRING", the specified STRING
727 interpreted and executed as rxvt's control sequence. For example, 824 is interpreted and executed as rxvt's control sequence. For example
728 "proto:\033]701;zh_CN.GBK\007" means changing the current locale to 825 the following means "change the current locale to "zh_CN.GBK" when
729 zh_CN.GBK. 826 Control-Meta-c is being pressed":
827
828 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
829
830 Due the the large number of modifier combinations, a defined key
831 mapping will match if at *at least* the specified identifiers are
832 being set, and no other key mappings with those and more bits are
833 being defined. That means that defining a key map for "a" will
834 automatically provide definitions for "Meta-a", "Shift-a" and so on,
835 unless some of those are defined mappings themselves.
836
837 Unfortunately, this will override built-in key mappings. For example
838 if you overwrite the "Insert" key you will disable rxvt's
839 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
840 the user-defined keymap using the "builtin:" replacement:
841
842 URxvt.keysym.Insert: <my insert key sequence>
843 URxvt.keysym.S-Insert: builtin:
844
845 The first line defines a mapping for "Insert" and *any* combination
846 of modifiers. The second line re-establishes the default mapping for
847 "Shift-Insert".
848
849 The following example will map Control-Meta-1 and Control-Meta-2 to
850 the fonts "suxuseuro" and "9x15bold", so you can have some limited
851 font-switching at runtime:
852
853 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
854 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
855
856 Other things are possible, e.g. resizing (see rxvt(7) for more
857 info):
858
859 URxvt.keysym.M-C-3: command:\033[8;25;80t
860 URxvt.keysym.M-C-4: command:\033[8;48;110t
730 861
731THE SCROLLBAR 862THE SCROLLBAR
732 Lines of text that scroll off the top of the rxvt window (resource: 863 Lines of text that scroll off the top of the rxvt window (resource:
733 saveLines) and can be scrolled back using the scrollbar or by 864 saveLines) and can be scrolled back using the scrollbar or by
734 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 865 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
744 normal text selection/insertion, hold either the Shift or the Meta (Alt) 875 normal text selection/insertion, hold either the Shift or the Meta (Alt)
745 key while performing the desired mouse action. 876 key while performing the desired mouse action.
746 877
747 If mouse reporting mode is active, the normal scrollbar actions are 878 If mouse reporting mode is active, the normal scrollbar actions are
748 disabled -- on the assumption that we are using a fullscreen 879 disabled -- on the assumption that we are using a fullscreen
749 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 880 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
750 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 881 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
751 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 882 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
752 883
753TEXT SELECTION AND INSERTION 884TEXT SELECTION AND INSERTION
754 The behaviour of text selection and insertion mechanism is similar to 885 The behaviour of text selection and insertion mechanism is similar to
755 *xterm*(1). 886 *xterm*(1).
756 887
757 Selection: 888 Selection:
758 Left click at the beginning of the region, drag to the end of the 889 Left click at the beginning of the region, drag to the end of the
759 region and release; Right click to extend the marked region; Left 890 region and release; Right click to extend the marked region; Left
760 double-click to select a word; Left triple-click to select the 891 double-click to select a word; Left triple-click to select the
761 entire line. 892 entire logical line (which can span multiple screen lines), unless
893 modified by resource tripleclickwords.
762 894
763 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 895 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
764 (Compile: frills) will create a rectangular selection instead of a 896 (Compile: *frills*) will create a rectangular selection instead of a
765 normal one. 897 normal one.
766 898
767 Insertion: 899 Insertion:
768 Pressing and releasing the Middle mouse button (or Shift-Insert) in 900 Pressing and releasing the Middle mouse button (or Shift-Insert) in
769 an rxvt window causes the current text selection to be inserted as 901 an rxvt window causes the current text selection to be inserted as
786 character codes using the keyboard. It consists of 4 parts. The first 918 character codes using the keyboard. It consists of 4 parts. The first
787 part is available rxvt-unicode has been compiled with "--enable-frills", 919 part is available rxvt-unicode has been compiled with "--enable-frills",
788 the rest is available when rxvt-unicode was compiled with 920 the rest is available when rxvt-unicode was compiled with
789 "--enable-iso14755". 921 "--enable-iso14755".
790 922
791 5.1: Basic method 923 * 5.1: Basic method
792 This allows you to enter unicode characters using their hexcode. 924 This allows you to enter unicode characters using their hexcode.
793 925
794 Start by pressing and holding both "Control" and "Shift", then enter 926 Start by pressing and holding both "Control" and "Shift", then enter
795 hex-digits (between one and six). Releasing "Control" and "Shift" 927 hex-digits (between one and six). Releasing "Control" and "Shift"
796 will commit the character as if it were typed directly. While 928 will commit the character as if it were typed directly. While
802 address, which you cannot type. Fortunately, the card has the e-mail 934 address, which you cannot type. Fortunately, the card has the e-mail
803 address printed as hexcodes, e.g. "671d 65e5". You can enter this 935 address printed as hexcodes, e.g. "671d 65e5". You can enter this
804 easily by pressing "Control" and "Shift", followed by 936 easily by pressing "Control" and "Shift", followed by
805 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 937 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
806 938
807 5.2: Keyboard symbols entry method 939 * 5.2: Keyboard symbols entry method
808 This mode lets you input characters representing the keycap symbols 940 This mode lets you input characters representing the keycap symbols
809 of your keyboard, if representable in the current locale encoding. 941 of your keyboard, if representable in the current locale encoding.
810 942
811 Start by pressing "Control" and "Shift" together, then releasing 943 Start by pressing "Control" and "Shift" together, then releasing
812 them. The next special key (cursor keys, home etc.) you enter will 944 them. The next special key (cursor keys, home etc.) you enter will
814 corresponding keycap symbol. The symbol will only be entered when 946 corresponding keycap symbol. The symbol will only be entered when
815 the key has been released, otherwise pressing e.g. "Shift" would 947 the key has been released, otherwise pressing e.g. "Shift" would
816 enter the symbol for "ISO Level 2 Switch", although your intention 948 enter the symbol for "ISO Level 2 Switch", although your intention
817 might have been to enter a reverse tab (Shift-Tab). 949 might have been to enter a reverse tab (Shift-Tab).
818 950
819 5.3: Screen-selection entry method 951 * 5.3: Screen-selection entry method
820 While this is implemented already (it's basically the selection 952 While this is implemented already (it's basically the selection
821 mechanism), it could be extended by displaying a unicode character 953 mechanism), it could be extended by displaying a unicode character
822 map. 954 map.
823 955
824 5.4: Feedback method for identifying displayed characters for later 956 * 5.4: Feedback method for identifying displayed characters for later
825 input 957 input
826 This method lets you display the unicode character code associated 958 This method lets you display the unicode character code associated
827 with characters already displayed. 959 with characters already displayed.
828 960
829 You enter this mode by holding down "Control" and "Shift" together, 961 You enter this mode by holding down "Control" and "Shift" together,
841 both scenario A and B of ISO 14755, including part 5.2. 973 both scenario A and B of ISO 14755, including part 5.2.
842 974
843LOGIN STAMP 975LOGIN STAMP
844 rxvt tries to write an entry into the *utmp*(5) file so that it can be 976 rxvt tries to write an entry into the *utmp*(5) file so that it can be
845 seen via the *who(1)* command, and can accept messages. To allow this 977 seen via the *who(1)* command, and can accept messages. To allow this
846 feature, rxvt must be installed setuid root on some systems. 978 feature, rxvt may need to be installed setuid root on some systems or
979 setgid to root or to some other group on others.
847 980
848COLORS AND GRAPHICS 981COLORS AND GRAPHICS
849 In addition to the default foreground and background colours, rxvt can 982 In addition to the default foreground and background colours, rxvt can
850 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 983 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
851 versions of the same). Here is a list of the colours with their rgb.txt 984 versions of the same). Here is a list of the colours with their rgb.txt
883 rxvt -fg Black -bg White -rv 1016 rxvt -fg Black -bg White -rv
884 would yield White on Black, while on *xterm*(1) it would yield Black 1017 would yield White on Black, while on *xterm*(1) it would yield Black
885 on White. 1018 on White.
886 1019
887ENVIRONMENT 1020ENVIRONMENT
888 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1021 rxvt sets and/or uses the following environment variables:
889 environment variable WINDOWID is set to the X window id number of the 1022
890 rxvt window and it also uses and sets the environment variable DISPLAY 1023 TERM
891 to specify which display terminal to use. rxvt uses the environment 1024 Normally set to "rxvt-unicode", unless overwritten at configure
892 variables RXVTPATH and PATH to find XPM files. 1025 time, via resources or on the commandline.
1026
1027 COLORTERM
1028 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1029 with XPM support, and optionally with the added extension "-mono" to
1030 indicate that rxvt-unicode runs on a monochrome screen.
1031
1032 COLORFGBG
1033 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1034 the colour code used as default foreground/text colour (or the
1035 string "default" to indicate that the default-colour escape sequence
1036 is to be used), "bg" is the colour code used as default background
1037 colour (or the string "default"), and "xpm" is the string "default"
1038 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1039 "slang" can (and do) use this information to optimize screen output.
1040
1041 WINDOWID
1042 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1043 window, which usually has subwindows for the scrollbar, the terminal
1044 window and so on).
1045
1046 TERMINFO
1047 Set to the terminfo directory iff rxvt was configured with
1048 "--with-terminfo=PATH".
1049
1050 DISPLAY
1051 Used by rxvt to connect to the display and set to the correct
1052 display in it's child processes.
1053
1054 SHELL
1055 The shell to be used for command execution, defaults to "/bin/sh".
1056
1057 RXVTPATH
1058 The path where rxvt looks for support files such as menu and xpm
1059 files.
1060
1061 PATH
1062 Used in the same way as "RXVTPATH".
1063
1064 RXVT_SOCKET
1065 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1066
1067 Default "$HOME/.rxvt-unicode-<nodename".
1068
1069 HOME
1070 Used to locate the default directory for the unix domain socket for
1071 daemon communications and to locate various resource files (such as
1072 ".Xdefaults")
1073
1074 XAPPLRESDIR
1075 Directory where various X resource files are being located.
1076
1077 XENVIRONMENT
1078 If set and accessible, gives the name of a X resource file to be
1079 loaded by rxvt.
893 1080
894FILES 1081FILES
895 /etc/utmp
896 System file for login records.
897
898 /usr/lib/X11/rgb.txt 1082 /usr/lib/X11/rgb.txt
899 Color names. 1083 Color names.
900 1084
901SEE ALSO 1085SEE ALSO
902 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1086 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
908 1092
909 Click-and-drag doesn't work with X11 mouse report overriding. 1093 Click-and-drag doesn't work with X11 mouse report overriding.
910 1094
911CURRENT PROJECT COORDINATOR 1095CURRENT PROJECT COORDINATOR
912 Project Coordinator 1096 Project Coordinator
913 Marc A. Lehmann rxvt@schmorp.de 1097 Marc A. Lehmann <rxvt-unicode@schmorp.de>
914 1098
915 Web page maintainter
916 Marc A. Lehmann rxvt@schmorp.de
917
918 <http://software.schmorp.de/> 1099 <http://software.schmorp.de/#rxvt-unicode>
919 1100
920AUTHORS 1101AUTHORS
921 John Bovey 1102 John Bovey
922 University of Kent, 1992, wrote the original Xvt. 1103 University of Kent, 1992, wrote the original Xvt.
923 1104
937 1118
938 Geoff Wing <gcw@pobox.com> 1119 Geoff Wing <gcw@pobox.com>
939 Rewrote screen display and text selection routines. Project 1120 Rewrote screen display and text selection routines. Project
940 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1121 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
941 1122
942 Marc Alexander Lehmann <rxvt@schmorp.de> 1123 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
943 Forked rxvt-unicode, rewrote most of the display code and internal 1124 Forked rxvt-unicode, rewrote most of the display code and internal
944 character handling to store text in unicode, improve xterm 1125 character handling to store text in unicode, improve xterm
945 compatibility and apply numerous other bugfixes and extensions. 1126 compatibility and apply numerous other bugfixes and extensions.
946 1127
947 Project Coordinator (Changes 1.0 -) 1128 Project Coordinator (Changes 1.0 -)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines