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.13 by root, Mon Jul 26 14:57:11 2004 UTC

1.TH "RXVT" "1" "RXVTDATE()" "X Version 11" "X Tools" 1.TH "RXVT" "1" "2004-06-26" "X Version 11" "X Tools"
2.SH "NAME" 2.SH "NAME"
3rxvt (ouR XVT) \- a VT102 emulator for the X window system 3rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
4.PP 4.PP
5.SH "SYNOPSIS" 5.SH "SYNOPSIS"
6.PP 6.PP
7\fBrxvt\fP [options] [-e command [ args ]] 7\fBurxvt\fP [options] [-e command [ args ]]
8.PP 8.PP
9.SH "DESCRIPTION" 9.SH "DESCRIPTION"
10.PP 10.PP
11\fBrxvt\fP, version \fBRXVTVERSION()\fP, is a colour vt102 terminal emulator 11\fBrxvt-unicode\fP, version \fB3\&.1\fP, is a colour vt102 terminal emulator
12intended as an \fIxterm\fP(1) replacement for users who do not require 12intended as an \fIxterm\fP(1) replacement for users who do not require
13features such as Tektronix 4014 emulation and toolkit-style configurability\&. 13features such as Tektronix 4014 emulation and toolkit-style configurability\&.
14As a result, \fBrxvt\fP uses much less swap space -- a significant 14As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
15advantage on a machine serving many X sessions\&. 15advantage on a machine serving many X sessions\&.
16.PP 16.PP
17.PP 17.PP
18.SH "OPTIONS" 18.SH "OPTIONS"
19.PP 19.PP
20The \fBrxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. 20The \fBurxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&.
21In keeping with the smaller-is-better philosophy, options may be eliminated 21In keeping with the smaller-is-better philosophy, options may be eliminated
22or default values chosen at compile-time, so options and defaults listed 22or default values chosen at compile-time, so options and defaults listed
23may not accurately reflect the version installed on your system\&. 23may not accurately reflect the version installed on your system\&.
24`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&. 24`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&.
25Option descriptions may be prefixed with which compile option each is 25Option descriptions may be prefixed with which compile option each is
26dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP 26dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP
27line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled 27line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled
28into your version\&. 28into your version\&.
29.PP 29.PP
30Note that \fBrxvt\fP permits the resource name to be used as a long-option 30Note that \fBurxvt\fP permits the resource name to be used as a long-option
31(--/++ option) so the potential command-line options are far greater than 31(--/++ option) so the potential command-line options are far greater than
32those listed\&. 32those listed\&.
33For example: `rxvt --loginShell --color1 Orange\&'\&. 33For example: `rxvt --loginShell --color1 Orange\&'\&.
34.PP
35Also note that if you do not explictly specify a font (\fB-fn\fP and \fB-fm\fP)
36or a multichar encoding method (\fB-km\fP), rxvt will select a font for the
37preferable encoding according to your locale\&. Supported encodings are:
38\fBISO-8859-\fPn (n=\fB1\fP\&.\&.\&.\fB15\fP), \fBKOI8-R\fP, \fBKOI8-U\fP, \fBEUC-JP\fP,
39\fBShift_JIS\fP, \fBEUC-KR\fP, \fBEUC-CN\fP (aka \fBGB\fP), and \fBBig5\fP\&.
40.PP 34.PP
41The following options are available: 35The following options are available:
42.PP 36.PP
43.IP "\fB-help\fP, \fB--help\fP" 37.IP "\fB-help\fP, \fB--help\fP"
44Print out a message describing available options\&. 38Print out a message describing available options\&.
57resource \fBjumpScroll\fP\&. 51resource \fBjumpScroll\fP\&.
58.IP "\fB-ip\fP|\fB+ip\fP" 52.IP "\fB-ip\fP|\fB+ip\fP"
59Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 53Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
60is \fB-tr\fP; 54is \fB-tr\fP;
61resource \fBinheritPixmap\fP\&. 55resource \fBinheritPixmap\fP\&.
56.IP "\fB-tint\fP \fIcolour\fP"
57Tint the transparent background pixmap with the given colour\&.
62.IP "\fB-bg\fP \fIcolour\fP" 58.IP "\fB-bg\fP \fIcolour\fP"
63Window background colour; 59Window background colour;
64resource \fBbackground\fP\&. 60resource \fBbackground\fP\&.
65.IP "\fB-fg\fP \fIcolour\fP" 61.IP "\fB-fg\fP \fIcolour\fP"
66Window foreground colour; 62Window foreground colour;
73resource \fBbackgroundPixmap\fP\&. 69resource \fBbackgroundPixmap\fP\&.
74.IP "\fB-cr\fP \fIcolour\fP" 70.IP "\fB-cr\fP \fIcolour\fP"
75The cursor colour; 71The cursor colour;
76resource \fBcursorColor\fP\&. 72resource \fBcursorColor\fP\&.
77.IP "\fB-pr\fP \fIcolour\fP" 73.IP "\fB-pr\fP \fIcolour\fP"
78The mouse pointer colour; 74The mouse pointer foreground colour;
79resource \fBpointerColor\fP\&. 75resource \fBpointerColor\fP\&.
76.IP "\fB-pr2\fP \fIcolour\fP"
77The mouse pointer background colour;
78resource \fBpointerColor2\fP\&.
80.IP "\fB-bd\fP \fIcolour\fP" 79.IP "\fB-bd\fP \fIcolour\fP"
81The colour of the border between the xterm scrollbar and the text; 80The colour of the border between the xterm scrollbar and the text;
82resource \fBborderColor\fP\&. 81resource \fBborderColor\fP\&.
83.IP "\fB-fn\fP \fIfontname\fP" 82.IP "\fB-fn\fP \fIfontname\fP"
84Main normal text font; 83Select the fonts to be used\&.
84This is a comma seperated list of font names that are used in turn when
85trying to display Unicode characters\&.
86The first font defines the cell size for characters; other fonts might
87be smaller, but not larger\&.
88A reasonable default font list is always appended to it\&.
85resource \fBfont\fP\&. 89resource \fBfont\fP\&.
86.IP "\fB-fb\fP \fIfontname\fP" 90.IP "\fB-rb\fP|\fB+rb\fP"
87Main bold text font; 91Enable "real bold" support\&.
92When this option is on, bold text will be displayed using the first
93available bold font in the font list\&.
94Bold fonts should thus be specified in the font list after their
95corresponding regular fonts\&.
96If no bold font can be found, a regular font will be used\&.
88resource \fBboldFont\fP\&. 97resource \fBrealBold\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" 98.IP "\fB-name\fP \fIname\fP"
108Specify the application name under which resources 99Specify the application name under which resources
109are to be obtained, rather than the default executable file name\&. 100are to be obtained, rather than the default executable file name\&.
110Name should not contain `\&.\&' or `*\&' characters\&. 101Name should not contain `\&.\&' or `*\&' characters\&.
111Also sets the icon and title name\&. 102Also sets the icon and title name\&.
135Put scrollbar on right/left; 126Put scrollbar on right/left;
136resource \fBscrollBar_right\fP\&. 127resource \fBscrollBar_right\fP\&.
137.IP "\fB-st\fP|\fB+st\fP" 128.IP "\fB-st\fP|\fB+st\fP"
138Display normal (non XTerm/NeXT) scrollbar without/with a trough; 129Display normal (non XTerm/NeXT) scrollbar without/with a trough;
139resource \fBscrollBar_floating\fP\&. 130resource \fBscrollBar_floating\fP\&.
140.IP "\fB-mcc\fP|\fB+mcc\fP"
141Compile \fImultichar_languages\fP: treat multibyte glyphs as single
142character for backspace, delete and cursor movement keys;
143resource \fBmultibyte_cursor\fP\&.
144.IP "\fB-bc\fP|\fB+bc\fP" 131.IP "\fB-bc\fP|\fB+bc\fP"
145Blink the cursor; resource \fBcursorBlink\fP\&. 132Blink the cursor; resource \fBcursorBlink\fP\&.
146.IP "\fB-iconic\fP" 133.IP "\fB-iconic\fP"
147Start iconified, if the window manager supports that option\&. 134Start iconified, if the window manager supports that option\&.
148Alternative form is \fB-ic\fP\&. 135Alternative form is \fB-ic\fP\&.
166This option specifies the name of the terminal type to be set in the 153This option specifies the name of the terminal type to be set in the
167\fBTERM\fP environment variable\&. This terminal type must exist in the 154\fBTERM\fP environment variable\&. This terminal type must exist in the
168\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; 155\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
169resource \fBtermName\fP\&. 156resource \fBtermName\fP\&.
170.IP "\fB-e\fP \fIcommand [arguments]\fP" 157.IP "\fB-e\fP \fIcommand [arguments]\fP"
171Run the command with its command-line arguments in the \fBrxvt\fP 158Run the command with its command-line arguments in the \fBurxvt\fP
172window; also sets the window title and icon name to be the basename 159window; also sets the window title and icon name to be the basename
173of the program being executed if neither \fI-title\fP (\fI-T\fP) nor 160of the program being executed if neither \fI-title\fP (\fI-T\fP) nor
174\fI-n\fP are given on the command line\&. If this option is used, it 161\fI-n\fP are given on the command line\&. If this option is used, it
175must be the last on the command-line\&. If there is no \fB-e\fP option 162must be the last on the command-line\&. If there is no \fB-e\fP option
176then the default is to run the program specified by the \fBSHELL\fP 163then the default is to run the program specified by the \fBSHELL\fP
191\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 178\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
192resource \fBpreeditType\fP\&. 179resource \fBpreeditType\fP\&.
193.IP "\fB-im\fP \fItext\fP" 180.IP "\fB-im\fP \fItext\fP"
194Compile \fIXIM\fP: input method name\&. 181Compile \fIXIM\fP: input method name\&.
195resource \fBinputMethod\fP\&. 182resource \fBinputMethod\fP\&.
183.IP "\fB-imlocale\fP \fIstring\fP"
184The locale to use for opening the IM\&. You can use an LC_CTYPE
185of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
186for the input extension to be able to input japanese characters
187while staying in another locale\&.
188.IP "\fB-insecure\fP"
189Enable "insecure" mode, which currently enables most of the escape
190sequences that echo strings\&. See the resource \fBinsecure\fP for
191more info\&.
196.IP "\fB-mod\fP \fImodifier\fP" 192.IP "\fB-mod\fP \fImodifier\fP"
197Override detection of Meta modifier with specified key: 193Override detection of Meta modifier with specified key:
198\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 194\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
199\fBmod4\fP, \fBmod5\fP; 195\fBmod4\fP, \fBmod5\fP;
200resource \fImodifier\fP\&. 196resource \fImodifier\fP\&.
197.IP "\fB-ssc\fP|\fB+ssc\fP"
198Turn on/off secondary screen (default enabled);
199resource \fBsecondaryScreen\fP\&.
200.IP "\fB-ssr\fP|\fB+ssr\fP"
201Turn on/off secondary screen scroll (default enabled);
202resource \fBsecondaryScroll\fP\&.
201.IP "\fB-xrm\fP \fIresourcestring\fP" 203.IP "\fB-xrm\fP \fIresourcestring\fP"
202No effect on rxvt\&. Simply passes through an argument to be made 204No effect on rxvt\&. Simply passes through an argument to be made
203available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 205available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
204in some window managers\&. 206in some window managers\&.
205.SH "RESOURCES (available also as long-options)" 207.SH "RESOURCES (available also as long-options)"
206.PP 208.PP
207Note: `rxvt --help\&' gives a list of all resources (long options) compiled 209Note: `rxvt --help\&' gives a list of all resources (long options) compiled
208into your version\&. 210into your version\&.
209If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 211If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists
210\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 212\fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in
211XAPPLOADDIR/Rxvt (compile-time defined: usually 213XAPPLOADDIR/Rxvt (compile-time defined: usually
212\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 214\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP,
213or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 215or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when
214reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 216reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and
215\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 217\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both
216\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 218\fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name
217\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 219\fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and
218key-handling, to be shared between different \fBrxvt\fP configurations\&. 220key-handling, to be shared between different \fBurxvt\fP configurations\&.
219If no resources are specified, suitable defaults will be used\&. 221If no resources are specified, suitable defaults will be used\&.
220Command-line arguments can be used to override resource settings\&. The 222Command-line arguments can be used to override resource settings\&. The
221following resources are allowed: 223following resources are allowed:
222.PP 224.PP
223.IP "\fBgeometry:\fP \fIgeom\fP" 225.IP "\fBgeometry:\fP \fIgeom\fP"
241but the actual colour names used are listed in the 243but the actual colour names used are listed in the
242\fBCOLORS AND GRAPHICS\fP section\&. 244\fBCOLORS AND GRAPHICS\fP section\&.
243.IP "\fBcolorBD:\fP \fIcolour\fP" 245.IP "\fBcolorBD:\fP \fIcolour\fP"
244Use the specified colour to display bold characters when the 246Use the specified colour to display bold characters when the
245foreground colour is the default\&. 247foreground colour is the default\&.
248This option will be ignored if \fBrealBold\fP is enabled\&.
246.IP "\fBcolorUL:\fP \fIcolour\fP" 249.IP "\fBcolorUL:\fP \fIcolour\fP"
247Use the specified colour to display underlined characters when the 250Use the specified colour to display underlined characters when the
248foreground colour is the default\&. 251foreground colour is the default\&.
249.IP "\fBcolorRV:\fP \fIcolour\fP" 252.IP "\fBcolorRV:\fP \fIcolour\fP"
250Use the specified colour as the background for reverse video 253Use the specified colour as the background for reverse video
271option \fB+j\fP\&. 274option \fB+j\fP\&.
272.IP "\fBinheritPixmap:\fP \fIboolean\fP" 275.IP "\fBinheritPixmap:\fP \fIboolean\fP"
273\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 276\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
274giving artificial transparency\&. 277giving artificial transparency\&.
275\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 278\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
279.IP "\fBtintColor\fP \fIcolour\fP"
280Tint the transparent background pixmap with the given colour\&.
276.IP "\fBscrollColor:\fP \fIcolour\fP" 281.IP "\fBscrollColor:\fP \fIcolour\fP"
277Use the specified colour for the scrollbar [default #B2B2B2]\&. 282Use the specified colour for the scrollbar [default #B2B2B2]\&.
278.IP "\fBtroughColor:\fP \fIcolour\fP" 283.IP "\fBtroughColor:\fP \fIcolour\fP"
279Use the specified colour for the scrollbar\&'s trough area [default 284Use the specified colour for the scrollbar\&'s trough area [default
280#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 285#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
295.IP "\fBpath:\fP \fIpath\fP" 300.IP "\fBpath:\fP \fIpath\fP"
296Specify the colon-delimited search path for finding files (XPM and 301Specify the colon-delimited search path for finding files (XPM and
297menus), in addition to the paths specified by the \fBRXVTPATH\fP and 302menus), in addition to the paths specified by the \fBRXVTPATH\fP and
298\fBPATH\fP environment variables\&. 303\fBPATH\fP environment variables\&.
299.IP "\fBfont:\fP \fIfontname\fP" 304.IP "\fBfont:\fP \fIfontname\fP"
300Select the main text font used [default 7x14]; 305Select the fonts to be used\&.
306This is a comma seperated list of font names that are used in turn when
307trying to display Unicode characters\&.
308The first font defines the cell size for characters; other fonts might
309be smaller, but not larger\&.
310A reasonable default font list is always appended to it\&.
301option \fB-fn\fP\&. 311option \fB-fn\fP\&.
302.IP "\fBfont\fP\fIn\fP\fB:\fP \fIfontname\fP" 312.IP "\fBrealBold:\fP \fIboolean\fP"
303Specify the alternative font \fIn\fP\&. The default font values: 313\fBTrue\fP: Enable "real bold" support\&.
304.br 314When this option is on, bold text will be displayed using the first
305.RS 315available bold font in the font list\&.
306.HP 316Bold fonts should thus be specified in the font list after their
307.TS 317corresponding regular fonts\&.
308tab(`); 318If no bold font can be found, a regular font will be used\&.
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\&. 319option \fB-rb\fP\&.
323.IP "\fBmfont:\fP \fIfontname\fP" 320\fBFalse\fP: Display bold text in a regular font, using the color
324Select the main multiple-character text font used [default k14]; 321specified with \fBcolorBD\fP;
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\&. 322option \fB+rb\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" 323.IP "\fBselectstyle:\fP \fImode\fP"
350Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 324Set 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 325is xterm style with 2\&.20 old word selection, or anything else which
352gives xterm style selection\&. 326gives xterm style selection\&.
353.IP "\fBscrollstyle:\fP \fImode\fP" 327.IP "\fBscrollstyle:\fP \fImode\fP"
354Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 328Set scrollbar style to \fBurxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
355.IP "\fBtitle:\fP \fIstring\fP" 329.IP "\fBtitle:\fP \fIstring\fP"
356Set window title string, the default title is the command-line 330Set window title string, the default title is the command-line
357specified after the \fB-e\fP option, if any, otherwise the application 331specified after the \fB-e\fP option, if any, otherwise the application
358name; 332name;
359option \fB-title\fP\&. 333option \fB-title\fP\&.
460option \fB-bc\fP\&. 434option \fB-bc\fP\&.
461.IP "\fBpointerBlank:\fP \fIboolean\fP" 435.IP "\fBpointerBlank:\fP \fIboolean\fP"
462\fBTrue\fP: blank the pointer when a key is pressed or after a set number 436\fBTrue\fP: blank the pointer when a key is pressed or after a set number
463of seconds of inactivity\&. 437of seconds of inactivity\&.
464\fBFalse\fP: the pointer is always visible [default]\&. 438\fBFalse\fP: the pointer is always visible [default]\&.
439.IP "\fBpointerColor:\fP \fIcolour\fP"
440Mouse pointer foreground colour\&.
441.IP "\fBpointerColor2:\fP \fIcolour\fP"
442Mouse pointer background colour\&.
465.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 443.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
466Specifies number of seconds before blanking the pointer [default 2]\&. 444Specifies number of seconds before blanking the pointer [default 2]\&.
467.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
468\fBTrue\fP: consider multibyte glyphs as single character for backspace,
469delete and cursor movement keys;
470option \fB-mcc\fP\&.
471\fBFalse\fP: move through all components of all glyphs;
472option \fB+mcc\fP\&.
473.IP "\fBbackspacekey:\fP \fIstring\fP" 445.IP "\fBbackspacekey:\fP \fIstring\fP"
474The string to send when the backspace key is pressed\&. If set to 446The string to send when the backspace key is pressed\&. If set to
475\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 447\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
476\fBBackspace\fP (code 8) - which can be reversed with the appropriate 448\fBBackspace\fP (code 8) - which can be reversed with the appropriate
477DEC private mode escape sequence\&. 449DEC private mode escape sequence\&.
488\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; 460\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
489option \fB-pt\fP\&. 461option \fB-pt\fP\&.
490.IP "\fBinputMethod:\fP \fIname\fP" 462.IP "\fBinputMethod:\fP \fIname\fP"
491\fIname\fP of inputMethod to use; 463\fIname\fP of inputMethod to use;
492option \fB-im\fP\&. 464option \fB-im\fP\&.
465.IP "\fBimLocale:\fP \fIname\fP"
466The locale to use for opening the IM\&. You can use an LC_CTYPE
467of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
468for the input extension to be able to input japanese characters
469while staying in another locale\&.
470option \fB-imlocale\fP\&.
471.IP "\fBinsecure\fP"
472Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
473that echo arbitrary strings like the icon name or the locale\&. This
474could be abused if somebody gets 8-bit-clean access to your
475display, wether throuh a mail client displaying mail bodies
476unfiltered or though write(1)\&. Therefore, these sequences are
477disabled by default\&. (Note that other terminals, including xterm,
478have these sequences enabled by default)\&. You can enable them
479by setting this boolean resource or specifying \fB-insecure\fP as
480an option\&. At the moment, this enabled display-answer, locale,
481findfont, icon label and window title requests as well as dynamic
482menubar dispatch\&.
493.IP "\fBmodifier:\fP \fImodifier\fP" 483.IP "\fBmodifier:\fP \fImodifier\fP"
494Set the key to be interpreted as the Meta key to: 484Set 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, 485\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
496\fBmod4\fP, \fBmod5\fP; 486\fBmod4\fP, \fBmod5\fP;
497option \fB-mod\fP\&. 487option \fB-mod\fP\&.
498.IP "\fBanswerbackString:\fP \fIstring\fP" 488.IP "\fBanswerbackString:\fP \fIstring\fP"
499Specify the reply rxvt sends to the shell when an ENQ (control-E) 489Specify the reply rxvt sends to the shell when an ENQ (control-E)
500character is passed through\&. It may contain escape values as 490character is passed through\&. It may contain escape values as
501described in the entry on \fBkeysym\fP following\&. 491described in the entry on \fBkeysym\fP following\&.
492.IP "\fBsecondaryScreen:\fP \fIbool\fP"
493Turn on/off secondary screen (default enabled)\&.
494.IP "\fBsecondaryScroll:\fP \fIbool\fP"
495Turn on/off secondary screen scroll (default enabled)\&. If
496the this option is enabled, scrolls on the secondary screen will
497change the scrollback buffer and switching to/from the secondary screen
498will instead scroll the screen up\&.
502.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 499.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
503Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 500Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
504may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 501may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
505\en: newline, \er: return, \et: tab, \e000: octal number) or control 502\en: newline, \er: return, \et: tab, \e000: octal number) or control
506characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 503characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
507double quotes so that it can start or end with whitespace\&. The 504double quotes so that it can start or end with whitespace\&. The
508intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This 505intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
509resource is only available when compiled with KEYSYM_RESOURCE\&. 506resource is only available when compiled with KEYSYM_RESOURCE\&.
510.SH "THE SCROLLBAR" 507.SH "THE SCROLLBAR"
511.PP 508.PP
512Lines of text that scroll off the top of the \fBrxvt\fP window (resource: 509Lines of text that scroll off the top of the \fBurxvt\fP window (resource:
513\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. 510\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&.
514The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly 511The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly
515intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour 512intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
516mimics that of \fIxterm\fP 513mimics that of \fIxterm\fP
517.PP 514.PP
518Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. 515Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
519Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. 516Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
540region and release; Right click to extend the marked region; 537region and release; Right click to extend the marked region;
541Left double-click to select a word; Left triple-click to select 538Left double-click to select a word; Left triple-click to select
542the entire line\&. 539the entire line\&.
543.IP "\fBInsertion\fP:" 540.IP "\fBInsertion\fP:"
544Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) 541Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
545in an \fBrxvt\fP window causes the current text selection to be inserted 542in an \fBurxvt\fP window causes the current text selection to be inserted
546as if it had been typed on the keyboard\&. 543as if it had been typed on the keyboard\&.
547.SH "CHANGING FONTS" 544.SH "CHANGING FONTS"
548.PP 545.PP
549You can change fonts on-the-fly, which is to say cycle through the default 546You can change fonts on-the-fly, which is to say cycle through the default
550font and others of various sizes, by using \fBShift-KP_Add\fP and 547font and others of various sizes, by using \fBShift-KP_Add\fP and
551\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with 548\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
552\fBAlt->\fP and \fBAlt-<\fP, where the actual key 549\fBAlt->\fP and \fBAlt-<\fP, where the actual key
553can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. 550can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
554.SH "LOGIN STAMP" 551.SH "LOGIN STAMP"
555.PP 552.PP
556\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 553\fBurxvt\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 554seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
558feature, \fBrxvt\fP must be installed setuid root on some systems\&. 555feature, \fBurxvt\fP must be installed setuid root on some systems\&.
559.SH "COLORS AND GRAPHICS" 556.SH "COLORS AND GRAPHICS"
560.PP 557.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
565In addition to the default foreground and background colours, \fBrxvt\fP 558In addition to the default foreground and background colours, \fBurxvt\fP
566can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 559can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
567versions of the same)\&. 560versions of the same)\&.
568Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 561Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
569.PP 562.PP
570.TS 563.TS
604.IP "\fBrxvt -fg Black -bg White -rv\fP" 597.IP "\fBrxvt -fg Black -bg White -rv\fP"
605would yield White on Black, while on \fIxterm\fP(1) it would yield 598would yield White on Black, while on \fIxterm\fP(1) it would yield
606Black on White\&. 599Black on White\&.
607.SH "ENVIRONMENT" 600.SH "ENVIRONMENT"
608.PP 601.PP
609\fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and 602\fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and
610\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window 603\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window
611id number of the \fBrxvt\fP window and it also uses and sets the environment 604id number of the \fBurxvt\fP window and it also uses and sets the environment
612variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses 605variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses
613the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. 606the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
614.SH "FILES" 607.SH "FILES"
615.PP 608.PP
616.IP "\fB/etc/utmp\fP" 609.IP "\fB/etc/utmp\fP"
617System file for login records\&. 610System file for login records\&.
632.PP 625.PP
633Cursor change support is not yet implemented\&. 626Cursor change support is not yet implemented\&.
634.PP 627.PP
635Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 628Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
636.PP 629.PP
637Graphics support is fairly crude\&.
638.PP
639.SH "FTP LOCATION" 630.SH "FTP LOCATION"
640.PP 631.PP
641rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 632rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites
642RXVTFTPSITE() 633ftp://ftp\&.rxvt\&.org/pub/rxvt
643.PP 634.PP
644.SH "CURRENT PROJECT COORDINATOR" 635.SH "CURRENT PROJECT COORDINATOR"
645.PP 636.PP
646.IP "Project Coordinator" 637.IP "Project Coordinator"
647RXVTMAINT() RXVTMAINTEMAIL() 638Marc A\&. Lehmann <rxvt@schmorp\&.de>
648.br 639.br
649.IP "Web page maintainter" 640.IP "Web page maintainter"
650RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 641Marc A\&. Lehmann <rxvt@schmorp\&.de>
651.br 642.br
652RXVTWEBPAGE() 643<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
653.br 644.br
654.IP "Mailing list"
655The Rxvt Workers <rxvt-workers@rxvt\&.org>
656mailing list has also been established for rxvt development, to
657subscribe, email to
658<rxvt-workers-subscribe@rxvt\&.org>\&.
659There is also a mailing list for announcements of new releases of
660rxvt\&. To subscribe, email to
661<rxvt-announce-subscribe@rxvt\&.org>\&.
662.PP 645.PP
663.SH "AUTHORS" 646.SH "AUTHORS"
664.PP 647.PP
665.IP "John Bovey" 648.IP "John Bovey"
666University of Kent, 1992, wrote the original Xvt\&. 649University of Kent, 1992, wrote the original Xvt\&.
667.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" 650.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
668very heavily modified Xvt and came up with Rxvt 651very heavily modified Xvt and came up with Rxvt
669.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" 652.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
670wrote the Greek Keyboard Input 653wrote the Greek Keyboard Input (no longer in code)
671.IP "mj olesen <olesen@me\&.QueensU\&.CA>" 654.IP "mj olesen <olesen@me\&.QueensU\&.CA>"
672Wrote the menu system\&. 655Wrote the menu system\&.
673.br 656.br
674Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) 657Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
675.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 658.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
676Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 659Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
677.IP "Geoff Wing <gcw@pobox\&.com>" 660.IP "Geoff Wing <gcw@pobox\&.com>"
678Rewrote screen display and text selection routines\&. 661Rewrote screen display and text selection routines\&.
662Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
663.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
664Forked rxvt-unicode, rewrote most of the display code and
665internal character handling to store text in unicode,
666improve xterm compatibility and apply numerous other bugfixes
667and extensions\&.
679.br 668.br
680Project Coordinator (changes\&.txt 2\&.4\&.6 - ) 669Project Coordinator (Changes 1\&.0 - )
670.PP

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines