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.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.TH "RXVT" "1" "RXVTDATE()" "X Version 11" "X Tools" 1.TH "RXVT" "1" "2004-03-28" "X Version 11" "X Tools"
2.SH "NAME" 2.SH "NAME"
3rxvt (ouR XVT) \- 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\fP, version \fBRXVTVERSION()\fP, is a colour vt102 terminal emulator 11\fBrxvt-unicode\fP, version \fB2\&.6\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\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
17.PP 17.PP
18.SH "OPTIONS" 18.SH "OPTIONS"
19.PP 19.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-tint\fP \fIcolour\fP"
57Tint the transparent background pixmap with the given colour\&.
56.IP "\fB-bg\fP \fIcolour\fP" 58.IP "\fB-bg\fP \fIcolour\fP"
57Window background colour; 59Window background colour;
58resource \fBbackground\fP\&. 60resource \fBbackground\fP\&.
59.IP "\fB-fg\fP \fIcolour\fP" 61.IP "\fB-fg\fP \fIcolour\fP"
60Window foreground colour; 62Window foreground colour;
… …
76resource \fBborderColor\fP\&. 78resource \fBborderColor\fP\&.
77.IP "\fB-fn\fP \fIfontname\fP" 79.IP "\fB-fn\fP \fIfontname\fP"
78Select the fonts to be used used\&. This is a comma seperated 80Select the fonts to be used used\&. This is a comma seperated
79list of font names that are used in turn when trying to display 81list of font names that are used in turn when trying to display
80unicode characters\&. The first font defines the cell size for characters, 82unicode characters\&. The first font defines the cell size for characters,
81pther fonts might be smaller, but not larger\&. A reasonable default list 83other fonts might be smaller, but not larger\&. A reasonable default font list
82is appended\&. 84is always appended to it\&.
83resource \fBfont\fP\&. 85resource \fBfont\fP\&.
84.IP "\fB-name\fP \fIname\fP" 86.IP "\fB-name\fP \fIname\fP"
85Specify the application name under which resources 87Specify the application name under which resources
86are to be obtained, rather than the default executable file name\&. 88are to be obtained, rather than the default executable file name\&.
87Name should not contain `\&.\&' or `*\&' characters\&. 89Name should not contain `\&.\&' or `*\&' characters\&.
… …
112Put scrollbar on right/left; 114Put scrollbar on right/left;
113resource \fBscrollBar_right\fP\&. 115resource \fBscrollBar_right\fP\&.
114.IP "\fB-st\fP|\fB+st\fP" 116.IP "\fB-st\fP|\fB+st\fP"
115Display normal (non XTerm/NeXT) scrollbar without/with a trough; 117Display normal (non XTerm/NeXT) scrollbar without/with a trough;
116resource \fBscrollBar_floating\fP\&. 118resource \fBscrollBar_floating\fP\&.
117.IP "\fB-mcc\fP|\fB+mcc\fP"
118Compile \fImultichar_languages\fP: treat multibyte glyphs as single
119character for backspace, delete and cursor movement keys;
120resource \fBmultibyte_cursor\fP\&.
121.IP "\fB-bc\fP|\fB+bc\fP" 119.IP "\fB-bc\fP|\fB+bc\fP"
122Blink the cursor; resource \fBcursorBlink\fP\&. 120Blink the cursor; resource \fBcursorBlink\fP\&.
123.IP "\fB-iconic\fP" 121.IP "\fB-iconic\fP"
124Start iconified, if the window manager supports that option\&. 122Start iconified, if the window manager supports that option\&.
125Alternative form is \fB-ic\fP\&. 123Alternative form is \fB-ic\fP\&.
… …
173.IP "\fB-imlocale\fP \fIstring\fP" 171.IP "\fB-imlocale\fP \fIstring\fP"
174The locale to use for opening the IM\&. You can use an LC_CTYPE 172The locale to use for opening the IM\&. You can use an LC_CTYPE
175of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 173of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
176for the input extension to be able to input japanese characters 174for the input extension to be able to input japanese characters
177while staying in another locale\&. 175while staying in another locale\&.
176.IP "\fB-insecure\fP"
177Enable "insecure" mode, which currently enables most of the escape
178sequences that echo strings\&. See the resource \fBinsecure\fP for
179more info\&.
178.IP "\fB-mod\fP \fImodifier\fP" 180.IP "\fB-mod\fP \fImodifier\fP"
179Override detection of Meta modifier with specified key: 181Override detection of Meta modifier with specified key:
180\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 182\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
181\fBmod4\fP, \fBmod5\fP; 183\fBmod4\fP, \fBmod5\fP;
182resource \fImodifier\fP\&. 184resource \fImodifier\fP\&.
… …
253option \fB+j\fP\&. 255option \fB+j\fP\&.
254.IP "\fBinheritPixmap:\fP \fIboolean\fP" 256.IP "\fBinheritPixmap:\fP \fIboolean\fP"
255\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 257\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
256giving artificial transparency\&. 258giving artificial transparency\&.
257\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 259\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
260.IP "\fBtintColor\fP \fIcolour\fP"
261Tint the transparent background pixmap with the given colour\&.
258.IP "\fBscrollColor:\fP \fIcolour\fP" 262.IP "\fBscrollColor:\fP \fIcolour\fP"
259Use the specified colour for the scrollbar [default #B2B2B2]\&. 263Use the specified colour for the scrollbar [default #B2B2B2]\&.
260.IP "\fBtroughColor:\fP \fIcolour\fP" 264.IP "\fBtroughColor:\fP \fIcolour\fP"
261Use the specified colour for the scrollbar\&'s trough area [default 265Use the specified colour for the scrollbar\&'s trough area [default
262#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 266#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
280\fBPATH\fP environment variables\&. 284\fBPATH\fP environment variables\&.
281.IP "\fBfont:\fP \fIfontname\fP" 285.IP "\fBfont:\fP \fIfontname\fP"
282Select the fonts to be used used\&. This is a comma seperated 286Select the fonts to be used used\&. This is a comma seperated
283list of font names that are used in turn when trying to display 287list of font names that are used in turn when trying to display
284unicode characters\&. The first font defines the cell size for characters, 288unicode characters\&. The first font defines the cell size for characters,
285pther fonts might be smaller, but not larger\&. A reasonable default list 289other fonts might be smaller, but not larger\&. A reasonable default font list
286is appended\&. 290is always appended to this list\&.
287option \fB-fn\fP\&. 291option \fB-fn\fP\&.
288.IP "\fBselectstyle:\fP \fImode\fP" 292.IP "\fBselectstyle:\fP \fImode\fP"
289Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 293Set 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 294is xterm style with 2\&.20 old word selection, or anything else which
291gives xterm style selection\&. 295gives xterm style selection\&.
… …
401\fBTrue\fP: blank the pointer when a key is pressed or after a set number 405\fBTrue\fP: blank the pointer when a key is pressed or after a set number
402of seconds of inactivity\&. 406of seconds of inactivity\&.
403\fBFalse\fP: the pointer is always visible [default]\&. 407\fBFalse\fP: the pointer is always visible [default]\&.
404.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 408.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
405Specifies number of seconds before blanking the pointer [default 2]\&. 409Specifies number of seconds before blanking the pointer [default 2]\&.
406.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
407\fBTrue\fP: consider multibyte glyphs as single character for backspace,
408delete and cursor movement keys;
409option \fB-mcc\fP\&.
410\fBFalse\fP: move through all components of all glyphs;
411option \fB+mcc\fP\&.
412.IP "\fBbackspacekey:\fP \fIstring\fP" 410.IP "\fBbackspacekey:\fP \fIstring\fP"
413The string to send when the backspace key is pressed\&. If set to 411The string to send when the backspace key is pressed\&. If set to
414\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 412\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
415\fBBackspace\fP (code 8) - which can be reversed with the appropriate 413\fBBackspace\fP (code 8) - which can be reversed with the appropriate
416DEC private mode escape sequence\&. 414DEC private mode escape sequence\&.
… …
433The locale to use for opening the IM\&. You can use an LC_CTYPE 431The locale to use for opening the IM\&. You can use an LC_CTYPE
434of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 432of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
435for the input extension to be able to input japanese characters 433for the input extension to be able to input japanese characters
436while staying in another locale\&. 434while staying in another locale\&.
437option \fB-imlocale\fP\&. 435option \fB-imlocale\fP\&.
436.IP "\fBinsecure\fP"
437Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
438that echo arbitrary strings like the icon name or the locale\&. This
439could be abused if somebody gets 8-bit-clean access to your display,
440wether throuh a mail client displaying mail bodies unfiltered or
441though write(1)\&. Therefore, these sequences are disabled by default\&.
442You can enable them by setting this boolean resource or specifying
443\fB-insecure\fP as an option\&. At the moment, this enabled display-answer,
444locale, findfont, icon label and window title requests as well as
445dynamic menubar dispatch\&.
438.IP "\fBmodifier:\fP \fImodifier\fP" 446.IP "\fBmodifier:\fP \fImodifier\fP"
439Set the key to be interpreted as the Meta key to: 447Set the key to be interpreted as the Meta key to:
440\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 448\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
441\fBmod4\fP, \fBmod5\fP; 449\fBmod4\fP, \fBmod5\fP;
442option \fB-mod\fP\&. 450option \fB-mod\fP\&.
… …
573.PP 581.PP
574Cursor change support is not yet implemented\&. 582Cursor change support is not yet implemented\&.
575.PP 583.PP
576Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 584Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
577.PP 585.PP
578Graphics support is fairly crude\&.
579.PP
580.SH "FTP LOCATION" 586.SH "FTP LOCATION"
581.PP 587.PP
582rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 588rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites
583RXVTFTPSITE() 589ftp://ftp\&.rxvt\&.org/pub/rxvt
584.PP 590.PP
585.SH "CURRENT PROJECT COORDINATOR" 591.SH "CURRENT PROJECT COORDINATOR"
586.PP 592.PP
587.IP "Project Coordinator" 593.IP "Project Coordinator"
588RXVTMAINT() RXVTMAINTEMAIL() 594Marc A\&. Lehmann <rxvt@schmorp\&.de>
589.br 595.br
590.IP "Web page maintainter" 596.IP "Web page maintainter"
591RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 597Marc A\&. Lehmann <rxvt@schmorp\&.de>
592.br 598.br
593RXVTWEBPAGE() 599<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
594.br 600.br
595.IP "Mailing list"
596The Rxvt Workers <rxvt-workers@rxvt\&.org>
597mailing list has also been established for rxvt development, to
598subscribe, email to
599<rxvt-workers-subscribe@rxvt\&.org>\&.
600There is also a mailing list for announcements of new releases of
601rxvt\&. To subscribe, email to
602<rxvt-announce-subscribe@rxvt\&.org>\&.
603.PP 601.PP
604.SH "AUTHORS" 602.SH "AUTHORS"
605.PP 603.PP
606.IP "John Bovey" 604.IP "John Bovey"
607University of Kent, 1992, wrote the original Xvt\&. 605University of Kent, 1992, wrote the original Xvt\&.

Diff Legend

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