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.23 by root, Thu Jul 7 19:37:47 2005 UTC vs.
Revision 1.29 by root, Mon Jan 2 15:11:05 2006 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.6, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.2, 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
165 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
166 174
167 -fbi *fontlist* 175 -fbi *fontlist*
168 Compile font-styles: The bold italic font list to use when bold 176 Compile font-styles: The bold italic font list to use when bold
169 characters are to be printed. See resource boldItalicFont for 177 characters are to be printed. See resource boldItalicFont for
178 details.
179
180 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for
170 details. 183 details.
171 184
172 -name *name* 185 -name *name*
173 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
174 obtained, rather than the default executable file name. Name should 187 obtained, rather than the default executable file name. Name should
259 on the command line. If this option is used, it must be the last on 272 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 273 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, 274 run the program specified by the SHELL environment variable or,
262 failing that, *sh(1)*. 275 failing that, *sh(1)*.
263 276
277 Please note that you must specify a program with arguments. If you
278 want to run shell commands, you have to specify the shell, like
279 this:
280
281 rxvt -e sh -c "shell commands"
282
264 -title *text* 283 -title *text*
265 Window title (-T still respected); the default title is the basename 284 Window title (-T still respected); the default title is the basename
266 of the program specified after the -e option, if any, otherwise the 285 of the program specified after the -e option, if any, otherwise the
267 application name; resource title. 286 application name; resource title.
268 287
310 secondaryScreen. 329 secondaryScreen.
311 330
312 -ssr|+ssr 331 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 332 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 333 secondaryScroll.
334
335 -hold|+hold
336 Turn on/off hold window after exit support. If enabled, rxvt will
337 not immediately destroy its window when the program executed within
338 it exits. Instead, it will wait till it is being killed or closed by
339 the user; resource hold.
315 340
316 -keysym.*sym* *string* 341 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 342 Remap a key symbol. See resource keysym.
318 343
319 -embed *windowid* 344 -embed *windowid*
467 True: make the background inherit the parent windows' pixmap, giving 492 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 493 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 494 pixmap.
470 495
471 fading: *number* 496 fading: *number*
472 Fade the text by the given percentage when focus is lost. 497 Fade the text by the given percentage when focus is lost; option
498 -fade.
499
500 fadeColor: *colour*
501 Fade to this colour, when fading is used (see fading:). The default
502 colour is black; option -fadecolor.
473 503
474 tintColor: *colour* 504 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 505 Tint the transparent background pixmap with the given colour; option
506 -tint.
476 507
477 shading: *number* 508 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 509 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 510 image in addition to tinting it.
480 511
570 tried. 601 tried.
571 602
572 If set, but empty, then this specific style is disabled and the 603 If set, but empty, then this specific style is disabled and the
573 normal text font will being used for the given style. 604 normal text font will being used for the given style.
574 605
606 intensityStyles: *boolean*
607 When font styles are not enabled, or this option is enabled (True,
608 option -is, the default), bold and italic font styles imply high
609 intensity foreground/backround colours. Disabling this option
610 (False, option +is) disables this behaviour, the high intensity
611 colours are not reachable.
612
575 selectstyle: *mode* 613 selectstyle: *mode*
576 Set mouse selection style to old which is 2.20, oldword which is 614 Set mouse selection style to old which is 2.20, oldword which is
577 xterm style with 2.20 old word selection, or anything else which 615 xterm style with 2.20 old word selection, or anything else which
578 gives xterm style selection. 616 gives xterm style selection.
579 617
755 793
756 insecure: *boolean* 794 insecure: *boolean*
757 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 795 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
758 that echo arbitrary strings like the icon name or the locale. This 796 that echo arbitrary strings like the icon name or the locale. This
759 could be abused if somebody gets 8-bit-clean access to your display, 797 could be abused if somebody gets 8-bit-clean access to your display,
760 whether throuh a mail client displaying mail bodies unfiltered or 798 whether through a mail client displaying mail bodies unfiltered or
761 though write(1). Therefore, these sequences are disabled by default. 799 through write(1) or any other means. Therefore, these sequences are
762 (Note that other terminals, including xterm, have these sequences 800 disabled by default. (Note that many other terminals, including
763 enabled by default). You can enable them by setting this boolean 801 xterm, have these sequences enabled by default, which doesn't make
764 resource or specifying -insecure as an option. At the moment, this 802 it safer, though).
765 enabled display-answer, locale, findfont, icon label and window 803
766 title requests as well as dynamic menubar dispatch. 804 You can enable them by setting this boolean resource or specifying
805 -insecure as an option. At the moment, this enables display-answer,
806 locale, findfont, icon label and window title requests as well as
807 dynamic menubar dispatch.
767 808
768 modifier: *modifier* 809 modifier: *modifier*
769 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 810 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
770 super, mod1, mod2, mod3, mod4, mod5; option -mod. 811 super, mod1, mod2, mod3, mod4, mod5; option -mod.
771 812
780 secondaryScroll: *bool* 821 secondaryScroll: *bool*
781 Turn on/off secondary screen scroll (default enabled). If the this 822 Turn on/off secondary screen scroll (default enabled). If the this
782 option is enabled, scrolls on the secondary screen will change the 823 option is enabled, scrolls on the secondary screen will change the
783 scrollback buffer and switching to/from the secondary screen will 824 scrollback buffer and switching to/from the secondary screen will
784 instead scroll the screen up. 825 instead scroll the screen up.
826
827 hold: *bool*
828 Turn on/off hold window after exit support. If enabled, rxvt will
829 not immediately destroy its window when the program executed within
830 it exits. Instead, it will wait till it is being killed or closed by
831 the user.
785 832
786 keysym.*sym*: *string* 833 keysym.*sym*: *string*
787 Compile *frills*: Associate *string* with keysym *sym*. The 834 Compile *frills*: Associate *string* with keysym *sym*. The
788 intervening resource name keysym. cannot be omitted. 835 intervening resource name keysym. cannot be omitted.
789 836
901 entire logical line (which can span multiple screen lines), unless 948 entire logical line (which can span multiple screen lines), unless
902 modified by resource tripleclickwords. 949 modified by resource tripleclickwords.
903 950
904 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 951 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
905 (Compile: *frills*) will create a rectangular selection instead of a 952 (Compile: *frills*) will create a rectangular selection instead of a
906 normal one. 953 normal one. In this mode, every selected row becomes its own line in
954 the selection, and trailing whitespace is visually underlined and
955 removed from the selection.
907 956
908 Insertion: 957 Insertion:
909 Pressing and releasing the Middle mouse button (or Shift-Insert) in 958 Pressing and releasing the Middle mouse button (or Shift-Insert) in
910 an rxvt window causes the current text selection to be inserted as 959 an rxvt window causes the current text selection to be inserted as
911 if it had been typed on the keyboard. 960 if it had been typed on the keyboard.
915 supported in rxvt-unicode. Bug me if you need this. 964 supported in rxvt-unicode. Bug me if you need this.
916 965
917 You can, however, switch fonts at runtime using escape sequences (and 966 You can, however, switch fonts at runtime using escape sequences (and
918 therefore using the menubar), e.g.: 967 therefore using the menubar), e.g.:
919 968
920 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 969 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
921 970
922 rxvt-unicode will automatically re-apply these fonts to the output so 971 rxvt-unicode will automatically re-apply these fonts to the output so
923 far. 972 far.
924 973
925ISO 14755 SUPPORT 974ISO 14755 SUPPORT
1093 1142
1094SEE ALSO 1143SEE ALSO
1095 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1144 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1096 tty(4), utmp(5) 1145 tty(4), utmp(5)
1097 1146
1098BUGS
1099 Check the BUGS file for an up-to-date list.
1100
1101 Cursor change support is not yet implemented.
1102
1103 Click-and-drag doesn't work with X11 mouse report overriding.
1104
1105CURRENT PROJECT COORDINATOR 1147CURRENT PROJECT COORDINATOR
1106 Project Coordinator 1148 Project Coordinator
1107 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1149 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1108 1150
1109 <http://software.schmorp.de/#rxvt-unicode> 1151 <http://software.schmorp.de/#rxvt-unicode>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines