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.2 by pcg, Thu Dec 18 00:38:07 2003 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-grk\fP \fImode\fP"
88Compile \fIGreek\fP: Greek keyboard translation;
89\fBiso\fP: ISO-8859 mapping\&.
90\fBibm\fP: IBM-437 mapping;
91resource \fBgreek_keyboard\fP\&.
92.IP "\fB-name\fP \fIname\fP" 89.IP "\fB-name\fP \fIname\fP"
93Specify the application name under which resources 90Specify the application name under which resources
94are to be obtained, rather than the default executable file name\&. 91are to be obtained, rather than the default executable file name\&.
95Name should not contain `\&.\&' or `*\&' characters\&. 92Name should not contain `\&.\&' or `*\&' characters\&.
96Also sets the icon and title name\&. 93Also sets the icon and title name\&.
… …
120Put scrollbar on right/left; 117Put scrollbar on right/left;
121resource \fBscrollBar_right\fP\&. 118resource \fBscrollBar_right\fP\&.
122.IP "\fB-st\fP|\fB+st\fP" 119.IP "\fB-st\fP|\fB+st\fP"
123Display normal (non XTerm/NeXT) scrollbar without/with a trough; 120Display normal (non XTerm/NeXT) scrollbar without/with a trough;
124resource \fBscrollBar_floating\fP\&. 121resource \fBscrollBar_floating\fP\&.
125.IP "\fB-mcc\fP|\fB+mcc\fP"
126Compile \fImultichar_languages\fP: treat multibyte glyphs as single
127character for backspace, delete and cursor movement keys;
128resource \fBmultibyte_cursor\fP\&.
129.IP "\fB-bc\fP|\fB+bc\fP" 122.IP "\fB-bc\fP|\fB+bc\fP"
130Blink the cursor; resource \fBcursorBlink\fP\&. 123Blink the cursor; resource \fBcursorBlink\fP\&.
131.IP "\fB-iconic\fP" 124.IP "\fB-iconic\fP"
132Start iconified, if the window manager supports that option\&. 125Start iconified, if the window manager supports that option\&.
133Alternative form is \fB-ic\fP\&. 126Alternative form is \fB-ic\fP\&.
… …
181.IP "\fB-imlocale\fP \fIstring\fP" 174.IP "\fB-imlocale\fP \fIstring\fP"
182The 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
183of 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
184for the input extension to be able to input japanese characters 177for the input extension to be able to input japanese characters
185while 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\&.
186.IP "\fB-mod\fP \fImodifier\fP" 183.IP "\fB-mod\fP \fImodifier\fP"
187Override detection of Meta modifier with specified key: 184Override detection of Meta modifier with specified key:
188\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,
189\fBmod4\fP, \fBmod5\fP; 186\fBmod4\fP, \fBmod5\fP;
190resource \fImodifier\fP\&. 187resource \fImodifier\fP\&.
… …
261option \fB+j\fP\&. 258option \fB+j\fP\&.
262.IP "\fBinheritPixmap:\fP \fIboolean\fP" 259.IP "\fBinheritPixmap:\fP \fIboolean\fP"
263\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 260\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
264giving artificial transparency\&. 261giving artificial transparency\&.
265\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\&.
266.IP "\fBscrollColor:\fP \fIcolour\fP" 265.IP "\fBscrollColor:\fP \fIcolour\fP"
267Use the specified colour for the scrollbar [default #B2B2B2]\&. 266Use the specified colour for the scrollbar [default #B2B2B2]\&.
268.IP "\fBtroughColor:\fP \fIcolour\fP" 267.IP "\fBtroughColor:\fP \fIcolour\fP"
269Use the specified colour for the scrollbar\&'s trough area [default 268Use the specified colour for the scrollbar\&'s trough area [default
270#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 269#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
288\fBPATH\fP environment variables\&. 287\fBPATH\fP environment variables\&.
289.IP "\fBfont:\fP \fIfontname\fP" 288.IP "\fBfont:\fP \fIfontname\fP"
290Select the fonts to be used used\&. This is a comma seperated 289Select the fonts to be used used\&. This is a comma seperated
291list 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
292unicode characters\&. The first font defines the cell size for characters, 291unicode characters\&. The first font defines the cell size for characters,
293pther fonts might be smaller, but not larger\&. A reasonable default list 292other fonts might be smaller, but not larger\&. A reasonable default font list
294is appended\&. 293is always appended to this list\&.
295option \fB-fn\fP\&. 294option \fB-fn\fP\&.
296.IP "\fBgreek_keyboard:\fP \fImode\fP"
297Set the Greek keyboard translation mode to be used;
298\fBiso\fP: ISO-8859 mapping (elot-928) [default]\&.
299\fBibm\fP: IBM-437 mapping (DOS codepage 737);
300option \fB-grk\fP\&.
301.IP "\fBgreektoggle_key:\fP \fIkeysym\fP"
302Set the key to toggle keyboard input between no translation and
303Greek translation [default \fBMode_switch\fP]\&.
304For more details, see the distributed file \fBREADME\&.greek\fP\&.
305.IP "\fBselectstyle:\fP \fImode\fP" 295.IP "\fBselectstyle:\fP \fImode\fP"
306Set 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
307is 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
308gives xterm style selection\&. 298gives xterm style selection\&.
309.IP "\fBscrollstyle:\fP \fImode\fP" 299.IP "\fBscrollstyle:\fP \fImode\fP"
… …
418\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
419of seconds of inactivity\&. 409of seconds of inactivity\&.
420\fBFalse\fP: the pointer is always visible [default]\&. 410\fBFalse\fP: the pointer is always visible [default]\&.
421.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 411.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
422Specifies number of seconds before blanking the pointer [default 2]\&. 412Specifies number of seconds before blanking the pointer [default 2]\&.
423.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
424\fBTrue\fP: consider multibyte glyphs as single character for backspace,
425delete and cursor movement keys;
426option \fB-mcc\fP\&.
427\fBFalse\fP: move through all components of all glyphs;
428option \fB+mcc\fP\&.
429.IP "\fBbackspacekey:\fP \fIstring\fP" 413.IP "\fBbackspacekey:\fP \fIstring\fP"
430The 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
431\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,
432\fBBackspace\fP (code 8) - which can be reversed with the appropriate 416\fBBackspace\fP (code 8) - which can be reversed with the appropriate
433DEC private mode escape sequence\&. 417DEC private mode escape sequence\&.
… …
450The 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
451of 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
452for the input extension to be able to input japanese characters 436for the input extension to be able to input japanese characters
453while staying in another locale\&. 437while staying in another locale\&.
454option \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\&.
455.IP "\fBmodifier:\fP \fImodifier\fP" 449.IP "\fBmodifier:\fP \fImodifier\fP"
456Set the key to be interpreted as the Meta key to: 450Set the key to be interpreted as the Meta key to:
457\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,
458\fBmod4\fP, \fBmod5\fP; 452\fBmod4\fP, \fBmod5\fP;
459option \fB-mod\fP\&. 453option \fB-mod\fP\&.
… …
517.PP 511.PP
518\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 512\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
519seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 513seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
520feature, \fBrxvt\fP must be installed setuid root on some systems\&. 514feature, \fBrxvt\fP must be installed setuid root on some systems\&.
521.SH "COLORS AND GRAPHICS" 515.SH "COLORS AND GRAPHICS"
522.PP
523If graphics support was enabled at compile-time, \fBrxvt\fP can be queried
524with ANSI escape sequences and can address individual pixels instead of
525text characters\&. Note the graphics support is still considered beta code\&.
526.PP 516.PP
527In addition to the default foreground and background colours, \fBrxvt\fP 517In addition to the default foreground and background colours, \fBrxvt\fP
528can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 518can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
529versions of the same)\&. 519versions of the same)\&.
530Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 520Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
… …
1041.PP 1031.PP
1042Cursor change support is not yet implemented\&. 1032Cursor change support is not yet implemented\&.
1043.PP 1033.PP
1044Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1034Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1045.PP 1035.PP
1046Graphics support is fairly crude\&.
1047.PP
1048.SH "FTP LOCATION" 1036.SH "FTP LOCATION"
1049.PP 1037.PP
1050rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 1038rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites
1051RXVTFTPSITE() 1039ftp://ftp\&.rxvt\&.org/pub/rxvt
1052.PP 1040.PP
1053.SH "CURRENT PROJECT COORDINATOR" 1041.SH "CURRENT PROJECT COORDINATOR"
1054.PP 1042.PP
1055.IP "Project Coordinator" 1043.IP "Project Coordinator"
1056RXVTMAINT() RXVTMAINTEMAIL() 1044Marc A\&. Lehmann <rxvt@schmorp\&.de>
1057.br 1045.br
1058.IP "Web page maintainter" 1046.IP "Web page maintainter"
1059RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 1047Marc A\&. Lehmann <rxvt@schmorp\&.de>
1060.br 1048.br
1061RXVTWEBPAGE() 1049<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
1062.br 1050.br
1063.IP "Mailing list"
1064The Rxvt Workers <rxvt-workers@rxvt\&.org>
1065mailing list has also been established for rxvt development, to
1066subscribe, email to
1067<rxvt-workers-subscribe@rxvt\&.org>\&.
1068There is also a mailing list for announcements of new releases of
1069rxvt\&. To subscribe, email to
1070<rxvt-announce-subscribe@rxvt\&.org>\&.
1071.PP 1051.PP
1072.SH "AUTHORS" 1052.SH "AUTHORS"
1073.PP 1053.PP
1074.IP "John Bovey" 1054.IP "John Bovey"
1075University of Kent, 1992, wrote the original Xvt\&. 1055University of Kent, 1992, wrote the original Xvt\&.
1076.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" 1056.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
1077very heavily modified Xvt and came up with Rxvt 1057very heavily modified Xvt and came up with Rxvt
1078.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" 1058.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
1079wrote the Greek Keyboard Input 1059wrote the Greek Keyboard Input (no longer in code)
1080.IP "mj olesen <olesen@me\&.QueensU\&.CA>" 1060.IP "mj olesen <olesen@me\&.QueensU\&.CA>"
1081Wrote the menu system\&. 1061Wrote the menu system\&.
1082.br 1062.br
1083Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) 1063Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
1084.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1064.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1085Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1065Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1086.IP "Geoff Wing <gcw@pobox\&.com>" 1066.IP "Geoff Wing <gcw@pobox\&.com>"
1087Rewrote screen display and text selection routines\&. 1067Rewrote screen display and text selection routines\&.
1068Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1069.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>"
1070Rewrote most of the display code and internal character handling
1071to store text in unicode\&. Numerous other fixes and extensions\&.
1088.br 1072.br
1089Project Coordinator (changes\&.txt 2\&.4\&.6 - ) 1073Project Coordinator (Changes 1\&.0 - )
1074.PP

Diff Legend

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