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.47 by root, Mon Jan 16 15:12:48 2006 UTC vs.
Revision 1.55 by root, Sun Jan 29 22:38:43 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 7.0, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.4, 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
84 -display *displayname* 84 -display *displayname*
85 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88 88
89 -depth *bitdepth*
90 Compile *xft*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
93 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling; resource jumpScroll.
97 101
98 -ip|+ip | -tr|+tr 102 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 103 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 104 -tr; resource inheritPixmap.
105
106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions!*
101 108
102 -fade *number* 109 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 110 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 111 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 112 the fade colour; resource fading.
106 113
107 -fadecolor *colour* 114 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 115 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 116 colour is opaque black. resource fadeColor.
110 117
111 -tint *colour* 118 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 119 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 120 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 121 non-tiled backgrounds, currently. See also the -sh option that can
251 externalBorder. 258 externalBorder.
252 259
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 260 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
254 if honoured by the WM, the rxvt-unicode window will not have window 261 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 262 decorations; resource borderLess.
263
264 -override-redirect
265 Compile *frills*: Sets override-redirect on the window; resource
266 override-redirect.
256 267
257 -sbg 268 -sbg
258 Compile *frills*: Disable the usage of the built-in block 269 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 270 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its 271 fonts provide. Use this if you have a good font and want to use its
428 will be used. Command-line arguments can be used to override resource 439 will be used. Command-line arguments can be used to override resource
429 settings. The following resources are supported (you might want to check 440 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not 441 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here): 442 documented here):
432 443
444 depth: *bitdepth*
445 Compile *xft*: Attempt to find a visual with the given bit depth;
446 option -depth.
447
433 geometry: *geom* 448 geometry: *geom*
434 Create the window with the specified X window geometry [default 449 Create the window with the specified X window geometry [default
435 80x24]; option -geometry. 450 80x24]; option -geometry.
436 451
437 background: *colour* 452 background: *colour*
497 512
498 inheritPixmap: *boolean* 513 inheritPixmap: *boolean*
499 True: make the background inherit the parent windows' pixmap, giving 514 True: make the background inherit the parent windows' pixmap, giving
500 artificial transparency. False: do not inherit the parent windows' 515 artificial transparency. False: do not inherit the parent windows'
501 pixmap. 516 pixmap.
517
518 *Please note that transparency of any kind if completely unsupported
519 by the author. Don't bug him with installation questions!*
502 520
503 fading: *number* 521 fading: *number*
504 Fade the text by the given percentage when focus is lost; option 522 Fade the text by the given percentage when focus is lost; option
505 -fade. 523 -fade.
506 524
765 The string to send when the delete key (not the keypad delete key) 783 The string to send when the delete key (not the keypad delete key)
766 is pressed. If unset it will send the sequence traditionally 784 is pressed. If unset it will send the sequence traditionally
767 associated with the Execute key. 785 associated with the Execute key.
768 786
769 cutchars: *string* 787 cutchars: *string*
770 The characters used as delimiters for double-click word selection. 788 The characters used as delimiters for double-click word selection
771 The built-in default: 789 (whitespace delimiting is added automatically if resource is given).
790
791 When the selection extension is in use (the default if compiled in,
792 see the rxvtperl(3) manpage), a suitable regex using these
793 characters will be created (if the resource exists, otherwise, no
794 regex will be created). In this mode, characters outside ISO-8859-1
795 can be used.
796
797 When the selection extension is not used, only ISO-8859-1 characters
798 can be used. If not specified, the built-in default is used:
772 799
773 BACKSLASH `"'&()*,;<=>?@[]{|} 800 BACKSLASH `"'&()*,;<=>?@[]{|}
774 801
775 preeditType: *style* 802 preeditType: *style*
776 OverTheSpot, OffTheSpot, Root; option -pt. 803 OverTheSpot, OffTheSpot, Root; option -pt.
818 answerbackString: *string* 845 answerbackString: *string*
819 Specify the reply rxvt-unicode sends to the shell when an ENQ 846 Specify the reply rxvt-unicode sends to the shell when an ENQ
820 (control-E) character is passed through. It may contain escape 847 (control-E) character is passed through. It may contain escape
821 values as described in the entry on keysym following. 848 values as described in the entry on keysym following.
822 849
823 secondaryScreen: *bool* 850 secondaryScreen: *boolean*
824 Turn on/off secondary screen (default enabled). 851 Turn on/off secondary screen (default enabled).
825 852
826 secondaryScroll: *bool* 853 secondaryScroll: *boolean*
827 Turn on/off secondary screen scroll (default enabled). If the this 854 Turn on/off secondary screen scroll (default enabled). If the this
828 option is enabled, scrolls on the secondary screen will change the 855 option is enabled, scrolls on the secondary screen will change the
829 scrollback buffer and switching to/from the secondary screen will 856 scrollback buffer and switching to/from the secondary screen will
830 instead scroll the screen up. 857 instead scroll the screen up.
831 858
832 hold: *bool* 859 hold: *boolean*
833 Turn on/off hold window after exit support. If enabled, rxvt will 860 Turn on/off hold window after exit support. If enabled, rxvt will
834 not immediately destroy its window when the program executed within 861 not immediately destroy its window when the program executed within
835 it exits. Instead, it will wait till it is being killed or closed by 862 it exits. Instead, it will wait till it is being killed or closed by
836 the user. 863 the user.
837 864
982 urlLauncher: *string* 1009 urlLauncher: *string*
983 Specifies the program to be started with a URL argument. Used by the 1010 Specifies the program to be started with a URL argument. Used by the
984 "selection-popup" and "mark-urls" perl extensions. 1011 "selection-popup" and "mark-urls" perl extensions.
985 1012
986 transient-for: *windowid* 1013 transient-for: *windowid*
987 Sets the WM_TRANSIENT_FOR property to the given window iw. 1014 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1015 window id.
1016
1017 override-redirect: *boolean*
1018 Compile *frills*: Sets override-redirect for the terminal window,
1019 making it almost invisible to window managers; option
1020 -override-redirect.
988 1021
989THE SCROLLBAR 1022THE SCROLLBAR
990 Lines of text that scroll off the top of the rxvt window (resource: 1023 Lines of text that scroll off the top of the rxvt window (resource:
991 saveLines) and can be scrolled back using the scrollbar or by 1024 saveLines) and can be scrolled back using the scrollbar or by
992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1025 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1024 normal one. In this mode, every selected row becomes its own line in 1057 normal one. In this mode, every selected row becomes its own line in
1025 the selection, and trailing whitespace is visually underlined and 1058 the selection, and trailing whitespace is visually underlined and
1026 removed from the selection. 1059 removed from the selection.
1027 1060
1028 Insertion: 1061 Insertion:
1029 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1062 Pressing and releasing the Middle mouse button in an rxvt window
1030 an rxvt window causes the current text selection to be inserted as 1063 causes the value of the PRIMARY selection (or CLIPBOARD with the
1031 if it had been typed on the keyboard. 1064 Meta modifier) to be inserted as if it had been typed on the
1065 keyboard.
1066
1067 Pressing Shift-Insert causes the value of the PRIMARY selection to
1068 be inserted too.
1032 1069
1033CHANGING FONTS 1070CHANGING FONTS
1034 Changing fonts (or font sizes, respectively) via the keypad is not yet 1071 Changing fonts (or font sizes, respectively) via the keypad is not yet
1035 supported in rxvt-unicode. Bug me if you need this. 1072 supported in rxvt-unicode. Bug me if you need this.
1036 1073
1112 setgid to root or to some other group on others. 1149 setgid to root or to some other group on others.
1113 1150
1114COLORS AND GRAPHICS 1151COLORS AND GRAPHICS
1115 In addition to the default foreground and background colours, rxvt can 1152 In addition to the default foreground and background colours, rxvt can
1116 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1153 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1117 versions of the same). Here is a list of the colours with their rgb.txt 1154 versions of the same). Here is a list of the colours with their names.
1118 names.
1119 1155
1120 color0 (black) = Black 1156 color0 (black) = Black
1121 color1 (red) = Red3 1157 color1 (red) = Red3
1122 color2 (green) = Green3 1158 color2 (green) = Green3
1123 color3 (yellow) = Yellow3 1159 color3 (yellow) = Yellow3
1139 It is also possible to specify the colour values of foreground, 1175 It is also possible to specify the colour values of foreground,
1140 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1176 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1141 0-15, as a convenient shorthand to reference the colour name of 1177 0-15, as a convenient shorthand to reference the colour name of
1142 color0-color15. 1178 color0-color15.
1143 1179
1180 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1181 get their act together, rxvt-unicode will support
1182 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1183 digits/component), "#ARGB", "#AARRGGBB" and "#AAAARRRRGGGGBBBB" colour
1184 specifications, in addition to the ones provided by X, where the
1185 additional A component specifies alpha (opacity) values (0 is completely
1186 transparent and the maximum is opaque). You probably need to specify
1187 "-depth 32", too, and have the luck that your X-server uses ARGB pixel
1188 layout, as X is far from just supporting ARGB visuals out of the box,
1189 and rxvt-unicode just fudges around.
1190
1191 *Please note that transparency of any kind if completely unsupported by
1192 the author. Don't bug him with installation questions!*
1193
1144 Note that -rv ("reverseVideo: True") simulates reverse video by always 1194 Note that -rv ("reverseVideo: True") simulates reverse video by always
1145 swapping the foreground/background colours. This is in contrast to 1195 swapping the foreground/background colours. This is in contrast to
1146 *xterm*(1) where the colours are only swapped if they have not otherwise 1196 *xterm*(1) where the colours are only swapped if they have not otherwise
1147 been specified. For example, 1197 been specified. For example,
1148 1198
1235 1285
1236 Oezguer Kesim <kesim@math.fu-berlin.de> 1286 Oezguer Kesim <kesim@math.fu-berlin.de>
1237 Project Coordinator (changes.txt 2.21a to 2.4.5) 1287 Project Coordinator (changes.txt 2.21a to 2.4.5)
1238 1288
1239 Geoff Wing <gcw@pobox.com> 1289 Geoff Wing <gcw@pobox.com>
1240 Rewrote screen display and text selection routines. Project 1290 Rewrote screen display and text selection routines.
1291
1241 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1292 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1242 1293
1243 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1294 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1244 Forked rxvt-unicode, rewrote most of the display code and internal 1295 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1245 character handling to store text in unicode, improve xterm 1296 perl extension, random hacks, numerous bugfixes and extensions.
1246 compatibility and apply numerous other bugfixes and extensions.
1247 1297
1248 Project Coordinator (Changes 1.0 -) 1298 Project Coordinator (Changes 1.0 -)
1249 1299
1300 Emanuele Giaquinta <e.giaquinta@glauco.it>
1301 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1302

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines