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