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.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.42 by root, Wed Jan 11 23:08:54 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>7.0</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>
… …
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 />
510<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1> 655<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1>
511<p>Note: `rxvt --help' gives a list of all resources (long 656<p>Note: `rxvt --help' gives a list of all resources (long
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>You can set and change the resources using X11 tools like <strong>xrdb</strong>. Many
514Xresource data: using the X libraries (Xrm*-functions) or internal
515Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
516<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
518settings from the <strong>~/.Xresources</strong> file when X starts.</p> 659distribution do also load settings from the <strong>~/.Xresources</strong> file when X
519<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> 660starts. rxvt will consult the following files/resources in order,
520lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 661with later settings overwriting earlier ones:</p>
521set in XAPPLOADDIR/URxvt (compile-time defined: usually 662<pre>
522<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 663 1. system-wide app-defaults file, either locale-dependent OR global
523<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist. 664 2. app-defaults file in $XAPPLRESDIR
665 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
666 4. SCREEN_RESOURCES for the current screen
667 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
524Note that when reading X resources, <strong>rxvt</strong> recognizes two 668<p>Note that when reading X resources, <strong>rxvt</strong> recognizes two class
525class names: <strong>XTerm</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows 669names: <strong>Rxvt</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows resources
526resources common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be 670common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be easily
527easily configured, while the class name <strong>URxvt</strong> allows resources 671configured, while the class name <strong>URxvt</strong> allows resources unique to
528unique to <strong>rxvt</strong>, notably colours and key-handling, to be 672<strong>rxvt</strong>, to be shared between different <strong>rxvt</strong>
529shared between different <strong>rxvt</strong> configurations. If no 673configurations. If no resources are specified, suitable defaults will
530resources are specified, suitable defaults will be used. Command-line 674be used. Command-line arguments can be used to override resource
531arguments can be used to override resource settings. The following 675settings. The following resources are supported (you might want to
532resources are allowed:</p> 676check the <code>rxvtperl(3)</code> manpage for additional settings by perl
677extensions not documented here):</p>
533<dl> 678<dl>
534<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br /> 679<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br />
535</dt> 680</dt>
536<dd> 681<dd>
537Create the window with the specified X window geometry [default 80x24]; 682Create the window with the specified X window geometry [default 80x24];
… …
642</dd> 787</dd>
643<p></p> 788<p></p>
644<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 789<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
645</dt> 790</dt>
646<dd> 791<dd>
647Fade the text by the given percentage when focus is lost. 792Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
793</dd>
794<p></p>
795<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
796</dt>
797<dd>
798Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
799colour is black; option <strong>-fadecolor</strong>.
648</dd> 800</dd>
649<p></p> 801<p></p>
650<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 802<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
651</dt> 803</dt>
652<dd> 804<dd>
653Tint the transparent background pixmap with the given colour. 805Tint the transparent background pixmap with the given colour; option
806<strong>-tint</strong>.
654</dd> 807</dd>
655<p></p> 808<p></p>
656<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 809<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
657</dt> 810</dt>
658<dd> 811<dd>
… …
668<p></p> 821<p></p>
669<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 822<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
670</dt> 823</dt>
671<dd> 824<dd>
672Use the specified colour for the scrollbar's trough area [default 825Use the specified colour for the scrollbar's trough area [default
673#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 826#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
674</dd> 827</dd>
675<p></p> 828<p></p>
676<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 829<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
677</dt> 830</dt>
678<dd> 831<dd>
… …
715<dd> 868<dd>
716Select the fonts to be used. This is a comma separated list of font 869Select 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. 870names that are used in turn when trying to display Unicode characters.
718The first font defines the cell size for characters; other fonts might 871The first font defines the cell size for characters; other fonts might
719be smaller, but not larger. A reasonable default font list is always 872be smaller, but not larger. A reasonable default font list is always
720appended to it. option <strong>-fn</strong>. 873appended to it; option <strong>-fn</strong>.
721</dd> 874</dd>
722<dd> 875<dd>
723<p>Each font can either be a standard X11 core font (XLFD) name, with 876<p>Each font can either be a standard X11 core font (XLFD) name, with
724optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p> 877optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
725</dd> 878</dd>
… …
786<dd> 939<dd>
787<p>If set, but empty, then this specific style is disabled and the normal 940<p>If set, but empty, then this specific style is disabled and the normal
788text font will being used for the given style.</p> 941text font will being used for the given style.</p>
789</dd> 942</dd>
790<p></p> 943<p></p>
944<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
945</dt>
946<dd>
947When font styles are not enabled, or this option is enabled (<strong>True</strong>,
948option <strong>-is</strong>, the default), bold and italic font styles imply high
949intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
950option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
951reachable.
952</dd>
953<p></p>
791<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 954<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
792</dt> 955</dt>
793<dd> 956<dd>
794Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 957Set 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 958xterm style with 2.20 old word selection, or anything else which gives
… …
798<p></p> 961<p></p>
799<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 962<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
800</dt> 963</dt>
801<dd> 964<dd>
802Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 965Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
803the author's favourite.. 966the author's favourite.
804</dd> 967</dd>
805<p></p> 968<p></p>
806<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 969<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
807</dt> 970</dt>
808<dd> 971<dd>
… …
854<dd> 1017<dd>
855Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 1018Specify 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 1019<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. 1020<strong>Shift-Print</strong> to include the scrollback as well.
858</dd> 1021</dd>
1022<dd>
1023<p>The string will be interpreted as if typed into the shell as-is.</p>
1024</dd>
1025<dd>
1026<p>Example:</p>
1027</dd>
1028<dd>
1029<pre>
1030 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1031</dd>
1032<dd>
1033<p>This creates a new file in your home directory with the screen contents
1034everytime you hit <code>Print</code>.</p>
1035</dd>
859<p></p> 1036<p></p>
860<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 1037<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
861</dt> 1038</dt>
862<dd> 1039<dd>
863<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 1040<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
… …
895<p></p> 1072<p></p>
896<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1073<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
897</dt> 1074</dt>
898<dd> 1075<dd>
899<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1076<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 1077<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>. 1078with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
902</dd> 1079</dd>
903<p></p> 1080<p></p>
904<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1081<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
905</dt> 1082</dt>
906<dd> 1083<dd>
… …
936<dd> 1113<dd>
937Set MWM hints to request a borderless window, i.e. if honoured by the 1114Set 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>. 1115WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
939</dd> 1116</dd>
940<p></p> 1117<p></p>
1118<dt><strong><a name="item_skipbuiltinglyphs_3a_boolean"><strong>skipBuiltinGlyphs:</strong> <em>boolean</em></a></strong><br />
1119</dt>
1120<dd>
1121Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
1122drawing characters and just rely on what the specified fonts provide. Use
1123this if you have a good font and want to use its block graphic glyphs;
1124option <strong>-sbg</strong>.
1125</dd>
1126<p></p>
941<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br /> 1127<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
942</dt> 1128</dt>
943<dd> 1129<dd>
944Specifies the terminal type name to be set in the <strong>TERM</strong> environment 1130Specifies the terminal type name to be set in the <strong>TERM</strong> environment
945variable; option <strong>-tn</strong>. 1131variable; option <strong>-tn</strong>.
… …
1001</dd> 1187</dd>
1002<p></p> 1188<p></p>
1003<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1189<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1004</dt> 1190</dt>
1005<dd> 1191<dd>
1006Specifies number of seconds before blanking the pointer [default 2]. 1192Specifies number of seconds before blanking the pointer [default 2]. Use a
1193large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1007</dd> 1194</dd>
1008<p></p> 1195<p></p>
1009<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1196<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1010</dt> 1197</dt>
1011<dd> 1198<dd>
… …
1046</dd> 1233</dd>
1047<p></p> 1234<p></p>
1048<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br /> 1235<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br />
1049</dt> 1236</dt>
1050<dd> 1237<dd>
1051The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 1238The 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 1239<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 1240input extension to be able to input japanese characters while staying in
1054another locale. option <strong>-imlocale</strong>. 1241another locale; option <strong>-imlocale</strong>.
1242</dd>
1243<p></p>
1244<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1245</dt>
1246<dd>
1247Specify the font-set used for XIM styles <code>OverTheSpot</code> or
1248<code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated
1249by commas), i.e. it's not in the same format as the other font lists used
1250in rxvt. The default will be set-up to chose *any* suitable found
1251found, preferably one or two pixels differing in size to the base font.
1252option <strong>-imfont</strong>.
1253</dd>
1254<p></p>
1255<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1256</dt>
1257<dd>
1258Change the meaning of triple-click selection with the left mouse
1259button. Instead of selecting a full line it will extend the selection to
1260the end of the logical line only; option <strong>-tcw</strong>.
1055</dd> 1261</dd>
1056<p></p> 1262<p></p>
1057<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1263<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1058</dt> 1264</dt>
1059<dd> 1265<dd>
1060Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1266Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1061echo arbitrary strings like the icon name or the locale. This could be 1267echo arbitrary strings like the icon name or the locale. This could be
1062abused if somebody gets 8-bit-clean access to your display, whether 1268abused if somebody gets 8-bit-clean access to your display, whether
1063throuh a mail client displaying mail bodies unfiltered or though 1269through a mail client displaying mail bodies unfiltered or through
1064write(1). Therefore, these sequences are disabled by default. (Note 1270<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1065that other terminals, including xterm, have these sequences 1271default. (Note that many other terminals, including xterm, have these
1066enabled by default). You can enable them by setting this boolean 1272sequences enabled by default, which doesn't make it safer, though).
1067resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1273</dd>
1068enabled display-answer, locale, findfont, icon label and window title 1274<dd>
1069requests as well as dynamic menubar dispatch. 1275<p>You can enable them by setting this boolean resource or specifying
1276<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1277locale, findfont, icon label and window title requests as well as dynamic
1278menubar dispatch.</p>
1070</dd> 1279</dd>
1071<p></p> 1280<p></p>
1072<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1281<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1073</dt> 1282</dt>
1074<dd> 1283<dd>
… …
1096<dd> 1305<dd>
1097Turn on/off secondary screen scroll (default enabled). If the this 1306Turn on/off secondary screen scroll (default enabled). If the this
1098option is enabled, scrolls on the secondary screen will change the 1307option is enabled, scrolls on the secondary screen will change the
1099scrollback buffer and switching to/from the secondary screen will 1308scrollback buffer and switching to/from the secondary screen will
1100instead scroll the screen up. 1309instead scroll the screen up.
1310</dd>
1311<p></p>
1312<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1313</dt>
1314<dd>
1315Turn on/off hold window after exit support. If enabled, rxvt
1316will not immediately destroy its window when the program executed within
1317it exits. Instead, it will wait till it is being killed or closed by the
1318user.
1101</dd> 1319</dd>
1102<p></p> 1320<p></p>
1103<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1321<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1104</dt> 1322</dt>
1105<dd> 1323<dd>
… …
1114<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p> 1332<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p>
1115</dd> 1333</dd>
1116<dd> 1334<dd>
1117<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to 1335<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to
1118whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1336whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1119keys are being mapped. <strong>AppKeypad</strong> is a artificial modifier mapped to the 1337keys are being mapped. <strong>AppKeypad</strong> is a synthetic modifier mapped to the
1120current application keymap mode state.</p> 1338current application keymap mode state.</p>
1121</dd> 1339</dd>
1122<dd> 1340<dd>
1123<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or 1341<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or
1124searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and 1342searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and
… …
1132<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1350<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1133<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it 1351<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1134can start or end with whitespace.</p> 1352can start or end with whitespace.</p>
1135</dd> 1353</dd>
1136<dd> 1354<dd>
1355<p>Please note that you need to double the <code>\</code> in resource files, as
1356Xlib itself does it's own de-escaping (you can use <code>\033</code> instead of
1357<code>\e</code> (and so on), which will work with both Xt and rxvt's own
1358processing).</p>
1359</dd>
1360<dd>
1137<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1361<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1138with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' 1362with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1139should be a character not used by the strings.</p> 1363should be a character not used by the strings.</p>
1140</dd> 1364</dd>
1141<dd> 1365<dd>
1142<p>Its usage can be demonstrated by an example:</p> 1366<p>Its usage can be demonstrated by an example:</p>
1143</dd> 1367</dd>
1144<dd> 1368<dd>
1145<pre> 1369<pre>
1146 URxvt.keysym.M-C-0x61: list|\e&lt;M-C-|abc|&gt;</pre> 1370 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1147</dd> 1371</dd>
1148<dd> 1372<dd>
1149<p>The above line is equivalent to the following three lines:</p> 1373<p>The above line is equivalent to the following three lines:</p>
1150</dd> 1374</dd>
1151<dd> 1375<dd>
1152<pre> 1376<pre>
1153 URxvt.keysym.Meta-Control-0x61: \e&lt;M-C-a&gt; 1377 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1154 URxvt.keysym.Meta-Control-0x62: \e&lt;M-C-b&gt; 1378 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1155 URxvt.keysym.Meta-Control-0x63: \e&lt;M-C-c&gt;</pre> 1379 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1156</dd>
1157<dd> 1380</dd>
1381<dd>
1158<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong> is 1382<p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
1159interpreted and executed as rxvt's control sequence. For example, 1383is interpreted and executed as rxvt's control sequence. For
1160<code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to 1384example the following means ``change the current locale to <code>zh_CN.GBK</code>
1161<code>zh_CN.GBK</code>.</p> 1385when Control-Meta-c is being pressed'':</p>
1386</dd>
1387<dd>
1388<pre>
1389 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1390</dd>
1391<dd>
1392<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1393is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1394manpage. For example, the <em>selection</em> extension (activated via
1395<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1396</dd>
1397<dd>
1398<pre>
1399 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1400</dd>
1401<dd>
1402<p>Due the the large number of modifier combinations, a defined key mapping
1403will match if at <em>at least</em> the specified identifiers are being set, and
1404no other key mappings with those and more bits are being defined. That
1405means that defining a key map for <code>a</code> will automatically provide
1406definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1407mappings themselves.</p>
1408</dd>
1409<dd>
1410<p>Unfortunately, this will override built-in key mappings. For example
1411if you overwrite the <code>Insert</code> key you will disable rxvt's
1412<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1413user-defined keymap using the <code>builtin:</code> replacement:</p>
1414</dd>
1415<dd>
1416<pre>
1417 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1418 URxvt.keysym.S-Insert: builtin:</pre>
1419</dd>
1420<dd>
1421<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1422of modifiers. The second line re-establishes the default mapping for
1423<code>Shift-Insert</code>.</p>
1424</dd>
1425<dd>
1426<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1427the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1428font-switching at runtime:</p>
1429</dd>
1430<dd>
1431<pre>
1432 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1433 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1434</dd>
1435<dd>
1436<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1437info):</p>
1438</dd>
1439<dd>
1440<pre>
1441 URxvt.keysym.M-C-3: command:\033[8;25;80t
1442 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1443</dd>
1444<p></p>
1445<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1446</dt>
1447<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1448</dt>
1449<dd>
1450Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1451use in this terminal instance; option <strong>-pe</strong>.
1452</dd>
1453<dd>
1454<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1455them. This can be useful to selectively disable some extensions loaded
1456by default, or specified via the <code>perl-ext-common</code> resource. For
1457example, <code>default,-selection</code> will use all the default extension except
1458<code>selection</code>.</p>
1459</dd>
1460<dd>
1461<p>Extension names can also be followed by an argument in angle brackets
1462(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for
1463searchable scorllback to Alt/Meta-s). Mentioning the same extension
1464multiple times with different arguments will pass multiple arguments to
1465the extension.</p>
1466</dd>
1467<dd>
1468<p>Each extension is looked up in the library directories, loaded if
1469necessary, and bound to the current terminal instance.</p>
1470</dd>
1471<dd>
1472<p>If both of these resources are the empty string, then the perl
1473interpreter will not be initialized. The idea behind two options is that
1474<strong>perl-ext-common</strong> will be used for extensions that should be available to
1475all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1476</dd>
1477<p></p>
1478<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1479</dt>
1480<dd>
1481Perl code to be evaluated when all extensions have been registered. See
1482the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1483will be ignored when running setuid/setgid.
1484</dd>
1485<p></p>
1486<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1487</dt>
1488<dd>
1489Colon-separated list of additional directories that hold extension
1490scripts. When looking for extensions specified by the <code>perl</code> resource,
1491rxvt will first look in these directories and then in
1492<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1493will be ignored when running setuid/setgid.
1494</dd>
1495<dd>
1496<p>See the <code>rxvtperl(3)</code> manpage.</p>
1497</dd>
1498<p></p>
1499<dt><strong><a name="item_urllauncher_3a_string"><strong>urlLauncher</strong>: <em>string</em></a></strong><br />
1500</dt>
1501<dd>
1502Specifies the program to be started with a URL argument. Used by the
1503<code>selection-popup</code> and <code>mark-urls</code> perl extensions.
1504</dd>
1505<p></p>
1506<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1507</dt>
1508<dd>
1509Sets the WM_TRANSIENT_FOR property to the given window iw.
1162</dd> 1510</dd>
1163<p></p></dl> 1511<p></p></dl>
1164<p> 1512<p>
1165</p> 1513</p>
1166<hr /> 1514<hr />
… …
1180<p>To temporarily override mouse reporting, for either the scrollbar or 1528<p>To temporarily override mouse reporting, for either the scrollbar or
1181the normal text selection/insertion, hold either the Shift or the Meta 1529the normal text selection/insertion, hold either the Shift or the Meta
1182(Alt) key while performing the desired mouse action.</p> 1530(Alt) key while performing the desired mouse action.</p>
1183<p>If mouse reporting mode is active, the normal scrollbar actions are 1531<p>If mouse reporting mode is active, the normal scrollbar actions are
1184disabled -- on the assumption that we are using a fullscreen 1532disabled -- on the assumption that we are using a fullscreen
1185application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1533application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1186(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1534(Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the
1187up and down arrows sends <strong>ESC[A</strong> (Up) and <strong>ESC[B</strong> (Down), 1535up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1188respectively.</p> 1536respectively.</p>
1189<p> 1537<p>
1190</p> 1538</p>
1191<hr /> 1539<hr />
1192<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1540<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
… …
1194<em>xterm</em>(1).</p> 1542<em>xterm</em>(1).</p>
1195<dl> 1543<dl>
1196<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br /> 1544<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br />
1197</dt> 1545</dt>
1198<dd> 1546<dd>
1199Left click at the beginning of the region, drag to the end of the 1547Left click at the beginning of the region, drag to the end of the region
1200region and release; Right click to extend the marked region; Left 1548and release; Right click to extend the marked region; Left double-click
1201double-click to select a word; Left triple-click to select the entire 1549to select a word; Left triple-click to select the entire logical line
1202line. 1550(which can span multiple screen lines), unless modified by resource
1551<strong>tripleclickwords</strong>.
1203</dd> 1552</dd>
1204<dd> 1553<dd>
1205<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1554<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1206(Compile: <em>frills</em>) will create a rectangular selection instead of a normal 1555(Compile: <em>frills</em>) will create a rectangular selection instead of a
1207one.</p> 1556normal one. In this mode, every selected row becomes its own line in the
1557selection, and trailing whitespace is visually underlined and removed from
1558the selection.</p>
1208</dd> 1559</dd>
1209<p></p> 1560<p></p>
1210<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1561<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1211</dt> 1562</dt>
1212<dd> 1563<dd>
… …
1222<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1573<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1223supported in rxvt-unicode. Bug me if you need this.</p> 1574supported in rxvt-unicode. Bug me if you need this.</p>
1224<p>You can, however, switch fonts at runtime using escape sequences (and 1575<p>You can, however, switch fonts at runtime using escape sequences (and
1225therefore using the menubar), e.g.:</p> 1576therefore using the menubar), e.g.:</p>
1226<pre> 1577<pre>
1227 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1578 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1228<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1579<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1229<p> 1580<p>
1230</p> 1581</p>
1231<hr /> 1582<hr />
1232<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1583<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
1233<p>ISO 14755 is a standard for entering and viewing unicode characters 1584<p>ISO 14755 is a standard for entering and viewing unicode characters
1234and character codes using the keyboard. It consists of 4 parts. The 1585and character codes using the keyboard. It consists of 4 parts. The
1235first part is available rxvt-unicode has been compiled with 1586first part is available rxvt-unicode has been compiled with
1236<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled 1587<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled
1237with <code>--enable-iso14755</code>.</p> 1588with <code>--enable-iso14755</code>.</p>
1238<ol> 1589<ul>
1239<li><strong><a name="item_1_3a_basic_method">1: Basic method</a></strong><br /> 1590<li><strong><a name="item_5_2e1_3a_basic_method">5.1: Basic method</a></strong><br />
1240</li> 1591</li>
1241This allows you to enter unicode characters using their hexcode. 1592This allows you to enter unicode characters using their hexcode.
1242<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter 1593<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter
1243hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will 1594hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will
1244commit the character as if it were typed directly. While holding down 1595commit the character as if it were typed directly. While holding down
… …
1249address, which you cannot type. Fortunately, the card has the e-mail 1600address, which you cannot type. Fortunately, the card has the e-mail
1250address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily 1601address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily
1251by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>, 1602by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>,
1252followed by releasing the modifier keys.</p> 1603followed by releasing the modifier keys.</p>
1253<p></p> 1604<p></p>
1254<li><strong><a name="item_2_3a_keyboard_symbols_entry_method">2: Keyboard symbols entry method</a></strong><br /> 1605<li><strong><a name="item_5_2e2_3a_keyboard_symbols_entry_method">5.2: Keyboard symbols entry method</a></strong><br />
1255</li> 1606</li>
1256This mode lets you input characters representing the keycap symbols of 1607This mode lets you input characters representing the keycap symbols of
1257your keyboard, if representable in the current locale encoding. 1608your keyboard, if representable in the current locale encoding.
1258<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing 1609<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing
1259them. The next special key (cursor keys, home etc.) you enter will not 1610them. The next special key (cursor keys, home etc.) you enter will not
… …
1261keycap symbol. The symbol will only be entered when the key has been 1612keycap symbol. The symbol will only be entered when the key has been
1262released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for 1613released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for
1263<code>ISO Level 2 Switch</code>, although your intention might have been to enter a 1614<code>ISO Level 2 Switch</code>, although your intention might have been to enter a
1264reverse tab (Shift-Tab).</p> 1615reverse tab (Shift-Tab).</p>
1265<p></p> 1616<p></p>
1266<li><strong><a name="item_3_3a_screen_2dselection_entry_method">3: Screen-selection entry method</a></strong><br /> 1617<li><strong><a name="item_5_2e3_3a_screen_2dselection_entry_method">5.3: Screen-selection entry method</a></strong><br />
1267</li> 1618</li>
1268While this is implemented already (it's basically the selection 1619While this is implemented already (it's basically the selection
1269mechanism), it could be extended by displaying a unicode character map. 1620mechanism), it could be extended by displaying a unicode character map.
1270<p></p> 1621<p></p>
1271<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 /> 1622<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 />
1272</li> 1623</li>
1273This method lets you display the unicode character code associated with 1624This method lets you display the unicode character code associated with
1274characters already displayed. 1625characters already displayed.
1275<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then 1626<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then
1276pressing and holding the left mouse button and moving around. The unicode 1627pressing and holding the left mouse button and moving around. The unicode
… …
1278pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p> 1629pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p>
1279<p>In addition to the hex codes it will display the font used to draw this 1630<p>In addition to the hex codes it will display the font used to draw this
1280character - due to implementation reasons, characters combined with 1631character - due to implementation reasons, characters combined with
1281combining characters, line drawing characters and unknown characters will 1632combining characters, line drawing characters and unknown characters will
1282always be drawn using the built-in support font.</p> 1633always be drawn using the built-in support font.</p>
1283<p></p></ol> 1634<p></p></ul>
1284<p>With respect to conformance, rxvt-unicode is supposed to be compliant to 1635<p>With respect to conformance, rxvt-unicode is supposed to be compliant to
1285both scenario A and B of ISO 14755, including part 5.2.</p> 1636both scenario A and B of ISO 14755, including part 5.2.</p>
1286<p> 1637<p>
1287</p> 1638</p>
1288<hr /> 1639<hr />
1289<h1><a name="login_stamp">LOGIN STAMP</a></h1> 1640<h1><a name="login_stamp">LOGIN STAMP</a></h1>
1290<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so 1641<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so that
1291that it can be seen via the <em>who(1)</em> command, and can accept messages. 1642it can be seen via the <em>who(1)</em> command, and can accept messages. To
1292To allow this feature, <strong>rxvt</strong> must be installed setuid root on 1643allow this feature, <strong>rxvt</strong> may need to be installed setuid root
1293some systems.</p> 1644on some systems or setgid to root or to some other group on others.</p>
1294<p> 1645<p>
1295</p> 1646</p>
1296<hr /> 1647<hr />
1297<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1> 1648<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
1298<p>In addition to the default foreground and background colours, 1649<p>In addition to the default foreground and background colours,
… …
1336<p></p></dl> 1687<p></p></dl>
1337<p> 1688<p>
1338</p> 1689</p>
1339<hr /> 1690<hr />
1340<h1><a name="environment">ENVIRONMENT</a></h1> 1691<h1><a name="environment">ENVIRONMENT</a></h1>
1341<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1692<p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
1342and <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X 1693<dl>
1343window id number of the <strong>rxvt</strong> window and it also uses and 1694<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1344sets the environment variable <strong>DISPLAY</strong> to specify which display 1695</dt>
1345terminal to use. <strong>rxvt</strong> uses the environment variables 1696<dd>
1346<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1697Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1698resources or on the commandline.
1699</dd>
1700<p></p>
1701<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1702</dt>
1703<dd>
1704Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1705compiled with XPM support, and optionally with the added extension
1706<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1707</dd>
1708<p></p>
1709<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1710</dt>
1711<dd>
1712Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1713the colour code used as default foreground/text colour (or the string
1714<code>default</code> to indicate that the default-colour escape sequence is to be
1715used), <code>bg</code> is the colour code used as default background colour (or the
1716string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1717was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1718(and do) use this information to optimize screen output.
1719</dd>
1720<p></p>
1721<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1722</dt>
1723<dd>
1724Set to the (decimal) X Window ID of the rxvt window (the toplevel
1725window, which usually has subwindows for the scrollbar, the terminal
1726window and so on).
1727</dd>
1728<p></p>
1729<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1730</dt>
1731<dd>
1732Set to the terminfo directory iff rxvt was configured with
1733<code>--with-terminfo=PATH</code>.
1734</dd>
1735<p></p>
1736<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1737</dt>
1738<dd>
1739Used by rxvt to connect to the display and set to the correct
1740display in it's child processes.
1741</dd>
1742<p></p>
1743<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1744</dt>
1745<dd>
1746The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1747</dd>
1748<p></p>
1749<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1750</dt>
1751<dd>
1752The path where rxvt looks for support files such as menu and xpm
1753files.
1754</dd>
1755<p></p>
1756<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1757</dt>
1758<dd>
1759Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1760</dd>
1761<p></p>
1762<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1763</dt>
1764<dd>
1765The unix domain socket path used by <code>rxvtc(1)</code> and
1766rxvtd(1).
1767</dd>
1768<dd>
1769<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1770</dd>
1771<p></p>
1772<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1773</dt>
1774<dd>
1775Used to locate the default directory for the unix domain socket for
1776daemon communications and to locate various resource files (such as
1777<code>.Xdefaults</code>)
1778</dd>
1779<p></p>
1780<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1781</dt>
1782<dd>
1783Directory where various X resource files are being located.
1784</dd>
1785<p></p>
1786<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1787</dt>
1788<dd>
1789If set and accessible, gives the name of a X resource file to be loaded by
1790rxvt.
1791</dd>
1792<p></p></dl>
1347<p> 1793<p>
1348</p> 1794</p>
1349<hr /> 1795<hr />
1350<h1><a name="files">FILES</a></h1> 1796<h1><a name="files">FILES</a></h1>
1351<dl> 1797<dl>
1352<dt><strong><a name="item__2fetc_2futmp"><strong>/etc/utmp</strong></a></strong><br />
1353</dt>
1354<dd>
1355System file for login records.
1356</dd>
1357<p></p>
1358<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br /> 1798<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br />
1359</dt> 1799</dt>
1360<dd> 1800<dd>
1361Color names. 1801Color names.
1362</dd> 1802</dd>
1363<p></p></dl> 1803<p></p></dl>
1364<p> 1804<p>
1365</p> 1805</p>
1366<hr /> 1806<hr />
1367<h1><a name="see_also">SEE ALSO</a></h1> 1807<h1><a name="see_also">SEE ALSO</a></h1>
1368<p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1808<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1369<p>
1370</p>
1371<hr />
1372<h1><a name="bugs">BUGS</a></h1>
1373<p>Check the BUGS file for an up-to-date list.</p>
1374<p>Cursor change support is not yet implemented.</p>
1375<p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1376<p> 1809<p>
1377</p> 1810</p>
1378<hr /> 1811<hr />
1379<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1812<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1380<dl> 1813<dl>
1381<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1814<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1382</dt> 1815</dt>
1383<dd> 1816<dd>
1384Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1817Marc A. Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;
1385</dd>
1386<p></p>
1387<dt><strong><a name="item_web_page_maintainter">Web page maintainter</a></strong><br />
1388</dt>
1389<dd> 1818</dd>
1390Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1391</dd> 1819<dd>
1392<dd>
1393<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1820<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1394</dd> 1821</dd>
1395<p></p></dl> 1822<p></p></dl>
1396<p> 1823<p>
1397</p> 1824</p>
1398<hr /> 1825<hr />
… …
1436<dd> 1863<dd>
1437Rewrote screen display and text selection routines. Project Coordinator 1864Rewrote screen display and text selection routines. Project Coordinator
1438(changes.txt 2.4.6 - rxvt-unicode) 1865(changes.txt 2.4.6 - rxvt-unicode)
1439</dd> 1866</dd>
1440<p></p> 1867<p></p>
1441<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 /> 1868<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 />
1442</dt> 1869</dt>
1443<dd> 1870<dd>
1444Forked rxvt-unicode, rewrote most of the display code and internal 1871Forked rxvt-unicode, rewrote most of the display code and internal
1445character handling to store text in unicode, improve xterm 1872character handling to store text in unicode, improve xterm
1446compatibility and apply numerous other bugfixes and extensions. 1873compatibility and apply numerous other bugfixes and extensions.

Diff Legend

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