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.20 by root, Sun Apr 17 22:36:13 2005 UTC vs.
Revision 1.28 by root, Tue Dec 27 12:24:09 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.3, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.1, 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
… …
746 781
747 insecure: *boolean* 782 insecure: *boolean*
748 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 783 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
749 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
750 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,
751 whether throuh a mail client displaying mail bodies unfiltered or 786 whether through a mail client displaying mail bodies unfiltered or
752 though write(1). Therefore, these sequences are disabled by default. 787 through write(1) or any other means. Therefore, these sequences are
753 (Note that other terminals, including xterm, have these sequences 788 disabled by default. (Note that many other terminals, including
754 enabled by default). You can enable them by setting this boolean 789 xterm, have these sequences enabled by default, which doesn't make
755 resource or specifying -insecure as an option. At the moment, this 790 it safer, though).
756 enabled display-answer, locale, findfont, icon label and window 791
757 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.
758 796
759 modifier: *modifier* 797 modifier: *modifier*
760 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,
761 super, mod1, mod2, mod3, mod4, mod5; option -mod. 799 super, mod1, mod2, mod3, mod4, mod5; option -mod.
762 800
… …
771 secondaryScroll: *bool* 809 secondaryScroll: *bool*
772 Turn on/off secondary screen scroll (default enabled). If the this 810 Turn on/off secondary screen scroll (default enabled). If the this
773 option is enabled, scrolls on the secondary screen will change the 811 option is enabled, scrolls on the secondary screen will change the
774 scrollback buffer and switching to/from the secondary screen will 812 scrollback buffer and switching to/from the secondary screen will
775 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.
776 820
777 keysym.*sym*: *string* 821 keysym.*sym*: *string*
778 Compile *frills*: Associate *string* with keysym *sym*. The 822 Compile *frills*: Associate *string* with keysym *sym*. The
779 intervening resource name keysym. cannot be omitted. 823 intervening resource name keysym. cannot be omitted.
780 824
… …
825 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
826 Control-Meta-c is being pressed": 870 Control-Meta-c is being pressed":
827 871
828 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
829 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
830 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
831 the fonts "suxuseuro" and "9x15bold", so you can have some limited 894 the fonts "suxuseuro" and "9x15bold", so you can have some limited
832 font-switching at runtime: 895 font-switching at runtime:
833 896
834 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 897 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
873 entire logical line (which can span multiple screen lines), unless 936 entire logical line (which can span multiple screen lines), unless
874 modified by resource tripleclickwords. 937 modified by resource tripleclickwords.
875 938
876 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 939 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
877 (Compile: *frills*) will create a rectangular selection instead of a 940 (Compile: *frills*) will create a rectangular selection instead of a
878 normal one. 941 normal one. In this mode, every selected row becomes its own line in
942 the selection, and trailing whitespace is visually underlined and
943 removed from the selection.
879 944
880 Insertion: 945 Insertion:
881 Pressing and releasing the Middle mouse button (or Shift-Insert) in 946 Pressing and releasing the Middle mouse button (or Shift-Insert) in
882 an rxvt window causes the current text selection to be inserted as 947 an rxvt window causes the current text selection to be inserted as
883 if it had been typed on the keyboard. 948 if it had been typed on the keyboard.
… …
887 supported in rxvt-unicode. Bug me if you need this. 952 supported in rxvt-unicode. Bug me if you need this.
888 953
889 You can, however, switch fonts at runtime using escape sequences (and 954 You can, however, switch fonts at runtime using escape sequences (and
890 therefore using the menubar), e.g.: 955 therefore using the menubar), e.g.:
891 956
892 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 957 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
893 958
894 rxvt-unicode will automatically re-apply these fonts to the output so 959 rxvt-unicode will automatically re-apply these fonts to the output so
895 far. 960 far.
896 961
897ISO 14755 SUPPORT 962ISO 14755 SUPPORT
… …
1043 Used in the same way as "RXVTPATH". 1108 Used in the same way as "RXVTPATH".
1044 1109
1045 RXVT_SOCKET 1110 RXVT_SOCKET
1046 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1111 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1047 1112
1048 Default "$HOME/.rxvt-unicode-<nodename". 1113 Default $HOME/.rxvt-unicode-*<nodename*.
1049 1114
1050 HOME 1115 HOME
1051 Used to locate the default directory for the unix domain socket for 1116 Used to locate the default directory for the unix domain socket for
1052 daemon communications and to locate various resource files (such as 1117 daemon communications and to locate various resource files (such as
1053 ".Xdefaults") 1118 ".Xdefaults")
… …
1062FILES 1127FILES
1063 /usr/lib/X11/rgb.txt 1128 /usr/lib/X11/rgb.txt
1064 Color names. 1129 Color names.
1065 1130
1066SEE ALSO 1131SEE ALSO
1067 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1132 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1068 1133 tty(4), utmp(5)
1069BUGS
1070 Check the BUGS file for an up-to-date list.
1071
1072 Cursor change support is not yet implemented.
1073
1074 Click-and-drag doesn't work with X11 mouse report overriding.
1075 1134
1076CURRENT PROJECT COORDINATOR 1135CURRENT PROJECT COORDINATOR
1077 Project Coordinator 1136 Project Coordinator
1078 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1137 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1079 1138

Diff Legend

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