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.2 by root, Sun Jan 16 15:59:45 2005 UTC vs.
Revision 1.6 by root, Thu Feb 3 10:24:10 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 4.9, 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
… …
118 Window foreground colour; resource foreground. 118 Window foreground colour; resource foreground.
119 119
120 -pixmap *file[;geom]* 120 -pixmap *file[;geom]*
121 Compile *XPM*: Specify XPM file for the background and also 121 Compile *XPM*: Specify XPM file for the background and also
122 optionally specify its scaling with a geometry string. Note you may 122 optionally specify its scaling with a geometry string. Note you may
123 need to add quotes to avoid special shell interpretation of the `;' 123 need to add quotes to avoid special shell interpretation of the ";"
124 in the command-line; resource backgroundPixmap. 124 in the command-line; resource backgroundPixmap.
125 125
126 -cr *colour* 126 -cr *colour*
127 The cursor colour; resource cursorColor. 127 The cursor colour; resource cursorColor.
128 128
… …
277 277
278 -im *text* 278 -im *text*
279 Compile *XIM*: input method name. resource inputMethod. 279 Compile *XIM*: input method name. resource inputMethod.
280 280
281 -imlocale *string* 281 -imlocale *string*
282 The locale to use for opening the IM. You can use an LC_CTYPE of 282 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 283 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 284 the input extension to be able to input japanese characters while
285 staying in another locale. 285 staying in another locale. resource imLocale.
286
287 -imfont *fontset*
288 Set the font set to use for the X Input Method, see resource imFont
289 for more info.
290
291 -tcw
292 Change the meaning of triple-click selection with the left mouse
293 button. Instead of selecting a full line it will extend the
294 selection the end of the logical line only. resource
295 tripleclickwords.
286 296
287 -insecure 297 -insecure
288 Enable "insecure" mode, which currently enables most of the escape 298 Enable "insecure" mode, which currently enables most of the escape
289 sequences that echo strings. See the resource insecure for more 299 sequences that echo strings. See the resource insecure for more
290 info. 300 info.
… …
359 369
360 colorBD: *colour* 370 colorBD: *colour*
361 colorIT: *colour* 371 colorIT: *colour*
362 Use the specified colour to display bold or italic characters when 372 Use the specified colour to display bold or italic characters when
363 the foreground colour is the default. If font styles are not 373 the foreground colour is the default. If font styles are not
364 available (Compile styles) and this option is unset, reverse video 374 available (Compile *styles*) and this option is unset, reverse video
365 is used instead. 375 is used instead.
366 376
367 colorUL: *colour* 377 colorUL: *colour*
368 Use the specified colour to display underlined characters when the 378 Use the specified colour to display underlined characters when the
369 foreground colour is the default. 379 foreground colour is the default.
… …
449 characters. The first font defines the cell size for characters; 459 characters. The first font defines the cell size for characters;
450 other fonts might be smaller, but not larger. A reasonable default 460 other fonts might be smaller, but not larger. A reasonable default
451 font list is always appended to it. option -fn. 461 font list is always appended to it. option -fn.
452 462
453 Each font can either be a standard X11 core font (XLFD) name, with 463 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 464 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
455 "xft:". 465 "xft:".
456 466
457 In addition, each font can be prefixed with additional hints and 467 In addition, each font can be prefixed with additional hints and
458 specifications enclosed in square brackets ("[]"). The only 468 specifications enclosed in square brackets ("[]"). The only
459 available hint currently is "codeset=codeset-name", and this is only 469 available hint currently is "codeset=codeset-name", and this is only
… …
654 664
655 inputMethod: *name* 665 inputMethod: *name*
656 *name* of inputMethod to use; option -im. 666 *name* of inputMethod to use; option -im.
657 667
658 imLocale: *name* 668 imLocale: *name*
659 The locale to use for opening the IM. You can use an LC_CTYPE of 669 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 670 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 671 the input extension to be able to input japanese characters while
662 staying in another locale. option -imlocale. 672 staying in another locale. option -imlocale.
673
674 imFont: *fontset*
675 Specify the font-set used for XIM styles "OverTheSpot" or
676 "OffTheSpot". It must be a standard X font set (XLFD patterns
677 separated by commas), i.e. it's not in the same format as the other
678 font lists used in rxvt. The default will be set-up to chose *any*
679 suitable found found, preferably one or two pixels differing in size
680 to the base font. option -imfont.
681
682 tripleclickwords: *boolean*
683 Change the meaning of triple-click selection with the left mouse
684 button. Instead of selecting a full line it will extend the
685 selection to the end of the logical line only. option -tcw.
663 686
664 insecure: *boolean* 687 insecure: *boolean*
665 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 688 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666 that echo arbitrary strings like the icon name or the locale. This 689 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, 690 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 713 option is enabled, scrolls on the secondary screen will change the
691 scrollback buffer and switching to/from the secondary screen will 714 scrollback buffer and switching to/from the secondary screen will
692 instead scroll the screen up. 715 instead scroll the screen up.
693 716
694 keysym.*sym*: *string* 717 keysym.*sym*: *string*
695 Associate *string* with keysym *sym*. The intervening resource name 718 Compile *frills*: Associate *string* with keysym *sym*. The
696 keysym. cannot be omitted. This resource is only available when 719 intervening resource name keysym. cannot be omitted.
697 compiled with KEYSYM_RESOURCE.
698 720
699 The format of *sym* is "*(mask-)key*", where *mask* can be any 721 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
700 combination of Control, NumLock, Shift, Meta, Lock, Mod1, Mod2, 722 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, 723 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
724 C, N, S, M, A, L, 1, 2, 3, 4, 5.
725
726 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
727 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
728 Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
729 mapped to the current application keymap mode state.
730
702 5. The spellings of *key* can be obtained by using xev(1) command or 731 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 732 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
704 omit the prefix XK_. Alternatively you can specify *key* by its hex 733 omitting the prefix XK_. Alternatively you can specify *key* by its
705 keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s is 734 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
706 not performed in an exact manner; however, the closest match is 735 is not performed in an exact manner; however, the closest match is
707 assured. 736 assured.
708 737
709 *string* may contain escape values (\a: bell, \b: backspace, \e, \E: 738 *string* may contain escape values ("\a": bell, "\b": backspace,
710 escape, \n: newline, \r: return, \t: tab, \000: octal number) or 739 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
711 control characters (^?: delete, ^@: null, ^A ...) and may enclosed 740 "\000": octal number) or verbatim control characters ("^?": delete,
741 "^@": null, "^A" ...) and may be enclosed with double quotes so that
712 with double quotes so that it can start or end with whitespace. 742 it can start or end with whitespace.
713 743
714 You can define a range of keysyms in one shot by providing a 744 You can define a range of keysyms in one shot by providing a
715 *string* with pattern list/STRING1/STRING2/STRING3, where the 745 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
716 delimeter `/' should be a character not used by the STRINGs. 746 `/' should be a character not used by the strings.
717 747
718 Its usage can be demonstrated by an example: URxvt.keysym.M-C-0x61: 748 Its usage can be demonstrated by an example:
719 list.abc.\e<M-C-.> 749
750 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|>
720 751
721 The above line is equivalent to the following three lines: 752 The above line is equivalent to the following three lines:
753
722 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 754 URxvt.keysym.Meta-Control-0x61: \e<M-C-a>
723 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 755 URxvt.keysym.Meta-Control-0x62: \e<M-C-b>
724 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 756 URxvt.keysym.Meta-Control-0x63: \e<M-C-c>
725 757
726 If *string* takes the form of proto:STRING, the specified STRING is 758 If *string* takes the form of "proto:STRING", the specified STRING
727 interpreted and executed as rxvt's control sequence. For example, 759 is interpreted and executed as rxvt's control sequence. For example
760 the following means "change the current locale to "zh_CN.GBK" when
761 Control-Meta-c is being pressed":
762
763 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007
764
765 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
767 font-switching at runtime:
768
769 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007
770 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007
771
728 "proto:\033]701;zh_CN.GBK\007" means changing the current locale to 772 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to
729 zh_CN.GBK. 773 "zh_CN.GBK".
730 774
731THE SCROLLBAR 775THE SCROLLBAR
732 Lines of text that scroll off the top of the rxvt window (resource: 776 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 777 saveLines) and can be scrolled back using the scrollbar or by
734 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 778 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
756 800
757 Selection: 801 Selection:
758 Left click at the beginning of the region, drag to the end of the 802 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 803 region and release; Right click to extend the marked region; Left
760 double-click to select a word; Left triple-click to select the 804 double-click to select a word; Left triple-click to select the
761 entire line. 805 entire logical line (which can span multiple screen lines), unless
806 modified by resource tripleclickwords.
762 807
763 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 808 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
764 (Compile: frills) will create a rectangular selection instead of a 809 (Compile: *frills*) will create a rectangular selection instead of a
765 normal one. 810 normal one.
766 811
767 Insertion: 812 Insertion:
768 Pressing and releasing the Middle mouse button (or Shift-Insert) in 813 Pressing and releasing the Middle mouse button (or Shift-Insert) in
769 an rxvt window causes the current text selection to be inserted as 814 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 831 character codes using the keyboard. It consists of 4 parts. The first
787 part is available rxvt-unicode has been compiled with "--enable-frills", 832 part is available rxvt-unicode has been compiled with "--enable-frills",
788 the rest is available when rxvt-unicode was compiled with 833 the rest is available when rxvt-unicode was compiled with
789 "--enable-iso14755". 834 "--enable-iso14755".
790 835
791 5.1: Basic method 836 * 5.1: Basic method
792 This allows you to enter unicode characters using their hexcode. 837 This allows you to enter unicode characters using their hexcode.
793 838
794 Start by pressing and holding both "Control" and "Shift", then enter 839 Start by pressing and holding both "Control" and "Shift", then enter
795 hex-digits (between one and six). Releasing "Control" and "Shift" 840 hex-digits (between one and six). Releasing "Control" and "Shift"
796 will commit the character as if it were typed directly. While 841 will commit the character as if it were typed directly. While
… …
802 address, which you cannot type. Fortunately, the card has the e-mail 847 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 848 address printed as hexcodes, e.g. "671d 65e5". You can enter this
804 easily by pressing "Control" and "Shift", followed by 849 easily by pressing "Control" and "Shift", followed by
805 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 850 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
806 851
807 5.2: Keyboard symbols entry method 852 * 5.2: Keyboard symbols entry method
808 This mode lets you input characters representing the keycap symbols 853 This mode lets you input characters representing the keycap symbols
809 of your keyboard, if representable in the current locale encoding. 854 of your keyboard, if representable in the current locale encoding.
810 855
811 Start by pressing "Control" and "Shift" together, then releasing 856 Start by pressing "Control" and "Shift" together, then releasing
812 them. The next special key (cursor keys, home etc.) you enter will 857 them. The next special key (cursor keys, home etc.) you enter will
… …
814 corresponding keycap symbol. The symbol will only be entered when 859 corresponding keycap symbol. The symbol will only be entered when
815 the key has been released, otherwise pressing e.g. "Shift" would 860 the key has been released, otherwise pressing e.g. "Shift" would
816 enter the symbol for "ISO Level 2 Switch", although your intention 861 enter the symbol for "ISO Level 2 Switch", although your intention
817 might have been to enter a reverse tab (Shift-Tab). 862 might have been to enter a reverse tab (Shift-Tab).
818 863
819 5.3: Screen-selection entry method 864 * 5.3: Screen-selection entry method
820 While this is implemented already (it's basically the selection 865 While this is implemented already (it's basically the selection
821 mechanism), it could be extended by displaying a unicode character 866 mechanism), it could be extended by displaying a unicode character
822 map. 867 map.
823 868
824 5.4: Feedback method for identifying displayed characters for later 869 * 5.4: Feedback method for identifying displayed characters for later
825 input 870 input
826 This method lets you display the unicode character code associated 871 This method lets you display the unicode character code associated
827 with characters already displayed. 872 with characters already displayed.
828 873
829 You enter this mode by holding down "Control" and "Shift" together, 874 You enter this mode by holding down "Control" and "Shift" together,
… …
841 both scenario A and B of ISO 14755, including part 5.2. 886 both scenario A and B of ISO 14755, including part 5.2.
842 887
843LOGIN STAMP 888LOGIN STAMP
844 rxvt tries to write an entry into the *utmp*(5) file so that it can be 889 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 890 seen via the *who(1)* command, and can accept messages. To allow this
846 feature, rxvt must be installed setuid root on some systems. 891 feature, rxvt may need to be installed setuid root on some systems or
892 setgid to root or to some other group on others.
847 893
848COLORS AND GRAPHICS 894COLORS AND GRAPHICS
849 In addition to the default foreground and background colours, rxvt can 895 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 896 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 897 versions of the same). Here is a list of the colours with their rgb.txt
… …
890 rxvt window and it also uses and sets the environment variable DISPLAY 936 rxvt window and it also uses and sets the environment variable DISPLAY
891 to specify which display terminal to use. rxvt uses the environment 937 to specify which display terminal to use. rxvt uses the environment
892 variables RXVTPATH and PATH to find XPM files. 938 variables RXVTPATH and PATH to find XPM files.
893 939
894FILES 940FILES
895 /etc/utmp
896 System file for login records.
897
898 /usr/lib/X11/rgb.txt 941 /usr/lib/X11/rgb.txt
899 Color names. 942 Color names.
900 943
901SEE ALSO 944SEE ALSO
902 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 945 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)

Diff Legend

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