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.19 by root, Sat Feb 19 01:08:26 2005 UTC vs.
Revision 1.27 by root, Thu Dec 22 16:44: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 5.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.0, 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
… …
259 on the command line. If this option is used, it must be the last on 267 on the command line. If this option is used, it must be the last on
260 the command-line. If there is no -e option then the default is to 268 the command-line. If there is no -e option then the default is to
261 run the program specified by the SHELL environment variable or, 269 run the program specified by the SHELL environment variable or,
262 failing that, *sh(1)*. 270 failing that, *sh(1)*.
263 271
272 Please note that you must specify a program with arguments. If you
273 want to run shell commands, you have to specify the shell, like
274 this:
275
276 rxvt -e sh -c "shell commands"
277
264 -title *text* 278 -title *text*
265 Window title (-T still respected); the default title is the basename 279 Window title (-T still respected); the default title is the basename
266 of the program specified after the -e option, if any, otherwise the 280 of the program specified after the -e option, if any, otherwise the
267 application name; resource title. 281 application name; resource title.
268 282
… …
310 secondaryScreen. 324 secondaryScreen.
311 325
312 -ssr|+ssr 326 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 327 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 328 secondaryScroll.
329
330 -hold|+hold
331 Turn on/off hold window after exit support. If enabled, rxvt will
332 not immediately destroy its window when the program executed within
333 it exits. Instead, it will wait till it is being killed or closed by
334 the user; resource hold.
315 335
316 -keysym.*sym* *string* 336 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 337 Remap a key symbol. See resource keysym.
318 338
319 -embed *windowid* 339 -embed *windowid*
… …
467 True: make the background inherit the parent windows' pixmap, giving 487 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 488 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 489 pixmap.
470 490
471 fading: *number* 491 fading: *number*
472 Fade the text by the given percentage when focus is lost. 492 Fade the text by the given percentage when focus is lost; option
493 -fade.
494
495 fadeColor: *colour*
496 Fade to this colour, when fading is used (see fading:). The default
497 colour is black; option -fadecolor.
473 498
474 tintColor: *colour* 499 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 500 Tint the transparent background pixmap with the given colour; option
501 -tint.
476 502
477 shading: *number* 503 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 504 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 505 image in addition to tinting it.
480 506
481 scrollColor: *colour* 507 scrollColor: *colour*
482 Use the specified colour for the scrollbar [default #B2B2B2]. 508 Use the specified colour for the scrollbar [default #B2B2B2].
483 509
484 troughColor: *colour* 510 troughColor: *colour*
485 Use the specified colour for the scrollbar's trough area [default 511 Use the specified colour for the scrollbar's trough area [default
486 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 512 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
487 513
488 borderColor: *colour* 514 borderColor: *colour*
489 The colour of the border around the text area and between the 515 The colour of the border around the text area and between the
490 scrollbar and the text. 516 scrollbar and the text.
491 517
… …
577 xterm style with 2.20 old word selection, or anything else which 603 xterm style with 2.20 old word selection, or anything else which
578 gives xterm style selection. 604 gives xterm style selection.
579 605
580 scrollstyle: *mode* 606 scrollstyle: *mode*
581 Set scrollbar style to rxvt, plain, next or xterm. plain is the 607 Set scrollbar style to rxvt, plain, next or xterm. plain is the
582 author's favourite.. 608 author's favourite.
583 609
584 title: *string* 610 title: *string*
585 Set window title string, the default title is the command-line 611 Set window title string, the default title is the command-line
586 specified after the -e option, if any, otherwise the application 612 specified after the -e option, if any, otherwise the application
587 name; option -title. 613 name; option -title.
… …
611 637
612 print-pipe: *string* 638 print-pipe: *string*
613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 639 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 640 Print to initiate a screen dump to the printer and Ctrl-Print or
615 Shift-Print to include the scrollback as well. 641 Shift-Print to include the scrollback as well.
642
643 The string will be interpreted as if typed into the shell as-is.
644
645 Example:
646
647 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
648
649 This creates a new file in your home directory with the screen
650 contents everytime you hit "Print".
616 651
617 scrollBar: *boolean* 652 scrollBar: *boolean*
618 True: enable the scrollbar [default]; option -sb. False: disable the 653 True: enable the scrollbar [default]; option -sb. False: disable the
619 scrollbar; option +sb. 654 scrollbar; option +sb.
620 655
… …
697 pointerColor2: *colour* 732 pointerColor2: *colour*
698 Mouse pointer background colour. 733 Mouse pointer background colour.
699 734
700 pointerBlankDelay: *number* 735 pointerBlankDelay: *number*
701 Specifies number of seconds before blanking the pointer [default 2]. 736 Specifies number of seconds before blanking the pointer [default 2].
737 Use a large number (e.g. 987654321) to effectively disable the
738 timeout.
702 739
703 backspacekey: *string* 740 backspacekey: *string*
704 The string to send when the backspace key is pressed. If set to DEC 741 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 742 or unset it will send Delete (code 127) or, if shifted, Backspace
706 (code 8) - which can be reversed with the appropriate DEC private 743 (code 8) - which can be reversed with the appropriate DEC private
… …
744 781
745 insecure: *boolean* 782 insecure: *boolean*
746 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 783 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
747 that echo arbitrary strings like the icon name or the locale. This 784 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, 785 could be abused if somebody gets 8-bit-clean access to your display,
749 whether throuh a mail client displaying mail bodies unfiltered or 786 whether through a mail client displaying mail bodies unfiltered or
750 though write(1). Therefore, these sequences are disabled by default. 787 through write(1) or any other means. Therefore, these sequences are
751 (Note that other terminals, including xterm, have these sequences 788 disabled by default. (Note that many other terminals, including
752 enabled by default). You can enable them by setting this boolean 789 xterm, have these sequences enabled by default, which doesn't make
753 resource or specifying -insecure as an option. At the moment, this 790 it safer, though).
754 enabled display-answer, locale, findfont, icon label and window 791
755 title requests as well as dynamic menubar dispatch. 792 You can enable them by setting this boolean resource or specifying
793 -insecure as an option. At the moment, this enables display-answer,
794 locale, findfont, icon label and window title requests as well as
795 dynamic menubar dispatch.
756 796
757 modifier: *modifier* 797 modifier: *modifier*
758 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 798 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
759 super, mod1, mod2, mod3, mod4, mod5; option -mod. 799 super, mod1, mod2, mod3, mod4, mod5; option -mod.
760 800
… …
769 secondaryScroll: *bool* 809 secondaryScroll: *bool*
770 Turn on/off secondary screen scroll (default enabled). If the this 810 Turn on/off secondary screen scroll (default enabled). If the this
771 option is enabled, scrolls on the secondary screen will change the 811 option is enabled, scrolls on the secondary screen will change the
772 scrollback buffer and switching to/from the secondary screen will 812 scrollback buffer and switching to/from the secondary screen will
773 instead scroll the screen up. 813 instead scroll the screen up.
814
815 hold: *bool*
816 Turn on/off hold window after exit support. If enabled, rxvt will
817 not immediately destroy its window when the program executed within
818 it exits. Instead, it will wait till it is being killed or closed by
819 the user.
774 820
775 keysym.*sym*: *string* 821 keysym.*sym*: *string*
776 Compile *frills*: Associate *string* with keysym *sym*. The 822 Compile *frills*: Associate *string* with keysym *sym*. The
777 intervening resource name keysym. cannot be omitted. 823 intervening resource name keysym. cannot be omitted.
778 824
… …
823 the following means "change the current locale to "zh_CN.GBK" when 869 the following means "change the current locale to "zh_CN.GBK" when
824 Control-Meta-c is being pressed": 870 Control-Meta-c is being pressed":
825 871
826 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 872 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
827 873
874 Due the the large number of modifier combinations, a defined key
875 mapping will match if at *at least* the specified identifiers are
876 being set, and no other key mappings with those and more bits are
877 being defined. That means that defining a key map for "a" will
878 automatically provide definitions for "Meta-a", "Shift-a" and so on,
879 unless some of those are defined mappings themselves.
880
881 Unfortunately, this will override built-in key mappings. For example
882 if you overwrite the "Insert" key you will disable rxvt's
883 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
884 the user-defined keymap using the "builtin:" replacement:
885
886 URxvt.keysym.Insert: <my insert key sequence>
887 URxvt.keysym.S-Insert: builtin:
888
889 The first line defines a mapping for "Insert" and *any* combination
890 of modifiers. The second line re-establishes the default mapping for
891 "Shift-Insert".
892
828 The following example will map Control-Meta-1 and Control-Meta-2 to 893 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 894 the fonts "suxuseuro" and "9x15bold", so you can have some limited
830 font-switching at runtime: 895 font-switching at runtime:
831 896
832 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 897 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
885 supported in rxvt-unicode. Bug me if you need this. 950 supported in rxvt-unicode. Bug me if you need this.
886 951
887 You can, however, switch fonts at runtime using escape sequences (and 952 You can, however, switch fonts at runtime using escape sequences (and
888 therefore using the menubar), e.g.: 953 therefore using the menubar), e.g.:
889 954
890 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 955 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
891 956
892 rxvt-unicode will automatically re-apply these fonts to the output so 957 rxvt-unicode will automatically re-apply these fonts to the output so
893 far. 958 far.
894 959
895ISO 14755 SUPPORT 960ISO 14755 SUPPORT
… …
1041 Used in the same way as "RXVTPATH". 1106 Used in the same way as "RXVTPATH".
1042 1107
1043 RXVT_SOCKET 1108 RXVT_SOCKET
1044 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1109 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1045 1110
1046 Default "$HOME/.rxvt-unicode-<nodename". 1111 Default $HOME/.rxvt-unicode-*<nodename*.
1047 1112
1048 HOME 1113 HOME
1049 Used to locate the default directory for the unix domain socket for 1114 Used to locate the default directory for the unix domain socket for
1050 daemon communications and to locate various resource files (such as 1115 daemon communications and to locate various resource files (such as
1051 ".Xdefaults") 1116 ".Xdefaults")
… …
1060FILES 1125FILES
1061 /usr/lib/X11/rgb.txt 1126 /usr/lib/X11/rgb.txt
1062 Color names. 1127 Color names.
1063 1128
1064SEE ALSO 1129SEE ALSO
1065 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1130 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1066 1131 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 1132
1074CURRENT PROJECT COORDINATOR 1133CURRENT PROJECT COORDINATOR
1075 Project Coordinator 1134 Project Coordinator
1076 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1135 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1077 1136

Diff Legend

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