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.6 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.53 by root, Thu Jan 26 00:09:47 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.9</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>7.3a</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
130Attempt to open a window on the named X display (<strong>-d</strong> still 131Attempt to open a window on the named X display (<strong>-d</strong> still
131respected). In the absence of this option, the display specified by the 132respected). In the absence of this option, the display specified by the
132<strong>DISPLAY</strong> environment variable is used. 133<strong>DISPLAY</strong> environment variable is used.
133</dd> 134</dd>
134<p></p> 135<p></p>
136<dt><strong><a name="item__2ddepth_bitdepth"><strong>-depth</strong> <em>bitdepth</em></a></strong><br />
137</dt>
138<dd>
139Compile <em>frills</em>: Attempt to find a visual with the given bit depth;
140resource <strong>depth</strong>.
141</dd>
142<p></p>
135<dt><strong><a name="item__2dgeometry_geom"><strong>-geometry</strong> <em>geom</em></a></strong><br /> 143<dt><strong><a name="item__2dgeometry_geom"><strong>-geometry</strong> <em>geom</em></a></strong><br />
136</dt> 144</dt>
137<dd> 145<dd>
138Window geometry (<strong>-g</strong> still respected); resource <strong>geometry</strong>. 146Window geometry (<strong>-g</strong> still respected); resource <strong>geometry</strong>.
139</dd> 147</dd>
148</dt> 156</dt>
149<dd> 157<dd>
150Turn on/off jump scrolling; resource <strong>jumpScroll</strong>. 158Turn on/off jump scrolling; resource <strong>jumpScroll</strong>.
151</dd> 159</dd>
152<p></p> 160<p></p>
153<dt><strong><a name="item__2dip_7c_2bip"><strong>-ip</strong>|<strong>+ip</strong></a></strong><br /> 161<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> 162</dt>
155<dd> 163<dd>
156Turn on/off inheriting parent window's pixmap. Alternative form is 164Turn on/off inheriting parent window's pixmap. Alternative form is
157<strong>-tr</strong>; resource <strong>inheritPixmap</strong>. 165<strong>-tr</strong>; resource <strong>inheritPixmap</strong>.
158</dd> 166</dd>
159<p></p> 167<p></p>
160<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br /> 168<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br />
161</dt> 169</dt>
162<dd> 170<dd>
163Fade the text by the given percentage when focus is lost. resource <strong>fading</strong>. 171Fade the text by the given percentage when focus is lost. Small values
172fade a little only, 100 completely replaces all colours by the fade
173colour; resource <strong>fading</strong>.
174</dd>
175<p></p>
176<dt><strong><a name="item__2dfadecolor_colour"><strong>-fadecolor</strong> <em>colour</em></a></strong><br />
177</dt>
178<dd>
179Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour
180is black. resource <strong>fadeColor</strong>.
164</dd> 181</dd>
165<p></p> 182<p></p>
166<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br /> 183<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br />
167</dt> 184</dt>
168<dd> 185<dd>
169Tint the transparent background pixmap with the given colour when 186Tint 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> 187transparency 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 188non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be
172tinting it. 189used to brighten or darken the image in addition to tinting it; resource
190<em>tintColor</em>. Example:
191</dd>
192<dd>
193<pre>
194 rxvt -tr -tint blue -sh 40</pre>
173</dd> 195</dd>
174<p></p> 196<p></p>
175<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br /> 197<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br />
176</dt> 198</dt>
177<dd> 199<dd>
228<p></p> 250<p></p>
229<dt><strong><a name="item__2dfn_fontlist"><strong>-fn</strong> <em>fontlist</em></a></strong><br /> 251<dt><strong><a name="item__2dfn_fontlist"><strong>-fn</strong> <em>fontlist</em></a></strong><br />
230</dt> 252</dt>
231<dd> 253<dd>
232Select the fonts to be used. This is a comma separated list of font names 254Select the fonts to be used. This is a comma separated list of font names
233that are used in turn when trying to display Unicode characters. The 255that are checked in order when trying to find glyphs for characters. The
234first font defines the cell size for characters; other fonts might be 256first font defines the cell size for characters; other fonts might be
235smaller, but not (in general) larger. A (hopefully) reasonable default 257smaller, but not (in general) larger. A (hopefully) reasonable default
236font list is always appended to it. See resource <strong>font</strong> for more details. 258font list is always appended to it. See resource <strong>font</strong> for more details.
237</dd> 259</dd>
238<dd> 260<dd>
251</dd> 273</dd>
252<p></p> 274<p></p>
253<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br /> 275<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br />
254</dt> 276</dt>
255<dd> 277<dd>
256Compile font-styles: The bold font list to use when bold characters are to 278Compile <em>font-styles</em>: The bold font list to use when <strong>bold</strong> characters
257be printed. See resource <strong>boldFont</strong> for details. 279are to be printed. See resource <strong>boldFont</strong> for details.
258</dd> 280</dd>
259<p></p> 281<p></p>
260<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br /> 282<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br />
261</dt> 283</dt>
262<dd> 284<dd>
263Compile font-styles: The italic font list to use when bold characters are to 285Compile <em>font-styles</em>: The italic font list to use when <em>italic</em>
264be printed. See resource <strong>italicFont</strong> for details. 286characters are to be printed. See resource <strong>italicFont</strong> for details.
265</dd> 287</dd>
266<p></p> 288<p></p>
267<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br /> 289<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br />
268</dt> 290</dt>
269<dd> 291<dd>
270Compile font-styles: The bold italic font list to use when bold characters are to 292Compile <em>font-styles</em>: The bold italic font list to use when <strong><em>bold
271be printed. See resource <strong>boldItalicFont</strong> for details. 293italic</em> </strong>&gt; characters are to be printed. See resource <strong>boldItalicFont</strong>
294for details.
295</dd>
296<p></p>
297<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br />
298</dt>
299<dd>
300Compile <em>font-styles</em>: Bold/Italic font styles imply high intensity
301foreground/background (default). See resource <strong>intensityStyles</strong> for
302details.
272</dd> 303</dd>
273<p></p> 304<p></p>
274<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br /> 305<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br />
275</dt> 306</dt>
276<dd> 307<dd>
334</dd> 365</dd>
335<p></p> 366<p></p>
336<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 367<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
337</dt> 368</dt>
338<dd> 369<dd>
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 370Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource <strong>scrollBar_floating</strong>. 371resource <strong>scrollBar_floating</strong>.
341</dd> 372</dd>
342<p></p> 373<p></p>
343<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 374<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
344</dt> 375</dt>
389</dt> 420</dt>
390<dd> 421<dd>
391Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e. 422Compile <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 423if honoured by the WM, the rxvt-unicode window will not have window
393decorations; resource <strong>borderLess</strong>. 424decorations; resource <strong>borderLess</strong>.
425</dd>
426<p></p>
427<dt><strong><a name="item__2doverride_2dredirect"><strong>-override-redirect</strong></a></strong><br />
428</dt>
429<dd>
430Compile <em>frills</em>: Sets override-redirect on the window; resource
431<strong>override-redirect</strong>.
432</dd>
433<p></p>
434<dt><strong><a name="item__2dsbg"><strong>-sbg</strong></a></strong><br />
435</dt>
436<dd>
437Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
438drawing characters and just rely on what the specified fonts provide. Use
439this if you have a good font and want to use its block graphic glyphs;
440resource <strong>skipBuiltinGlyphs</strong>.
394</dd> 441</dd>
395<p></p> 442<p></p>
396<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br /> 443<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br />
397</dt> 444</dt>
398<dd> 445<dd>
419given on the command line. If this option is used, it must be the last 466given 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 467on 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, 468run the program specified by the <strong>SHELL</strong> environment variable or,
422failing that, <em>sh(1)</em>. 469failing that, <em>sh(1)</em>.
423</dd> 470</dd>
471<dd>
472<p>Please note that you must specify a program with arguments. If you want to
473run shell commands, you have to specify the shell, like this:</p>
474</dd>
475<dd>
476<pre>
477 rxvt -e sh -c &quot;shell commands&quot;</pre>
478</dd>
424<p></p> 479<p></p>
425<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 480<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
426</dt> 481</dt>
427<dd> 482<dd>
428Window title (<strong>-T</strong> still respected); the default title is the basename 483Window title (<strong>-T</strong> still respected); the default title is the basename
509<dd> 564<dd>
510Turn on/off secondary screen scroll (default enabled); resource 565Turn on/off secondary screen scroll (default enabled); resource
511<strong>secondaryScroll</strong>. 566<strong>secondaryScroll</strong>.
512</dd> 567</dd>
513<p></p> 568<p></p>
514<dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br /> 569<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
515</dt> 570</dt>
571<dd>
572Turn on/off hold window after exit support. If enabled, rxvt
573will not immediately destroy its window when the program executed within
574it exits. Instead, it will wait till it is being killed or closed by the
575user; resource <strong>hold</strong>.
516<dd> 576</dd>
517No effect on rxvt-unicode. Simply passes through an argument to be made 577<p></p>
518available in the instance's argument list. Appears in <em>WM_COMMAND</em> in 578<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
519some window managers. 579</dt>
580<dd>
581Remap a key symbol. See resource <strong>keysym</strong>.
582</dd>
583<p></p>
584<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
585</dt>
586<dd>
587Tells rxvt to embed it's windows into an already-existing window,
588which enables applications to easily embed a terminal.
589</dd>
590<dd>
591<p>Right now, rxvt will first unmap/map the specified window, so it
592shouldn't be a top-level window. rxvt will also reconfigure it
593quite a bit, so don't expect it to keep some specific state. It's best to
594create an extra subwindow for rxvt and leave it alone.</p>
595</dd>
596<dd>
597<p>The window will not be destroyed when rxvt exits.</p>
598</dd>
599<dd>
600<p>It might be useful to know that rxvt will not close file
601descriptors passed to it (except for stdin/out/err, of course), so you
602can use file descriptors to communicate with the programs within the
603terminal. This works regardless of wether the <code>-embed</code> option was used or
604not.</p>
605</dd>
606<dd>
607<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
608used (a longer example is in <em>doc/embed</em>):</p>
609</dd>
610<dd>
611<pre>
612 my $rxvt = new Gtk2::Socket;
613 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
614 my $xid = $_[0]-&gt;window-&gt;get_xid;
615 system &quot;rxvt -embed $xid &amp;&quot;;
616 });</pre>
617</dd>
618<p></p>
619<dt><strong><a name="item__2dpty_2dfd_file_descriptor"><strong>-pty-fd</strong> <em>file descriptor</em></a></strong><br />
620</dt>
621<dd>
622Tells rxvt NOT to execute any commands or create a new pty/tty
623pair but instead use the given filehandle as the tty master. This is
624useful if you want to drive rxvt as a generic terminal emulator
625without having to run a program within it.
626</dd>
627<dd>
628<p>If this switch is given, rxvt will not create any utmp/wtmp
629entries and will not tinker with pty/tty permissions - you have to do that
630yourself if you want that.</p>
631</dd>
632<dd>
633<p>As an extremely special case, specifying <code>-1</code> will completely suppress
634pty/tty operations.</p>
635</dd>
636<dd>
637<p>Here is a example in perl that illustrates how this option can be used (a
638longer example is in <em>doc/pty-fd</em>):</p>
639</dd>
640<dd>
641<pre>
642 use IO::Pty;
643 use Fcntl;</pre>
644</dd>
645<dd>
646<pre>
647 my $pty = new IO::Pty;
648 fcntl $pty, F_SETFD, 0; # clear close-on-exec
649 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
650 close $pty;</pre>
651</dd>
652<dd>
653<pre>
654 # now communicate with rxvt
655 my $slave = $pty-&gt;slave;
656 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
657</dd>
658<p></p>
659<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br />
660</dt>
661<dd>
662Comma-separated list of perl extension scripts to use (or not to use) in
663this terminal instance. See resource <strong>perl-ext</strong> for details.
520</dd> 664</dd>
521<p></p></dl> 665<p></p></dl>
522<p> 666<p>
523</p> 667</p>
524<hr /> 668<hr />
525<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1> 669<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1>
526<p>Note: `rxvt --help' gives a list of all resources (long 670<p>Note: `rxvt --help' gives a list of all resources (long
527options) compiled into your version.</p> 671options) compiled into your version.</p>
528<p>There are two different methods that rxvt can use to get the 672<p>You can set and change the resources using X11 tools like <strong>xrdb</strong>. Many
529Xresource data: using the X libraries (Xrm*-functions) or internal
530Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
531<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
532resources using X11 tools like <strong>xset</strong>. Many distribution do also load
533settings from the <strong>~/.Xresources</strong> file when X starts.</p> 673distribution do also load settings from the <strong>~/.Xresources</strong> file when X
534<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> 674starts. rxvt will consult the following files/resources in order,
535lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 675with later settings overwriting earlier ones:</p>
536set in XAPPLOADDIR/URxvt (compile-time defined: usually 676<pre>
537<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 677 1. system-wide app-defaults file, either locale-dependent OR global
538<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist. 678 2. app-defaults file in $XAPPLRESDIR
679 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
680 4. SCREEN_RESOURCES for the current screen
681 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
539Note that when reading X resources, <strong>rxvt</strong> recognizes two 682<p>Note that when reading X resources, <strong>rxvt</strong> recognizes two class
540class names: <strong>XTerm</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows 683names: <strong>Rxvt</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows resources
541resources common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be 684common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be easily
542easily configured, while the class name <strong>URxvt</strong> allows resources 685configured, while the class name <strong>URxvt</strong> allows resources unique to
543unique to <strong>rxvt</strong>, notably colours and key-handling, to be 686<strong>rxvt</strong>, to be shared between different <strong>rxvt</strong>
544shared between different <strong>rxvt</strong> configurations. If no 687configurations. If no resources are specified, suitable defaults will
545resources are specified, suitable defaults will be used. Command-line 688be used. Command-line arguments can be used to override resource
546arguments can be used to override resource settings. The following 689settings. The following resources are supported (you might want to
547resources are allowed:</p> 690check the <code>rxvtperl(3)</code> manpage for additional settings by perl
691extensions not documented here):</p>
548<dl> 692<dl>
693<dt><strong><a name="item_depth_3a_bitdepth"><strong>depth:</strong> <em>bitdepth</em></a></strong><br />
694</dt>
695<dd>
696Compile <em>frills</em>: Attempt to find a visual with the given bit depth;
697option <strong>-depth</strong>.
698</dd>
699<p></p>
549<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br /> 700<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br />
550</dt> 701</dt>
551<dd> 702<dd>
552Create the window with the specified X window geometry [default 80x24]; 703Create the window with the specified X window geometry [default 80x24];
553option <strong>-geometry</strong>. 704option <strong>-geometry</strong>.
657</dd> 808</dd>
658<p></p> 809<p></p>
659<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 810<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
660</dt> 811</dt>
661<dd> 812<dd>
662Fade the text by the given percentage when focus is lost. 813Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
814</dd>
815<p></p>
816<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
817</dt>
818<dd>
819Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
820colour is black; option <strong>-fadecolor</strong>.
663</dd> 821</dd>
664<p></p> 822<p></p>
665<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 823<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
666</dt> 824</dt>
667<dd> 825<dd>
668Tint the transparent background pixmap with the given colour. 826Tint the transparent background pixmap with the given colour; option
827<strong>-tint</strong>.
669</dd> 828</dd>
670<p></p> 829<p></p>
671<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 830<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
672</dt> 831</dt>
673<dd> 832<dd>
683<p></p> 842<p></p>
684<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 843<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
685</dt> 844</dt>
686<dd> 845<dd>
687Use the specified colour for the scrollbar's trough area [default 846Use the specified colour for the scrollbar's trough area [default
688#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 847#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
689</dd> 848</dd>
690<p></p> 849<p></p>
691<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 850<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
692</dt> 851</dt>
693<dd> 852<dd>
707specifies an integer number of images in that direction. No image will 866specifies an integer number of images in that direction. No image will
708be magnified beyond 10 times its original size. The maximum permitted 867be magnified beyond 10 times its original size. The maximum permitted
709scale is 1000. [default 0x0+50+50] 868scale is 1000. [default 0x0+50+50]
710</dd> 869</dd>
711<p></p> 870<p></p>
712<dt><strong><a name="item_menu_3a_file_5b_3btag_5d"><strong>menu:</strong> <em>file[;tag]</em></a></strong><br />
713</dt>
714<dd>
715Read in the specified menu file (note the `.menu' extension is
716optional) and also optionally specify a starting tag to find. See the
717reference documentation for details on the syntax for the menuBar.
718</dd>
719<p></p>
720<dt><strong><a name="item_path_3a_path"><strong>path:</strong> <em>path</em></a></strong><br /> 871<dt><strong><a name="item_path_3a_path"><strong>path:</strong> <em>path</em></a></strong><br />
721</dt> 872</dt>
722<dd> 873<dd>
723Specify the colon-delimited search path for finding files (XPM and 874Specify the colon-delimited search path for finding XPM files.
724menus), in addition to the paths specified by the <strong>RXVTPATH</strong> and
725<strong>PATH</strong> environment variables.
726</dd> 875</dd>
727<p></p> 876<p></p>
728<dt><strong><a name="item_font_3a_fontlist"><strong>font:</strong> <em>fontlist</em></a></strong><br /> 877<dt><strong><a name="item_font_3a_fontlist"><strong>font:</strong> <em>fontlist</em></a></strong><br />
729</dt> 878</dt>
730<dd> 879<dd>
731Select the fonts to be used. This is a comma separated list of font 880Select the fonts to be used. This is a comma separated list of font names
732names that are used in turn when trying to display Unicode characters. 881that are checked in order when trying to find glyphs for characters. The
733The first font defines the cell size for characters; other fonts might 882first font defines the cell size for characters; other fonts might be
734be smaller, but not larger. A reasonable default font list is always 883smaller, but not (in general) larger. A (hopefully) reasonable default
735appended to it. option <strong>-fn</strong>. 884font list is always appended to it; option <strong>-fn</strong>.
736</dd> 885</dd>
737<dd> 886<dd>
738<p>Each font can either be a standard X11 core font (XLFD) name, with 887<p>Each font can either be a standard X11 core font (XLFD) name, with
739optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p> 888optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
740</dd> 889</dd>
747<dd> 896<dd>
748<p>For example, this font resource</p> 897<p>For example, this font resource</p>
749</dd> 898</dd>
750<dd> 899<dd>
751<pre> 900<pre>
752 URxvt*font: 9x15bold,\ 901 URxvt.font: 9x15bold,\
753 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 902 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
754 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 903 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
755 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 904 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
756 xft:Code2000:antialias=false</pre> 905 xft:Code2000:antialias=false</pre>
757</dd> 906</dd>
801<dd> 950<dd>
802<p>If set, but empty, then this specific style is disabled and the normal 951<p>If set, but empty, then this specific style is disabled and the normal
803text font will being used for the given style.</p> 952text font will being used for the given style.</p>
804</dd> 953</dd>
805<p></p> 954<p></p>
955<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
956</dt>
957<dd>
958When font styles are not enabled, or this option is enabled (<strong>True</strong>,
959option <strong>-is</strong>, the default), bold and italic font styles imply high
960intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
961option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
962reachable.
963</dd>
964<p></p>
806<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 965<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
807</dt> 966</dt>
808<dd> 967<dd>
809Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 968Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is
810xterm style with 2.20 old word selection, or anything else which gives 969xterm style with 2.20 old word selection, or anything else which gives
813<p></p> 972<p></p>
814<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 973<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
815</dt> 974</dt>
816<dd> 975<dd>
817Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 976Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
818the author's favourite.. 977the author's favourite.
819</dd> 978</dd>
820<p></p> 979<p></p>
821<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 980<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
822</dt> 981</dt>
823<dd> 982<dd>
869<dd> 1028<dd>
870Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 1029Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use
871<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or 1030<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or
872<strong>Shift-Print</strong> to include the scrollback as well. 1031<strong>Shift-Print</strong> to include the scrollback as well.
873</dd> 1032</dd>
1033<dd>
1034<p>The string will be interpreted as if typed into the shell as-is.</p>
1035</dd>
1036<dd>
1037<p>Example:</p>
1038</dd>
1039<dd>
1040<pre>
1041 URxvt.print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1042</dd>
1043<dd>
1044<p>This creates a new file in your home directory with the screen contents
1045everytime you hit <code>Print</code>.</p>
1046</dd>
874<p></p> 1047<p></p>
875<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 1048<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
876</dt> 1049</dt>
877<dd> 1050<dd>
878<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 1051<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
910<p></p> 1083<p></p>
911<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1084<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
912</dt> 1085</dt>
913<dd> 1086<dd>
914<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1087<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
915<strong>scrollTtyOutput</strong> is False); option <strong>+sw</strong>. <strong>False</strong>: do not scroll 1088<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll
916with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>. 1089with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
917</dd> 1090</dd>
918<p></p> 1091<p></p>
919<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1092<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
920</dt> 1093</dt>
921<dd> 1094<dd>
951<dd> 1124<dd>
952Set MWM hints to request a borderless window, i.e. if honoured by the 1125Set MWM hints to request a borderless window, i.e. if honoured by the
953WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>. 1126WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
954</dd> 1127</dd>
955<p></p> 1128<p></p>
1129<dt><strong><a name="item_skipbuiltinglyphs_3a_boolean"><strong>skipBuiltinGlyphs:</strong> <em>boolean</em></a></strong><br />
1130</dt>
1131<dd>
1132Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
1133drawing characters and just rely on what the specified fonts provide. Use
1134this if you have a good font and want to use its block graphic glyphs;
1135option <strong>-sbg</strong>.
1136</dd>
1137<p></p>
956<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br /> 1138<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
957</dt> 1139</dt>
958<dd> 1140<dd>
959Specifies the terminal type name to be set in the <strong>TERM</strong> environment 1141Specifies the terminal type name to be set in the <strong>TERM</strong> environment
960variable; option <strong>-tn</strong>. 1142variable; option <strong>-tn</strong>.
1016</dd> 1198</dd>
1017<p></p> 1199<p></p>
1018<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1200<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1019</dt> 1201</dt>
1020<dd> 1202<dd>
1021Specifies number of seconds before blanking the pointer [default 2]. 1203Specifies number of seconds before blanking the pointer [default 2]. Use a
1204large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1022</dd> 1205</dd>
1023<p></p> 1206<p></p>
1024<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1207<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1025</dt> 1208</dt>
1026<dd> 1209<dd>
1039</dd> 1222</dd>
1040<p></p> 1223<p></p>
1041<dt><strong><a name="item_cutchars_3a_string"><strong>cutchars:</strong> <em>string</em></a></strong><br /> 1224<dt><strong><a name="item_cutchars_3a_string"><strong>cutchars:</strong> <em>string</em></a></strong><br />
1042</dt> 1225</dt>
1043<dd> 1226<dd>
1044The characters used as delimiters for double-click word selection. The 1227The characters used as delimiters for double-click word selection
1045built-in default: 1228(whitespace delimiting is added automatically if resource is given).
1229</dd>
1230<dd>
1231<p>When the selection extension is in use (the default if compiled in, see
1232the <code>rxvtperl(3)</code> manpage), a suitable regex using these characters
1233will be created (if the resource exists, otherwise, no regex will be
1234created). In this mode, characters outside ISO-8859-1 can be used.</p>
1235</dd>
1236<dd>
1237<p>When the selection extension is not used, only ISO-8859-1 characters can
1238be used. If not specified, the built-in default is used:</p>
1046</dd> 1239</dd>
1047<dd> 1240<dd>
1048<p><strong>BACKSLASH ```'&amp;()*,;&lt;=</strong>?@[]{|} &gt;&gt;</p> 1241<p><strong>BACKSLASH ```'&amp;()*,;&lt;=</strong>?@[]{|} &gt;&gt;</p>
1049</dd> 1242</dd>
1050<p></p> 1243<p></p>
1064</dt> 1257</dt>
1065<dd> 1258<dd>
1066The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g. 1259The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1067<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the 1260<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1068input extension to be able to input japanese characters while staying in 1261input extension to be able to input japanese characters while staying in
1069another locale. option <strong>-imlocale</strong>. 1262another locale; option <strong>-imlocale</strong>.
1070</dd> 1263</dd>
1071<p></p> 1264<p></p>
1072<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br /> 1265<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1073</dt> 1266</dt>
1074<dd> 1267<dd>
1083<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br /> 1276<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1084</dt> 1277</dt>
1085<dd> 1278<dd>
1086Change the meaning of triple-click selection with the left mouse 1279Change the meaning of triple-click selection with the left mouse
1087button. Instead of selecting a full line it will extend the selection to 1280button. Instead of selecting a full line it will extend the selection to
1088the end of the logical line only. option <strong>-tcw</strong>. 1281the end of the logical line only; option <strong>-tcw</strong>.
1089</dd> 1282</dd>
1090<p></p> 1283<p></p>
1091<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1284<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1092</dt> 1285</dt>
1093<dd> 1286<dd>
1094Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1287Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1095echo arbitrary strings like the icon name or the locale. This could be 1288echo arbitrary strings like the icon name or the locale. This could be
1096abused if somebody gets 8-bit-clean access to your display, whether 1289abused if somebody gets 8-bit-clean access to your display, whether
1097throuh a mail client displaying mail bodies unfiltered or though 1290through a mail client displaying mail bodies unfiltered or through
1098write(1). Therefore, these sequences are disabled by default. (Note 1291<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1099that other terminals, including xterm, have these sequences 1292default. (Note that many other terminals, including xterm, have these
1100enabled by default). You can enable them by setting this boolean 1293sequences enabled by default, which doesn't make it safer, though).
1101resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1294</dd>
1102enabled display-answer, locale, findfont, icon label and window title 1295<dd>
1103requests as well as dynamic menubar dispatch. 1296<p>You can enable them by setting this boolean resource or specifying
1297<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1298locale, findfont, icon label and window title requests.</p>
1104</dd> 1299</dd>
1105<p></p> 1300<p></p>
1106<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1301<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1107</dt> 1302</dt>
1108<dd> 1303<dd>
1117Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1312Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
1118character is passed through. It may contain escape values as described 1313character is passed through. It may contain escape values as described
1119in the entry on <strong>keysym</strong> following. 1314in the entry on <strong>keysym</strong> following.
1120</dd> 1315</dd>
1121<p></p> 1316<p></p>
1122<dt><strong><a name="item_secondaryscreen_3a_bool"><strong>secondaryScreen:</strong> <em>bool</em></a></strong><br /> 1317<dt><strong><a name="item_secondaryscreen_3a_boolean"><strong>secondaryScreen:</strong> <em>boolean</em></a></strong><br />
1123</dt> 1318</dt>
1124<dd> 1319<dd>
1125Turn on/off secondary screen (default enabled). 1320Turn on/off secondary screen (default enabled).
1126</dd> 1321</dd>
1127<p></p> 1322<p></p>
1128<dt><strong><a name="item_secondaryscroll_3a_bool"><strong>secondaryScroll:</strong> <em>bool</em></a></strong><br /> 1323<dt><strong><a name="item_secondaryscroll_3a_boolean"><strong>secondaryScroll:</strong> <em>boolean</em></a></strong><br />
1129</dt> 1324</dt>
1130<dd> 1325<dd>
1131Turn on/off secondary screen scroll (default enabled). If the this 1326Turn on/off secondary screen scroll (default enabled). If the this
1132option is enabled, scrolls on the secondary screen will change the 1327option is enabled, scrolls on the secondary screen will change the
1133scrollback buffer and switching to/from the secondary screen will 1328scrollback buffer and switching to/from the secondary screen will
1134instead scroll the screen up. 1329instead scroll the screen up.
1330</dd>
1331<p></p>
1332<dt><strong><a name="item_hold_3a_boolean"><strong>hold</strong>: <em>boolean</em></a></strong><br />
1333</dt>
1334<dd>
1335Turn on/off hold window after exit support. If enabled, rxvt
1336will not immediately destroy its window when the program executed within
1337it exits. Instead, it will wait till it is being killed or closed by the
1338user.
1135</dd> 1339</dd>
1136<p></p> 1340<p></p>
1137<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1341<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1138</dt> 1342</dt>
1139<dd> 1343<dd>
1166<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1370<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1167<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it 1371<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1168can start or end with whitespace.</p> 1372can start or end with whitespace.</p>
1169</dd> 1373</dd>
1170<dd> 1374<dd>
1375<p>Please note that you need to double the <code>\</code> in resource files, as
1376Xlib itself does it's own de-escaping (you can use <code>\033</code> instead of
1377<code>\e</code> (and so on), which will work with both Xt and rxvt's own
1378processing).</p>
1379</dd>
1380<dd>
1171<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1381<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1172with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' 1382with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1173should be a character not used by the strings.</p> 1383should be a character not used by the strings.</p>
1174</dd> 1384</dd>
1175<dd> 1385<dd>
1176<p>Its usage can be demonstrated by an example:</p> 1386<p>Its usage can be demonstrated by an example:</p>
1177</dd> 1387</dd>
1178<dd> 1388<dd>
1179<pre> 1389<pre>
1180 URxvt.keysym.M-C-0x61: list|\e&lt;M-C-|abc|&gt;</pre> 1390 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1181</dd> 1391</dd>
1182<dd> 1392<dd>
1183<p>The above line is equivalent to the following three lines:</p> 1393<p>The above line is equivalent to the following three lines:</p>
1184</dd> 1394</dd>
1185<dd> 1395<dd>
1186<pre> 1396<pre>
1187 URxvt.keysym.Meta-Control-0x61: \e&lt;M-C-a&gt; 1397 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1188 URxvt.keysym.Meta-Control-0x62: \e&lt;M-C-b&gt; 1398 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1189 URxvt.keysym.Meta-Control-0x63: \e&lt;M-C-c&gt;</pre> 1399 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1190</dd>
1191<dd> 1400</dd>
1401<dd>
1192<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong> 1402<p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
1193is interpreted and executed as rxvt's control sequence. For 1403is interpreted and executed as rxvt's control sequence. For
1194example the following means ``change the current locale to <code>zh_CN.GBK</code> 1404example the following means ``change the current locale to <code>zh_CN.GBK</code>
1195when Control-Meta-c is being pressed'':</p> 1405when Control-Meta-c is being pressed'':</p>
1196</dd> 1406</dd>
1197<dd> 1407<dd>
1198<pre> 1408<pre>
1199 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007</pre> 1409 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1410</dd>
1411<dd>
1412<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1413is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1414manpage. For example, the <em>selection</em> extension (activated via
1415<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1416</dd>
1417<dd>
1418<pre>
1419 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1420</dd>
1421<dd>
1422<p>Due the the large number of modifier combinations, a defined key mapping
1423will match if at <em>at least</em> the specified identifiers are being set, and
1424no other key mappings with those and more bits are being defined. That
1425means that defining a key map for <code>a</code> will automatically provide
1426definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1427mappings themselves.</p>
1428</dd>
1429<dd>
1430<p>Unfortunately, this will override built-in key mappings. For example
1431if you overwrite the <code>Insert</code> key you will disable rxvt's
1432<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1433user-defined keymap using the <code>builtin:</code> replacement:</p>
1434</dd>
1435<dd>
1436<pre>
1437 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1438 URxvt.keysym.S-Insert: builtin:</pre>
1439</dd>
1440<dd>
1441<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1442of modifiers. The second line re-establishes the default mapping for
1443<code>Shift-Insert</code>.</p>
1200</dd> 1444</dd>
1201<dd> 1445<dd>
1202<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1446<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1203the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you cna have some limited 1447the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1204font-switching at runtime:</p> 1448font-switching at runtime:</p>
1205</dd> 1449</dd>
1206<dd> 1450<dd>
1207<pre> 1451<pre>
1208 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 1452 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1209 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007</pre> 1453 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1210</dd>
1211<dd> 1454</dd>
1212<p><code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to 1455<dd>
1213<code>zh_CN.GBK</code>.</p> 1456<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1457info):</p>
1458</dd>
1459<dd>
1460<pre>
1461 URxvt.keysym.M-C-3: command:\033[8;25;80t
1462 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1463</dd>
1464<p></p>
1465<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1466</dt>
1467<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1468</dt>
1469<dd>
1470Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1471use in this terminal instance; option <strong>-pe</strong>.
1472</dd>
1473<dd>
1474<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1475them. This can be useful to selectively disable some extensions loaded
1476by default, or specified via the <code>perl-ext-common</code> resource. For
1477example, <code>default,-selection</code> will use all the default extension except
1478<code>selection</code>.</p>
1479</dd>
1480<dd>
1481<p>Extension names can also be followed by an argument in angle brackets
1482(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for
1483searchable scorllback to Alt/Meta-s). Mentioning the same extension
1484multiple times with different arguments will pass multiple arguments to
1485the extension.</p>
1486</dd>
1487<dd>
1488<p>Each extension is looked up in the library directories, loaded if
1489necessary, and bound to the current terminal instance.</p>
1490</dd>
1491<dd>
1492<p>If both of these resources are the empty string, then the perl
1493interpreter will not be initialized. The idea behind two options is that
1494<strong>perl-ext-common</strong> will be used for extensions that should be available to
1495all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1496</dd>
1497<p></p>
1498<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1499</dt>
1500<dd>
1501Perl code to be evaluated when all extensions have been registered. See
1502the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1503will be ignored when running setuid/setgid.
1504</dd>
1505<p></p>
1506<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1507</dt>
1508<dd>
1509Colon-separated list of additional directories that hold extension
1510scripts. When looking for extensions specified by the <code>perl</code> resource,
1511rxvt will first look in these directories and then in
1512<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1513will be ignored when running setuid/setgid.
1514</dd>
1515<dd>
1516<p>See the <code>rxvtperl(3)</code> manpage.</p>
1517</dd>
1518<p></p>
1519<dt><strong><a name="item_selection_2epattern_2didx_3a_perl_2dregex"><strong>selection.pattern-<em>idx</em> </strong>&gt;: <em>perl-regex</em></a></strong><br />
1520</dt>
1521<dd>
1522Additional selection patterns, see the <code>rxvtperl(3)</code> manpage for
1523details.
1524</dd>
1525<p></p>
1526<dt><strong><a name="item_selection_2dautotransform_2eidx_3a_perl_2dtransfor"><strong>selection-autotransform.<em>idx</em> </strong>&gt;: <em>perl-transform</em></a></strong><br />
1527</dt>
1528<dd>
1529Selection auto-transform patterns, see the <code>rxvtperl(3)</code> manpage
1530for details.
1531</dd>
1532<p></p>
1533<dt><strong><a name="item_searchable_2dscrollback_3a_keysym"><strong>searchable-scrollback:</strong> <em>keysym</em></a></strong><br />
1534</dt>
1535<dd>
1536Sets the hotkey that starts the incremental scrollback buffer search
1537(default: <code>M-s</code>).
1538</dd>
1539<p></p>
1540<dt><strong><a name="item_urllauncher_3a_string"><strong>urlLauncher</strong>: <em>string</em></a></strong><br />
1541</dt>
1542<dd>
1543Specifies the program to be started with a URL argument. Used by the
1544<code>selection-popup</code> and <code>mark-urls</code> perl extensions.
1545</dd>
1546<p></p>
1547<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1548</dt>
1549<dd>
1550Compile <em>frills</em>: Sets the WM_TRANSIENT_FOR property to the given window id.
1551</dd>
1552<p></p>
1553<dt><strong><a name="item_override_2dredirect_3a_boolean"><strong>override-redirect</strong>: <em>boolean</em></a></strong><br />
1554</dt>
1555<dd>
1556Compile <em>frills</em>: Sets override-redirect for the terminal window, making
1557it almost invisible to window managers; option <strong>-override-redirect</strong>.
1214</dd> 1558</dd>
1215<p></p></dl> 1559<p></p></dl>
1216<p> 1560<p>
1217</p> 1561</p>
1218<hr /> 1562<hr />
1232<p>To temporarily override mouse reporting, for either the scrollbar or 1576<p>To temporarily override mouse reporting, for either the scrollbar or
1233the normal text selection/insertion, hold either the Shift or the Meta 1577the normal text selection/insertion, hold either the Shift or the Meta
1234(Alt) key while performing the desired mouse action.</p> 1578(Alt) key while performing the desired mouse action.</p>
1235<p>If mouse reporting mode is active, the normal scrollbar actions are 1579<p>If mouse reporting mode is active, the normal scrollbar actions are
1236disabled -- on the assumption that we are using a fullscreen 1580disabled -- on the assumption that we are using a fullscreen
1237application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1581application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1238(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1582(Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the
1239up and down arrows sends <strong>ESC[A</strong> (Up) and <strong>ESC[B</strong> (Down), 1583up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1240respectively.</p> 1584respectively.</p>
1241<p> 1585<p>
1242</p> 1586</p>
1243<hr /> 1587<hr />
1244<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1588<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
1254(which can span multiple screen lines), unless modified by resource 1598(which can span multiple screen lines), unless modified by resource
1255<strong>tripleclickwords</strong>. 1599<strong>tripleclickwords</strong>.
1256</dd> 1600</dd>
1257<dd> 1601<dd>
1258<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1602<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1259(Compile: <em>frills</em>) will create a rectangular selection instead of a normal 1603(Compile: <em>frills</em>) will create a rectangular selection instead of a
1260one.</p> 1604normal one. In this mode, every selected row becomes its own line in the
1605selection, and trailing whitespace is visually underlined and removed from
1606the selection.</p>
1261</dd> 1607</dd>
1262<p></p> 1608<p></p>
1263<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1609<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1264</dt> 1610</dt>
1265<dd> 1611<dd>
1266Pressing and releasing the Middle mouse button (or <strong>Shift-Insert</strong>) in 1612Pressing and releasing the Middle mouse button in an <strong>rxvt</strong>
1267an <strong>rxvt</strong> window causes the current text selection to be 1613window causes the value of the PRIMARY selection (or CLIPBOARD with the
1268inserted as if it had been typed on the keyboard. 1614Meta modifier) to be inserted as if it had been typed on the keyboard.
1615</dd>
1616<dd>
1617<p>Pressing <strong>Shift-Insert</strong> causes the value of the PRIMARY selection to be
1618inserted too.</p>
1269</dd> 1619</dd>
1270<p></p></dl> 1620<p></p></dl>
1271<p> 1621<p>
1272</p> 1622</p>
1273<hr /> 1623<hr />
1274<h1><a name="changing_fonts">CHANGING FONTS</a></h1> 1624<h1><a name="changing_fonts">CHANGING FONTS</a></h1>
1275<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1625<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1276supported in rxvt-unicode. Bug me if you need this.</p> 1626supported in rxvt-unicode. Bug me if you need this.</p>
1277<p>You can, however, switch fonts at runtime using escape sequences (and 1627<p>You can, however, switch fonts at runtime using escape sequences, e.g.:</p>
1278therefore using the menubar), e.g.:</p>
1279<pre> 1628<pre>
1280 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1629 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1630<p>You can use keyboard shortcuts, too:</p>
1631<pre>
1632 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1633 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007</pre>
1281<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1634<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1282<p> 1635<p>
1283</p> 1636</p>
1284<hr /> 1637<hr />
1285<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1638<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
1389<p></p></dl> 1742<p></p></dl>
1390<p> 1743<p>
1391</p> 1744</p>
1392<hr /> 1745<hr />
1393<h1><a name="environment">ENVIRONMENT</a></h1> 1746<h1><a name="environment">ENVIRONMENT</a></h1>
1394<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1747<p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
1395and <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X 1748<dl>
1396window id number of the <strong>rxvt</strong> window and it also uses and 1749<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1397sets the environment variable <strong>DISPLAY</strong> to specify which display 1750</dt>
1398terminal to use. <strong>rxvt</strong> uses the environment variables 1751<dd>
1399<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1752Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1753resources or on the commandline.
1754</dd>
1755<p></p>
1756<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1757</dt>
1758<dd>
1759Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1760compiled with XPM support, and optionally with the added extension
1761<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1762</dd>
1763<p></p>
1764<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1765</dt>
1766<dd>
1767Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1768the colour code used as default foreground/text colour (or the string
1769<code>default</code> to indicate that the default-colour escape sequence is to be
1770used), <code>bg</code> is the colour code used as default background colour (or the
1771string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1772was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1773(and do) use this information to optimize screen output.
1774</dd>
1775<p></p>
1776<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1777</dt>
1778<dd>
1779Set to the (decimal) X Window ID of the rxvt window (the toplevel
1780window, which usually has subwindows for the scrollbar, the terminal
1781window and so on).
1782</dd>
1783<p></p>
1784<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1785</dt>
1786<dd>
1787Set to the terminfo directory iff rxvt was configured with
1788<code>--with-terminfo=PATH</code>.
1789</dd>
1790<p></p>
1791<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1792</dt>
1793<dd>
1794Used by rxvt to connect to the display and set to the correct
1795display in it's child processes.
1796</dd>
1797<p></p>
1798<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1799</dt>
1800<dd>
1801The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1802</dd>
1803<p></p>
1804<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1805</dt>
1806<dd>
1807The unix domain socket path used by <code>rxvtc(1)</code> and
1808rxvtd(1).
1809</dd>
1810<dd>
1811<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1812</dd>
1813<p></p>
1814<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1815</dt>
1816<dd>
1817Used to locate the default directory for the unix domain socket for
1818daemon communications and to locate various resource files (such as
1819<code>.Xdefaults</code>)
1820</dd>
1821<p></p>
1822<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1823</dt>
1824<dd>
1825Directory where various X resource files are being located.
1826</dd>
1827<p></p>
1828<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1829</dt>
1830<dd>
1831If set and accessible, gives the name of a X resource file to be loaded by
1832rxvt.
1833</dd>
1834<p></p></dl>
1400<p> 1835<p>
1401</p> 1836</p>
1402<hr /> 1837<hr />
1403<h1><a name="files">FILES</a></h1> 1838<h1><a name="files">FILES</a></h1>
1404<dl> 1839<dl>
1410<p></p></dl> 1845<p></p></dl>
1411<p> 1846<p>
1412</p> 1847</p>
1413<hr /> 1848<hr />
1414<h1><a name="see_also">SEE ALSO</a></h1> 1849<h1><a name="see_also">SEE ALSO</a></h1>
1415<p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1850<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1416<p>
1417</p>
1418<hr />
1419<h1><a name="bugs">BUGS</a></h1>
1420<p>Check the BUGS file for an up-to-date list.</p>
1421<p>Cursor change support is not yet implemented.</p>
1422<p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1423<p> 1851<p>
1424</p> 1852</p>
1425<hr /> 1853<hr />
1426<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1854<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1427<dl> 1855<dl>
1428<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1856<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1429</dt> 1857</dt>
1430<dd> 1858<dd>
1431Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1859Marc A. Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;
1432</dd>
1433<p></p>
1434<dt><strong><a name="item_web_page_maintainter">Web page maintainter</a></strong><br />
1435</dt>
1436<dd> 1860</dd>
1437Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1438</dd> 1861<dd>
1439<dd>
1440<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1862<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1441</dd> 1863</dd>
1442<p></p></dl> 1864<p></p></dl>
1443<p> 1865<p>
1444</p> 1866</p>
1445<hr /> 1867<hr />
1479</dd> 1901</dd>
1480<p></p> 1902<p></p>
1481<dt><strong><a name="item_geoff_wing__3cgcw_40pobox_2ecom_3e">Geoff Wing <em><a href="mailto:<gcw@pobox.com"><gcw@pobox.com</a></em>&gt;</a></strong><br /> 1903<dt><strong><a name="item_geoff_wing__3cgcw_40pobox_2ecom_3e">Geoff Wing <em><a href="mailto:<gcw@pobox.com"><gcw@pobox.com</a></em>&gt;</a></strong><br />
1482</dt> 1904</dt>
1483<dd> 1905<dd>
1484Rewrote screen display and text selection routines. Project Coordinator 1906Rewrote screen display and text selection routines.
1485(changes.txt 2.4.6 - rxvt-unicode) 1907
1908</dd>
1486</dd> 1909<dd>
1910<pre>
1911
1912Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)</pre>
1913</dd>
1487<p></p> 1914<p></p>
1488<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 /> 1915<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 />
1489</dt> 1916</dt>
1490<dd> 1917<dd>
1491Forked rxvt-unicode, rewrote most of the display code and internal 1918Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1492character handling to store text in unicode, improve xterm 1919extension, random hacks, numerous bugfixes and extensions.
1493compatibility and apply numerous other bugfixes and extensions.
1494</dd> 1920</dd>
1495<dd> 1921<dd>
1496<p>Project Coordinator (Changes 1.0 -)</p> 1922<p>Project Coordinator (Changes 1.0 -)</p>
1923</dd>
1924<p></p>
1925<dt><strong><a name="item_emanuele_giaquinta__3ce_2egiaquinta_40glauco_2eit_">Emanuele Giaquinta <em><a href="mailto:<e.giaquinta@glauco.it"><e.giaquinta@glauco.it</a></em>&gt;</a></strong><br />
1926</dt>
1927<dd>
1928Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1497</dd> 1929</dd>
1498<p></p></dl> 1930<p></p></dl>
1499 1931
1500</body> 1932</body>
1501 1933

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines