ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.html
Revision: 1.68
Committed: Sun Jun 24 22:30:52 2007 UTC (17 years ago) by root
Content type: text/html
Branch: MAIN
Changes since 1.67: +2 -2 lines
Log Message:
hack around pod::xhtmls missing support for begin/end

File Contents

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