ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1 (file contents):
Revision 1.2 by pcg, Thu Dec 18 00:38:07 2003 UTC vs.
Revision 1.13 by root, Mon Jul 26 14:57:11 2004 UTC

1.if !\n(.g .ab GNU tbl requires GNU troff. 1.if !\n(.g .ab GNU tbl requires GNU troff.
2.if !dTS .ds TS 2.if !dTS .ds TS
3.if !dTE .ds TE 3.if !dTE .ds TE
4.TH "RXVT" "1" "RXVTDATE()" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-06-26" "X Version 11" "X Tools"
5.SH "NAME" 5.SH "NAME"
6rxvt (ouR XVT) \- a VT102 emulator for the X window system 6rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
7.PP 7.PP
8.SH "SYNOPSIS" 8.SH "SYNOPSIS"
9.PP 9.PP
10\fBrxvt\fP [options] [-e command [ args ]] 10\fBurxvt\fP [options] [-e command [ args ]]
11.PP 11.PP
12.SH "DESCRIPTION" 12.SH "DESCRIPTION"
13.PP 13.PP
14\fBrxvt\fP, version \fBRXVTVERSION()\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB3\&.1\fP, is a colour vt102 terminal emulator
15intended as an \fIxterm\fP(1) replacement for users who do not require 15intended as an \fIxterm\fP(1) replacement for users who do not require
16features such as Tektronix 4014 emulation and toolkit-style configurability\&. 16features such as Tektronix 4014 emulation and toolkit-style configurability\&.
17As a result, \fBrxvt\fP uses much less swap space -- a significant 17As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
18advantage on a machine serving many X sessions\&. 18advantage on a machine serving many X sessions\&.
19.PP 19.PP
20.PP 20.PP
21.SH "OPTIONS" 21.SH "OPTIONS"
22.PP 22.PP
23The \fBrxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. 23The \fBurxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&.
24In keeping with the smaller-is-better philosophy, options may be eliminated 24In keeping with the smaller-is-better philosophy, options may be eliminated
25or default values chosen at compile-time, so options and defaults listed 25or default values chosen at compile-time, so options and defaults listed
26may not accurately reflect the version installed on your system\&. 26may not accurately reflect the version installed on your system\&.
27`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&. 27`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&.
28Option descriptions may be prefixed with which compile option each is 28Option descriptions may be prefixed with which compile option each is
29dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP 29dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP
30line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled 30line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled
31into your version\&. 31into your version\&.
32.PP 32.PP
33Note that \fBrxvt\fP permits the resource name to be used as a long-option 33Note that \fBurxvt\fP permits the resource name to be used as a long-option
34(--/++ option) so the potential command-line options are far greater than 34(--/++ option) so the potential command-line options are far greater than
35those listed\&. 35those listed\&.
36For example: `rxvt --loginShell --color1 Orange\&'\&. 36For example: `rxvt --loginShell --color1 Orange\&'\&.
37.PP 37.PP
38The following options are available: 38The following options are available:
54resource \fBjumpScroll\fP\&. 54resource \fBjumpScroll\fP\&.
55.IP "\fB-ip\fP|\fB+ip\fP" 55.IP "\fB-ip\fP|\fB+ip\fP"
56Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 56Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
57is \fB-tr\fP; 57is \fB-tr\fP;
58resource \fBinheritPixmap\fP\&. 58resource \fBinheritPixmap\fP\&.
59.IP "\fB-tint\fP \fIcolour\fP"
60Tint the transparent background pixmap with the given colour\&.
59.IP "\fB-bg\fP \fIcolour\fP" 61.IP "\fB-bg\fP \fIcolour\fP"
60Window background colour; 62Window background colour;
61resource \fBbackground\fP\&. 63resource \fBbackground\fP\&.
62.IP "\fB-fg\fP \fIcolour\fP" 64.IP "\fB-fg\fP \fIcolour\fP"
63Window foreground colour; 65Window foreground colour;
70resource \fBbackgroundPixmap\fP\&. 72resource \fBbackgroundPixmap\fP\&.
71.IP "\fB-cr\fP \fIcolour\fP" 73.IP "\fB-cr\fP \fIcolour\fP"
72The cursor colour; 74The cursor colour;
73resource \fBcursorColor\fP\&. 75resource \fBcursorColor\fP\&.
74.IP "\fB-pr\fP \fIcolour\fP" 76.IP "\fB-pr\fP \fIcolour\fP"
75The mouse pointer colour; 77The mouse pointer foreground colour;
76resource \fBpointerColor\fP\&. 78resource \fBpointerColor\fP\&.
79.IP "\fB-pr2\fP \fIcolour\fP"
80The mouse pointer background colour;
81resource \fBpointerColor2\fP\&.
77.IP "\fB-bd\fP \fIcolour\fP" 82.IP "\fB-bd\fP \fIcolour\fP"
78The colour of the border between the xterm scrollbar and the text; 83The colour of the border between the xterm scrollbar and the text;
79resource \fBborderColor\fP\&. 84resource \fBborderColor\fP\&.
80.IP "\fB-fn\fP \fIfontname\fP" 85.IP "\fB-fn\fP \fIfontname\fP"
81Select the fonts to be used used\&. This is a comma seperated 86Select the fonts to be used\&.
82list of font names that are used in turn when trying to display 87This is a comma seperated list of font names that are used in turn when
83unicode characters\&. The first font defines the cell size for characters, 88trying to display Unicode characters\&.
84pther fonts might be smaller, but not larger\&. A reasonable default list 89The first font defines the cell size for characters; other fonts might
85is appended\&. 90be smaller, but not larger\&.
91A reasonable default font list is always appended to it\&.
86resource \fBfont\fP\&. 92resource \fBfont\fP\&.
87.IP "\fB-grk\fP \fImode\fP" 93.IP "\fB-rb\fP|\fB+rb\fP"
88Compile \fIGreek\fP: Greek keyboard translation; 94Enable "real bold" support\&.
89\fBiso\fP: ISO-8859 mapping\&. 95When this option is on, bold text will be displayed using the first
90\fBibm\fP: IBM-437 mapping; 96available bold font in the font list\&.
97Bold fonts should thus be specified in the font list after their
98corresponding regular fonts\&.
99If no bold font can be found, a regular font will be used\&.
91resource \fBgreek_keyboard\fP\&. 100resource \fBrealBold\fP\&.
92.IP "\fB-name\fP \fIname\fP" 101.IP "\fB-name\fP \fIname\fP"
93Specify the application name under which resources 102Specify the application name under which resources
94are to be obtained, rather than the default executable file name\&. 103are to be obtained, rather than the default executable file name\&.
95Name should not contain `\&.\&' or `*\&' characters\&. 104Name should not contain `\&.\&' or `*\&' characters\&.
96Also sets the icon and title name\&. 105Also sets the icon and title name\&.
120Put scrollbar on right/left; 129Put scrollbar on right/left;
121resource \fBscrollBar_right\fP\&. 130resource \fBscrollBar_right\fP\&.
122.IP "\fB-st\fP|\fB+st\fP" 131.IP "\fB-st\fP|\fB+st\fP"
123Display normal (non XTerm/NeXT) scrollbar without/with a trough; 132Display normal (non XTerm/NeXT) scrollbar without/with a trough;
124resource \fBscrollBar_floating\fP\&. 133resource \fBscrollBar_floating\fP\&.
125.IP "\fB-mcc\fP|\fB+mcc\fP"
126Compile \fImultichar_languages\fP: treat multibyte glyphs as single
127character for backspace, delete and cursor movement keys;
128resource \fBmultibyte_cursor\fP\&.
129.IP "\fB-bc\fP|\fB+bc\fP" 134.IP "\fB-bc\fP|\fB+bc\fP"
130Blink the cursor; resource \fBcursorBlink\fP\&. 135Blink the cursor; resource \fBcursorBlink\fP\&.
131.IP "\fB-iconic\fP" 136.IP "\fB-iconic\fP"
132Start iconified, if the window manager supports that option\&. 137Start iconified, if the window manager supports that option\&.
133Alternative form is \fB-ic\fP\&. 138Alternative form is \fB-ic\fP\&.
151This option specifies the name of the terminal type to be set in the 156This option specifies the name of the terminal type to be set in the
152\fBTERM\fP environment variable\&. This terminal type must exist in the 157\fBTERM\fP environment variable\&. This terminal type must exist in the
153\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; 158\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
154resource \fBtermName\fP\&. 159resource \fBtermName\fP\&.
155.IP "\fB-e\fP \fIcommand [arguments]\fP" 160.IP "\fB-e\fP \fIcommand [arguments]\fP"
156Run the command with its command-line arguments in the \fBrxvt\fP 161Run the command with its command-line arguments in the \fBurxvt\fP
157window; also sets the window title and icon name to be the basename 162window; also sets the window title and icon name to be the basename
158of the program being executed if neither \fI-title\fP (\fI-T\fP) nor 163of the program being executed if neither \fI-title\fP (\fI-T\fP) nor
159\fI-n\fP are given on the command line\&. If this option is used, it 164\fI-n\fP are given on the command line\&. If this option is used, it
160must be the last on the command-line\&. If there is no \fB-e\fP option 165must be the last on the command-line\&. If there is no \fB-e\fP option
161then the default is to run the program specified by the \fBSHELL\fP 166then the default is to run the program specified by the \fBSHELL\fP
181.IP "\fB-imlocale\fP \fIstring\fP" 186.IP "\fB-imlocale\fP \fIstring\fP"
182The locale to use for opening the IM\&. You can use an LC_CTYPE 187The locale to use for opening the IM\&. You can use an LC_CTYPE
183of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 188of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
184for the input extension to be able to input japanese characters 189for the input extension to be able to input japanese characters
185while staying in another locale\&. 190while staying in another locale\&.
191.IP "\fB-insecure\fP"
192Enable "insecure" mode, which currently enables most of the escape
193sequences that echo strings\&. See the resource \fBinsecure\fP for
194more info\&.
186.IP "\fB-mod\fP \fImodifier\fP" 195.IP "\fB-mod\fP \fImodifier\fP"
187Override detection of Meta modifier with specified key: 196Override detection of Meta modifier with specified key:
188\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 197\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
189\fBmod4\fP, \fBmod5\fP; 198\fBmod4\fP, \fBmod5\fP;
190resource \fImodifier\fP\&. 199resource \fImodifier\fP\&.
200.IP "\fB-ssc\fP|\fB+ssc\fP"
201Turn on/off secondary screen (default enabled);
202resource \fBsecondaryScreen\fP\&.
203.IP "\fB-ssr\fP|\fB+ssr\fP"
204Turn on/off secondary screen scroll (default enabled);
205resource \fBsecondaryScroll\fP\&.
191.IP "\fB-xrm\fP \fIresourcestring\fP" 206.IP "\fB-xrm\fP \fIresourcestring\fP"
192No effect on rxvt\&. Simply passes through an argument to be made 207No effect on rxvt\&. Simply passes through an argument to be made
193available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 208available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
194in some window managers\&. 209in some window managers\&.
195.SH "RESOURCES (available also as long-options)" 210.SH "RESOURCES (available also as long-options)"
196.PP 211.PP
197Note: `rxvt --help\&' gives a list of all resources (long options) compiled 212Note: `rxvt --help\&' gives a list of all resources (long options) compiled
198into your version\&. 213into your version\&.
199If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 214If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists
200\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 215\fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in
201XAPPLOADDIR/Rxvt (compile-time defined: usually 216XAPPLOADDIR/Rxvt (compile-time defined: usually
202\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 217\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP,
203or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 218or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when
204reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 219reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and
205\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 220\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both
206\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 221\fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name
207\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 222\fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and
208key-handling, to be shared between different \fBrxvt\fP configurations\&. 223key-handling, to be shared between different \fBurxvt\fP configurations\&.
209If no resources are specified, suitable defaults will be used\&. 224If no resources are specified, suitable defaults will be used\&.
210Command-line arguments can be used to override resource settings\&. The 225Command-line arguments can be used to override resource settings\&. The
211following resources are allowed: 226following resources are allowed:
212.PP 227.PP
213.IP "\fBgeometry:\fP \fIgeom\fP" 228.IP "\fBgeometry:\fP \fIgeom\fP"
231but the actual colour names used are listed in the 246but the actual colour names used are listed in the
232\fBCOLORS AND GRAPHICS\fP section\&. 247\fBCOLORS AND GRAPHICS\fP section\&.
233.IP "\fBcolorBD:\fP \fIcolour\fP" 248.IP "\fBcolorBD:\fP \fIcolour\fP"
234Use the specified colour to display bold characters when the 249Use the specified colour to display bold characters when the
235foreground colour is the default\&. 250foreground colour is the default\&.
251This option will be ignored if \fBrealBold\fP is enabled\&.
236.IP "\fBcolorUL:\fP \fIcolour\fP" 252.IP "\fBcolorUL:\fP \fIcolour\fP"
237Use the specified colour to display underlined characters when the 253Use the specified colour to display underlined characters when the
238foreground colour is the default\&. 254foreground colour is the default\&.
239.IP "\fBcolorRV:\fP \fIcolour\fP" 255.IP "\fBcolorRV:\fP \fIcolour\fP"
240Use the specified colour as the background for reverse video 256Use the specified colour as the background for reverse video
261option \fB+j\fP\&. 277option \fB+j\fP\&.
262.IP "\fBinheritPixmap:\fP \fIboolean\fP" 278.IP "\fBinheritPixmap:\fP \fIboolean\fP"
263\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 279\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
264giving artificial transparency\&. 280giving artificial transparency\&.
265\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 281\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
282.IP "\fBtintColor\fP \fIcolour\fP"
283Tint the transparent background pixmap with the given colour\&.
266.IP "\fBscrollColor:\fP \fIcolour\fP" 284.IP "\fBscrollColor:\fP \fIcolour\fP"
267Use the specified colour for the scrollbar [default #B2B2B2]\&. 285Use the specified colour for the scrollbar [default #B2B2B2]\&.
268.IP "\fBtroughColor:\fP \fIcolour\fP" 286.IP "\fBtroughColor:\fP \fIcolour\fP"
269Use the specified colour for the scrollbar\&'s trough area [default 287Use the specified colour for the scrollbar\&'s trough area [default
270#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 288#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
285.IP "\fBpath:\fP \fIpath\fP" 303.IP "\fBpath:\fP \fIpath\fP"
286Specify the colon-delimited search path for finding files (XPM and 304Specify the colon-delimited search path for finding files (XPM and
287menus), in addition to the paths specified by the \fBRXVTPATH\fP and 305menus), in addition to the paths specified by the \fBRXVTPATH\fP and
288\fBPATH\fP environment variables\&. 306\fBPATH\fP environment variables\&.
289.IP "\fBfont:\fP \fIfontname\fP" 307.IP "\fBfont:\fP \fIfontname\fP"
290Select the fonts to be used used\&. This is a comma seperated 308Select the fonts to be used\&.
291list of font names that are used in turn when trying to display 309This is a comma seperated list of font names that are used in turn when
292unicode characters\&. The first font defines the cell size for characters, 310trying to display Unicode characters\&.
293pther fonts might be smaller, but not larger\&. A reasonable default list 311The first font defines the cell size for characters; other fonts might
294is appended\&. 312be smaller, but not larger\&.
313A reasonable default font list is always appended to it\&.
295option \fB-fn\fP\&. 314option \fB-fn\fP\&.
296.IP "\fBgreek_keyboard:\fP \fImode\fP" 315.IP "\fBrealBold:\fP \fIboolean\fP"
297Set the Greek keyboard translation mode to be used; 316\fBTrue\fP: Enable "real bold" support\&.
298\fBiso\fP: ISO-8859 mapping (elot-928) [default]\&. 317When this option is on, bold text will be displayed using the first
299\fBibm\fP: IBM-437 mapping (DOS codepage 737); 318available bold font in the font list\&.
319Bold fonts should thus be specified in the font list after their
320corresponding regular fonts\&.
321If no bold font can be found, a regular font will be used\&.
300option \fB-grk\fP\&. 322option \fB-rb\fP\&.
301.IP "\fBgreektoggle_key:\fP \fIkeysym\fP" 323\fBFalse\fP: Display bold text in a regular font, using the color
302Set the key to toggle keyboard input between no translation and 324specified with \fBcolorBD\fP;
303Greek translation [default \fBMode_switch\fP]\&. 325option \fB+rb\fP\&.
304For more details, see the distributed file \fBREADME\&.greek\fP\&.
305.IP "\fBselectstyle:\fP \fImode\fP" 326.IP "\fBselectstyle:\fP \fImode\fP"
306Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 327Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
307is xterm style with 2\&.20 old word selection, or anything else which 328is xterm style with 2\&.20 old word selection, or anything else which
308gives xterm style selection\&. 329gives xterm style selection\&.
309.IP "\fBscrollstyle:\fP \fImode\fP" 330.IP "\fBscrollstyle:\fP \fImode\fP"
310Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 331Set scrollbar style to \fBurxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
311.IP "\fBtitle:\fP \fIstring\fP" 332.IP "\fBtitle:\fP \fIstring\fP"
312Set window title string, the default title is the command-line 333Set window title string, the default title is the command-line
313specified after the \fB-e\fP option, if any, otherwise the application 334specified after the \fB-e\fP option, if any, otherwise the application
314name; 335name;
315option \fB-title\fP\&. 336option \fB-title\fP\&.
416option \fB-bc\fP\&. 437option \fB-bc\fP\&.
417.IP "\fBpointerBlank:\fP \fIboolean\fP" 438.IP "\fBpointerBlank:\fP \fIboolean\fP"
418\fBTrue\fP: blank the pointer when a key is pressed or after a set number 439\fBTrue\fP: blank the pointer when a key is pressed or after a set number
419of seconds of inactivity\&. 440of seconds of inactivity\&.
420\fBFalse\fP: the pointer is always visible [default]\&. 441\fBFalse\fP: the pointer is always visible [default]\&.
442.IP "\fBpointerColor:\fP \fIcolour\fP"
443Mouse pointer foreground colour\&.
444.IP "\fBpointerColor2:\fP \fIcolour\fP"
445Mouse pointer background colour\&.
421.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 446.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
422Specifies number of seconds before blanking the pointer [default 2]\&. 447Specifies number of seconds before blanking the pointer [default 2]\&.
423.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
424\fBTrue\fP: consider multibyte glyphs as single character for backspace,
425delete and cursor movement keys;
426option \fB-mcc\fP\&.
427\fBFalse\fP: move through all components of all glyphs;
428option \fB+mcc\fP\&.
429.IP "\fBbackspacekey:\fP \fIstring\fP" 448.IP "\fBbackspacekey:\fP \fIstring\fP"
430The string to send when the backspace key is pressed\&. If set to 449The string to send when the backspace key is pressed\&. If set to
431\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 450\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
432\fBBackspace\fP (code 8) - which can be reversed with the appropriate 451\fBBackspace\fP (code 8) - which can be reversed with the appropriate
433DEC private mode escape sequence\&. 452DEC private mode escape sequence\&.
450The locale to use for opening the IM\&. You can use an LC_CTYPE 469The locale to use for opening the IM\&. You can use an LC_CTYPE
451of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 470of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
452for the input extension to be able to input japanese characters 471for the input extension to be able to input japanese characters
453while staying in another locale\&. 472while staying in another locale\&.
454option \fB-imlocale\fP\&. 473option \fB-imlocale\fP\&.
474.IP "\fBinsecure\fP"
475Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
476that echo arbitrary strings like the icon name or the locale\&. This
477could be abused if somebody gets 8-bit-clean access to your
478display, wether throuh a mail client displaying mail bodies
479unfiltered or though write(1)\&. Therefore, these sequences are
480disabled by default\&. (Note that other terminals, including xterm,
481have these sequences enabled by default)\&. You can enable them
482by setting this boolean resource or specifying \fB-insecure\fP as
483an option\&. At the moment, this enabled display-answer, locale,
484findfont, icon label and window title requests as well as dynamic
485menubar dispatch\&.
455.IP "\fBmodifier:\fP \fImodifier\fP" 486.IP "\fBmodifier:\fP \fImodifier\fP"
456Set the key to be interpreted as the Meta key to: 487Set the key to be interpreted as the Meta key to:
457\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 488\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
458\fBmod4\fP, \fBmod5\fP; 489\fBmod4\fP, \fBmod5\fP;
459option \fB-mod\fP\&. 490option \fB-mod\fP\&.
460.IP "\fBanswerbackString:\fP \fIstring\fP" 491.IP "\fBanswerbackString:\fP \fIstring\fP"
461Specify the reply rxvt sends to the shell when an ENQ (control-E) 492Specify the reply rxvt sends to the shell when an ENQ (control-E)
462character is passed through\&. It may contain escape values as 493character is passed through\&. It may contain escape values as
463described in the entry on \fBkeysym\fP following\&. 494described in the entry on \fBkeysym\fP following\&.
495.IP "\fBsecondaryScreen:\fP \fIbool\fP"
496Turn on/off secondary screen (default enabled)\&.
497.IP "\fBsecondaryScroll:\fP \fIbool\fP"
498Turn on/off secondary screen scroll (default enabled)\&. If
499the this option is enabled, scrolls on the secondary screen will
500change the scrollback buffer and switching to/from the secondary screen
501will instead scroll the screen up\&.
464.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 502.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
465Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 503Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
466may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 504may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
467\en: newline, \er: return, \et: tab, \e000: octal number) or control 505\en: newline, \er: return, \et: tab, \e000: octal number) or control
468characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 506characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
469double quotes so that it can start or end with whitespace\&. The 507double quotes so that it can start or end with whitespace\&. The
470intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This 508intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
471resource is only available when compiled with KEYSYM_RESOURCE\&. 509resource is only available when compiled with KEYSYM_RESOURCE\&.
472.SH "THE SCROLLBAR" 510.SH "THE SCROLLBAR"
473.PP 511.PP
474Lines of text that scroll off the top of the \fBrxvt\fP window (resource: 512Lines of text that scroll off the top of the \fBurxvt\fP window (resource:
475\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. 513\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&.
476The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly 514The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly
477intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour 515intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
478mimics that of \fIxterm\fP 516mimics that of \fIxterm\fP
479.PP 517.PP
480Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. 518Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
481Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. 519Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
502region and release; Right click to extend the marked region; 540region and release; Right click to extend the marked region;
503Left double-click to select a word; Left triple-click to select 541Left double-click to select a word; Left triple-click to select
504the entire line\&. 542the entire line\&.
505.IP "\fBInsertion\fP:" 543.IP "\fBInsertion\fP:"
506Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) 544Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
507in an \fBrxvt\fP window causes the current text selection to be inserted 545in an \fBurxvt\fP window causes the current text selection to be inserted
508as if it had been typed on the keyboard\&. 546as if it had been typed on the keyboard\&.
509.SH "CHANGING FONTS" 547.SH "CHANGING FONTS"
510.PP 548.PP
511You can change fonts on-the-fly, which is to say cycle through the default 549You can change fonts on-the-fly, which is to say cycle through the default
512font and others of various sizes, by using \fBShift-KP_Add\fP and 550font and others of various sizes, by using \fBShift-KP_Add\fP and
513\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with 551\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
514\fBAlt->\fP and \fBAlt-<\fP, where the actual key 552\fBAlt->\fP and \fBAlt-<\fP, where the actual key
515can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. 553can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
516.SH "LOGIN STAMP" 554.SH "LOGIN STAMP"
517.PP 555.PP
518\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 556\fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
519seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 557seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
520feature, \fBrxvt\fP must be installed setuid root on some systems\&. 558feature, \fBurxvt\fP must be installed setuid root on some systems\&.
521.SH "COLORS AND GRAPHICS" 559.SH "COLORS AND GRAPHICS"
522.PP 560.PP
523If graphics support was enabled at compile-time, \fBrxvt\fP can be queried
524with ANSI escape sequences and can address individual pixels instead of
525text characters\&. Note the graphics support is still considered beta code\&.
526.PP
527In addition to the default foreground and background colours, \fBrxvt\fP 561In addition to the default foreground and background colours, \fBurxvt\fP
528can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 562can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
529versions of the same)\&. 563versions of the same)\&.
530Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 564Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
531.PP 565.PP
532.TS 566.TS
1013.IP "\fBrxvt -fg Black -bg White -rv\fP" 1047.IP "\fBrxvt -fg Black -bg White -rv\fP"
1014would yield White on Black, while on \fIxterm\fP(1) it would yield 1048would yield White on Black, while on \fIxterm\fP(1) it would yield
1015Black on White\&. 1049Black on White\&.
1016.SH "ENVIRONMENT" 1050.SH "ENVIRONMENT"
1017.PP 1051.PP
1018\fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and 1052\fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and
1019\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window 1053\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window
1020id number of the \fBrxvt\fP window and it also uses and sets the environment 1054id number of the \fBurxvt\fP window and it also uses and sets the environment
1021variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses 1055variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses
1022the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. 1056the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
1023.SH "FILES" 1057.SH "FILES"
1024.PP 1058.PP
1025.IP "\fB/etc/utmp\fP" 1059.IP "\fB/etc/utmp\fP"
1026System file for login records\&. 1060System file for login records\&.
1041.PP 1075.PP
1042Cursor change support is not yet implemented\&. 1076Cursor change support is not yet implemented\&.
1043.PP 1077.PP
1044Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1078Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1045.PP 1079.PP
1046Graphics support is fairly crude\&.
1047.PP
1048.SH "FTP LOCATION" 1080.SH "FTP LOCATION"
1049.PP 1081.PP
1050rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 1082rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites
1051RXVTFTPSITE() 1083ftp://ftp\&.rxvt\&.org/pub/rxvt
1052.PP 1084.PP
1053.SH "CURRENT PROJECT COORDINATOR" 1085.SH "CURRENT PROJECT COORDINATOR"
1054.PP 1086.PP
1055.IP "Project Coordinator" 1087.IP "Project Coordinator"
1056RXVTMAINT() RXVTMAINTEMAIL() 1088Marc A\&. Lehmann <rxvt@schmorp\&.de>
1057.br 1089.br
1058.IP "Web page maintainter" 1090.IP "Web page maintainter"
1059RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 1091Marc A\&. Lehmann <rxvt@schmorp\&.de>
1060.br 1092.br
1061RXVTWEBPAGE() 1093<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
1062.br 1094.br
1063.IP "Mailing list"
1064The Rxvt Workers <rxvt-workers@rxvt\&.org>
1065mailing list has also been established for rxvt development, to
1066subscribe, email to
1067<rxvt-workers-subscribe@rxvt\&.org>\&.
1068There is also a mailing list for announcements of new releases of
1069rxvt\&. To subscribe, email to
1070<rxvt-announce-subscribe@rxvt\&.org>\&.
1071.PP 1095.PP
1072.SH "AUTHORS" 1096.SH "AUTHORS"
1073.PP 1097.PP
1074.IP "John Bovey" 1098.IP "John Bovey"
1075University of Kent, 1992, wrote the original Xvt\&. 1099University of Kent, 1992, wrote the original Xvt\&.
1076.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" 1100.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
1077very heavily modified Xvt and came up with Rxvt 1101very heavily modified Xvt and came up with Rxvt
1078.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" 1102.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
1079wrote the Greek Keyboard Input 1103wrote the Greek Keyboard Input (no longer in code)
1080.IP "mj olesen <olesen@me\&.QueensU\&.CA>" 1104.IP "mj olesen <olesen@me\&.QueensU\&.CA>"
1081Wrote the menu system\&. 1105Wrote the menu system\&.
1082.br 1106.br
1083Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) 1107Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
1084.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1108.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1085Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1109Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1086.IP "Geoff Wing <gcw@pobox\&.com>" 1110.IP "Geoff Wing <gcw@pobox\&.com>"
1087Rewrote screen display and text selection routines\&. 1111Rewrote screen display and text selection routines\&.
1112Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1113.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1114Forked rxvt-unicode, rewrote most of the display code and
1115internal character handling to store text in unicode,
1116improve xterm compatibility and apply numerous other bugfixes
1117and extensions\&.
1088.br 1118.br
1089Project Coordinator (changes\&.txt 2\&.4\&.6 - ) 1119Project Coordinator (Changes 1\&.0 - )
1120.PP

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines