| 1 | .if !\n(.g .ab GNU tbl requires GNU troff. |
1 | .if !\n(.g .ab GNU tbl requires GNU troff. |
| 2 | .if !dTS .ds TS |
2 | .if !dTS .ds TS |
| 3 | .if !dTE .ds TE |
3 | .if !dTE .ds TE |
| 4 | .TH "RXVT" "1" "2004-03-28" "X Version 11" "X Tools" |
4 | .TH "RXVT" "1" "2004-07-26" "X Version 11" "X Tools" |
| 5 | .SH "NAME" |
5 | .SH "NAME" |
| 6 | rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system |
6 | rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system |
| 7 | .PP |
7 | .PP |
| 8 | .SH "SYNOPSIS" |
8 | .SH "SYNOPSIS" |
| 9 | .PP |
9 | .PP |
| 10 | \fBrxvt\fP [options] [-e command [ args ]] |
10 | \fBrxvt\fP [options] [-e command [ args ]] |
| 11 | .PP |
11 | .PP |
| 12 | .SH "DESCRIPTION" |
12 | .SH "DESCRIPTION" |
| 13 | .PP |
13 | .PP |
| 14 | \fBrxvt-unicode\fP, version \fB2\&.5\fP, is a colour vt102 terminal emulator |
14 | \fBrxvt-unicode\fP, version \fB3\&.3\fP, is a colour vt102 terminal emulator |
| 15 | intended as an \fIxterm\fP(1) replacement for users who do not require |
15 | intended as an \fIxterm\fP(1) replacement for users who do not require |
| 16 | features such as Tektronix 4014 emulation and toolkit-style configurability\&. |
16 | features such as Tektronix 4014 emulation and toolkit-style configurability\&. |
| 17 | As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant |
17 | As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant |
| 18 | advantage on a machine serving many X sessions\&. |
18 | advantage on a machine serving many X sessions\&. |
| 19 | .PP |
19 | .PP |
| … | |
… | |
| 54 | resource \fBjumpScroll\fP\&. |
54 | resource \fBjumpScroll\fP\&. |
| 55 | .IP "\fB-ip\fP|\fB+ip\fP" |
55 | .IP "\fB-ip\fP|\fB+ip\fP" |
| 56 | Turn on/off inheriting parent window\&'s pixmap\&. Alternative form |
56 | Turn on/off inheriting parent window\&'s pixmap\&. Alternative form |
| 57 | is \fB-tr\fP; |
57 | is \fB-tr\fP; |
| 58 | resource \fBinheritPixmap\fP\&. |
58 | resource \fBinheritPixmap\fP\&. |
|
|
59 | .IP "\fB-fade\fP \fInumber\fP" |
|
|
60 | Fade the text by the given percentage when focus is lost\&. |
|
|
61 | .IP "\fB-tint\fP \fIcolour\fP" |
|
|
62 | Tint the transparent background pixmap with the given colour when |
|
|
63 | transparency is enabled with \fB-tr\fP or \fB-ip\fP\&. |
| 59 | .IP "\fB-bg\fP \fIcolour\fP" |
64 | .IP "\fB-bg\fP \fIcolour\fP" |
| 60 | Window background colour; |
65 | Window background colour; |
| 61 | resource \fBbackground\fP\&. |
66 | resource \fBbackground\fP\&. |
| 62 | .IP "\fB-fg\fP \fIcolour\fP" |
67 | .IP "\fB-fg\fP \fIcolour\fP" |
| 63 | Window foreground colour; |
68 | Window foreground colour; |
| … | |
… | |
| 70 | resource \fBbackgroundPixmap\fP\&. |
75 | resource \fBbackgroundPixmap\fP\&. |
| 71 | .IP "\fB-cr\fP \fIcolour\fP" |
76 | .IP "\fB-cr\fP \fIcolour\fP" |
| 72 | The cursor colour; |
77 | The cursor colour; |
| 73 | resource \fBcursorColor\fP\&. |
78 | resource \fBcursorColor\fP\&. |
| 74 | .IP "\fB-pr\fP \fIcolour\fP" |
79 | .IP "\fB-pr\fP \fIcolour\fP" |
| 75 | The mouse pointer colour; |
80 | The mouse pointer foreground colour; |
| 76 | resource \fBpointerColor\fP\&. |
81 | resource \fBpointerColor\fP\&. |
|
|
82 | .IP "\fB-pr2\fP \fIcolour\fP" |
|
|
83 | The mouse pointer background colour; |
|
|
84 | resource \fBpointerColor2\fP\&. |
| 77 | .IP "\fB-bd\fP \fIcolour\fP" |
85 | .IP "\fB-bd\fP \fIcolour\fP" |
| 78 | The colour of the border between the xterm scrollbar and the text; |
86 | The colour of the border between the xterm scrollbar and the text; |
| 79 | resource \fBborderColor\fP\&. |
87 | resource \fBborderColor\fP\&. |
| 80 | .IP "\fB-fn\fP \fIfontname\fP" |
88 | .IP "\fB-fn\fP \fIfontname\fP" |
| 81 | Select the fonts to be used used\&. This is a comma seperated |
89 | Select the fonts to be used\&. |
| 82 | list of font names that are used in turn when trying to display |
90 | This is a comma seperated list of font names that are used in turn when |
| 83 | unicode characters\&. The first font defines the cell size for characters, |
91 | trying to display Unicode characters\&. |
| 84 | other fonts might be smaller, but not larger\&. A reasonable default font list |
92 | The first font defines the cell size for characters; other fonts might |
| 85 | is always appended to it\&. |
93 | be smaller, but not larger\&. |
|
|
94 | A reasonable default font list is always appended to it\&. |
| 86 | resource \fBfont\fP\&. |
95 | resource \fBfont\fP\&. |
|
|
96 | .IP "\fB-rb\fP|\fB+rb\fP" |
|
|
97 | Enable "real bold" support\&. |
|
|
98 | When this option is on, bold text will be displayed using the first |
|
|
99 | available bold font in the font list\&. |
|
|
100 | Bold fonts should thus be specified in the font list after their |
|
|
101 | corresponding regular fonts\&. |
|
|
102 | If no bold font can be found, a regular font will be used\&. |
|
|
103 | resource \fBrealBold\fP\&. |
| 87 | .IP "\fB-name\fP \fIname\fP" |
104 | .IP "\fB-name\fP \fIname\fP" |
| 88 | Specify the application name under which resources |
105 | Specify the application name under which resources |
| 89 | are to be obtained, rather than the default executable file name\&. |
106 | are to be obtained, rather than the default executable file name\&. |
| 90 | Name should not contain `\&.\&' or `*\&' characters\&. |
107 | Name should not contain `\&.\&' or `*\&' characters\&. |
| 91 | Also sets the icon and title name\&. |
108 | Also sets the icon and title name\&. |
| … | |
… | |
| 181 | .IP "\fB-mod\fP \fImodifier\fP" |
198 | .IP "\fB-mod\fP \fImodifier\fP" |
| 182 | Override detection of Meta modifier with specified key: |
199 | Override detection of Meta modifier with specified key: |
| 183 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
200 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 184 | \fBmod4\fP, \fBmod5\fP; |
201 | \fBmod4\fP, \fBmod5\fP; |
| 185 | resource \fImodifier\fP\&. |
202 | resource \fImodifier\fP\&. |
|
|
203 | .IP "\fB-ssc\fP|\fB+ssc\fP" |
|
|
204 | Turn on/off secondary screen (default enabled); |
|
|
205 | resource \fBsecondaryScreen\fP\&. |
|
|
206 | .IP "\fB-ssr\fP|\fB+ssr\fP" |
|
|
207 | Turn on/off secondary screen scroll (default enabled); |
|
|
208 | resource \fBsecondaryScroll\fP\&. |
| 186 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
209 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
| 187 | No effect on rxvt\&. Simply passes through an argument to be made |
210 | No effect on rxvt\&. Simply passes through an argument to be made |
| 188 | available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP |
211 | available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP |
| 189 | in some window managers\&. |
212 | in some window managers\&. |
| 190 | .SH "RESOURCES (available also as long-options)" |
213 | .SH "RESOURCES (available also as long-options)" |
| … | |
… | |
| 226 | but the actual colour names used are listed in the |
249 | but the actual colour names used are listed in the |
| 227 | \fBCOLORS AND GRAPHICS\fP section\&. |
250 | \fBCOLORS AND GRAPHICS\fP section\&. |
| 228 | .IP "\fBcolorBD:\fP \fIcolour\fP" |
251 | .IP "\fBcolorBD:\fP \fIcolour\fP" |
| 229 | Use the specified colour to display bold characters when the |
252 | Use the specified colour to display bold characters when the |
| 230 | foreground colour is the default\&. |
253 | foreground colour is the default\&. |
|
|
254 | This option will be ignored if \fBrealBold\fP is enabled\&. |
| 231 | .IP "\fBcolorUL:\fP \fIcolour\fP" |
255 | .IP "\fBcolorUL:\fP \fIcolour\fP" |
| 232 | Use the specified colour to display underlined characters when the |
256 | Use the specified colour to display underlined characters when the |
| 233 | foreground colour is the default\&. |
257 | foreground colour is the default\&. |
| 234 | .IP "\fBcolorRV:\fP \fIcolour\fP" |
258 | .IP "\fBcolorRV:\fP \fIcolour\fP" |
| 235 | Use the specified colour as the background for reverse video |
259 | Use the specified colour as the background for reverse video |
| … | |
… | |
| 256 | option \fB+j\fP\&. |
280 | option \fB+j\fP\&. |
| 257 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
281 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
| 258 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
282 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
| 259 | giving artificial transparency\&. |
283 | giving artificial transparency\&. |
| 260 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
284 | \fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
|
|
285 | .IP "\fBtintColor:\fP \fIcolour\fP" |
|
|
286 | Tint the transparent background pixmap with the given colour\&. |
| 261 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
287 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
| 262 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
288 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
| 263 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
289 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
| 264 | Use the specified colour for the scrollbar\&'s trough area [default |
290 | Use the specified colour for the scrollbar\&'s trough area [default |
| 265 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
291 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
| … | |
… | |
| 280 | .IP "\fBpath:\fP \fIpath\fP" |
306 | .IP "\fBpath:\fP \fIpath\fP" |
| 281 | Specify the colon-delimited search path for finding files (XPM and |
307 | Specify the colon-delimited search path for finding files (XPM and |
| 282 | menus), in addition to the paths specified by the \fBRXVTPATH\fP and |
308 | menus), in addition to the paths specified by the \fBRXVTPATH\fP and |
| 283 | \fBPATH\fP environment variables\&. |
309 | \fBPATH\fP environment variables\&. |
| 284 | .IP "\fBfont:\fP \fIfontname\fP" |
310 | .IP "\fBfont:\fP \fIfontname\fP" |
| 285 | Select the fonts to be used used\&. This is a comma seperated |
311 | Select the fonts to be used\&. |
| 286 | list of font names that are used in turn when trying to display |
312 | This is a comma seperated list of font names that are used in turn when |
| 287 | unicode characters\&. The first font defines the cell size for characters, |
313 | trying to display Unicode characters\&. |
| 288 | other fonts might be smaller, but not larger\&. A reasonable default font list |
314 | The first font defines the cell size for characters; other fonts might |
| 289 | is always appended to this list\&. |
315 | be smaller, but not larger\&. |
|
|
316 | A reasonable default font list is always appended to it\&. |
| 290 | option \fB-fn\fP\&. |
317 | option \fB-fn\fP\&. |
|
|
318 | .IP "\fBrealBold:\fP \fIboolean\fP" |
|
|
319 | \fBTrue\fP: Enable "real bold" support\&. |
|
|
320 | When this option is on, bold text will be displayed using the first |
|
|
321 | available bold font in the font list\&. |
|
|
322 | Bold fonts should thus be specified in the font list after their |
|
|
323 | corresponding regular fonts\&. |
|
|
324 | If no bold font can be found, a regular font will be used\&. |
|
|
325 | option \fB-rb\fP\&. |
|
|
326 | \fBFalse\fP: Display bold text in a regular font, using the color |
|
|
327 | specified with \fBcolorBD\fP; |
|
|
328 | option \fB+rb\fP\&. |
| 291 | .IP "\fBselectstyle:\fP \fImode\fP" |
329 | .IP "\fBselectstyle:\fP \fImode\fP" |
| 292 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
330 | Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
| 293 | is xterm style with 2\&.20 old word selection, or anything else which |
331 | is xterm style with 2\&.20 old word selection, or anything else which |
| 294 | gives xterm style selection\&. |
332 | gives xterm style selection\&. |
| 295 | .IP "\fBscrollstyle:\fP \fImode\fP" |
333 | .IP "\fBscrollstyle:\fP \fImode\fP" |
| 296 | Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP |
334 | Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP |
| 297 | .IP "\fBtitle:\fP \fIstring\fP" |
335 | .IP "\fBtitle:\fP \fIstring\fP" |
| 298 | Set window title string, the default title is the command-line |
336 | Set window title string, the default title is the command-line |
| 299 | specified after the \fB-e\fP option, if any, otherwise the application |
337 | specified after the \fB-e\fP option, if any, otherwise the application |
| 300 | name; |
338 | name; |
| 301 | option \fB-title\fP\&. |
339 | option \fB-title\fP\&. |
| … | |
… | |
| 402 | option \fB-bc\fP\&. |
440 | option \fB-bc\fP\&. |
| 403 | .IP "\fBpointerBlank:\fP \fIboolean\fP" |
441 | .IP "\fBpointerBlank:\fP \fIboolean\fP" |
| 404 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
442 | \fBTrue\fP: blank the pointer when a key is pressed or after a set number |
| 405 | of seconds of inactivity\&. |
443 | of seconds of inactivity\&. |
| 406 | \fBFalse\fP: the pointer is always visible [default]\&. |
444 | \fBFalse\fP: the pointer is always visible [default]\&. |
|
|
445 | .IP "\fBpointerColor:\fP \fIcolour\fP" |
|
|
446 | Mouse pointer foreground colour\&. |
|
|
447 | .IP "\fBpointerColor2:\fP \fIcolour\fP" |
|
|
448 | Mouse pointer background colour\&. |
| 407 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
449 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
| 408 | Specifies number of seconds before blanking the pointer [default 2]\&. |
450 | Specifies number of seconds before blanking the pointer [default 2]\&. |
| 409 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
451 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
| 410 | The string to send when the backspace key is pressed\&. If set to |
452 | The string to send when the backspace key is pressed\&. If set to |
| 411 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
453 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
| … | |
… | |
| 433 | while staying in another locale\&. |
475 | while staying in another locale\&. |
| 434 | option \fB-imlocale\fP\&. |
476 | option \fB-imlocale\fP\&. |
| 435 | .IP "\fBinsecure\fP" |
477 | .IP "\fBinsecure\fP" |
| 436 | Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences |
478 | Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences |
| 437 | that echo arbitrary strings like the icon name or the locale\&. This |
479 | that echo arbitrary strings like the icon name or the locale\&. This |
| 438 | could be abused if somebody gets 8-bit-clean access to your display, |
480 | could be abused if somebody gets 8-bit-clean access to your |
| 439 | wether throuh a mail client displaying mail bodies unfiltered or |
481 | display, wether throuh a mail client displaying mail bodies |
| 440 | though write(1)\&. Therefore, these sequences are disabled by default\&. |
482 | unfiltered or though write(1)\&. Therefore, these sequences are |
| 441 | You can enable them by setting this boolean resource or specifying |
483 | disabled by default\&. (Note that other terminals, including xterm, |
|
|
484 | have these sequences enabled by default)\&. You can enable them |
|
|
485 | by setting this boolean resource or specifying \fB-insecure\fP as |
| 442 | \fB-insecure\fP as an option\&. At the moment, this enabled display-answer, |
486 | an option\&. At the moment, this enabled display-answer, locale, |
| 443 | locale, findfont, icon label and window title requests as well as |
487 | findfont, icon label and window title requests as well as dynamic |
| 444 | dynamic menubar dispatch\&. |
488 | menubar dispatch\&. |
| 445 | .IP "\fBmodifier:\fP \fImodifier\fP" |
489 | .IP "\fBmodifier:\fP \fImodifier\fP" |
| 446 | Set the key to be interpreted as the Meta key to: |
490 | Set the key to be interpreted as the Meta key to: |
| 447 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
491 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 448 | \fBmod4\fP, \fBmod5\fP; |
492 | \fBmod4\fP, \fBmod5\fP; |
| 449 | option \fB-mod\fP\&. |
493 | option \fB-mod\fP\&. |
| 450 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
494 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
| 451 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
495 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
| 452 | character is passed through\&. It may contain escape values as |
496 | character is passed through\&. It may contain escape values as |
| 453 | described in the entry on \fBkeysym\fP following\&. |
497 | described in the entry on \fBkeysym\fP following\&. |
|
|
498 | .IP "\fBsecondaryScreen:\fP \fIbool\fP" |
|
|
499 | Turn on/off secondary screen (default enabled)\&. |
|
|
500 | .IP "\fBsecondaryScroll:\fP \fIbool\fP" |
|
|
501 | Turn on/off secondary screen scroll (default enabled)\&. If |
|
|
502 | the this option is enabled, scrolls on the secondary screen will |
|
|
503 | change the scrollback buffer and switching to/from the secondary screen |
|
|
504 | will instead scroll the screen up\&. |
| 454 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
505 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
| 455 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
506 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
| 456 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
507 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
| 457 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
508 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
| 458 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
509 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
| … | |
… | |
| 1029 | .PP |
1080 | .PP |
| 1030 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
1081 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
| 1031 | .PP |
1082 | .PP |
| 1032 | .SH "FTP LOCATION" |
1083 | .SH "FTP LOCATION" |
| 1033 | .PP |
1084 | .PP |
| 1034 | rxvt-2\&.5\&.tar\&.gz can be found at the following ftp sites |
1085 | rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites |
| 1035 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
1086 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
| 1036 | .PP |
1087 | .PP |
| 1037 | .SH "CURRENT PROJECT COORDINATOR" |
1088 | .SH "CURRENT PROJECT COORDINATOR" |
| 1038 | .PP |
1089 | .PP |
| 1039 | .IP "Project Coordinator" |
1090 | .IP "Project Coordinator" |
| … | |
… | |
| 1060 | .IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" |
1111 | .IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" |
| 1061 | Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) |
1112 | Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) |
| 1062 | .IP "Geoff Wing <gcw@pobox\&.com>" |
1113 | .IP "Geoff Wing <gcw@pobox\&.com>" |
| 1063 | Rewrote screen display and text selection routines\&. |
1114 | Rewrote screen display and text selection routines\&. |
| 1064 | Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) |
1115 | Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) |
| 1065 | .IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" |
1116 | .IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>" |
| 1066 | Rewrote most of the display code and internal character handling |
1117 | Forked rxvt-unicode, rewrote most of the display code and |
| 1067 | to store text in unicode\&. Numerous other fixes and extensions\&. |
1118 | internal character handling to store text in unicode, |
|
|
1119 | improve xterm compatibility and apply numerous other bugfixes |
|
|
1120 | and extensions\&. |
| 1068 | .br |
1121 | .br |
| 1069 | Project Coordinator (Changes 1\&.0 - ) |
1122 | Project Coordinator (Changes 1\&.0 - ) |
| 1070 | .PP |
1123 | .PP |
