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.12 by root, Sat Jul 10 20:59:39 2004 UTC

1.TH "RXVT" "1" "RXVTDATE()" "X Version 11" "X Tools" 1.TH "RXVT" "1" "2004-05-10" "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 \fB3\&.1\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;
67resource \fBbackgroundPixmap\fP\&. 69resource \fBbackgroundPixmap\fP\&.
68.IP "\fB-cr\fP \fIcolour\fP" 70.IP "\fB-cr\fP \fIcolour\fP"
69The cursor colour; 71The cursor colour;
70resource \fBcursorColor\fP\&. 72resource \fBcursorColor\fP\&.
71.IP "\fB-pr\fP \fIcolour\fP" 73.IP "\fB-pr\fP \fIcolour\fP"
72The mouse pointer colour; 74The mouse pointer foreground colour;
73resource \fBpointerColor\fP\&. 75resource \fBpointerColor\fP\&.
76.IP "\fB-pr2\fP \fIcolour\fP"
77The mouse pointer background colour;
78resource \fBpointerColor2\fP\&.
74.IP "\fB-bd\fP \fIcolour\fP" 79.IP "\fB-bd\fP \fIcolour\fP"
75The colour of the border between the xterm scrollbar and the text; 80The colour of the border between the xterm scrollbar and the text;
76resource \fBborderColor\fP\&. 81resource \fBborderColor\fP\&.
77.IP "\fB-fn\fP \fIfontname\fP" 82.IP "\fB-fn\fP \fIfontname\fP"
78Select the fonts to be used used\&. This is a comma seperated 83Select the fonts to be used used\&. This is a comma seperated
79list 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
80unicode characters\&. The first font defines the cell size for characters, 85unicode characters\&. The first font defines the cell size for characters,
81pther fonts might be smaller, but not larger\&. A reasonable default list 86other fonts might be smaller, but not larger\&. A reasonable default font list
82is appended\&. 87is always appended to it\&.
83resource \fBfont\fP\&. 88resource \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" 89.IP "\fB-name\fP \fIname\fP"
90Specify the application name under which resources 90Specify the application name under which resources
91are to be obtained, rather than the default executable file name\&. 91are to be obtained, rather than the default executable file name\&.
92Name should not contain `\&.\&' or `*\&' characters\&. 92Name should not contain `\&.\&' or `*\&' characters\&.
93Also sets the icon and title name\&. 93Also sets the icon and title name\&.
117Put scrollbar on right/left; 117Put scrollbar on right/left;
118resource \fBscrollBar_right\fP\&. 118resource \fBscrollBar_right\fP\&.
119.IP "\fB-st\fP|\fB+st\fP" 119.IP "\fB-st\fP|\fB+st\fP"
120Display normal (non XTerm/NeXT) scrollbar without/with a trough; 120Display normal (non XTerm/NeXT) scrollbar without/with a trough;
121resource \fBscrollBar_floating\fP\&. 121resource \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" 122.IP "\fB-bc\fP|\fB+bc\fP"
127Blink the cursor; resource \fBcursorBlink\fP\&. 123Blink the cursor; resource \fBcursorBlink\fP\&.
128.IP "\fB-iconic\fP" 124.IP "\fB-iconic\fP"
129Start iconified, if the window manager supports that option\&. 125Start iconified, if the window manager supports that option\&.
130Alternative form is \fB-ic\fP\&. 126Alternative form is \fB-ic\fP\&.
178.IP "\fB-imlocale\fP \fIstring\fP" 174.IP "\fB-imlocale\fP \fIstring\fP"
179The 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
180of 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
181for the input extension to be able to input japanese characters 177for the input extension to be able to input japanese characters
182while 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\&.
183.IP "\fB-mod\fP \fImodifier\fP" 183.IP "\fB-mod\fP \fImodifier\fP"
184Override detection of Meta modifier with specified key: 184Override detection of Meta modifier with specified key:
185\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,
186\fBmod4\fP, \fBmod5\fP; 186\fBmod4\fP, \fBmod5\fP;
187resource \fImodifier\fP\&. 187resource \fImodifier\fP\&.
188.IP "\fB-ssc\fP|\fB+ssc\fP"
189Turn on/off secondary screen (default enabled);
190resource \fBsecondaryScreen\fP\&.
191.IP "\fB-ssr\fP|\fB+ssr\fP"
192Turn on/off secondary screen scroll (default enabled);
193resource \fBsecondaryScroll\fP\&.
188.IP "\fB-xrm\fP \fIresourcestring\fP" 194.IP "\fB-xrm\fP \fIresourcestring\fP"
189No effect on rxvt\&. Simply passes through an argument to be made 195No effect on rxvt\&. Simply passes through an argument to be made
190available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 196available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
191in some window managers\&. 197in some window managers\&.
192.SH "RESOURCES (available also as long-options)" 198.SH "RESOURCES (available also as long-options)"
258option \fB+j\fP\&. 264option \fB+j\fP\&.
259.IP "\fBinheritPixmap:\fP \fIboolean\fP" 265.IP "\fBinheritPixmap:\fP \fIboolean\fP"
260\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 266\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
261giving artificial transparency\&. 267giving artificial transparency\&.
262\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 268\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
269.IP "\fBtintColor\fP \fIcolour\fP"
270Tint the transparent background pixmap with the given colour\&.
263.IP "\fBscrollColor:\fP \fIcolour\fP" 271.IP "\fBscrollColor:\fP \fIcolour\fP"
264Use the specified colour for the scrollbar [default #B2B2B2]\&. 272Use the specified colour for the scrollbar [default #B2B2B2]\&.
265.IP "\fBtroughColor:\fP \fIcolour\fP" 273.IP "\fBtroughColor:\fP \fIcolour\fP"
266Use the specified colour for the scrollbar\&'s trough area [default 274Use the specified colour for the scrollbar\&'s trough area [default
267#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 275#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
285\fBPATH\fP environment variables\&. 293\fBPATH\fP environment variables\&.
286.IP "\fBfont:\fP \fIfontname\fP" 294.IP "\fBfont:\fP \fIfontname\fP"
287Select the fonts to be used used\&. This is a comma seperated 295Select the fonts to be used used\&. This is a comma seperated
288list of font names that are used in turn when trying to display 296list of font names that are used in turn when trying to display
289unicode characters\&. The first font defines the cell size for characters, 297unicode characters\&. The first font defines the cell size for characters,
290pther fonts might be smaller, but not larger\&. A reasonable default list 298other fonts might be smaller, but not larger\&. A reasonable default font list
291is appended\&. 299is always appended to this list\&.
292option \fB-fn\fP\&. 300option \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" 301.IP "\fBselectstyle:\fP \fImode\fP"
303Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 302Set 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 303is xterm style with 2\&.20 old word selection, or anything else which
305gives xterm style selection\&. 304gives xterm style selection\&.
306.IP "\fBscrollstyle:\fP \fImode\fP" 305.IP "\fBscrollstyle:\fP \fImode\fP"
307Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 306Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
308.IP "\fBtitle:\fP \fIstring\fP" 307.IP "\fBtitle:\fP \fIstring\fP"
309Set window title string, the default title is the command-line 308Set window title string, the default title is the command-line
310specified after the \fB-e\fP option, if any, otherwise the application 309specified after the \fB-e\fP option, if any, otherwise the application
311name; 310name;
312option \fB-title\fP\&. 311option \fB-title\fP\&.
413option \fB-bc\fP\&. 412option \fB-bc\fP\&.
414.IP "\fBpointerBlank:\fP \fIboolean\fP" 413.IP "\fBpointerBlank:\fP \fIboolean\fP"
415\fBTrue\fP: blank the pointer when a key is pressed or after a set number 414\fBTrue\fP: blank the pointer when a key is pressed or after a set number
416of seconds of inactivity\&. 415of seconds of inactivity\&.
417\fBFalse\fP: the pointer is always visible [default]\&. 416\fBFalse\fP: the pointer is always visible [default]\&.
417.IP "\fBpointerColor:\fP \fIcolour\fP"
418Mouse pointer foreground colour\&.
419.IP "\fBpointerColor2:\fP \fIcolour\fP"
420Mouse pointer background colour\&.
418.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 421.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
419Specifies number of seconds before blanking the pointer [default 2]\&. 422Specifies 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" 423.IP "\fBbackspacekey:\fP \fIstring\fP"
427The string to send when the backspace key is pressed\&. If set to 424The 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, 425\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 426\fBBackspace\fP (code 8) - which can be reversed with the appropriate
430DEC private mode escape sequence\&. 427DEC private mode escape sequence\&.
447The locale to use for opening the IM\&. You can use an LC_CTYPE 444The 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 445of 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 446for the input extension to be able to input japanese characters
450while staying in another locale\&. 447while staying in another locale\&.
451option \fB-imlocale\fP\&. 448option \fB-imlocale\fP\&.
449.IP "\fBinsecure\fP"
450Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
451that echo arbitrary strings like the icon name or the locale\&. This
452could be abused if somebody gets 8-bit-clean access to your
453display, wether throuh a mail client displaying mail bodies
454unfiltered or though write(1)\&. Therefore, these sequences are
455disabled by default\&. (Note that other terminals, including xterm,
456have these sequences enabled by default)\&. You can enable them
457by setting this boolean resource or specifying \fB-insecure\fP as
458an option\&. At the moment, this enabled display-answer, locale,
459findfont, icon label and window title requests as well as dynamic
460menubar dispatch\&.
452.IP "\fBmodifier:\fP \fImodifier\fP" 461.IP "\fBmodifier:\fP \fImodifier\fP"
453Set the key to be interpreted as the Meta key to: 462Set 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, 463\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
455\fBmod4\fP, \fBmod5\fP; 464\fBmod4\fP, \fBmod5\fP;
456option \fB-mod\fP\&. 465option \fB-mod\fP\&.
457.IP "\fBanswerbackString:\fP \fIstring\fP" 466.IP "\fBanswerbackString:\fP \fIstring\fP"
458Specify the reply rxvt sends to the shell when an ENQ (control-E) 467Specify the reply rxvt sends to the shell when an ENQ (control-E)
459character is passed through\&. It may contain escape values as 468character is passed through\&. It may contain escape values as
460described in the entry on \fBkeysym\fP following\&. 469described in the entry on \fBkeysym\fP following\&.
470.IP "\fBsecondaryScreen:\fP \fIbool\fP"
471Turn on/off secondary screen (default enabled)\&.
472.IP "\fBsecondaryScroll:\fP \fIbool\fP"
473Turn on/off secondary screen scroll (default enabled)\&. If
474the this option is enabled, scrolls on the secondary screen will
475change the scrollback buffer and switching to/from the secondary screen
476will instead scroll the screen up\&.
461.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 477.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
462Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 478Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
463may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 479may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
464\en: newline, \er: return, \et: tab, \e000: octal number) or control 480\en: newline, \er: return, \et: tab, \e000: octal number) or control
465characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 481characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
514.PP 530.PP
515\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 531\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 532seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
517feature, \fBrxvt\fP must be installed setuid root on some systems\&. 533feature, \fBrxvt\fP must be installed setuid root on some systems\&.
518.SH "COLORS AND GRAPHICS" 534.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 535.PP
524In addition to the default foreground and background colours, \fBrxvt\fP 536In addition to the default foreground and background colours, \fBrxvt\fP
525can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 537can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
526versions of the same)\&. 538versions of the same)\&.
527Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 539Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
591.PP 603.PP
592Cursor change support is not yet implemented\&. 604Cursor change support is not yet implemented\&.
593.PP 605.PP
594Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 606Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
595.PP 607.PP
596Graphics support is fairly crude\&.
597.PP
598.SH "FTP LOCATION" 608.SH "FTP LOCATION"
599.PP 609.PP
600rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 610rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites
601RXVTFTPSITE() 611ftp://ftp\&.rxvt\&.org/pub/rxvt
602.PP 612.PP
603.SH "CURRENT PROJECT COORDINATOR" 613.SH "CURRENT PROJECT COORDINATOR"
604.PP 614.PP
605.IP "Project Coordinator" 615.IP "Project Coordinator"
606RXVTMAINT() RXVTMAINTEMAIL() 616Marc A\&. Lehmann <rxvt@schmorp\&.de>
607.br 617.br
608.IP "Web page maintainter" 618.IP "Web page maintainter"
609RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 619Marc A\&. Lehmann <rxvt@schmorp\&.de>
610.br 620.br
611RXVTWEBPAGE() 621<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
612.br 622.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 623.PP
622.SH "AUTHORS" 624.SH "AUTHORS"
623.PP 625.PP
624.IP "John Bovey" 626.IP "John Bovey"
625University of Kent, 1992, wrote the original Xvt\&. 627University of Kent, 1992, wrote the original Xvt\&.
626.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" 628.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
627very heavily modified Xvt and came up with Rxvt 629very heavily modified Xvt and came up with Rxvt
628.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" 630.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
629wrote the Greek Keyboard Input 631wrote the Greek Keyboard Input (no longer in code)
630.IP "mj olesen <olesen@me\&.QueensU\&.CA>" 632.IP "mj olesen <olesen@me\&.QueensU\&.CA>"
631Wrote the menu system\&. 633Wrote the menu system\&.
632.br 634.br
633Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) 635Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
634.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 636.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
635Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 637Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
636.IP "Geoff Wing <gcw@pobox\&.com>" 638.IP "Geoff Wing <gcw@pobox\&.com>"
637Rewrote screen display and text selection routines\&. 639Rewrote screen display and text selection routines\&.
640Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
641.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
642Forked rxvt-unicode, rewrote most of the display code and
643internal character handling to store text in unicode,
644improve xterm compatibility and apply numerous other bugfixes
645and extensions\&.
638.br 646.br
639Project Coordinator (changes\&.txt 2\&.4\&.6 - ) 647Project Coordinator (Changes 1\&.0 - )
648.PP

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines