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

Comparing rxvt-unicode/doc/rxvt.1 (file contents):
Revision 1.9 by pcg, Fri Apr 2 18:00:00 2004 UTC vs.
Revision 1.16 by root, Fri Jul 30 14:59:12 2004 UTC

1.if !\n(.g .ab GNU tbl requires GNU troff. 1.if !\n(.g .ab GNU tbl requires GNU troff.
2.if !dTS .ds TS 2.if !dTS .ds TS
3.if !dTE .ds TE 3.if !dTE .ds TE
4.TH "RXVT" "1" "2004-04-02" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-07-26" "X Version 11" "X Tools"
5.SH "NAME" 5.SH "NAME"
6rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system 6rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
7.PP 7.PP
8.SH "SYNOPSIS" 8.SH "SYNOPSIS"
9.PP 9.PP
10\fBrxvt\fP [options] [-e command [ args ]] 10\fBrxvt\fP [options] [-e command [ args ]]
11.PP 11.PP
12.SH "DESCRIPTION" 12.SH "DESCRIPTION"
13.PP 13.PP
14\fBrxvt-unicode\fP, version \fB2\&.6\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB3\&.3\fP, is a colour vt102 terminal emulator
15intended as an \fIxterm\fP(1) replacement for users who do not require 15intended as an \fIxterm\fP(1) replacement for users who do not require
16features such as Tektronix 4014 emulation and toolkit-style configurability\&. 16features such as Tektronix 4014 emulation and toolkit-style configurability\&.
17As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant 17As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
18advantage on a machine serving many X sessions\&. 18advantage on a machine serving many X sessions\&.
19.PP 19.PP
… …
54resource \fBjumpScroll\fP\&. 54resource \fBjumpScroll\fP\&.
55.IP "\fB-ip\fP|\fB+ip\fP" 55.IP "\fB-ip\fP|\fB+ip\fP"
56Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 56Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
57is \fB-tr\fP; 57is \fB-tr\fP;
58resource \fBinheritPixmap\fP\&. 58resource \fBinheritPixmap\fP\&.
59.IP "\fB-fade\fP \fInumber\fP"
60Fade the text by the given percentage when focus is lost\&.
59.IP "\fB-tint\fP \fIcolour\fP" 61.IP "\fB-tint\fP \fIcolour\fP"
60Tint the transparent background pixmap with the given colour\&. 62Tint the transparent background pixmap with the given colour\&.
61.IP "\fB-bg\fP \fIcolour\fP" 63.IP "\fB-bg\fP \fIcolour\fP"
62Window background colour; 64Window background colour;
63resource \fBbackground\fP\&. 65resource \fBbackground\fP\&.
… …
72resource \fBbackgroundPixmap\fP\&. 74resource \fBbackgroundPixmap\fP\&.
73.IP "\fB-cr\fP \fIcolour\fP" 75.IP "\fB-cr\fP \fIcolour\fP"
74The cursor colour; 76The cursor colour;
75resource \fBcursorColor\fP\&. 77resource \fBcursorColor\fP\&.
76.IP "\fB-pr\fP \fIcolour\fP" 78.IP "\fB-pr\fP \fIcolour\fP"
77The mouse pointer colour; 79The mouse pointer foreground colour;
78resource \fBpointerColor\fP\&. 80resource \fBpointerColor\fP\&.
81.IP "\fB-pr2\fP \fIcolour\fP"
82The mouse pointer background colour;
83resource \fBpointerColor2\fP\&.
79.IP "\fB-bd\fP \fIcolour\fP" 84.IP "\fB-bd\fP \fIcolour\fP"
80The colour of the border between the xterm scrollbar and the text; 85The colour of the border between the xterm scrollbar and the text;
81resource \fBborderColor\fP\&. 86resource \fBborderColor\fP\&.
82.IP "\fB-fn\fP \fIfontname\fP" 87.IP "\fB-fn\fP \fIfontname\fP"
83Select the fonts to be used used\&. This is a comma seperated 88Select the fonts to be used\&.
84list of font names that are used in turn when trying to display 89This is a comma seperated list of font names that are used in turn when
85unicode characters\&. The first font defines the cell size for characters, 90trying to display Unicode characters\&.
86other fonts might be smaller, but not larger\&. A reasonable default font list 91The first font defines the cell size for characters; other fonts might
87is always appended to it\&. 92be smaller, but not larger\&.
93A reasonable default font list is always appended to it\&.
88resource \fBfont\fP\&. 94resource \fBfont\fP\&.
95.IP "\fB-rb\fP|\fB+rb\fP"
96Enable "real bold" support\&.
97When this option is on, bold text will be displayed using the first
98available bold font in the font list\&.
99Bold fonts should thus be specified in the font list after their
100corresponding regular fonts\&.
101If no bold font can be found, a regular font will be used\&.
102resource \fBrealBold\fP\&.
89.IP "\fB-name\fP \fIname\fP" 103.IP "\fB-name\fP \fIname\fP"
90Specify the application name under which resources 104Specify the application name under which resources
91are to be obtained, rather than the default executable file name\&. 105are to be obtained, rather than the default executable file name\&.
92Name should not contain `\&.\&' or `*\&' characters\&. 106Name should not contain `\&.\&' or `*\&' characters\&.
93Also sets the icon and title name\&. 107Also sets the icon and title name\&.
… …
234but the actual colour names used are listed in the 248but the actual colour names used are listed in the
235\fBCOLORS AND GRAPHICS\fP section\&. 249\fBCOLORS AND GRAPHICS\fP section\&.
236.IP "\fBcolorBD:\fP \fIcolour\fP" 250.IP "\fBcolorBD:\fP \fIcolour\fP"
237Use the specified colour to display bold characters when the 251Use the specified colour to display bold characters when the
238foreground colour is the default\&. 252foreground colour is the default\&.
253This option will be ignored if \fBrealBold\fP is enabled\&.
239.IP "\fBcolorUL:\fP \fIcolour\fP" 254.IP "\fBcolorUL:\fP \fIcolour\fP"
240Use the specified colour to display underlined characters when the 255Use the specified colour to display underlined characters when the
241foreground colour is the default\&. 256foreground colour is the default\&.
242.IP "\fBcolorRV:\fP \fIcolour\fP" 257.IP "\fBcolorRV:\fP \fIcolour\fP"
243Use the specified colour as the background for reverse video 258Use the specified colour as the background for reverse video
… …
264option \fB+j\fP\&. 279option \fB+j\fP\&.
265.IP "\fBinheritPixmap:\fP \fIboolean\fP" 280.IP "\fBinheritPixmap:\fP \fIboolean\fP"
266\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 281\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
267giving artificial transparency\&. 282giving artificial transparency\&.
268\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 283\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
269.IP "\fBtintColor\fP \fIcolour\fP" 284.IP "\fBtintColor:\fP \fIcolour\fP"
270Tint the transparent background pixmap with the given colour\&. 285Tint the transparent background pixmap with the given colour\&.
271.IP "\fBscrollColor:\fP \fIcolour\fP" 286.IP "\fBscrollColor:\fP \fIcolour\fP"
272Use the specified colour for the scrollbar [default #B2B2B2]\&. 287Use the specified colour for the scrollbar [default #B2B2B2]\&.
273.IP "\fBtroughColor:\fP \fIcolour\fP" 288.IP "\fBtroughColor:\fP \fIcolour\fP"
274Use the specified colour for the scrollbar\&'s trough area [default 289Use the specified colour for the scrollbar\&'s trough area [default
… …
290.IP "\fBpath:\fP \fIpath\fP" 305.IP "\fBpath:\fP \fIpath\fP"
291Specify the colon-delimited search path for finding files (XPM and 306Specify the colon-delimited search path for finding files (XPM and
292menus), in addition to the paths specified by the \fBRXVTPATH\fP and 307menus), in addition to the paths specified by the \fBRXVTPATH\fP and
293\fBPATH\fP environment variables\&. 308\fBPATH\fP environment variables\&.
294.IP "\fBfont:\fP \fIfontname\fP" 309.IP "\fBfont:\fP \fIfontname\fP"
295Select the fonts to be used used\&. This is a comma seperated 310Select the fonts to be used\&.
296list of font names that are used in turn when trying to display 311This is a comma seperated list of font names that are used in turn when
297unicode characters\&. The first font defines the cell size for characters, 312trying to display Unicode characters\&.
298other fonts might be smaller, but not larger\&. A reasonable default font list 313The first font defines the cell size for characters; other fonts might
299is always appended to this list\&. 314be smaller, but not larger\&.
315A reasonable default font list is always appended to it\&.
300option \fB-fn\fP\&. 316option \fB-fn\fP\&.
317.IP "\fBrealBold:\fP \fIboolean\fP"
318\fBTrue\fP: Enable "real bold" support\&.
319When this option is on, bold text will be displayed using the first
320available bold font in the font list\&.
321Bold fonts should thus be specified in the font list after their
322corresponding regular fonts\&.
323If no bold font can be found, a regular font will be used\&.
324option \fB-rb\fP\&.
325\fBFalse\fP: Display bold text in a regular font, using the color
326specified with \fBcolorBD\fP;
327option \fB+rb\fP\&.
301.IP "\fBselectstyle:\fP \fImode\fP" 328.IP "\fBselectstyle:\fP \fImode\fP"
302Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 329Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
303is xterm style with 2\&.20 old word selection, or anything else which 330is xterm style with 2\&.20 old word selection, or anything else which
304gives xterm style selection\&. 331gives xterm style selection\&.
305.IP "\fBscrollstyle:\fP \fImode\fP" 332.IP "\fBscrollstyle:\fP \fImode\fP"
306Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 333Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
307.IP "\fBtitle:\fP \fIstring\fP" 334.IP "\fBtitle:\fP \fIstring\fP"
308Set window title string, the default title is the command-line 335Set window title string, the default title is the command-line
309specified after the \fB-e\fP option, if any, otherwise the application 336specified after the \fB-e\fP option, if any, otherwise the application
310name; 337name;
311option \fB-title\fP\&. 338option \fB-title\fP\&.
… …
412option \fB-bc\fP\&. 439option \fB-bc\fP\&.
413.IP "\fBpointerBlank:\fP \fIboolean\fP" 440.IP "\fBpointerBlank:\fP \fIboolean\fP"
414\fBTrue\fP: blank the pointer when a key is pressed or after a set number 441\fBTrue\fP: blank the pointer when a key is pressed or after a set number
415of seconds of inactivity\&. 442of seconds of inactivity\&.
416\fBFalse\fP: the pointer is always visible [default]\&. 443\fBFalse\fP: the pointer is always visible [default]\&.
444.IP "\fBpointerColor:\fP \fIcolour\fP"
445Mouse pointer foreground colour\&.
446.IP "\fBpointerColor2:\fP \fIcolour\fP"
447Mouse pointer background colour\&.
417.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 448.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
418Specifies number of seconds before blanking the pointer [default 2]\&. 449Specifies number of seconds before blanking the pointer [default 2]\&.
419.IP "\fBbackspacekey:\fP \fIstring\fP" 450.IP "\fBbackspacekey:\fP \fIstring\fP"
420The string to send when the backspace key is pressed\&. If set to 451The string to send when the backspace key is pressed\&. If set to
421\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 452\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
… …
1048.PP 1079.PP
1049Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1080Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1050.PP 1081.PP
1051.SH "FTP LOCATION" 1082.SH "FTP LOCATION"
1052.PP 1083.PP
1053rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites 1084rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
1054ftp://ftp\&.rxvt\&.org/pub/rxvt 1085ftp://ftp\&.rxvt\&.org/pub/rxvt
1055.PP 1086.PP
1056.SH "CURRENT PROJECT COORDINATOR" 1087.SH "CURRENT PROJECT COORDINATOR"
1057.PP 1088.PP
1058.IP "Project Coordinator" 1089.IP "Project Coordinator"
… …
1079.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1110.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1080Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1111Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1081.IP "Geoff Wing <gcw@pobox\&.com>" 1112.IP "Geoff Wing <gcw@pobox\&.com>"
1082Rewrote screen display and text selection routines\&. 1113Rewrote screen display and text selection routines\&.
1083Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 1114Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1084.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 1115.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1085Rewrote most of the display code and internal character handling 1116Forked rxvt-unicode, rewrote most of the display code and
1086to store text in unicode\&. Numerous other fixes and extensions\&. 1117internal character handling to store text in unicode,
1118improve xterm compatibility and apply numerous other bugfixes
1119and extensions\&.
1087.br 1120.br
1088Project Coordinator (Changes 1\&.0 - ) 1121Project Coordinator (Changes 1\&.0 - )
1089.PP 1122.PP

Diff Legend

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