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.1 by pcg, Mon Nov 24 17:28:08 2003 UTC vs.
Revision 1.2 by pcg, Thu Dec 18 00:38:07 2003 UTC

32.PP 32.PP
33Note that \fBrxvt\fP permits the resource name to be used as a long-option 33Note that \fBrxvt\fP permits the resource name to be used as a long-option
34(--/++ option) so the potential command-line options are far greater than 34(--/++ option) so the potential command-line options are far greater than
35those listed\&. 35those listed\&.
36For example: `rxvt --loginShell --color1 Orange\&'\&. 36For example: `rxvt --loginShell --color1 Orange\&'\&.
37.PP
38Also note that if you do not explictly specify a font (\fB-fn\fP and \fB-fm\fP)
39or a multichar encoding method (\fB-km\fP), rxvt will select a font for the
40preferable encoding according to your locale\&. Supported encodings are:
41\fBISO-8859-\fPn (n=\fB1\fP\&.\&.\&.\fB15\fP), \fBKOI8-R\fP, \fBKOI8-U\fP, \fBEUC-JP\fP,
42\fBShift_JIS\fP, \fBEUC-KR\fP, \fBEUC-CN\fP (aka \fBGB\fP), and \fBBig5\fP\&.
43.PP 37.PP
44The following options are available: 38The following options are available:
45.PP 39.PP
46.IP "\fB-help\fP, \fB--help\fP" 40.IP "\fB-help\fP, \fB--help\fP"
47Print out a message describing available options\&. 41Print out a message describing available options\&.
82resource \fBpointerColor\fP\&. 76resource \fBpointerColor\fP\&.
83.IP "\fB-bd\fP \fIcolour\fP" 77.IP "\fB-bd\fP \fIcolour\fP"
84The colour of the border between the xterm scrollbar and the text; 78The colour of the border between the xterm scrollbar and the text;
85resource \fBborderColor\fP\&. 79resource \fBborderColor\fP\&.
86.IP "\fB-fn\fP \fIfontname\fP" 80.IP "\fB-fn\fP \fIfontname\fP"
87Main normal text font; 81Select the fonts to be used used\&. This is a comma seperated
82list of font names that are used in turn when trying to display
83unicode characters\&. The first font defines the cell size for characters,
84pther fonts might be smaller, but not larger\&. A reasonable default list
85is appended\&.
88resource \fBfont\fP\&. 86resource \fBfont\fP\&.
89.IP "\fB-fb\fP \fIfontname\fP"
90Main bold text font;
91resource \fBboldFont\fP\&.
92.IP "\fB-fm\fP \fIfontname\fP"
93Main multicharacter font;
94resource \fBmfont\fP\&.
95.IP "\fB-km\fP \fImode\fP"
96Compile \fImultichar_languages\fP:
97Multiple-character font-set encoding mode;
98\fBeucj\fP: EUC Japanese encoding\&.
99\fBsjis\fP: Shift JIS encoding\&.
100\fBbig5\fP: BIG5 encoding\&.
101\fBgb\fP: GB encoding\&.
102\fBkr\fP: EUC Korean encoding\&.
103\fBnoenc\fP: no encoding;
104resource \fBmultichar_encoding\fP\&.
105.IP "\fB-grk\fP \fImode\fP" 87.IP "\fB-grk\fP \fImode\fP"
106Compile \fIGreek\fP: Greek keyboard translation; 88Compile \fIGreek\fP: Greek keyboard translation;
107\fBiso\fP: ISO-8859 mapping\&. 89\fBiso\fP: ISO-8859 mapping\&.
108\fBibm\fP: IBM-437 mapping; 90\fBibm\fP: IBM-437 mapping;
109resource \fBgreek_keyboard\fP\&. 91resource \fBgreek_keyboard\fP\&.
194\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 176\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
195resource \fBpreeditType\fP\&. 177resource \fBpreeditType\fP\&.
196.IP "\fB-im\fP \fItext\fP" 178.IP "\fB-im\fP \fItext\fP"
197Compile \fIXIM\fP: input method name\&. 179Compile \fIXIM\fP: input method name\&.
198resource \fBinputMethod\fP\&. 180resource \fBinputMethod\fP\&.
181.IP "\fB-imlocale\fP \fIstring\fP"
182The 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
184for the input extension to be able to input japanese characters
185while staying in another locale\&.
199.IP "\fB-mod\fP \fImodifier\fP" 186.IP "\fB-mod\fP \fImodifier\fP"
200Override detection of Meta modifier with specified key: 187Override detection of Meta modifier with specified key:
201\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 188\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
202\fBmod4\fP, \fBmod5\fP; 189\fBmod4\fP, \fBmod5\fP;
203resource \fImodifier\fP\&. 190resource \fImodifier\fP\&.
298.IP "\fBpath:\fP \fIpath\fP" 285.IP "\fBpath:\fP \fIpath\fP"
299Specify the colon-delimited search path for finding files (XPM and 286Specify the colon-delimited search path for finding files (XPM and
300menus), in addition to the paths specified by the \fBRXVTPATH\fP and 287menus), in addition to the paths specified by the \fBRXVTPATH\fP and
301\fBPATH\fP environment variables\&. 288\fBPATH\fP environment variables\&.
302.IP "\fBfont:\fP \fIfontname\fP" 289.IP "\fBfont:\fP \fIfontname\fP"
303Select the main text font used [default 7x14]; 290Select the fonts to be used used\&. This is a comma seperated
291list of font names that are used in turn when trying to display
292unicode characters\&. The first font defines the cell size for characters,
293pther fonts might be smaller, but not larger\&. A reasonable default list
294is appended\&.
304option \fB-fn\fP\&. 295option \fB-fn\fP\&.
305.IP "\fBfont\fP\fIn\fP\fB:\fP \fIfontname\fP"
306Specify the alternative font \fIn\fP\&. The default font values:
307.br
308.RS
309.HP
310.TS
311.nr 3c \n(.C
312.cp 0
313.nr 3lps \n[.s]
314.nr 3cent \n[.ce]
315.de 3init
316.ft \n[.f]
317.ps \n[.s]
318.vs \n[.v]u
319.in \n[.i]u
320.ll \n[.l]u
321.ls \n[.L]
322.ad \n[.j]
323.ie \n[.u] .fi
324.el .nf
325.ce \n[.ce]
326..
327.nr 3ind \n[.i]
328.nr 3fnt \n[.f]
329.nr 3sz \n[.s]
330.nr 3fll \n[.u]
331.nr T. 0
332.nr 3crow 0-1
333.nr 3passed 0-1
334.nr 3sflag 0
335.ds 3trans
336.ds 3quote
337.nr 3brule 1
338.nr 3supbot 0
339.eo
340.de 3rmk
341.mk \$1
342.if !'\n(.z'' \!.3rmk "\$1"
343..
344.de 3rvpt
345.vpt \$1
346.if !'\n(.z'' \!.3rvpt "\$1"
347..
348.de 3keep
349.if '\n[.z]'' \{.ds 3quote \\
350.ds 3trans \!
351.di 3section
352.nr 3sflag 1
353.in 0
354.\}
355..
356.de 3release
357.if \n[3sflag] \{.di
358.in \n[3ind]u
359.nr 3dn \n[dn]
360.ds 3quote
361.ds 3trans
362.nr 3sflag 0
363.if \n[.t]<=\n[dn] \{.nr T. 1
364.T#
365.nr 3supbot 1
366.sp \n[.t]u
367.nr 3supbot 0
368.mk #T
369.\}
370.if \n[.t]<=\n[3dn] .tm warning: page \n%: table text block will not fit on one page
371.nf
372.ls 1
373.3section
374.ls
375.rm 3section
376.\}
377..
378.nr 3tflag 0
379.de 3tkeep
380.if '\n[.z]'' \{.di 3table
381.nr 3tflag 1
382.\}
383..
384.de 3trelease
385.if \n[3tflag] \{.br
386.di
387.nr 3dn \n[dn]
388.ne \n[dn]u+\n[.V]u
389.ie \n[.t]<=\n[3dn] .tm error: page \n%: table will not fit on one page; use .TS H/.TH with a supporting macro package
390.el \{.in 0
391.ls 1
392.nf
393.3table
394.\}
395.rm 3table
396.\}
397..
398.ec
399.ce 0
400.nf
401.nr 3sep 1n
402.nr 3w0 \n(.H
403.nr 3aw0 0
404.nr 3lnw0 0
405.nr 3rnw0 0
406.nr 3w1 \n(.H
407.nr 3aw1 0
408.nr 3lnw1 0
409.nr 3rnw1 0
410.nr 3w0 \n[3w0]>?\w\[tbl]\fBfont\fP: \[tbl]
411.nr 3w1 \n[3w1]>?\w\[tbl]\ 7x14 \[tbl]
412.nr 3w0 \n[3w0]>?\w\[tbl]\fBfont1\fP: \[tbl]
413.nr 3w1 \n[3w1]>?\w\[tbl]\ 6x10 \[tbl]
414.nr 3w0 \n[3w0]>?\w\[tbl]\fBfont2\fP: \[tbl]
415.nr 3w1 \n[3w1]>?\w\[tbl]\ 6x13 \[tbl]
416.nr 3w0 \n[3w0]>?\w\[tbl]\fBfont3\fP: \[tbl]
417.nr 3w1 \n[3w1]>?\w\[tbl]\ 8x13 \[tbl]
418.nr 3w0 \n[3w0]>?\w\[tbl]\fBfont4\fP: \[tbl]
419.nr 3w1 \n[3w1]>?\w\[tbl]\ 9x15 \[tbl]
420.nr 3w0 \n[3w0]>?(\n[3lnw0]+\n[3rnw0])
421.if \n[3aw0] .nr 3w0 \n[3w0]>?(\n[3aw0]+2n)
422.nr 3w1 \n[3w1]>?(\n[3lnw1]+\n[3rnw1])
423.if \n[3aw1] .nr 3w1 \n[3w1]>?(\n[3aw1]+2n)
424.nr 3cd0 0
425.nr 3cl0 0*\n[3sep]
426.nr 3ce0 \n[3cl0]+\n[3w0]
427.nr 3cl1 \n[3ce0]+(3*\n[3sep])
428.nr 3cd1 \n[3ce0]+\n[3cl1]/2
429.nr 3ce1 \n[3cl1]+\n[3w1]
430.nr 3cd2 \n[3ce1]+(0*\n[3sep])
431.nr TW \n[3cd2]
432.if \n[3cent] \{.in +(u;\n[.l]-\n[.i]-\n[TW]/2>?-\n[.i])
433.nr 3ind \n[.i]
434.\}
435.eo
436.de T#
437.if !\n[3supbot] \{.3rvpt 0
438.mk 3vert
439.ls 1
440.ls
441.nr 3passed \n[3crow]
442.sp |\n[3vert]u
443.3rvpt 1
444.\}
445..
446.ec
447.fc 
448.3keep
449.3rmk 3rt0
450\*[3trans].nr 3crow 0
451.3keep
452.mk 3rs0
453.mk 3bot
454.3rvpt 0
455.ta \n[3ce0]u \n[3ce1]u
456\&\h'|\n[3cl0]u'\fBfont\fP: \h'|\n[3cl1]u'\ 7x14
457.nr 3bot \n[3bot]>?\n[.d]
458.sp |\n[3rs0]u
459.3rvpt 1
460.sp |\n[3bot]u
461\*[3trans].nr 3brule 1
462.3release
463.3keep
464.3rmk 3rt1
465\*[3trans].nr 3crow 1
466.3keep
467.mk 3rs1
468.mk 3bot
469.3rvpt 0
470.ta \n[3ce0]u \n[3ce1]u
471\&\h'|\n[3cl0]u'\fBfont1\fP: \h'|\n[3cl1]u'\ 6x10
472.nr 3bot \n[3bot]>?\n[.d]
473.sp |\n[3rs1]u
474.3rvpt 1
475.sp |\n[3bot]u
476\*[3trans].nr 3brule 1
477.3release
478.3keep
479.3rmk 3rt2
480\*[3trans].nr 3crow 2
481.3keep
482.mk 3rs2
483.mk 3bot
484.3rvpt 0
485.ta \n[3ce0]u \n[3ce1]u
486\&\h'|\n[3cl0]u'\fBfont2\fP: \h'|\n[3cl1]u'\ 6x13
487.nr 3bot \n[3bot]>?\n[.d]
488.sp |\n[3rs2]u
489.3rvpt 1
490.sp |\n[3bot]u
491\*[3trans].nr 3brule 1
492.3release
493.3keep
494.3rmk 3rt3
495\*[3trans].nr 3crow 3
496.3keep
497.mk 3rs3
498.mk 3bot
499.3rvpt 0
500.ta \n[3ce0]u \n[3ce1]u
501\&\h'|\n[3cl0]u'\fBfont3\fP: \h'|\n[3cl1]u'\ 8x13
502.nr 3bot \n[3bot]>?\n[.d]
503.sp |\n[3rs3]u
504.3rvpt 1
505.sp |\n[3bot]u
506\*[3trans].nr 3brule 1
507.3release
508.3keep
509.3rmk 3rt4
510\*[3trans].nr 3crow 4
511.3keep
512.mk 3rs4
513.mk 3bot
514.3rvpt 0
515.ta \n[3ce0]u \n[3ce1]u
516\&\h'|\n[3cl0]u'\fBfont4\fP: \h'|\n[3cl1]u'\ 9x15
517.nr 3bot \n[3bot]>?\n[.d]
518.sp |\n[3rs4]u
519.3rvpt 1
520.sp |\n[3bot]u
521\*[3trans].nr 3brule 1
522.3release
523.mk 3rt5
524.nr 3brule 1
525.nr T. 1
526.T#
527.3init
528.fc
529.cp \n(3c
530.TE
531.RE
532.IP "\fBboldFont:\fP \fIfontname\fP"
533Specify the name of the bold font to use if \fBcolorBD\fP has not been
534specified and it is not possible to map the default foreground colour
535to colour 8-15 [default NONE]\&. This font must be the same height and
536width as the normal font;
537option \fB-fb\fP\&.
538.IP "\fBmfont:\fP \fIfontname\fP"
539Select the main multiple-character text font used [default k14];
540option \fB-fk\fP\&.
541.IP "\fBmfont\fP\fIn\fP\fB:\fP \fIfontname\fP"
542Specify the alternative multiple-character font \fIn\fP\&. If compiled
543for multiple-character fonts, the Roman and multiple-character font
544sizes should match\&.
545.IP "\fBmultichar_encoding:\fP \fImode\fP"
546Set the encoding mode to be used when multicharacter encoding is
547received;
548\fBeucj\fP: EUC Japanese encoding [default for Kanji]\&.
549\fBsjis\fP: Shift JIS encoding\&.
550\fBbig5\fP: BIG5 encoding\&.
551\fBgb\fP: GB encoding\&.
552\fBkr\fP: EUC Korean encoding\&.
553\fBnoenc\fP: no encoding;
554option \fB-km\fP\&.
555.IP "\fBgreek_keyboard:\fP \fImode\fP" 296.IP "\fBgreek_keyboard:\fP \fImode\fP"
556Set the Greek keyboard translation mode to be used; 297Set the Greek keyboard translation mode to be used;
557\fBiso\fP: ISO-8859 mapping (elot-928) [default]\&. 298\fBiso\fP: ISO-8859 mapping (elot-928) [default]\&.
558\fBibm\fP: IBM-437 mapping (DOS codepage 737); 299\fBibm\fP: IBM-437 mapping (DOS codepage 737);
559option \fB-grk\fP\&. 300option \fB-grk\fP\&.
703\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 444\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
704option \fB-pt\fP\&. 445option \fB-pt\fP\&.
705.IP "\fBinputMethod:\fP \fIname\fP" 446.IP "\fBinputMethod:\fP \fIname\fP"
706\fIname\fP of inputMethod to use; 447\fIname\fP of inputMethod to use;
707option \fB-im\fP\&. 448option \fB-im\fP\&.
449.IP "\fBimLocale:\fP \fIname\fP"
450The 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
452for the input extension to be able to input japanese characters
453while staying in another locale\&.
454option \fB-imlocale\fP\&.
708.IP "\fBmodifier:\fP \fImodifier\fP" 455.IP "\fBmodifier:\fP \fImodifier\fP"
709Set the key to be interpreted as the Meta key to: 456Set the key to be interpreted as the Meta key to:
710\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 457\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
711\fBmod4\fP, \fBmod5\fP; 458\fBmod4\fP, \fBmod5\fP;
712option \fB-mod\fP\&. 459option \fB-mod\fP\&.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines