ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.tbl
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.tbl (file contents):
Revision 1.6 by pcg, Sun Mar 14 21:59:57 2004 UTC vs.
Revision 1.16 by root, Fri Jul 30 14:59:12 2004 UTC

1.TH "RXVT" "1" "2004-03-14" "X Version 11" "X Tools" 1.TH "RXVT" "1" "2004-07-26" "X Version 11" "X Tools"
2.SH "NAME" 2.SH "NAME"
3rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system 3rxvt-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\&.3\fP, is a colour vt102 terminal emulator
12intended as an \fIxterm\fP(1) replacement for users who do not require 12intended as an \fIxterm\fP(1) replacement for users who do not require
13features such as Tektronix 4014 emulation and toolkit-style configurability\&. 13features such as Tektronix 4014 emulation and toolkit-style configurability\&.
14As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant 14As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
15advantage on a machine serving many X sessions\&. 15advantage on a machine serving many X sessions\&.
16.PP 16.PP
… …
51resource \fBjumpScroll\fP\&. 51resource \fBjumpScroll\fP\&.
52.IP "\fB-ip\fP|\fB+ip\fP" 52.IP "\fB-ip\fP|\fB+ip\fP"
53Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 53Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
54is \fB-tr\fP; 54is \fB-tr\fP;
55resource \fBinheritPixmap\fP\&. 55resource \fBinheritPixmap\fP\&.
56.IP "\fB-fade\fP \fInumber\fP"
57Fade the text by the given percentage when focus is lost\&.
58.IP "\fB-tint\fP \fIcolour\fP"
59Tint the transparent background pixmap with the given colour\&.
56.IP "\fB-bg\fP \fIcolour\fP" 60.IP "\fB-bg\fP \fIcolour\fP"
57Window background colour; 61Window background colour;
58resource \fBbackground\fP\&. 62resource \fBbackground\fP\&.
59.IP "\fB-fg\fP \fIcolour\fP" 63.IP "\fB-fg\fP \fIcolour\fP"
60Window foreground colour; 64Window foreground colour;
… …
67resource \fBbackgroundPixmap\fP\&. 71resource \fBbackgroundPixmap\fP\&.
68.IP "\fB-cr\fP \fIcolour\fP" 72.IP "\fB-cr\fP \fIcolour\fP"
69The cursor colour; 73The cursor colour;
70resource \fBcursorColor\fP\&. 74resource \fBcursorColor\fP\&.
71.IP "\fB-pr\fP \fIcolour\fP" 75.IP "\fB-pr\fP \fIcolour\fP"
72The mouse pointer colour; 76The mouse pointer foreground colour;
73resource \fBpointerColor\fP\&. 77resource \fBpointerColor\fP\&.
78.IP "\fB-pr2\fP \fIcolour\fP"
79The mouse pointer background colour;
80resource \fBpointerColor2\fP\&.
74.IP "\fB-bd\fP \fIcolour\fP" 81.IP "\fB-bd\fP \fIcolour\fP"
75The colour of the border between the xterm scrollbar and the text; 82The colour of the border between the xterm scrollbar and the text;
76resource \fBborderColor\fP\&. 83resource \fBborderColor\fP\&.
77.IP "\fB-fn\fP \fIfontname\fP" 84.IP "\fB-fn\fP \fIfontname\fP"
78Select the fonts to be used used\&. This is a comma seperated 85Select the fonts to be used\&.
79list of font names that are used in turn when trying to display 86This is a comma seperated list of font names that are used in turn when
80unicode characters\&. The first font defines the cell size for characters, 87trying to display Unicode characters\&.
81pther fonts might be smaller, but not larger\&. A reasonable default list 88The first font defines the cell size for characters; other fonts might
82is appended\&. 89be smaller, but not larger\&.
90A reasonable default font list is always appended to it\&.
83resource \fBfont\fP\&. 91resource \fBfont\fP\&.
92.IP "\fB-rb\fP|\fB+rb\fP"
93Enable "real bold" support\&.
94When this option is on, bold text will be displayed using the first
95available bold font in the font list\&.
96Bold fonts should thus be specified in the font list after their
97corresponding regular fonts\&.
98If no bold font can be found, a regular font will be used\&.
99resource \fBrealBold\fP\&.
84.IP "\fB-name\fP \fIname\fP" 100.IP "\fB-name\fP \fIname\fP"
85Specify the application name under which resources 101Specify the application name under which resources
86are to be obtained, rather than the default executable file name\&. 102are to be obtained, rather than the default executable file name\&.
87Name should not contain `\&.\&' or `*\&' characters\&. 103Name should not contain `\&.\&' or `*\&' characters\&.
88Also sets the icon and title name\&. 104Also sets the icon and title name\&.
… …
169.IP "\fB-imlocale\fP \fIstring\fP" 185.IP "\fB-imlocale\fP \fIstring\fP"
170The locale to use for opening the IM\&. You can use an LC_CTYPE 186The locale to use for opening the IM\&. You can use an LC_CTYPE
171of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 187of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
172for the input extension to be able to input japanese characters 188for the input extension to be able to input japanese characters
173while staying in another locale\&. 189while staying in another locale\&.
190.IP "\fB-insecure\fP"
191Enable "insecure" mode, which currently enables most of the escape
192sequences that echo strings\&. See the resource \fBinsecure\fP for
193more info\&.
174.IP "\fB-mod\fP \fImodifier\fP" 194.IP "\fB-mod\fP \fImodifier\fP"
175Override detection of Meta modifier with specified key: 195Override detection of Meta modifier with specified key:
176\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 196\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
177\fBmod4\fP, \fBmod5\fP; 197\fBmod4\fP, \fBmod5\fP;
178resource \fImodifier\fP\&. 198resource \fImodifier\fP\&.
199.IP "\fB-ssc\fP|\fB+ssc\fP"
200Turn on/off secondary screen (default enabled);
201resource \fBsecondaryScreen\fP\&.
202.IP "\fB-ssr\fP|\fB+ssr\fP"
203Turn on/off secondary screen scroll (default enabled);
204resource \fBsecondaryScroll\fP\&.
179.IP "\fB-xrm\fP \fIresourcestring\fP" 205.IP "\fB-xrm\fP \fIresourcestring\fP"
180No effect on rxvt\&. Simply passes through an argument to be made 206No effect on rxvt\&. Simply passes through an argument to be made
181available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 207available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
182in some window managers\&. 208in some window managers\&.
183.SH "RESOURCES (available also as long-options)" 209.SH "RESOURCES (available also as long-options)"
… …
219but the actual colour names used are listed in the 245but the actual colour names used are listed in the
220\fBCOLORS AND GRAPHICS\fP section\&. 246\fBCOLORS AND GRAPHICS\fP section\&.
221.IP "\fBcolorBD:\fP \fIcolour\fP" 247.IP "\fBcolorBD:\fP \fIcolour\fP"
222Use the specified colour to display bold characters when the 248Use the specified colour to display bold characters when the
223foreground colour is the default\&. 249foreground colour is the default\&.
250This option will be ignored if \fBrealBold\fP is enabled\&.
224.IP "\fBcolorUL:\fP \fIcolour\fP" 251.IP "\fBcolorUL:\fP \fIcolour\fP"
225Use the specified colour to display underlined characters when the 252Use the specified colour to display underlined characters when the
226foreground colour is the default\&. 253foreground colour is the default\&.
227.IP "\fBcolorRV:\fP \fIcolour\fP" 254.IP "\fBcolorRV:\fP \fIcolour\fP"
228Use the specified colour as the background for reverse video 255Use the specified colour as the background for reverse video
… …
249option \fB+j\fP\&. 276option \fB+j\fP\&.
250.IP "\fBinheritPixmap:\fP \fIboolean\fP" 277.IP "\fBinheritPixmap:\fP \fIboolean\fP"
251\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 278\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
252giving artificial transparency\&. 279giving artificial transparency\&.
253\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 280\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
281.IP "\fBtintColor:\fP \fIcolour\fP"
282Tint the transparent background pixmap with the given colour\&.
254.IP "\fBscrollColor:\fP \fIcolour\fP" 283.IP "\fBscrollColor:\fP \fIcolour\fP"
255Use the specified colour for the scrollbar [default #B2B2B2]\&. 284Use the specified colour for the scrollbar [default #B2B2B2]\&.
256.IP "\fBtroughColor:\fP \fIcolour\fP" 285.IP "\fBtroughColor:\fP \fIcolour\fP"
257Use the specified colour for the scrollbar\&'s trough area [default 286Use the specified colour for the scrollbar\&'s trough area [default
258#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 287#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
273.IP "\fBpath:\fP \fIpath\fP" 302.IP "\fBpath:\fP \fIpath\fP"
274Specify the colon-delimited search path for finding files (XPM and 303Specify the colon-delimited search path for finding files (XPM and
275menus), in addition to the paths specified by the \fBRXVTPATH\fP and 304menus), in addition to the paths specified by the \fBRXVTPATH\fP and
276\fBPATH\fP environment variables\&. 305\fBPATH\fP environment variables\&.
277.IP "\fBfont:\fP \fIfontname\fP" 306.IP "\fBfont:\fP \fIfontname\fP"
278Select the fonts to be used used\&. This is a comma seperated 307Select the fonts to be used\&.
279list of font names that are used in turn when trying to display 308This is a comma seperated list of font names that are used in turn when
280unicode characters\&. The first font defines the cell size for characters, 309trying to display Unicode characters\&.
281pther fonts might be smaller, but not larger\&. A reasonable default list 310The first font defines the cell size for characters; other fonts might
282is appended\&. 311be smaller, but not larger\&.
312A reasonable default font list is always appended to it\&.
283option \fB-fn\fP\&. 313option \fB-fn\fP\&.
314.IP "\fBrealBold:\fP \fIboolean\fP"
315\fBTrue\fP: Enable "real bold" support\&.
316When this option is on, bold text will be displayed using the first
317available bold font in the font list\&.
318Bold fonts should thus be specified in the font list after their
319corresponding regular fonts\&.
320If no bold font can be found, a regular font will be used\&.
321option \fB-rb\fP\&.
322\fBFalse\fP: Display bold text in a regular font, using the color
323specified with \fBcolorBD\fP;
324option \fB+rb\fP\&.
284.IP "\fBselectstyle:\fP \fImode\fP" 325.IP "\fBselectstyle:\fP \fImode\fP"
285Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 326Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
286is xterm style with 2\&.20 old word selection, or anything else which 327is xterm style with 2\&.20 old word selection, or anything else which
287gives xterm style selection\&. 328gives xterm style selection\&.
288.IP "\fBscrollstyle:\fP \fImode\fP" 329.IP "\fBscrollstyle:\fP \fImode\fP"
289Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 330Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
290.IP "\fBtitle:\fP \fIstring\fP" 331.IP "\fBtitle:\fP \fIstring\fP"
291Set window title string, the default title is the command-line 332Set window title string, the default title is the command-line
292specified after the \fB-e\fP option, if any, otherwise the application 333specified after the \fB-e\fP option, if any, otherwise the application
293name; 334name;
294option \fB-title\fP\&. 335option \fB-title\fP\&.
… …
395option \fB-bc\fP\&. 436option \fB-bc\fP\&.
396.IP "\fBpointerBlank:\fP \fIboolean\fP" 437.IP "\fBpointerBlank:\fP \fIboolean\fP"
397\fBTrue\fP: blank the pointer when a key is pressed or after a set number 438\fBTrue\fP: blank the pointer when a key is pressed or after a set number
398of seconds of inactivity\&. 439of seconds of inactivity\&.
399\fBFalse\fP: the pointer is always visible [default]\&. 440\fBFalse\fP: the pointer is always visible [default]\&.
441.IP "\fBpointerColor:\fP \fIcolour\fP"
442Mouse pointer foreground colour\&.
443.IP "\fBpointerColor2:\fP \fIcolour\fP"
444Mouse pointer background colour\&.
400.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 445.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
401Specifies number of seconds before blanking the pointer [default 2]\&. 446Specifies number of seconds before blanking the pointer [default 2]\&.
402.IP "\fBbackspacekey:\fP \fIstring\fP" 447.IP "\fBbackspacekey:\fP \fIstring\fP"
403The string to send when the backspace key is pressed\&. If set to 448The 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, 449\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
… …
423The locale to use for opening the IM\&. You can use an LC_CTYPE 468The locale to use for opening the IM\&. You can use an LC_CTYPE
424of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 469of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
425for the input extension to be able to input japanese characters 470for the input extension to be able to input japanese characters
426while staying in another locale\&. 471while staying in another locale\&.
427option \fB-imlocale\fP\&. 472option \fB-imlocale\fP\&.
473.IP "\fBinsecure\fP"
474Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
475that echo arbitrary strings like the icon name or the locale\&. This
476could be abused if somebody gets 8-bit-clean access to your
477display, wether throuh a mail client displaying mail bodies
478unfiltered or though write(1)\&. Therefore, these sequences are
479disabled by default\&. (Note that other terminals, including xterm,
480have these sequences enabled by default)\&. You can enable them
481by setting this boolean resource or specifying \fB-insecure\fP as
482an option\&. At the moment, this enabled display-answer, locale,
483findfont, icon label and window title requests as well as dynamic
484menubar dispatch\&.
428.IP "\fBmodifier:\fP \fImodifier\fP" 485.IP "\fBmodifier:\fP \fImodifier\fP"
429Set the key to be interpreted as the Meta key to: 486Set 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, 487\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
431\fBmod4\fP, \fBmod5\fP; 488\fBmod4\fP, \fBmod5\fP;
432option \fB-mod\fP\&. 489option \fB-mod\fP\&.
433.IP "\fBanswerbackString:\fP \fIstring\fP" 490.IP "\fBanswerbackString:\fP \fIstring\fP"
434Specify the reply rxvt sends to the shell when an ENQ (control-E) 491Specify the reply rxvt sends to the shell when an ENQ (control-E)
435character is passed through\&. It may contain escape values as 492character is passed through\&. It may contain escape values as
436described in the entry on \fBkeysym\fP following\&. 493described in the entry on \fBkeysym\fP following\&.
494.IP "\fBsecondaryScreen:\fP \fIbool\fP"
495Turn on/off secondary screen (default enabled)\&.
496.IP "\fBsecondaryScroll:\fP \fIbool\fP"
497Turn on/off secondary screen scroll (default enabled)\&. If
498the this option is enabled, scrolls on the secondary screen will
499change the scrollback buffer and switching to/from the secondary screen
500will instead scroll the screen up\&.
437.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 501.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
438Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 502Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
439may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 503may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
440\en: newline, \er: return, \et: tab, \e000: octal number) or control 504\en: newline, \er: return, \et: tab, \e000: octal number) or control
441characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 505characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
… …
565.PP 629.PP
566Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 630Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
567.PP 631.PP
568.SH "FTP LOCATION" 632.SH "FTP LOCATION"
569.PP 633.PP
570rxvt-2\&.4\&.tar\&.gz can be found at the following ftp sites 634rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
571ftp://ftp\&.rxvt\&.org/pub/rxvt 635ftp://ftp\&.rxvt\&.org/pub/rxvt
572.PP 636.PP
573.SH "CURRENT PROJECT COORDINATOR" 637.SH "CURRENT PROJECT COORDINATOR"
574.PP 638.PP
575.IP "Project Coordinator" 639.IP "Project Coordinator"
… …
596.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 660.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
597Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 661Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
598.IP "Geoff Wing <gcw@pobox\&.com>" 662.IP "Geoff Wing <gcw@pobox\&.com>"
599Rewrote screen display and text selection routines\&. 663Rewrote screen display and text selection routines\&.
600Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 664Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
601.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 665.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
602Rewrote most of the display code and internal character handling 666Forked rxvt-unicode, rewrote most of the display code and
603to store text in unicode\&. Numerous other fixes and extensions\&. 667internal character handling to store text in unicode,
668improve xterm compatibility and apply numerous other bugfixes
669and extensions\&.
604.br 670.br
605Project Coordinator (Changes 1\&.0 - ) 671Project Coordinator (Changes 1\&.0 - )
606.PP 672.PP

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines