ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.html (file contents):
Revision 1.16 by root, Wed Feb 16 22:16:30 2005 UTC vs.
Revision 1.70 by root, Sat Oct 27 12:09:02 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines