| 1 | .TH "RXVT" "1" "2004-03-14" "X Version 11" "X Tools" |
1 | .TH "RXVT" "1" "2004-05-10" "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 | \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 \fB2\&.4\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 |
| 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 |
| … | |
… | |
| 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; |
| … | |
… | |
| 67 | resource \fBbackgroundPixmap\fP\&. |
69 | resource \fBbackgroundPixmap\fP\&. |
| 68 | .IP "\fB-cr\fP \fIcolour\fP" |
70 | .IP "\fB-cr\fP \fIcolour\fP" |
| 69 | The cursor colour; |
71 | The cursor colour; |
| 70 | resource \fBcursorColor\fP\&. |
72 | resource \fBcursorColor\fP\&. |
| 71 | .IP "\fB-pr\fP \fIcolour\fP" |
73 | .IP "\fB-pr\fP \fIcolour\fP" |
| 72 | The mouse pointer colour; |
74 | The mouse pointer foreground colour; |
| 73 | resource \fBpointerColor\fP\&. |
75 | resource \fBpointerColor\fP\&. |
|
|
76 | .IP "\fB-pr2\fP \fIcolour\fP" |
|
|
77 | The mouse pointer background colour; |
|
|
78 | resource \fBpointerColor2\fP\&. |
| 74 | .IP "\fB-bd\fP \fIcolour\fP" |
79 | .IP "\fB-bd\fP \fIcolour\fP" |
| 75 | 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; |
| 76 | resource \fBborderColor\fP\&. |
81 | resource \fBborderColor\fP\&. |
| 77 | .IP "\fB-fn\fP \fIfontname\fP" |
82 | .IP "\fB-fn\fP \fIfontname\fP" |
| 78 | Select the fonts to be used used\&. This is a comma seperated |
83 | 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 |
84 | 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, |
85 | unicode characters\&. The first font defines the cell size for characters, |
| 81 | pther fonts might be smaller, but not larger\&. A reasonable default list |
86 | other fonts might be smaller, but not larger\&. A reasonable default font list |
| 82 | is appended\&. |
87 | is always appended to it\&. |
| 83 | resource \fBfont\fP\&. |
88 | resource \fBfont\fP\&. |
| 84 | .IP "\fB-name\fP \fIname\fP" |
89 | .IP "\fB-name\fP \fIname\fP" |
| 85 | Specify the application name under which resources |
90 | Specify the application name under which resources |
| 86 | are to be obtained, rather than the default executable file name\&. |
91 | are to be obtained, rather than the default executable file name\&. |
| 87 | Name should not contain `\&.\&' or `*\&' characters\&. |
92 | Name should not contain `\&.\&' or `*\&' characters\&. |
| … | |
… | |
| 169 | .IP "\fB-imlocale\fP \fIstring\fP" |
174 | .IP "\fB-imlocale\fP \fIstring\fP" |
| 170 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
175 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
| 171 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
176 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
| 172 | for the input extension to be able to input japanese characters |
177 | for the input extension to be able to input japanese characters |
| 173 | while staying in another locale\&. |
178 | while staying in another locale\&. |
|
|
179 | .IP "\fB-insecure\fP" |
|
|
180 | Enable "insecure" mode, which currently enables most of the escape |
|
|
181 | sequences that echo strings\&. See the resource \fBinsecure\fP for |
|
|
182 | more info\&. |
| 174 | .IP "\fB-mod\fP \fImodifier\fP" |
183 | .IP "\fB-mod\fP \fImodifier\fP" |
| 175 | Override detection of Meta modifier with specified key: |
184 | Override detection of Meta modifier with specified key: |
| 176 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
185 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 177 | \fBmod4\fP, \fBmod5\fP; |
186 | \fBmod4\fP, \fBmod5\fP; |
| 178 | resource \fImodifier\fP\&. |
187 | resource \fImodifier\fP\&. |
|
|
188 | .IP "\fB-ssc\fP|\fB+ssc\fP" |
|
|
189 | Turn on/off secondary screen (default enabled); |
|
|
190 | resource \fBsecondaryScreen\fP\&. |
|
|
191 | .IP "\fB-ssr\fP|\fB+ssr\fP" |
|
|
192 | Turn on/off secondary screen scroll (default enabled); |
|
|
193 | resource \fBsecondaryScroll\fP\&. |
| 179 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
194 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
| 180 | No effect on rxvt\&. Simply passes through an argument to be made |
195 | No effect on rxvt\&. Simply passes through an argument to be made |
| 181 | available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP |
196 | available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP |
| 182 | in some window managers\&. |
197 | in some window managers\&. |
| 183 | .SH "RESOURCES (available also as long-options)" |
198 | .SH "RESOURCES (available also as long-options)" |
| … | |
… | |
| 249 | option \fB+j\fP\&. |
264 | option \fB+j\fP\&. |
| 250 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
265 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
| 251 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
266 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
| 252 | giving artificial transparency\&. |
267 | giving artificial transparency\&. |
| 253 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
268 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
|
|
269 | .IP "\fBtintColor\fP \fIcolour\fP" |
|
|
270 | Tint the transparent background pixmap with the given colour\&. |
| 254 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
271 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
| 255 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
272 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
| 256 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
273 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
| 257 | Use the specified colour for the scrollbar\&'s trough area [default |
274 | Use the specified colour for the scrollbar\&'s trough area [default |
| 258 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
275 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
| … | |
… | |
| 276 | \fBPATH\fP environment variables\&. |
293 | \fBPATH\fP environment variables\&. |
| 277 | .IP "\fBfont:\fP \fIfontname\fP" |
294 | .IP "\fBfont:\fP \fIfontname\fP" |
| 278 | Select the fonts to be used used\&. This is a comma seperated |
295 | Select the fonts to be used used\&. This is a comma seperated |
| 279 | list of font names that are used in turn when trying to display |
296 | list of font names that are used in turn when trying to display |
| 280 | unicode characters\&. The first font defines the cell size for characters, |
297 | unicode characters\&. The first font defines the cell size for characters, |
| 281 | pther fonts might be smaller, but not larger\&. A reasonable default list |
298 | other fonts might be smaller, but not larger\&. A reasonable default font list |
| 282 | is appended\&. |
299 | is always appended to this list\&. |
| 283 | option \fB-fn\fP\&. |
300 | option \fB-fn\fP\&. |
| 284 | .IP "\fBselectstyle:\fP \fImode\fP" |
301 | .IP "\fBselectstyle:\fP \fImode\fP" |
| 285 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
302 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
| 286 | is xterm style with 2\&.20 old word selection, or anything else which |
303 | is xterm style with 2\&.20 old word selection, or anything else which |
| 287 | gives xterm style selection\&. |
304 | gives xterm style selection\&. |
| 288 | .IP "\fBscrollstyle:\fP \fImode\fP" |
305 | .IP "\fBscrollstyle:\fP \fImode\fP" |
| 289 | Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP |
306 | Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP |
| 290 | .IP "\fBtitle:\fP \fIstring\fP" |
307 | .IP "\fBtitle:\fP \fIstring\fP" |
| 291 | Set window title string, the default title is the command-line |
308 | Set window title string, the default title is the command-line |
| 292 | specified after the \fB-e\fP option, if any, otherwise the application |
309 | specified after the \fB-e\fP option, if any, otherwise the application |
| 293 | name; |
310 | name; |
| 294 | option \fB-title\fP\&. |
311 | option \fB-title\fP\&. |
| … | |
… | |
| 395 | option \fB-bc\fP\&. |
412 | option \fB-bc\fP\&. |
| 396 | .IP "\fBpointerBlank:\fP \fIboolean\fP" |
413 | .IP "\fBpointerBlank:\fP \fIboolean\fP" |
| 397 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
414 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
| 398 | of seconds of inactivity\&. |
415 | of seconds of inactivity\&. |
| 399 | \fBFalse\fP: the pointer is always visible [default]\&. |
416 | \fBFalse\fP: the pointer is always visible [default]\&. |
|
|
417 | .IP "\fBpointerColor:\fP \fIcolour\fP" |
|
|
418 | Mouse pointer foreground colour\&. |
|
|
419 | .IP "\fBpointerColor2:\fP \fIcolour\fP" |
|
|
420 | Mouse pointer background colour\&. |
| 400 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
421 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
| 401 | Specifies number of seconds before blanking the pointer [default 2]\&. |
422 | Specifies number of seconds before blanking the pointer [default 2]\&. |
| 402 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
423 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
| 403 | The string to send when the backspace key is pressed\&. If set to |
424 | The string to send when the backspace key is pressed\&. If set to |
| 404 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
425 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
| … | |
… | |
| 423 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
444 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
| 424 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
445 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
| 425 | for the input extension to be able to input japanese characters |
446 | for the input extension to be able to input japanese characters |
| 426 | while staying in another locale\&. |
447 | while staying in another locale\&. |
| 427 | option \fB-imlocale\fP\&. |
448 | option \fB-imlocale\fP\&. |
|
|
449 | .IP "\fBinsecure\fP" |
|
|
450 | Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences |
|
|
451 | that echo arbitrary strings like the icon name or the locale\&. This |
|
|
452 | could be abused if somebody gets 8-bit-clean access to your |
|
|
453 | display, wether throuh a mail client displaying mail bodies |
|
|
454 | unfiltered or though write(1)\&. Therefore, these sequences are |
|
|
455 | disabled by default\&. (Note that other terminals, including xterm, |
|
|
456 | have these sequences enabled by default)\&. You can enable them |
|
|
457 | by setting this boolean resource or specifying \fB-insecure\fP as |
|
|
458 | an option\&. At the moment, this enabled display-answer, locale, |
|
|
459 | findfont, icon label and window title requests as well as dynamic |
|
|
460 | menubar dispatch\&. |
| 428 | .IP "\fBmodifier:\fP \fImodifier\fP" |
461 | .IP "\fBmodifier:\fP \fImodifier\fP" |
| 429 | Set the key to be interpreted as the Meta key to: |
462 | Set the key to be interpreted as the Meta key to: |
| 430 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
463 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 431 | \fBmod4\fP, \fBmod5\fP; |
464 | \fBmod4\fP, \fBmod5\fP; |
| 432 | option \fB-mod\fP\&. |
465 | option \fB-mod\fP\&. |
| 433 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
466 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
| 434 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
467 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
| 435 | character is passed through\&. It may contain escape values as |
468 | character is passed through\&. It may contain escape values as |
| 436 | described in the entry on \fBkeysym\fP following\&. |
469 | described in the entry on \fBkeysym\fP following\&. |
|
|
470 | .IP "\fBsecondaryScreen:\fP \fIbool\fP" |
|
|
471 | Turn on/off secondary screen (default enabled)\&. |
|
|
472 | .IP "\fBsecondaryScroll:\fP \fIbool\fP" |
|
|
473 | Turn on/off secondary screen scroll (default enabled)\&. If |
|
|
474 | the this option is enabled, scrolls on the secondary screen will |
|
|
475 | change the scrollback buffer and switching to/from the secondary screen |
|
|
476 | will instead scroll the screen up\&. |
| 437 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
477 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
| 438 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
478 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
| 439 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
479 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
| 440 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
480 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
| 441 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
481 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
| … | |
… | |
| 565 | .PP |
605 | .PP |
| 566 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
606 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
| 567 | .PP |
607 | .PP |
| 568 | .SH "FTP LOCATION" |
608 | .SH "FTP LOCATION" |
| 569 | .PP |
609 | .PP |
| 570 | rxvt-2\&.4\&.tar\&.gz can be found at the following ftp sites |
610 | rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites |
| 571 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
611 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
| 572 | .PP |
612 | .PP |
| 573 | .SH "CURRENT PROJECT COORDINATOR" |
613 | .SH "CURRENT PROJECT COORDINATOR" |
| 574 | .PP |
614 | .PP |
| 575 | .IP "Project Coordinator" |
615 | .IP "Project Coordinator" |
| … | |
… | |
| 596 | .IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" |
636 | .IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" |
| 597 | Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) |
637 | Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) |
| 598 | .IP "Geoff Wing <gcw@pobox\&.com>" |
638 | .IP "Geoff Wing <gcw@pobox\&.com>" |
| 599 | Rewrote screen display and text selection routines\&. |
639 | Rewrote screen display and text selection routines\&. |
| 600 | Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) |
640 | Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) |
| 601 | .IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" |
641 | .IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>" |
| 602 | Rewrote most of the display code and internal character handling |
642 | Forked rxvt-unicode, rewrote most of the display code and |
| 603 | to store text in unicode\&. Numerous other fixes and extensions\&. |
643 | internal character handling to store text in unicode, |
|
|
644 | improve xterm compatibility and apply numerous other bugfixes |
|
|
645 | and extensions\&. |
| 604 | .br |
646 | .br |
| 605 | Project Coordinator (Changes 1\&.0 - ) |
647 | Project Coordinator (Changes 1\&.0 - ) |
| 606 | .PP |
648 | .PP |
