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.19 by root, Sat Feb 19 01:08:26 2005 UTC vs.
Revision 1.26 by root, Sat Dec 17 20:55:45 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 5.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 5.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
… …
93 Turn on/off simulated reverse video; resource reverseVideo. 93 Turn on/off simulated reverse video; resource reverseVideo.
94 94
95 -j|+j 95 -j|+j
96 Turn on/off jump scrolling; resource jumpScroll. 96 Turn on/off jump scrolling; resource jumpScroll.
97 97
98 -ip|+ip 98 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 99 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 100 -tr; resource inheritPixmap.
101 101
102 -fade *number* 102 -fade *number*
103 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
104 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.
105 110
106 -tint *colour* 111 -tint *colour*
107 Tint the transparent background pixmap with the given colour when 112 Tint the transparent background pixmap with the given colour when
108 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
109 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;
110 tinting it. 116 resource *tintColor*. Example:
117
118 rxvt -tr -tint blue -sh 40
111 119
112 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
113 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
114 specified, too, e.g. "-tint white"). 122 specified, too, e.g. "-tint white").
115 123
… …
204 212
205 -sr|+sr 213 -sr|+sr
206 Put scrollbar on right/left; resource scrollBar_right. 214 Put scrollbar on right/left; resource scrollBar_right.
207 215
208 -st|+st 216 -st|+st
209 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 217 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
210 resource scrollBar_floating. 218 resource scrollBar_floating.
211 219
212 -ptab|+ptab 220 -ptab|+ptab
213 If enabled (default), "Horizontal Tab" characters are being stored 221 If enabled (default), "Horizontal Tab" characters are being stored
214 as actual wide characters in the screen buffer, which makes it 222 as actual wide characters in the screen buffer, which makes it
… …
467 True: make the background inherit the parent windows' pixmap, giving 475 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 476 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 477 pixmap.
470 478
471 fading: *number* 479 fading: *number*
472 Fade the text by the given percentage when focus is lost. 480 Fade the text by the given percentage when focus is lost; option
481 -fade.
482
483 fadeColor: *colour*
484 Fade to this colour, when fading is used (see fading:). The default
485 colour is black; option -fadecolor.
473 486
474 tintColor: *colour* 487 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 488 Tint the transparent background pixmap with the given colour; option
489 -tint.
476 490
477 shading: *number* 491 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 492 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 493 image in addition to tinting it.
480 494
481 scrollColor: *colour* 495 scrollColor: *colour*
482 Use the specified colour for the scrollbar [default #B2B2B2]. 496 Use the specified colour for the scrollbar [default #B2B2B2].
483 497
484 troughColor: *colour* 498 troughColor: *colour*
485 Use the specified colour for the scrollbar's trough area [default 499 Use the specified colour for the scrollbar's trough area [default
486 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 500 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
487 501
488 borderColor: *colour* 502 borderColor: *colour*
489 The colour of the border around the text area and between the 503 The colour of the border around the text area and between the
490 scrollbar and the text. 504 scrollbar and the text.
491 505
… …
577 xterm style with 2.20 old word selection, or anything else which 591 xterm style with 2.20 old word selection, or anything else which
578 gives xterm style selection. 592 gives xterm style selection.
579 593
580 scrollstyle: *mode* 594 scrollstyle: *mode*
581 Set scrollbar style to rxvt, plain, next or xterm. plain is the 595 Set scrollbar style to rxvt, plain, next or xterm. plain is the
582 author's favourite.. 596 author's favourite.
583 597
584 title: *string* 598 title: *string*
585 Set window title string, the default title is the command-line 599 Set window title string, the default title is the command-line
586 specified after the -e option, if any, otherwise the application 600 specified after the -e option, if any, otherwise the application
587 name; option -title. 601 name; option -title.
… …
611 625
612 print-pipe: *string* 626 print-pipe: *string*
613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 627 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
614 Print to initiate a screen dump to the printer and Ctrl-Print or 628 Print to initiate a screen dump to the printer and Ctrl-Print or
615 Shift-Print to include the scrollback as well. 629 Shift-Print to include the scrollback as well.
630
631 The string will be interpreted as if typed into the shell as-is.
632
633 Example:
634
635 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
636
637 This creates a new file in your home directory with the screen
638 contents everytime you hit "Print".
616 639
617 scrollBar: *boolean* 640 scrollBar: *boolean*
618 True: enable the scrollbar [default]; option -sb. False: disable the 641 True: enable the scrollbar [default]; option -sb. False: disable the
619 scrollbar; option +sb. 642 scrollbar; option +sb.
620 643
… …
697 pointerColor2: *colour* 720 pointerColor2: *colour*
698 Mouse pointer background colour. 721 Mouse pointer background colour.
699 722
700 pointerBlankDelay: *number* 723 pointerBlankDelay: *number*
701 Specifies number of seconds before blanking the pointer [default 2]. 724 Specifies number of seconds before blanking the pointer [default 2].
725 Use a large number (e.g. 987654321) to effectively disable the
726 timeout.
702 727
703 backspacekey: *string* 728 backspacekey: *string*
704 The string to send when the backspace key is pressed. If set to DEC 729 The string to send when the backspace key is pressed. If set to DEC
705 or unset it will send Delete (code 127) or, if shifted, Backspace 730 or unset it will send Delete (code 127) or, if shifted, Backspace
706 (code 8) - which can be reversed with the appropriate DEC private 731 (code 8) - which can be reversed with the appropriate DEC private
… …
744 769
745 insecure: *boolean* 770 insecure: *boolean*
746 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
747 that echo arbitrary strings like the icon name or the locale. This 772 that echo arbitrary strings like the icon name or the locale. This
748 could be abused if somebody gets 8-bit-clean access to your display, 773 could be abused if somebody gets 8-bit-clean access to your display,
749 whether throuh a mail client displaying mail bodies unfiltered or 774 whether through a mail client displaying mail bodies unfiltered or
750 though write(1). Therefore, these sequences are disabled by default. 775 through write(1) or any other means. Therefore, these sequences are
751 (Note that other terminals, including xterm, have these sequences 776 disabled by default. (Note that many other terminals, including
752 enabled by default). You can enable them by setting this boolean 777 xterm, have these sequences enabled by default, which doesn't make
753 resource or specifying -insecure as an option. At the moment, this 778 it safer, though).
754 enabled display-answer, locale, findfont, icon label and window 779
755 title requests as well as dynamic menubar dispatch. 780 You can enable them by setting this boolean resource or specifying
781 -insecure as an option. At the moment, this enables display-answer,
782 locale, findfont, icon label and window title requests as well as
783 dynamic menubar dispatch.
756 784
757 modifier: *modifier* 785 modifier: *modifier*
758 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 786 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
759 super, mod1, mod2, mod3, mod4, mod5; option -mod. 787 super, mod1, mod2, mod3, mod4, mod5; option -mod.
760 788
… …
823 the following means "change the current locale to "zh_CN.GBK" when 851 the following means "change the current locale to "zh_CN.GBK" when
824 Control-Meta-c is being pressed": 852 Control-Meta-c is being pressed":
825 853
826 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 854 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
827 855
856 Due the the large number of modifier combinations, a defined key
857 mapping will match if at *at least* the specified identifiers are
858 being set, and no other key mappings with those and more bits are
859 being defined. That means that defining a key map for "a" will
860 automatically provide definitions for "Meta-a", "Shift-a" and so on,
861 unless some of those are defined mappings themselves.
862
863 Unfortunately, this will override built-in key mappings. For example
864 if you overwrite the "Insert" key you will disable rxvt's
865 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
866 the user-defined keymap using the "builtin:" replacement:
867
868 URxvt.keysym.Insert: <my insert key sequence>
869 URxvt.keysym.S-Insert: builtin:
870
871 The first line defines a mapping for "Insert" and *any* combination
872 of modifiers. The second line re-establishes the default mapping for
873 "Shift-Insert".
874
828 The following example will map Control-Meta-1 and Control-Meta-2 to 875 The following example will map Control-Meta-1 and Control-Meta-2 to
829 the fonts "suxuseuro" and "9x15bold", so you can have some limited 876 the fonts "suxuseuro" and "9x15bold", so you can have some limited
830 font-switching at runtime: 877 font-switching at runtime:
831 878
832 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 879 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
885 supported in rxvt-unicode. Bug me if you need this. 932 supported in rxvt-unicode. Bug me if you need this.
886 933
887 You can, however, switch fonts at runtime using escape sequences (and 934 You can, however, switch fonts at runtime using escape sequences (and
888 therefore using the menubar), e.g.: 935 therefore using the menubar), e.g.:
889 936
890 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 937 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
891 938
892 rxvt-unicode will automatically re-apply these fonts to the output so 939 rxvt-unicode will automatically re-apply these fonts to the output so
893 far. 940 far.
894 941
895ISO 14755 SUPPORT 942ISO 14755 SUPPORT
… …
1041 Used in the same way as "RXVTPATH". 1088 Used in the same way as "RXVTPATH".
1042 1089
1043 RXVT_SOCKET 1090 RXVT_SOCKET
1044 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1091 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1045 1092
1046 Default "$HOME/.rxvt-unicode-<nodename". 1093 Default $HOME/.rxvt-unicode-*<nodename*.
1047 1094
1048 HOME 1095 HOME
1049 Used to locate the default directory for the unix domain socket for 1096 Used to locate the default directory for the unix domain socket for
1050 daemon communications and to locate various resource files (such as 1097 daemon communications and to locate various resource files (such as
1051 ".Xdefaults") 1098 ".Xdefaults")
… …
1060FILES 1107FILES
1061 /usr/lib/X11/rgb.txt 1108 /usr/lib/X11/rgb.txt
1062 Color names. 1109 Color names.
1063 1110
1064SEE ALSO 1111SEE ALSO
1065 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1112 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1066 1113 tty(4), utmp(5)
1067BUGS
1068 Check the BUGS file for an up-to-date list.
1069
1070 Cursor change support is not yet implemented.
1071
1072 Click-and-drag doesn't work with X11 mouse report overriding.
1073 1114
1074CURRENT PROJECT COORDINATOR 1115CURRENT PROJECT COORDINATOR
1075 Project Coordinator 1116 Project Coordinator
1076 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1117 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1077 1118

Diff Legend

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