| 1 | .TH "RXVT" "1" "2004-05-10" "X Version 11" "X Tools" |
1 | .TH "RXVT" "1" "2004-06-26" "X Version 11" "X Tools" |
| 2 | .SH "NAME" |
2 | .SH "NAME" |
| 3 | rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system |
3 | rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system |
| 4 | .PP |
4 | .PP |
| 5 | .SH "SYNOPSIS" |
5 | .SH "SYNOPSIS" |
| 6 | .PP |
6 | .PP |
| 7 | \fBrxvt\fP [options] [-e command [ args ]] |
7 | \fBurxvt\fP [options] [-e command [ args ]] |
| 8 | .PP |
8 | .PP |
| 9 | .SH "DESCRIPTION" |
9 | .SH "DESCRIPTION" |
| 10 | .PP |
10 | .PP |
| 11 | \fBrxvt-unicode\fP, version \fB3\&.1\fP, is a colour vt102 terminal emulator |
11 | \fBrxvt-unicode\fP, version \fB3\&.1\fP, is a colour vt102 terminal emulator |
| 12 | intended as an \fIxterm\fP(1) replacement for users who do not require |
12 | intended as an \fIxterm\fP(1) replacement for users who do not require |
| … | |
… | |
| 15 | advantage on a machine serving many X sessions\&. |
15 | advantage on a machine serving many X sessions\&. |
| 16 | .PP |
16 | .PP |
| 17 | .PP |
17 | .PP |
| 18 | .SH "OPTIONS" |
18 | .SH "OPTIONS" |
| 19 | .PP |
19 | .PP |
| 20 | The \fBrxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. |
20 | The \fBurxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. |
| 21 | In keeping with the smaller-is-better philosophy, options may be eliminated |
21 | In keeping with the smaller-is-better philosophy, options may be eliminated |
| 22 | or default values chosen at compile-time, so options and defaults listed |
22 | or default values chosen at compile-time, so options and defaults listed |
| 23 | may not accurately reflect the version installed on your system\&. |
23 | may not accurately reflect the version installed on your system\&. |
| 24 | `rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&. |
24 | `rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&. |
| 25 | Option descriptions may be prefixed with which compile option each is |
25 | Option descriptions may be prefixed with which compile option each is |
| 26 | dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP |
26 | dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP |
| 27 | line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled |
27 | line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled |
| 28 | into your version\&. |
28 | into your version\&. |
| 29 | .PP |
29 | .PP |
| 30 | Note that \fBrxvt\fP permits the resource name to be used as a long-option |
30 | Note that \fBurxvt\fP permits the resource name to be used as a long-option |
| 31 | (--/++ option) so the potential command-line options are far greater than |
31 | (--/++ option) so the potential command-line options are far greater than |
| 32 | those listed\&. |
32 | those listed\&. |
| 33 | For example: `rxvt --loginShell --color1 Orange\&'\&. |
33 | For example: `rxvt --loginShell --color1 Orange\&'\&. |
| 34 | .PP |
34 | .PP |
| 35 | The following options are available: |
35 | The following options are available: |
| … | |
… | |
| 78 | resource \fBpointerColor2\fP\&. |
78 | resource \fBpointerColor2\fP\&. |
| 79 | .IP "\fB-bd\fP \fIcolour\fP" |
79 | .IP "\fB-bd\fP \fIcolour\fP" |
| 80 | The colour of the border between the xterm scrollbar and the text; |
80 | The colour of the border between the xterm scrollbar and the text; |
| 81 | resource \fBborderColor\fP\&. |
81 | resource \fBborderColor\fP\&. |
| 82 | .IP "\fB-fn\fP \fIfontname\fP" |
82 | .IP "\fB-fn\fP \fIfontname\fP" |
| 83 | Select the fonts to be used used\&. This is a comma seperated |
83 | Select the fonts to be used\&. |
| 84 | list of font names that are used in turn when trying to display |
84 | This is a comma seperated list of font names that are used in turn when |
| 85 | unicode characters\&. The first font defines the cell size for characters, |
85 | trying to display Unicode characters\&. |
| 86 | other fonts might be smaller, but not larger\&. A reasonable default font list |
86 | The first font defines the cell size for characters; other fonts might |
| 87 | is always appended to it\&. |
87 | be smaller, but not larger\&. |
|
|
88 | A reasonable default font list is always appended to it\&. |
| 88 | resource \fBfont\fP\&. |
89 | resource \fBfont\fP\&. |
|
|
90 | .IP "\fB-rb\fP|\fB+rb\fP" |
|
|
91 | Enable "real bold" support\&. |
|
|
92 | When this option is on, bold text will be displayed using the first |
|
|
93 | available bold font in the font list\&. |
|
|
94 | Bold fonts should thus be specified in the font list after their |
|
|
95 | corresponding regular fonts\&. |
|
|
96 | If no bold font can be found, a regular font will be used\&. |
|
|
97 | resource \fBrealBold\fP\&. |
| 89 | .IP "\fB-name\fP \fIname\fP" |
98 | .IP "\fB-name\fP \fIname\fP" |
| 90 | Specify the application name under which resources |
99 | Specify the application name under which resources |
| 91 | are to be obtained, rather than the default executable file name\&. |
100 | are to be obtained, rather than the default executable file name\&. |
| 92 | Name should not contain `\&.\&' or `*\&' characters\&. |
101 | Name should not contain `\&.\&' or `*\&' characters\&. |
| 93 | Also sets the icon and title name\&. |
102 | Also sets the icon and title name\&. |
| … | |
… | |
| 144 | This option specifies the name of the terminal type to be set in the |
153 | This option specifies the name of the terminal type to be set in the |
| 145 | \fBTERM\fP environment variable\&. This terminal type must exist in the |
154 | \fBTERM\fP environment variable\&. This terminal type must exist in the |
| 146 | \fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; |
155 | \fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; |
| 147 | resource \fBtermName\fP\&. |
156 | resource \fBtermName\fP\&. |
| 148 | .IP "\fB-e\fP \fIcommand [arguments]\fP" |
157 | .IP "\fB-e\fP \fIcommand [arguments]\fP" |
| 149 | Run the command with its command-line arguments in the \fBrxvt\fP |
158 | Run the command with its command-line arguments in the \fBurxvt\fP |
| 150 | window; also sets the window title and icon name to be the basename |
159 | window; also sets the window title and icon name to be the basename |
| 151 | of the program being executed if neither \fI-title\fP (\fI-T\fP) nor |
160 | of the program being executed if neither \fI-title\fP (\fI-T\fP) nor |
| 152 | \fI-n\fP are given on the command line\&. If this option is used, it |
161 | \fI-n\fP are given on the command line\&. If this option is used, it |
| 153 | must be the last on the command-line\&. If there is no \fB-e\fP option |
162 | must be the last on the command-line\&. If there is no \fB-e\fP option |
| 154 | then the default is to run the program specified by the \fBSHELL\fP |
163 | then the default is to run the program specified by the \fBSHELL\fP |
| … | |
… | |
| 198 | .SH "RESOURCES (available also as long-options)" |
207 | .SH "RESOURCES (available also as long-options)" |
| 199 | .PP |
208 | .PP |
| 200 | Note: `rxvt --help\&' gives a list of all resources (long options) compiled |
209 | Note: `rxvt --help\&' gives a list of all resources (long options) compiled |
| 201 | into your version\&. |
210 | into your version\&. |
| 202 | If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists |
211 | If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists |
| 203 | \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in |
212 | \fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in |
| 204 | XAPPLOADDIR/Rxvt (compile-time defined: usually |
213 | XAPPLOADDIR/Rxvt (compile-time defined: usually |
| 205 | \fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, |
214 | \fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, |
| 206 | or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when |
215 | or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when |
| 207 | reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and |
216 | reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and |
| 208 | \fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both |
217 | \fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both |
| 209 | \fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name |
218 | \fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name |
| 210 | \fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and |
219 | \fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and |
| 211 | key-handling, to be shared between different \fBrxvt\fP configurations\&. |
220 | key-handling, to be shared between different \fBurxvt\fP configurations\&. |
| 212 | If no resources are specified, suitable defaults will be used\&. |
221 | If no resources are specified, suitable defaults will be used\&. |
| 213 | Command-line arguments can be used to override resource settings\&. The |
222 | Command-line arguments can be used to override resource settings\&. The |
| 214 | following resources are allowed: |
223 | following resources are allowed: |
| 215 | .PP |
224 | .PP |
| 216 | .IP "\fBgeometry:\fP \fIgeom\fP" |
225 | .IP "\fBgeometry:\fP \fIgeom\fP" |
| … | |
… | |
| 234 | but the actual colour names used are listed in the |
243 | but the actual colour names used are listed in the |
| 235 | \fBCOLORS AND GRAPHICS\fP section\&. |
244 | \fBCOLORS AND GRAPHICS\fP section\&. |
| 236 | .IP "\fBcolorBD:\fP \fIcolour\fP" |
245 | .IP "\fBcolorBD:\fP \fIcolour\fP" |
| 237 | Use the specified colour to display bold characters when the |
246 | Use the specified colour to display bold characters when the |
| 238 | foreground colour is the default\&. |
247 | foreground colour is the default\&. |
|
|
248 | This option will be ignored if \fBrealBold\fP is enabled\&. |
| 239 | .IP "\fBcolorUL:\fP \fIcolour\fP" |
249 | .IP "\fBcolorUL:\fP \fIcolour\fP" |
| 240 | Use the specified colour to display underlined characters when the |
250 | Use the specified colour to display underlined characters when the |
| 241 | foreground colour is the default\&. |
251 | foreground colour is the default\&. |
| 242 | .IP "\fBcolorRV:\fP \fIcolour\fP" |
252 | .IP "\fBcolorRV:\fP \fIcolour\fP" |
| 243 | Use the specified colour as the background for reverse video |
253 | Use the specified colour as the background for reverse video |
| … | |
… | |
| 290 | .IP "\fBpath:\fP \fIpath\fP" |
300 | .IP "\fBpath:\fP \fIpath\fP" |
| 291 | Specify the colon-delimited search path for finding files (XPM and |
301 | Specify the colon-delimited search path for finding files (XPM and |
| 292 | menus), in addition to the paths specified by the \fBRXVTPATH\fP and |
302 | menus), in addition to the paths specified by the \fBRXVTPATH\fP and |
| 293 | \fBPATH\fP environment variables\&. |
303 | \fBPATH\fP environment variables\&. |
| 294 | .IP "\fBfont:\fP \fIfontname\fP" |
304 | .IP "\fBfont:\fP \fIfontname\fP" |
| 295 | Select the fonts to be used used\&. This is a comma seperated |
305 | Select the fonts to be used\&. |
| 296 | list of font names that are used in turn when trying to display |
306 | This is a comma seperated list of font names that are used in turn when |
| 297 | unicode characters\&. The first font defines the cell size for characters, |
307 | trying to display Unicode characters\&. |
| 298 | other fonts might be smaller, but not larger\&. A reasonable default font list |
308 | The first font defines the cell size for characters; other fonts might |
| 299 | is always appended to this list\&. |
309 | be smaller, but not larger\&. |
|
|
310 | A reasonable default font list is always appended to it\&. |
| 300 | option \fB-fn\fP\&. |
311 | option \fB-fn\fP\&. |
|
|
312 | .IP "\fBrealBold:\fP \fIboolean\fP" |
|
|
313 | \fBTrue\fP: Enable "real bold" support\&. |
|
|
314 | When this option is on, bold text will be displayed using the first |
|
|
315 | available bold font in the font list\&. |
|
|
316 | Bold fonts should thus be specified in the font list after their |
|
|
317 | corresponding regular fonts\&. |
|
|
318 | If no bold font can be found, a regular font will be used\&. |
|
|
319 | option \fB-rb\fP\&. |
|
|
320 | \fBFalse\fP: Display bold text in a regular font, using the color |
|
|
321 | specified with \fBcolorBD\fP; |
|
|
322 | option \fB+rb\fP\&. |
| 301 | .IP "\fBselectstyle:\fP \fImode\fP" |
323 | .IP "\fBselectstyle:\fP \fImode\fP" |
| 302 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
324 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
| 303 | is xterm style with 2\&.20 old word selection, or anything else which |
325 | is xterm style with 2\&.20 old word selection, or anything else which |
| 304 | gives xterm style selection\&. |
326 | gives xterm style selection\&. |
| 305 | .IP "\fBscrollstyle:\fP \fImode\fP" |
327 | .IP "\fBscrollstyle:\fP \fImode\fP" |
| 306 | Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP |
328 | Set scrollbar style to \fBurxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP |
| 307 | .IP "\fBtitle:\fP \fIstring\fP" |
329 | .IP "\fBtitle:\fP \fIstring\fP" |
| 308 | Set window title string, the default title is the command-line |
330 | Set window title string, the default title is the command-line |
| 309 | specified after the \fB-e\fP option, if any, otherwise the application |
331 | specified after the \fB-e\fP option, if any, otherwise the application |
| 310 | name; |
332 | name; |
| 311 | option \fB-title\fP\&. |
333 | option \fB-title\fP\&. |
| … | |
… | |
| 482 | double quotes so that it can start or end with whitespace\&. The |
504 | double quotes so that it can start or end with whitespace\&. The |
| 483 | intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This |
505 | intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This |
| 484 | resource is only available when compiled with KEYSYM_RESOURCE\&. |
506 | resource is only available when compiled with KEYSYM_RESOURCE\&. |
| 485 | .SH "THE SCROLLBAR" |
507 | .SH "THE SCROLLBAR" |
| 486 | .PP |
508 | .PP |
| 487 | Lines of text that scroll off the top of the \fBrxvt\fP window (resource: |
509 | Lines of text that scroll off the top of the \fBurxvt\fP window (resource: |
| 488 | \fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. |
510 | \fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. |
| 489 | The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly |
511 | The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly |
| 490 | intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour |
512 | intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour |
| 491 | mimics that of \fIxterm\fP |
513 | mimics that of \fIxterm\fP |
| 492 | .PP |
514 | .PP |
| 493 | Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. |
515 | Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. |
| 494 | Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. |
516 | Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. |
| … | |
… | |
| 515 | region and release; Right click to extend the marked region; |
537 | region and release; Right click to extend the marked region; |
| 516 | Left double-click to select a word; Left triple-click to select |
538 | Left double-click to select a word; Left triple-click to select |
| 517 | the entire line\&. |
539 | the entire line\&. |
| 518 | .IP "\fBInsertion\fP:" |
540 | .IP "\fBInsertion\fP:" |
| 519 | Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) |
541 | Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) |
| 520 | in an \fBrxvt\fP window causes the current text selection to be inserted |
542 | in an \fBurxvt\fP window causes the current text selection to be inserted |
| 521 | as if it had been typed on the keyboard\&. |
543 | as if it had been typed on the keyboard\&. |
| 522 | .SH "CHANGING FONTS" |
544 | .SH "CHANGING FONTS" |
| 523 | .PP |
545 | .PP |
| 524 | You can change fonts on-the-fly, which is to say cycle through the default |
546 | You can change fonts on-the-fly, which is to say cycle through the default |
| 525 | font and others of various sizes, by using \fBShift-KP_Add\fP and |
547 | font and others of various sizes, by using \fBShift-KP_Add\fP and |
| 526 | \fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with |
548 | \fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with |
| 527 | \fBAlt->\fP and \fBAlt-<\fP, where the actual key |
549 | \fBAlt->\fP and \fBAlt-<\fP, where the actual key |
| 528 | can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. |
550 | can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. |
| 529 | .SH "LOGIN STAMP" |
551 | .SH "LOGIN STAMP" |
| 530 | .PP |
552 | .PP |
| 531 | \fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be |
553 | \fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be |
| 532 | seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this |
554 | seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this |
| 533 | feature, \fBrxvt\fP must be installed setuid root on some systems\&. |
555 | feature, \fBurxvt\fP must be installed setuid root on some systems\&. |
| 534 | .SH "COLORS AND GRAPHICS" |
556 | .SH "COLORS AND GRAPHICS" |
| 535 | .PP |
557 | .PP |
| 536 | In addition to the default foreground and background colours, \fBrxvt\fP |
558 | In addition to the default foreground and background colours, \fBurxvt\fP |
| 537 | can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
559 | can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
| 538 | versions of the same)\&. |
560 | versions of the same)\&. |
| 539 | Here is a list of the colours with their \fBrgb\&.txt\fP names\&. |
561 | Here is a list of the colours with their \fBrgb\&.txt\fP names\&. |
| 540 | .PP |
562 | .PP |
| 541 | .TS |
563 | .TS |
| … | |
… | |
| 575 | .IP "\fBrxvt -fg Black -bg White -rv\fP" |
597 | .IP "\fBrxvt -fg Black -bg White -rv\fP" |
| 576 | would yield White on Black, while on \fIxterm\fP(1) it would yield |
598 | would yield White on Black, while on \fIxterm\fP(1) it would yield |
| 577 | Black on White\&. |
599 | Black on White\&. |
| 578 | .SH "ENVIRONMENT" |
600 | .SH "ENVIRONMENT" |
| 579 | .PP |
601 | .PP |
| 580 | \fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and |
602 | \fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and |
| 581 | \fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window |
603 | \fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window |
| 582 | id number of the \fBrxvt\fP window and it also uses and sets the environment |
604 | id number of the \fBurxvt\fP window and it also uses and sets the environment |
| 583 | variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses |
605 | variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses |
| 584 | the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. |
606 | the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. |
| 585 | .SH "FILES" |
607 | .SH "FILES" |
| 586 | .PP |
608 | .PP |
| 587 | .IP "\fB/etc/utmp\fP" |
609 | .IP "\fB/etc/utmp\fP" |
| 588 | System file for login records\&. |
610 | System file for login records\&. |
