ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.html
Revision: 1.15
Committed: Mon Feb 14 18:50:56 2005 UTC (19 years, 3 months ago) by root
Content type: text/html
Branch: MAIN
CVS Tags: rel-5_1
Changes since 1.14: +3 -0 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <title>unicode) -</title>
5 <link rev="made" href="mailto:perl-binary@plan9.de" />
6 </head>
7
8 <body style="background-color: white">
9
10 <p><a name="__index__"></a></p>
11 <!-- INDEX BEGIN -->
12
13 <ul>
14
15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></li>
19 <li><a href="#rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></li>
20 <li><a href="#options">OPTIONS</a></li>
21 <li><a href="#resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></li>
22 <li><a href="#the_scrollbar">THE SCROLLBAR</a></li>
23 <li><a href="#mouse_reporting">MOUSE REPORTING</a></li>
24 <li><a href="#text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></li>
25 <li><a href="#changing_fonts">CHANGING FONTS</a></li>
26 <li><a href="#iso_14755_support">ISO 14755 SUPPORT</a></li>
27 <li><a href="#login_stamp">LOGIN STAMP</a></li>
28 <li><a href="#colors_and_graphics">COLORS AND GRAPHICS</a></li>
29 <li><a href="#environment">ENVIRONMENT</a></li>
30 <li><a href="#files">FILES</a></li>
31 <li><a href="#see_also">SEE ALSO</a></li>
32 <li><a href="#bugs">BUGS</a></li>
33 <li><a href="#current_project_coordinator">CURRENT PROJECT COORDINATOR</a></li>
34 <li><a href="#authors">AUTHORS</a></li>
35 </ul>
36 <!-- INDEX END -->
37
38 <hr />
39 <p>
40 </p>
41 <h1><a name="name">NAME</a></h1>
42 <p>rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)</p>
43 <p>
44 </p>
45 <hr />
46 <h1><a name="synopsis">SYNOPSIS</a></h1>
47 <p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
48 <p>
49 </p>
50 <hr />
51 <h1><a name="description">DESCRIPTION</a></h1>
52 <p><strong>rxvt-unicode</strong>, version <strong>5.1</strong>, is a colour vt102 terminal
53 emulator intended as an <em>xterm</em>(1) replacement for users who do not
54 require features such as Tektronix 4014 emulation and toolkit-style
55 configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
56 a significant advantage on a machine serving many X sessions.</p>
57 <p>
58 </p>
59 <hr />
60 <h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
61 <p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of
62 frequently asked questions and answer to them and some common
63 problems. That document is also accessible on the World-Wide-Web at
64 <a href="http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html</a>.</p>
65 <p>
66 </p>
67 <hr />
68 <h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1>
69 <p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode
70 internally. That means it can store and display most scripts in the
71 world. Being a terminal emulator, however, some things are very difficult,
72 especially cursive scripts such as arabic, vertically written scripts
73 like mongolian or scripts requiring extremely complex combining rules,
74 like tibetan or devenagari. Don't expect pretty output when using these
75 scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
76 fine, though. A somewhat difficult case are left-to-right scripts, such
77 as hebrew: <strong>rxvt-unicode</strong> adopts the view that bidirectional algorithms
78 belong into the application, not the terminal emulator (too many things --
79 such as cursor-movement while editing -- break otherwise), but that might
80 change.</p>
81 <p>If you are looking for a terminal that supports more exotic scripts, let
82 me recommend <code>mlterm</code>, which is a very userfriendly, lean and clean
83 terminal emulator. In fact, the reason rxvt-unicode was born was solely
84 because the author couldn't get <code>mlterm</code> to use one font for latin1 and
85 another for japanese.</p>
86 <p>Therefore another design rationale was the use of multiple fonts to
87 display characters: The idea of a single unicode font which many other
88 programs force onto it's users never made sense to me: You should be able
89 to choose any font for any script freely.</p>
90 <p>Apart from that, rxvt-unicode is also much better internationalised than
91 it's predecessor, supports things such as XFT and ISO 14755 that are handy
92 in i18n-environments, is faster, and has a lot less bugs than the original
93 rxvt. This all in addition to dozens of other small improvements.</p>
94 <p>It is still faithfully following the original rxvt idea of being lean
95 and nice on resources: for example, you can still configure rxvt-unicode
96 without most of it's features to get a lean binary. It also comes with
97 a client/daemon pair that lets you open any number of terminal windows
98 from within a single process, which makes startup time very fast and
99 drastically reduces memory usage. See <code>rxvtd(1)</code> (daemon) and
100 <code>rxvtc(1)</code> (client).</p>
101 <p>It also makes technical information about escape sequences (which have
102 been extended) easier accessible: see <code>rxvt(7)</code> for technical
103 reference documentation (escape sequences etc.).</p>
104 <p>
105 </p>
106 <hr />
107 <h1><a name="options">OPTIONS</a></h1>
108 <p>The <strong>rxvt</strong> options (mostly a subset of <em>xterm</em>'s) are listed
109 below. In keeping with the smaller-is-better philosophy, options may be
110 eliminated or default values chosen at compile-time, so options and
111 defaults listed may not accurately reflect the version installed on
112 your system. `rxvt -h' gives a list of major compile-time options on
113 the <em>Options</em> line. Option descriptions may be prefixed with which
114 compile option each is dependent upon. e.g. `Compile <em>XIM</em>:' requires
115 <em>XIM</em> on the <em>Options</em> line. Note: `rxvt -help' gives a list of all
116 command-line options compiled into your version.</p>
117 <p>Note that <strong>rxvt</strong> permits the resource name to be used as a
118 long-option (--/++ option) so the potential command-line options are
119 far greater than those listed. For example: `rxvt --loginShell --color1
120 Orange'.</p>
121 <p>The following options are available:</p>
122 <dl>
123 <dt><strong><a name="item__2dhelp_2c__2d_2dhelp"><strong>-help</strong>, <strong>--help</strong></a></strong><br />
124 </dt>
125 <dd>
126 Print out a message describing available options.
127 </dd>
128 <p></p>
129 <dt><strong><a name="item__2ddisplay_displayname"><strong>-display</strong> <em>displayname</em></a></strong><br />
130 </dt>
131 <dd>
132 Attempt to open a window on the named X display (<strong>-d</strong> still
133 respected). In the absence of this option, the display specified by the
134 <strong>DISPLAY</strong> environment variable is used.
135 </dd>
136 <p></p>
137 <dt><strong><a name="item__2dgeometry_geom"><strong>-geometry</strong> <em>geom</em></a></strong><br />
138 </dt>
139 <dd>
140 Window geometry (<strong>-g</strong> still respected); resource <strong>geometry</strong>.
141 </dd>
142 <p></p>
143 <dt><strong><a name="item__2drv_7c_2brv"><strong>-rv</strong>|<strong>+rv</strong></a></strong><br />
144 </dt>
145 <dd>
146 Turn on/off simulated reverse video; resource <strong>reverseVideo</strong>.
147 </dd>
148 <p></p>
149 <dt><strong><a name="item__2dj_7c_2bj"><strong>-j</strong>|<strong>+j</strong></a></strong><br />
150 </dt>
151 <dd>
152 Turn on/off jump scrolling; resource <strong>jumpScroll</strong>.
153 </dd>
154 <p></p>
155 <dt><strong><a name="item__2dip_7c_2bip"><strong>-ip</strong>|<strong>+ip</strong></a></strong><br />
156 </dt>
157 <dd>
158 Turn on/off inheriting parent window's pixmap. Alternative form is
159 <strong>-tr</strong>; resource <strong>inheritPixmap</strong>.
160 </dd>
161 <p></p>
162 <dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br />
163 </dt>
164 <dd>
165 Fade the text by the given percentage when focus is lost. resource <strong>fading</strong>.
166 </dd>
167 <p></p>
168 <dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br />
169 </dt>
170 <dd>
171 Tint the transparent background pixmap with the given colour when
172 transparency is enabled with <strong>-tr</strong> or <strong>-ip</strong>. See also the <strong>-sh</strong>
173 option that can be used to brighten or darken the image in addition to
174 tinting it.
175 </dd>
176 <p></p>
177 <dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br />
178 </dt>
179 <dd>
180 <em>number</em> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
181 background image in addition to tinting it (i.e. <strong>-tint</strong> must be
182 specified, too, e.g. <code>-tint white</code>).
183 </dd>
184 <p></p>
185 <dt><strong><a name="item__2dbg_colour"><strong>-bg</strong> <em>colour</em></a></strong><br />
186 </dt>
187 <dd>
188 Window background colour; resource <strong>background</strong>.
189 </dd>
190 <p></p>
191 <dt><strong><a name="item__2dfg_colour"><strong>-fg</strong> <em>colour</em></a></strong><br />
192 </dt>
193 <dd>
194 Window foreground colour; resource <strong>foreground</strong>.
195 </dd>
196 <p></p>
197 <dt><strong><a name="item__2dpixmap_file_5b_3bgeom_5d"><strong>-pixmap</strong> <em>file[;geom]</em></a></strong><br />
198 </dt>
199 <dd>
200 Compile <em>XPM</em>: Specify XPM file for the background and also optionally
201 specify its scaling with a geometry string. Note you may need to
202 add quotes to avoid special shell interpretation of the <code>;</code> in the
203 command-line; resource <strong>backgroundPixmap</strong>.
204 </dd>
205 <p></p>
206 <dt><strong><a name="item__2dcr_colour"><strong>-cr</strong> <em>colour</em></a></strong><br />
207 </dt>
208 <dd>
209 The cursor colour; resource <strong>cursorColor</strong>.
210 </dd>
211 <p></p>
212 <dt><strong><a name="item__2dpr_colour"><strong>-pr</strong> <em>colour</em></a></strong><br />
213 </dt>
214 <dd>
215 The mouse pointer foreground colour; resource <strong>pointerColor</strong>.
216 </dd>
217 <p></p>
218 <dt><strong><a name="item__2dpr2_colour"><strong>-pr2</strong> <em>colour</em></a></strong><br />
219 </dt>
220 <dd>
221 The mouse pointer background colour; resource <strong>pointerColor2</strong>.
222 </dd>
223 <p></p>
224 <dt><strong><a name="item__2dbd_colour"><strong>-bd</strong> <em>colour</em></a></strong><br />
225 </dt>
226 <dd>
227 The colour of the border around the text area and between the scrollbar and the text;
228 resource <strong>borderColor</strong>.
229 </dd>
230 <p></p>
231 <dt><strong><a name="item__2dfn_fontlist"><strong>-fn</strong> <em>fontlist</em></a></strong><br />
232 </dt>
233 <dd>
234 Select the fonts to be used. This is a comma separated list of font names
235 that are used in turn when trying to display Unicode characters. The
236 first font defines the cell size for characters; other fonts might be
237 smaller, but not (in general) larger. A (hopefully) reasonable default
238 font list is always appended to it. See resource <strong>font</strong> for more details.
239 </dd>
240 <dd>
241 <p>In short, to specify an X11 core font, just specify it's name or prefix it
242 with <code>x:</code>. To specify an XFT-font, you need to prefix it with <code>xft:</code>,
243 e.g.:</p>
244 </dd>
245 <dd>
246 <pre>
247 rxvt -fn &quot;xft:Bitstream Vera Sans Mono:pixelsize=15&quot;
248 rxvt -fn &quot;9x15bold,xft:Bitstream Vera Sans Mono&quot;</pre>
249 </dd>
250 <dd>
251 <p>See also the question ``How does rxvt-unicode choose fonts?'' in the FAQ
252 section of rxvt(7).</p>
253 </dd>
254 <p></p>
255 <dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br />
256 </dt>
257 <dd>
258 Compile font-styles: The bold font list to use when bold characters are to
259 be printed. See resource <strong>boldFont</strong> for details.
260 </dd>
261 <p></p>
262 <dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br />
263 </dt>
264 <dd>
265 Compile font-styles: The italic font list to use when bold characters are to
266 be printed. See resource <strong>italicFont</strong> for details.
267 </dd>
268 <p></p>
269 <dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br />
270 </dt>
271 <dd>
272 Compile font-styles: The bold italic font list to use when bold characters are to
273 be printed. See resource <strong>boldItalicFont</strong> for details.
274 </dd>
275 <p></p>
276 <dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br />
277 </dt>
278 <dd>
279 Specify the application name under which resources are to be obtained,
280 rather than the default executable file name. Name should not contain
281 `.' or `*' characters. Also sets the icon and title name.
282 </dd>
283 <p></p>
284 <dt><strong><a name="item__2dls_7c_2bls"><strong>-ls</strong>|<strong>+ls</strong></a></strong><br />
285 </dt>
286 <dd>
287 Start as a login-shell/sub-shell; resource <strong>loginShell</strong>.
288 </dd>
289 <p></p>
290 <dt><strong><a name="item__2dut_7c_2but"><strong>-ut</strong>|<strong>+ut</strong></a></strong><br />
291 </dt>
292 <dd>
293 Compile <em>utmp</em>: Inhibit/enable writing a utmp entry; resource
294 <strong>utmpInhibit</strong>.
295 </dd>
296 <p></p>
297 <dt><strong><a name="item__2dvb_7c_2bvb"><strong>-vb</strong>|<strong>+vb</strong></a></strong><br />
298 </dt>
299 <dd>
300 Turn on/off visual bell on receipt of a bell character; resource
301 <strong>visualBell</strong>.
302 </dd>
303 <p></p>
304 <dt><strong><a name="item__2dsb_7c_2bsb"><strong>-sb</strong>|<strong>+sb</strong></a></strong><br />
305 </dt>
306 <dd>
307 Turn on/off scrollbar; resource <strong>scrollBar</strong>.
308 </dd>
309 <p></p>
310 <dt><strong><a name="item__2dsi_7c_2bsi"><strong>-si</strong>|<strong>+si</strong></a></strong><br />
311 </dt>
312 <dd>
313 Turn on/off scroll-to-bottom on TTY output inhibit; resource
314 <strong>scrollTtyOutput</strong> has opposite effect.
315 </dd>
316 <p></p>
317 <dt><strong><a name="item__2dsk_7c_2bsk"><strong>-sk</strong>|<strong>+sk</strong></a></strong><br />
318 </dt>
319 <dd>
320 Turn on/off scroll-to-bottom on keypress; resource
321 <strong>scrollTtyKeypress</strong>.
322 </dd>
323 <p></p>
324 <dt><strong><a name="item__2dsw_7c_2bsw"><strong>-sw</strong>|<strong>+sw</strong></a></strong><br />
325 </dt>
326 <dd>
327 Turn on/off scrolling with the scrollback buffer as new lines appear.
328 This only takes effect if <strong>-si</strong> is also given; resource
329 <strong>scrollWithBuffer</strong>.
330 </dd>
331 <p></p>
332 <dt><strong><a name="item__2dsr_7c_2bsr"><strong>-sr</strong>|<strong>+sr</strong></a></strong><br />
333 </dt>
334 <dd>
335 Put scrollbar on right/left; resource <strong>scrollBar_right</strong>.
336 </dd>
337 <p></p>
338 <dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
339 </dt>
340 <dd>
341 Display normal (non XTerm/NeXT) scrollbar without/with a trough;
342 resource <strong>scrollBar_floating</strong>.
343 </dd>
344 <p></p>
345 <dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
346 </dt>
347 <dd>
348 If enabled (default), ``Horizontal Tab'' characters are being stored as
349 actual wide characters in the screen buffer, which makes it possible to
350 select and paste them. Since a horizontal tab is a cursor movement and
351 not an actual glyph, this can sometimes be visually annoying as the cursor
352 on a tab character is displayed as a wide cursor; resource <strong>pastableTabs</strong>.
353 </dd>
354 <p></p>
355 <dt><strong><a name="item__2dbc_7c_2bbc"><strong>-bc</strong>|<strong>+bc</strong></a></strong><br />
356 </dt>
357 <dd>
358 Blink the cursor; resource <strong>cursorBlink</strong>.
359 </dd>
360 <p></p>
361 <dt><strong><a name="item__2diconic"><strong>-iconic</strong></a></strong><br />
362 </dt>
363 <dd>
364 Start iconified, if the window manager supports that option.
365 Alternative form is <strong>-ic</strong>.
366 </dd>
367 <p></p>
368 <dt><strong><a name="item__2dsl_number"><strong>-sl</strong> <em>number</em></a></strong><br />
369 </dt>
370 <dd>
371 Save <em>number</em> lines in the scrollback buffer. See resource entry for
372 limits; resource <strong>saveLines</strong>.
373 </dd>
374 <p></p>
375 <dt><strong><a name="item__2db_number"><strong>-b</strong> <em>number</em></a></strong><br />
376 </dt>
377 <dd>
378 Compile <em>frills</em>: Internal border of <em>number</em> pixels. See resource
379 entry for limits; resource <strong>internalBorder</strong>.
380 </dd>
381 <p></p>
382 <dt><strong><a name="item__2dw_number"><strong>-w</strong> <em>number</em></a></strong><br />
383 </dt>
384 <dd>
385 Compile <em>frills</em>: External border of <em>number</em> pixels. Also, <strong>-bw</strong>
386 and <strong>-borderwidth</strong>. See resource entry for limits; resource
387 <strong>externalBorder</strong>.
388 </dd>
389 <p></p>
390 <dt><strong><a name="item__2dbl"><strong>-bl</strong></a></strong><br />
391 </dt>
392 <dd>
393 Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e.
394 if honoured by the WM, the rxvt-unicode window will not have window
395 decorations; resource <strong>borderLess</strong>.
396 </dd>
397 <p></p>
398 <dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br />
399 </dt>
400 <dd>
401 Compile <em>frills</em>: Lines (pixel height) to insert between each row of
402 the display. Useful to work around font rendering problems; resource
403 <strong>linespace</strong>.
404 </dd>
405 <p></p>
406 <dt><strong><a name="item__2dtn_termname"><strong>-tn</strong> <em>termname</em></a></strong><br />
407 </dt>
408 <dd>
409 This option specifies the name of the terminal type to be set in the
410 <strong>TERM</strong> environment variable. This terminal type must exist in the
411 <em>termcap(5)</em> database and should have <em>li#</em> and <em>co#</em> entries;
412 resource <strong>termName</strong>.
413 </dd>
414 <p></p>
415 <dt><strong><a name="item__2de_command__5barguments_5d"><strong>-e</strong> <em>command [arguments]</em></a></strong><br />
416 </dt>
417 <dd>
418 Run the command with its command-line arguments in the <strong>rxvt</strong>
419 window; also sets the window title and icon name to be the basename of
420 the program being executed if neither <em>-title</em> (<em>-T</em>) nor <em>-n</em> are
421 given on the command line. If this option is used, it must be the last
422 on the command-line. If there is no <strong>-e</strong> option then the default is to
423 run the program specified by the <strong>SHELL</strong> environment variable or,
424 failing that, <em>sh(1)</em>.
425 </dd>
426 <p></p>
427 <dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
428 </dt>
429 <dd>
430 Window title (<strong>-T</strong> still respected); the default title is the basename
431 of the program specified after the <strong>-e</strong> option, if any, otherwise the
432 application name; resource <strong>title</strong>.
433 </dd>
434 <p></p>
435 <dt><strong><a name="item__2dn_text"><strong>-n</strong> <em>text</em></a></strong><br />
436 </dt>
437 <dd>
438 Icon name; the default name is the basename of the program specified
439 after the <strong>-e</strong> option, if any, otherwise the application name;
440 resource <strong>iconName</strong>.
441 </dd>
442 <p></p>
443 <dt><strong><a name="item__2dc"><strong>-C</strong></a></strong><br />
444 </dt>
445 <dd>
446 Capture system console messages.
447 </dd>
448 <p></p>
449 <dt><strong><a name="item__2dpt_style"><strong>-pt</strong> <em>style</em></a></strong><br />
450 </dt>
451 <dd>
452 Compile <em>XIM</em>: input style for input method; <strong>OverTheSpot</strong>,
453 <strong>OffTheSpot</strong>, <strong>Root</strong>; resource <strong>preeditType</strong>.
454 </dd>
455 <p></p>
456 <dt><strong><a name="item__2dim_text"><strong>-im</strong> <em>text</em></a></strong><br />
457 </dt>
458 <dd>
459 Compile <em>XIM</em>: input method name. resource <strong>inputMethod</strong>.
460 </dd>
461 <p></p>
462 <dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br />
463 </dt>
464 <dd>
465 The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
466 <code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
467 input extension to be able to input japanese characters while staying in
468 another locale. resource <strong>imLocale</strong>.
469 </dd>
470 <p></p>
471 <dt><strong><a name="item__2dimfont_fontset"><strong>-imfont</strong> <em>fontset</em></a></strong><br />
472 </dt>
473 <dd>
474 Set the font set to use for the X Input Method, see resource <strong>imFont</strong>
475 for more info.
476 </dd>
477 <p></p>
478 <dt><strong><a name="item__2dtcw"><strong>-tcw</strong></a></strong><br />
479 </dt>
480 <dd>
481 Change the meaning of triple-click selection with the left mouse
482 button. Instead of selecting a full line it will extend the selection the
483 end of the logical line only. resource <strong>tripleclickwords</strong>.
484 </dd>
485 <p></p>
486 <dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br />
487 </dt>
488 <dd>
489 Enable ``insecure'' mode, which currently enables most of the escape
490 sequences that echo strings. See the resource <strong>insecure</strong> for more
491 info.
492 </dd>
493 <p></p>
494 <dt><strong><a name="item__2dmod_modifier"><strong>-mod</strong> <em>modifier</em></a></strong><br />
495 </dt>
496 <dd>
497 Override detection of Meta modifier with specified key: <strong>alt</strong>,
498 <strong>meta</strong>, <strong>hyper</strong>, <strong>super</strong>, <strong>mod1</strong>, <strong>mod2</strong>, <strong>mod3</strong>, <strong>mod4</strong>,
499 <strong>mod5</strong>; resource <em>modifier</em>.
500 </dd>
501 <p></p>
502 <dt><strong><a name="item__2dssc_7c_2bssc"><strong>-ssc</strong>|<strong>+ssc</strong></a></strong><br />
503 </dt>
504 <dd>
505 Turn on/off secondary screen (default enabled); resource
506 <strong>secondaryScreen</strong>.
507 </dd>
508 <p></p>
509 <dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br />
510 </dt>
511 <dd>
512 Turn on/off secondary screen scroll (default enabled); resource
513 <strong>secondaryScroll</strong>.
514 </dd>
515 <p></p>
516 <dt><strong><a name="item__2dkeysym_2esym_3a_string"><strong>-keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
517 </dt>
518 <dd>
519 Remap a key symbol. See resource <strong>keysym</strong>.
520 </dd>
521 <p></p>
522 <dt><strong><a name="item__2dembed_3a_windowid"><strong>-embed</strong>: <em>windowid</em></a></strong><br />
523 </dt>
524 <dd>
525 Tells rxvt to embed it's windows into an already-existing window,
526 which enables applications to easily embed a terminal.
527 </dd>
528 <dd>
529 <p>Right now, rxvt will first unmap/map the specified window, so it
530 shouldn't be a top-level window. rxvt will also reconfigure it
531 quite a bit, so don't expect it to keep some specific state. It's best to
532 create an extra subwindow for rxvt and leave it alone.</p>
533 </dd>
534 <dd>
535 <p>The window will not be destroyed when rxvt exits.</p>
536 </dd>
537 <dd>
538 <p>It might be useful to know that rxvt will not close file
539 descriptors passed to it (except for stdin/out/err, of course), so you
540 can use file descriptors to communicate with the programs within the
541 terminal. This works regardless of wether the <code>-embed</code> option was used or
542 not.</p>
543 </dd>
544 <p></p></dl>
545 <p>
546 </p>
547 <hr />
548 <h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1>
549 <p>Note: `rxvt --help' gives a list of all resources (long
550 options) compiled into your version.</p>
551 <p>There are two different methods that rxvt can use to get the
552 Xresource data: using the X libraries (Xrm*-functions) or internal
553 Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
554 <strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
555 resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
556 settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
557 will consult the following files/resources in order, with later settings
558 overwriting earlier ones:</p>
559 <pre>
560 1. system-wide app-defaults file, either locale-dependent OR global
561 2. app-defaults file in $XAPPLRESDIR
562 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
563 4. SCREEN_RESOURCES for the current screen
564 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
565 <p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
566 lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
567 set in XAPPLOADDIR/URxvt (compile-time defined: usually
568 <strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
569 <strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
570 Note that when reading X resources, <strong>rxvt</strong> recognizes two
571 class names: <strong>XTerm</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows
572 resources common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be
573 easily configured, while the class name <strong>URxvt</strong> allows resources
574 unique to <strong>rxvt</strong>, notably colours and key-handling, to be
575 shared between different <strong>rxvt</strong> configurations. If no
576 resources are specified, suitable defaults will be used. Command-line
577 arguments can be used to override resource settings. The following
578 resources are allowed:</p>
579 <dl>
580 <dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br />
581 </dt>
582 <dd>
583 Create the window with the specified X window geometry [default 80x24];
584 option <strong>-geometry</strong>.
585 </dd>
586 <p></p>
587 <dt><strong><a name="item_background_3a_colour"><strong>background:</strong> <em>colour</em></a></strong><br />
588 </dt>
589 <dd>
590 Use the specified colour as the window's background colour [default
591 White]; option <strong>-bg</strong>.
592 </dd>
593 <p></p>
594 <dt><strong><a name="item_foreground_3a_colour"><strong>foreground:</strong> <em>colour</em></a></strong><br />
595 </dt>
596 <dd>
597 Use the specified colour as the window's foreground colour [default
598 Black]; option <strong>-fg</strong>.
599 </dd>
600 <p></p>
601 <dt><strong><a name="item_colorn_3a_colour"><strong>color</strong><em>n</em><strong>:</strong> <em>colour</em></a></strong><br />
602 </dt>
603 <dd>
604 Use the specified colour for the colour value <em>n</em>, where 0-7
605 corresponds to low-intensity (normal) colours and 8-15 corresponds to
606 high-intensity (bold = bright foreground, blink = bright background)
607 colours. The canonical names are as follows: 0=black, 1=red, 2=green,
608 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
609 names used are listed in the <strong>COLORS AND GRAPHICS</strong> section.
610 </dd>
611 <dd>
612 <p>Colours higher than 15 cannot be set using resources (yet), but can be
613 changed using an escape command (see rxvt(7)).</p>
614 </dd>
615 <dd>
616 <p>Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
617 88 colour support). Colours 80-87 are evenly spaces grey steps.</p>
618 </dd>
619 <p></p>
620 <dt><strong><a name="item_colorbd_3a_colour"><strong>colorBD:</strong> <em>colour</em></a></strong><br />
621 </dt>
622 <dt><strong><a name="item_colorit_3a_colour"><strong>colorIT:</strong> <em>colour</em></a></strong><br />
623 </dt>
624 <dd>
625 Use the specified colour to display bold or italic characters when the
626 foreground colour is the default. If font styles are not available
627 (Compile <em>styles</em>) and this option is unset, reverse video is used instead.
628 </dd>
629 <p></p>
630 <dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br />
631 </dt>
632 <dd>
633 Use the specified colour to display underlined characters when the
634 foreground colour is the default.
635 </dd>
636 <p></p>
637 <dt><strong><a name="item_colorrv_3a_colour"><strong>colorRV:</strong> <em>colour</em></a></strong><br />
638 </dt>
639 <dd>
640 Use the specified colour as the background for reverse video
641 characters.
642 </dd>
643 <p></p>
644 <dt><strong><a name="item_underlinecolor_3a_colour"><strong>underlineColor:</strong> <em>colour</em></a></strong><br />
645 </dt>
646 <dd>
647 If set, use the specified colour as the colour for the underline
648 itself. If unset, use the foreground colour.
649 </dd>
650 <p></p>
651 <dt><strong><a name="item_cursorcolor_3a_colour"><strong>cursorColor:</strong> <em>colour</em></a></strong><br />
652 </dt>
653 <dd>
654 Use the specified colour for the cursor. The default is to use the
655 foreground colour; option <strong>-cr</strong>.
656 </dd>
657 <p></p>
658 <dt><strong><a name="item_cursorcolor2_3a_colour"><strong>cursorColor2:</strong> <em>colour</em></a></strong><br />
659 </dt>
660 <dd>
661 Use the specified colour for the colour of the cursor text. For this to
662 take effect, <strong>cursorColor</strong> must also be specified. The default is to
663 use the background colour.
664 </dd>
665 <p></p>
666 <dt><strong><a name="item_reversevideo_3a_boolean"><strong>reverseVideo:</strong> <em>boolean</em></a></strong><br />
667 </dt>
668 <dd>
669 <strong>True</strong>: simulate reverse video by foreground and background colours;
670 option <strong>-rv</strong>. <strong>False</strong>: regular screen colours [default]; option
671 <strong>+rv</strong>. See note in <strong>COLORS AND GRAPHICS</strong> section.
672 </dd>
673 <p></p>
674 <dt><strong><a name="item_jumpscroll_3a_boolean"><strong>jumpScroll:</strong> <em>boolean</em></a></strong><br />
675 </dt>
676 <dd>
677 <strong>True</strong>: specify that jump scrolling should be used. When scrolling
678 quickly, fewer screen updates are performed [default]; option <strong>-j</strong>.
679 <strong>False</strong>: specify that smooth scrolling should be used; option <strong>+j</strong>.
680 </dd>
681 <p></p>
682 <dt><strong><a name="item_inheritpixmap_3a_boolean"><strong>inheritPixmap:</strong> <em>boolean</em></a></strong><br />
683 </dt>
684 <dd>
685 <strong>True</strong>: make the background inherit the parent windows' pixmap, giving
686 artificial transparency. <strong>False</strong>: do not inherit the parent windows'
687 pixmap.
688 </dd>
689 <p></p>
690 <dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
691 </dt>
692 <dd>
693 Fade the text by the given percentage when focus is lost.
694 </dd>
695 <p></p>
696 <dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
697 </dt>
698 <dd>
699 Tint the transparent background pixmap with the given colour.
700 </dd>
701 <p></p>
702 <dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
703 </dt>
704 <dd>
705 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
706 image in addition to tinting it.
707 </dd>
708 <p></p>
709 <dt><strong><a name="item_scrollcolor_3a_colour"><strong>scrollColor:</strong> <em>colour</em></a></strong><br />
710 </dt>
711 <dd>
712 Use the specified colour for the scrollbar [default #B2B2B2].
713 </dd>
714 <p></p>
715 <dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
716 </dt>
717 <dd>
718 Use the specified colour for the scrollbar's trough area [default
719 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
720 </dd>
721 <p></p>
722 <dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
723 </dt>
724 <dd>
725 The colour of the border around the text area and between the scrollbar
726 and the text.
727 </dd>
728 <p></p>
729 <dt><strong><a name="item_backgroundpixmap_3a_file_5b_3bgeom_5d"><strong>backgroundPixmap:</strong> <em>file[;geom]</em></a></strong><br />
730 </dt>
731 <dd>
732 Use the specified XPM file (note the `.xpm' extension is optional) for
733 the background and also optionally specify its scaling with a geometry
734 string <strong>WxH+X+Y</strong>, in which <strong>``W'' / ``H''</strong> specify the
735 horizontal/vertical scale (percent) and <strong>``X'' / ``Y''</strong> locate the image
736 centre (percent). A scale of 0 displays the image with tiling. A scale
737 of 1 displays the image without any scaling. A scale of 2 to 9
738 specifies an integer number of images in that direction. No image will
739 be magnified beyond 10 times its original size. The maximum permitted
740 scale is 1000. [default 0x0+50+50]
741 </dd>
742 <p></p>
743 <dt><strong><a name="item_menu_3a_file_5b_3btag_5d"><strong>menu:</strong> <em>file[;tag]</em></a></strong><br />
744 </dt>
745 <dd>
746 Read in the specified menu file (note the `.menu' extension is
747 optional) and also optionally specify a starting tag to find. See the
748 reference documentation for details on the syntax for the menuBar.
749 </dd>
750 <p></p>
751 <dt><strong><a name="item_path_3a_path"><strong>path:</strong> <em>path</em></a></strong><br />
752 </dt>
753 <dd>
754 Specify the colon-delimited search path for finding files (XPM and
755 menus), in addition to the paths specified by the <strong>RXVTPATH</strong> and
756 <strong>PATH</strong> environment variables.
757 </dd>
758 <p></p>
759 <dt><strong><a name="item_font_3a_fontlist"><strong>font:</strong> <em>fontlist</em></a></strong><br />
760 </dt>
761 <dd>
762 Select the fonts to be used. This is a comma separated list of font
763 names that are used in turn when trying to display Unicode characters.
764 The first font defines the cell size for characters; other fonts might
765 be smaller, but not larger. A reasonable default font list is always
766 appended to it. option <strong>-fn</strong>.
767 </dd>
768 <dd>
769 <p>Each font can either be a standard X11 core font (XLFD) name, with
770 optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
771 </dd>
772 <dd>
773 <p>In addition, each font can be prefixed with additional hints and
774 specifications enclosed in square brackets (<code>[]</code>). The only available
775 hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft
776 fonts.</p>
777 </dd>
778 <dd>
779 <p>For example, this font resource</p>
780 </dd>
781 <dd>
782 <pre>
783 URxvt*font: 9x15bold,\
784 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
785 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
786 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
787 xft:Code2000:antialias=false</pre>
788 </dd>
789 <dd>
790 <p>specifies five fonts to be used. The first one is <code>9x15bold</code> (actually
791 the iso8859-1 version of the second font), which is the base font (because
792 it is named first) and thus defines the character cell grid to be 9 pixels
793 wide and 15 pixels high.</p>
794 </dd>
795 <dd>
796 <p>The second font is just used to add additional unicode characters not in
797 the base font, likewise the third, which is unfortunately non-bold, but
798 the bold version of the font does contain less characters, so this is a
799 useful supplement.</p>
800 </dd>
801 <dd>
802 <p>The third font is an Xft font with aliasing turned off, and the characters
803 are limited to the <strong>JIS 0208</strong> codeset (i.e. japanese kanji). The font
804 contains other characters, but we are not interested in them.</p>
805 </dd>
806 <dd>
807 <p>The last font is a useful catch-all font that supplies most of the
808 remaining unicode characters.</p>
809 </dd>
810 <p></p>
811 <dt><strong><a name="item_boldfont_3a_fontlist"><strong>boldFont:</strong> <em>fontlist</em></a></strong><br />
812 </dt>
813 <dt><strong><a name="item_italicfont_3a_fontlist"><strong>italicFont:</strong> <em>fontlist</em></a></strong><br />
814 </dt>
815 <dt><strong><a name="item_bolditalicfont_3a_fontlist"><strong>boldItalicFont:</strong> <em>fontlist</em></a></strong><br />
816 </dt>
817 <dd>
818 The font list to use for displaying <strong>bold</strong>, <em>italic</em> or <strong><em>bold
819 italic</em> </strong>&gt; characters, respectively.
820 </dd>
821 <dd>
822 <p>If specified and non-empty, then the syntax is the same as for the
823 <strong>font</strong>-resource, and the given font list will be used as is, which makes
824 it possible to substitute completely different font styles for bold and
825 italic.</p>
826 </dd>
827 <dd>
828 <p>If unset (the default), a suitable font list will be synthesized by
829 ``morphing'' the normal text font list into the desired shape. If that is
830 not possible, replacement fonts of the desired shape will be tried.</p>
831 </dd>
832 <dd>
833 <p>If set, but empty, then this specific style is disabled and the normal
834 text font will being used for the given style.</p>
835 </dd>
836 <p></p>
837 <dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
838 </dt>
839 <dd>
840 Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is
841 xterm style with 2.20 old word selection, or anything else which gives
842 xterm style selection.
843 </dd>
844 <p></p>
845 <dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
846 </dt>
847 <dd>
848 Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
849 the author's favourite..
850 </dd>
851 <p></p>
852 <dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
853 </dt>
854 <dd>
855 Set window title string, the default title is the command-line
856 specified after the <strong>-e</strong> option, if any, otherwise the application
857 name; option <strong>-title</strong>.
858 </dd>
859 <p></p>
860 <dt><strong><a name="item_iconname_3a_string"><strong>iconName:</strong> <em>string</em></a></strong><br />
861 </dt>
862 <dd>
863 Set the name used to label the window's icon or displayed in an icon
864 manager window, it also sets the window's title unless it is explicitly
865 set; option <strong>-n</strong>.
866 </dd>
867 <p></p>
868 <dt><strong><a name="item_mapalert_3a_boolean"><strong>mapAlert:</strong> <em>boolean</em></a></strong><br />
869 </dt>
870 <dd>
871 <strong>True</strong>: de-iconify (map) on receipt of a bell character. <strong>False</strong>: no
872 de-iconify (map) on receipt of a bell character [default].
873 </dd>
874 <p></p>
875 <dt><strong><a name="item_visualbell_3a_boolean"><strong>visualBell:</strong> <em>boolean</em></a></strong><br />
876 </dt>
877 <dd>
878 <strong>True</strong>: use visual bell on receipt of a bell character; option <strong>-vb</strong>.
879 <strong>False</strong>: no visual bell [default]; option <strong>+vb</strong>.
880 </dd>
881 <p></p>
882 <dt><strong><a name="item_loginshell_3a_boolean"><strong>loginShell:</strong> <em>boolean</em></a></strong><br />
883 </dt>
884 <dd>
885 <strong>True</strong>: start as a login shell by prepending a `-' to <strong>argv[0]</strong> of
886 the shell; option <strong>-ls</strong>. <strong>False</strong>: start as a normal sub-shell
887 [default]; option <strong>+ls</strong>.
888 </dd>
889 <p></p>
890 <dt><strong><a name="item_utmpinhibit_3a_boolean"><strong>utmpInhibit:</strong> <em>boolean</em></a></strong><br />
891 </dt>
892 <dd>
893 <strong>True</strong>: inhibit writing record into the system log file <strong>utmp</strong>;
894 option <strong>-ut</strong>. <strong>False</strong>: write record into the system log file <strong>utmp</strong>
895 [default]; option <strong>+ut</strong>.
896 </dd>
897 <p></p>
898 <dt><strong><a name="item_print_2dpipe_3a_string"><strong>print-pipe:</strong> <em>string</em></a></strong><br />
899 </dt>
900 <dd>
901 Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use
902 <strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or
903 <strong>Shift-Print</strong> to include the scrollback as well.
904 </dd>
905 <p></p>
906 <dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
907 </dt>
908 <dd>
909 <strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
910 disable the scrollbar; option <strong>+sb</strong>.
911 </dd>
912 <p></p>
913 <dt><strong><a name="item_scrollbar_right_3a_boolean"><strong>scrollBar_right:</strong> <em>boolean</em></a></strong><br />
914 </dt>
915 <dd>
916 <strong>True</strong>: place the scrollbar on the right of the window; option <strong>-sr</strong>.
917 <strong>False</strong>: place the scrollbar on the left of the window; option <strong>+sr</strong>.
918 </dd>
919 <p></p>
920 <dt><strong><a name="item_scrollbar_floating_3a_boolean"><strong>scrollBar_floating:</strong> <em>boolean</em></a></strong><br />
921 </dt>
922 <dd>
923 <strong>True</strong>: display an rxvt scrollbar without a trough; option <strong>-st</strong>.
924 <strong>False</strong>: display an rxvt scrollbar with a trough; option <strong>+st</strong>.
925 </dd>
926 <p></p>
927 <dt><strong><a name="item_scrollbar_align_3a_mode"><strong>scrollBar_align:</strong> <em>mode</em></a></strong><br />
928 </dt>
929 <dd>
930 Align the <strong>top</strong>, <strong>bottom</strong> or <strong>centre</strong> [default] of the scrollbar
931 thumb with the pointer on middle button press/drag.
932 </dd>
933 <p></p>
934 <dt><strong><a name="item_scrollttyoutput_3a_boolean"><strong>scrollTtyOutput:</strong> <em>boolean</em></a></strong><br />
935 </dt>
936 <dd>
937 <strong>True</strong>: scroll to bottom when tty receives output; option <strong>-si</strong>.
938 <strong>False</strong>: do not scroll to bottom when tty receives output; option
939 <strong>+si</strong>.
940 </dd>
941 <p></p>
942 <dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
943 </dt>
944 <dd>
945 <strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
946 <strong>scrollTtyOutput</strong> is False); option <strong>+sw</strong>. <strong>False</strong>: do not scroll
947 with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>.
948 </dd>
949 <p></p>
950 <dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
951 </dt>
952 <dd>
953 <strong>True</strong>: scroll to bottom when a non-special key is pressed. Special keys
954 are those which are intercepted by rxvt-unicode for special handling and
955 are not passed onto the shell; option <strong>-sk</strong>. <strong>False</strong>: do not scroll to
956 bottom when a non-special key is pressed; option <strong>+sk</strong>.
957 </dd>
958 <p></p>
959 <dt><strong><a name="item_savelines_3a_number"><strong>saveLines:</strong> <em>number</em></a></strong><br />
960 </dt>
961 <dd>
962 Save <em>number</em> lines in the scrollback buffer [default 64]. This
963 resource is limited on most machines to 65535; option <strong>-sl</strong>.
964 </dd>
965 <p></p>
966 <dt><strong><a name="item_internalborder_3a_number"><strong>internalBorder:</strong> <em>number</em></a></strong><br />
967 </dt>
968 <dd>
969 Internal border of <em>number</em> pixels. This resource is limited to 100;
970 option <strong>-b</strong>.
971 </dd>
972 <p></p>
973 <dt><strong><a name="item_externalborder_3a_number"><strong>externalBorder:</strong> <em>number</em></a></strong><br />
974 </dt>
975 <dd>
976 External border of <em>number</em> pixels. This resource is limited to 100;
977 option <strong>-w</strong>, <strong>-bw</strong>, <strong>-borderwidth</strong>.
978 </dd>
979 <p></p>
980 <dt><strong><a name="item_borderless_3a_boolean"><strong>borderLess:</strong> <em>boolean</em></a></strong><br />
981 </dt>
982 <dd>
983 Set MWM hints to request a borderless window, i.e. if honoured by the
984 WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
985 </dd>
986 <p></p>
987 <dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
988 </dt>
989 <dd>
990 Specifies the terminal type name to be set in the <strong>TERM</strong> environment
991 variable; option <strong>-tn</strong>.
992 </dd>
993 <p></p>
994 <dt><strong><a name="item_linespace_3a_number"><strong>linespace:</strong> <em>number</em></a></strong><br />
995 </dt>
996 <dd>
997 Specifies number of lines (pixel height) to insert between each row of
998 the display [default 0]; option <strong>-lsp</strong>.
999 </dd>
1000 <p></p>
1001 <dt><strong><a name="item_meta8_3a_boolean"><strong>meta8:</strong> <em>boolean</em></a></strong><br />
1002 </dt>
1003 <dd>
1004 <strong>True</strong>: handle Meta (Alt) + keypress to set the 8th bit. <strong>False</strong>:
1005 handle Meta (Alt) + keypress as an escape prefix [default].
1006 </dd>
1007 <p></p>
1008 <dt><strong><a name="item_mousewheelscrollpage_3a_boolean"><strong>mouseWheelScrollPage:</strong> <em>boolean</em></a></strong><br />
1009 </dt>
1010 <dd>
1011 <strong>True</strong>: the mouse wheel scrolls a page full. <strong>False</strong>: the mouse wheel
1012 scrolls five lines [default].
1013 </dd>
1014 <p></p>
1015 <dt><strong><a name="item_pastabletabs_3a_boolean"><strong>pastableTabs:</strong> <em>boolean</em></a></strong><br />
1016 </dt>
1017 <dd>
1018 <strong>True</strong>: store tabs as wide characters. <strong>False</strong>: interpret tabs as cursor
1019 movement only; option <code>-ptab</code>.
1020 </dd>
1021 <p></p>
1022 <dt><strong><a name="item_cursorblink_3a_boolean"><strong>cursorBlink:</strong> <em>boolean</em></a></strong><br />
1023 </dt>
1024 <dd>
1025 <strong>True</strong>: blink the cursor. <strong>False</strong>: do not blink the cursor [default];
1026 option <strong>-bc</strong>.
1027 </dd>
1028 <p></p>
1029 <dt><strong><a name="item_pointerblank_3a_boolean"><strong>pointerBlank:</strong> <em>boolean</em></a></strong><br />
1030 </dt>
1031 <dd>
1032 <strong>True</strong>: blank the pointer when a key is pressed or after a set number
1033 of seconds of inactivity. <strong>False</strong>: the pointer is always visible
1034 [default].
1035 </dd>
1036 <p></p>
1037 <dt><strong><a name="item_pointercolor_3a_colour"><strong>pointerColor:</strong> <em>colour</em></a></strong><br />
1038 </dt>
1039 <dd>
1040 Mouse pointer foreground colour.
1041 </dd>
1042 <p></p>
1043 <dt><strong><a name="item_pointercolor2_3a_colour"><strong>pointerColor2:</strong> <em>colour</em></a></strong><br />
1044 </dt>
1045 <dd>
1046 Mouse pointer background colour.
1047 </dd>
1048 <p></p>
1049 <dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1050 </dt>
1051 <dd>
1052 Specifies number of seconds before blanking the pointer [default 2].
1053 </dd>
1054 <p></p>
1055 <dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1056 </dt>
1057 <dd>
1058 The string to send when the backspace key is pressed. If set to <strong>DEC</strong>
1059 or unset it will send <strong>Delete</strong> (code 127) or, if shifted, <strong>Backspace</strong>
1060 (code 8) - which can be reversed with the appropriate DEC private mode
1061 escape sequence.
1062 </dd>
1063 <p></p>
1064 <dt><strong><a name="item_deletekey_3a_string"><strong>deletekey:</strong> <em>string</em></a></strong><br />
1065 </dt>
1066 <dd>
1067 The string to send when the delete key (not the keypad delete key) is
1068 pressed. If unset it will send the sequence traditionally associated
1069 with the <strong>Execute</strong> key.
1070 </dd>
1071 <p></p>
1072 <dt><strong><a name="item_cutchars_3a_string"><strong>cutchars:</strong> <em>string</em></a></strong><br />
1073 </dt>
1074 <dd>
1075 The characters used as delimiters for double-click word selection. The
1076 built-in default:
1077 </dd>
1078 <dd>
1079 <p><strong>BACKSLASH ```'&amp;()*,;&lt;=</strong>?@[]{|} &gt;&gt;</p>
1080 </dd>
1081 <p></p>
1082 <dt><strong><a name="item_preedittype_3a_style"><strong>preeditType:</strong> <em>style</em></a></strong><br />
1083 </dt>
1084 <dd>
1085 <strong>OverTheSpot</strong>, <strong>OffTheSpot</strong>, <strong>Root</strong>; option <strong>-pt</strong>.
1086 </dd>
1087 <p></p>
1088 <dt><strong><a name="item_inputmethod_3a_name"><strong>inputMethod:</strong> <em>name</em></a></strong><br />
1089 </dt>
1090 <dd>
1091 <em>name</em> of inputMethod to use; option <strong>-im</strong>.
1092 </dd>
1093 <p></p>
1094 <dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br />
1095 </dt>
1096 <dd>
1097 The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1098 <code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1099 input extension to be able to input japanese characters while staying in
1100 another locale. option <strong>-imlocale</strong>.
1101 </dd>
1102 <p></p>
1103 <dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1104 </dt>
1105 <dd>
1106 Specify the font-set used for XIM styles <code>OverTheSpot</code> or
1107 <code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated
1108 by commas), i.e. it's not in the same format as the other font lists used
1109 in rxvt. The default will be set-up to chose *any* suitable found
1110 found, preferably one or two pixels differing in size to the base font.
1111 option <strong>-imfont</strong>.
1112 </dd>
1113 <p></p>
1114 <dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1115 </dt>
1116 <dd>
1117 Change the meaning of triple-click selection with the left mouse
1118 button. Instead of selecting a full line it will extend the selection to
1119 the end of the logical line only. option <strong>-tcw</strong>.
1120 </dd>
1121 <p></p>
1122 <dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1123 </dt>
1124 <dd>
1125 Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1126 echo arbitrary strings like the icon name or the locale. This could be
1127 abused if somebody gets 8-bit-clean access to your display, whether
1128 throuh a mail client displaying mail bodies unfiltered or though
1129 write(1). Therefore, these sequences are disabled by default. (Note
1130 that other terminals, including xterm, have these sequences
1131 enabled by default). You can enable them by setting this boolean
1132 resource or specifying <strong>-insecure</strong> as an option. At the moment, this
1133 enabled display-answer, locale, findfont, icon label and window title
1134 requests as well as dynamic menubar dispatch.
1135 </dd>
1136 <p></p>
1137 <dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1138 </dt>
1139 <dd>
1140 Set the key to be interpreted as the Meta key to: <strong>alt</strong>, <strong>meta</strong>,
1141 <strong>hyper</strong>, <strong>super</strong>, <strong>mod1</strong>, <strong>mod2</strong>, <strong>mod3</strong>, <strong>mod4</strong>, <strong>mod5</strong>; option
1142 <strong>-mod</strong>.
1143 </dd>
1144 <p></p>
1145 <dt><strong><a name="item_answerbackstring_3a_string"><strong>answerbackString:</strong> <em>string</em></a></strong><br />
1146 </dt>
1147 <dd>
1148 Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
1149 character is passed through. It may contain escape values as described
1150 in the entry on <strong>keysym</strong> following.
1151 </dd>
1152 <p></p>
1153 <dt><strong><a name="item_secondaryscreen_3a_bool"><strong>secondaryScreen:</strong> <em>bool</em></a></strong><br />
1154 </dt>
1155 <dd>
1156 Turn on/off secondary screen (default enabled).
1157 </dd>
1158 <p></p>
1159 <dt><strong><a name="item_secondaryscroll_3a_bool"><strong>secondaryScroll:</strong> <em>bool</em></a></strong><br />
1160 </dt>
1161 <dd>
1162 Turn on/off secondary screen scroll (default enabled). If the this
1163 option is enabled, scrolls on the secondary screen will change the
1164 scrollback buffer and switching to/from the secondary screen will
1165 instead scroll the screen up.
1166 </dd>
1167 <p></p>
1168 <dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1169 </dt>
1170 <dd>
1171 Compile <em>frills</em>: Associate <em>string</em> with keysym <em>sym</em>. The
1172 intervening resource name <strong>keysym.</strong> cannot be omitted.
1173 </dd>
1174 <dd>
1175 <p>The format of <em>sym</em> is ``<em>(modifiers-)key</em>'', where <em>modifiers</em> can be
1176 any combination of <strong>ISOLevel3</strong>, <strong>AppKeypad</strong>, <strong>Control</strong>, <strong>NumLock</strong>,
1177 <strong>Shift</strong>, <strong>Meta</strong>, <strong>Lock</strong>, <strong>Mod1</strong>, <strong>Mod2</strong>, <strong>Mod3</strong>, <strong>Mod4</strong>, <strong>Mod5</strong>,
1178 and the abbreviated <strong>I</strong>, <strong>K</strong>, <strong>C</strong>, <strong>N</strong>, <strong>S</strong>, <strong>M</strong>, <strong>A</strong>, <strong>L</strong>, <strong>1</strong>,
1179 <strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p>
1180 </dd>
1181 <dd>
1182 <p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to
1183 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1184 keys are being mapped. <strong>AppKeypad</strong> is a synthetic modifier mapped to the
1185 current application keymap mode state.</p>
1186 </dd>
1187 <dd>
1188 <p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or
1189 searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and
1190 omitting the prefix <strong>XK_</strong>. Alternatively you can specify <em>key</em> by its hex
1191 keysym value (<strong>0x0000 - 0xFFFF</strong>). Note that the lookup of <em>sym</em>s is not
1192 performed in an exact manner; however, the closest match is assured.</p>
1193 </dd>
1194 <dd>
1195 <p><em>string</em> may contain escape values (<code>\a</code>: bell, <code>\b</code>: backspace,
1196 <code>\e</code>, <code>\E</code>: escape, <code>\n</code>: newline, <code>\r</code>: carriage return, <code>\t</code>: tab,
1197 <code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1198 <code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1199 can start or end with whitespace.</p>
1200 </dd>
1201 <dd>
1202 <p>Please note that you need to double the <code>\</code> when using
1203 <code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
1204 use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
1205 rxvt's own processing).</p>
1206 </dd>
1207 <dd>
1208 <p>You can define a range of keysyms in one shot by providing a <em>string</em>
1209 with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1210 should be a character not used by the strings.</p>
1211 </dd>
1212 <dd>
1213 <p>Its usage can be demonstrated by an example:</p>
1214 </dd>
1215 <dd>
1216 <pre>
1217 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1218 </dd>
1219 <dd>
1220 <p>The above line is equivalent to the following three lines:</p>
1221 </dd>
1222 <dd>
1223 <pre>
1224 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1225 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1226 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1227 </dd>
1228 <dd>
1229 <p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
1230 is interpreted and executed as rxvt's control sequence. For
1231 example the following means ``change the current locale to <code>zh_CN.GBK</code>
1232 when Control-Meta-c is being pressed'':</p>
1233 </dd>
1234 <dd>
1235 <pre>
1236 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1237 </dd>
1238 <dd>
1239 <p>The following example will map Control-Meta-1 and Control-Meta-2 to
1240 the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1241 font-switching at runtime:</p>
1242 </dd>
1243 <dd>
1244 <pre>
1245 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1246 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1247 </dd>
1248 <dd>
1249 <p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1250 info):</p>
1251 </dd>
1252 <dd>
1253 <pre>
1254 URxvt.keysym.M-C-3: command:\033[8;25;80t
1255 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1256 </dd>
1257 <p></p></dl>
1258 <p>
1259 </p>
1260 <hr />
1261 <h1><a name="the_scrollbar">THE SCROLLBAR</a></h1>
1262 <p>Lines of text that scroll off the top of the <strong>rxvt</strong> window
1263 (resource: <strong>saveLines</strong>) and can be scrolled back using the scrollbar
1264 or by keystrokes. The normal <strong>rxvt</strong> scrollbar has arrows and
1265 its behaviour is fairly intuitive. The <strong>xterm-scrollbar</strong> is without
1266 arrows and its behaviour mimics that of <em>xterm</em></p>
1267 <p>Scroll down with <strong>Button1</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Next</strong>.
1268 Scroll up with <strong>Button3</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Prior</strong>.
1269 Continuous scroll with <strong>Button2</strong>.</p>
1270 <p>
1271 </p>
1272 <hr />
1273 <h1><a name="mouse_reporting">MOUSE REPORTING</a></h1>
1274 <p>To temporarily override mouse reporting, for either the scrollbar or
1275 the normal text selection/insertion, hold either the Shift or the Meta
1276 (Alt) key while performing the desired mouse action.</p>
1277 <p>If mouse reporting mode is active, the normal scrollbar actions are
1278 disabled -- on the assumption that we are using a fullscreen
1279 application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1280 (Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the
1281 up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1282 respectively.</p>
1283 <p>
1284 </p>
1285 <hr />
1286 <h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
1287 <p>The behaviour of text selection and insertion mechanism is similar to
1288 <em>xterm</em>(1).</p>
1289 <dl>
1290 <dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br />
1291 </dt>
1292 <dd>
1293 Left click at the beginning of the region, drag to the end of the region
1294 and release; Right click to extend the marked region; Left double-click
1295 to select a word; Left triple-click to select the entire logical line
1296 (which can span multiple screen lines), unless modified by resource
1297 <strong>tripleclickwords</strong>.
1298 </dd>
1299 <dd>
1300 <p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1301 (Compile: <em>frills</em>) will create a rectangular selection instead of a normal
1302 one.</p>
1303 </dd>
1304 <p></p>
1305 <dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1306 </dt>
1307 <dd>
1308 Pressing and releasing the Middle mouse button (or <strong>Shift-Insert</strong>) in
1309 an <strong>rxvt</strong> window causes the current text selection to be
1310 inserted as if it had been typed on the keyboard.
1311 </dd>
1312 <p></p></dl>
1313 <p>
1314 </p>
1315 <hr />
1316 <h1><a name="changing_fonts">CHANGING FONTS</a></h1>
1317 <p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1318 supported in rxvt-unicode. Bug me if you need this.</p>
1319 <p>You can, however, switch fonts at runtime using escape sequences (and
1320 therefore using the menubar), e.g.:</p>
1321 <pre>
1322 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1323 <p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1324 <p>
1325 </p>
1326 <hr />
1327 <h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
1328 <p>ISO 14755 is a standard for entering and viewing unicode characters
1329 and character codes using the keyboard. It consists of 4 parts. The
1330 first part is available rxvt-unicode has been compiled with
1331 <code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled
1332 with <code>--enable-iso14755</code>.</p>
1333 <ul>
1334 <li><strong><a name="item_5_2e1_3a_basic_method">5.1: Basic method</a></strong><br />
1335 </li>
1336 This allows you to enter unicode characters using their hexcode.
1337 <p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter
1338 hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will
1339 commit the character as if it were typed directly. While holding down
1340 <code>Control</code> and <code>Shift</code> you can also enter multiple characters by pressing
1341 <code>Space</code>, which will commit the current character and lets you start a new
1342 one.</p>
1343 <p>As an example of use, imagine a business card with a japanese e-mail
1344 address, which you cannot type. Fortunately, the card has the e-mail
1345 address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily
1346 by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>,
1347 followed by releasing the modifier keys.</p>
1348 <p></p>
1349 <li><strong><a name="item_5_2e2_3a_keyboard_symbols_entry_method">5.2: Keyboard symbols entry method</a></strong><br />
1350 </li>
1351 This mode lets you input characters representing the keycap symbols of
1352 your keyboard, if representable in the current locale encoding.
1353 <p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing
1354 them. The next special key (cursor keys, home etc.) you enter will not
1355 invoke it's usual function but instead will insert the corresponding
1356 keycap symbol. The symbol will only be entered when the key has been
1357 released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for
1358 <code>ISO Level 2 Switch</code>, although your intention might have been to enter a
1359 reverse tab (Shift-Tab).</p>
1360 <p></p>
1361 <li><strong><a name="item_5_2e3_3a_screen_2dselection_entry_method">5.3: Screen-selection entry method</a></strong><br />
1362 </li>
1363 While this is implemented already (it's basically the selection
1364 mechanism), it could be extended by displaying a unicode character map.
1365 <p></p>
1366 <li><strong><a name="item_5_2e4_3a_feedback_method_for_identifying_displayed">5.4: Feedback method for identifying displayed characters for later input</a></strong><br />
1367 </li>
1368 This method lets you display the unicode character code associated with
1369 characters already displayed.
1370 <p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then
1371 pressing and holding the left mouse button and moving around. The unicode
1372 hex <code>code(s)</code> (it might be a combining character) of the character under the
1373 pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p>
1374 <p>In addition to the hex codes it will display the font used to draw this
1375 character - due to implementation reasons, characters combined with
1376 combining characters, line drawing characters and unknown characters will
1377 always be drawn using the built-in support font.</p>
1378 <p></p></ul>
1379 <p>With respect to conformance, rxvt-unicode is supposed to be compliant to
1380 both scenario A and B of ISO 14755, including part 5.2.</p>
1381 <p>
1382 </p>
1383 <hr />
1384 <h1><a name="login_stamp">LOGIN STAMP</a></h1>
1385 <p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so that
1386 it can be seen via the <em>who(1)</em> command, and can accept messages. To
1387 allow this feature, <strong>rxvt</strong> may need to be installed setuid root
1388 on some systems or setgid to root or to some other group on others.</p>
1389 <p>
1390 </p>
1391 <hr />
1392 <h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
1393 <p>In addition to the default foreground and background colours,
1394 <strong>rxvt</strong> can display up to 16 colours (8 ANSI colours plus
1395 high-intensity bold/blink versions of the same). Here is a list of the
1396 colours with their <strong>rgb.txt</strong> names.</p>
1397 <table>
1398 <tr><td>color0</td><td>(black)</td><td>= Black</td></tr>
1399 <tr><td>color1</td><td>(red)</td><td>= Red3</td></tr>
1400 <tr><td>color2</td><td>(green)</td><td>= Green3</td></tr>
1401 <tr><td>color3</td><td>(yellow)</td><td>= Yellow3</td></tr>
1402 <tr><td>color4</td><td>(blue)</td><td>= Blue3</td></tr>
1403 <tr><td>color5</td><td>(magenta)</td><td>= Magenta3</td></tr>
1404 <tr><td>color6</td><td>(cyan)</td><td>= Cyan3</td></tr>
1405 <tr><td>color7</td><td>(white)</td><td>= AntiqueWhite</td></tr>
1406 <tr><td>color8</td><td>(bright black)</td><td>= Grey25</td></tr>
1407 <tr><td>color9</td><td>(bright red)</td><td>= Red</td></tr>
1408 <tr><td>color10</td><td>(bright green)</td><td>= Green</td></tr>
1409 <tr><td>color11</td><td>(bright yellow)</td><td>= Yellow</td></tr>
1410 <tr><td>color12</td><td>(bright blue)</td><td>= Blue</td></tr>
1411 <tr><td>color13</td><td>(bright magenta)</td><td>= Magenta</td></tr>
1412 <tr><td>color14</td><td>(bright cyan)</td><td>= Cyan</td></tr>
1413 <tr><td>color15</td><td>(bright white)</td><td>= White</td></tr>
1414 <tr><td>foreground</td><td></td><td>= Black</td></tr>
1415 <tr><td>background</td><td></td><td>= White</td></tr>
1416 </table><p>It is also possible to specify the colour values of <strong>foreground</strong>,
1417 <strong>background</strong>, <strong>cursorColor</strong>, <strong>cursorColor2</strong>, <strong>colorBD</strong>, <strong>colorUL</strong> as
1418 a number 0-15, as a convenient shorthand to reference the colour name of
1419 color0-color15.</p>
1420 <p>Note that <strong>-rv</strong> (<strong>``reverseVideo: True''</strong>) simulates reverse video by
1421 always swapping the foreground/background colours. This is in contrast to
1422 <em>xterm</em>(1) where the colours are only swapped if they have not otherwise
1423 been specified. For example,</p>
1424 <dl>
1425 <dt><strong><a name="item_rxvt__2dfg_black__2dbg_white__2drv"><strong>rxvt -fg Black -bg White -rv</strong></a></strong><br />
1426 </dt>
1427 <dd>
1428 would yield White on Black, while on <em>xterm</em>(1) it would yield Black
1429 on White.
1430 </dd>
1431 <p></p></dl>
1432 <p>
1433 </p>
1434 <hr />
1435 <h1><a name="environment">ENVIRONMENT</a></h1>
1436 <p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
1437 <dl>
1438 <dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1439 </dt>
1440 <dd>
1441 Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1442 resources or on the commandline.
1443 </dd>
1444 <p></p>
1445 <dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1446 </dt>
1447 <dd>
1448 Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1449 compiled with XPM support, and optionally with the added extension
1450 <code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1451 </dd>
1452 <p></p>
1453 <dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1454 </dt>
1455 <dd>
1456 Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1457 the colour code used as default foreground/text colour (or the string
1458 <code>default</code> to indicate that the default-colour escape sequence is to be
1459 used), <code>bg</code> is the colour code used as default background colour (or the
1460 string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1461 was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1462 (and do) use this information to optimize screen output.
1463 </dd>
1464 <p></p>
1465 <dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1466 </dt>
1467 <dd>
1468 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1469 window, which usually has subwindows for the scrollbar, the terminal
1470 window and so on).
1471 </dd>
1472 <p></p>
1473 <dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1474 </dt>
1475 <dd>
1476 Set to the terminfo directory iff rxvt was configured with
1477 <code>--with-terminfo=PATH</code>.
1478 </dd>
1479 <p></p>
1480 <dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1481 </dt>
1482 <dd>
1483 Used by rxvt to connect to the display and set to the correct
1484 display in it's child processes.
1485 </dd>
1486 <p></p>
1487 <dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1488 </dt>
1489 <dd>
1490 The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1491 </dd>
1492 <p></p>
1493 <dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1494 </dt>
1495 <dd>
1496 The path where rxvt looks for support files such as menu and xpm
1497 files.
1498 </dd>
1499 <p></p>
1500 <dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1501 </dt>
1502 <dd>
1503 Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1504 </dd>
1505 <p></p>
1506 <dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1507 </dt>
1508 <dd>
1509 The unix domain socket path used by <code>rxvtc(1)</code> and
1510 rxvtd(1).
1511 </dd>
1512 <dd>
1513 <p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p>
1514 </dd>
1515 <p></p>
1516 <dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1517 </dt>
1518 <dd>
1519 Used to locate the default directory for the unix domain socket for
1520 daemon communications and to locate various resource files (such as
1521 <code>.Xdefaults</code>)
1522 </dd>
1523 <p></p>
1524 <dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1525 </dt>
1526 <dd>
1527 Directory where various X resource files are being located.
1528 </dd>
1529 <p></p>
1530 <dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1531 </dt>
1532 <dd>
1533 If set and accessible, gives the name of a X resource file to be loaded by
1534 rxvt.
1535 </dd>
1536 <p></p></dl>
1537 <p>
1538 </p>
1539 <hr />
1540 <h1><a name="files">FILES</a></h1>
1541 <dl>
1542 <dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br />
1543 </dt>
1544 <dd>
1545 Color names.
1546 </dd>
1547 <p></p></dl>
1548 <p>
1549 </p>
1550 <hr />
1551 <h1><a name="see_also">SEE ALSO</a></h1>
1552 <p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1553 <p>
1554 </p>
1555 <hr />
1556 <h1><a name="bugs">BUGS</a></h1>
1557 <p>Check the BUGS file for an up-to-date list.</p>
1558 <p>Cursor change support is not yet implemented.</p>
1559 <p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1560 <p>
1561 </p>
1562 <hr />
1563 <h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1564 <dl>
1565 <dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1566 </dt>
1567 <dd>
1568 Marc A. Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;
1569 </dd>
1570 <dd>
1571 <p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1572 </dd>
1573 <p></p></dl>
1574 <p>
1575 </p>
1576 <hr />
1577 <h1><a name="authors">AUTHORS</a></h1>
1578 <dl>
1579 <dt><strong><a name="item_john_bovey">John Bovey</a></strong><br />
1580 </dt>
1581 <dd>
1582 University of Kent, 1992, wrote the original Xvt.
1583 </dd>
1584 <p></p>
1585 <dt><strong><a name="item_rob_nation__3cnation_40rocket_2esanders_2elockheed">Rob Nation <em><a href="mailto:<nation@rocket.sanders.lockheed.com"><nation@rocket.sanders.lockheed.com</a></em>&gt;</a></strong><br />
1586 </dt>
1587 <dd>
1588 very heavily modified Xvt and came up with Rxvt
1589 </dd>
1590 <p></p>
1591 <dt><strong><a name="item_angelo_haritsis__3cah_40doc_2eic_2eac_2euk_3e">Angelo Haritsis <em><a href="mailto:<ah@doc.ic.ac.uk"><ah@doc.ic.ac.uk</a></em>&gt;</a></strong><br />
1592 </dt>
1593 <dd>
1594 wrote the Greek Keyboard Input (no longer in code)
1595 </dd>
1596 <p></p>
1597 <dt><strong><a name="item_mj_olesen__3colesen_40me_2equeensu_2eca_3e">mj olesen <em><a href="mailto:<olesen@me.QueensU.CA"><olesen@me.QueensU.CA</a></em>&gt;</a></strong><br />
1598 </dt>
1599 <dd>
1600 Wrote the menu system.
1601 </dd>
1602 <dd>
1603 <p>Project Coordinator (changes.txt 2.11 to 2.21)</p>
1604 </dd>
1605 <p></p>
1606 <dt><strong><a name="item_oezguer_kesim__3ckesim_40math_2efu_2dberlin_2ede_3">Oezguer Kesim <em><a href="mailto:<kesim@math.fu-berlin.de"><kesim@math.fu-berlin.de</a></em>&gt;</a></strong><br />
1607 </dt>
1608 <dd>
1609 Project Coordinator (changes.txt 2.21a to 2.4.5)
1610 </dd>
1611 <p></p>
1612 <dt><strong><a name="item_geoff_wing__3cgcw_40pobox_2ecom_3e">Geoff Wing <em><a href="mailto:<gcw@pobox.com"><gcw@pobox.com</a></em>&gt;</a></strong><br />
1613 </dt>
1614 <dd>
1615 Rewrote screen display and text selection routines. Project Coordinator
1616 (changes.txt 2.4.6 - rxvt-unicode)
1617 </dd>
1618 <p></p>
1619 <dt><strong><a name="item_marc_alexander_lehmann__3crxvt_2dunicode_40schmorp">Marc Alexander Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;</a></strong><br />
1620 </dt>
1621 <dd>
1622 Forked rxvt-unicode, rewrote most of the display code and internal
1623 character handling to store text in unicode, improve xterm
1624 compatibility and apply numerous other bugfixes and extensions.
1625 </dd>
1626 <dd>
1627 <p>Project Coordinator (Changes 1.0 -)</p>
1628 </dd>
1629 <p></p></dl>
1630
1631 </body>
1632
1633 </html>