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.7 by pcg, Mon Mar 29 16:52:06 2004 UTC vs.
Revision 1.20 by root, Sat Jul 31 15:32:50 2004 UTC

1.TH "RXVT" "1" "2004-03-28" "X Version 11" "X Tools" 1.TH "RXVT" "1" "2004-07-31" "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\&.5\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\&. You can also
61emulate the "shading" or "brigthness change" option known from
62other terminal programs using gray10 (gray20, etc\&.) colour
63strings\&.
56.IP "\fB-bg\fP \fIcolour\fP" 64.IP "\fB-bg\fP \fIcolour\fP"
57Window background colour; 65Window background colour;
58resource \fBbackground\fP\&. 66resource \fBbackground\fP\&.
59.IP "\fB-fg\fP \fIcolour\fP" 67.IP "\fB-fg\fP \fIcolour\fP"
60Window foreground colour; 68Window foreground colour;
61resource \fBforeground\fP\&. 69resource \fBforeground\fP\&.
62.IP "\fB-pixmap:\fP \fIfile[;geom]\fP" 70.IP "\fB-pixmap\fP \fIfile[;geom]\fP"
63Compile \fIXPM\fP: Specify XPM file for the background and also 71Compile \fIXPM\fP: Specify XPM file for the background and also
64optionally specify its scaling with a geometry string\&. Note you 72optionally specify its scaling with a geometry string\&. Note you
65may need to add quotes to avoid special shell interpretation of 73may need to add quotes to avoid special shell interpretation of
66the `;\&' in the command-line; 74the `;\&' in the command-line;
67resource \fBbackgroundPixmap\fP\&. 75resource \fBbackgroundPixmap\fP\&.
68.IP "\fB-cr\fP \fIcolour\fP" 76.IP "\fB-cr\fP \fIcolour\fP"
69The cursor colour; 77The cursor colour;
70resource \fBcursorColor\fP\&. 78resource \fBcursorColor\fP\&.
71.IP "\fB-pr\fP \fIcolour\fP" 79.IP "\fB-pr\fP \fIcolour\fP"
72The mouse pointer colour; 80The mouse pointer foreground colour;
73resource \fBpointerColor\fP\&. 81resource \fBpointerColor\fP\&.
82.IP "\fB-pr2\fP \fIcolour\fP"
83The mouse pointer background colour;
84resource \fBpointerColor2\fP\&.
74.IP "\fB-bd\fP \fIcolour\fP" 85.IP "\fB-bd\fP \fIcolour\fP"
75The colour of the border between the xterm scrollbar and the text; 86The colour of the border between the xterm scrollbar and the text;
76resource \fBborderColor\fP\&. 87resource \fBborderColor\fP\&.
77.IP "\fB-fn\fP \fIfontname\fP" 88.IP "\fB-fn\fP \fIfontname\fP"
78Select the fonts to be used used\&. This is a comma seperated 89Select the fonts to be used\&.
79list of font names that are used in turn when trying to display 90This 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, 91trying to display Unicode characters\&.
81other fonts might be smaller, but not larger\&. A reasonable default font list 92The first font defines the cell size for characters; other fonts might
82is always appended to it\&. 93be smaller, but not larger\&.
94A reasonable default font list is always appended to it\&.
83resource \fBfont\fP\&. 95resource \fBfont\fP\&.
96.IP "\fB-rb\fP|\fB+rb\fP"
97Enable "real bold" support\&.
98When this option is on, bold text will be displayed using the first
99available bold font in the font list\&.
100Bold fonts should thus be specified in the font list after their
101corresponding regular fonts\&.
102If no bold font can be found, a regular font will be used\&.
103resource \fBrealBold\fP\&.
84.IP "\fB-name\fP \fIname\fP" 104.IP "\fB-name\fP \fIname\fP"
85Specify the application name under which resources 105Specify the application name under which resources
86are to be obtained, rather than the default executable file name\&. 106are to be obtained, rather than the default executable file name\&.
87Name should not contain `\&.\&' or `*\&' characters\&. 107Name should not contain `\&.\&' or `*\&' characters\&.
88Also sets the icon and title name\&. 108Also sets the icon and title name\&.
… …
178.IP "\fB-mod\fP \fImodifier\fP" 198.IP "\fB-mod\fP \fImodifier\fP"
179Override detection of Meta modifier with specified key: 199Override detection of Meta modifier with specified key:
180\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,
181\fBmod4\fP, \fBmod5\fP; 201\fBmod4\fP, \fBmod5\fP;
182resource \fImodifier\fP\&. 202resource \fImodifier\fP\&.
203.IP "\fB-ssc\fP|\fB+ssc\fP"
204Turn on/off secondary screen (default enabled);
205resource \fBsecondaryScreen\fP\&.
206.IP "\fB-ssr\fP|\fB+ssr\fP"
207Turn on/off secondary screen scroll (default enabled);
208resource \fBsecondaryScroll\fP\&.
183.IP "\fB-xrm\fP \fIresourcestring\fP" 209.IP "\fB-xrm\fP \fIresourcestring\fP"
184No effect on rxvt\&. Simply passes through an argument to be made 210No effect on rxvt\&. Simply passes through an argument to be made
185available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 211available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
186in some window managers\&. 212in some window managers\&.
187.SH "RESOURCES (available also as long-options)" 213.SH "RESOURCES (available also as long-options)"
188.PP 214.PP
189Note: `rxvt --help\&' gives a list of all resources (long options) compiled 215Note: `rxvt --help\&' gives a list of all resources (long options) compiled
190into your version\&. 216into your version\&.
217.PP
218There are two different methods that rxvt can use to get the
219Xresource data: using the X libraries (Xrm*-functions) or internal Xresources
220reader (\fB~/\&.Xdefaults\fP)\&. For the first method (ie\&. \fBrxvt -h\fP lists
221\fBXGetDefaults\fP), you can set and change the resources using X11
222tools like \fBxset\fP\&. Many distribution do also load settings from the
223\fB~/\&.Xresources\fP file when X starts\&.
224.PP
191If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 225If compiled with internal Xresources support (i\&.e\&. \fBrxvt
192\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 226-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
193XAPPLOADDIR/Rxvt (compile-time defined: usually 227defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
194\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 228\fB/usr/lib/X11/app-defaults/URxvt\fP) and resources set in
195or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 229\fB~/\&.Xdefaults\fP, or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&.
196reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 230Note that when reading X resources, \fBrxvt\fP recognizes two class
197\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 231names: \fBXTerm\fP and \fBURxvt\fP\&. The class name \fBRxvt\fP allows resources
198\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 232common to both \fBrxvt\fP and the original \fIrxvt\fP to be easily configured,
199\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 233while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
200key-handling, to be shared between different \fBrxvt\fP configurations\&. 234notably colours and key-handling, to be shared between different
201If no resources are specified, suitable defaults will be used\&. 235\fBrxvt\fP configurations\&. If no resources are specified, suitable
202Command-line arguments can be used to override resource settings\&. The 236defaults will be used\&. Command-line arguments can be used to override
203following resources are allowed: 237resource settings\&. The following resources are allowed:
204.PP 238.PP
205.IP "\fBgeometry:\fP \fIgeom\fP" 239.IP "\fBgeometry:\fP \fIgeom\fP"
206Create the window with the specified X window geometry [default 240Create the window with the specified X window geometry [default
20780x24]; 24180x24];
208option \fB-geometry\fP\&. 242option \fB-geometry\fP\&.
… …
223but the actual colour names used are listed in the 257but the actual colour names used are listed in the
224\fBCOLORS AND GRAPHICS\fP section\&. 258\fBCOLORS AND GRAPHICS\fP section\&.
225.IP "\fBcolorBD:\fP \fIcolour\fP" 259.IP "\fBcolorBD:\fP \fIcolour\fP"
226Use the specified colour to display bold characters when the 260Use the specified colour to display bold characters when the
227foreground colour is the default\&. 261foreground colour is the default\&.
262This option will be ignored if \fBrealBold\fP is enabled\&.
228.IP "\fBcolorUL:\fP \fIcolour\fP" 263.IP "\fBcolorUL:\fP \fIcolour\fP"
229Use the specified colour to display underlined characters when the 264Use the specified colour to display underlined characters when the
230foreground colour is the default\&. 265foreground colour is the default\&.
231.IP "\fBcolorRV:\fP \fIcolour\fP" 266.IP "\fBcolorRV:\fP \fIcolour\fP"
232Use the specified colour as the background for reverse video 267Use the specified colour as the background for reverse video
… …
253option \fB+j\fP\&. 288option \fB+j\fP\&.
254.IP "\fBinheritPixmap:\fP \fIboolean\fP" 289.IP "\fBinheritPixmap:\fP \fIboolean\fP"
255\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 290\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
256giving artificial transparency\&. 291giving artificial transparency\&.
257\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 292\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
293.IP "\fBfading:\fP \fInumber\fP"
294Fade the text by the given percentage when focus is lost\&.
295.IP "\fBtintColor:\fP \fIcolour\fP"
296Tint the transparent background pixmap with the given colour\&.
297.IP "\fBfading:\fP \fInumber\fP"
298Scale the tint colour by the given percentage\&.
258.IP "\fBscrollColor:\fP \fIcolour\fP" 299.IP "\fBscrollColor:\fP \fIcolour\fP"
259Use the specified colour for the scrollbar [default #B2B2B2]\&. 300Use the specified colour for the scrollbar [default #B2B2B2]\&.
260.IP "\fBtroughColor:\fP \fIcolour\fP" 301.IP "\fBtroughColor:\fP \fIcolour\fP"
261Use the specified colour for the scrollbar\&'s trough area [default 302Use the specified colour for the scrollbar\&'s trough area [default
262#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 303#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
277.IP "\fBpath:\fP \fIpath\fP" 318.IP "\fBpath:\fP \fIpath\fP"
278Specify the colon-delimited search path for finding files (XPM and 319Specify the colon-delimited search path for finding files (XPM and
279menus), in addition to the paths specified by the \fBRXVTPATH\fP and 320menus), in addition to the paths specified by the \fBRXVTPATH\fP and
280\fBPATH\fP environment variables\&. 321\fBPATH\fP environment variables\&.
281.IP "\fBfont:\fP \fIfontname\fP" 322.IP "\fBfont:\fP \fIfontname\fP"
282Select the fonts to be used used\&. This is a comma seperated 323Select the fonts to be used\&.
283list of font names that are used in turn when trying to display 324This is a comma seperated list of font names that are used in turn when
284unicode characters\&. The first font defines the cell size for characters, 325trying to display Unicode characters\&.
285other fonts might be smaller, but not larger\&. A reasonable default font list 326The first font defines the cell size for characters; other fonts might
286is always appended to this list\&. 327be smaller, but not larger\&.
328A reasonable default font list is always appended to it\&.
287option \fB-fn\fP\&. 329option \fB-fn\fP\&.
330.IP "\fBrealBold:\fP \fIboolean\fP"
331\fBTrue\fP: Enable "real bold" support\&.
332When this option is on, bold text will be displayed using the first
333available bold font in the font list\&.
334Bold fonts should thus be specified in the font list after their
335corresponding regular fonts\&.
336If no bold font can be found, a regular font will be used\&.
337option \fB-rb\fP\&.
338\fBFalse\fP: Display bold text in a regular font, using the color
339specified with \fBcolorBD\fP;
340option \fB+rb\fP\&.
288.IP "\fBselectstyle:\fP \fImode\fP" 341.IP "\fBselectstyle:\fP \fImode\fP"
289Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 342Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
290is xterm style with 2\&.20 old word selection, or anything else which 343is xterm style with 2\&.20 old word selection, or anything else which
291gives xterm style selection\&. 344gives xterm style selection\&.
292.IP "\fBscrollstyle:\fP \fImode\fP" 345.IP "\fBscrollstyle:\fP \fImode\fP"
293Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 346Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
294.IP "\fBtitle:\fP \fIstring\fP" 347.IP "\fBtitle:\fP \fIstring\fP"
295Set window title string, the default title is the command-line 348Set window title string, the default title is the command-line
296specified after the \fB-e\fP option, if any, otherwise the application 349specified after the \fB-e\fP option, if any, otherwise the application
297name; 350name;
298option \fB-title\fP\&. 351option \fB-title\fP\&.
… …
399option \fB-bc\fP\&. 452option \fB-bc\fP\&.
400.IP "\fBpointerBlank:\fP \fIboolean\fP" 453.IP "\fBpointerBlank:\fP \fIboolean\fP"
401\fBTrue\fP: blank the pointer when a key is pressed or after a set number 454\fBTrue\fP: blank the pointer when a key is pressed or after a set number
402of seconds of inactivity\&. 455of seconds of inactivity\&.
403\fBFalse\fP: the pointer is always visible [default]\&. 456\fBFalse\fP: the pointer is always visible [default]\&.
457.IP "\fBpointerColor:\fP \fIcolour\fP"
458Mouse pointer foreground colour\&.
459.IP "\fBpointerColor2:\fP \fIcolour\fP"
460Mouse pointer background colour\&.
404.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 461.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
405Specifies number of seconds before blanking the pointer [default 2]\&. 462Specifies number of seconds before blanking the pointer [default 2]\&.
406.IP "\fBbackspacekey:\fP \fIstring\fP" 463.IP "\fBbackspacekey:\fP \fIstring\fP"
407The string to send when the backspace key is pressed\&. If set to 464The string to send when the backspace key is pressed\&. If set to
408\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 465\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
… …
430while staying in another locale\&. 487while staying in another locale\&.
431option \fB-imlocale\fP\&. 488option \fB-imlocale\fP\&.
432.IP "\fBinsecure\fP" 489.IP "\fBinsecure\fP"
433Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences 490Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
434that echo arbitrary strings like the icon name or the locale\&. This 491that echo arbitrary strings like the icon name or the locale\&. This
435could be abused if somebody gets 8-bit-clean access to your display, 492could be abused if somebody gets 8-bit-clean access to your
436wether throuh a mail client displaying mail bodies unfiltered or 493display, wether throuh a mail client displaying mail bodies
437though write(1)\&. Therefore, these sequences are disabled by default\&. 494unfiltered or though write(1)\&. Therefore, these sequences are
438You can enable them by setting this boolean resource or specifying 495disabled by default\&. (Note that other terminals, including xterm,
496have these sequences enabled by default)\&. You can enable them
497by setting this boolean resource or specifying \fB-insecure\fP as
439\fB-insecure\fP as an option\&. At the moment, this enabled display-answer, 498an option\&. At the moment, this enabled display-answer, locale,
440locale, findfont, icon label and window title requests as well as 499findfont, icon label and window title requests as well as dynamic
441dynamic menubar dispatch\&. 500menubar dispatch\&.
442.IP "\fBmodifier:\fP \fImodifier\fP" 501.IP "\fBmodifier:\fP \fImodifier\fP"
443Set the key to be interpreted as the Meta key to: 502Set the key to be interpreted as the Meta key to:
444\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 503\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
445\fBmod4\fP, \fBmod5\fP; 504\fBmod4\fP, \fBmod5\fP;
446option \fB-mod\fP\&. 505option \fB-mod\fP\&.
447.IP "\fBanswerbackString:\fP \fIstring\fP" 506.IP "\fBanswerbackString:\fP \fIstring\fP"
448Specify the reply rxvt sends to the shell when an ENQ (control-E) 507Specify the reply rxvt sends to the shell when an ENQ (control-E)
449character is passed through\&. It may contain escape values as 508character is passed through\&. It may contain escape values as
450described in the entry on \fBkeysym\fP following\&. 509described in the entry on \fBkeysym\fP following\&.
510.IP "\fBsecondaryScreen:\fP \fIbool\fP"
511Turn on/off secondary screen (default enabled)\&.
512.IP "\fBsecondaryScroll:\fP \fIbool\fP"
513Turn on/off secondary screen scroll (default enabled)\&. If
514the this option is enabled, scrolls on the secondary screen will
515change the scrollback buffer and switching to/from the secondary screen
516will instead scroll the screen up\&.
451.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 517.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
452Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 518Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
453may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 519may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
454\en: newline, \er: return, \et: tab, \e000: octal number) or control 520\en: newline, \er: return, \et: tab, \e000: octal number) or control
455characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 521characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
… …
579.PP 645.PP
580Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 646Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
581.PP 647.PP
582.SH "FTP LOCATION" 648.SH "FTP LOCATION"
583.PP 649.PP
584rxvt-2\&.5\&.tar\&.gz can be found at the following ftp sites 650rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
585ftp://ftp\&.rxvt\&.org/pub/rxvt 651ftp://ftp\&.rxvt\&.org/pub/rxvt
586.PP 652.PP
587.SH "CURRENT PROJECT COORDINATOR" 653.SH "CURRENT PROJECT COORDINATOR"
588.PP 654.PP
589.IP "Project Coordinator" 655.IP "Project Coordinator"
… …
610.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 676.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
611Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 677Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
612.IP "Geoff Wing <gcw@pobox\&.com>" 678.IP "Geoff Wing <gcw@pobox\&.com>"
613Rewrote screen display and text selection routines\&. 679Rewrote screen display and text selection routines\&.
614Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 680Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
615.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 681.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
616Rewrote most of the display code and internal character handling 682Forked rxvt-unicode, rewrote most of the display code and
617to store text in unicode\&. Numerous other fixes and extensions\&. 683internal character handling to store text in unicode,
684improve xterm compatibility and apply numerous other bugfixes
685and extensions\&.
618.br 686.br
619Project Coordinator (Changes 1\&.0 - ) 687Project Coordinator (Changes 1\&.0 - )
620.PP 688.PP

Diff Legend

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