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.9 by pcg, Fri Apr 2 18:00:00 2004 UTC vs.
Revision 1.18 by root, Fri Jul 30 22:32:33 2004 UTC

1.TH "RXVT" "1" "2004-04-02" "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\&.6\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\&.
56.IP "\fB-tint\fP \fIcolour\fP" 58.IP "\fB-tint\fP \fIcolour\fP"
57Tint the transparent background pixmap with the given colour\&. 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\&.
58.IP "\fB-bg\fP \fIcolour\fP" 64.IP "\fB-bg\fP \fIcolour\fP"
59Window background colour; 65Window background colour;
60resource \fBbackground\fP\&. 66resource \fBbackground\fP\&.
61.IP "\fB-fg\fP \fIcolour\fP" 67.IP "\fB-fg\fP \fIcolour\fP"
62Window foreground colour; 68Window foreground colour;
… …
69resource \fBbackgroundPixmap\fP\&. 75resource \fBbackgroundPixmap\fP\&.
70.IP "\fB-cr\fP \fIcolour\fP" 76.IP "\fB-cr\fP \fIcolour\fP"
71The cursor colour; 77The cursor colour;
72resource \fBcursorColor\fP\&. 78resource \fBcursorColor\fP\&.
73.IP "\fB-pr\fP \fIcolour\fP" 79.IP "\fB-pr\fP \fIcolour\fP"
74The mouse pointer colour; 80The mouse pointer foreground colour;
75resource \fBpointerColor\fP\&. 81resource \fBpointerColor\fP\&.
82.IP "\fB-pr2\fP \fIcolour\fP"
83The mouse pointer background colour;
84resource \fBpointerColor2\fP\&.
76.IP "\fB-bd\fP \fIcolour\fP" 85.IP "\fB-bd\fP \fIcolour\fP"
77The colour of the border between the xterm scrollbar and the text; 86The colour of the border between the xterm scrollbar and the text;
78resource \fBborderColor\fP\&. 87resource \fBborderColor\fP\&.
79.IP "\fB-fn\fP \fIfontname\fP" 88.IP "\fB-fn\fP \fIfontname\fP"
80Select the fonts to be used used\&. This is a comma seperated 89Select the fonts to be used\&.
81list 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
82unicode characters\&. The first font defines the cell size for characters, 91trying to display Unicode characters\&.
83other fonts might be smaller, but not larger\&. A reasonable default font list 92The first font defines the cell size for characters; other fonts might
84is always appended to it\&. 93be smaller, but not larger\&.
94A reasonable default font list is always appended to it\&.
85resource \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\&.
86.IP "\fB-name\fP \fIname\fP" 104.IP "\fB-name\fP \fIname\fP"
87Specify the application name under which resources 105Specify the application name under which resources
88are to be obtained, rather than the default executable file name\&. 106are to be obtained, rather than the default executable file name\&.
89Name should not contain `\&.\&' or `*\&' characters\&. 107Name should not contain `\&.\&' or `*\&' characters\&.
90Also sets the icon and title name\&. 108Also sets the icon and title name\&.
… …
194in some window managers\&. 212in some window managers\&.
195.SH "RESOURCES (available also as long-options)" 213.SH "RESOURCES (available also as long-options)"
196.PP 214.PP
197Note: `rxvt --help\&' gives a list of all resources (long options) compiled 215Note: `rxvt --help\&' gives a list of all resources (long options) compiled
198into 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
199If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 225If compiled with internal Xresources support (i\&.e\&. \fBrxvt
200\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 226-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
201XAPPLOADDIR/Rxvt (compile-time defined: usually 227defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
202\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
203or \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\&.
204reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 230Note that when reading X resources, \fBrxvt\fP recognizes two class
205\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
206\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,
207\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 233while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
208key-handling, to be shared between different \fBrxvt\fP configurations\&. 234notably colours and key-handling, to be shared between different
209If no resources are specified, suitable defaults will be used\&. 235\fBrxvt\fP configurations\&. If no resources are specified, suitable
210Command-line arguments can be used to override resource settings\&. The 236defaults will be used\&. Command-line arguments can be used to override
211following resources are allowed: 237resource settings\&. The following resources are allowed:
212.PP 238.PP
213.IP "\fBgeometry:\fP \fIgeom\fP" 239.IP "\fBgeometry:\fP \fIgeom\fP"
214Create the window with the specified X window geometry [default 240Create the window with the specified X window geometry [default
21580x24]; 24180x24];
216option \fB-geometry\fP\&. 242option \fB-geometry\fP\&.
… …
231but the actual colour names used are listed in the 257but the actual colour names used are listed in the
232\fBCOLORS AND GRAPHICS\fP section\&. 258\fBCOLORS AND GRAPHICS\fP section\&.
233.IP "\fBcolorBD:\fP \fIcolour\fP" 259.IP "\fBcolorBD:\fP \fIcolour\fP"
234Use the specified colour to display bold characters when the 260Use the specified colour to display bold characters when the
235foreground colour is the default\&. 261foreground colour is the default\&.
262This option will be ignored if \fBrealBold\fP is enabled\&.
236.IP "\fBcolorUL:\fP \fIcolour\fP" 263.IP "\fBcolorUL:\fP \fIcolour\fP"
237Use the specified colour to display underlined characters when the 264Use the specified colour to display underlined characters when the
238foreground colour is the default\&. 265foreground colour is the default\&.
239.IP "\fBcolorRV:\fP \fIcolour\fP" 266.IP "\fBcolorRV:\fP \fIcolour\fP"
240Use the specified colour as the background for reverse video 267Use the specified colour as the background for reverse video
… …
261option \fB+j\fP\&. 288option \fB+j\fP\&.
262.IP "\fBinheritPixmap:\fP \fIboolean\fP" 289.IP "\fBinheritPixmap:\fP \fIboolean\fP"
263\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 290\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
264giving artificial transparency\&. 291giving artificial transparency\&.
265\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 292\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
266.IP "\fBtintColor\fP \fIcolour\fP" 293.IP "\fBtintColor:\fP \fIcolour\fP"
267Tint the transparent background pixmap with the given colour\&. 294Tint the transparent background pixmap with the given colour\&.
268.IP "\fBscrollColor:\fP \fIcolour\fP" 295.IP "\fBscrollColor:\fP \fIcolour\fP"
269Use the specified colour for the scrollbar [default #B2B2B2]\&. 296Use the specified colour for the scrollbar [default #B2B2B2]\&.
270.IP "\fBtroughColor:\fP \fIcolour\fP" 297.IP "\fBtroughColor:\fP \fIcolour\fP"
271Use the specified colour for the scrollbar\&'s trough area [default 298Use the specified colour for the scrollbar\&'s trough area [default
… …
287.IP "\fBpath:\fP \fIpath\fP" 314.IP "\fBpath:\fP \fIpath\fP"
288Specify the colon-delimited search path for finding files (XPM and 315Specify the colon-delimited search path for finding files (XPM and
289menus), in addition to the paths specified by the \fBRXVTPATH\fP and 316menus), in addition to the paths specified by the \fBRXVTPATH\fP and
290\fBPATH\fP environment variables\&. 317\fBPATH\fP environment variables\&.
291.IP "\fBfont:\fP \fIfontname\fP" 318.IP "\fBfont:\fP \fIfontname\fP"
292Select the fonts to be used used\&. This is a comma seperated 319Select the fonts to be used\&.
293list of font names that are used in turn when trying to display 320This is a comma seperated list of font names that are used in turn when
294unicode characters\&. The first font defines the cell size for characters, 321trying to display Unicode characters\&.
295other fonts might be smaller, but not larger\&. A reasonable default font list 322The first font defines the cell size for characters; other fonts might
296is always appended to this list\&. 323be smaller, but not larger\&.
324A reasonable default font list is always appended to it\&.
297option \fB-fn\fP\&. 325option \fB-fn\fP\&.
326.IP "\fBrealBold:\fP \fIboolean\fP"
327\fBTrue\fP: Enable "real bold" support\&.
328When this option is on, bold text will be displayed using the first
329available bold font in the font list\&.
330Bold fonts should thus be specified in the font list after their
331corresponding regular fonts\&.
332If no bold font can be found, a regular font will be used\&.
333option \fB-rb\fP\&.
334\fBFalse\fP: Display bold text in a regular font, using the color
335specified with \fBcolorBD\fP;
336option \fB+rb\fP\&.
298.IP "\fBselectstyle:\fP \fImode\fP" 337.IP "\fBselectstyle:\fP \fImode\fP"
299Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 338Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
300is xterm style with 2\&.20 old word selection, or anything else which 339is xterm style with 2\&.20 old word selection, or anything else which
301gives xterm style selection\&. 340gives xterm style selection\&.
302.IP "\fBscrollstyle:\fP \fImode\fP" 341.IP "\fBscrollstyle:\fP \fImode\fP"
303Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 342Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
304.IP "\fBtitle:\fP \fIstring\fP" 343.IP "\fBtitle:\fP \fIstring\fP"
305Set window title string, the default title is the command-line 344Set window title string, the default title is the command-line
306specified after the \fB-e\fP option, if any, otherwise the application 345specified after the \fB-e\fP option, if any, otherwise the application
307name; 346name;
308option \fB-title\fP\&. 347option \fB-title\fP\&.
… …
409option \fB-bc\fP\&. 448option \fB-bc\fP\&.
410.IP "\fBpointerBlank:\fP \fIboolean\fP" 449.IP "\fBpointerBlank:\fP \fIboolean\fP"
411\fBTrue\fP: blank the pointer when a key is pressed or after a set number 450\fBTrue\fP: blank the pointer when a key is pressed or after a set number
412of seconds of inactivity\&. 451of seconds of inactivity\&.
413\fBFalse\fP: the pointer is always visible [default]\&. 452\fBFalse\fP: the pointer is always visible [default]\&.
453.IP "\fBpointerColor:\fP \fIcolour\fP"
454Mouse pointer foreground colour\&.
455.IP "\fBpointerColor2:\fP \fIcolour\fP"
456Mouse pointer background colour\&.
414.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 457.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
415Specifies number of seconds before blanking the pointer [default 2]\&. 458Specifies number of seconds before blanking the pointer [default 2]\&.
416.IP "\fBbackspacekey:\fP \fIstring\fP" 459.IP "\fBbackspacekey:\fP \fIstring\fP"
417The string to send when the backspace key is pressed\&. If set to 460The string to send when the backspace key is pressed\&. If set to
418\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 461\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
… …
598.PP 641.PP
599Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 642Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
600.PP 643.PP
601.SH "FTP LOCATION" 644.SH "FTP LOCATION"
602.PP 645.PP
603rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites 646rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
604ftp://ftp\&.rxvt\&.org/pub/rxvt 647ftp://ftp\&.rxvt\&.org/pub/rxvt
605.PP 648.PP
606.SH "CURRENT PROJECT COORDINATOR" 649.SH "CURRENT PROJECT COORDINATOR"
607.PP 650.PP
608.IP "Project Coordinator" 651.IP "Project Coordinator"
… …
629.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 672.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
630Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 673Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
631.IP "Geoff Wing <gcw@pobox\&.com>" 674.IP "Geoff Wing <gcw@pobox\&.com>"
632Rewrote screen display and text selection routines\&. 675Rewrote screen display and text selection routines\&.
633Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 676Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
634.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 677.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
635Rewrote most of the display code and internal character handling 678Forked rxvt-unicode, rewrote most of the display code and
636to store text in unicode\&. Numerous other fixes and extensions\&. 679internal character handling to store text in unicode,
680improve xterm compatibility and apply numerous other bugfixes
681and extensions\&.
637.br 682.br
638Project Coordinator (Changes 1\&.0 - ) 683Project Coordinator (Changes 1\&.0 - )
639.PP 684.PP

Diff Legend

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