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