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.20 by root, Sat Jul 31 15:32:50 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-07-31" "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\fBrxvt\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 \fB3\&.3\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
… …
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\&.
… …
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-fade\fP \fInumber\fP"
60Fade the text by the given percentage when focus is lost\&.
61.IP "\fB-tint\fP \fIcolour\fP"
62Tint the transparent background pixmap with the given colour when
63transparency is enabled with \fB-tr\fP or \fB-ip\fP\&. You can also
64emulate the "shading" or "brigthness change" option known from
65other terminal programs using gray10 (gray20, etc\&.) colour
66strings\&.
65.IP "\fB-bg\fP \fIcolour\fP" 67.IP "\fB-bg\fP \fIcolour\fP"
66Window background colour; 68Window background colour;
67resource \fBbackground\fP\&. 69resource \fBbackground\fP\&.
68.IP "\fB-fg\fP \fIcolour\fP" 70.IP "\fB-fg\fP \fIcolour\fP"
69Window foreground colour; 71Window foreground colour;
70resource \fBforeground\fP\&. 72resource \fBforeground\fP\&.
71.IP "\fB-pixmap:\fP \fIfile[;geom]\fP" 73.IP "\fB-pixmap\fP \fIfile[;geom]\fP"
72Compile \fIXPM\fP: Specify XPM file for the background and also 74Compile \fIXPM\fP: Specify XPM file for the background and also
73optionally specify its scaling with a geometry string\&. Note you 75optionally specify its scaling with a geometry string\&. Note you
74may need to add quotes to avoid special shell interpretation of 76may need to add quotes to avoid special shell interpretation of
75the `;\&' in the command-line; 77the `;\&' in the command-line;
76resource \fBbackgroundPixmap\fP\&. 78resource \fBbackgroundPixmap\fP\&.
77.IP "\fB-cr\fP \fIcolour\fP" 79.IP "\fB-cr\fP \fIcolour\fP"
78The cursor colour; 80The cursor colour;
79resource \fBcursorColor\fP\&. 81resource \fBcursorColor\fP\&.
80.IP "\fB-pr\fP \fIcolour\fP" 82.IP "\fB-pr\fP \fIcolour\fP"
81The mouse pointer colour; 83The mouse pointer foreground colour;
82resource \fBpointerColor\fP\&. 84resource \fBpointerColor\fP\&.
85.IP "\fB-pr2\fP \fIcolour\fP"
86The mouse pointer background colour;
87resource \fBpointerColor2\fP\&.
83.IP "\fB-bd\fP \fIcolour\fP" 88.IP "\fB-bd\fP \fIcolour\fP"
84The colour of the border between the xterm scrollbar and the text; 89The colour of the border between the xterm scrollbar and the text;
85resource \fBborderColor\fP\&. 90resource \fBborderColor\fP\&.
86.IP "\fB-fn\fP \fIfontname\fP" 91.IP "\fB-fn\fP \fIfontname\fP"
87Main normal text font; 92Select the fonts to be used\&.
93This is a comma seperated list of font names that are used in turn when
94trying to display Unicode characters\&.
95The first font defines the cell size for characters; other fonts might
96be smaller, but not larger\&.
97A reasonable default font list is always appended to it\&.
88resource \fBfont\fP\&. 98resource \fBfont\fP\&.
89.IP "\fB-fb\fP \fIfontname\fP" 99.IP "\fB-rb\fP|\fB+rb\fP"
90Main bold text font; 100Enable "real bold" support\&.
101When this option is on, bold text will be displayed using the first
102available bold font in the font list\&.
103Bold fonts should thus be specified in the font list after their
104corresponding regular fonts\&.
105If no bold font can be found, a regular font will be used\&.
91resource \fBboldFont\fP\&. 106resource \fBrealBold\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" 107.IP "\fB-name\fP \fIname\fP"
111Specify the application name under which resources 108Specify the application name under which resources
112are to be obtained, rather than the default executable file name\&. 109are to be obtained, rather than the default executable file name\&.
113Name should not contain `\&.\&' or `*\&' characters\&. 110Name should not contain `\&.\&' or `*\&' characters\&.
114Also sets the icon and title name\&. 111Also sets the icon and title name\&.
… …
138Put scrollbar on right/left; 135Put scrollbar on right/left;
139resource \fBscrollBar_right\fP\&. 136resource \fBscrollBar_right\fP\&.
140.IP "\fB-st\fP|\fB+st\fP" 137.IP "\fB-st\fP|\fB+st\fP"
141Display normal (non XTerm/NeXT) scrollbar without/with a trough; 138Display normal (non XTerm/NeXT) scrollbar without/with a trough;
142resource \fBscrollBar_floating\fP\&. 139resource \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" 140.IP "\fB-bc\fP|\fB+bc\fP"
148Blink the cursor; resource \fBcursorBlink\fP\&. 141Blink the cursor; resource \fBcursorBlink\fP\&.
149.IP "\fB-iconic\fP" 142.IP "\fB-iconic\fP"
150Start iconified, if the window manager supports that option\&. 143Start iconified, if the window manager supports that option\&.
151Alternative form is \fB-ic\fP\&. 144Alternative form is \fB-ic\fP\&.
… …
194\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 187\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
195resource \fBpreeditType\fP\&. 188resource \fBpreeditType\fP\&.
196.IP "\fB-im\fP \fItext\fP" 189.IP "\fB-im\fP \fItext\fP"
197Compile \fIXIM\fP: input method name\&. 190Compile \fIXIM\fP: input method name\&.
198resource \fBinputMethod\fP\&. 191resource \fBinputMethod\fP\&.
192.IP "\fB-imlocale\fP \fIstring\fP"
193The locale to use for opening the IM\&. You can use an LC_CTYPE
194of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
195for the input extension to be able to input japanese characters
196while staying in another locale\&.
197.IP "\fB-insecure\fP"
198Enable "insecure" mode, which currently enables most of the escape
199sequences that echo strings\&. See the resource \fBinsecure\fP for
200more info\&.
199.IP "\fB-mod\fP \fImodifier\fP" 201.IP "\fB-mod\fP \fImodifier\fP"
200Override detection of Meta modifier with specified key: 202Override detection of Meta modifier with specified key:
201\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 203\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
202\fBmod4\fP, \fBmod5\fP; 204\fBmod4\fP, \fBmod5\fP;
203resource \fImodifier\fP\&. 205resource \fImodifier\fP\&.
206.IP "\fB-ssc\fP|\fB+ssc\fP"
207Turn on/off secondary screen (default enabled);
208resource \fBsecondaryScreen\fP\&.
209.IP "\fB-ssr\fP|\fB+ssr\fP"
210Turn on/off secondary screen scroll (default enabled);
211resource \fBsecondaryScroll\fP\&.
204.IP "\fB-xrm\fP \fIresourcestring\fP" 212.IP "\fB-xrm\fP \fIresourcestring\fP"
205No effect on rxvt\&. Simply passes through an argument to be made 213No effect on rxvt\&. Simply passes through an argument to be made
206available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 214available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
207in some window managers\&. 215in some window managers\&.
208.SH "RESOURCES (available also as long-options)" 216.SH "RESOURCES (available also as long-options)"
209.PP 217.PP
210Note: `rxvt --help\&' gives a list of all resources (long options) compiled 218Note: `rxvt --help\&' gives a list of all resources (long options) compiled
211into your version\&. 219into your version\&.
220.PP
221There are two different methods that rxvt can use to get the
222Xresource data: using the X libraries (Xrm*-functions) or internal Xresources
223reader (\fB~/\&.Xdefaults\fP)\&. For the first method (ie\&. \fBrxvt -h\fP lists
224\fBXGetDefaults\fP), you can set and change the resources using X11
225tools like \fBxset\fP\&. Many distribution do also load settings from the
226\fB~/\&.Xresources\fP file when X starts\&.
227.PP
212If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 228If compiled with internal Xresources support (i\&.e\&. \fBrxvt
213\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 229-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
214XAPPLOADDIR/Rxvt (compile-time defined: usually 230defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
215\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 231\fB/usr/lib/X11/app-defaults/URxvt\fP) and resources set in
216or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 232\fB~/\&.Xdefaults\fP, or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&.
217reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 233Note that when reading X resources, \fBrxvt\fP recognizes two class
218\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 234names: \fBXTerm\fP and \fBURxvt\fP\&. The class name \fBRxvt\fP allows resources
219\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 235common to both \fBrxvt\fP and the original \fIrxvt\fP to be easily configured,
220\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 236while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
221key-handling, to be shared between different \fBrxvt\fP configurations\&. 237notably colours and key-handling, to be shared between different
222If no resources are specified, suitable defaults will be used\&. 238\fBrxvt\fP configurations\&. If no resources are specified, suitable
223Command-line arguments can be used to override resource settings\&. The 239defaults will be used\&. Command-line arguments can be used to override
224following resources are allowed: 240resource settings\&. The following resources are allowed:
225.PP 241.PP
226.IP "\fBgeometry:\fP \fIgeom\fP" 242.IP "\fBgeometry:\fP \fIgeom\fP"
227Create the window with the specified X window geometry [default 243Create the window with the specified X window geometry [default
22880x24]; 24480x24];
229option \fB-geometry\fP\&. 245option \fB-geometry\fP\&.
… …
244but the actual colour names used are listed in the 260but the actual colour names used are listed in the
245\fBCOLORS AND GRAPHICS\fP section\&. 261\fBCOLORS AND GRAPHICS\fP section\&.
246.IP "\fBcolorBD:\fP \fIcolour\fP" 262.IP "\fBcolorBD:\fP \fIcolour\fP"
247Use the specified colour to display bold characters when the 263Use the specified colour to display bold characters when the
248foreground colour is the default\&. 264foreground colour is the default\&.
265This option will be ignored if \fBrealBold\fP is enabled\&.
249.IP "\fBcolorUL:\fP \fIcolour\fP" 266.IP "\fBcolorUL:\fP \fIcolour\fP"
250Use the specified colour to display underlined characters when the 267Use the specified colour to display underlined characters when the
251foreground colour is the default\&. 268foreground colour is the default\&.
252.IP "\fBcolorRV:\fP \fIcolour\fP" 269.IP "\fBcolorRV:\fP \fIcolour\fP"
253Use the specified colour as the background for reverse video 270Use the specified colour as the background for reverse video
… …
274option \fB+j\fP\&. 291option \fB+j\fP\&.
275.IP "\fBinheritPixmap:\fP \fIboolean\fP" 292.IP "\fBinheritPixmap:\fP \fIboolean\fP"
276\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 293\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
277giving artificial transparency\&. 294giving artificial transparency\&.
278\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 295\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
296.IP "\fBfading:\fP \fInumber\fP"
297Fade the text by the given percentage when focus is lost\&.
298.IP "\fBtintColor:\fP \fIcolour\fP"
299Tint the transparent background pixmap with the given colour\&.
300.IP "\fBfading:\fP \fInumber\fP"
301Scale the tint colour by the given percentage\&.
279.IP "\fBscrollColor:\fP \fIcolour\fP" 302.IP "\fBscrollColor:\fP \fIcolour\fP"
280Use the specified colour for the scrollbar [default #B2B2B2]\&. 303Use the specified colour for the scrollbar [default #B2B2B2]\&.
281.IP "\fBtroughColor:\fP \fIcolour\fP" 304.IP "\fBtroughColor:\fP \fIcolour\fP"
282Use the specified colour for the scrollbar\&'s trough area [default 305Use the specified colour for the scrollbar\&'s trough area [default
283#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 306#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
298.IP "\fBpath:\fP \fIpath\fP" 321.IP "\fBpath:\fP \fIpath\fP"
299Specify the colon-delimited search path for finding files (XPM and 322Specify the colon-delimited search path for finding files (XPM and
300menus), in addition to the paths specified by the \fBRXVTPATH\fP and 323menus), in addition to the paths specified by the \fBRXVTPATH\fP and
301\fBPATH\fP environment variables\&. 324\fBPATH\fP environment variables\&.
302.IP "\fBfont:\fP \fIfontname\fP" 325.IP "\fBfont:\fP \fIfontname\fP"
303Select the main text font used [default 7x14]; 326Select the fonts to be used\&.
327This is a comma seperated list of font names that are used in turn when
328trying to display Unicode characters\&.
329The first font defines the cell size for characters; other fonts might
330be smaller, but not larger\&.
331A reasonable default font list is always appended to it\&.
304option \fB-fn\fP\&. 332option \fB-fn\fP\&.
305.IP "\fBfont\fP\fIn\fP\fB:\fP \fIfontname\fP" 333.IP "\fBrealBold:\fP \fIboolean\fP"
306Specify the alternative font \fIn\fP\&. The default font values: 334\fBTrue\fP: Enable "real bold" support\&.
307.br 335When this option is on, bold text will be displayed using the first
308.RS 336available bold font in the font list\&.
309.HP 337Bold fonts should thus be specified in the font list after their
310.TS 338corresponding regular fonts\&.
311.nr 3c \n(.C 339If no bold font can be found, a regular font will be used\&.
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\&. 340option \fB-rb\fP\&.
538.IP "\fBmfont:\fP \fIfontname\fP" 341\fBFalse\fP: Display bold text in a regular font, using the color
539Select the main multiple-character text font used [default k14]; 342specified with \fBcolorBD\fP;
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\&. 343option \fB+rb\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" 344.IP "\fBselectstyle:\fP \fImode\fP"
565Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 345Set 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 346is xterm style with 2\&.20 old word selection, or anything else which
567gives xterm style selection\&. 347gives xterm style selection\&.
568.IP "\fBscrollstyle:\fP \fImode\fP" 348.IP "\fBscrollstyle:\fP \fImode\fP"
569Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 349Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
570.IP "\fBtitle:\fP \fIstring\fP" 350.IP "\fBtitle:\fP \fIstring\fP"
571Set window title string, the default title is the command-line 351Set window title string, the default title is the command-line
572specified after the \fB-e\fP option, if any, otherwise the application 352specified after the \fB-e\fP option, if any, otherwise the application
573name; 353name;
574option \fB-title\fP\&. 354option \fB-title\fP\&.
… …
675option \fB-bc\fP\&. 455option \fB-bc\fP\&.
676.IP "\fBpointerBlank:\fP \fIboolean\fP" 456.IP "\fBpointerBlank:\fP \fIboolean\fP"
677\fBTrue\fP: blank the pointer when a key is pressed or after a set number 457\fBTrue\fP: blank the pointer when a key is pressed or after a set number
678of seconds of inactivity\&. 458of seconds of inactivity\&.
679\fBFalse\fP: the pointer is always visible [default]\&. 459\fBFalse\fP: the pointer is always visible [default]\&.
460.IP "\fBpointerColor:\fP \fIcolour\fP"
461Mouse pointer foreground colour\&.
462.IP "\fBpointerColor2:\fP \fIcolour\fP"
463Mouse pointer background colour\&.
680.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 464.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
681Specifies number of seconds before blanking the pointer [default 2]\&. 465Specifies 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" 466.IP "\fBbackspacekey:\fP \fIstring\fP"
689The string to send when the backspace key is pressed\&. If set to 467The 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, 468\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 469\fBBackspace\fP (code 8) - which can be reversed with the appropriate
692DEC private mode escape sequence\&. 470DEC private mode escape sequence\&.
… …
703\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 481\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
704option \fB-pt\fP\&. 482option \fB-pt\fP\&.
705.IP "\fBinputMethod:\fP \fIname\fP" 483.IP "\fBinputMethod:\fP \fIname\fP"
706\fIname\fP of inputMethod to use; 484\fIname\fP of inputMethod to use;
707option \fB-im\fP\&. 485option \fB-im\fP\&.
486.IP "\fBimLocale:\fP \fIname\fP"
487The locale to use for opening the IM\&. You can use an LC_CTYPE
488of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
489for the input extension to be able to input japanese characters
490while staying in another locale\&.
491option \fB-imlocale\fP\&.
492.IP "\fBinsecure\fP"
493Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
494that echo arbitrary strings like the icon name or the locale\&. This
495could be abused if somebody gets 8-bit-clean access to your
496display, wether throuh a mail client displaying mail bodies
497unfiltered or though write(1)\&. Therefore, these sequences are
498disabled by default\&. (Note that other terminals, including xterm,
499have these sequences enabled by default)\&. You can enable them
500by setting this boolean resource or specifying \fB-insecure\fP as
501an option\&. At the moment, this enabled display-answer, locale,
502findfont, icon label and window title requests as well as dynamic
503menubar dispatch\&.
708.IP "\fBmodifier:\fP \fImodifier\fP" 504.IP "\fBmodifier:\fP \fImodifier\fP"
709Set the key to be interpreted as the Meta key to: 505Set 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, 506\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
711\fBmod4\fP, \fBmod5\fP; 507\fBmod4\fP, \fBmod5\fP;
712option \fB-mod\fP\&. 508option \fB-mod\fP\&.
713.IP "\fBanswerbackString:\fP \fIstring\fP" 509.IP "\fBanswerbackString:\fP \fIstring\fP"
714Specify the reply rxvt sends to the shell when an ENQ (control-E) 510Specify the reply rxvt sends to the shell when an ENQ (control-E)
715character is passed through\&. It may contain escape values as 511character is passed through\&. It may contain escape values as
716described in the entry on \fBkeysym\fP following\&. 512described in the entry on \fBkeysym\fP following\&.
513.IP "\fBsecondaryScreen:\fP \fIbool\fP"
514Turn on/off secondary screen (default enabled)\&.
515.IP "\fBsecondaryScroll:\fP \fIbool\fP"
516Turn on/off secondary screen scroll (default enabled)\&. If
517the this option is enabled, scrolls on the secondary screen will
518change the scrollback buffer and switching to/from the secondary screen
519will instead scroll the screen up\&.
717.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 520.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
718Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 521Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
719may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 522may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
720\en: newline, \er: return, \et: tab, \e000: octal number) or control 523\en: newline, \er: return, \et: tab, \e000: octal number) or control
721characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 524characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
… …
770.PP 573.PP
771\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 574\fBrxvt\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 575seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
773feature, \fBrxvt\fP must be installed setuid root on some systems\&. 576feature, \fBrxvt\fP must be installed setuid root on some systems\&.
774.SH "COLORS AND GRAPHICS" 577.SH "COLORS AND GRAPHICS"
775.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 578.PP
780In addition to the default foreground and background colours, \fBrxvt\fP 579In addition to the default foreground and background colours, \fBrxvt\fP
781can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 580can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
782versions of the same)\&. 581versions of the same)\&.
783Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 582Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
… …
1294.PP 1093.PP
1295Cursor change support is not yet implemented\&. 1094Cursor change support is not yet implemented\&.
1296.PP 1095.PP
1297Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1096Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1298.PP 1097.PP
1299Graphics support is fairly crude\&.
1300.PP
1301.SH "FTP LOCATION" 1098.SH "FTP LOCATION"
1302.PP 1099.PP
1303rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 1100rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
1304RXVTFTPSITE() 1101ftp://ftp\&.rxvt\&.org/pub/rxvt
1305.PP 1102.PP
1306.SH "CURRENT PROJECT COORDINATOR" 1103.SH "CURRENT PROJECT COORDINATOR"
1307.PP 1104.PP
1308.IP "Project Coordinator" 1105.IP "Project Coordinator"
1309RXVTMAINT() RXVTMAINTEMAIL() 1106Marc A\&. Lehmann <rxvt@schmorp\&.de>
1310.br 1107.br
1311.IP "Web page maintainter" 1108.IP "Web page maintainter"
1312RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 1109Marc A\&. Lehmann <rxvt@schmorp\&.de>
1313.br 1110.br
1314RXVTWEBPAGE() 1111<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
1315.br 1112.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 1113.PP
1325.SH "AUTHORS" 1114.SH "AUTHORS"
1326.PP 1115.PP
1327.IP "John Bovey" 1116.IP "John Bovey"
1328University of Kent, 1992, wrote the original Xvt\&. 1117University of Kent, 1992, wrote the original Xvt\&.
1329.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" 1118.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
1330very heavily modified Xvt and came up with Rxvt 1119very heavily modified Xvt and came up with Rxvt
1331.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" 1120.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
1332wrote the Greek Keyboard Input 1121wrote the Greek Keyboard Input (no longer in code)
1333.IP "mj olesen <olesen@me\&.QueensU\&.CA>" 1122.IP "mj olesen <olesen@me\&.QueensU\&.CA>"
1334Wrote the menu system\&. 1123Wrote the menu system\&.
1335.br 1124.br
1336Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) 1125Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
1337.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1126.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1338Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1127Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1339.IP "Geoff Wing <gcw@pobox\&.com>" 1128.IP "Geoff Wing <gcw@pobox\&.com>"
1340Rewrote screen display and text selection routines\&. 1129Rewrote screen display and text selection routines\&.
1130Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1131.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1132Forked rxvt-unicode, rewrote most of the display code and
1133internal character handling to store text in unicode,
1134improve xterm compatibility and apply numerous other bugfixes
1135and extensions\&.
1341.br 1136.br
1342Project Coordinator (changes\&.txt 2\&.4\&.6 - ) 1137Project Coordinator (Changes 1\&.0 - )
1138.PP

Diff Legend

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