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.46 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.54 by root, Sun Jan 29 21:45:47 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 *frills*: 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.
251 externalBorder. 255 externalBorder.
252 256
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 257 -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 258 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 259 decorations; resource borderLess.
260
261 -override-redirect
262 Compile *frills*: Sets override-redirect on the window; resource
263 override-redirect.
256 264
257 -sbg 265 -sbg
258 Compile *frills*: Disable the usage of the built-in block 266 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 267 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 268 fonts provide. Use this if you have a good font and want to use its
427 rxvt configurations. If no resources are specified, suitable defaults 435 rxvt configurations. If no resources are specified, suitable defaults
428 will be used. Command-line arguments can be used to override resource 436 will be used. Command-line arguments can be used to override resource
429 settings. The following resources are supported (you might want to check 437 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not 438 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here): 439 documented here):
440
441 depth: *bitdepth*
442 Compile *frills*: Attempt to find a visual with the given bit depth;
443 option -depth.
432 444
433 geometry: *geom* 445 geometry: *geom*
434 Create the window with the specified X window geometry [default 446 Create the window with the specified X window geometry [default
435 80x24]; option -geometry. 447 80x24]; option -geometry.
436 448
765 The string to send when the delete key (not the keypad delete key) 777 The string to send when the delete key (not the keypad delete key)
766 is pressed. If unset it will send the sequence traditionally 778 is pressed. If unset it will send the sequence traditionally
767 associated with the Execute key. 779 associated with the Execute key.
768 780
769 cutchars: *string* 781 cutchars: *string*
770 The characters used as delimiters for double-click word selection. 782 The characters used as delimiters for double-click word selection
771 The built-in default: 783 (whitespace delimiting is added automatically if resource is given).
784
785 When the selection extension is in use (the default if compiled in,
786 see the rxvtperl(3) manpage), a suitable regex using these
787 characters will be created (if the resource exists, otherwise, no
788 regex will be created). In this mode, characters outside ISO-8859-1
789 can be used.
790
791 When the selection extension is not used, only ISO-8859-1 characters
792 can be used. If not specified, the built-in default is used:
772 793
773 BACKSLASH `"'&()*,;<=>?@[]{|} 794 BACKSLASH `"'&()*,;<=>?@[]{|}
774 795
775 preeditType: *style* 796 preeditType: *style*
776 OverTheSpot, OffTheSpot, Root; option -pt. 797 OverTheSpot, OffTheSpot, Root; option -pt.
818 answerbackString: *string* 839 answerbackString: *string*
819 Specify the reply rxvt-unicode sends to the shell when an ENQ 840 Specify the reply rxvt-unicode sends to the shell when an ENQ
820 (control-E) character is passed through. It may contain escape 841 (control-E) character is passed through. It may contain escape
821 values as described in the entry on keysym following. 842 values as described in the entry on keysym following.
822 843
823 secondaryScreen: *bool* 844 secondaryScreen: *boolean*
824 Turn on/off secondary screen (default enabled). 845 Turn on/off secondary screen (default enabled).
825 846
826 secondaryScroll: *bool* 847 secondaryScroll: *boolean*
827 Turn on/off secondary screen scroll (default enabled). If the this 848 Turn on/off secondary screen scroll (default enabled). If the this
828 option is enabled, scrolls on the secondary screen will change the 849 option is enabled, scrolls on the secondary screen will change the
829 scrollback buffer and switching to/from the secondary screen will 850 scrollback buffer and switching to/from the secondary screen will
830 instead scroll the screen up. 851 instead scroll the screen up.
831 852
832 hold: *bool* 853 hold: *boolean*
833 Turn on/off hold window after exit support. If enabled, rxvt will 854 Turn on/off hold window after exit support. If enabled, rxvt will
834 not immediately destroy its window when the program executed within 855 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 856 it exits. Instead, it will wait till it is being killed or closed by
836 the user. 857 the user.
837 858
982 urlLauncher: *string* 1003 urlLauncher: *string*
983 Specifies the program to be started with a URL argument. Used by the 1004 Specifies the program to be started with a URL argument. Used by the
984 "selection-popup" and "mark-urls" perl extensions. 1005 "selection-popup" and "mark-urls" perl extensions.
985 1006
986 transient-for: *windowid* 1007 transient-for: *windowid*
987 Sets the WM_TRANSIENT_FOR property to the given window iw. 1008 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1009 window id.
1010
1011 override-redirect: *boolean*
1012 Compile *frills*: Sets override-redirect for the terminal window,
1013 making it almost invisible to window managers; option
1014 -override-redirect.
988 1015
989THE SCROLLBAR 1016THE SCROLLBAR
990 Lines of text that scroll off the top of the rxvt window (resource: 1017 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 1018 saveLines) and can be scrolled back using the scrollbar or by
992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1019 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 1051 normal one. In this mode, every selected row becomes its own line in
1025 the selection, and trailing whitespace is visually underlined and 1052 the selection, and trailing whitespace is visually underlined and
1026 removed from the selection. 1053 removed from the selection.
1027 1054
1028 Insertion: 1055 Insertion:
1029 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1056 Pressing and releasing the Middle mouse button in an rxvt window
1030 an rxvt window causes the current text selection to be inserted as 1057 causes the value of the PRIMARY selection (or CLIPBOARD with the
1031 if it had been typed on the keyboard. 1058 Meta modifier) to be inserted as if it had been typed on the
1059 keyboard.
1060
1061 Pressing Shift-Insert causes the value of the PRIMARY selection to
1062 be inserted too.
1032 1063
1033CHANGING FONTS 1064CHANGING FONTS
1034 Changing fonts (or font sizes, respectively) via the keypad is not yet 1065 Changing fonts (or font sizes, respectively) via the keypad is not yet
1035 supported in rxvt-unicode. Bug me if you need this. 1066 supported in rxvt-unicode. Bug me if you need this.
1036 1067
1112 setgid to root or to some other group on others. 1143 setgid to root or to some other group on others.
1113 1144
1114COLORS AND GRAPHICS 1145COLORS AND GRAPHICS
1115 In addition to the default foreground and background colours, rxvt can 1146 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 1147 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 1148 versions of the same). Here is a list of the colours with their names.
1118 names.
1119 1149
1120 color0 (black) = Black 1150 color0 (black) = Black
1121 color1 (red) = Red3 1151 color1 (red) = Red3
1122 color2 (green) = Green3 1152 color2 (green) = Green3
1123 color3 (yellow) = Yellow3 1153 color3 (yellow) = Yellow3
1139 It is also possible to specify the colour values of foreground, 1169 It is also possible to specify the colour values of foreground,
1140 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1170 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1141 0-15, as a convenient shorthand to reference the colour name of 1171 0-15, as a convenient shorthand to reference the colour name of
1142 color0-color15. 1172 color0-color15.
1143 1173
1174 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1175 get their act together, rxvt-unicode will support
1176 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1177 digits/component), "#ARGB", "#AARRGGBB" and "#AAAARRRRGGGGBBBB" colour
1178 specifications, in addition to the ones provided by X, where the
1179 additional A component specifies alpha (opacity) values (0 is completely
1180 transparent and the maximum is opaque). You probably need to specify
1181 "-depth 32", too, and have the luck that your X-server uses ARGB pixel
1182 layout, as X is far from just supporting ARGB visuals out of the box,
1183 and rxvt-unicode just fudges around.
1184
1144 Note that -rv ("reverseVideo: True") simulates reverse video by always 1185 Note that -rv ("reverseVideo: True") simulates reverse video by always
1145 swapping the foreground/background colours. This is in contrast to 1186 swapping the foreground/background colours. This is in contrast to
1146 *xterm*(1) where the colours are only swapped if they have not otherwise 1187 *xterm*(1) where the colours are only swapped if they have not otherwise
1147 been specified. For example, 1188 been specified. For example,
1148 1189
1185 display in it's child processes. 1226 display in it's child processes.
1186 1227
1187 SHELL 1228 SHELL
1188 The shell to be used for command execution, defaults to "/bin/sh". 1229 The shell to be used for command execution, defaults to "/bin/sh".
1189 1230
1190 RXVTPATH
1191 The path where rxvt looks for support files such as menu and xpm
1192 files.
1193
1194 PATH
1195 Used in the same way as "RXVTPATH".
1196
1197 RXVT_SOCKET 1231 RXVT_SOCKET
1198 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1232 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1199 1233
1200 Default $HOME/.rxvt-unicode-*<nodename*. 1234 Default $HOME/.rxvt-unicode-*<nodename*.
1201 1235
1242 1276
1243 Oezguer Kesim <kesim@math.fu-berlin.de> 1277 Oezguer Kesim <kesim@math.fu-berlin.de>
1244 Project Coordinator (changes.txt 2.21a to 2.4.5) 1278 Project Coordinator (changes.txt 2.21a to 2.4.5)
1245 1279
1246 Geoff Wing <gcw@pobox.com> 1280 Geoff Wing <gcw@pobox.com>
1247 Rewrote screen display and text selection routines. Project 1281 Rewrote screen display and text selection routines.
1282
1248 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1283 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1249 1284
1250 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1285 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1251 Forked rxvt-unicode, rewrote most of the display code and internal 1286 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1252 character handling to store text in unicode, improve xterm 1287 perl extension, random hacks, numerous bugfixes and extensions.
1253 compatibility and apply numerous other bugfixes and extensions.
1254 1288
1255 Project Coordinator (Changes 1.0 -) 1289 Project Coordinator (Changes 1.0 -)
1256 1290
1291 Emanuele Giaquinta <e.giaquinta@glauco.it>
1292 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1293

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines