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.11 by pcg, Sat May 8 17:18:21 2004 UTC

1.if !\n(.g .ab GNU tbl requires GNU troff. 1.if !\n(.g .ab GNU tbl requires GNU troff.
2.if !dTS .ds TS 2.if !dTS .ds TS
3.if !dTE .ds TE 3.if !dTE .ds TE
4.TH "RXVT" "1" "RXVTDATE()" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-04-02" "X Version 11" "X Tools"
5.SH "NAME" 5.SH "NAME"
6rxvt (ouR XVT) \- a VT102 emulator for the X window system 6rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
7.PP 7.PP
8.SH "SYNOPSIS" 8.SH "SYNOPSIS"
9.PP 9.PP
10\fBrxvt\fP [options] [-e command [ args ]] 10\fBurxvt\fP [options] [-e command [ args ]]
11.PP 11.PP
12.SH "DESCRIPTION" 12.SH "DESCRIPTION"
13.PP 13.PP
14\fBrxvt\fP, version \fBRXVTVERSION()\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB2\&.7\fP, is a colour vt102 terminal emulator
15intended as an \fIxterm\fP(1) replacement for users who do not require 15intended as an \fIxterm\fP(1) replacement for users who do not require
16features such as Tektronix 4014 emulation and toolkit-style configurability\&. 16features such as Tektronix 4014 emulation and toolkit-style configurability\&.
17As a result, \fBrxvt\fP uses much less swap space -- a significant 17As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
18advantage on a machine serving many X sessions\&. 18advantage on a machine serving many X sessions\&.
19.PP 19.PP
20.PP 20.PP
21.SH "OPTIONS" 21.SH "OPTIONS"
22.PP 22.PP
23The \fBrxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. 23The \fBurxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&.
24In keeping with the smaller-is-better philosophy, options may be eliminated 24In keeping with the smaller-is-better philosophy, options may be eliminated
25or default values chosen at compile-time, so options and defaults listed 25or default values chosen at compile-time, so options and defaults listed
26may not accurately reflect the version installed on your system\&. 26may not accurately reflect the version installed on your system\&.
27`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&. 27`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&.
28Option descriptions may be prefixed with which compile option each is 28Option descriptions may be prefixed with which compile option each is
29dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP 29dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP
30line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled 30line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled
31into your version\&. 31into your version\&.
32.PP 32.PP
33Note that \fBrxvt\fP permits the resource name to be used as a long-option 33Note that \fBurxvt\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\&.
… …
60resource \fBjumpScroll\fP\&. 54resource \fBjumpScroll\fP\&.
61.IP "\fB-ip\fP|\fB+ip\fP" 55.IP "\fB-ip\fP|\fB+ip\fP"
62Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 56Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
63is \fB-tr\fP; 57is \fB-tr\fP;
64resource \fBinheritPixmap\fP\&. 58resource \fBinheritPixmap\fP\&.
59.IP "\fB-tint\fP \fIcolour\fP"
60Tint the transparent background pixmap with the given colour\&.
65.IP "\fB-bg\fP \fIcolour\fP" 61.IP "\fB-bg\fP \fIcolour\fP"
66Window background colour; 62Window background colour;
67resource \fBbackground\fP\&. 63resource \fBbackground\fP\&.
68.IP "\fB-fg\fP \fIcolour\fP" 64.IP "\fB-fg\fP \fIcolour\fP"
69Window foreground colour; 65Window foreground colour;
… …
82resource \fBpointerColor\fP\&. 78resource \fBpointerColor\fP\&.
83.IP "\fB-bd\fP \fIcolour\fP" 79.IP "\fB-bd\fP \fIcolour\fP"
84The colour of the border between the xterm scrollbar and the text; 80The colour of the border between the xterm scrollbar and the text;
85resource \fBborderColor\fP\&. 81resource \fBborderColor\fP\&.
86.IP "\fB-fn\fP \fIfontname\fP" 82.IP "\fB-fn\fP \fIfontname\fP"
87Main normal text font; 83Select the fonts to be used used\&. This is a comma seperated
84list of font names that are used in turn when trying to display
85unicode characters\&. The first font defines the cell size for characters,
86other fonts might be smaller, but not larger\&. A reasonable default font list
87is always appended to it\&.
88resource \fBfont\fP\&. 88resource \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"
106Compile \fIGreek\fP: Greek keyboard translation;
107\fBiso\fP: ISO-8859 mapping\&.
108\fBibm\fP: IBM-437 mapping;
109resource \fBgreek_keyboard\fP\&.
110.IP "\fB-name\fP \fIname\fP" 89.IP "\fB-name\fP \fIname\fP"
111Specify the application name under which resources 90Specify the application name under which resources
112are to be obtained, rather than the default executable file name\&. 91are to be obtained, rather than the default executable file name\&.
113Name should not contain `\&.\&' or `*\&' characters\&. 92Name should not contain `\&.\&' or `*\&' characters\&.
114Also sets the icon and title name\&. 93Also sets the icon and title name\&.
… …
138Put scrollbar on right/left; 117Put scrollbar on right/left;
139resource \fBscrollBar_right\fP\&. 118resource \fBscrollBar_right\fP\&.
140.IP "\fB-st\fP|\fB+st\fP" 119.IP "\fB-st\fP|\fB+st\fP"
141Display normal (non XTerm/NeXT) scrollbar without/with a trough; 120Display normal (non XTerm/NeXT) scrollbar without/with a trough;
142resource \fBscrollBar_floating\fP\&. 121resource \fBscrollBar_floating\fP\&.
143.IP "\fB-mcc\fP|\fB+mcc\fP"
144Compile \fImultichar_languages\fP: treat multibyte glyphs as single
145character for backspace, delete and cursor movement keys;
146resource \fBmultibyte_cursor\fP\&.
147.IP "\fB-bc\fP|\fB+bc\fP" 122.IP "\fB-bc\fP|\fB+bc\fP"
148Blink the cursor; resource \fBcursorBlink\fP\&. 123Blink the cursor; resource \fBcursorBlink\fP\&.
149.IP "\fB-iconic\fP" 124.IP "\fB-iconic\fP"
150Start iconified, if the window manager supports that option\&. 125Start iconified, if the window manager supports that option\&.
151Alternative form is \fB-ic\fP\&. 126Alternative form is \fB-ic\fP\&.
… …
169This option specifies the name of the terminal type to be set in the 144This option specifies the name of the terminal type to be set in the
170\fBTERM\fP environment variable\&. This terminal type must exist in the 145\fBTERM\fP environment variable\&. This terminal type must exist in the
171\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; 146\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
172resource \fBtermName\fP\&. 147resource \fBtermName\fP\&.
173.IP "\fB-e\fP \fIcommand [arguments]\fP" 148.IP "\fB-e\fP \fIcommand [arguments]\fP"
174Run the command with its command-line arguments in the \fBrxvt\fP 149Run the command with its command-line arguments in the \fBurxvt\fP
175window; also sets the window title and icon name to be the basename 150window; also sets the window title and icon name to be the basename
176of the program being executed if neither \fI-title\fP (\fI-T\fP) nor 151of the program being executed if neither \fI-title\fP (\fI-T\fP) nor
177\fI-n\fP are given on the command line\&. If this option is used, it 152\fI-n\fP are given on the command line\&. If this option is used, it
178must be the last on the command-line\&. If there is no \fB-e\fP option 153must be the last on the command-line\&. If there is no \fB-e\fP option
179then the default is to run the program specified by the \fBSHELL\fP 154then the default is to run the program specified by the \fBSHELL\fP
… …
194\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 169\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
195resource \fBpreeditType\fP\&. 170resource \fBpreeditType\fP\&.
196.IP "\fB-im\fP \fItext\fP" 171.IP "\fB-im\fP \fItext\fP"
197Compile \fIXIM\fP: input method name\&. 172Compile \fIXIM\fP: input method name\&.
198resource \fBinputMethod\fP\&. 173resource \fBinputMethod\fP\&.
174.IP "\fB-imlocale\fP \fIstring\fP"
175The locale to use for opening the IM\&. You can use an LC_CTYPE
176of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
177for the input extension to be able to input japanese characters
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\&.
199.IP "\fB-mod\fP \fImodifier\fP" 183.IP "\fB-mod\fP \fImodifier\fP"
200Override detection of Meta modifier with specified key: 184Override detection of Meta modifier with specified key:
201\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,
202\fBmod4\fP, \fBmod5\fP; 186\fBmod4\fP, \fBmod5\fP;
203resource \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\&.
204.IP "\fB-xrm\fP \fIresourcestring\fP" 194.IP "\fB-xrm\fP \fIresourcestring\fP"
205No effect on rxvt\&. Simply passes through an argument to be made 195No effect on rxvt\&. Simply passes through an argument to be made
206available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 196available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
207in some window managers\&. 197in some window managers\&.
208.SH "RESOURCES (available also as long-options)" 198.SH "RESOURCES (available also as long-options)"
209.PP 199.PP
210Note: `rxvt --help\&' gives a list of all resources (long options) compiled 200Note: `rxvt --help\&' gives a list of all resources (long options) compiled
211into your version\&. 201into your version\&.
212If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 202If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists
213\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 203\fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in
214XAPPLOADDIR/Rxvt (compile-time defined: usually 204XAPPLOADDIR/Rxvt (compile-time defined: usually
215\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 205\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP,
216or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 206or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when
217reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 207reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and
218\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 208\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both
219\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 209\fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name
220\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 210\fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and
221key-handling, to be shared between different \fBrxvt\fP configurations\&. 211key-handling, to be shared between different \fBurxvt\fP configurations\&.
222If no resources are specified, suitable defaults will be used\&. 212If no resources are specified, suitable defaults will be used\&.
223Command-line arguments can be used to override resource settings\&. The 213Command-line arguments can be used to override resource settings\&. The
224following resources are allowed: 214following resources are allowed:
225.PP 215.PP
226.IP "\fBgeometry:\fP \fIgeom\fP" 216.IP "\fBgeometry:\fP \fIgeom\fP"
… …
274option \fB+j\fP\&. 264option \fB+j\fP\&.
275.IP "\fBinheritPixmap:\fP \fIboolean\fP" 265.IP "\fBinheritPixmap:\fP \fIboolean\fP"
276\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 266\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
277giving artificial transparency\&. 267giving artificial transparency\&.
278\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\&.
279.IP "\fBscrollColor:\fP \fIcolour\fP" 271.IP "\fBscrollColor:\fP \fIcolour\fP"
280Use the specified colour for the scrollbar [default #B2B2B2]\&. 272Use the specified colour for the scrollbar [default #B2B2B2]\&.
281.IP "\fBtroughColor:\fP \fIcolour\fP" 273.IP "\fBtroughColor:\fP \fIcolour\fP"
282Use the specified colour for the scrollbar\&'s trough area [default 274Use the specified colour for the scrollbar\&'s trough area [default
283#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 275#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
298.IP "\fBpath:\fP \fIpath\fP" 290.IP "\fBpath:\fP \fIpath\fP"
299Specify the colon-delimited search path for finding files (XPM and 291Specify the colon-delimited search path for finding files (XPM and
300menus), in addition to the paths specified by the \fBRXVTPATH\fP and 292menus), in addition to the paths specified by the \fBRXVTPATH\fP and
301\fBPATH\fP environment variables\&. 293\fBPATH\fP environment variables\&.
302.IP "\fBfont:\fP \fIfontname\fP" 294.IP "\fBfont:\fP \fIfontname\fP"
303Select the main text font used [default 7x14]; 295Select the fonts to be used used\&. This is a comma seperated
296list of font names that are used in turn when trying to display
297unicode characters\&. The first font defines the cell size for characters,
298other fonts might be smaller, but not larger\&. A reasonable default font list
299is always appended to this list\&.
304option \fB-fn\fP\&. 300option \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"
556Set the Greek keyboard translation mode to be used;
557\fBiso\fP: ISO-8859 mapping (elot-928) [default]\&.
558\fBibm\fP: IBM-437 mapping (DOS codepage 737);
559option \fB-grk\fP\&.
560.IP "\fBgreektoggle_key:\fP \fIkeysym\fP"
561Set the key to toggle keyboard input between no translation and
562Greek translation [default \fBMode_switch\fP]\&.
563For more details, see the distributed file \fBREADME\&.greek\fP\&.
564.IP "\fBselectstyle:\fP \fImode\fP" 301.IP "\fBselectstyle:\fP \fImode\fP"
565Set 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
566is 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
567gives xterm style selection\&. 304gives xterm style selection\&.
568.IP "\fBscrollstyle:\fP \fImode\fP" 305.IP "\fBscrollstyle:\fP \fImode\fP"
569Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 306Set scrollbar style to \fBurxvt\fP, \fBnext\fP or \fBxterm\fP
570.IP "\fBtitle:\fP \fIstring\fP" 307.IP "\fBtitle:\fP \fIstring\fP"
571Set window title string, the default title is the command-line 308Set window title string, the default title is the command-line
572specified after the \fB-e\fP option, if any, otherwise the application 309specified after the \fB-e\fP option, if any, otherwise the application
573name; 310name;
574option \fB-title\fP\&. 311option \fB-title\fP\&.
… …
677\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
678of seconds of inactivity\&. 415of seconds of inactivity\&.
679\fBFalse\fP: the pointer is always visible [default]\&. 416\fBFalse\fP: the pointer is always visible [default]\&.
680.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 417.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
681Specifies number of seconds before blanking the pointer [default 2]\&. 418Specifies number of seconds before blanking the pointer [default 2]\&.
682.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
683\fBTrue\fP: consider multibyte glyphs as single character for backspace,
684delete and cursor movement keys;
685option \fB-mcc\fP\&.
686\fBFalse\fP: move through all components of all glyphs;
687option \fB+mcc\fP\&.
688.IP "\fBbackspacekey:\fP \fIstring\fP" 419.IP "\fBbackspacekey:\fP \fIstring\fP"
689The string to send when the backspace key is pressed\&. If set to 420The string to send when the backspace key is pressed\&. If set to
690\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 421\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
691\fBBackspace\fP (code 8) - which can be reversed with the appropriate 422\fBBackspace\fP (code 8) - which can be reversed with the appropriate
692DEC private mode escape sequence\&. 423DEC private mode escape sequence\&.
… …
703\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 434\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
704option \fB-pt\fP\&. 435option \fB-pt\fP\&.
705.IP "\fBinputMethod:\fP \fIname\fP" 436.IP "\fBinputMethod:\fP \fIname\fP"
706\fIname\fP of inputMethod to use; 437\fIname\fP of inputMethod to use;
707option \fB-im\fP\&. 438option \fB-im\fP\&.
439.IP "\fBimLocale:\fP \fIname\fP"
440The locale to use for opening the IM\&. You can use an LC_CTYPE
441of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
442for the input extension to be able to input japanese characters
443while staying in another locale\&.
444option \fB-imlocale\fP\&.
445.IP "\fBinsecure\fP"
446Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
447that echo arbitrary strings like the icon name or the locale\&. This
448could be abused if somebody gets 8-bit-clean access to your
449display, wether throuh a mail client displaying mail bodies
450unfiltered or though write(1)\&. Therefore, these sequences are
451disabled by default\&. (Note that other terminals, including xterm,
452have these sequences enabled by default)\&. You can enable them
453by setting this boolean resource or specifying \fB-insecure\fP as
454an option\&. At the moment, this enabled display-answer, locale,
455findfont, icon label and window title requests as well as dynamic
456menubar dispatch\&.
708.IP "\fBmodifier:\fP \fImodifier\fP" 457.IP "\fBmodifier:\fP \fImodifier\fP"
709Set the key to be interpreted as the Meta key to: 458Set 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, 459\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
711\fBmod4\fP, \fBmod5\fP; 460\fBmod4\fP, \fBmod5\fP;
712option \fB-mod\fP\&. 461option \fB-mod\fP\&.
713.IP "\fBanswerbackString:\fP \fIstring\fP" 462.IP "\fBanswerbackString:\fP \fIstring\fP"
714Specify the reply rxvt sends to the shell when an ENQ (control-E) 463Specify the reply rxvt sends to the shell when an ENQ (control-E)
715character is passed through\&. It may contain escape values as 464character is passed through\&. It may contain escape values as
716described in the entry on \fBkeysym\fP following\&. 465described in the entry on \fBkeysym\fP following\&.
466.IP "\fBsecondaryScreen:\fP \fIbool\fP"
467Turn on/off secondary screen (default enabled)\&.
468.IP "\fBsecondaryScroll:\fP \fIbool\fP"
469Turn on/off secondary screen scroll (default enabled)\&. If
470the this option is enabled, scrolls on the secondary screen will
471change the scrollback buffer and switching to/from the secondary screen
472will instead scroll the screen up\&.
717.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 473.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
718Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 474Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
719may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 475may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
720\en: newline, \er: return, \et: tab, \e000: octal number) or control 476\en: newline, \er: return, \et: tab, \e000: octal number) or control
721characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 477characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
722double quotes so that it can start or end with whitespace\&. The 478double quotes so that it can start or end with whitespace\&. The
723intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This 479intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
724resource is only available when compiled with KEYSYM_RESOURCE\&. 480resource is only available when compiled with KEYSYM_RESOURCE\&.
725.SH "THE SCROLLBAR" 481.SH "THE SCROLLBAR"
726.PP 482.PP
727Lines of text that scroll off the top of the \fBrxvt\fP window (resource: 483Lines of text that scroll off the top of the \fBurxvt\fP window (resource:
728\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. 484\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&.
729The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly 485The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly
730intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour 486intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
731mimics that of \fIxterm\fP 487mimics that of \fIxterm\fP
732.PP 488.PP
733Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. 489Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
734Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. 490Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
… …
755region and release; Right click to extend the marked region; 511region and release; Right click to extend the marked region;
756Left double-click to select a word; Left triple-click to select 512Left double-click to select a word; Left triple-click to select
757the entire line\&. 513the entire line\&.
758.IP "\fBInsertion\fP:" 514.IP "\fBInsertion\fP:"
759Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) 515Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
760in an \fBrxvt\fP window causes the current text selection to be inserted 516in an \fBurxvt\fP window causes the current text selection to be inserted
761as if it had been typed on the keyboard\&. 517as if it had been typed on the keyboard\&.
762.SH "CHANGING FONTS" 518.SH "CHANGING FONTS"
763.PP 519.PP
764You can change fonts on-the-fly, which is to say cycle through the default 520You can change fonts on-the-fly, which is to say cycle through the default
765font and others of various sizes, by using \fBShift-KP_Add\fP and 521font and others of various sizes, by using \fBShift-KP_Add\fP and
766\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with 522\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
767\fBAlt->\fP and \fBAlt-<\fP, where the actual key 523\fBAlt->\fP and \fBAlt-<\fP, where the actual key
768can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. 524can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
769.SH "LOGIN STAMP" 525.SH "LOGIN STAMP"
770.PP 526.PP
771\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 527\fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
772seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 528seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
773feature, \fBrxvt\fP must be installed setuid root on some systems\&. 529feature, \fBurxvt\fP must be installed setuid root on some systems\&.
774.SH "COLORS AND GRAPHICS" 530.SH "COLORS AND GRAPHICS"
775.PP 531.PP
776If graphics support was enabled at compile-time, \fBrxvt\fP can be queried
777with ANSI escape sequences and can address individual pixels instead of
778text characters\&. Note the graphics support is still considered beta code\&.
779.PP
780In addition to the default foreground and background colours, \fBrxvt\fP 532In addition to the default foreground and background colours, \fBurxvt\fP
781can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 533can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
782versions of the same)\&. 534versions of the same)\&.
783Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 535Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
784.PP 536.PP
785.TS 537.TS
… …
1266.IP "\fBrxvt -fg Black -bg White -rv\fP" 1018.IP "\fBrxvt -fg Black -bg White -rv\fP"
1267would yield White on Black, while on \fIxterm\fP(1) it would yield 1019would yield White on Black, while on \fIxterm\fP(1) it would yield
1268Black on White\&. 1020Black on White\&.
1269.SH "ENVIRONMENT" 1021.SH "ENVIRONMENT"
1270.PP 1022.PP
1271\fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and 1023\fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and
1272\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window 1024\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window
1273id number of the \fBrxvt\fP window and it also uses and sets the environment 1025id number of the \fBurxvt\fP window and it also uses and sets the environment
1274variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses 1026variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses
1275the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. 1027the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
1276.SH "FILES" 1028.SH "FILES"
1277.PP 1029.PP
1278.IP "\fB/etc/utmp\fP" 1030.IP "\fB/etc/utmp\fP"
1279System file for login records\&. 1031System file for login records\&.
… …
1294.PP 1046.PP
1295Cursor change support is not yet implemented\&. 1047Cursor change support is not yet implemented\&.
1296.PP 1048.PP
1297Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1049Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1298.PP 1050.PP
1299Graphics support is fairly crude\&.
1300.PP
1301.SH "FTP LOCATION" 1051.SH "FTP LOCATION"
1302.PP 1052.PP
1303rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 1053rxvt-2\&.7\&.tar\&.gz can be found at the following ftp sites
1304RXVTFTPSITE() 1054ftp://ftp\&.rxvt\&.org/pub/rxvt
1305.PP 1055.PP
1306.SH "CURRENT PROJECT COORDINATOR" 1056.SH "CURRENT PROJECT COORDINATOR"
1307.PP 1057.PP
1308.IP "Project Coordinator" 1058.IP "Project Coordinator"
1309RXVTMAINT() RXVTMAINTEMAIL() 1059Marc A\&. Lehmann <rxvt@schmorp\&.de>
1310.br 1060.br
1311.IP "Web page maintainter" 1061.IP "Web page maintainter"
1312RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 1062Marc A\&. Lehmann <rxvt@schmorp\&.de>
1313.br 1063.br
1314RXVTWEBPAGE() 1064<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
1315.br 1065.br
1316.IP "Mailing list"
1317The Rxvt Workers <rxvt-workers@rxvt\&.org>
1318mailing list has also been established for rxvt development, to
1319subscribe, email to
1320<rxvt-workers-subscribe@rxvt\&.org>\&.
1321There is also a mailing list for announcements of new releases of
1322rxvt\&. To subscribe, email to
1323<rxvt-announce-subscribe@rxvt\&.org>\&.
1324.PP 1066.PP
1325.SH "AUTHORS" 1067.SH "AUTHORS"
1326.PP 1068.PP
1327.IP "John Bovey" 1069.IP "John Bovey"
1328University of Kent, 1992, wrote the original Xvt\&. 1070University of Kent, 1992, wrote the original Xvt\&.
1329.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" 1071.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
1330very heavily modified Xvt and came up with Rxvt 1072very heavily modified Xvt and came up with Rxvt
1331.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" 1073.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
1332wrote the Greek Keyboard Input 1074wrote the Greek Keyboard Input (no longer in code)
1333.IP "mj olesen <olesen@me\&.QueensU\&.CA>" 1075.IP "mj olesen <olesen@me\&.QueensU\&.CA>"
1334Wrote the menu system\&. 1076Wrote the menu system\&.
1335.br 1077.br
1336Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) 1078Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
1337.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1079.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1338Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1080Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1339.IP "Geoff Wing <gcw@pobox\&.com>" 1081.IP "Geoff Wing <gcw@pobox\&.com>"
1340Rewrote screen display and text selection routines\&. 1082Rewrote screen display and text selection routines\&.
1083Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1084.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1085Forked rxvt-unicode\&. Rewrote most of the display code and
1086internal character handling to store text in unicode,
1087improve xterm compatibility and numerous other bugfixes
1088and extensions\&.
1341.br 1089.br
1342Project Coordinator (changes\&.txt 2\&.4\&.6 - ) 1090Project Coordinator (Changes 1\&.0 - )
1091.PP

Diff Legend

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