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.2 by pcg, Thu Dec 18 00:38:07 2003 UTC vs.
Revision 1.7 by pcg, Mon Mar 29 16:52:06 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\&.5\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
… …
76resource \fBborderColor\fP\&. 76resource \fBborderColor\fP\&.
77.IP "\fB-fn\fP \fIfontname\fP" 77.IP "\fB-fn\fP \fIfontname\fP"
78Select the fonts to be used used\&. This is a comma seperated 78Select the fonts to be used used\&. This is a comma seperated
79list of font names that are used in turn when trying to display 79list of font names that are used in turn when trying to display
80unicode characters\&. The first font defines the cell size for characters, 80unicode characters\&. The first font defines the cell size for characters,
81pther fonts might be smaller, but not larger\&. A reasonable default list 81other fonts might be smaller, but not larger\&. A reasonable default font list
82is appended\&. 82is always appended to it\&.
83resource \fBfont\fP\&. 83resource \fBfont\fP\&.
84.IP "\fB-grk\fP \fImode\fP"
85Compile \fIGreek\fP: Greek keyboard translation;
86\fBiso\fP: ISO-8859 mapping\&.
87\fBibm\fP: IBM-437 mapping;
88resource \fBgreek_keyboard\fP\&.
89.IP "\fB-name\fP \fIname\fP" 84.IP "\fB-name\fP \fIname\fP"
90Specify the application name under which resources 85Specify the application name under which resources
91are to be obtained, rather than the default executable file name\&. 86are to be obtained, rather than the default executable file name\&.
92Name should not contain `\&.\&' or `*\&' characters\&. 87Name should not contain `\&.\&' or `*\&' characters\&.
93Also sets the icon and title name\&. 88Also sets the icon and title name\&.
… …
117Put scrollbar on right/left; 112Put scrollbar on right/left;
118resource \fBscrollBar_right\fP\&. 113resource \fBscrollBar_right\fP\&.
119.IP "\fB-st\fP|\fB+st\fP" 114.IP "\fB-st\fP|\fB+st\fP"
120Display normal (non XTerm/NeXT) scrollbar without/with a trough; 115Display normal (non XTerm/NeXT) scrollbar without/with a trough;
121resource \fBscrollBar_floating\fP\&. 116resource \fBscrollBar_floating\fP\&.
122.IP "\fB-mcc\fP|\fB+mcc\fP"
123Compile \fImultichar_languages\fP: treat multibyte glyphs as single
124character for backspace, delete and cursor movement keys;
125resource \fBmultibyte_cursor\fP\&.
126.IP "\fB-bc\fP|\fB+bc\fP" 117.IP "\fB-bc\fP|\fB+bc\fP"
127Blink the cursor; resource \fBcursorBlink\fP\&. 118Blink the cursor; resource \fBcursorBlink\fP\&.
128.IP "\fB-iconic\fP" 119.IP "\fB-iconic\fP"
129Start iconified, if the window manager supports that option\&. 120Start iconified, if the window manager supports that option\&.
130Alternative form is \fB-ic\fP\&. 121Alternative form is \fB-ic\fP\&.
… …
178.IP "\fB-imlocale\fP \fIstring\fP" 169.IP "\fB-imlocale\fP \fIstring\fP"
179The locale to use for opening the IM\&. You can use an LC_CTYPE 170The locale to use for opening the IM\&. You can use an LC_CTYPE
180of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 171of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
181for the input extension to be able to input japanese characters 172for the input extension to be able to input japanese characters
182while staying in another locale\&. 173while staying in another locale\&.
174.IP "\fB-insecure\fP"
175Enable "insecure" mode, which currently enables most of the escape
176sequences that echo strings\&. See the resource \fBinsecure\fP for
177more info\&.
183.IP "\fB-mod\fP \fImodifier\fP" 178.IP "\fB-mod\fP \fImodifier\fP"
184Override detection of Meta modifier with specified key: 179Override detection of Meta modifier with specified key:
185\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 180\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
186\fBmod4\fP, \fBmod5\fP; 181\fBmod4\fP, \fBmod5\fP;
187resource \fImodifier\fP\&. 182resource \fImodifier\fP\&.
… …
285\fBPATH\fP environment variables\&. 280\fBPATH\fP environment variables\&.
286.IP "\fBfont:\fP \fIfontname\fP" 281.IP "\fBfont:\fP \fIfontname\fP"
287Select the fonts to be used used\&. This is a comma seperated 282Select the fonts to be used used\&. This is a comma seperated
288list of font names that are used in turn when trying to display 283list of font names that are used in turn when trying to display
289unicode characters\&. The first font defines the cell size for characters, 284unicode characters\&. The first font defines the cell size for characters,
290pther fonts might be smaller, but not larger\&. A reasonable default list 285other fonts might be smaller, but not larger\&. A reasonable default font list
291is appended\&. 286is always appended to this list\&.
292option \fB-fn\fP\&. 287option \fB-fn\fP\&.
293.IP "\fBgreek_keyboard:\fP \fImode\fP"
294Set the Greek keyboard translation mode to be used;
295\fBiso\fP: ISO-8859 mapping (elot-928) [default]\&.
296\fBibm\fP: IBM-437 mapping (DOS codepage 737);
297option \fB-grk\fP\&.
298.IP "\fBgreektoggle_key:\fP \fIkeysym\fP"
299Set the key to toggle keyboard input between no translation and
300Greek translation [default \fBMode_switch\fP]\&.
301For more details, see the distributed file \fBREADME\&.greek\fP\&.
302.IP "\fBselectstyle:\fP \fImode\fP" 288.IP "\fBselectstyle:\fP \fImode\fP"
303Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 289Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
304is xterm style with 2\&.20 old word selection, or anything else which 290is xterm style with 2\&.20 old word selection, or anything else which
305gives xterm style selection\&. 291gives xterm style selection\&.
306.IP "\fBscrollstyle:\fP \fImode\fP" 292.IP "\fBscrollstyle:\fP \fImode\fP"
… …
415\fBTrue\fP: blank the pointer when a key is pressed or after a set number 401\fBTrue\fP: blank the pointer when a key is pressed or after a set number
416of seconds of inactivity\&. 402of seconds of inactivity\&.
417\fBFalse\fP: the pointer is always visible [default]\&. 403\fBFalse\fP: the pointer is always visible [default]\&.
418.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 404.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
419Specifies number of seconds before blanking the pointer [default 2]\&. 405Specifies number of seconds before blanking the pointer [default 2]\&.
420.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
421\fBTrue\fP: consider multibyte glyphs as single character for backspace,
422delete and cursor movement keys;
423option \fB-mcc\fP\&.
424\fBFalse\fP: move through all components of all glyphs;
425option \fB+mcc\fP\&.
426.IP "\fBbackspacekey:\fP \fIstring\fP" 406.IP "\fBbackspacekey:\fP \fIstring\fP"
427The string to send when the backspace key is pressed\&. If set to 407The string to send when the backspace key is pressed\&. If set to
428\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 408\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
429\fBBackspace\fP (code 8) - which can be reversed with the appropriate 409\fBBackspace\fP (code 8) - which can be reversed with the appropriate
430DEC private mode escape sequence\&. 410DEC private mode escape sequence\&.
… …
447The locale to use for opening the IM\&. You can use an LC_CTYPE 427The locale to use for opening the IM\&. You can use an LC_CTYPE
448of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 428of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
449for the input extension to be able to input japanese characters 429for the input extension to be able to input japanese characters
450while staying in another locale\&. 430while staying in another locale\&.
451option \fB-imlocale\fP\&. 431option \fB-imlocale\fP\&.
432.IP "\fBinsecure\fP"
433Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
434that echo arbitrary strings like the icon name or the locale\&. This
435could be abused if somebody gets 8-bit-clean access to your display,
436wether throuh a mail client displaying mail bodies unfiltered or
437though write(1)\&. Therefore, these sequences are disabled by default\&.
438You can enable them by setting this boolean resource or specifying
439\fB-insecure\fP as an option\&. At the moment, this enabled display-answer,
440locale, findfont, icon label and window title requests as well as
441dynamic menubar dispatch\&.
452.IP "\fBmodifier:\fP \fImodifier\fP" 442.IP "\fBmodifier:\fP \fImodifier\fP"
453Set the key to be interpreted as the Meta key to: 443Set the key to be interpreted as the Meta key to:
454\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 444\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
455\fBmod4\fP, \fBmod5\fP; 445\fBmod4\fP, \fBmod5\fP;
456option \fB-mod\fP\&. 446option \fB-mod\fP\&.
… …
514.PP 504.PP
515\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 505\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
516seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 506seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
517feature, \fBrxvt\fP must be installed setuid root on some systems\&. 507feature, \fBrxvt\fP must be installed setuid root on some systems\&.
518.SH "COLORS AND GRAPHICS" 508.SH "COLORS AND GRAPHICS"
519.PP
520If graphics support was enabled at compile-time, \fBrxvt\fP can be queried
521with ANSI escape sequences and can address individual pixels instead of
522text characters\&. Note the graphics support is still considered beta code\&.
523.PP 509.PP
524In addition to the default foreground and background colours, \fBrxvt\fP 510In addition to the default foreground and background colours, \fBrxvt\fP
525can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 511can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
526versions of the same)\&. 512versions of the same)\&.
527Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 513Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
… …
591.PP 577.PP
592Cursor change support is not yet implemented\&. 578Cursor change support is not yet implemented\&.
593.PP 579.PP
594Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 580Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
595.PP 581.PP
596Graphics support is fairly crude\&.
597.PP
598.SH "FTP LOCATION" 582.SH "FTP LOCATION"
599.PP 583.PP
600rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 584rxvt-2\&.5\&.tar\&.gz can be found at the following ftp sites
601RXVTFTPSITE() 585ftp://ftp\&.rxvt\&.org/pub/rxvt
602.PP 586.PP
603.SH "CURRENT PROJECT COORDINATOR" 587.SH "CURRENT PROJECT COORDINATOR"
604.PP 588.PP
605.IP "Project Coordinator" 589.IP "Project Coordinator"
606RXVTMAINT() RXVTMAINTEMAIL() 590Marc A\&. Lehmann <rxvt@schmorp\&.de>
607.br 591.br
608.IP "Web page maintainter" 592.IP "Web page maintainter"
609RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 593Marc A\&. Lehmann <rxvt@schmorp\&.de>
610.br 594.br
611RXVTWEBPAGE() 595<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
612.br 596.br
613.IP "Mailing list"
614The Rxvt Workers <rxvt-workers@rxvt\&.org>
615mailing list has also been established for rxvt development, to
616subscribe, email to
617<rxvt-workers-subscribe@rxvt\&.org>\&.
618There is also a mailing list for announcements of new releases of
619rxvt\&. To subscribe, email to
620<rxvt-announce-subscribe@rxvt\&.org>\&.
621.PP 597.PP
622.SH "AUTHORS" 598.SH "AUTHORS"
623.PP 599.PP
624.IP "John Bovey" 600.IP "John Bovey"
625University of Kent, 1992, wrote the original Xvt\&. 601University of Kent, 1992, wrote the original Xvt\&.
626.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" 602.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
627very heavily modified Xvt and came up with Rxvt 603very heavily modified Xvt and came up with Rxvt
628.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" 604.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
629wrote the Greek Keyboard Input 605wrote the Greek Keyboard Input (no longer in code)
630.IP "mj olesen <olesen@me\&.QueensU\&.CA>" 606.IP "mj olesen <olesen@me\&.QueensU\&.CA>"
631Wrote the menu system\&. 607Wrote the menu system\&.
632.br 608.br
633Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) 609Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
634.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 610.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
635Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 611Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
636.IP "Geoff Wing <gcw@pobox\&.com>" 612.IP "Geoff Wing <gcw@pobox\&.com>"
637Rewrote screen display and text selection routines\&. 613Rewrote screen display and text selection routines\&.
614Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
615.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>"
616Rewrote most of the display code and internal character handling
617to store text in unicode\&. Numerous other fixes and extensions\&.
638.br 618.br
639Project Coordinator (changes\&.txt 2\&.4\&.6 - ) 619Project Coordinator (Changes 1\&.0 - )
620.PP

Diff Legend

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