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.55 by root, Sun Jan 29 22:38:43 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.4</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>xft</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>
167<dd>
168<p><em>Please note that transparency of any kind if completely unsupported by
169the author. Don't bug him with installation questions!</em></p>
170</dd>
159<p></p> 171<p></p>
160<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br /> 172<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br />
161</dt> 173</dt>
162<dd> 174<dd>
163Fade the text by the given percentage when focus is lost. resource <strong>fading</strong>. 175Fade the text by the given percentage when focus is lost. Small values
176fade a little only, 100 completely replaces all colours by the fade
177colour; resource <strong>fading</strong>.
178</dd>
179<p></p>
180<dt><strong><a name="item__2dfadecolor_colour"><strong>-fadecolor</strong> <em>colour</em></a></strong><br />
181</dt>
182<dd>
183Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour
184is opaque black. resource <strong>fadeColor</strong>.
164</dd> 185</dd>
165<p></p> 186<p></p>
166<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br /> 187<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br />
167</dt> 188</dt>
168<dd> 189<dd>
169Tint the transparent background pixmap with the given colour when 190Tint 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> 191transparency 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 192non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be
172tinting it. 193used to brighten or darken the image in addition to tinting it; resource
194<em>tintColor</em>. Example:
195</dd>
196<dd>
197<pre>
198 rxvt -tr -tint blue -sh 40</pre>
173</dd> 199</dd>
174<p></p> 200<p></p>
175<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br /> 201<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br />
176</dt> 202</dt>
177<dd> 203<dd>
228<p></p> 254<p></p>
229<dt><strong><a name="item__2dfn_fontlist"><strong>-fn</strong> <em>fontlist</em></a></strong><br /> 255<dt><strong><a name="item__2dfn_fontlist"><strong>-fn</strong> <em>fontlist</em></a></strong><br />
230</dt> 256</dt>
231<dd> 257<dd>
232Select the fonts to be used. This is a comma separated list of font names 258Select 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 259that are checked in order when trying to find glyphs for characters. The
234first font defines the cell size for characters; other fonts might be 260first font defines the cell size for characters; other fonts might be
235smaller, but not (in general) larger. A (hopefully) reasonable default 261smaller, but not (in general) larger. A (hopefully) reasonable default
236font list is always appended to it. See resource <strong>font</strong> for more details. 262font list is always appended to it. See resource <strong>font</strong> for more details.
237</dd> 263</dd>
238<dd> 264<dd>
251</dd> 277</dd>
252<p></p> 278<p></p>
253<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br /> 279<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br />
254</dt> 280</dt>
255<dd> 281<dd>
256Compile font-styles: The bold font list to use when bold characters are to 282Compile <em>font-styles</em>: The bold font list to use when <strong>bold</strong> characters
257be printed. See resource <strong>boldFont</strong> for details. 283are to be printed. See resource <strong>boldFont</strong> for details.
258</dd> 284</dd>
259<p></p> 285<p></p>
260<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br /> 286<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br />
261</dt> 287</dt>
262<dd> 288<dd>
263Compile font-styles: The italic font list to use when bold characters are to 289Compile <em>font-styles</em>: The italic font list to use when <em>italic</em>
264be printed. See resource <strong>italicFont</strong> for details. 290characters are to be printed. See resource <strong>italicFont</strong> for details.
265</dd> 291</dd>
266<p></p> 292<p></p>
267<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br /> 293<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br />
268</dt> 294</dt>
269<dd> 295<dd>
270Compile font-styles: The bold italic font list to use when bold characters are to 296Compile <em>font-styles</em>: The bold italic font list to use when <strong><em>bold
271be printed. See resource <strong>boldItalicFont</strong> for details. 297italic</em> </strong>&gt; characters are to be printed. See resource <strong>boldItalicFont</strong>
298for details.
299</dd>
300<p></p>
301<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br />
302</dt>
303<dd>
304Compile <em>font-styles</em>: Bold/Italic font styles imply high intensity
305foreground/background (default). See resource <strong>intensityStyles</strong> for
306details.
272</dd> 307</dd>
273<p></p> 308<p></p>
274<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br /> 309<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br />
275</dt> 310</dt>
276<dd> 311<dd>
334</dd> 369</dd>
335<p></p> 370<p></p>
336<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 371<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
337</dt> 372</dt>
338<dd> 373<dd>
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 374Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource <strong>scrollBar_floating</strong>. 375resource <strong>scrollBar_floating</strong>.
341</dd> 376</dd>
342<p></p> 377<p></p>
343<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 378<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
344</dt> 379</dt>
389</dt> 424</dt>
390<dd> 425<dd>
391Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e. 426Compile <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 427if honoured by the WM, the rxvt-unicode window will not have window
393decorations; resource <strong>borderLess</strong>. 428decorations; resource <strong>borderLess</strong>.
429</dd>
430<p></p>
431<dt><strong><a name="item__2doverride_2dredirect"><strong>-override-redirect</strong></a></strong><br />
432</dt>
433<dd>
434Compile <em>frills</em>: Sets override-redirect on the window; resource
435<strong>override-redirect</strong>.
436</dd>
437<p></p>
438<dt><strong><a name="item__2dsbg"><strong>-sbg</strong></a></strong><br />
439</dt>
440<dd>
441Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
442drawing characters and just rely on what the specified fonts provide. Use
443this if you have a good font and want to use its block graphic glyphs;
444resource <strong>skipBuiltinGlyphs</strong>.
394</dd> 445</dd>
395<p></p> 446<p></p>
396<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br /> 447<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br />
397</dt> 448</dt>
398<dd> 449<dd>
419given on the command line. If this option is used, it must be the last 470given 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 471on 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, 472run the program specified by the <strong>SHELL</strong> environment variable or,
422failing that, <em>sh(1)</em>. 473failing that, <em>sh(1)</em>.
423</dd> 474</dd>
475<dd>
476<p>Please note that you must specify a program with arguments. If you want to
477run shell commands, you have to specify the shell, like this:</p>
478</dd>
479<dd>
480<pre>
481 rxvt -e sh -c &quot;shell commands&quot;</pre>
482</dd>
424<p></p> 483<p></p>
425<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 484<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
426</dt> 485</dt>
427<dd> 486<dd>
428Window title (<strong>-T</strong> still respected); the default title is the basename 487Window title (<strong>-T</strong> still respected); the default title is the basename
458</dd> 517</dd>
459<p></p> 518<p></p>
460<dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br /> 519<dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br />
461</dt> 520</dt>
462<dd> 521<dd>
463The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 522The 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 523<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 524input extension to be able to input japanese characters while staying in
466another locale. 525another locale. resource <strong>imLocale</strong>.
526</dd>
527<p></p>
528<dt><strong><a name="item__2dimfont_fontset"><strong>-imfont</strong> <em>fontset</em></a></strong><br />
529</dt>
530<dd>
531Set the font set to use for the X Input Method, see resource <strong>imFont</strong>
532for more info.
533</dd>
534<p></p>
535<dt><strong><a name="item__2dtcw"><strong>-tcw</strong></a></strong><br />
536</dt>
537<dd>
538Change the meaning of triple-click selection with the left mouse
539button. Instead of selecting a full line it will extend the selection the
540end of the logical line only. resource <strong>tripleclickwords</strong>.
467</dd> 541</dd>
468<p></p> 542<p></p>
469<dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br /> 543<dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br />
470</dt> 544</dt>
471<dd> 545<dd>
494<dd> 568<dd>
495Turn on/off secondary screen scroll (default enabled); resource 569Turn on/off secondary screen scroll (default enabled); resource
496<strong>secondaryScroll</strong>. 570<strong>secondaryScroll</strong>.
497</dd> 571</dd>
498<p></p> 572<p></p>
499<dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br /> 573<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
500</dt> 574</dt>
575<dd>
576Turn on/off hold window after exit support. If enabled, rxvt
577will not immediately destroy its window when the program executed within
578it exits. Instead, it will wait till it is being killed or closed by the
579user; resource <strong>hold</strong>.
501<dd> 580</dd>
502No effect on rxvt-unicode. Simply passes through an argument to be made 581<p></p>
503available in the instance's argument list. Appears in <em>WM_COMMAND</em> in 582<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
504some window managers. 583</dt>
584<dd>
585Remap a key symbol. See resource <strong>keysym</strong>.
586</dd>
587<p></p>
588<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
589</dt>
590<dd>
591Tells rxvt to embed it's windows into an already-existing window,
592which enables applications to easily embed a terminal.
593</dd>
594<dd>
595<p>Right now, rxvt will first unmap/map the specified window, so it
596shouldn't be a top-level window. rxvt will also reconfigure it
597quite a bit, so don't expect it to keep some specific state. It's best to
598create an extra subwindow for rxvt and leave it alone.</p>
599</dd>
600<dd>
601<p>The window will not be destroyed when rxvt exits.</p>
602</dd>
603<dd>
604<p>It might be useful to know that rxvt will not close file
605descriptors passed to it (except for stdin/out/err, of course), so you
606can use file descriptors to communicate with the programs within the
607terminal. This works regardless of wether the <code>-embed</code> option was used or
608not.</p>
609</dd>
610<dd>
611<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
612used (a longer example is in <em>doc/embed</em>):</p>
613</dd>
614<dd>
615<pre>
616 my $rxvt = new Gtk2::Socket;
617 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
618 my $xid = $_[0]-&gt;window-&gt;get_xid;
619 system &quot;rxvt -embed $xid &amp;&quot;;
620 });</pre>
621</dd>
622<p></p>
623<dt><strong><a name="item__2dpty_2dfd_file_descriptor"><strong>-pty-fd</strong> <em>file descriptor</em></a></strong><br />
624</dt>
625<dd>
626Tells rxvt NOT to execute any commands or create a new pty/tty
627pair but instead use the given filehandle as the tty master. This is
628useful if you want to drive rxvt as a generic terminal emulator
629without having to run a program within it.
630</dd>
631<dd>
632<p>If this switch is given, rxvt will not create any utmp/wtmp
633entries and will not tinker with pty/tty permissions - you have to do that
634yourself if you want that.</p>
635</dd>
636<dd>
637<p>As an extremely special case, specifying <code>-1</code> will completely suppress
638pty/tty operations.</p>
639</dd>
640<dd>
641<p>Here is a example in perl that illustrates how this option can be used (a
642longer example is in <em>doc/pty-fd</em>):</p>
643</dd>
644<dd>
645<pre>
646 use IO::Pty;
647 use Fcntl;</pre>
648</dd>
649<dd>
650<pre>
651 my $pty = new IO::Pty;
652 fcntl $pty, F_SETFD, 0; # clear close-on-exec
653 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
654 close $pty;</pre>
655</dd>
656<dd>
657<pre>
658 # now communicate with rxvt
659 my $slave = $pty-&gt;slave;
660 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
661</dd>
662<p></p>
663<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br />
664</dt>
665<dd>
666Comma-separated list of perl extension scripts to use (or not to use) in
667this terminal instance. See resource <strong>perl-ext</strong> for details.
505</dd> 668</dd>
506<p></p></dl> 669<p></p></dl>
507<p> 670<p>
508</p> 671</p>
509<hr /> 672<hr />
510<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1> 673<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 674<p>Note: `rxvt --help' gives a list of all resources (long
512options) compiled into your version.</p> 675options) compiled into your version.</p>
513<p>There are two different methods that rxvt can use to get the 676<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> 677distribution 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> 678starts. rxvt will consult the following files/resources in order,
520lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 679with later settings overwriting earlier ones:</p>
521set in XAPPLOADDIR/URxvt (compile-time defined: usually 680<pre>
522<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 681 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. 682 2. app-defaults file in $XAPPLRESDIR
683 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
684 4. SCREEN_RESOURCES for the current screen
685 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
524Note that when reading X resources, <strong>rxvt</strong> recognizes two 686<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 687names: <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 688common 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 689configured, while the class name <strong>URxvt</strong> allows resources unique to
528unique to <strong>rxvt</strong>, notably colours and key-handling, to be 690<strong>rxvt</strong>, to be shared between different <strong>rxvt</strong>
529shared between different <strong>rxvt</strong> configurations. If no 691configurations. If no resources are specified, suitable defaults will
530resources are specified, suitable defaults will be used. Command-line 692be used. Command-line arguments can be used to override resource
531arguments can be used to override resource settings. The following 693settings. The following resources are supported (you might want to
532resources are allowed:</p> 694check the <code>rxvtperl(3)</code> manpage for additional settings by perl
695extensions not documented here):</p>
533<dl> 696<dl>
697<dt><strong><a name="item_depth_3a_bitdepth"><strong>depth:</strong> <em>bitdepth</em></a></strong><br />
698</dt>
699<dd>
700Compile <em>xft</em>: Attempt to find a visual with the given bit depth;
701option <strong>-depth</strong>.
702</dd>
703<p></p>
534<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br /> 704<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br />
535</dt> 705</dt>
536<dd> 706<dd>
537Create the window with the specified X window geometry [default 80x24]; 707Create the window with the specified X window geometry [default 80x24];
538option <strong>-geometry</strong>. 708option <strong>-geometry</strong>.
638<dd> 808<dd>
639<strong>True</strong>: make the background inherit the parent windows' pixmap, giving 809<strong>True</strong>: make the background inherit the parent windows' pixmap, giving
640artificial transparency. <strong>False</strong>: do not inherit the parent windows' 810artificial transparency. <strong>False</strong>: do not inherit the parent windows'
641pixmap. 811pixmap.
642</dd> 812</dd>
813<dd>
814<p><em>Please note that transparency of any kind if completely unsupported by
815the author. Don't bug him with installation questions!</em></p>
816</dd>
643<p></p> 817<p></p>
644<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 818<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
645</dt> 819</dt>
646<dd> 820<dd>
647Fade the text by the given percentage when focus is lost. 821Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
822</dd>
823<p></p>
824<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
825</dt>
826<dd>
827Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
828colour is black; option <strong>-fadecolor</strong>.
648</dd> 829</dd>
649<p></p> 830<p></p>
650<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 831<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
651</dt> 832</dt>
652<dd> 833<dd>
653Tint the transparent background pixmap with the given colour. 834Tint the transparent background pixmap with the given colour; option
835<strong>-tint</strong>.
654</dd> 836</dd>
655<p></p> 837<p></p>
656<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 838<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
657</dt> 839</dt>
658<dd> 840<dd>
668<p></p> 850<p></p>
669<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 851<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
670</dt> 852</dt>
671<dd> 853<dd>
672Use the specified colour for the scrollbar's trough area [default 854Use the specified colour for the scrollbar's trough area [default
673#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 855#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
674</dd> 856</dd>
675<p></p> 857<p></p>
676<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 858<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
677</dt> 859</dt>
678<dd> 860<dd>
692specifies an integer number of images in that direction. No image will 874specifies an integer number of images in that direction. No image will
693be magnified beyond 10 times its original size. The maximum permitted 875be magnified beyond 10 times its original size. The maximum permitted
694scale is 1000. [default 0x0+50+50] 876scale is 1000. [default 0x0+50+50]
695</dd> 877</dd>
696<p></p> 878<p></p>
697<dt><strong><a name="item_menu_3a_file_5b_3btag_5d"><strong>menu:</strong> <em>file[;tag]</em></a></strong><br />
698</dt>
699<dd>
700Read in the specified menu file (note the `.menu' extension is
701optional) and also optionally specify a starting tag to find. See the
702reference documentation for details on the syntax for the menuBar.
703</dd>
704<p></p>
705<dt><strong><a name="item_path_3a_path"><strong>path:</strong> <em>path</em></a></strong><br /> 879<dt><strong><a name="item_path_3a_path"><strong>path:</strong> <em>path</em></a></strong><br />
706</dt> 880</dt>
707<dd> 881<dd>
708Specify the colon-delimited search path for finding files (XPM and 882Specify the colon-delimited search path for finding XPM files.
709menus), in addition to the paths specified by the <strong>RXVTPATH</strong> and
710<strong>PATH</strong> environment variables.
711</dd> 883</dd>
712<p></p> 884<p></p>
713<dt><strong><a name="item_font_3a_fontlist"><strong>font:</strong> <em>fontlist</em></a></strong><br /> 885<dt><strong><a name="item_font_3a_fontlist"><strong>font:</strong> <em>fontlist</em></a></strong><br />
714</dt> 886</dt>
715<dd> 887<dd>
716Select the fonts to be used. This is a comma separated list of font 888Select the fonts to be used. This is a comma separated list of font names
717names that are used in turn when trying to display Unicode characters. 889that are checked in order when trying to find glyphs for characters. The
718The first font defines the cell size for characters; other fonts might 890first font defines the cell size for characters; other fonts might be
719be smaller, but not larger. A reasonable default font list is always 891smaller, but not (in general) larger. A (hopefully) reasonable default
720appended to it. option <strong>-fn</strong>. 892font list is always appended to it; option <strong>-fn</strong>.
721</dd> 893</dd>
722<dd> 894<dd>
723<p>Each font can either be a standard X11 core font (XLFD) name, with 895<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> 896optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
725</dd> 897</dd>
732<dd> 904<dd>
733<p>For example, this font resource</p> 905<p>For example, this font resource</p>
734</dd> 906</dd>
735<dd> 907<dd>
736<pre> 908<pre>
737 URxvt*font: 9x15bold,\ 909 URxvt.font: 9x15bold,\
738 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 910 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
739 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 911 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
740 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 912 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
741 xft:Code2000:antialias=false</pre> 913 xft:Code2000:antialias=false</pre>
742</dd> 914</dd>
786<dd> 958<dd>
787<p>If set, but empty, then this specific style is disabled and the normal 959<p>If set, but empty, then this specific style is disabled and the normal
788text font will being used for the given style.</p> 960text font will being used for the given style.</p>
789</dd> 961</dd>
790<p></p> 962<p></p>
963<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
964</dt>
965<dd>
966When font styles are not enabled, or this option is enabled (<strong>True</strong>,
967option <strong>-is</strong>, the default), bold and italic font styles imply high
968intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
969option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
970reachable.
971</dd>
972<p></p>
791<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 973<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
792</dt> 974</dt>
793<dd> 975<dd>
794Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 976Set 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 977xterm style with 2.20 old word selection, or anything else which gives
798<p></p> 980<p></p>
799<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 981<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
800</dt> 982</dt>
801<dd> 983<dd>
802Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 984Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
803the author's favourite.. 985the author's favourite.
804</dd> 986</dd>
805<p></p> 987<p></p>
806<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 988<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
807</dt> 989</dt>
808<dd> 990<dd>
854<dd> 1036<dd>
855Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 1037Specify 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 1038<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. 1039<strong>Shift-Print</strong> to include the scrollback as well.
858</dd> 1040</dd>
1041<dd>
1042<p>The string will be interpreted as if typed into the shell as-is.</p>
1043</dd>
1044<dd>
1045<p>Example:</p>
1046</dd>
1047<dd>
1048<pre>
1049 URxvt.print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1050</dd>
1051<dd>
1052<p>This creates a new file in your home directory with the screen contents
1053everytime you hit <code>Print</code>.</p>
1054</dd>
859<p></p> 1055<p></p>
860<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 1056<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
861</dt> 1057</dt>
862<dd> 1058<dd>
863<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 1059<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
895<p></p> 1091<p></p>
896<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1092<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
897</dt> 1093</dt>
898<dd> 1094<dd>
899<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1095<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 1096<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>. 1097with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
902</dd> 1098</dd>
903<p></p> 1099<p></p>
904<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1100<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
905</dt> 1101</dt>
906<dd> 1102<dd>
936<dd> 1132<dd>
937Set MWM hints to request a borderless window, i.e. if honoured by the 1133Set 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>. 1134WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
939</dd> 1135</dd>
940<p></p> 1136<p></p>
1137<dt><strong><a name="item_skipbuiltinglyphs_3a_boolean"><strong>skipBuiltinGlyphs:</strong> <em>boolean</em></a></strong><br />
1138</dt>
1139<dd>
1140Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
1141drawing characters and just rely on what the specified fonts provide. Use
1142this if you have a good font and want to use its block graphic glyphs;
1143option <strong>-sbg</strong>.
1144</dd>
1145<p></p>
941<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br /> 1146<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
942</dt> 1147</dt>
943<dd> 1148<dd>
944Specifies the terminal type name to be set in the <strong>TERM</strong> environment 1149Specifies the terminal type name to be set in the <strong>TERM</strong> environment
945variable; option <strong>-tn</strong>. 1150variable; option <strong>-tn</strong>.
1001</dd> 1206</dd>
1002<p></p> 1207<p></p>
1003<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1208<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1004</dt> 1209</dt>
1005<dd> 1210<dd>
1006Specifies number of seconds before blanking the pointer [default 2]. 1211Specifies number of seconds before blanking the pointer [default 2]. Use a
1212large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1007</dd> 1213</dd>
1008<p></p> 1214<p></p>
1009<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1215<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1010</dt> 1216</dt>
1011<dd> 1217<dd>
1024</dd> 1230</dd>
1025<p></p> 1231<p></p>
1026<dt><strong><a name="item_cutchars_3a_string"><strong>cutchars:</strong> <em>string</em></a></strong><br /> 1232<dt><strong><a name="item_cutchars_3a_string"><strong>cutchars:</strong> <em>string</em></a></strong><br />
1027</dt> 1233</dt>
1028<dd> 1234<dd>
1029The characters used as delimiters for double-click word selection. The 1235The characters used as delimiters for double-click word selection
1030built-in default: 1236(whitespace delimiting is added automatically if resource is given).
1237</dd>
1238<dd>
1239<p>When the selection extension is in use (the default if compiled in, see
1240the <code>rxvtperl(3)</code> manpage), a suitable regex using these characters
1241will be created (if the resource exists, otherwise, no regex will be
1242created). In this mode, characters outside ISO-8859-1 can be used.</p>
1243</dd>
1244<dd>
1245<p>When the selection extension is not used, only ISO-8859-1 characters can
1246be used. If not specified, the built-in default is used:</p>
1031</dd> 1247</dd>
1032<dd> 1248<dd>
1033<p><strong>BACKSLASH ```'&amp;()*,;&lt;=</strong>?@[]{|} &gt;&gt;</p> 1249<p><strong>BACKSLASH ```'&amp;()*,;&lt;=</strong>?@[]{|} &gt;&gt;</p>
1034</dd> 1250</dd>
1035<p></p> 1251<p></p>
1046</dd> 1262</dd>
1047<p></p> 1263<p></p>
1048<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br /> 1264<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br />
1049</dt> 1265</dt>
1050<dd> 1266<dd>
1051The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 1267The 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 1268<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 1269input extension to be able to input japanese characters while staying in
1054another locale. option <strong>-imlocale</strong>. 1270another locale; option <strong>-imlocale</strong>.
1271</dd>
1272<p></p>
1273<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1274</dt>
1275<dd>
1276Specify the font-set used for XIM styles <code>OverTheSpot</code> or
1277<code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated
1278by commas), i.e. it's not in the same format as the other font lists used
1279in rxvt. The default will be set-up to chose *any* suitable found
1280found, preferably one or two pixels differing in size to the base font.
1281option <strong>-imfont</strong>.
1282</dd>
1283<p></p>
1284<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1285</dt>
1286<dd>
1287Change the meaning of triple-click selection with the left mouse
1288button. Instead of selecting a full line it will extend the selection to
1289the end of the logical line only; option <strong>-tcw</strong>.
1055</dd> 1290</dd>
1056<p></p> 1291<p></p>
1057<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1292<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1058</dt> 1293</dt>
1059<dd> 1294<dd>
1060Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1295Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1061echo arbitrary strings like the icon name or the locale. This could be 1296echo arbitrary strings like the icon name or the locale. This could be
1062abused if somebody gets 8-bit-clean access to your display, whether 1297abused if somebody gets 8-bit-clean access to your display, whether
1063throuh a mail client displaying mail bodies unfiltered or though 1298through a mail client displaying mail bodies unfiltered or through
1064write(1). Therefore, these sequences are disabled by default. (Note 1299<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1065that other terminals, including xterm, have these sequences 1300default. (Note that many other terminals, including xterm, have these
1066enabled by default). You can enable them by setting this boolean 1301sequences enabled by default, which doesn't make it safer, though).
1067resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1302</dd>
1068enabled display-answer, locale, findfont, icon label and window title 1303<dd>
1069requests as well as dynamic menubar dispatch. 1304<p>You can enable them by setting this boolean resource or specifying
1305<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1306locale, findfont, icon label and window title requests.</p>
1070</dd> 1307</dd>
1071<p></p> 1308<p></p>
1072<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1309<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1073</dt> 1310</dt>
1074<dd> 1311<dd>
1083Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1320Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
1084character is passed through. It may contain escape values as described 1321character is passed through. It may contain escape values as described
1085in the entry on <strong>keysym</strong> following. 1322in the entry on <strong>keysym</strong> following.
1086</dd> 1323</dd>
1087<p></p> 1324<p></p>
1088<dt><strong><a name="item_secondaryscreen_3a_bool"><strong>secondaryScreen:</strong> <em>bool</em></a></strong><br /> 1325<dt><strong><a name="item_secondaryscreen_3a_boolean"><strong>secondaryScreen:</strong> <em>boolean</em></a></strong><br />
1089</dt> 1326</dt>
1090<dd> 1327<dd>
1091Turn on/off secondary screen (default enabled). 1328Turn on/off secondary screen (default enabled).
1092</dd> 1329</dd>
1093<p></p> 1330<p></p>
1094<dt><strong><a name="item_secondaryscroll_3a_bool"><strong>secondaryScroll:</strong> <em>bool</em></a></strong><br /> 1331<dt><strong><a name="item_secondaryscroll_3a_boolean"><strong>secondaryScroll:</strong> <em>boolean</em></a></strong><br />
1095</dt> 1332</dt>
1096<dd> 1333<dd>
1097Turn on/off secondary screen scroll (default enabled). If the this 1334Turn on/off secondary screen scroll (default enabled). If the this
1098option is enabled, scrolls on the secondary screen will change the 1335option is enabled, scrolls on the secondary screen will change the
1099scrollback buffer and switching to/from the secondary screen will 1336scrollback buffer and switching to/from the secondary screen will
1100instead scroll the screen up. 1337instead scroll the screen up.
1338</dd>
1339<p></p>
1340<dt><strong><a name="item_hold_3a_boolean"><strong>hold</strong>: <em>boolean</em></a></strong><br />
1341</dt>
1342<dd>
1343Turn on/off hold window after exit support. If enabled, rxvt
1344will not immediately destroy its window when the program executed within
1345it exits. Instead, it will wait till it is being killed or closed by the
1346user.
1101</dd> 1347</dd>
1102<p></p> 1348<p></p>
1103<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1349<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1104</dt> 1350</dt>
1105<dd> 1351<dd>
1114<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p> 1360<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p>
1115</dd> 1361</dd>
1116<dd> 1362<dd>
1117<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to 1363<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 1364whatever 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 1365keys are being mapped. <strong>AppKeypad</strong> is a synthetic modifier mapped to the
1120current application keymap mode state.</p> 1366current application keymap mode state.</p>
1121</dd> 1367</dd>
1122<dd> 1368<dd>
1123<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or 1369<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 1370searching 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, 1378<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 1379<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1134can start or end with whitespace.</p> 1380can start or end with whitespace.</p>
1135</dd> 1381</dd>
1136<dd> 1382<dd>
1383<p>Please note that you need to double the <code>\</code> in resource files, as
1384Xlib itself does it's own de-escaping (you can use <code>\033</code> instead of
1385<code>\e</code> (and so on), which will work with both Xt and rxvt's own
1386processing).</p>
1387</dd>
1388<dd>
1137<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1389<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 `/' 1390with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1139should be a character not used by the strings.</p> 1391should be a character not used by the strings.</p>
1140</dd> 1392</dd>
1141<dd> 1393<dd>
1142<p>Its usage can be demonstrated by an example:</p> 1394<p>Its usage can be demonstrated by an example:</p>
1143</dd> 1395</dd>
1144<dd> 1396<dd>
1145<pre> 1397<pre>
1146 URxvt.keysym.M-C-0x61: list|\e&lt;M-C-|abc|&gt;</pre> 1398 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1147</dd> 1399</dd>
1148<dd> 1400<dd>
1149<p>The above line is equivalent to the following three lines:</p> 1401<p>The above line is equivalent to the following three lines:</p>
1150</dd> 1402</dd>
1151<dd> 1403<dd>
1152<pre> 1404<pre>
1153 URxvt.keysym.Meta-Control-0x61: \e&lt;M-C-a&gt; 1405 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1154 URxvt.keysym.Meta-Control-0x62: \e&lt;M-C-b&gt; 1406 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1155 URxvt.keysym.Meta-Control-0x63: \e&lt;M-C-c&gt;</pre> 1407 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1156</dd>
1157<dd> 1408</dd>
1409<dd>
1158<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong> is 1410<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, 1411is 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 1412example the following means ``change the current locale to <code>zh_CN.GBK</code>
1161<code>zh_CN.GBK</code>.</p> 1413when Control-Meta-c is being pressed'':</p>
1414</dd>
1415<dd>
1416<pre>
1417 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1418</dd>
1419<dd>
1420<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1421is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1422manpage. For example, the <em>selection</em> extension (activated via
1423<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1424</dd>
1425<dd>
1426<pre>
1427 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1428</dd>
1429<dd>
1430<p>Due the the large number of modifier combinations, a defined key mapping
1431will match if at <em>at least</em> the specified identifiers are being set, and
1432no other key mappings with those and more bits are being defined. That
1433means that defining a key map for <code>a</code> will automatically provide
1434definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1435mappings themselves.</p>
1436</dd>
1437<dd>
1438<p>Unfortunately, this will override built-in key mappings. For example
1439if you overwrite the <code>Insert</code> key you will disable rxvt's
1440<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1441user-defined keymap using the <code>builtin:</code> replacement:</p>
1442</dd>
1443<dd>
1444<pre>
1445 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1446 URxvt.keysym.S-Insert: builtin:</pre>
1447</dd>
1448<dd>
1449<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1450of modifiers. The second line re-establishes the default mapping for
1451<code>Shift-Insert</code>.</p>
1452</dd>
1453<dd>
1454<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1455the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1456font-switching at runtime:</p>
1457</dd>
1458<dd>
1459<pre>
1460 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1461 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1462</dd>
1463<dd>
1464<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1465info):</p>
1466</dd>
1467<dd>
1468<pre>
1469 URxvt.keysym.M-C-3: command:\033[8;25;80t
1470 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1471</dd>
1472<p></p>
1473<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1474</dt>
1475<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1476</dt>
1477<dd>
1478Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1479use in this terminal instance; option <strong>-pe</strong>.
1480</dd>
1481<dd>
1482<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1483them. This can be useful to selectively disable some extensions loaded
1484by default, or specified via the <code>perl-ext-common</code> resource. For
1485example, <code>default,-selection</code> will use all the default extension except
1486<code>selection</code>.</p>
1487</dd>
1488<dd>
1489<p>Extension names can also be followed by an argument in angle brackets
1490(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for
1491searchable scorllback to Alt/Meta-s). Mentioning the same extension
1492multiple times with different arguments will pass multiple arguments to
1493the extension.</p>
1494</dd>
1495<dd>
1496<p>Each extension is looked up in the library directories, loaded if
1497necessary, and bound to the current terminal instance.</p>
1498</dd>
1499<dd>
1500<p>If both of these resources are the empty string, then the perl
1501interpreter will not be initialized. The idea behind two options is that
1502<strong>perl-ext-common</strong> will be used for extensions that should be available to
1503all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1504</dd>
1505<p></p>
1506<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1507</dt>
1508<dd>
1509Perl code to be evaluated when all extensions have been registered. See
1510the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1511will be ignored when running setuid/setgid.
1512</dd>
1513<p></p>
1514<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1515</dt>
1516<dd>
1517Colon-separated list of additional directories that hold extension
1518scripts. When looking for extensions specified by the <code>perl</code> resource,
1519rxvt will first look in these directories and then in
1520<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1521will be ignored when running setuid/setgid.
1522</dd>
1523<dd>
1524<p>See the <code>rxvtperl(3)</code> manpage.</p>
1525</dd>
1526<p></p>
1527<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 />
1528</dt>
1529<dd>
1530Additional selection patterns, see the <code>rxvtperl(3)</code> manpage for
1531details.
1532</dd>
1533<p></p>
1534<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 />
1535</dt>
1536<dd>
1537Selection auto-transform patterns, see the <code>rxvtperl(3)</code> manpage
1538for details.
1539</dd>
1540<p></p>
1541<dt><strong><a name="item_searchable_2dscrollback_3a_keysym"><strong>searchable-scrollback:</strong> <em>keysym</em></a></strong><br />
1542</dt>
1543<dd>
1544Sets the hotkey that starts the incremental scrollback buffer search
1545(default: <code>M-s</code>).
1546</dd>
1547<p></p>
1548<dt><strong><a name="item_urllauncher_3a_string"><strong>urlLauncher</strong>: <em>string</em></a></strong><br />
1549</dt>
1550<dd>
1551Specifies the program to be started with a URL argument. Used by the
1552<code>selection-popup</code> and <code>mark-urls</code> perl extensions.
1553</dd>
1554<p></p>
1555<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1556</dt>
1557<dd>
1558Compile <em>frills</em>: Sets the WM_TRANSIENT_FOR property to the given window id.
1559</dd>
1560<p></p>
1561<dt><strong><a name="item_override_2dredirect_3a_boolean"><strong>override-redirect</strong>: <em>boolean</em></a></strong><br />
1562</dt>
1563<dd>
1564Compile <em>frills</em>: Sets override-redirect for the terminal window, making
1565it almost invisible to window managers; option <strong>-override-redirect</strong>.
1162</dd> 1566</dd>
1163<p></p></dl> 1567<p></p></dl>
1164<p> 1568<p>
1165</p> 1569</p>
1166<hr /> 1570<hr />
1180<p>To temporarily override mouse reporting, for either the scrollbar or 1584<p>To temporarily override mouse reporting, for either the scrollbar or
1181the normal text selection/insertion, hold either the Shift or the Meta 1585the normal text selection/insertion, hold either the Shift or the Meta
1182(Alt) key while performing the desired mouse action.</p> 1586(Alt) key while performing the desired mouse action.</p>
1183<p>If mouse reporting mode is active, the normal scrollbar actions are 1587<p>If mouse reporting mode is active, the normal scrollbar actions are
1184disabled -- on the assumption that we are using a fullscreen 1588disabled -- on the assumption that we are using a fullscreen
1185application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1589application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1186(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1590(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), 1591up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1188respectively.</p> 1592respectively.</p>
1189<p> 1593<p>
1190</p> 1594</p>
1191<hr /> 1595<hr />
1192<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1596<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
1194<em>xterm</em>(1).</p> 1598<em>xterm</em>(1).</p>
1195<dl> 1599<dl>
1196<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br /> 1600<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br />
1197</dt> 1601</dt>
1198<dd> 1602<dd>
1199Left click at the beginning of the region, drag to the end of the 1603Left 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 1604and release; Right click to extend the marked region; Left double-click
1201double-click to select a word; Left triple-click to select the entire 1605to select a word; Left triple-click to select the entire logical line
1202line. 1606(which can span multiple screen lines), unless modified by resource
1607<strong>tripleclickwords</strong>.
1203</dd> 1608</dd>
1204<dd> 1609<dd>
1205<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1610<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 1611(Compile: <em>frills</em>) will create a rectangular selection instead of a
1207one.</p> 1612normal one. In this mode, every selected row becomes its own line in the
1613selection, and trailing whitespace is visually underlined and removed from
1614the selection.</p>
1208</dd> 1615</dd>
1209<p></p> 1616<p></p>
1210<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1617<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1211</dt> 1618</dt>
1212<dd> 1619<dd>
1213Pressing and releasing the Middle mouse button (or <strong>Shift-Insert</strong>) in 1620Pressing and releasing the Middle mouse button in an <strong>rxvt</strong>
1214an <strong>rxvt</strong> window causes the current text selection to be 1621window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215inserted as if it had been typed on the keyboard. 1622Meta modifier) to be inserted as if it had been typed on the keyboard.
1623</dd>
1624<dd>
1625<p>Pressing <strong>Shift-Insert</strong> causes the value of the PRIMARY selection to be
1626inserted too.</p>
1216</dd> 1627</dd>
1217<p></p></dl> 1628<p></p></dl>
1218<p> 1629<p>
1219</p> 1630</p>
1220<hr /> 1631<hr />
1221<h1><a name="changing_fonts">CHANGING FONTS</a></h1> 1632<h1><a name="changing_fonts">CHANGING FONTS</a></h1>
1222<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1633<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1223supported in rxvt-unicode. Bug me if you need this.</p> 1634supported in rxvt-unicode. Bug me if you need this.</p>
1224<p>You can, however, switch fonts at runtime using escape sequences (and 1635<p>You can, however, switch fonts at runtime using escape sequences, e.g.:</p>
1225therefore using the menubar), e.g.:</p>
1226<pre> 1636<pre>
1227 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1637 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1638<p>You can use keyboard shortcuts, too:</p>
1639<pre>
1640 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1641 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007</pre>
1228<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1642<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1229<p> 1643<p>
1230</p> 1644</p>
1231<hr /> 1645<hr />
1232<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1646<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
1233<p>ISO 14755 is a standard for entering and viewing unicode characters 1647<p>ISO 14755 is a standard for entering and viewing unicode characters
1234and character codes using the keyboard. It consists of 4 parts. The 1648and character codes using the keyboard. It consists of 4 parts. The
1235first part is available rxvt-unicode has been compiled with 1649first part is available rxvt-unicode has been compiled with
1236<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled 1650<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled
1237with <code>--enable-iso14755</code>.</p> 1651with <code>--enable-iso14755</code>.</p>
1238<ol> 1652<ul>
1239<li><strong><a name="item_1_3a_basic_method">1: Basic method</a></strong><br /> 1653<li><strong><a name="item_5_2e1_3a_basic_method">5.1: Basic method</a></strong><br />
1240</li> 1654</li>
1241This allows you to enter unicode characters using their hexcode. 1655This 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 1656<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 1657hex-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 1658commit the character as if it were typed directly. While holding down
1249address, which you cannot type. Fortunately, the card has the e-mail 1663address, 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 1664address 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>, 1665by 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> 1666followed by releasing the modifier keys.</p>
1253<p></p> 1667<p></p>
1254<li><strong><a name="item_2_3a_keyboard_symbols_entry_method">2: Keyboard symbols entry method</a></strong><br /> 1668<li><strong><a name="item_5_2e2_3a_keyboard_symbols_entry_method">5.2: Keyboard symbols entry method</a></strong><br />
1255</li> 1669</li>
1256This mode lets you input characters representing the keycap symbols of 1670This mode lets you input characters representing the keycap symbols of
1257your keyboard, if representable in the current locale encoding. 1671your keyboard, if representable in the current locale encoding.
1258<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing 1672<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 1673them. 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 1675keycap 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 1676released, 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 1677<code>ISO Level 2 Switch</code>, although your intention might have been to enter a
1264reverse tab (Shift-Tab).</p> 1678reverse tab (Shift-Tab).</p>
1265<p></p> 1679<p></p>
1266<li><strong><a name="item_3_3a_screen_2dselection_entry_method">3: Screen-selection entry method</a></strong><br /> 1680<li><strong><a name="item_5_2e3_3a_screen_2dselection_entry_method">5.3: Screen-selection entry method</a></strong><br />
1267</li> 1681</li>
1268While this is implemented already (it's basically the selection 1682While this is implemented already (it's basically the selection
1269mechanism), it could be extended by displaying a unicode character map. 1683mechanism), it could be extended by displaying a unicode character map.
1270<p></p> 1684<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 /> 1685<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> 1686</li>
1273This method lets you display the unicode character code associated with 1687This method lets you display the unicode character code associated with
1274characters already displayed. 1688characters already displayed.
1275<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then 1689<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 1690pressing 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> 1692pointer 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 1693<p>In addition to the hex codes it will display the font used to draw this
1280character - due to implementation reasons, characters combined with 1694character - due to implementation reasons, characters combined with
1281combining characters, line drawing characters and unknown characters will 1695combining characters, line drawing characters and unknown characters will
1282always be drawn using the built-in support font.</p> 1696always be drawn using the built-in support font.</p>
1283<p></p></ol> 1697<p></p></ul>
1284<p>With respect to conformance, rxvt-unicode is supposed to be compliant to 1698<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> 1699both scenario A and B of ISO 14755, including part 5.2.</p>
1286<p> 1700<p>
1287</p> 1701</p>
1288<hr /> 1702<hr />
1289<h1><a name="login_stamp">LOGIN STAMP</a></h1> 1703<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 1704<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. 1705it 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 1706allow this feature, <strong>rxvt</strong> may need to be installed setuid root
1293some systems.</p> 1707on some systems or setgid to root or to some other group on others.</p>
1294<p> 1708<p>
1295</p> 1709</p>
1296<hr /> 1710<hr />
1297<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1> 1711<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
1298<p>In addition to the default foreground and background colours, 1712<p>In addition to the default foreground and background colours,
1299<strong>rxvt</strong> can display up to 16 colours (8 ANSI colours plus 1713<strong>rxvt</strong> can display up to 16 colours (8 ANSI colours plus
1300high-intensity bold/blink versions of the same). Here is a list of the 1714high-intensity bold/blink versions of the same). Here is a list of the
1301colours with their <strong>rgb.txt</strong> names.</p> 1715colours with their names.</p>
1302<table> 1716<table>
1303<tr><td>color0</td><td>(black)</td><td>= Black</td></tr> 1717<tr><td>color0</td><td>(black)</td><td>= Black</td></tr>
1304<tr><td>color1</td><td>(red)</td><td>= Red3</td></tr> 1718<tr><td>color1</td><td>(red)</td><td>= Red3</td></tr>
1305<tr><td>color2</td><td>(green)</td><td>= Green3</td></tr> 1719<tr><td>color2</td><td>(green)</td><td>= Green3</td></tr>
1306<tr><td>color3</td><td>(yellow)</td><td>= Yellow3</td></tr> 1720<tr><td>color3</td><td>(yellow)</td><td>= Yellow3</td></tr>
1320<tr><td>background</td><td></td><td>= White</td></tr> 1734<tr><td>background</td><td></td><td>= White</td></tr>
1321</table><p>It is also possible to specify the colour values of <strong>foreground</strong>, 1735</table><p>It is also possible to specify the colour values of <strong>foreground</strong>,
1322<strong>background</strong>, <strong>cursorColor</strong>, <strong>cursorColor2</strong>, <strong>colorBD</strong>, <strong>colorUL</strong> as 1736<strong>background</strong>, <strong>cursorColor</strong>, <strong>cursorColor2</strong>, <strong>colorBD</strong>, <strong>colorUL</strong> as
1323a number 0-15, as a convenient shorthand to reference the colour name of 1737a number 0-15, as a convenient shorthand to reference the colour name of
1324color0-color15.</p> 1738color0-color15.</p>
1739<p>If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1740their act together, rxvt-unicode will support <code>rgba:rrrr/gggg/bbbb/aaaa</code>
1741(recommended, but <strong>MUST</strong> have 4 digits/component), <code>#ARGB</code>, <code>#AARRGGBB</code>
1742and <code>#AAAARRRRGGGGBBBB</code> colour specifications, in addition to the ones
1743provided by X, where the additional A component specifies alpha (opacity)
1744values (0 is completely transparent and the maximum is opaque). You
1745probably need to specify <strong>``-depth 32''</strong>, too, and have the luck that your
1746X-server uses ARGB pixel layout, as X is far from just supporting ARGB
1747visuals out of the box, and rxvt-unicode just fudges around.</p>
1748<p><em>Please note that transparency of any kind if completely unsupported by
1749the author. Don't bug him with installation questions!</em></p>
1325<p>Note that <strong>-rv</strong> (<strong>``reverseVideo: True''</strong>) simulates reverse video by 1750<p>Note that <strong>-rv</strong> (<strong>``reverseVideo: True''</strong>) simulates reverse video by
1326always swapping the foreground/background colours. This is in contrast to 1751always swapping the foreground/background colours. This is in contrast to
1327<em>xterm</em>(1) where the colours are only swapped if they have not otherwise 1752<em>xterm</em>(1) where the colours are only swapped if they have not otherwise
1328been specified. For example,</p> 1753been specified. For example,</p>
1329<dl> 1754<dl>
1336<p></p></dl> 1761<p></p></dl>
1337<p> 1762<p>
1338</p> 1763</p>
1339<hr /> 1764<hr />
1340<h1><a name="environment">ENVIRONMENT</a></h1> 1765<h1><a name="environment">ENVIRONMENT</a></h1>
1341<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1766<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 1767<dl>
1343window id number of the <strong>rxvt</strong> window and it also uses and 1768<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1344sets the environment variable <strong>DISPLAY</strong> to specify which display 1769</dt>
1345terminal to use. <strong>rxvt</strong> uses the environment variables 1770<dd>
1346<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1771Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1772resources or on the commandline.
1773</dd>
1774<p></p>
1775<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1776</dt>
1777<dd>
1778Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1779compiled with XPM support, and optionally with the added extension
1780<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1781</dd>
1782<p></p>
1783<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1784</dt>
1785<dd>
1786Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1787the colour code used as default foreground/text colour (or the string
1788<code>default</code> to indicate that the default-colour escape sequence is to be
1789used), <code>bg</code> is the colour code used as default background colour (or the
1790string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1791was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1792(and do) use this information to optimize screen output.
1793</dd>
1794<p></p>
1795<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1796</dt>
1797<dd>
1798Set to the (decimal) X Window ID of the rxvt window (the toplevel
1799window, which usually has subwindows for the scrollbar, the terminal
1800window and so on).
1801</dd>
1802<p></p>
1803<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1804</dt>
1805<dd>
1806Set to the terminfo directory iff rxvt was configured with
1807<code>--with-terminfo=PATH</code>.
1808</dd>
1809<p></p>
1810<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1811</dt>
1812<dd>
1813Used by rxvt to connect to the display and set to the correct
1814display in it's child processes.
1815</dd>
1816<p></p>
1817<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1818</dt>
1819<dd>
1820The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1821</dd>
1822<p></p>
1823<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1824</dt>
1825<dd>
1826The unix domain socket path used by <code>rxvtc(1)</code> and
1827rxvtd(1).
1828</dd>
1829<dd>
1830<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1831</dd>
1832<p></p>
1833<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1834</dt>
1835<dd>
1836Used to locate the default directory for the unix domain socket for
1837daemon communications and to locate various resource files (such as
1838<code>.Xdefaults</code>)
1839</dd>
1840<p></p>
1841<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1842</dt>
1843<dd>
1844Directory where various X resource files are being located.
1845</dd>
1846<p></p>
1847<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1848</dt>
1849<dd>
1850If set and accessible, gives the name of a X resource file to be loaded by
1851rxvt.
1852</dd>
1853<p></p></dl>
1347<p> 1854<p>
1348</p> 1855</p>
1349<hr /> 1856<hr />
1350<h1><a name="files">FILES</a></h1> 1857<h1><a name="files">FILES</a></h1>
1351<dl> 1858<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 /> 1859<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br />
1359</dt> 1860</dt>
1360<dd> 1861<dd>
1361Color names. 1862Color names.
1362</dd> 1863</dd>
1363<p></p></dl> 1864<p></p></dl>
1364<p> 1865<p>
1365</p> 1866</p>
1366<hr /> 1867<hr />
1367<h1><a name="see_also">SEE ALSO</a></h1> 1868<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> 1869<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> 1870<p>
1377</p> 1871</p>
1378<hr /> 1872<hr />
1379<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1873<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1380<dl> 1874<dl>
1381<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1875<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1382</dt> 1876</dt>
1383<dd> 1877<dd>
1384Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1878Marc 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> 1879</dd>
1390Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1391</dd> 1880<dd>
1392<dd>
1393<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1881<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1394</dd> 1882</dd>
1395<p></p></dl> 1883<p></p></dl>
1396<p> 1884<p>
1397</p> 1885</p>
1398<hr /> 1886<hr />
1432</dd> 1920</dd>
1433<p></p> 1921<p></p>
1434<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 /> 1922<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 />
1435</dt> 1923</dt>
1436<dd> 1924<dd>
1437Rewrote screen display and text selection routines. Project Coordinator 1925Rewrote screen display and text selection routines.
1438(changes.txt 2.4.6 - rxvt-unicode) 1926
1927</dd>
1439</dd> 1928<dd>
1929<pre>
1930
1931Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)</pre>
1932</dd>
1440<p></p> 1933<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 /> 1934<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> 1935</dt>
1443<dd> 1936<dd>
1444Forked rxvt-unicode, rewrote most of the display code and internal 1937Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1445character handling to store text in unicode, improve xterm 1938extension, random hacks, numerous bugfixes and extensions.
1446compatibility and apply numerous other bugfixes and extensions.
1447</dd> 1939</dd>
1448<dd> 1940<dd>
1449<p>Project Coordinator (Changes 1.0 -)</p> 1941<p>Project Coordinator (Changes 1.0 -)</p>
1942</dd>
1943<p></p>
1944<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 />
1945</dt>
1946<dd>
1947Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1450</dd> 1948</dd>
1451<p></p></dl> 1949<p></p></dl>
1452 1950
1453</body> 1951</body>
1454 1952

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines