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.1 by pcg, Mon Nov 24 17:28:08 2003 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
29.PP 29.PP
30Note that \fBrxvt\fP permits the resource name to be used as a long-option 30Note that \fBrxvt\fP permits the resource name to be used as a long-option
31(--/++ option) so the potential command-line options are far greater than 31(--/++ option) so the potential command-line options are far greater than
32those listed\&. 32those listed\&.
33For example: `rxvt --loginShell --color1 Orange\&'\&. 33For example: `rxvt --loginShell --color1 Orange\&'\&.
34.PP
35Also note that if you do not explictly specify a font (\fB-fn\fP and \fB-fm\fP)
36or a multichar encoding method (\fB-km\fP), rxvt will select a font for the
37preferable encoding according to your locale\&. Supported encodings are:
38\fBISO-8859-\fPn (n=\fB1\fP\&.\&.\&.\fB15\fP), \fBKOI8-R\fP, \fBKOI8-U\fP, \fBEUC-JP\fP,
39\fBShift_JIS\fP, \fBEUC-KR\fP, \fBEUC-CN\fP (aka \fBGB\fP), and \fBBig5\fP\&.
40.PP 34.PP
41The following options are available: 35The following options are available:
42.PP 36.PP
43.IP "\fB-help\fP, \fB--help\fP" 37.IP "\fB-help\fP, \fB--help\fP"
44Print out a message describing available options\&. 38Print out a message describing available options\&.
57resource \fBjumpScroll\fP\&. 51resource \fBjumpScroll\fP\&.
58.IP "\fB-ip\fP|\fB+ip\fP" 52.IP "\fB-ip\fP|\fB+ip\fP"
59Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 53Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
60is \fB-tr\fP; 54is \fB-tr\fP;
61resource \fBinheritPixmap\fP\&. 55resource \fBinheritPixmap\fP\&.
56.IP "\fB-tint\fP \fIcolour\fP"
57Tint the transparent background pixmap with the given colour\&.
62.IP "\fB-bg\fP \fIcolour\fP" 58.IP "\fB-bg\fP \fIcolour\fP"
63Window background colour; 59Window background colour;
64resource \fBbackground\fP\&. 60resource \fBbackground\fP\&.
65.IP "\fB-fg\fP \fIcolour\fP" 61.IP "\fB-fg\fP \fIcolour\fP"
66Window foreground colour; 62Window foreground colour;
79resource \fBpointerColor\fP\&. 75resource \fBpointerColor\fP\&.
80.IP "\fB-bd\fP \fIcolour\fP" 76.IP "\fB-bd\fP \fIcolour\fP"
81The colour of the border between the xterm scrollbar and the text; 77The colour of the border between the xterm scrollbar and the text;
82resource \fBborderColor\fP\&. 78resource \fBborderColor\fP\&.
83.IP "\fB-fn\fP \fIfontname\fP" 79.IP "\fB-fn\fP \fIfontname\fP"
84Main normal text font; 80Select the fonts to be used used\&. This is a comma seperated
81list of font names that are used in turn when trying to display
82unicode characters\&. The first font defines the cell size for characters,
83other fonts might be smaller, but not larger\&. A reasonable default font list
84is always appended to it\&.
85resource \fBfont\fP\&. 85resource \fBfont\fP\&.
86.IP "\fB-fb\fP \fIfontname\fP"
87Main bold text font;
88resource \fBboldFont\fP\&.
89.IP "\fB-fm\fP \fIfontname\fP"
90Main multicharacter font;
91resource \fBmfont\fP\&.
92.IP "\fB-km\fP \fImode\fP"
93Compile \fImultichar_languages\fP:
94Multiple-character font-set encoding mode;
95\fBeucj\fP: EUC Japanese encoding\&.
96\fBsjis\fP: Shift JIS encoding\&.
97\fBbig5\fP: BIG5 encoding\&.
98\fBgb\fP: GB encoding\&.
99\fBkr\fP: EUC Korean encoding\&.
100\fBnoenc\fP: no encoding;
101resource \fBmultichar_encoding\fP\&.
102.IP "\fB-grk\fP \fImode\fP"
103Compile \fIGreek\fP: Greek keyboard translation;
104\fBiso\fP: ISO-8859 mapping\&.
105\fBibm\fP: IBM-437 mapping;
106resource \fBgreek_keyboard\fP\&.
107.IP "\fB-name\fP \fIname\fP" 86.IP "\fB-name\fP \fIname\fP"
108Specify the application name under which resources 87Specify the application name under which resources
109are to be obtained, rather than the default executable file name\&. 88are to be obtained, rather than the default executable file name\&.
110Name should not contain `\&.\&' or `*\&' characters\&. 89Name should not contain `\&.\&' or `*\&' characters\&.
111Also sets the icon and title name\&. 90Also sets the icon and title name\&.
135Put scrollbar on right/left; 114Put scrollbar on right/left;
136resource \fBscrollBar_right\fP\&. 115resource \fBscrollBar_right\fP\&.
137.IP "\fB-st\fP|\fB+st\fP" 116.IP "\fB-st\fP|\fB+st\fP"
138Display normal (non XTerm/NeXT) scrollbar without/with a trough; 117Display normal (non XTerm/NeXT) scrollbar without/with a trough;
139resource \fBscrollBar_floating\fP\&. 118resource \fBscrollBar_floating\fP\&.
140.IP "\fB-mcc\fP|\fB+mcc\fP"
141Compile \fImultichar_languages\fP: treat multibyte glyphs as single
142character for backspace, delete and cursor movement keys;
143resource \fBmultibyte_cursor\fP\&.
144.IP "\fB-bc\fP|\fB+bc\fP" 119.IP "\fB-bc\fP|\fB+bc\fP"
145Blink the cursor; resource \fBcursorBlink\fP\&. 120Blink the cursor; resource \fBcursorBlink\fP\&.
146.IP "\fB-iconic\fP" 121.IP "\fB-iconic\fP"
147Start iconified, if the window manager supports that option\&. 122Start iconified, if the window manager supports that option\&.
148Alternative form is \fB-ic\fP\&. 123Alternative form is \fB-ic\fP\&.
191\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 166\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
192resource \fBpreeditType\fP\&. 167resource \fBpreeditType\fP\&.
193.IP "\fB-im\fP \fItext\fP" 168.IP "\fB-im\fP \fItext\fP"
194Compile \fIXIM\fP: input method name\&. 169Compile \fIXIM\fP: input method name\&.
195resource \fBinputMethod\fP\&. 170resource \fBinputMethod\fP\&.
171.IP "\fB-imlocale\fP \fIstring\fP"
172The locale to use for opening the IM\&. You can use an LC_CTYPE
173of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
174for the input extension to be able to input japanese characters
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\&.
196.IP "\fB-mod\fP \fImodifier\fP" 180.IP "\fB-mod\fP \fImodifier\fP"
197Override detection of Meta modifier with specified key: 181Override detection of Meta modifier with specified key:
198\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,
199\fBmod4\fP, \fBmod5\fP; 183\fBmod4\fP, \fBmod5\fP;
200resource \fImodifier\fP\&. 184resource \fImodifier\fP\&.
271option \fB+j\fP\&. 255option \fB+j\fP\&.
272.IP "\fBinheritPixmap:\fP \fIboolean\fP" 256.IP "\fBinheritPixmap:\fP \fIboolean\fP"
273\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 257\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
274giving artificial transparency\&. 258giving artificial transparency\&.
275\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\&.
276.IP "\fBscrollColor:\fP \fIcolour\fP" 262.IP "\fBscrollColor:\fP \fIcolour\fP"
277Use the specified colour for the scrollbar [default #B2B2B2]\&. 263Use the specified colour for the scrollbar [default #B2B2B2]\&.
278.IP "\fBtroughColor:\fP \fIcolour\fP" 264.IP "\fBtroughColor:\fP \fIcolour\fP"
279Use the specified colour for the scrollbar\&'s trough area [default 265Use the specified colour for the scrollbar\&'s trough area [default
280#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 266#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
295.IP "\fBpath:\fP \fIpath\fP" 281.IP "\fBpath:\fP \fIpath\fP"
296Specify the colon-delimited search path for finding files (XPM and 282Specify the colon-delimited search path for finding files (XPM and
297menus), in addition to the paths specified by the \fBRXVTPATH\fP and 283menus), in addition to the paths specified by the \fBRXVTPATH\fP and
298\fBPATH\fP environment variables\&. 284\fBPATH\fP environment variables\&.
299.IP "\fBfont:\fP \fIfontname\fP" 285.IP "\fBfont:\fP \fIfontname\fP"
300Select the main text font used [default 7x14]; 286Select the fonts to be used used\&. This is a comma seperated
287list of font names that are used in turn when trying to display
288unicode characters\&. The first font defines the cell size for characters,
289other fonts might be smaller, but not larger\&. A reasonable default font list
290is always appended to this list\&.
301option \fB-fn\fP\&. 291option \fB-fn\fP\&.
302.IP "\fBfont\fP\fIn\fP\fB:\fP \fIfontname\fP"
303Specify the alternative font \fIn\fP\&. The default font values:
304.br
305.RS
306.HP
307.TS
308tab(`);
309l l .
310\fBfont\fP: `\ 7x14
311\fBfont1\fP: `\ 6x10
312\fBfont2\fP: `\ 6x13
313\fBfont3\fP: `\ 8x13
314\fBfont4\fP: `\ 9x15
315.TE
316.RE
317.IP "\fBboldFont:\fP \fIfontname\fP"
318Specify the name of the bold font to use if \fBcolorBD\fP has not been
319specified and it is not possible to map the default foreground colour
320to colour 8-15 [default NONE]\&. This font must be the same height and
321width as the normal font;
322option \fB-fb\fP\&.
323.IP "\fBmfont:\fP \fIfontname\fP"
324Select the main multiple-character text font used [default k14];
325option \fB-fk\fP\&.
326.IP "\fBmfont\fP\fIn\fP\fB:\fP \fIfontname\fP"
327Specify the alternative multiple-character font \fIn\fP\&. If compiled
328for multiple-character fonts, the Roman and multiple-character font
329sizes should match\&.
330.IP "\fBmultichar_encoding:\fP \fImode\fP"
331Set the encoding mode to be used when multicharacter encoding is
332received;
333\fBeucj\fP: EUC Japanese encoding [default for Kanji]\&.
334\fBsjis\fP: Shift JIS encoding\&.
335\fBbig5\fP: BIG5 encoding\&.
336\fBgb\fP: GB encoding\&.
337\fBkr\fP: EUC Korean encoding\&.
338\fBnoenc\fP: no encoding;
339option \fB-km\fP\&.
340.IP "\fBgreek_keyboard:\fP \fImode\fP"
341Set the Greek keyboard translation mode to be used;
342\fBiso\fP: ISO-8859 mapping (elot-928) [default]\&.
343\fBibm\fP: IBM-437 mapping (DOS codepage 737);
344option \fB-grk\fP\&.
345.IP "\fBgreektoggle_key:\fP \fIkeysym\fP"
346Set the key to toggle keyboard input between no translation and
347Greek translation [default \fBMode_switch\fP]\&.
348For more details, see the distributed file \fBREADME\&.greek\fP\&.
349.IP "\fBselectstyle:\fP \fImode\fP" 292.IP "\fBselectstyle:\fP \fImode\fP"
350Set 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
351is 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
352gives xterm style selection\&. 295gives xterm style selection\&.
353.IP "\fBscrollstyle:\fP \fImode\fP" 296.IP "\fBscrollstyle:\fP \fImode\fP"
462\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
463of seconds of inactivity\&. 406of seconds of inactivity\&.
464\fBFalse\fP: the pointer is always visible [default]\&. 407\fBFalse\fP: the pointer is always visible [default]\&.
465.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 408.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
466Specifies number of seconds before blanking the pointer [default 2]\&. 409Specifies number of seconds before blanking the pointer [default 2]\&.
467.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
468\fBTrue\fP: consider multibyte glyphs as single character for backspace,
469delete and cursor movement keys;
470option \fB-mcc\fP\&.
471\fBFalse\fP: move through all components of all glyphs;
472option \fB+mcc\fP\&.
473.IP "\fBbackspacekey:\fP \fIstring\fP" 410.IP "\fBbackspacekey:\fP \fIstring\fP"
474The 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
475\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,
476\fBBackspace\fP (code 8) - which can be reversed with the appropriate 413\fBBackspace\fP (code 8) - which can be reversed with the appropriate
477DEC private mode escape sequence\&. 414DEC private mode escape sequence\&.
488\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 425\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
489option \fB-pt\fP\&. 426option \fB-pt\fP\&.
490.IP "\fBinputMethod:\fP \fIname\fP" 427.IP "\fBinputMethod:\fP \fIname\fP"
491\fIname\fP of inputMethod to use; 428\fIname\fP of inputMethod to use;
492option \fB-im\fP\&. 429option \fB-im\fP\&.
430.IP "\fBimLocale:\fP \fIname\fP"
431The locale to use for opening the IM\&. You can use an LC_CTYPE
432of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
433for the input extension to be able to input japanese characters
434while staying in another locale\&.
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\&.
493.IP "\fBmodifier:\fP \fImodifier\fP" 446.IP "\fBmodifier:\fP \fImodifier\fP"
494Set the key to be interpreted as the Meta key to: 447Set the key to be interpreted as the Meta key to:
495\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,
496\fBmod4\fP, \fBmod5\fP; 449\fBmod4\fP, \fBmod5\fP;
497option \fB-mod\fP\&. 450option \fB-mod\fP\&.
555.PP 508.PP
556\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 509\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
557seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 510seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
558feature, \fBrxvt\fP must be installed setuid root on some systems\&. 511feature, \fBrxvt\fP must be installed setuid root on some systems\&.
559.SH "COLORS AND GRAPHICS" 512.SH "COLORS AND GRAPHICS"
560.PP
561If graphics support was enabled at compile-time, \fBrxvt\fP can be queried
562with ANSI escape sequences and can address individual pixels instead of
563text characters\&. Note the graphics support is still considered beta code\&.
564.PP 513.PP
565In addition to the default foreground and background colours, \fBrxvt\fP 514In addition to the default foreground and background colours, \fBrxvt\fP
566can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 515can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
567versions of the same)\&. 516versions of the same)\&.
568Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 517Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
632.PP 581.PP
633Cursor change support is not yet implemented\&. 582Cursor change support is not yet implemented\&.
634.PP 583.PP
635Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 584Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
636.PP 585.PP
637Graphics support is fairly crude\&.
638.PP
639.SH "FTP LOCATION" 586.SH "FTP LOCATION"
640.PP 587.PP
641rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 588rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites
642RXVTFTPSITE() 589ftp://ftp\&.rxvt\&.org/pub/rxvt
643.PP 590.PP
644.SH "CURRENT PROJECT COORDINATOR" 591.SH "CURRENT PROJECT COORDINATOR"
645.PP 592.PP
646.IP "Project Coordinator" 593.IP "Project Coordinator"
647RXVTMAINT() RXVTMAINTEMAIL() 594Marc A\&. Lehmann <rxvt@schmorp\&.de>
648.br 595.br
649.IP "Web page maintainter" 596.IP "Web page maintainter"
650RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 597Marc A\&. Lehmann <rxvt@schmorp\&.de>
651.br 598.br
652RXVTWEBPAGE() 599<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
653.br 600.br
654.IP "Mailing list"
655The Rxvt Workers <rxvt-workers@rxvt\&.org>
656mailing list has also been established for rxvt development, to
657subscribe, email to
658<rxvt-workers-subscribe@rxvt\&.org>\&.
659There is also a mailing list for announcements of new releases of
660rxvt\&. To subscribe, email to
661<rxvt-announce-subscribe@rxvt\&.org>\&.
662.PP 601.PP
663.SH "AUTHORS" 602.SH "AUTHORS"
664.PP 603.PP
665.IP "John Bovey" 604.IP "John Bovey"
666University of Kent, 1992, wrote the original Xvt\&. 605University of Kent, 1992, wrote the original Xvt\&.
667.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" 606.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
668very heavily modified Xvt and came up with Rxvt 607very heavily modified Xvt and came up with Rxvt
669.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" 608.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
670wrote the Greek Keyboard Input 609wrote the Greek Keyboard Input (no longer in code)
671.IP "mj olesen <olesen@me\&.QueensU\&.CA>" 610.IP "mj olesen <olesen@me\&.QueensU\&.CA>"
672Wrote the menu system\&. 611Wrote the menu system\&.
673.br 612.br
674Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) 613Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
675.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 614.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
676Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 615Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
677.IP "Geoff Wing <gcw@pobox\&.com>" 616.IP "Geoff Wing <gcw@pobox\&.com>"
678Rewrote screen display and text selection routines\&. 617Rewrote screen display and text selection routines\&.
618Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
619.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>"
620Rewrote most of the display code and internal character handling
621to store text in unicode\&. Numerous other fixes and extensions\&.
679.br 622.br
680Project Coordinator (changes\&.txt 2\&.4\&.6 - ) 623Project Coordinator (Changes 1\&.0 - )
624.PP

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines