| 1 | .TH "RXVT" "1" "RXVTDATE()" "X Version 11" "X Tools" |
1 | .TH "RXVT" "1" "2004-03-28" "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-grk\fP \fImode\fP" |
|
|
| 85 | Compile \fIGreek\fP: Greek keyboard translation; |
|
|
| 86 | \fBiso\fP: ISO-8859 mapping\&. |
|
|
| 87 | \fBibm\fP: IBM-437 mapping; |
|
|
| 88 | resource \fBgreek_keyboard\fP\&. |
|
|
| 89 | .IP "\fB-name\fP \fIname\fP" |
86 | .IP "\fB-name\fP \fIname\fP" |
| 90 | Specify the application name under which resources |
87 | Specify the application name under which resources |
| 91 | are to be obtained, rather than the default executable file name\&. |
88 | are to be obtained, rather than the default executable file name\&. |
| 92 | Name should not contain `\&.\&' or `*\&' characters\&. |
89 | Name should not contain `\&.\&' or `*\&' characters\&. |
| 93 | Also sets the icon and title name\&. |
90 | Also sets the icon and title name\&. |
| … | |
… | |
| 117 | Put scrollbar on right/left; |
114 | Put scrollbar on right/left; |
| 118 | resource \fBscrollBar_right\fP\&. |
115 | resource \fBscrollBar_right\fP\&. |
| 119 | .IP "\fB-st\fP|\fB+st\fP" |
116 | .IP "\fB-st\fP|\fB+st\fP" |
| 120 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
117 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
| 121 | resource \fBscrollBar_floating\fP\&. |
118 | resource \fBscrollBar_floating\fP\&. |
| 122 | .IP "\fB-mcc\fP|\fB+mcc\fP" |
|
|
| 123 | Compile \fImultichar_languages\fP: treat multibyte glyphs as single |
|
|
| 124 | character for backspace, delete and cursor movement keys; |
|
|
| 125 | resource \fBmultibyte_cursor\fP\&. |
|
|
| 126 | .IP "\fB-bc\fP|\fB+bc\fP" |
119 | .IP "\fB-bc\fP|\fB+bc\fP" |
| 127 | Blink the cursor; resource \fBcursorBlink\fP\&. |
120 | Blink the cursor; resource \fBcursorBlink\fP\&. |
| 128 | .IP "\fB-iconic\fP" |
121 | .IP "\fB-iconic\fP" |
| 129 | Start iconified, if the window manager supports that option\&. |
122 | Start iconified, if the window manager supports that option\&. |
| 130 | Alternative form is \fB-ic\fP\&. |
123 | Alternative form is \fB-ic\fP\&. |
| … | |
… | |
| 178 | .IP "\fB-imlocale\fP \fIstring\fP" |
171 | .IP "\fB-imlocale\fP \fIstring\fP" |
| 179 | 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 |
| 180 | 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 |
| 181 | for the input extension to be able to input japanese characters |
174 | for the input extension to be able to input japanese characters |
| 182 | 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\&. |
| 183 | .IP "\fB-mod\fP \fImodifier\fP" |
180 | .IP "\fB-mod\fP \fImodifier\fP" |
| 184 | Override detection of Meta modifier with specified key: |
181 | Override detection of Meta modifier with specified key: |
| 185 | \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, |
| 186 | \fBmod4\fP, \fBmod5\fP; |
183 | \fBmod4\fP, \fBmod5\fP; |
| 187 | resource \fImodifier\fP\&. |
184 | resource \fImodifier\fP\&. |
| … | |
… | |
| 258 | option \fB+j\fP\&. |
255 | option \fB+j\fP\&. |
| 259 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
256 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
| 260 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
257 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
| 261 | giving artificial transparency\&. |
258 | giving artificial transparency\&. |
| 262 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
259 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
|
|
260 | .IP "\fBtintColor\fP \fIcolour\fP" |
|
|
261 | Tint the transparent background pixmap with the given colour\&. |
| 263 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
262 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
| 264 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
263 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
| 265 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
264 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
| 266 | Use the specified colour for the scrollbar\&'s trough area [default |
265 | Use the specified colour for the scrollbar\&'s trough area [default |
| 267 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
266 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
| … | |
… | |
| 285 | \fBPATH\fP environment variables\&. |
284 | \fBPATH\fP environment variables\&. |
| 286 | .IP "\fBfont:\fP \fIfontname\fP" |
285 | .IP "\fBfont:\fP \fIfontname\fP" |
| 287 | Select the fonts to be used used\&. This is a comma seperated |
286 | Select the fonts to be used used\&. This is a comma seperated |
| 288 | list of font names that are used in turn when trying to display |
287 | list of font names that are used in turn when trying to display |
| 289 | unicode characters\&. The first font defines the cell size for characters, |
288 | unicode characters\&. The first font defines the cell size for characters, |
| 290 | pther fonts might be smaller, but not larger\&. A reasonable default list |
289 | other fonts might be smaller, but not larger\&. A reasonable default font list |
| 291 | is appended\&. |
290 | is always appended to this list\&. |
| 292 | option \fB-fn\fP\&. |
291 | option \fB-fn\fP\&. |
| 293 | .IP "\fBgreek_keyboard:\fP \fImode\fP" |
|
|
| 294 | Set the Greek keyboard translation mode to be used; |
|
|
| 295 | \fBiso\fP: ISO-8859 mapping (elot-928) [default]\&. |
|
|
| 296 | \fBibm\fP: IBM-437 mapping (DOS codepage 737); |
|
|
| 297 | option \fB-grk\fP\&. |
|
|
| 298 | .IP "\fBgreektoggle_key:\fP \fIkeysym\fP" |
|
|
| 299 | Set the key to toggle keyboard input between no translation and |
|
|
| 300 | Greek translation [default \fBMode_switch\fP]\&. |
|
|
| 301 | For more details, see the distributed file \fBREADME\&.greek\fP\&. |
|
|
| 302 | .IP "\fBselectstyle:\fP \fImode\fP" |
292 | .IP "\fBselectstyle:\fP \fImode\fP" |
| 303 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
293 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
| 304 | is xterm style with 2\&.20 old word selection, or anything else which |
294 | is xterm style with 2\&.20 old word selection, or anything else which |
| 305 | gives xterm style selection\&. |
295 | gives xterm style selection\&. |
| 306 | .IP "\fBscrollstyle:\fP \fImode\fP" |
296 | .IP "\fBscrollstyle:\fP \fImode\fP" |
| … | |
… | |
| 415 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
405 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
| 416 | of seconds of inactivity\&. |
406 | of seconds of inactivity\&. |
| 417 | \fBFalse\fP: the pointer is always visible [default]\&. |
407 | \fBFalse\fP: the pointer is always visible [default]\&. |
| 418 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
408 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
| 419 | Specifies number of seconds before blanking the pointer [default 2]\&. |
409 | Specifies number of seconds before blanking the pointer [default 2]\&. |
| 420 | .IP "\fBmultibyte_cursor:\fP \fIboolean\fP" |
|
|
| 421 | \fBTrue\fP: consider multibyte glyphs as single character for backspace, |
|
|
| 422 | delete and cursor movement keys; |
|
|
| 423 | option \fB-mcc\fP\&. |
|
|
| 424 | \fBFalse\fP: move through all components of all glyphs; |
|
|
| 425 | option \fB+mcc\fP\&. |
|
|
| 426 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
410 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
| 427 | The string to send when the backspace key is pressed\&. If set to |
411 | The string to send when the backspace key is pressed\&. If set to |
| 428 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
412 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
| 429 | \fBBackspace\fP (code 8) - which can be reversed with the appropriate |
413 | \fBBackspace\fP (code 8) - which can be reversed with the appropriate |
| 430 | DEC private mode escape sequence\&. |
414 | DEC private mode escape sequence\&. |
| … | |
… | |
| 447 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
431 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
| 448 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
432 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
| 449 | for the input extension to be able to input japanese characters |
433 | for the input extension to be able to input japanese characters |
| 450 | while staying in another locale\&. |
434 | while staying in another locale\&. |
| 451 | option \fB-imlocale\fP\&. |
435 | option \fB-imlocale\fP\&. |
|
|
436 | .IP "\fBinsecure\fP" |
|
|
437 | Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences |
|
|
438 | that echo arbitrary strings like the icon name or the locale\&. This |
|
|
439 | could be abused if somebody gets 8-bit-clean access to your display, |
|
|
440 | wether throuh a mail client displaying mail bodies unfiltered or |
|
|
441 | though write(1)\&. Therefore, these sequences are disabled by default\&. |
|
|
442 | You can enable them by setting this boolean resource or specifying |
|
|
443 | \fB-insecure\fP as an option\&. At the moment, this enabled display-answer, |
|
|
444 | locale, findfont, icon label and window title requests as well as |
|
|
445 | dynamic menubar dispatch\&. |
| 452 | .IP "\fBmodifier:\fP \fImodifier\fP" |
446 | .IP "\fBmodifier:\fP \fImodifier\fP" |
| 453 | Set the key to be interpreted as the Meta key to: |
447 | Set the key to be interpreted as the Meta key to: |
| 454 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
448 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 455 | \fBmod4\fP, \fBmod5\fP; |
449 | \fBmod4\fP, \fBmod5\fP; |
| 456 | option \fB-mod\fP\&. |
450 | option \fB-mod\fP\&. |
| … | |
… | |
| 514 | .PP |
508 | .PP |
| 515 | \fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be |
509 | \fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be |
| 516 | seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this |
510 | seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this |
| 517 | feature, \fBrxvt\fP must be installed setuid root on some systems\&. |
511 | feature, \fBrxvt\fP must be installed setuid root on some systems\&. |
| 518 | .SH "COLORS AND GRAPHICS" |
512 | .SH "COLORS AND GRAPHICS" |
| 519 | .PP |
|
|
| 520 | If graphics support was enabled at compile-time, \fBrxvt\fP can be queried |
|
|
| 521 | with ANSI escape sequences and can address individual pixels instead of |
|
|
| 522 | text characters\&. Note the graphics support is still considered beta code\&. |
|
|
| 523 | .PP |
513 | .PP |
| 524 | In addition to the default foreground and background colours, \fBrxvt\fP |
514 | In addition to the default foreground and background colours, \fBrxvt\fP |
| 525 | can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
515 | can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
| 526 | versions of the same)\&. |
516 | versions of the same)\&. |
| 527 | Here is a list of the colours with their \fBrgb\&.txt\fP names\&. |
517 | Here is a list of the colours with their \fBrgb\&.txt\fP names\&. |
| … | |
… | |
| 591 | .PP |
581 | .PP |
| 592 | Cursor change support is not yet implemented\&. |
582 | Cursor change support is not yet implemented\&. |
| 593 | .PP |
583 | .PP |
| 594 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
584 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
| 595 | .PP |
585 | .PP |
| 596 | Graphics support is fairly crude\&. |
|
|
| 597 | .PP |
|
|
| 598 | .SH "FTP LOCATION" |
586 | .SH "FTP LOCATION" |
| 599 | .PP |
587 | .PP |
| 600 | rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites |
588 | rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites |
| 601 | RXVTFTPSITE() |
589 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
| 602 | .PP |
590 | .PP |
| 603 | .SH "CURRENT PROJECT COORDINATOR" |
591 | .SH "CURRENT PROJECT COORDINATOR" |
| 604 | .PP |
592 | .PP |
| 605 | .IP "Project Coordinator" |
593 | .IP "Project Coordinator" |
| 606 | RXVTMAINT() RXVTMAINTEMAIL() |
594 | Marc A\&. Lehmann <rxvt@schmorp\&.de> |
| 607 | .br |
595 | .br |
| 608 | .IP "Web page maintainter" |
596 | .IP "Web page maintainter" |
| 609 | RXVTWEBMAINT() RXVTWEBMAINTEMAIL() |
597 | Marc A\&. Lehmann <rxvt@schmorp\&.de> |
| 610 | .br |
598 | .br |
| 611 | RXVTWEBPAGE() |
599 | <http://www\&.sourceforge\&.net/projects/rxvt-unicode/> |
| 612 | .br |
600 | .br |
| 613 | .IP "Mailing list" |
|
|
| 614 | The Rxvt Workers <rxvt-workers@rxvt\&.org> |
|
|
| 615 | mailing list has also been established for rxvt development, to |
|
|
| 616 | subscribe, email to |
|
|
| 617 | <rxvt-workers-subscribe@rxvt\&.org>\&. |
|
|
| 618 | There is also a mailing list for announcements of new releases of |
|
|
| 619 | rxvt\&. To subscribe, email to |
|
|
| 620 | <rxvt-announce-subscribe@rxvt\&.org>\&. |
|
|
| 621 | .PP |
601 | .PP |
| 622 | .SH "AUTHORS" |
602 | .SH "AUTHORS" |
| 623 | .PP |
603 | .PP |
| 624 | .IP "John Bovey" |
604 | .IP "John Bovey" |
| 625 | University of Kent, 1992, wrote the original Xvt\&. |
605 | University of Kent, 1992, wrote the original Xvt\&. |
| 626 | .IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" |
606 | .IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" |
| 627 | very heavily modified Xvt and came up with Rxvt |
607 | very heavily modified Xvt and came up with Rxvt |
| 628 | .IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" |
608 | .IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" |
| 629 | wrote the Greek Keyboard Input |
609 | wrote the Greek Keyboard Input (no longer in code) |
| 630 | .IP "mj olesen <olesen@me\&.QueensU\&.CA>" |
610 | .IP "mj olesen <olesen@me\&.QueensU\&.CA>" |
| 631 | Wrote the menu system\&. |
611 | Wrote the menu system\&. |
| 632 | .br |
612 | .br |
| 633 | Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) |
613 | Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) |
| 634 | .IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" |
614 | .IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" |
| 635 | Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) |
615 | Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) |
| 636 | .IP "Geoff Wing <gcw@pobox\&.com>" |
616 | .IP "Geoff Wing <gcw@pobox\&.com>" |
| 637 | Rewrote screen display and text selection routines\&. |
617 | Rewrote screen display and text selection routines\&. |
|
|
618 | Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) |
|
|
619 | .IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" |
|
|
620 | Rewrote most of the display code and internal character handling |
|
|
621 | to store text in unicode\&. Numerous other fixes and extensions\&. |
| 638 | .br |
622 | .br |
| 639 | Project Coordinator (changes\&.txt 2\&.4\&.6 - ) |
623 | Project Coordinator (Changes 1\&.0 - ) |
|
|
624 | .PP |
