ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.html
Revision: 1.62
Committed: Mon Aug 7 16:17:30 2006 UTC (17 years, 10 months ago) by root
Content type: text/html
Branch: MAIN
CVS Tags: rel-7_9
Changes since 1.61: +83 -82 lines
Log Message:
*** empty log message ***

File Contents

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