1 | .TH "RXVT" "1" "2004-03-28" "X Version 11" "X Tools" |
1 | .TH "RXVT" "1" "2004-07-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 | \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\&.5\fP, is a colour vt102 terminal emulator |
11 | \fBrxvt-unicode\fP, version \fB3\&.3\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\&. |
79 | 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 |
80 | unicode characters\&. The first font defines the cell size for characters, |
85 | trying to display Unicode characters\&. |
81 | 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 |
82 | is always appended to it\&. |
87 | be smaller, but not larger\&. |
|
|
88 | A reasonable default font list is always appended to it\&. |
83 | 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\&. |
84 | .IP "\fB-name\fP \fIname\fP" |
98 | .IP "\fB-name\fP \fIname\fP" |
85 | Specify the application name under which resources |
99 | Specify the application name under which resources |
86 | are to be obtained, rather than the default executable file name\&. |
100 | are to be obtained, rather than the default executable file name\&. |
87 | Name should not contain `\&.\&' or `*\&' characters\&. |
101 | Name should not contain `\&.\&' or `*\&' characters\&. |
88 | Also sets the icon and title name\&. |
102 | Also sets the icon and title name\&. |
… | |
… | |
178 | .IP "\fB-mod\fP \fImodifier\fP" |
192 | .IP "\fB-mod\fP \fImodifier\fP" |
179 | Override detection of Meta modifier with specified key: |
193 | Override detection of Meta modifier with specified key: |
180 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
194 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
181 | \fBmod4\fP, \fBmod5\fP; |
195 | \fBmod4\fP, \fBmod5\fP; |
182 | resource \fImodifier\fP\&. |
196 | resource \fImodifier\fP\&. |
|
|
197 | .IP "\fB-ssc\fP|\fB+ssc\fP" |
|
|
198 | Turn on/off secondary screen (default enabled); |
|
|
199 | resource \fBsecondaryScreen\fP\&. |
|
|
200 | .IP "\fB-ssr\fP|\fB+ssr\fP" |
|
|
201 | Turn on/off secondary screen scroll (default enabled); |
|
|
202 | resource \fBsecondaryScroll\fP\&. |
183 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
203 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
184 | No effect on rxvt\&. Simply passes through an argument to be made |
204 | 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 |
205 | available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP |
186 | in some window managers\&. |
206 | in some window managers\&. |
187 | .SH "RESOURCES (available also as long-options)" |
207 | .SH "RESOURCES (available also as long-options)" |
… | |
… | |
223 | but the actual colour names used are listed in the |
243 | but the actual colour names used are listed in the |
224 | \fBCOLORS AND GRAPHICS\fP section\&. |
244 | \fBCOLORS AND GRAPHICS\fP section\&. |
225 | .IP "\fBcolorBD:\fP \fIcolour\fP" |
245 | .IP "\fBcolorBD:\fP \fIcolour\fP" |
226 | Use the specified colour to display bold characters when the |
246 | Use the specified colour to display bold characters when the |
227 | foreground colour is the default\&. |
247 | foreground colour is the default\&. |
|
|
248 | This option will be ignored if \fBrealBold\fP is enabled\&. |
228 | .IP "\fBcolorUL:\fP \fIcolour\fP" |
249 | .IP "\fBcolorUL:\fP \fIcolour\fP" |
229 | Use the specified colour to display underlined characters when the |
250 | Use the specified colour to display underlined characters when the |
230 | foreground colour is the default\&. |
251 | foreground colour is the default\&. |
231 | .IP "\fBcolorRV:\fP \fIcolour\fP" |
252 | .IP "\fBcolorRV:\fP \fIcolour\fP" |
232 | Use the specified colour as the background for reverse video |
253 | Use the specified colour as the background for reverse video |
… | |
… | |
253 | option \fB+j\fP\&. |
274 | option \fB+j\fP\&. |
254 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
275 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
255 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
276 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
256 | giving artificial transparency\&. |
277 | giving artificial transparency\&. |
257 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
278 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
|
|
279 | .IP "\fBtintColor:\fP \fIcolour\fP" |
|
|
280 | Tint the transparent background pixmap with the given colour\&. |
258 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
281 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
259 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
282 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
260 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
283 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
261 | Use the specified colour for the scrollbar\&'s trough area [default |
284 | Use the specified colour for the scrollbar\&'s trough area [default |
262 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
285 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
… | |
… | |
277 | .IP "\fBpath:\fP \fIpath\fP" |
300 | .IP "\fBpath:\fP \fIpath\fP" |
278 | Specify the colon-delimited search path for finding files (XPM and |
301 | Specify the colon-delimited search path for finding files (XPM and |
279 | 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 |
280 | \fBPATH\fP environment variables\&. |
303 | \fBPATH\fP environment variables\&. |
281 | .IP "\fBfont:\fP \fIfontname\fP" |
304 | .IP "\fBfont:\fP \fIfontname\fP" |
282 | Select the fonts to be used used\&. This is a comma seperated |
305 | Select the fonts to be used\&. |
283 | 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 |
284 | unicode characters\&. The first font defines the cell size for characters, |
307 | trying to display Unicode characters\&. |
285 | 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 |
286 | is always appended to this list\&. |
309 | be smaller, but not larger\&. |
|
|
310 | A reasonable default font list is always appended to it\&. |
287 | 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\&. |
288 | .IP "\fBselectstyle:\fP \fImode\fP" |
323 | .IP "\fBselectstyle:\fP \fImode\fP" |
289 | 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 |
290 | 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 |
291 | gives xterm style selection\&. |
326 | gives xterm style selection\&. |
292 | .IP "\fBscrollstyle:\fP \fImode\fP" |
327 | .IP "\fBscrollstyle:\fP \fImode\fP" |
293 | Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP |
328 | Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP |
294 | .IP "\fBtitle:\fP \fIstring\fP" |
329 | .IP "\fBtitle:\fP \fIstring\fP" |
295 | Set window title string, the default title is the command-line |
330 | Set window title string, the default title is the command-line |
296 | 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 |
297 | name; |
332 | name; |
298 | option \fB-title\fP\&. |
333 | option \fB-title\fP\&. |
… | |
… | |
399 | option \fB-bc\fP\&. |
434 | option \fB-bc\fP\&. |
400 | .IP "\fBpointerBlank:\fP \fIboolean\fP" |
435 | .IP "\fBpointerBlank:\fP \fIboolean\fP" |
401 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
436 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
402 | of seconds of inactivity\&. |
437 | of seconds of inactivity\&. |
403 | \fBFalse\fP: the pointer is always visible [default]\&. |
438 | \fBFalse\fP: the pointer is always visible [default]\&. |
|
|
439 | .IP "\fBpointerColor:\fP \fIcolour\fP" |
|
|
440 | Mouse pointer foreground colour\&. |
|
|
441 | .IP "\fBpointerColor2:\fP \fIcolour\fP" |
|
|
442 | Mouse pointer background colour\&. |
404 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
443 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
405 | Specifies number of seconds before blanking the pointer [default 2]\&. |
444 | Specifies number of seconds before blanking the pointer [default 2]\&. |
406 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
445 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
407 | The string to send when the backspace key is pressed\&. If set to |
446 | The string to send when the backspace key is pressed\&. If set to |
408 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
447 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
… | |
… | |
430 | while staying in another locale\&. |
469 | while staying in another locale\&. |
431 | option \fB-imlocale\fP\&. |
470 | option \fB-imlocale\fP\&. |
432 | .IP "\fBinsecure\fP" |
471 | .IP "\fBinsecure\fP" |
433 | Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences |
472 | Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences |
434 | that echo arbitrary strings like the icon name or the locale\&. This |
473 | that echo arbitrary strings like the icon name or the locale\&. This |
435 | could be abused if somebody gets 8-bit-clean access to your display, |
474 | could be abused if somebody gets 8-bit-clean access to your |
436 | wether throuh a mail client displaying mail bodies unfiltered or |
475 | display, wether throuh a mail client displaying mail bodies |
437 | though write(1)\&. Therefore, these sequences are disabled by default\&. |
476 | unfiltered or though write(1)\&. Therefore, these sequences are |
438 | You can enable them by setting this boolean resource or specifying |
477 | disabled by default\&. (Note that other terminals, including xterm, |
|
|
478 | have these sequences enabled by default)\&. You can enable them |
|
|
479 | by setting this boolean resource or specifying \fB-insecure\fP as |
439 | \fB-insecure\fP as an option\&. At the moment, this enabled display-answer, |
480 | an option\&. At the moment, this enabled display-answer, locale, |
440 | locale, findfont, icon label and window title requests as well as |
481 | findfont, icon label and window title requests as well as dynamic |
441 | dynamic menubar dispatch\&. |
482 | menubar dispatch\&. |
442 | .IP "\fBmodifier:\fP \fImodifier\fP" |
483 | .IP "\fBmodifier:\fP \fImodifier\fP" |
443 | Set the key to be interpreted as the Meta key to: |
484 | Set the key to be interpreted as the Meta key to: |
444 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
485 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
445 | \fBmod4\fP, \fBmod5\fP; |
486 | \fBmod4\fP, \fBmod5\fP; |
446 | option \fB-mod\fP\&. |
487 | option \fB-mod\fP\&. |
447 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
488 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
448 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
489 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
449 | character is passed through\&. It may contain escape values as |
490 | character is passed through\&. It may contain escape values as |
450 | described in the entry on \fBkeysym\fP following\&. |
491 | described in the entry on \fBkeysym\fP following\&. |
|
|
492 | .IP "\fBsecondaryScreen:\fP \fIbool\fP" |
|
|
493 | Turn on/off secondary screen (default enabled)\&. |
|
|
494 | .IP "\fBsecondaryScroll:\fP \fIbool\fP" |
|
|
495 | Turn on/off secondary screen scroll (default enabled)\&. If |
|
|
496 | the this option is enabled, scrolls on the secondary screen will |
|
|
497 | change the scrollback buffer and switching to/from the secondary screen |
|
|
498 | will instead scroll the screen up\&. |
451 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
499 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
452 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
500 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
453 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
501 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
454 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
502 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
455 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
503 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
… | |
… | |
579 | .PP |
627 | .PP |
580 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
628 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
581 | .PP |
629 | .PP |
582 | .SH "FTP LOCATION" |
630 | .SH "FTP LOCATION" |
583 | .PP |
631 | .PP |
584 | rxvt-2\&.5\&.tar\&.gz can be found at the following ftp sites |
632 | rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites |
585 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
633 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
586 | .PP |
634 | .PP |
587 | .SH "CURRENT PROJECT COORDINATOR" |
635 | .SH "CURRENT PROJECT COORDINATOR" |
588 | .PP |
636 | .PP |
589 | .IP "Project Coordinator" |
637 | .IP "Project Coordinator" |
… | |
… | |
610 | .IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" |
658 | .IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" |
611 | Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) |
659 | Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) |
612 | .IP "Geoff Wing <gcw@pobox\&.com>" |
660 | .IP "Geoff Wing <gcw@pobox\&.com>" |
613 | Rewrote screen display and text selection routines\&. |
661 | Rewrote screen display and text selection routines\&. |
614 | Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) |
662 | Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) |
615 | .IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" |
663 | .IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>" |
616 | Rewrote most of the display code and internal character handling |
664 | Forked rxvt-unicode, rewrote most of the display code and |
617 | to store text in unicode\&. Numerous other fixes and extensions\&. |
665 | internal character handling to store text in unicode, |
|
|
666 | improve xterm compatibility and apply numerous other bugfixes |
|
|
667 | and extensions\&. |
618 | .br |
668 | .br |
619 | Project Coordinator (Changes 1\&.0 - ) |
669 | Project Coordinator (Changes 1\&.0 - ) |
620 | .PP |
670 | .PP |