ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.html
Revision: 1.30
Committed: Mon Jan 2 19:36:07 2006 UTC (18 years, 5 months ago) by root
Content type: text/html
Branch: MAIN
Changes since 1.29: +35 -3 lines
Log Message:
*** empty log message ***

File Contents

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