ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.html
Revision: 1.73
Committed: Wed Dec 12 23:58:03 2007 UTC (16 years, 5 months ago) by ayin
Content type: text/html
Branch: MAIN
CVS Tags: HEAD
Changes since 1.72: +0 -0 lines
State: FILE REMOVED
Log Message:
*** empty log message ***

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