| 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" "RXVTDATE()" "X Version 11" "X Tools" |
4 | .TH "RXVT" "1" "2004-04-02" "X Version 11" "X Tools" |
| 5 | .SH "NAME" |
5 | .SH "NAME" |
| 6 | rxvt (ouR XVT) \- 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\fP, version \fBRXVTVERSION()\fP, is a colour vt102 terminal emulator |
14 | \fBrxvt-unicode\fP, version \fB2\&.6\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\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 |
| 20 | .PP |
20 | .PP |
| 21 | .SH "OPTIONS" |
21 | .SH "OPTIONS" |
| 22 | .PP |
22 | .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-tint\fP \fIcolour\fP" |
|
|
60 | Tint the transparent background pixmap with the given colour\&. |
| 59 | .IP "\fB-bg\fP \fIcolour\fP" |
61 | .IP "\fB-bg\fP \fIcolour\fP" |
| 60 | Window background colour; |
62 | Window background colour; |
| 61 | resource \fBbackground\fP\&. |
63 | resource \fBbackground\fP\&. |
| 62 | .IP "\fB-fg\fP \fIcolour\fP" |
64 | .IP "\fB-fg\fP \fIcolour\fP" |
| 63 | Window foreground colour; |
65 | Window foreground colour; |
| … | |
… | |
| 79 | resource \fBborderColor\fP\&. |
81 | resource \fBborderColor\fP\&. |
| 80 | .IP "\fB-fn\fP \fIfontname\fP" |
82 | .IP "\fB-fn\fP \fIfontname\fP" |
| 81 | 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 |
| 82 | 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 |
| 83 | unicode characters\&. The first font defines the cell size for characters, |
85 | unicode characters\&. The first font defines the cell size for characters, |
| 84 | 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 |
| 85 | is appended\&. |
87 | is always appended to it\&. |
| 86 | resource \fBfont\fP\&. |
88 | resource \fBfont\fP\&. |
| 87 | .IP "\fB-name\fP \fIname\fP" |
89 | .IP "\fB-name\fP \fIname\fP" |
| 88 | Specify the application name under which resources |
90 | Specify the application name under which resources |
| 89 | are to be obtained, rather than the default executable file name\&. |
91 | are to be obtained, rather than the default executable file name\&. |
| 90 | Name should not contain `\&.\&' or `*\&' characters\&. |
92 | Name should not contain `\&.\&' or `*\&' characters\&. |
| … | |
… | |
| 115 | Put scrollbar on right/left; |
117 | Put scrollbar on right/left; |
| 116 | resource \fBscrollBar_right\fP\&. |
118 | resource \fBscrollBar_right\fP\&. |
| 117 | .IP "\fB-st\fP|\fB+st\fP" |
119 | .IP "\fB-st\fP|\fB+st\fP" |
| 118 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
120 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
| 119 | resource \fBscrollBar_floating\fP\&. |
121 | resource \fBscrollBar_floating\fP\&. |
| 120 | .IP "\fB-mcc\fP|\fB+mcc\fP" |
|
|
| 121 | Compile \fImultichar_languages\fP: treat multibyte glyphs as single |
|
|
| 122 | character for backspace, delete and cursor movement keys; |
|
|
| 123 | resource \fBmultibyte_cursor\fP\&. |
|
|
| 124 | .IP "\fB-bc\fP|\fB+bc\fP" |
122 | .IP "\fB-bc\fP|\fB+bc\fP" |
| 125 | Blink the cursor; resource \fBcursorBlink\fP\&. |
123 | Blink the cursor; resource \fBcursorBlink\fP\&. |
| 126 | .IP "\fB-iconic\fP" |
124 | .IP "\fB-iconic\fP" |
| 127 | Start iconified, if the window manager supports that option\&. |
125 | Start iconified, if the window manager supports that option\&. |
| 128 | Alternative form is \fB-ic\fP\&. |
126 | Alternative form is \fB-ic\fP\&. |
| … | |
… | |
| 176 | .IP "\fB-imlocale\fP \fIstring\fP" |
174 | .IP "\fB-imlocale\fP \fIstring\fP" |
| 177 | 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 |
| 178 | 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 |
| 179 | for the input extension to be able to input japanese characters |
177 | for the input extension to be able to input japanese characters |
| 180 | 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\&. |
| 181 | .IP "\fB-mod\fP \fImodifier\fP" |
183 | .IP "\fB-mod\fP \fImodifier\fP" |
| 182 | Override detection of Meta modifier with specified key: |
184 | Override detection of Meta modifier with specified key: |
| 183 | \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, |
| 184 | \fBmod4\fP, \fBmod5\fP; |
186 | \fBmod4\fP, \fBmod5\fP; |
| 185 | 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\&. |
| 186 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
194 | .IP "\fB-xrm\fP \fIresourcestring\fP" |
| 187 | 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 |
| 188 | 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 |
| 189 | in some window managers\&. |
197 | in some window managers\&. |
| 190 | .SH "RESOURCES (available also as long-options)" |
198 | .SH "RESOURCES (available also as long-options)" |
| … | |
… | |
| 256 | option \fB+j\fP\&. |
264 | option \fB+j\fP\&. |
| 257 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
265 | .IP "\fBinheritPixmap:\fP \fIboolean\fP" |
| 258 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
266 | \fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
| 259 | giving artificial transparency\&. |
267 | giving artificial transparency\&. |
| 260 | \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\&. |
| 261 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
271 | .IP "\fBscrollColor:\fP \fIcolour\fP" |
| 262 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
272 | Use the specified colour for the scrollbar [default #B2B2B2]\&. |
| 263 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
273 | .IP "\fBtroughColor:\fP \fIcolour\fP" |
| 264 | Use the specified colour for the scrollbar\&'s trough area [default |
274 | Use the specified colour for the scrollbar\&'s trough area [default |
| 265 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
275 | #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
| … | |
… | |
| 283 | \fBPATH\fP environment variables\&. |
293 | \fBPATH\fP environment variables\&. |
| 284 | .IP "\fBfont:\fP \fIfontname\fP" |
294 | .IP "\fBfont:\fP \fIfontname\fP" |
| 285 | 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 |
| 286 | 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 |
| 287 | unicode characters\&. The first font defines the cell size for characters, |
297 | unicode characters\&. The first font defines the cell size for characters, |
| 288 | 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 |
| 289 | is appended\&. |
299 | is always appended to this list\&. |
| 290 | option \fB-fn\fP\&. |
300 | option \fB-fn\fP\&. |
| 291 | .IP "\fBselectstyle:\fP \fImode\fP" |
301 | .IP "\fBselectstyle:\fP \fImode\fP" |
| 292 | 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 |
| 293 | 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 |
| 294 | gives xterm style selection\&. |
304 | gives xterm style selection\&. |
| … | |
… | |
| 404 | \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 |
| 405 | of seconds of inactivity\&. |
415 | of seconds of inactivity\&. |
| 406 | \fBFalse\fP: the pointer is always visible [default]\&. |
416 | \fBFalse\fP: the pointer is always visible [default]\&. |
| 407 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
417 | .IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
| 408 | Specifies number of seconds before blanking the pointer [default 2]\&. |
418 | Specifies number of seconds before blanking the pointer [default 2]\&. |
| 409 | .IP "\fBmultibyte_cursor:\fP \fIboolean\fP" |
|
|
| 410 | \fBTrue\fP: consider multibyte glyphs as single character for backspace, |
|
|
| 411 | delete and cursor movement keys; |
|
|
| 412 | option \fB-mcc\fP\&. |
|
|
| 413 | \fBFalse\fP: move through all components of all glyphs; |
|
|
| 414 | option \fB+mcc\fP\&. |
|
|
| 415 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
419 | .IP "\fBbackspacekey:\fP \fIstring\fP" |
| 416 | The string to send when the backspace key is pressed\&. If set to |
420 | The string to send when the backspace key is pressed\&. If set to |
| 417 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
421 | \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
| 418 | \fBBackspace\fP (code 8) - which can be reversed with the appropriate |
422 | \fBBackspace\fP (code 8) - which can be reversed with the appropriate |
| 419 | DEC private mode escape sequence\&. |
423 | DEC private mode escape sequence\&. |
| … | |
… | |
| 436 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
440 | The locale to use for opening the IM\&. You can use an LC_CTYPE |
| 437 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
441 | of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
| 438 | for the input extension to be able to input japanese characters |
442 | for the input extension to be able to input japanese characters |
| 439 | while staying in another locale\&. |
443 | while staying in another locale\&. |
| 440 | option \fB-imlocale\fP\&. |
444 | option \fB-imlocale\fP\&. |
|
|
445 | .IP "\fBinsecure\fP" |
|
|
446 | Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences |
|
|
447 | that echo arbitrary strings like the icon name or the locale\&. This |
|
|
448 | could be abused if somebody gets 8-bit-clean access to your |
|
|
449 | display, wether throuh a mail client displaying mail bodies |
|
|
450 | unfiltered or though write(1)\&. Therefore, these sequences are |
|
|
451 | disabled by default\&. (Note that other terminals, including xterm, |
|
|
452 | have these sequences enabled by default)\&. You can enable them |
|
|
453 | by setting this boolean resource or specifying \fB-insecure\fP as |
|
|
454 | an option\&. At the moment, this enabled display-answer, locale, |
|
|
455 | findfont, icon label and window title requests as well as dynamic |
|
|
456 | menubar dispatch\&. |
| 441 | .IP "\fBmodifier:\fP \fImodifier\fP" |
457 | .IP "\fBmodifier:\fP \fImodifier\fP" |
| 442 | Set the key to be interpreted as the Meta key to: |
458 | Set the key to be interpreted as the Meta key to: |
| 443 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
459 | \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 444 | \fBmod4\fP, \fBmod5\fP; |
460 | \fBmod4\fP, \fBmod5\fP; |
| 445 | option \fB-mod\fP\&. |
461 | option \fB-mod\fP\&. |
| 446 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
462 | .IP "\fBanswerbackString:\fP \fIstring\fP" |
| 447 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
463 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
| 448 | character is passed through\&. It may contain escape values as |
464 | character is passed through\&. It may contain escape values as |
| 449 | described in the entry on \fBkeysym\fP following\&. |
465 | described in the entry on \fBkeysym\fP following\&. |
|
|
466 | .IP "\fBsecondaryScreen:\fP \fIbool\fP" |
|
|
467 | Turn on/off secondary screen (default enabled)\&. |
|
|
468 | .IP "\fBsecondaryScroll:\fP \fIbool\fP" |
|
|
469 | Turn on/off secondary screen scroll (default enabled)\&. If |
|
|
470 | the this option is enabled, scrolls on the secondary screen will |
|
|
471 | change the scrollback buffer and switching to/from the secondary screen |
|
|
472 | will instead scroll the screen up\&. |
| 450 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
473 | .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
| 451 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
474 | Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
| 452 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
475 | may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
| 453 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
476 | \en: newline, \er: return, \et: tab, \e000: octal number) or control |
| 454 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
477 | characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
| … | |
… | |
| 1025 | .PP |
1048 | .PP |
| 1026 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
1049 | Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
| 1027 | .PP |
1050 | .PP |
| 1028 | .SH "FTP LOCATION" |
1051 | .SH "FTP LOCATION" |
| 1029 | .PP |
1052 | .PP |
| 1030 | rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites |
1053 | rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites |
| 1031 | RXVTFTPSITE() |
1054 | ftp://ftp\&.rxvt\&.org/pub/rxvt |
| 1032 | .PP |
1055 | .PP |
| 1033 | .SH "CURRENT PROJECT COORDINATOR" |
1056 | .SH "CURRENT PROJECT COORDINATOR" |
| 1034 | .PP |
1057 | .PP |
| 1035 | .IP "Project Coordinator" |
1058 | .IP "Project Coordinator" |
| 1036 | RXVTMAINT() RXVTMAINTEMAIL() |
1059 | Marc A\&. Lehmann <rxvt@schmorp\&.de> |
| 1037 | .br |
1060 | .br |
| 1038 | .IP "Web page maintainter" |
1061 | .IP "Web page maintainter" |
| 1039 | RXVTWEBMAINT() RXVTWEBMAINTEMAIL() |
1062 | Marc A\&. Lehmann <rxvt@schmorp\&.de> |
| 1040 | .br |
1063 | .br |
| 1041 | RXVTWEBPAGE() |
1064 | <http://www\&.sourceforge\&.net/projects/rxvt-unicode/> |
| 1042 | .br |
1065 | .br |
| 1043 | .IP "Mailing list" |
|
|
| 1044 | The Rxvt Workers <rxvt-workers@rxvt\&.org> |
|
|
| 1045 | mailing list has also been established for rxvt development, to |
|
|
| 1046 | subscribe, email to |
|
|
| 1047 | <rxvt-workers-subscribe@rxvt\&.org>\&. |
|
|
| 1048 | There is also a mailing list for announcements of new releases of |
|
|
| 1049 | rxvt\&. To subscribe, email to |
|
|
| 1050 | <rxvt-announce-subscribe@rxvt\&.org>\&. |
|
|
| 1051 | .PP |
1066 | .PP |
| 1052 | .SH "AUTHORS" |
1067 | .SH "AUTHORS" |
| 1053 | .PP |
1068 | .PP |
| 1054 | .IP "John Bovey" |
1069 | .IP "John Bovey" |
| 1055 | University of Kent, 1992, wrote the original Xvt\&. |
1070 | University of Kent, 1992, wrote the original Xvt\&. |
