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