| 1 | .TH "RXVT" "1" "2004-06-26" "X Version 11" "X Tools" |
1 | .TH "RXVT" "1" "2004-07-31" "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 | \fBurxvt\fP [options] [-e command [ args ]] |
7 | \fBrxvt\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\&.4\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 |
| 13 | features such as Tektronix 4014 emulation and toolkit-style configurability\&. |
13 | features such as Tektronix 4014 emulation and toolkit-style configurability\&. |
| 14 | As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant |
14 | As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant |
| 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 \fBurxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. |
20 | The \fBrxvt\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 \fBurxvt\fP permits the resource name to be used as a long-option |
30 | Note that \fBrxvt\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: |
| … | |
… | |
| 51 | resource \fBjumpScroll\fP\&. |
51 | resource \fBjumpScroll\fP\&. |
| 52 | .IP "\fB-ip\fP|\fB+ip\fP" |
52 | .IP "\fB-ip\fP|\fB+ip\fP" |
| 53 | Turn on/off inheriting parent window\&'s pixmap\&. Alternative form |
53 | Turn on/off inheriting parent window\&'s pixmap\&. Alternative form |
| 54 | is \fB-tr\fP; |
54 | is \fB-tr\fP; |
| 55 | resource \fBinheritPixmap\fP\&. |
55 | resource \fBinheritPixmap\fP\&. |
|
|
56 | .IP "\fB-fade\fP \fInumber\fP" |
|
|
57 | Fade the text by the given percentage when focus is lost\&. |
| 56 | .IP "\fB-tint\fP \fIcolour\fP" |
58 | .IP "\fB-tint\fP \fIcolour\fP" |
| 57 | Tint the transparent background pixmap with the given colour\&. |
59 | Tint the transparent background pixmap with the given colour when |
|
|
60 | transparency is enabled with \fB-tr\fP or \fB-ip\fP\&. See also |
|
|
61 | the \fB-sh\fP option that cna be used to brighten or darken |
|
|
62 | the image in addition to tinting it\&. |
|
|
63 | dot(\fB-sh\fP) \fInumber\fP |
|
|
64 | Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background |
|
|
65 | image in addition to tinting it\&. |
| 58 | .IP "\fB-bg\fP \fIcolour\fP" |
66 | .IP "\fB-bg\fP \fIcolour\fP" |
| 59 | Window background colour; |
67 | Window background colour; |
| 60 | resource \fBbackground\fP\&. |
68 | resource \fBbackground\fP\&. |
| 61 | .IP "\fB-fg\fP \fIcolour\fP" |
69 | .IP "\fB-fg\fP \fIcolour\fP" |
| 62 | Window foreground colour; |
70 | Window foreground colour; |
| 63 | resource \fBforeground\fP\&. |
71 | resource \fBforeground\fP\&. |
| 64 | .IP "\fB-pixmap:\fP \fIfile[;geom]\fP" |
72 | .IP "\fB-pixmap\fP \fIfile[;geom]\fP" |
| 65 | Compile \fIXPM\fP: Specify XPM file for the background and also |
73 | Compile \fIXPM\fP: Specify XPM file for the background and also |
| 66 | optionally specify its scaling with a geometry string\&. Note you |
74 | optionally specify its scaling with a geometry string\&. Note you |
| 67 | may need to add quotes to avoid special shell interpretation of |
75 | may need to add quotes to avoid special shell interpretation of |
| 68 | the `;\&' in the command-line; |
76 | the `;\&' in the command-line; |
| 69 | resource \fBbackgroundPixmap\fP\&. |
77 | resource \fBbackgroundPixmap\fP\&. |
| … | |
… | |
| 153 | This option specifies the name of the terminal type to be set in the |
161 | This option specifies the name of the terminal type to be set in the |
| 154 | \fBTERM\fP environment variable\&. This terminal type must exist in the |
162 | \fBTERM\fP environment variable\&. This terminal type must exist in the |
| 155 | \fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; |
163 | \fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; |
| 156 | resource \fBtermName\fP\&. |
164 | resource \fBtermName\fP\&. |
| 157 | .IP "\fB-e\fP \fIcommand [arguments]\fP" |
165 | .IP "\fB-e\fP \fIcommand [arguments]\fP" |
| 158 | Run the command with its command-line arguments in the \fBurxvt\fP |
166 | Run the command with its command-line arguments in the \fBrxvt\fP |
| 159 | window; also sets the window title and icon name to be the basename |
167 | window; also sets the window title and icon name to be the basename |
| 160 | of the program being executed if neither \fI-title\fP (\fI-T\fP) nor |
168 | of the program being executed if neither \fI-title\fP (\fI-T\fP) nor |
| 161 | \fI-n\fP are given on the command line\&. If this option is used, it |
169 | \fI-n\fP are given on the command line\&. If this option is used, it |
| 162 | must be the last on the command-line\&. If there is no \fB-e\fP option |
170 | must be the last on the command-line\&. If there is no \fB-e\fP option |
| 163 | then the default is to run the program specified by the \fBSHELL\fP |
171 | then the default is to run the program specified by the \fBSHELL\fP |
| … | |
… | |
| 206 | in some window managers\&. |
214 | in some window managers\&. |
| 207 | .SH "RESOURCES (available also as long-options)" |
215 | .SH "RESOURCES (available also as long-options)" |
| 208 | .PP |
216 | .PP |
| 209 | Note: `rxvt --help\&' gives a list of all resources (long options) compiled |
217 | Note: `rxvt --help\&' gives a list of all resources (long options) compiled |
| 210 | into your version\&. |
218 | into your version\&. |
|
|
219 | .PP |
|
|
220 | There are two different methods that rxvt can use to get the |
|
|
221 | Xresource data: using the X libraries (Xrm*-functions) or internal Xresources |
|
|
222 | reader (\fB~/\&.Xdefaults\fP)\&. For the first method (ie\&. \fBrxvt -h\fP lists |
|
|
223 | \fBXGetDefaults\fP), you can set and change the resources using X11 |
|
|
224 | tools like \fBxset\fP\&. Many distribution do also load settings from the |
|
|
225 | \fB~/\&.Xresources\fP file when X starts\&. |
|
|
226 | .PP |
| 211 | If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists |
227 | If compiled with internal Xresources support (i\&.e\&. \fBrxvt |
| 212 | \fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in |
228 | -h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application |
| 213 | XAPPLOADDIR/Rxvt (compile-time defined: usually |
229 | defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually |
| 214 | \fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, |
230 | \fB/usr/lib/X11/app-defaults/URxvt\fP) and resources set in |
| 215 | or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when |
231 | \fB~/\&.Xdefaults\fP, or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. |
| 216 | reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and |
232 | Note that when reading X resources, \fBrxvt\fP recognizes two class |
| 217 | \fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both |
233 | names: \fBXTerm\fP and \fBURxvt\fP\&. The class name \fBRxvt\fP allows resources |
| 218 | \fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name |
234 | common to both \fBrxvt\fP and the original \fIrxvt\fP to be easily configured, |
| 219 | \fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and |
235 | while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP, |
| 220 | key-handling, to be shared between different \fBurxvt\fP configurations\&. |
236 | notably colours and key-handling, to be shared between different |
| 221 | If no resources are specified, suitable defaults will be used\&. |
237 | \fBrxvt\fP configurations\&. If no resources are specified, suitable |
| 222 | Command-line arguments can be used to override resource settings\&. The |
238 | defaults will be used\&. Command-line arguments can be used to override |
| 223 | following resources are allowed: |
239 | resource settings\&. The following resources are allowed: |
| 224 | .PP |
240 | .PP |
| 225 | .IP "\fBgeometry:\fP \fIgeom\fP" |
241 | .IP "\fBgeometry:\fP \fIgeom\fP" |
| 226 | Create the window with the specified X window geometry [default |
242 | Create the window with the specified X window geometry [default |
| 227 | 80x24]; |
243 | 80x24]; |
| 228 | option \fB-geometry\fP\&. |
244 | option \fB-geometry\fP\&. |
| … | |
… | |
| 274 | option \fB+j\fP\&. |
290 | option \fB+j\fP\&. |
| 275 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
291 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
| 276 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
292 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
| 277 | giving artificial transparency\&. |
293 | giving artificial transparency\&. |
| 278 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
294 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
|
|
295 | .IP "\fBfading:\fP \fInumber\fP" |
|
|
296 | Fade the text by the given percentage when focus is lost\&. |
| 279 | .IP "\fBtintColor\fP \fIcolour\fP" |
297 | .IP "\fBtintColor:\fP \fIcolour\fP" |
| 280 | Tint the transparent background pixmap with the given colour\&. |
298 | Tint the transparent background pixmap with the given colour\&. |
|
|
299 | .IP "\fBshading:\fP \fInumber\fP" |
|
|
300 | Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background |
|
|
301 | image in addition to tinting it\&. |
|
|
302 | .IP "\fBfading:\fP \fInumber\fP" |
|
|
303 | Scale the tint colour by the given percentage\&. |
| 281 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
304 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
| 282 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
305 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
| 283 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
306 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
| 284 | Use the specified colour for the scrollbar\&'s trough area [default |
307 | Use the specified colour for the scrollbar\&'s trough area [default |
| 285 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
308 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
| … | |
… | |
| 323 | .IP "\fBselectstyle:\fP \fImode\fP" |
346 | .IP "\fBselectstyle:\fP \fImode\fP" |
| 324 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
347 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
| 325 | is xterm style with 2\&.20 old word selection, or anything else which |
348 | is xterm style with 2\&.20 old word selection, or anything else which |
| 326 | gives xterm style selection\&. |
349 | gives xterm style selection\&. |
| 327 | .IP "\fBscrollstyle:\fP \fImode\fP" |
350 | .IP "\fBscrollstyle:\fP \fImode\fP" |
| 328 | Set scrollbar style to \fBurxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP |
351 | Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP |
| 329 | .IP "\fBtitle:\fP \fIstring\fP" |
352 | .IP "\fBtitle:\fP \fIstring\fP" |
| 330 | Set window title string, the default title is the command-line |
353 | Set window title string, the default title is the command-line |
| 331 | specified after the \fB-e\fP option, if any, otherwise the application |
354 | specified after the \fB-e\fP option, if any, otherwise the application |
| 332 | name; |
355 | name; |
| 333 | option \fB-title\fP\&. |
356 | option \fB-title\fP\&. |
| … | |
… | |
| 504 | double quotes so that it can start or end with whitespace\&. The |
527 | double quotes so that it can start or end with whitespace\&. The |
| 505 | intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This |
528 | intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This |
| 506 | resource is only available when compiled with KEYSYM_RESOURCE\&. |
529 | resource is only available when compiled with KEYSYM_RESOURCE\&. |
| 507 | .SH "THE SCROLLBAR" |
530 | .SH "THE SCROLLBAR" |
| 508 | .PP |
531 | .PP |
| 509 | Lines of text that scroll off the top of the \fBurxvt\fP window (resource: |
532 | Lines of text that scroll off the top of the \fBrxvt\fP window (resource: |
| 510 | \fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. |
533 | \fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. |
| 511 | The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly |
534 | The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly |
| 512 | intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour |
535 | intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour |
| 513 | mimics that of \fIxterm\fP |
536 | mimics that of \fIxterm\fP |
| 514 | .PP |
537 | .PP |
| 515 | Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. |
538 | Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. |
| 516 | Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. |
539 | Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. |
| … | |
… | |
| 537 | region and release; Right click to extend the marked region; |
560 | region and release; Right click to extend the marked region; |
| 538 | Left double-click to select a word; Left triple-click to select |
561 | Left double-click to select a word; Left triple-click to select |
| 539 | the entire line\&. |
562 | the entire line\&. |
| 540 | .IP "\fBInsertion\fP:" |
563 | .IP "\fBInsertion\fP:" |
| 541 | Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) |
564 | Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) |
| 542 | in an \fBurxvt\fP window causes the current text selection to be inserted |
565 | in an \fBrxvt\fP window causes the current text selection to be inserted |
| 543 | as if it had been typed on the keyboard\&. |
566 | as if it had been typed on the keyboard\&. |
| 544 | .SH "CHANGING FONTS" |
567 | .SH "CHANGING FONTS" |
| 545 | .PP |
568 | .PP |
| 546 | You can change fonts on-the-fly, which is to say cycle through the default |
569 | You can change fonts on-the-fly, which is to say cycle through the default |
| 547 | font and others of various sizes, by using \fBShift-KP_Add\fP and |
570 | font and others of various sizes, by using \fBShift-KP_Add\fP and |
| 548 | \fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with |
571 | \fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with |
| 549 | \fBAlt->\fP and \fBAlt-<\fP, where the actual key |
572 | \fBAlt->\fP and \fBAlt-<\fP, where the actual key |
| 550 | can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. |
573 | can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. |
| 551 | .SH "LOGIN STAMP" |
574 | .SH "LOGIN STAMP" |
| 552 | .PP |
575 | .PP |
| 553 | \fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be |
576 | \fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be |
| 554 | seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this |
577 | seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this |
| 555 | feature, \fBurxvt\fP must be installed setuid root on some systems\&. |
578 | feature, \fBrxvt\fP must be installed setuid root on some systems\&. |
| 556 | .SH "COLORS AND GRAPHICS" |
579 | .SH "COLORS AND GRAPHICS" |
| 557 | .PP |
580 | .PP |
| 558 | In addition to the default foreground and background colours, \fBurxvt\fP |
581 | In addition to the default foreground and background colours, \fBrxvt\fP |
| 559 | can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
582 | can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
| 560 | versions of the same)\&. |
583 | versions of the same)\&. |
| 561 | Here is a list of the colours with their \fBrgb\&.txt\fP names\&. |
584 | Here is a list of the colours with their \fBrgb\&.txt\fP names\&. |
| 562 | .PP |
585 | .PP |
| 563 | .TS |
586 | .TS |
| … | |
… | |
| 597 | .IP "\fBrxvt -fg Black -bg White -rv\fP" |
620 | .IP "\fBrxvt -fg Black -bg White -rv\fP" |
| 598 | would yield White on Black, while on \fIxterm\fP(1) it would yield |
621 | would yield White on Black, while on \fIxterm\fP(1) it would yield |
| 599 | Black on White\&. |
622 | Black on White\&. |
| 600 | .SH "ENVIRONMENT" |
623 | .SH "ENVIRONMENT" |
| 601 | .PP |
624 | .PP |
| 602 | \fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and |
625 | \fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and |
| 603 | \fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window |
626 | \fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window |
| 604 | id number of the \fBurxvt\fP window and it also uses and sets the environment |
627 | id number of the \fBrxvt\fP window and it also uses and sets the environment |
| 605 | variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses |
628 | variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses |
| 606 | the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. |
629 | the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. |
| 607 | .SH "FILES" |
630 | .SH "FILES" |
| 608 | .PP |
631 | .PP |
| 609 | .IP "\fB/etc/utmp\fP" |
632 | .IP "\fB/etc/utmp\fP" |
| 610 | System file for login records\&. |
633 | System file for login records\&. |
| … | |
… | |
| 627 | .PP |
650 | .PP |
| 628 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
651 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
| 629 | .PP |
652 | .PP |
| 630 | .SH "FTP LOCATION" |
653 | .SH "FTP LOCATION" |
| 631 | .PP |
654 | .PP |
| 632 | rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites |
655 | rxvt-3\&.4\&.tar\&.gz can be found at the following ftp sites |
| 633 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
656 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
| 634 | .PP |
657 | .PP |
| 635 | .SH "CURRENT PROJECT COORDINATOR" |
658 | .SH "CURRENT PROJECT COORDINATOR" |
| 636 | .PP |
659 | .PP |
| 637 | .IP "Project Coordinator" |
660 | .IP "Project Coordinator" |
