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.24 by root, Tue Oct 25 20:04:59 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.8, 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
822 is interpreted and executed as rxvt's control sequence. For example 847 is interpreted and executed as rxvt's control sequence. For example
823 the following means "change the current locale to "zh_CN.GBK" when 848 the following means "change the current locale to "zh_CN.GBK" when
824 Control-Meta-c is being pressed": 849 Control-Meta-c is being pressed":
825 850
826 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 851 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
852
853 Due the the large number of modifier combinations, a defined key
854 mapping will match if at *at least* the specified identifiers are
855 being set, and no other key mappings with those and more bits are
856 being defined. That means that defining a key map for "a" will
857 automatically provide definitions for "Meta-a", "Shift-a" and so on,
858 unless some of those are defined mappings themselves.
859
860 Unfortunately, this will override built-in key mappings. For example
861 if you overwrite the "Insert" key you will disable rxvt's
862 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
863 the user-defined keymap using the "builtin:" replacement:
864
865 URxvt.keysym.Insert: <my insert key sequence>
866 URxvt.keysym.S-Insert: builtin:
867
868 The first line defines a mapping for "Insert" and *any* combination
869 of modifiers. The second line re-establishes the default mapping for
870 "Shift-Insert".
827 871
828 The following example will map Control-Meta-1 and Control-Meta-2 to 872 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 873 the fonts "suxuseuro" and "9x15bold", so you can have some limited
830 font-switching at runtime: 874 font-switching at runtime:
831 875
1041 Used in the same way as "RXVTPATH". 1085 Used in the same way as "RXVTPATH".
1042 1086
1043 RXVT_SOCKET 1087 RXVT_SOCKET
1044 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1088 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1045 1089
1046 Default "$HOME/.rxvt-unicode-<nodename". 1090 Default $HOME/.rxvt-unicode-*<nodename*.
1047 1091
1048 HOME 1092 HOME
1049 Used to locate the default directory for the unix domain socket for 1093 Used to locate the default directory for the unix domain socket for
1050 daemon communications and to locate various resource files (such as 1094 daemon communications and to locate various resource files (such as
1051 ".Xdefaults") 1095 ".Xdefaults")
1060FILES 1104FILES
1061 /usr/lib/X11/rgb.txt 1105 /usr/lib/X11/rgb.txt
1062 Color names. 1106 Color names.
1063 1107
1064SEE ALSO 1108SEE ALSO
1065 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1109 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1110 tty(4), utmp(5)
1066 1111
1067BUGS 1112BUGS
1068 Check the BUGS file for an up-to-date list. 1113 Check the BUGS file for an up-to-date list.
1069 1114
1070 Cursor change support is not yet implemented. 1115 Cursor change support is not yet implemented.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines