ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.html
Revision: 1.69
Committed: Wed Aug 1 18:38:15 2007 UTC (16 years, 10 months ago) by root
Content type: text/html
Branch: MAIN
CVS Tags: rel-8_3
Changes since 1.68: +20 -14 lines
Log Message:
fix lots of configure bugs

File Contents

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