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

Diff Legend

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