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