| 1 | .TH "RXVT" "1" "RXVTDATE()" "X Version 11" "X Tools" |
1 | .TH "RXVT" "1" "2004-04-02" "X Version 11" "X Tools" |
| 2 | .SH "NAME" |
2 | .SH "NAME" |
| 3 | rxvt (ouR XVT) \- 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 | \fBrxvt\fP [options] [-e command [ args ]] |
| 8 | .PP |
8 | .PP |
| 9 | .SH "DESCRIPTION" |
9 | .SH "DESCRIPTION" |
| 10 | .PP |
10 | .PP |
| 11 | \fBrxvt\fP, version \fBRXVTVERSION()\fP, is a colour vt102 terminal emulator |
11 | \fBrxvt-unicode\fP, version \fB2\&.6\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\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 |
| … | |
… | |
| 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-tint\fP \fIcolour\fP" |
|
|
57 | Tint the transparent background pixmap with the given colour\&. |
| 56 | .IP "\fB-bg\fP \fIcolour\fP" |
58 | .IP "\fB-bg\fP \fIcolour\fP" |
| 57 | Window background colour; |
59 | Window background colour; |
| 58 | resource \fBbackground\fP\&. |
60 | resource \fBbackground\fP\&. |
| 59 | .IP "\fB-fg\fP \fIcolour\fP" |
61 | .IP "\fB-fg\fP \fIcolour\fP" |
| 60 | Window foreground colour; |
62 | Window foreground colour; |
| … | |
… | |
| 76 | resource \fBborderColor\fP\&. |
78 | resource \fBborderColor\fP\&. |
| 77 | .IP "\fB-fn\fP \fIfontname\fP" |
79 | .IP "\fB-fn\fP \fIfontname\fP" |
| 78 | Select the fonts to be used used\&. This is a comma seperated |
80 | Select the fonts to be used used\&. This is a comma seperated |
| 79 | list of font names that are used in turn when trying to display |
81 | list of font names that are used in turn when trying to display |
| 80 | unicode characters\&. The first font defines the cell size for characters, |
82 | unicode characters\&. The first font defines the cell size for characters, |
| 81 | pther fonts might be smaller, but not larger\&. A reasonable default list |
83 | other fonts might be smaller, but not larger\&. A reasonable default font list |
| 82 | is appended\&. |
84 | is always appended to it\&. |
| 83 | resource \fBfont\fP\&. |
85 | resource \fBfont\fP\&. |
| 84 | .IP "\fB-name\fP \fIname\fP" |
86 | .IP "\fB-name\fP \fIname\fP" |
| 85 | Specify the application name under which resources |
87 | Specify the application name under which resources |
| 86 | are to be obtained, rather than the default executable file name\&. |
88 | are to be obtained, rather than the default executable file name\&. |
| 87 | Name should not contain `\&.\&' or `*\&' characters\&. |
89 | Name should not contain `\&.\&' or `*\&' characters\&. |
| … | |
… | |
| 112 | Put scrollbar on right/left; |
114 | Put scrollbar on right/left; |
| 113 | resource \fBscrollBar_right\fP\&. |
115 | resource \fBscrollBar_right\fP\&. |
| 114 | .IP "\fB-st\fP|\fB+st\fP" |
116 | .IP "\fB-st\fP|\fB+st\fP" |
| 115 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
117 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
| 116 | resource \fBscrollBar_floating\fP\&. |
118 | resource \fBscrollBar_floating\fP\&. |
| 117 | .IP "\fB-mcc\fP|\fB+mcc\fP" |
|
|
| 118 | Compile \fImultichar_languages\fP: treat multibyte glyphs as single |
|
|
| 119 | character for backspace, delete and cursor movement keys; |
|
|
| 120 | resource \fBmultibyte_cursor\fP\&. |
|
|
| 121 | .IP "\fB-bc\fP|\fB+bc\fP" |
119 | .IP "\fB-bc\fP|\fB+bc\fP" |
| 122 | Blink the cursor; resource \fBcursorBlink\fP\&. |
120 | Blink the cursor; resource \fBcursorBlink\fP\&. |
| 123 | .IP "\fB-iconic\fP" |
121 | .IP "\fB-iconic\fP" |
| 124 | Start iconified, if the window manager supports that option\&. |
122 | Start iconified, if the window manager supports that option\&. |
| 125 | Alternative form is \fB-ic\fP\&. |
123 | Alternative form is \fB-ic\fP\&. |
| … | |
… | |
| 173 | .IP "\fB-imlocale\fP \fIstring\fP" |
171 | .IP "\fB-imlocale\fP \fIstring\fP" |
| 174 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
172 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
| 175 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
173 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
| 176 | for the input extension to be able to input japanese characters |
174 | for the input extension to be able to input japanese characters |
| 177 | while staying in another locale\&. |
175 | while staying in another locale\&. |
|
|
176 | .IP "\fB-insecure\fP" |
|
|
177 | Enable "insecure" mode, which currently enables most of the escape |
|
|
178 | sequences that echo strings\&. See the resource \fBinsecure\fP for |
|
|
179 | more info\&. |
| 178 | .IP "\fB-mod\fP \fImodifier\fP" |
180 | .IP "\fB-mod\fP \fImodifier\fP" |
| 179 | Override detection of Meta modifier with specified key: |
181 | Override detection of Meta modifier with specified key: |
| 180 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
182 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 181 | \fBmod4\fP, \fBmod5\fP; |
183 | \fBmod4\fP, \fBmod5\fP; |
| 182 | resource \fImodifier\fP\&. |
184 | resource \fImodifier\fP\&. |
|
|
185 | .IP "\fB-ssc\fP|\fB+ssc\fP" |
|
|
186 | Turn on/off secondary screen (default enabled); |
|
|
187 | resource \fBsecondaryScreen\fP\&. |
|
|
188 | .IP "\fB-ssr\fP|\fB+ssr\fP" |
|
|
189 | Turn on/off secondary screen scroll (default enabled); |
|
|
190 | resource \fBsecondaryScroll\fP\&. |
| 183 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
191 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
| 184 | No effect on rxvt\&. Simply passes through an argument to be made |
192 | No effect on rxvt\&. Simply passes through an argument to be made |
| 185 | available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP |
193 | available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP |
| 186 | in some window managers\&. |
194 | in some window managers\&. |
| 187 | .SH "RESOURCES (available also as long-options)" |
195 | .SH "RESOURCES (available also as long-options)" |
| … | |
… | |
| 253 | option \fB+j\fP\&. |
261 | option \fB+j\fP\&. |
| 254 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
262 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
| 255 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
263 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
| 256 | giving artificial transparency\&. |
264 | giving artificial transparency\&. |
| 257 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
265 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
|
|
266 | .IP "\fBtintColor\fP \fIcolour\fP" |
|
|
267 | Tint the transparent background pixmap with the given colour\&. |
| 258 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
268 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
| 259 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
269 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
| 260 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
270 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
| 261 | Use the specified colour for the scrollbar\&'s trough area [default |
271 | Use the specified colour for the scrollbar\&'s trough area [default |
| 262 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
272 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
| … | |
… | |
| 280 | \fBPATH\fP environment variables\&. |
290 | \fBPATH\fP environment variables\&. |
| 281 | .IP "\fBfont:\fP \fIfontname\fP" |
291 | .IP "\fBfont:\fP \fIfontname\fP" |
| 282 | Select the fonts to be used used\&. This is a comma seperated |
292 | Select the fonts to be used used\&. This is a comma seperated |
| 283 | list of font names that are used in turn when trying to display |
293 | list of font names that are used in turn when trying to display |
| 284 | unicode characters\&. The first font defines the cell size for characters, |
294 | unicode characters\&. The first font defines the cell size for characters, |
| 285 | pther fonts might be smaller, but not larger\&. A reasonable default list |
295 | other fonts might be smaller, but not larger\&. A reasonable default font list |
| 286 | is appended\&. |
296 | is always appended to this list\&. |
| 287 | option \fB-fn\fP\&. |
297 | option \fB-fn\fP\&. |
| 288 | .IP "\fBselectstyle:\fP \fImode\fP" |
298 | .IP "\fBselectstyle:\fP \fImode\fP" |
| 289 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
299 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
| 290 | is xterm style with 2\&.20 old word selection, or anything else which |
300 | is xterm style with 2\&.20 old word selection, or anything else which |
| 291 | gives xterm style selection\&. |
301 | gives xterm style selection\&. |
| … | |
… | |
| 401 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
411 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
| 402 | of seconds of inactivity\&. |
412 | of seconds of inactivity\&. |
| 403 | \fBFalse\fP: the pointer is always visible [default]\&. |
413 | \fBFalse\fP: the pointer is always visible [default]\&. |
| 404 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
414 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
| 405 | Specifies number of seconds before blanking the pointer [default 2]\&. |
415 | Specifies number of seconds before blanking the pointer [default 2]\&. |
| 406 | .IP "\fBmultibyte_cursor:\fP \fIboolean\fP" |
|
|
| 407 | \fBTrue\fP: consider multibyte glyphs as single character for backspace, |
|
|
| 408 | delete and cursor movement keys; |
|
|
| 409 | option \fB-mcc\fP\&. |
|
|
| 410 | \fBFalse\fP: move through all components of all glyphs; |
|
|
| 411 | option \fB+mcc\fP\&. |
|
|
| 412 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
416 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
| 413 | The string to send when the backspace key is pressed\&. If set to |
417 | The string to send when the backspace key is pressed\&. If set to |
| 414 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
418 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
| 415 | \fBBackspace\fP (code 8) - which can be reversed with the appropriate |
419 | \fBBackspace\fP (code 8) - which can be reversed with the appropriate |
| 416 | DEC private mode escape sequence\&. |
420 | DEC private mode escape sequence\&. |
| … | |
… | |
| 433 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
437 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
| 434 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
438 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
| 435 | for the input extension to be able to input japanese characters |
439 | for the input extension to be able to input japanese characters |
| 436 | while staying in another locale\&. |
440 | while staying in another locale\&. |
| 437 | option \fB-imlocale\fP\&. |
441 | option \fB-imlocale\fP\&. |
|
|
442 | .IP "\fBinsecure\fP" |
|
|
443 | Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences |
|
|
444 | that echo arbitrary strings like the icon name or the locale\&. This |
|
|
445 | could be abused if somebody gets 8-bit-clean access to your |
|
|
446 | display, wether throuh a mail client displaying mail bodies |
|
|
447 | unfiltered or though write(1)\&. Therefore, these sequences are |
|
|
448 | disabled by default\&. (Note that other terminals, including xterm, |
|
|
449 | have these sequences enabled by default)\&. You can enable them |
|
|
450 | by setting this boolean resource or specifying \fB-insecure\fP as |
|
|
451 | an option\&. At the moment, this enabled display-answer, locale, |
|
|
452 | findfont, icon label and window title requests as well as dynamic |
|
|
453 | menubar dispatch\&. |
| 438 | .IP "\fBmodifier:\fP \fImodifier\fP" |
454 | .IP "\fBmodifier:\fP \fImodifier\fP" |
| 439 | Set the key to be interpreted as the Meta key to: |
455 | Set the key to be interpreted as the Meta key to: |
| 440 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
456 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 441 | \fBmod4\fP, \fBmod5\fP; |
457 | \fBmod4\fP, \fBmod5\fP; |
| 442 | option \fB-mod\fP\&. |
458 | option \fB-mod\fP\&. |
| 443 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
459 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
| 444 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
460 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
| 445 | character is passed through\&. It may contain escape values as |
461 | character is passed through\&. It may contain escape values as |
| 446 | described in the entry on \fBkeysym\fP following\&. |
462 | described in the entry on \fBkeysym\fP following\&. |
|
|
463 | .IP "\fBsecondaryScreen:\fP \fIbool\fP" |
|
|
464 | Turn on/off secondary screen (default enabled)\&. |
|
|
465 | .IP "\fBsecondaryScroll:\fP \fIbool\fP" |
|
|
466 | Turn on/off secondary screen scroll (default enabled)\&. If |
|
|
467 | the this option is enabled, scrolls on the secondary screen will |
|
|
468 | change the scrollback buffer and switching to/from the secondary screen |
|
|
469 | will instead scroll the screen up\&. |
| 447 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
470 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
| 448 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
471 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
| 449 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
472 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
| 450 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
473 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
| 451 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
474 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
| … | |
… | |
| 573 | .PP |
596 | .PP |
| 574 | Cursor change support is not yet implemented\&. |
597 | Cursor change support is not yet implemented\&. |
| 575 | .PP |
598 | .PP |
| 576 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
599 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
| 577 | .PP |
600 | .PP |
| 578 | Graphics support is fairly crude\&. |
|
|
| 579 | .PP |
|
|
| 580 | .SH "FTP LOCATION" |
601 | .SH "FTP LOCATION" |
| 581 | .PP |
602 | .PP |
| 582 | rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites |
603 | rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites |
| 583 | RXVTFTPSITE() |
604 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
| 584 | .PP |
605 | .PP |
| 585 | .SH "CURRENT PROJECT COORDINATOR" |
606 | .SH "CURRENT PROJECT COORDINATOR" |
| 586 | .PP |
607 | .PP |
| 587 | .IP "Project Coordinator" |
608 | .IP "Project Coordinator" |
| 588 | RXVTMAINT() RXVTMAINTEMAIL() |
609 | Marc A\&. Lehmann <rxvt@schmorp\&.de> |
| 589 | .br |
610 | .br |
| 590 | .IP "Web page maintainter" |
611 | .IP "Web page maintainter" |
| 591 | RXVTWEBMAINT() RXVTWEBMAINTEMAIL() |
612 | Marc A\&. Lehmann <rxvt@schmorp\&.de> |
| 592 | .br |
613 | .br |
| 593 | RXVTWEBPAGE() |
614 | <http://www\&.sourceforge\&.net/projects/rxvt-unicode/> |
| 594 | .br |
615 | .br |
| 595 | .IP "Mailing list" |
|
|
| 596 | The Rxvt Workers <rxvt-workers@rxvt\&.org> |
|
|
| 597 | mailing list has also been established for rxvt development, to |
|
|
| 598 | subscribe, email to |
|
|
| 599 | <rxvt-workers-subscribe@rxvt\&.org>\&. |
|
|
| 600 | There is also a mailing list for announcements of new releases of |
|
|
| 601 | rxvt\&. To subscribe, email to |
|
|
| 602 | <rxvt-announce-subscribe@rxvt\&.org>\&. |
|
|
| 603 | .PP |
616 | .PP |
| 604 | .SH "AUTHORS" |
617 | .SH "AUTHORS" |
| 605 | .PP |
618 | .PP |
| 606 | .IP "John Bovey" |
619 | .IP "John Bovey" |
| 607 | University of Kent, 1992, wrote the original Xvt\&. |
620 | University of Kent, 1992, wrote the original Xvt\&. |
