ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.html (file contents):
Revision 1.1 by root, Tue Jan 11 02:24:59 2005 UTC vs.
Revision 1.39 by root, Mon Jan 9 01:36:56 2006 UTC

… …
27 <li><a href="#login_stamp">LOGIN STAMP</a></li> 27 <li><a href="#login_stamp">LOGIN STAMP</a></li>
28 <li><a href="#colors_and_graphics">COLORS AND GRAPHICS</a></li> 28 <li><a href="#colors_and_graphics">COLORS AND GRAPHICS</a></li>
29 <li><a href="#environment">ENVIRONMENT</a></li> 29 <li><a href="#environment">ENVIRONMENT</a></li>
30 <li><a href="#files">FILES</a></li> 30 <li><a href="#files">FILES</a></li>
31 <li><a href="#see_also">SEE ALSO</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> 32 <li><a href="#current_project_coordinator">CURRENT PROJECT COORDINATOR</a></li>
34 <li><a href="#authors">AUTHORS</a></li> 33 <li><a href="#authors">AUTHORS</a></li>
35</ul> 34</ul>
36<!-- INDEX END --> 35<!-- INDEX END -->
37 36
… …
47<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 46<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
48<p> 47<p>
49</p> 48</p>
50<hr /> 49<hr />
51<h1><a name="description">DESCRIPTION</a></h1> 50<h1><a name="description">DESCRIPTION</a></h1>
52<p><strong>rxvt-unicode</strong>, version <strong>4.8</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>6.3</strong>, is a colour vt102 terminal
53emulator intended as an <em>xterm</em>(1) replacement for users who do not 52emulator intended as an <em>xterm</em>(1) replacement for users who do not
54require features such as Tektronix 4014 emulation and toolkit-style 53require features such as Tektronix 4014 emulation and toolkit-style
55configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- 54configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
56a significant advantage on a machine serving many X sessions.</p> 55a significant advantage on a machine serving many X sessions.</p>
57<p> 56<p>
58</p> 57</p>
59<hr /> 58<hr />
60<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1> 59<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
61<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of frequently 60<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of
62asked questions and answer to them and some common problems.</p> 61frequently asked questions and answer to them and some common
62problems. 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>
63<p> 64<p>
64</p> 65</p>
65<hr /> 66<hr />
66<h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1> 67<h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1>
67<p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode 68<p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode
… …
148</dt> 149</dt>
149<dd> 150<dd>
150Turn on/off jump scrolling; resource <strong>jumpScroll</strong>. 151Turn on/off jump scrolling; resource <strong>jumpScroll</strong>.
151</dd> 152</dd>
152<p></p> 153<p></p>
153<dt><strong><a name="item__2dip_7c_2bip"><strong>-ip</strong>|<strong>+ip</strong></a></strong><br /> 154<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 />
154</dt> 155</dt>
155<dd> 156<dd>
156Turn on/off inheriting parent window's pixmap. Alternative form is 157Turn on/off inheriting parent window's pixmap. Alternative form is
157<strong>-tr</strong>; resource <strong>inheritPixmap</strong>. 158<strong>-tr</strong>; resource <strong>inheritPixmap</strong>.
158</dd> 159</dd>
159<p></p> 160<p></p>
160<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br /> 161<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br />
161</dt> 162</dt>
162<dd> 163<dd>
163Fade the text by the given percentage when focus is lost. resource <strong>fading</strong>. 164Fade the text by the given percentage when focus is lost. Small values
165fade a little only, 100 completely replaces all colours by the fade
166colour; 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>
172Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour
173is black. resource <strong>fadeColor</strong>.
164</dd> 174</dd>
165<p></p> 175<p></p>
166<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br /> 176<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br />
167</dt> 177</dt>
168<dd> 178<dd>
169Tint the transparent background pixmap with the given colour when 179Tint the transparent background pixmap with the given colour when
170transparency is enabled with <strong>-tr</strong> or <strong>-ip</strong>. See also the <strong>-sh</strong> 180transparency is enabled with <strong>-tr</strong> or <strong>-ip</strong>. This only works for
171option that can be used to brighten or darken the image in addition to 181non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be
172tinting it. 182used 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>
173</dd> 188</dd>
174<p></p> 189<p></p>
175<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br /> 190<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br />
176</dt> 191</dt>
177<dd> 192<dd>
… …
194<p></p> 209<p></p>
195<dt><strong><a name="item__2dpixmap_file_5b_3bgeom_5d"><strong>-pixmap</strong> <em>file[;geom]</em></a></strong><br /> 210<dt><strong><a name="item__2dpixmap_file_5b_3bgeom_5d"><strong>-pixmap</strong> <em>file[;geom]</em></a></strong><br />
196</dt> 211</dt>
197<dd> 212<dd>
198Compile <em>XPM</em>: Specify XPM file for the background and also optionally 213Compile <em>XPM</em>: Specify XPM file for the background and also optionally
199specify its scaling with a geometry string. Note you may need to add 214specify its scaling with a geometry string. Note you may need to
200quotes to avoid special shell interpretation of the `;' in the 215add quotes to avoid special shell interpretation of the <code>;</code> in the
201command-line; resource <strong>backgroundPixmap</strong>. 216command-line; resource <strong>backgroundPixmap</strong>.
202</dd> 217</dd>
203<p></p> 218<p></p>
204<dt><strong><a name="item__2dcr_colour"><strong>-cr</strong> <em>colour</em></a></strong><br /> 219<dt><strong><a name="item__2dcr_colour"><strong>-cr</strong> <em>colour</em></a></strong><br />
205</dt> 220</dt>
… …
251</dd> 266</dd>
252<p></p> 267<p></p>
253<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br /> 268<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br />
254</dt> 269</dt>
255<dd> 270<dd>
256Compile font-styles: The bold font list to use when bold characters are to 271Compile <em>font-styles</em>: The bold font list to use when <strong>bold</strong> characters
257be printed. See resource <strong>boldFont</strong> for details. 272are to be printed. See resource <strong>boldFont</strong> for details.
258</dd> 273</dd>
259<p></p> 274<p></p>
260<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br /> 275<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br />
261</dt> 276</dt>
262<dd> 277<dd>
263Compile font-styles: The italic font list to use when bold characters are to 278Compile <em>font-styles</em>: The italic font list to use when <em>italic</em>
264be printed. See resource <strong>italicFont</strong> for details. 279characters are to be printed. See resource <strong>italicFont</strong> for details.
265</dd> 280</dd>
266<p></p> 281<p></p>
267<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br /> 282<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br />
268</dt> 283</dt>
269<dd> 284<dd>
270Compile font-styles: The bold italic font list to use when bold characters are to 285Compile <em>font-styles</em>: The bold italic font list to use when <strong><em>bold
271be printed. See resource <strong>boldItalicFont</strong> for details. 286italic</em> </strong>&gt; characters are to be printed. See resource <strong>boldItalicFont</strong>
287for details.
288</dd>
289<p></p>
290<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br />
291</dt>
292<dd>
293Compile <em>font-styles</em>: Bold/Italic font styles imply high intensity
294foreground/background (default). See resource <strong>intensityStyles</strong> for
295details.
272</dd> 296</dd>
273<p></p> 297<p></p>
274<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br /> 298<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br />
275</dt> 299</dt>
276<dd> 300<dd>
… …
334</dd> 358</dd>
335<p></p> 359<p></p>
336<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 360<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
337</dt> 361</dt>
338<dd> 362<dd>
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 363Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource <strong>scrollBar_floating</strong>. 364resource <strong>scrollBar_floating</strong>.
341</dd> 365</dd>
342<p></p> 366<p></p>
343<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 367<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
344</dt> 368</dt>
… …
389</dt> 413</dt>
390<dd> 414<dd>
391Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e. 415Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e.
392if honoured by the WM, the rxvt-unicode window will not have window 416if honoured by the WM, the rxvt-unicode window will not have window
393decorations; resource <strong>borderLess</strong>. 417decorations; resource <strong>borderLess</strong>.
418</dd>
419<p></p>
420<dt><strong><a name="item__2dsbg"><strong>-sbg</strong></a></strong><br />
421</dt>
422<dd>
423Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
424drawing characters and just rely on what the specified fonts provide. Use
425this if you have a good font and want to use its block graphic glyphs;
426resource <strong>skipBuiltinGlyphs</strong>.
394</dd> 427</dd>
395<p></p> 428<p></p>
396<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br /> 429<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br />
397</dt> 430</dt>
398<dd> 431<dd>
… …
419given on the command line. If this option is used, it must be the last 452given on the command line. If this option is used, it must be the last
420on the command-line. If there is no <strong>-e</strong> option then the default is to 453on the command-line. If there is no <strong>-e</strong> option then the default is to
421run the program specified by the <strong>SHELL</strong> environment variable or, 454run the program specified by the <strong>SHELL</strong> environment variable or,
422failing that, <em>sh(1)</em>. 455failing that, <em>sh(1)</em>.
423</dd> 456</dd>
457<dd>
458<p>Please note that you must specify a program with arguments. If you want to
459run shell commands, you have to specify the shell, like this:</p>
460</dd>
461<dd>
462<pre>
463 rxvt -e sh -c &quot;shell commands&quot;</pre>
464</dd>
424<p></p> 465<p></p>
425<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 466<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
426</dt> 467</dt>
427<dd> 468<dd>
428Window title (<strong>-T</strong> still respected); the default title is the basename 469Window title (<strong>-T</strong> still respected); the default title is the basename
… …
458</dd> 499</dd>
459<p></p> 500<p></p>
460<dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br /> 501<dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br />
461</dt> 502</dt>
462<dd> 503<dd>
463The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 504The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
464de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 505<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
465extension to be able to input japanese characters while staying in 506input extension to be able to input japanese characters while staying in
466another locale. 507another locale. resource <strong>imLocale</strong>.
508</dd>
509<p></p>
510<dt><strong><a name="item__2dimfont_fontset"><strong>-imfont</strong> <em>fontset</em></a></strong><br />
511</dt>
512<dd>
513Set the font set to use for the X Input Method, see resource <strong>imFont</strong>
514for more info.
515</dd>
516<p></p>
517<dt><strong><a name="item__2dtcw"><strong>-tcw</strong></a></strong><br />
518</dt>
519<dd>
520Change the meaning of triple-click selection with the left mouse
521button. Instead of selecting a full line it will extend the selection the
522end of the logical line only. resource <strong>tripleclickwords</strong>.
467</dd> 523</dd>
468<p></p> 524<p></p>
469<dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br /> 525<dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br />
470</dt> 526</dt>
471<dd> 527<dd>
… …
494<dd> 550<dd>
495Turn on/off secondary screen scroll (default enabled); resource 551Turn on/off secondary screen scroll (default enabled); resource
496<strong>secondaryScroll</strong>. 552<strong>secondaryScroll</strong>.
497</dd> 553</dd>
498<p></p> 554<p></p>
499<dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br /> 555<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
500</dt> 556</dt>
557<dd>
558Turn on/off hold window after exit support. If enabled, rxvt
559will not immediately destroy its window when the program executed within
560it exits. Instead, it will wait till it is being killed or closed by the
561user; resource <strong>hold</strong>.
501<dd> 562</dd>
502No effect on rxvt-unicode. Simply passes through an argument to be made 563<p></p>
503available in the instance's argument list. Appears in <em>WM_COMMAND</em> in 564<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
504some window managers. 565</dt>
566<dd>
567Remap a key symbol. See resource <strong>keysym</strong>.
568</dd>
569<p></p>
570<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
571</dt>
572<dd>
573Tells rxvt to embed it's windows into an already-existing window,
574which enables applications to easily embed a terminal.
575</dd>
576<dd>
577<p>Right now, rxvt will first unmap/map the specified window, so it
578shouldn't be a top-level window. rxvt will also reconfigure it
579quite a bit, so don't expect it to keep some specific state. It's best to
580create an extra subwindow for rxvt and leave it alone.</p>
581</dd>
582<dd>
583<p>The window will not be destroyed when rxvt exits.</p>
584</dd>
585<dd>
586<p>It might be useful to know that rxvt will not close file
587descriptors passed to it (except for stdin/out/err, of course), so you
588can use file descriptors to communicate with the programs within the
589terminal. This works regardless of wether the <code>-embed</code> option was used or
590not.</p>
591</dd>
592<dd>
593<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
594used (a longer example is in <em>doc/embed</em>):</p>
595</dd>
596<dd>
597<pre>
598 my $rxvt = new Gtk2::Socket;
599 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
600 my $xid = $_[0]-&gt;window-&gt;get_xid;
601 system &quot;rxvt -embed $xid &amp;&quot;;
602 });</pre>
603</dd>
604<p></p>
605<dt><strong><a name="item__2dpty_2dfd_file_descriptor"><strong>-pty-fd</strong> <em>file descriptor</em></a></strong><br />
606</dt>
607<dd>
608Tells rxvt NOT to execute any commands or create a new pty/tty
609pair but instead use the given filehandle as the tty master. This is
610useful if you want to drive rxvt as a generic terminal emulator
611without having to run a program within it.
612</dd>
613<dd>
614<p>If this switch is given, rxvt will not create any utmp/wtmp
615entries and will not tinker with pty/tty permissions - you have to do that
616yourself if you want that.</p>
617</dd>
618<dd>
619<p>As an extremely special case, specifying <code>-1</code> will completely suppress
620pty/tty operations.</p>
621</dd>
622<dd>
623<p>Here is a example in perl that illustrates how this option can be used (a
624longer example is in <em>doc/pty-fd</em>):</p>
625</dd>
626<dd>
627<pre>
628 use IO::Pty;
629 use Fcntl;</pre>
630</dd>
631<dd>
632<pre>
633 my $pty = new IO::Pty;
634 fcntl $pty, F_SETFD, 0; # clear close-on-exec
635 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
636 close $pty;</pre>
637</dd>
638<dd>
639<pre>
640 # now communicate with rxvt
641 my $slave = $pty-&gt;slave;
642 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
643</dd>
644<p></p>
645<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br />
646</dt>
647<dd>
648Comma-separated list of perl extension scripts to use (or not to use) in
649this terminal instance. See resource <strong>perl-ext</strong> for details.
505</dd> 650</dd>
506<p></p></dl> 651<p></p></dl>
507<p> 652<p>
508</p> 653</p>
509<hr /> 654<hr />
… …
512options) compiled into your version.</p> 657options) compiled into your version.</p>
513<p>There are two different methods that rxvt can use to get the 658<p>There are two different methods that rxvt can use to get the
514Xresource data: using the X libraries (Xrm*-functions) or internal 659Xresource data: using the X libraries (Xrm*-functions) or internal
515Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie. 660Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
516<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the 661<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
517resources using X11 tools like <strong>xset</strong>. Many distribution do also load 662resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
518settings from the <strong>~/.Xresources</strong> file when X starts.</p> 663settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
664will consult the following files/resources in order, with later settings
665overwriting earlier ones:</p>
666<pre>
667 1. system-wide app-defaults file, either locale-dependent OR global
668 2. app-defaults file in $XAPPLRESDIR
669 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
670 4. SCREEN_RESOURCES for the current screen
671 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
519<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> 672<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
520lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 673lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
521set in XAPPLOADDIR/URxvt (compile-time defined: usually 674set in XAPPLOADDIR/URxvt (compile-time defined: usually
522<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 675<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
523<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist. 676<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
… …
576<dt><strong><a name="item_colorit_3a_colour"><strong>colorIT:</strong> <em>colour</em></a></strong><br /> 729<dt><strong><a name="item_colorit_3a_colour"><strong>colorIT:</strong> <em>colour</em></a></strong><br />
577</dt> 730</dt>
578<dd> 731<dd>
579Use the specified colour to display bold or italic characters when the 732Use the specified colour to display bold or italic characters when the
580foreground colour is the default. If font styles are not available 733foreground colour is the default. If font styles are not available
581(Compile styles) and this option is unset, reverse video is used instead. 734(Compile <em>styles</em>) and this option is unset, reverse video is used instead.
582</dd> 735</dd>
583<p></p> 736<p></p>
584<dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br /> 737<dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br />
585</dt> 738</dt>
586<dd> 739<dd>
… …
642</dd> 795</dd>
643<p></p> 796<p></p>
644<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 797<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
645</dt> 798</dt>
646<dd> 799<dd>
647Fade the text by the given percentage when focus is lost. 800Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
801</dd>
802<p></p>
803<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
804</dt>
805<dd>
806Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
807colour is black; option <strong>-fadecolor</strong>.
648</dd> 808</dd>
649<p></p> 809<p></p>
650<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 810<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
651</dt> 811</dt>
652<dd> 812<dd>
653Tint the transparent background pixmap with the given colour. 813Tint the transparent background pixmap with the given colour; option
814<strong>-tint</strong>.
654</dd> 815</dd>
655<p></p> 816<p></p>
656<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 817<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
657</dt> 818</dt>
658<dd> 819<dd>
… …
668<p></p> 829<p></p>
669<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 830<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
670</dt> 831</dt>
671<dd> 832<dd>
672Use the specified colour for the scrollbar's trough area [default 833Use the specified colour for the scrollbar's trough area [default
673#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 834#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
674</dd> 835</dd>
675<p></p> 836<p></p>
676<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 837<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
677</dt> 838</dt>
678<dd> 839<dd>
… …
715<dd> 876<dd>
716Select the fonts to be used. This is a comma separated list of font 877Select the fonts to be used. This is a comma separated list of font
717names that are used in turn when trying to display Unicode characters. 878names that are used in turn when trying to display Unicode characters.
718The first font defines the cell size for characters; other fonts might 879The first font defines the cell size for characters; other fonts might
719be smaller, but not larger. A reasonable default font list is always 880be smaller, but not larger. A reasonable default font list is always
720appended to it. option <strong>-fn</strong>. 881appended to it; option <strong>-fn</strong>.
721</dd> 882</dd>
722<dd> 883<dd>
723<p>Each font can either be a standard X11 core font (XLFD) name, with 884<p>Each font can either be a standard X11 core font (XLFD) name, with
724optional prefix <code>x:</code> or a Xft font (Compile xft), prefixed with <code>xft:</code>.</p> 885optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
725</dd> 886</dd>
726<dd> 887<dd>
727<p>In addition, each font can be prefixed with additional hints and 888<p>In addition, each font can be prefixed with additional hints and
728specifications enclosed in square brackets (<code>[]</code>). The only available 889specifications enclosed in square brackets (<code>[]</code>). The only available
729hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft 890hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft
… …
786<dd> 947<dd>
787<p>If set, but empty, then this specific style is disabled and the normal 948<p>If set, but empty, then this specific style is disabled and the normal
788text font will being used for the given style.</p> 949text font will being used for the given style.</p>
789</dd> 950</dd>
790<p></p> 951<p></p>
952<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
953</dt>
954<dd>
955When font styles are not enabled, or this option is enabled (<strong>True</strong>,
956option <strong>-is</strong>, the default), bold and italic font styles imply high
957intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
958option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
959reachable.
960</dd>
961<p></p>
791<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 962<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
792</dt> 963</dt>
793<dd> 964<dd>
794Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 965Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is
795xterm style with 2.20 old word selection, or anything else which gives 966xterm style with 2.20 old word selection, or anything else which gives
… …
798<p></p> 969<p></p>
799<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 970<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
800</dt> 971</dt>
801<dd> 972<dd>
802Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 973Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
803the author's favourite.. 974the author's favourite.
804</dd> 975</dd>
805<p></p> 976<p></p>
806<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 977<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
807</dt> 978</dt>
808<dd> 979<dd>
… …
854<dd> 1025<dd>
855Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 1026Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use
856<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or 1027<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or
857<strong>Shift-Print</strong> to include the scrollback as well. 1028<strong>Shift-Print</strong> to include the scrollback as well.
858</dd> 1029</dd>
1030<dd>
1031<p>The string will be interpreted as if typed into the shell as-is.</p>
1032</dd>
1033<dd>
1034<p>Example:</p>
1035</dd>
1036<dd>
1037<pre>
1038 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1039</dd>
1040<dd>
1041<p>This creates a new file in your home directory with the screen contents
1042everytime you hit <code>Print</code>.</p>
1043</dd>
859<p></p> 1044<p></p>
860<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 1045<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
861</dt> 1046</dt>
862<dd> 1047<dd>
863<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 1048<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
… …
895<p></p> 1080<p></p>
896<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1081<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
897</dt> 1082</dt>
898<dd> 1083<dd>
899<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1084<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
900<strong>scrollTtyOutput</strong> is False); option <strong>+sw</strong>. <strong>False</strong>: do not scroll 1085<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll
901with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>. 1086with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
902</dd> 1087</dd>
903<p></p> 1088<p></p>
904<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1089<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
905</dt> 1090</dt>
906<dd> 1091<dd>
… …
936<dd> 1121<dd>
937Set MWM hints to request a borderless window, i.e. if honoured by the 1122Set MWM hints to request a borderless window, i.e. if honoured by the
938WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>. 1123WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
939</dd> 1124</dd>
940<p></p> 1125<p></p>
1126<dt><strong><a name="item_skipbuiltinglyphs_3a_boolean"><strong>skipBuiltinGlyphs:</strong> <em>boolean</em></a></strong><br />
1127</dt>
1128<dd>
1129Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
1130drawing characters and just rely on what the specified fonts provide. Use
1131this if you have a good font and want to use its block graphic glyphs;
1132option <strong>-sbg</strong>.
1133</dd>
1134<p></p>
941<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br /> 1135<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
942</dt> 1136</dt>
943<dd> 1137<dd>
944Specifies the terminal type name to be set in the <strong>TERM</strong> environment 1138Specifies the terminal type name to be set in the <strong>TERM</strong> environment
945variable; option <strong>-tn</strong>. 1139variable; option <strong>-tn</strong>.
… …
1001</dd> 1195</dd>
1002<p></p> 1196<p></p>
1003<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1197<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1004</dt> 1198</dt>
1005<dd> 1199<dd>
1006Specifies number of seconds before blanking the pointer [default 2]. 1200Specifies number of seconds before blanking the pointer [default 2]. Use a
1201large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1007</dd> 1202</dd>
1008<p></p> 1203<p></p>
1009<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1204<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1010</dt> 1205</dt>
1011<dd> 1206<dd>
… …
1046</dd> 1241</dd>
1047<p></p> 1242<p></p>
1048<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br /> 1243<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br />
1049</dt> 1244</dt>
1050<dd> 1245<dd>
1051The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 1246The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1052de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 1247<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1053extension to be able to input japanese characters while staying in 1248input extension to be able to input japanese characters while staying in
1054another locale. option <strong>-imlocale</strong>. 1249another locale; option <strong>-imlocale</strong>.
1250</dd>
1251<p></p>
1252<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1253</dt>
1254<dd>
1255Specify the font-set used for XIM styles <code>OverTheSpot</code> or
1256<code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated
1257by commas), i.e. it's not in the same format as the other font lists used
1258in rxvt. The default will be set-up to chose *any* suitable found
1259found, preferably one or two pixels differing in size to the base font.
1260option <strong>-imfont</strong>.
1261</dd>
1262<p></p>
1263<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1264</dt>
1265<dd>
1266Change the meaning of triple-click selection with the left mouse
1267button. Instead of selecting a full line it will extend the selection to
1268the end of the logical line only; option <strong>-tcw</strong>.
1055</dd> 1269</dd>
1056<p></p> 1270<p></p>
1057<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1271<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1058</dt> 1272</dt>
1059<dd> 1273<dd>
1060Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1274Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1061echo arbitrary strings like the icon name or the locale. This could be 1275echo arbitrary strings like the icon name or the locale. This could be
1062abused if somebody gets 8-bit-clean access to your display, whether 1276abused if somebody gets 8-bit-clean access to your display, whether
1063throuh a mail client displaying mail bodies unfiltered or though 1277through a mail client displaying mail bodies unfiltered or through
1064write(1). Therefore, these sequences are disabled by default. (Note 1278<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1065that other terminals, including xterm, have these sequences 1279default. (Note that many other terminals, including xterm, have these
1066enabled by default). You can enable them by setting this boolean 1280sequences enabled by default, which doesn't make it safer, though).
1067resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1281</dd>
1068enabled display-answer, locale, findfont, icon label and window title 1282<dd>
1069requests as well as dynamic menubar dispatch. 1283<p>You can enable them by setting this boolean resource or specifying
1284<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1285locale, findfont, icon label and window title requests as well as dynamic
1286menubar dispatch.</p>
1070</dd> 1287</dd>
1071<p></p> 1288<p></p>
1072<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1289<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1073</dt> 1290</dt>
1074<dd> 1291<dd>
… …
1098option is enabled, scrolls on the secondary screen will change the 1315option is enabled, scrolls on the secondary screen will change the
1099scrollback buffer and switching to/from the secondary screen will 1316scrollback buffer and switching to/from the secondary screen will
1100instead scroll the screen up. 1317instead scroll the screen up.
1101</dd> 1318</dd>
1102<p></p> 1319<p></p>
1320<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1321</dt>
1322<dd>
1323Turn on/off hold window after exit support. If enabled, rxvt
1324will not immediately destroy its window when the program executed within
1325it exits. Instead, it will wait till it is being killed or closed by the
1326user.
1327</dd>
1328<p></p>
1103<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1329<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1104</dt> 1330</dt>
1105<dd> 1331<dd>
1106Associate <em>string</em> with keysym <em>sym</em> (<strong>0xFF00 - 0xFFFF</strong>). It may 1332Compile <em>frills</em>: Associate <em>string</em> with keysym <em>sym</em>. The
1107contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
1108newline, \r: return, \t:
1109tab, \000: octal number) or control characters (^?: delete, ^@: null,
1110^A ...) and may enclosed with double quotes so that it can start or end
1111with whitespace. The intervening resource name <strong>keysym.</strong> cannot be 1333intervening resource name <strong>keysym.</strong> cannot be omitted.
1112omitted. This resource is only available when compiled with 1334</dd>
1113KEYSYM_RESOURCE. 1335<dd>
1336<p>The format of <em>sym</em> is ``<em>(modifiers-)key</em>'', where <em>modifiers</em> can be
1337any combination of <strong>ISOLevel3</strong>, <strong>AppKeypad</strong>, <strong>Control</strong>, <strong>NumLock</strong>,
1338<strong>Shift</strong>, <strong>Meta</strong>, <strong>Lock</strong>, <strong>Mod1</strong>, <strong>Mod2</strong>, <strong>Mod3</strong>, <strong>Mod4</strong>, <strong>Mod5</strong>,
1339and 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>,
1340<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p>
1341</dd>
1342<dd>
1343<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to
1344whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1345keys are being mapped. <strong>AppKeypad</strong> is a synthetic modifier mapped to the
1346current application keymap mode state.</p>
1347</dd>
1348<dd>
1349<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or
1350searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and
1351omitting the prefix <strong>XK_</strong>. Alternatively you can specify <em>key</em> by its hex
1352keysym value (<strong>0x0000 - 0xFFFF</strong>). Note that the lookup of <em>sym</em>s is not
1353performed in an exact manner; however, the closest match is assured.</p>
1354</dd>
1355<dd>
1356<p><em>string</em> may contain escape values (<code>\a</code>: bell, <code>\b</code>: backspace,
1357<code>\e</code>, <code>\E</code>: escape, <code>\n</code>: newline, <code>\r</code>: carriage return, <code>\t</code>: tab,
1358<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1359<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1360can start or end with whitespace.</p>
1361</dd>
1362<dd>
1363<p>Please note that you need to double the <code>\</code> when using
1364<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
1365use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
1366rxvt's own processing).</p>
1367</dd>
1368<dd>
1369<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1370with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1371should be a character not used by the strings.</p>
1372</dd>
1373<dd>
1374<p>Its usage can be demonstrated by an example:</p>
1375</dd>
1376<dd>
1377<pre>
1378 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1379</dd>
1380<dd>
1381<p>The above line is equivalent to the following three lines:</p>
1382</dd>
1383<dd>
1384<pre>
1385 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1386 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1387 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1388</dd>
1389<dd>
1390<p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
1391is interpreted and executed as rxvt's control sequence. For
1392example the following means ``change the current locale to <code>zh_CN.GBK</code>
1393when Control-Meta-c is being pressed'':</p>
1394</dd>
1395<dd>
1396<pre>
1397 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1398</dd>
1399<dd>
1400<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1401is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1402manpage. For example, the <em>selection</em> extension (activated via
1403<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1404</dd>
1405<dd>
1406<pre>
1407 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1408</dd>
1409<dd>
1410<p>Due the the large number of modifier combinations, a defined key mapping
1411will match if at <em>at least</em> the specified identifiers are being set, and
1412no other key mappings with those and more bits are being defined. That
1413means that defining a key map for <code>a</code> will automatically provide
1414definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1415mappings themselves.</p>
1416</dd>
1417<dd>
1418<p>Unfortunately, this will override built-in key mappings. For example
1419if you overwrite the <code>Insert</code> key you will disable rxvt's
1420<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1421user-defined keymap using the <code>builtin:</code> replacement:</p>
1422</dd>
1423<dd>
1424<pre>
1425 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1426 URxvt.keysym.S-Insert: builtin:</pre>
1427</dd>
1428<dd>
1429<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1430of modifiers. The second line re-establishes the default mapping for
1431<code>Shift-Insert</code>.</p>
1432</dd>
1433<dd>
1434<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1435the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1436font-switching at runtime:</p>
1437</dd>
1438<dd>
1439<pre>
1440 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1441 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1442</dd>
1443<dd>
1444<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1445info):</p>
1446</dd>
1447<dd>
1448<pre>
1449 URxvt.keysym.M-C-3: command:\033[8;25;80t
1450 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1451</dd>
1452<p></p>
1453<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1454</dt>
1455<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1456</dt>
1457<dd>
1458Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1459use in this terminal instance; option <strong>-pe</strong>.
1460</dd>
1461<dd>
1462<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1463it. This can be useful to selectively disable some extensions loaded
1464by default, or specified via the <code>perl-ext-common</code> resource. For
1465example, <code>default,-selection</code> will use all the default extension except
1466<code>selection</code>.</p>
1467</dd>
1468<dd>
1469<p>Each extension is looked up in the library directories, loaded if
1470necessary, and bound to the current terminal instance.</p>
1471</dd>
1472<dd>
1473<p>If both of these resources are the empty string, then the perl
1474interpreter will not be initialized. The idea behind two options is that
1475<strong>perl-ext-common</strong> will be used for extensions that should be available to
1476all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1477</dd>
1478<p></p>
1479<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1480</dt>
1481<dd>
1482Perl code to be evaluated when all extensions have been registered. See
1483the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1484will be ignored when running setuid/setgid.
1485</dd>
1486<p></p>
1487<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1488</dt>
1489<dd>
1490Colon-separated list of additional directories that hold extension
1491scripts. When looking for extensions specified by the <code>perl</code> resource,
1492rxvt will first look in these directories and then in
1493<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1494will be ignored when running setuid/setgid.
1495</dd>
1496<dd>
1497<p>See the <code>rxvtperl(3)</code> manpage.</p>
1498</dd>
1499<p></p>
1500<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1501</dt>
1502<dd>
1503Sets the WM_TRANSIENT_FOR property to the given window iw.
1114</dd> 1504</dd>
1115<p></p></dl> 1505<p></p></dl>
1116<p> 1506<p>
1117</p> 1507</p>
1118<hr /> 1508<hr />
… …
1132<p>To temporarily override mouse reporting, for either the scrollbar or 1522<p>To temporarily override mouse reporting, for either the scrollbar or
1133the normal text selection/insertion, hold either the Shift or the Meta 1523the normal text selection/insertion, hold either the Shift or the Meta
1134(Alt) key while performing the desired mouse action.</p> 1524(Alt) key while performing the desired mouse action.</p>
1135<p>If mouse reporting mode is active, the normal scrollbar actions are 1525<p>If mouse reporting mode is active, the normal scrollbar actions are
1136disabled -- on the assumption that we are using a fullscreen 1526disabled -- on the assumption that we are using a fullscreen
1137application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1527application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1138(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1528(Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the
1139up and down arrows sends <strong>ESC[A</strong> (Up) and <strong>ESC[B</strong> (Down), 1529up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1140respectively.</p> 1530respectively.</p>
1141<p> 1531<p>
1142</p> 1532</p>
1143<hr /> 1533<hr />
1144<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1534<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
… …
1146<em>xterm</em>(1).</p> 1536<em>xterm</em>(1).</p>
1147<dl> 1537<dl>
1148<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br /> 1538<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br />
1149</dt> 1539</dt>
1150<dd> 1540<dd>
1151Left click at the beginning of the region, drag to the end of the 1541Left click at the beginning of the region, drag to the end of the region
1152region and release; Right click to extend the marked region; Left 1542and release; Right click to extend the marked region; Left double-click
1153double-click to select a word; Left triple-click to select the entire 1543to select a word; Left triple-click to select the entire logical line
1154line. 1544(which can span multiple screen lines), unless modified by resource
1545<strong>tripleclickwords</strong>.
1155</dd> 1546</dd>
1156<dd> 1547<dd>
1157<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1548<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1158(Compile: frills) will create a rectangular selection instead of a normal 1549(Compile: <em>frills</em>) will create a rectangular selection instead of a
1159one.</p> 1550normal one. In this mode, every selected row becomes its own line in the
1551selection, and trailing whitespace is visually underlined and removed from
1552the selection.</p>
1160</dd> 1553</dd>
1161<p></p> 1554<p></p>
1162<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1555<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1163</dt> 1556</dt>
1164<dd> 1557<dd>
… …
1174<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1567<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1175supported in rxvt-unicode. Bug me if you need this.</p> 1568supported in rxvt-unicode. Bug me if you need this.</p>
1176<p>You can, however, switch fonts at runtime using escape sequences (and 1569<p>You can, however, switch fonts at runtime using escape sequences (and
1177therefore using the menubar), e.g.:</p> 1570therefore using the menubar), e.g.:</p>
1178<pre> 1571<pre>
1179 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1572 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1180<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1573<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1181<p> 1574<p>
1182</p> 1575</p>
1183<hr /> 1576<hr />
1184<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1577<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
1185<p>ISO 14755 is a standard for entering and viewing unicode characters 1578<p>ISO 14755 is a standard for entering and viewing unicode characters
1186and character codes using the keyboard. It consists of 4 parts. The 1579and character codes using the keyboard. It consists of 4 parts. The
1187first part is available rxvt-unicode has been compiled with 1580first part is available rxvt-unicode has been compiled with
1188<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled 1581<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled
1189with <code>--enable-iso14755</code>.</p> 1582with <code>--enable-iso14755</code>.</p>
1190<ol> 1583<ul>
1191<li><strong><a name="item_1_3a_basic_method">1: Basic method</a></strong><br /> 1584<li><strong><a name="item_5_2e1_3a_basic_method">5.1: Basic method</a></strong><br />
1192</li> 1585</li>
1193This allows you to enter unicode characters using their hexcode. 1586This allows you to enter unicode characters using their hexcode.
1194<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter 1587<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter
1195hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will 1588hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will
1196commit the character as if it were typed directly. While holding down 1589commit the character as if it were typed directly. While holding down
… …
1201address, which you cannot type. Fortunately, the card has the e-mail 1594address, which you cannot type. Fortunately, the card has the e-mail
1202address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily 1595address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily
1203by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>, 1596by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>,
1204followed by releasing the modifier keys.</p> 1597followed by releasing the modifier keys.</p>
1205<p></p> 1598<p></p>
1206<li><strong><a name="item_2_3a_keyboard_symbols_entry_method">2: Keyboard symbols entry method</a></strong><br /> 1599<li><strong><a name="item_5_2e2_3a_keyboard_symbols_entry_method">5.2: Keyboard symbols entry method</a></strong><br />
1207</li> 1600</li>
1208This mode lets you input characters representing the keycap symbols of 1601This mode lets you input characters representing the keycap symbols of
1209your keyboard, if representable in the current locale encoding. 1602your keyboard, if representable in the current locale encoding.
1210<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing 1603<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing
1211them. The next special key (cursor keys, home etc.) you enter will not 1604them. The next special key (cursor keys, home etc.) you enter will not
… …
1213keycap symbol. The symbol will only be entered when the key has been 1606keycap symbol. The symbol will only be entered when the key has been
1214released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for 1607released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for
1215<code>ISO Level 2 Switch</code>, although your intention might have been to enter a 1608<code>ISO Level 2 Switch</code>, although your intention might have been to enter a
1216reverse tab (Shift-Tab).</p> 1609reverse tab (Shift-Tab).</p>
1217<p></p> 1610<p></p>
1218<li><strong><a name="item_3_3a_screen_2dselection_entry_method">3: Screen-selection entry method</a></strong><br /> 1611<li><strong><a name="item_5_2e3_3a_screen_2dselection_entry_method">5.3: Screen-selection entry method</a></strong><br />
1219</li> 1612</li>
1220While this is implemented already (it's basically the selection 1613While this is implemented already (it's basically the selection
1221mechanism), it could be extended by displaying a unicode character map. 1614mechanism), it could be extended by displaying a unicode character map.
1222<p></p> 1615<p></p>
1223<li><strong><a name="item_4_3a_feedback_method_for_identifying_displayed_cha">4: Feedback method for identifying displayed characters for later input</a></strong><br /> 1616<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 />
1224</li> 1617</li>
1225This method lets you display the unicode character code associated with 1618This method lets you display the unicode character code associated with
1226characters already displayed. 1619characters already displayed.
1227<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then 1620<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then
1228pressing and holding the left mouse button and moving around. The unicode 1621pressing and holding the left mouse button and moving around. The unicode
… …
1230pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p> 1623pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p>
1231<p>In addition to the hex codes it will display the font used to draw this 1624<p>In addition to the hex codes it will display the font used to draw this
1232character - due to implementation reasons, characters combined with 1625character - due to implementation reasons, characters combined with
1233combining characters, line drawing characters and unknown characters will 1626combining characters, line drawing characters and unknown characters will
1234always be drawn using the built-in support font.</p> 1627always be drawn using the built-in support font.</p>
1235<p></p></ol> 1628<p></p></ul>
1236<p>With respect to conformance, rxvt-unicode is supposed to be compliant to 1629<p>With respect to conformance, rxvt-unicode is supposed to be compliant to
1237both scenario A and B of ISO 14755, including part 5.2.</p> 1630both scenario A and B of ISO 14755, including part 5.2.</p>
1238<p> 1631<p>
1239</p> 1632</p>
1240<hr /> 1633<hr />
1241<h1><a name="login_stamp">LOGIN STAMP</a></h1> 1634<h1><a name="login_stamp">LOGIN STAMP</a></h1>
1242<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so 1635<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so that
1243that it can be seen via the <em>who(1)</em> command, and can accept messages. 1636it can be seen via the <em>who(1)</em> command, and can accept messages. To
1244To allow this feature, <strong>rxvt</strong> must be installed setuid root on 1637allow this feature, <strong>rxvt</strong> may need to be installed setuid root
1245some systems.</p> 1638on some systems or setgid to root or to some other group on others.</p>
1246<p> 1639<p>
1247</p> 1640</p>
1248<hr /> 1641<hr />
1249<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1> 1642<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
1250<p>In addition to the default foreground and background colours, 1643<p>In addition to the default foreground and background colours,
… …
1288<p></p></dl> 1681<p></p></dl>
1289<p> 1682<p>
1290</p> 1683</p>
1291<hr /> 1684<hr />
1292<h1><a name="environment">ENVIRONMENT</a></h1> 1685<h1><a name="environment">ENVIRONMENT</a></h1>
1293<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1686<p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
1294and <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X 1687<dl>
1295window id number of the <strong>rxvt</strong> window and it also uses and 1688<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1296sets the environment variable <strong>DISPLAY</strong> to specify which display 1689</dt>
1297terminal to use. <strong>rxvt</strong> uses the environment variables 1690<dd>
1298<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1691Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1692resources or on the commandline.
1693</dd>
1694<p></p>
1695<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1696</dt>
1697<dd>
1698Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1699compiled with XPM support, and optionally with the added extension
1700<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1701</dd>
1702<p></p>
1703<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1704</dt>
1705<dd>
1706Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1707the colour code used as default foreground/text colour (or the string
1708<code>default</code> to indicate that the default-colour escape sequence is to be
1709used), <code>bg</code> is the colour code used as default background colour (or the
1710string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1711was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1712(and do) use this information to optimize screen output.
1713</dd>
1714<p></p>
1715<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1716</dt>
1717<dd>
1718Set to the (decimal) X Window ID of the rxvt window (the toplevel
1719window, which usually has subwindows for the scrollbar, the terminal
1720window and so on).
1721</dd>
1722<p></p>
1723<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1724</dt>
1725<dd>
1726Set to the terminfo directory iff rxvt was configured with
1727<code>--with-terminfo=PATH</code>.
1728</dd>
1729<p></p>
1730<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1731</dt>
1732<dd>
1733Used by rxvt to connect to the display and set to the correct
1734display in it's child processes.
1735</dd>
1736<p></p>
1737<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1738</dt>
1739<dd>
1740The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1741</dd>
1742<p></p>
1743<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1744</dt>
1745<dd>
1746The path where rxvt looks for support files such as menu and xpm
1747files.
1748</dd>
1749<p></p>
1750<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1751</dt>
1752<dd>
1753Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1754</dd>
1755<p></p>
1756<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1757</dt>
1758<dd>
1759The unix domain socket path used by <code>rxvtc(1)</code> and
1760rxvtd(1).
1761</dd>
1762<dd>
1763<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1764</dd>
1765<p></p>
1766<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1767</dt>
1768<dd>
1769Used to locate the default directory for the unix domain socket for
1770daemon communications and to locate various resource files (such as
1771<code>.Xdefaults</code>)
1772</dd>
1773<p></p>
1774<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1775</dt>
1776<dd>
1777Directory where various X resource files are being located.
1778</dd>
1779<p></p>
1780<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1781</dt>
1782<dd>
1783If set and accessible, gives the name of a X resource file to be loaded by
1784rxvt.
1785</dd>
1786<p></p></dl>
1299<p> 1787<p>
1300</p> 1788</p>
1301<hr /> 1789<hr />
1302<h1><a name="files">FILES</a></h1> 1790<h1><a name="files">FILES</a></h1>
1303<dl> 1791<dl>
1304<dt><strong><a name="item__2fetc_2futmp"><strong>/etc/utmp</strong></a></strong><br />
1305</dt>
1306<dd>
1307System file for login records.
1308</dd>
1309<p></p>
1310<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br /> 1792<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br />
1311</dt> 1793</dt>
1312<dd> 1794<dd>
1313Color names. 1795Color names.
1314</dd> 1796</dd>
1315<p></p></dl> 1797<p></p></dl>
1316<p> 1798<p>
1317</p> 1799</p>
1318<hr /> 1800<hr />
1319<h1><a name="see_also">SEE ALSO</a></h1> 1801<h1><a name="see_also">SEE ALSO</a></h1>
1320<p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1802<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1321<p>
1322</p>
1323<hr />
1324<h1><a name="bugs">BUGS</a></h1>
1325<p>Check the BUGS file for an up-to-date list.</p>
1326<p>Cursor change support is not yet implemented.</p>
1327<p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1328<p> 1803<p>
1329</p> 1804</p>
1330<hr /> 1805<hr />
1331<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1806<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1332<dl> 1807<dl>
1333<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1808<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1334</dt> 1809</dt>
1335<dd> 1810<dd>
1336Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1811Marc A. Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;
1337</dd>
1338<p></p>
1339<dt><strong><a name="item_web_page_maintainter">Web page maintainter</a></strong><br />
1340</dt>
1341<dd> 1812</dd>
1342Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1343</dd> 1813<dd>
1344<dd>
1345<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1814<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1346</dd> 1815</dd>
1347<p></p></dl> 1816<p></p></dl>
1348<p> 1817<p>
1349</p> 1818</p>
1350<hr /> 1819<hr />
… …
1388<dd> 1857<dd>
1389Rewrote screen display and text selection routines. Project Coordinator 1858Rewrote screen display and text selection routines. Project Coordinator
1390(changes.txt 2.4.6 - rxvt-unicode) 1859(changes.txt 2.4.6 - rxvt-unicode)
1391</dd> 1860</dd>
1392<p></p> 1861<p></p>
1393<dt><strong><a name="item_marc_alexander_lehmann__3crxvt_40schmorp_2ede_3e">Marc Alexander Lehmann <em><a href="mailto:<rxvt@schmorp.de"><rxvt@schmorp.de</a></em>&gt;</a></strong><br /> 1862<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 />
1394</dt> 1863</dt>
1395<dd> 1864<dd>
1396Forked rxvt-unicode, rewrote most of the display code and internal 1865Forked rxvt-unicode, rewrote most of the display code and internal
1397character handling to store text in unicode, improve xterm 1866character handling to store text in unicode, improve xterm
1398compatibility and apply numerous other bugfixes and extensions. 1867compatibility and apply numerous other bugfixes and extensions.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines