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.3 by pcg, Sun Feb 22 10:37:54 2004 UTC vs.
Revision 1.8 by pcg, Fri Apr 2 00:51:09 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" "RXVTDATE()" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-03-28" "X Version 11" "X Tools"
5.SH "NAME" 5.SH "NAME"
6rxvt (ouR XVT) \- 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\fP, version \fBRXVTVERSION()\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB2\&.6\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\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
20.PP 20.PP
21.SH "OPTIONS" 21.SH "OPTIONS"
22.PP 22.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-tint\fP \fIcolour\fP"
60Tint the transparent background pixmap with the given colour\&.
59.IP "\fB-bg\fP \fIcolour\fP" 61.IP "\fB-bg\fP \fIcolour\fP"
60Window background colour; 62Window background colour;
61resource \fBbackground\fP\&. 63resource \fBbackground\fP\&.
62.IP "\fB-fg\fP \fIcolour\fP" 64.IP "\fB-fg\fP \fIcolour\fP"
63Window foreground colour; 65Window foreground colour;
… …
79resource \fBborderColor\fP\&. 81resource \fBborderColor\fP\&.
80.IP "\fB-fn\fP \fIfontname\fP" 82.IP "\fB-fn\fP \fIfontname\fP"
81Select the fonts to be used used\&. This is a comma seperated 83Select the fonts to be used used\&. This is a comma seperated
82list of font names that are used in turn when trying to display 84list of font names that are used in turn when trying to display
83unicode characters\&. The first font defines the cell size for characters, 85unicode characters\&. The first font defines the cell size for characters,
84pther fonts might be smaller, but not larger\&. A reasonable default list 86other fonts might be smaller, but not larger\&. A reasonable default font list
85is appended\&. 87is always appended to it\&.
86resource \fBfont\fP\&. 88resource \fBfont\fP\&.
87.IP "\fB-name\fP \fIname\fP" 89.IP "\fB-name\fP \fIname\fP"
88Specify the application name under which resources 90Specify the application name under which resources
89are to be obtained, rather than the default executable file name\&. 91are to be obtained, rather than the default executable file name\&.
90Name should not contain `\&.\&' or `*\&' characters\&. 92Name should not contain `\&.\&' or `*\&' characters\&.
… …
115Put scrollbar on right/left; 117Put scrollbar on right/left;
116resource \fBscrollBar_right\fP\&. 118resource \fBscrollBar_right\fP\&.
117.IP "\fB-st\fP|\fB+st\fP" 119.IP "\fB-st\fP|\fB+st\fP"
118Display normal (non XTerm/NeXT) scrollbar without/with a trough; 120Display normal (non XTerm/NeXT) scrollbar without/with a trough;
119resource \fBscrollBar_floating\fP\&. 121resource \fBscrollBar_floating\fP\&.
120.IP "\fB-mcc\fP|\fB+mcc\fP"
121Compile \fImultichar_languages\fP: treat multibyte glyphs as single
122character for backspace, delete and cursor movement keys;
123resource \fBmultibyte_cursor\fP\&.
124.IP "\fB-bc\fP|\fB+bc\fP" 122.IP "\fB-bc\fP|\fB+bc\fP"
125Blink the cursor; resource \fBcursorBlink\fP\&. 123Blink the cursor; resource \fBcursorBlink\fP\&.
126.IP "\fB-iconic\fP" 124.IP "\fB-iconic\fP"
127Start iconified, if the window manager supports that option\&. 125Start iconified, if the window manager supports that option\&.
128Alternative form is \fB-ic\fP\&. 126Alternative form is \fB-ic\fP\&.
… …
176.IP "\fB-imlocale\fP \fIstring\fP" 174.IP "\fB-imlocale\fP \fIstring\fP"
177The locale to use for opening the IM\&. You can use an LC_CTYPE 175The locale to use for opening the IM\&. You can use an LC_CTYPE
178of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 176of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
179for the input extension to be able to input japanese characters 177for the input extension to be able to input japanese characters
180while staying in another locale\&. 178while staying in another locale\&.
179.IP "\fB-insecure\fP"
180Enable "insecure" mode, which currently enables most of the escape
181sequences that echo strings\&. See the resource \fBinsecure\fP for
182more info\&.
181.IP "\fB-mod\fP \fImodifier\fP" 183.IP "\fB-mod\fP \fImodifier\fP"
182Override detection of Meta modifier with specified key: 184Override detection of Meta modifier with specified key:
183\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 185\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
184\fBmod4\fP, \fBmod5\fP; 186\fBmod4\fP, \fBmod5\fP;
185resource \fImodifier\fP\&. 187resource \fImodifier\fP\&.
… …
256option \fB+j\fP\&. 258option \fB+j\fP\&.
257.IP "\fBinheritPixmap:\fP \fIboolean\fP" 259.IP "\fBinheritPixmap:\fP \fIboolean\fP"
258\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 260\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
259giving artificial transparency\&. 261giving artificial transparency\&.
260\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 262\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
263.IP "\fBtintColor\fP \fIcolour\fP"
264Tint the transparent background pixmap with the given colour\&.
261.IP "\fBscrollColor:\fP \fIcolour\fP" 265.IP "\fBscrollColor:\fP \fIcolour\fP"
262Use the specified colour for the scrollbar [default #B2B2B2]\&. 266Use the specified colour for the scrollbar [default #B2B2B2]\&.
263.IP "\fBtroughColor:\fP \fIcolour\fP" 267.IP "\fBtroughColor:\fP \fIcolour\fP"
264Use the specified colour for the scrollbar\&'s trough area [default 268Use the specified colour for the scrollbar\&'s trough area [default
265#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 269#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
283\fBPATH\fP environment variables\&. 287\fBPATH\fP environment variables\&.
284.IP "\fBfont:\fP \fIfontname\fP" 288.IP "\fBfont:\fP \fIfontname\fP"
285Select the fonts to be used used\&. This is a comma seperated 289Select the fonts to be used used\&. This is a comma seperated
286list of font names that are used in turn when trying to display 290list of font names that are used in turn when trying to display
287unicode characters\&. The first font defines the cell size for characters, 291unicode characters\&. The first font defines the cell size for characters,
288pther fonts might be smaller, but not larger\&. A reasonable default list 292other fonts might be smaller, but not larger\&. A reasonable default font list
289is appended\&. 293is always appended to this list\&.
290option \fB-fn\fP\&. 294option \fB-fn\fP\&.
291.IP "\fBselectstyle:\fP \fImode\fP" 295.IP "\fBselectstyle:\fP \fImode\fP"
292Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 296Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
293is xterm style with 2\&.20 old word selection, or anything else which 297is xterm style with 2\&.20 old word selection, or anything else which
294gives xterm style selection\&. 298gives xterm style selection\&.
… …
404\fBTrue\fP: blank the pointer when a key is pressed or after a set number 408\fBTrue\fP: blank the pointer when a key is pressed or after a set number
405of seconds of inactivity\&. 409of seconds of inactivity\&.
406\fBFalse\fP: the pointer is always visible [default]\&. 410\fBFalse\fP: the pointer is always visible [default]\&.
407.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 411.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
408Specifies number of seconds before blanking the pointer [default 2]\&. 412Specifies number of seconds before blanking the pointer [default 2]\&.
409.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
410\fBTrue\fP: consider multibyte glyphs as single character for backspace,
411delete and cursor movement keys;
412option \fB-mcc\fP\&.
413\fBFalse\fP: move through all components of all glyphs;
414option \fB+mcc\fP\&.
415.IP "\fBbackspacekey:\fP \fIstring\fP" 413.IP "\fBbackspacekey:\fP \fIstring\fP"
416The string to send when the backspace key is pressed\&. If set to 414The string to send when the backspace key is pressed\&. If set to
417\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 415\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
418\fBBackspace\fP (code 8) - which can be reversed with the appropriate 416\fBBackspace\fP (code 8) - which can be reversed with the appropriate
419DEC private mode escape sequence\&. 417DEC private mode escape sequence\&.
… …
436The locale to use for opening the IM\&. You can use an LC_CTYPE 434The locale to use for opening the IM\&. You can use an LC_CTYPE
437of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 435of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
438for the input extension to be able to input japanese characters 436for the input extension to be able to input japanese characters
439while staying in another locale\&. 437while staying in another locale\&.
440option \fB-imlocale\fP\&. 438option \fB-imlocale\fP\&.
439.IP "\fBinsecure\fP"
440Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
441that echo arbitrary strings like the icon name or the locale\&. This
442could be abused if somebody gets 8-bit-clean access to your display,
443wether throuh a mail client displaying mail bodies unfiltered or
444though write(1)\&. Therefore, these sequences are disabled by default\&.
445You can enable them by setting this boolean resource or specifying
446\fB-insecure\fP as an option\&. At the moment, this enabled display-answer,
447locale, findfont, icon label and window title requests as well as
448dynamic menubar dispatch\&.
441.IP "\fBmodifier:\fP \fImodifier\fP" 449.IP "\fBmodifier:\fP \fImodifier\fP"
442Set the key to be interpreted as the Meta key to: 450Set the key to be interpreted as the Meta key to:
443\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 451\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
444\fBmod4\fP, \fBmod5\fP; 452\fBmod4\fP, \fBmod5\fP;
445option \fB-mod\fP\&. 453option \fB-mod\fP\&.
… …
1023.PP 1031.PP
1024Cursor change support is not yet implemented\&. 1032Cursor change support is not yet implemented\&.
1025.PP 1033.PP
1026Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1034Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1027.PP 1035.PP
1028Graphics support is fairly crude\&.
1029.PP
1030.SH "FTP LOCATION" 1036.SH "FTP LOCATION"
1031.PP 1037.PP
1032rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 1038rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites
1033RXVTFTPSITE() 1039ftp://ftp\&.rxvt\&.org/pub/rxvt
1034.PP 1040.PP
1035.SH "CURRENT PROJECT COORDINATOR" 1041.SH "CURRENT PROJECT COORDINATOR"
1036.PP 1042.PP
1037.IP "Project Coordinator" 1043.IP "Project Coordinator"
1038RXVTMAINT() RXVTMAINTEMAIL() 1044Marc A\&. Lehmann <rxvt@schmorp\&.de>
1039.br 1045.br
1040.IP "Web page maintainter" 1046.IP "Web page maintainter"
1041RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 1047Marc A\&. Lehmann <rxvt@schmorp\&.de>
1042.br 1048.br
1043RXVTWEBPAGE() 1049<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
1044.br 1050.br
1045.IP "Mailing list"
1046The Rxvt Workers <rxvt-workers@rxvt\&.org>
1047mailing list has also been established for rxvt development, to
1048subscribe, email to
1049<rxvt-workers-subscribe@rxvt\&.org>\&.
1050There is also a mailing list for announcements of new releases of
1051rxvt\&. To subscribe, email to
1052<rxvt-announce-subscribe@rxvt\&.org>\&.
1053.PP 1051.PP
1054.SH "AUTHORS" 1052.SH "AUTHORS"
1055.PP 1053.PP
1056.IP "John Bovey" 1054.IP "John Bovey"
1057University of Kent, 1992, wrote the original Xvt\&. 1055University of Kent, 1992, wrote the original Xvt\&.

Diff Legend

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