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.4 by pcg, Sun Feb 22 12:58:01 2004 UTC

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\&.
79resource \fBpointerColor\fP\&. 73resource \fBpointerColor\fP\&.
80.IP "\fB-bd\fP \fIcolour\fP" 74.IP "\fB-bd\fP \fIcolour\fP"
81The colour of the border between the xterm scrollbar and the text; 75The colour of the border between the xterm scrollbar and the text;
82resource \fBborderColor\fP\&. 76resource \fBborderColor\fP\&.
83.IP "\fB-fn\fP \fIfontname\fP" 77.IP "\fB-fn\fP \fIfontname\fP"
84Main normal text font; 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
80unicode characters\&. The first font defines the cell size for characters,
81pther fonts might be smaller, but not larger\&. A reasonable default list
82is appended\&.
85resource \fBfont\fP\&. 83resource \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" 84.IP "\fB-name\fP \fIname\fP"
108Specify the application name under which resources 85Specify the application name under which resources
109are to be obtained, rather than the default executable file name\&. 86are to be obtained, rather than the default executable file name\&.
110Name should not contain `\&.\&' or `*\&' characters\&. 87Name should not contain `\&.\&' or `*\&' characters\&.
111Also sets the icon and title name\&. 88Also sets the icon and title name\&.
191\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 168\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
192resource \fBpreeditType\fP\&. 169resource \fBpreeditType\fP\&.
193.IP "\fB-im\fP \fItext\fP" 170.IP "\fB-im\fP \fItext\fP"
194Compile \fIXIM\fP: input method name\&. 171Compile \fIXIM\fP: input method name\&.
195resource \fBinputMethod\fP\&. 172resource \fBinputMethod\fP\&.
173.IP "\fB-imlocale\fP \fIstring\fP"
174The 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
176for the input extension to be able to input japanese characters
177while staying in another locale\&.
196.IP "\fB-mod\fP \fImodifier\fP" 178.IP "\fB-mod\fP \fImodifier\fP"
197Override detection of Meta modifier with specified key: 179Override detection of Meta modifier with specified key:
198\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,
199\fBmod4\fP, \fBmod5\fP; 181\fBmod4\fP, \fBmod5\fP;
200resource \fImodifier\fP\&. 182resource \fImodifier\fP\&.
295.IP "\fBpath:\fP \fIpath\fP" 277.IP "\fBpath:\fP \fIpath\fP"
296Specify the colon-delimited search path for finding files (XPM and 278Specify the colon-delimited search path for finding files (XPM and
297menus), in addition to the paths specified by the \fBRXVTPATH\fP and 279menus), in addition to the paths specified by the \fBRXVTPATH\fP and
298\fBPATH\fP environment variables\&. 280\fBPATH\fP environment variables\&.
299.IP "\fBfont:\fP \fIfontname\fP" 281.IP "\fBfont:\fP \fIfontname\fP"
300Select the main text font used [default 7x14]; 282Select the fonts to be used used\&. This is a comma seperated
283list of font names that are used in turn when trying to display
284unicode characters\&. The first font defines the cell size for characters,
285pther fonts might be smaller, but not larger\&. A reasonable default list
286is appended\&.
301option \fB-fn\fP\&. 287option \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" 288.IP "\fBselectstyle:\fP \fImode\fP"
350Set 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
351is 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
352gives xterm style selection\&. 291gives xterm style selection\&.
353.IP "\fBscrollstyle:\fP \fImode\fP" 292.IP "\fBscrollstyle:\fP \fImode\fP"
488\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 427\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
489option \fB-pt\fP\&. 428option \fB-pt\fP\&.
490.IP "\fBinputMethod:\fP \fIname\fP" 429.IP "\fBinputMethod:\fP \fIname\fP"
491\fIname\fP of inputMethod to use; 430\fIname\fP of inputMethod to use;
492option \fB-im\fP\&. 431option \fB-im\fP\&.
432.IP "\fBimLocale:\fP \fIname\fP"
433The 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
435for the input extension to be able to input japanese characters
436while staying in another locale\&.
437option \fB-imlocale\fP\&.
493.IP "\fBmodifier:\fP \fImodifier\fP" 438.IP "\fBmodifier:\fP \fImodifier\fP"
494Set the key to be interpreted as the Meta key to: 439Set 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, 440\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
496\fBmod4\fP, \fBmod5\fP; 441\fBmod4\fP, \fBmod5\fP;
497option \fB-mod\fP\&. 442option \fB-mod\fP\&.
555.PP 500.PP
556\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 501\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 502seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
558feature, \fBrxvt\fP must be installed setuid root on some systems\&. 503feature, \fBrxvt\fP must be installed setuid root on some systems\&.
559.SH "COLORS AND GRAPHICS" 504.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 505.PP
565In addition to the default foreground and background colours, \fBrxvt\fP 506In addition to the default foreground and background colours, \fBrxvt\fP
566can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 507can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
567versions of the same)\&. 508versions of the same)\&.
568Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 509Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
632.PP 573.PP
633Cursor change support is not yet implemented\&. 574Cursor change support is not yet implemented\&.
634.PP 575.PP
635Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 576Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
636.PP 577.PP
637Graphics support is fairly crude\&.
638.PP
639.SH "FTP LOCATION" 578.SH "FTP LOCATION"
640.PP 579.PP
641rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 580rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites
642RXVTFTPSITE() 581RXVTFTPSITE()
643.PP 582.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