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