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

Diff Legend

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