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.29 by root, Mon Jan 2 15:11:05 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>6.2</strong>, is a colour vt102 terminal
53emulator intended as an <em>xterm</em>(1) replacement for users who do not 52emulator intended as an <em>xterm</em>(1) replacement for users who do not
54require features such as Tektronix 4014 emulation and toolkit-style 53require features such as Tektronix 4014 emulation and toolkit-style
55configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- 54configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
56a significant advantage on a machine serving many X sessions.</p> 55a significant advantage on a machine serving many X sessions.</p>
57<p> 56<p>
58</p> 57</p>
59<hr /> 58<hr />
60<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1> 59<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
61<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of frequently 60<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of
62asked questions and answer to them and some common problems.</p> 61frequently asked questions and answer to them and some common
62problems. That document is also accessible on the World-Wide-Web at
63<a href="http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html</a>.</p>
63<p> 64<p>
64</p> 65</p>
65<hr /> 66<hr />
66<h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1> 67<h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1>
67<p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode 68<p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode
… …
148</dt> 149</dt>
149<dd> 150<dd>
150Turn on/off jump scrolling; resource <strong>jumpScroll</strong>. 151Turn on/off jump scrolling; resource <strong>jumpScroll</strong>.
151</dd> 152</dd>
152<p></p> 153<p></p>
153<dt><strong><a name="item__2dip_7c_2bip"><strong>-ip</strong>|<strong>+ip</strong></a></strong><br /> 154<dt><strong><a name="item__2dip_7c_2bip__7c__2dtr_7c_2btr"><strong>-ip</strong>|<strong>+ip</strong> | <strong>-tr</strong>|<strong>+tr</strong></a></strong><br />
154</dt> 155</dt>
155<dd> 156<dd>
156Turn on/off inheriting parent window's pixmap. Alternative form is 157Turn on/off inheriting parent window's pixmap. Alternative form is
157<strong>-tr</strong>; resource <strong>inheritPixmap</strong>. 158<strong>-tr</strong>; resource <strong>inheritPixmap</strong>.
158</dd> 159</dd>
159<p></p> 160<p></p>
160<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br /> 161<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br />
161</dt> 162</dt>
162<dd> 163<dd>
163Fade the text by the given percentage when focus is lost. resource <strong>fading</strong>. 164Fade the text by the given percentage when focus is lost. Small values
165fade a little only, 100 completely replaces all colours by the fade
166colour; resource <strong>fading</strong>.
167</dd>
168<p></p>
169<dt><strong><a name="item__2dfadecolor_colour"><strong>-fadecolor</strong> <em>colour</em></a></strong><br />
170</dt>
171<dd>
172Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour
173is black. resource <strong>fadeColor</strong>.
164</dd> 174</dd>
165<p></p> 175<p></p>
166<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br /> 176<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br />
167</dt> 177</dt>
168<dd> 178<dd>
169Tint the transparent background pixmap with the given colour when 179Tint the transparent background pixmap with the given colour when
170transparency is enabled with <strong>-tr</strong> or <strong>-ip</strong>. See also the <strong>-sh</strong> 180transparency is enabled with <strong>-tr</strong> or <strong>-ip</strong>. This only works for
171option that can be used to brighten or darken the image in addition to 181non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be
172tinting it. 182used to brighten or darken the image in addition to tinting it; resource
183<em>tintColor</em>. Example:
184</dd>
185<dd>
186<pre>
187 rxvt -tr -tint blue -sh 40</pre>
173</dd> 188</dd>
174<p></p> 189<p></p>
175<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br /> 190<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br />
176</dt> 191</dt>
177<dd> 192<dd>
… …
269<dd> 284<dd>
270Compile font-styles: The bold italic font list to use when bold characters are to 285Compile font-styles: The bold italic font list to use when bold characters are to
271be printed. See resource <strong>boldItalicFont</strong> for details. 286be printed. See resource <strong>boldItalicFont</strong> for details.
272</dd> 287</dd>
273<p></p> 288<p></p>
289<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br />
290</dt>
291<dd>
292Compile font-styles: Bold/Italic font styles imply high intensity
293foreground/background (default). See resource <strong>intensityStyles</strong> for
294details.
295</dd>
296<p></p>
274<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br /> 297<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br />
275</dt> 298</dt>
276<dd> 299<dd>
277Specify the application name under which resources are to be obtained, 300Specify the application name under which resources are to be obtained,
278rather than the default executable file name. Name should not contain 301rather than the default executable file name. Name should not contain
… …
334</dd> 357</dd>
335<p></p> 358<p></p>
336<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 359<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
337</dt> 360</dt>
338<dd> 361<dd>
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 362Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource <strong>scrollBar_floating</strong>. 363resource <strong>scrollBar_floating</strong>.
341</dd> 364</dd>
342<p></p> 365<p></p>
343<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 366<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
344</dt> 367</dt>
… …
419given on the command line. If this option is used, it must be the last 442given 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 443on 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, 444run the program specified by the <strong>SHELL</strong> environment variable or,
422failing that, <em>sh(1)</em>. 445failing that, <em>sh(1)</em>.
423</dd> 446</dd>
447<dd>
448<p>Please note that you must specify a program with arguments. If you want to
449run shell commands, you have to specify the shell, like this:</p>
450</dd>
451<dd>
452<pre>
453 rxvt -e sh -c &quot;shell commands&quot;</pre>
454</dd>
424<p></p> 455<p></p>
425<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 456<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
426</dt> 457</dt>
427<dd> 458<dd>
428Window title (<strong>-T</strong> still respected); the default title is the basename 459Window title (<strong>-T</strong> still respected); the default title is the basename
… …
509<dd> 540<dd>
510Turn on/off secondary screen scroll (default enabled); resource 541Turn on/off secondary screen scroll (default enabled); resource
511<strong>secondaryScroll</strong>. 542<strong>secondaryScroll</strong>.
512</dd> 543</dd>
513<p></p> 544<p></p>
514<dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br /> 545<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
515</dt> 546</dt>
547<dd>
548Turn on/off hold window after exit support. If enabled, rxvt
549will not immediately destroy its window when the program executed within
550it exits. Instead, it will wait till it is being killed or closed by the
551user; resource <strong>hold</strong>.
516<dd> 552</dd>
517No effect on rxvt-unicode. Simply passes through an argument to be made 553<p></p>
518available in the instance's argument list. Appears in <em>WM_COMMAND</em> in 554<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
519some window managers. 555</dt>
556<dd>
557Remap a key symbol. See resource <strong>keysym</strong>.
558</dd>
559<p></p>
560<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
561</dt>
562<dd>
563Tells rxvt to embed it's windows into an already-existing window,
564which enables applications to easily embed a terminal.
565</dd>
566<dd>
567<p>Right now, rxvt will first unmap/map the specified window, so it
568shouldn't be a top-level window. rxvt will also reconfigure it
569quite a bit, so don't expect it to keep some specific state. It's best to
570create an extra subwindow for rxvt and leave it alone.</p>
571</dd>
572<dd>
573<p>The window will not be destroyed when rxvt exits.</p>
574</dd>
575<dd>
576<p>It might be useful to know that rxvt will not close file
577descriptors passed to it (except for stdin/out/err, of course), so you
578can use file descriptors to communicate with the programs within the
579terminal. This works regardless of wether the <code>-embed</code> option was used or
580not.</p>
581</dd>
582<dd>
583<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
584used (a longer example is in <em>doc/embed</em>):</p>
585</dd>
586<dd>
587<pre>
588 my $rxvt = new Gtk2::Socket;
589 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
590 my $xid = $_[0]-&gt;window-&gt;get_xid;
591 system &quot;rxvt -embed $xid &amp;&quot;;
592 });</pre>
593</dd>
594<p></p>
595<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br />
596</dt>
597<dd>
598Tells rxvt NOT to execute any commands or create a new pty/tty
599pair but instead use the given filehandle as the tty master. This is
600useful if you want to drive rxvt as a generic terminal emulator
601without having to run a program within it.
602</dd>
603<dd>
604<p>If this switch is given, rxvt will not create any utmp/wtmp
605entries and will not tinker with pty/tty permissions - you have to do that
606yourself if you want that.</p>
607</dd>
608<dd>
609<p>Here is a example in perl that illustrates how this option can be used (a
610longer example is in <em>doc/pty-fd</em>):</p>
611</dd>
612<dd>
613<pre>
614 use IO::Pty;
615 use Fcntl;</pre>
616</dd>
617<dd>
618<pre>
619 my $pty = new IO::Pty;
620 fcntl $pty, F_SETFD, 0; # clear close-on-exec
621 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
622 close $pty;</pre>
623</dd>
624<dd>
625<pre>
626 # now communicate with rxvt
627 my $slave = $pty-&gt;slave;
628 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
520</dd> 629</dd>
521<p></p></dl> 630<p></p></dl>
522<p> 631<p>
523</p> 632</p>
524<hr /> 633<hr />
… …
527options) compiled into your version.</p> 636options) compiled into your version.</p>
528<p>There are two different methods that rxvt can use to get the 637<p>There are two different methods that rxvt can use to get the
529Xresource data: using the X libraries (Xrm*-functions) or internal 638Xresource data: using the X libraries (Xrm*-functions) or internal
530Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie. 639Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
531<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the 640<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 641resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
533settings from the <strong>~/.Xresources</strong> file when X starts.</p> 642settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
643will consult the following files/resources in order, with later settings
644overwriting earlier ones:</p>
645<pre>
646 1. system-wide app-defaults file, either locale-dependent OR global
647 2. app-defaults file in $XAPPLRESDIR
648 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
649 4. SCREEN_RESOURCES for the current screen
650 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
534<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> 651<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
535lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 652lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
536set in XAPPLOADDIR/URxvt (compile-time defined: usually 653set in XAPPLOADDIR/URxvt (compile-time defined: usually
537<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 654<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
538<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist. 655<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
… …
657</dd> 774</dd>
658<p></p> 775<p></p>
659<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 776<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
660</dt> 777</dt>
661<dd> 778<dd>
662Fade the text by the given percentage when focus is lost. 779Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
780</dd>
781<p></p>
782<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
783</dt>
784<dd>
785Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
786colour is black; option <strong>-fadecolor</strong>.
663</dd> 787</dd>
664<p></p> 788<p></p>
665<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 789<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
666</dt> 790</dt>
667<dd> 791<dd>
668Tint the transparent background pixmap with the given colour. 792Tint the transparent background pixmap with the given colour; option
793<strong>-tint</strong>.
669</dd> 794</dd>
670<p></p> 795<p></p>
671<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 796<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
672</dt> 797</dt>
673<dd> 798<dd>
… …
683<p></p> 808<p></p>
684<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 809<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
685</dt> 810</dt>
686<dd> 811<dd>
687Use the specified colour for the scrollbar's trough area [default 812Use the specified colour for the scrollbar's trough area [default
688#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 813#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
689</dd> 814</dd>
690<p></p> 815<p></p>
691<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 816<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
692</dt> 817</dt>
693<dd> 818<dd>
… …
801<dd> 926<dd>
802<p>If set, but empty, then this specific style is disabled and the normal 927<p>If set, but empty, then this specific style is disabled and the normal
803text font will being used for the given style.</p> 928text font will being used for the given style.</p>
804</dd> 929</dd>
805<p></p> 930<p></p>
931<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
932</dt>
933<dd>
934When font styles are not enabled, or this option is enabled (<strong>True</strong>,
935option <strong>-is</strong>, the default), bold and italic font styles imply high
936intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
937option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
938reachable.
939</dd>
940<p></p>
806<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 941<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
807</dt> 942</dt>
808<dd> 943<dd>
809Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 944Set 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 945xterm style with 2.20 old word selection, or anything else which gives
… …
813<p></p> 948<p></p>
814<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 949<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
815</dt> 950</dt>
816<dd> 951<dd>
817Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 952Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
818the author's favourite.. 953the author's favourite.
819</dd> 954</dd>
820<p></p> 955<p></p>
821<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 956<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
822</dt> 957</dt>
823<dd> 958<dd>
… …
869<dd> 1004<dd>
870Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 1005Specify 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 1006<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. 1007<strong>Shift-Print</strong> to include the scrollback as well.
873</dd> 1008</dd>
1009<dd>
1010<p>The string will be interpreted as if typed into the shell as-is.</p>
1011</dd>
1012<dd>
1013<p>Example:</p>
1014</dd>
1015<dd>
1016<pre>
1017 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1018</dd>
1019<dd>
1020<p>This creates a new file in your home directory with the screen contents
1021everytime you hit <code>Print</code>.</p>
1022</dd>
874<p></p> 1023<p></p>
875<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 1024<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
876</dt> 1025</dt>
877<dd> 1026<dd>
878<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 1027<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
… …
910<p></p> 1059<p></p>
911<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1060<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
912</dt> 1061</dt>
913<dd> 1062<dd>
914<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1063<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 1064<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>. 1065with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
917</dd> 1066</dd>
918<p></p> 1067<p></p>
919<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1068<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
920</dt> 1069</dt>
921<dd> 1070<dd>
… …
1016</dd> 1165</dd>
1017<p></p> 1166<p></p>
1018<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1167<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1019</dt> 1168</dt>
1020<dd> 1169<dd>
1021Specifies number of seconds before blanking the pointer [default 2]. 1170Specifies number of seconds before blanking the pointer [default 2]. Use a
1171large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1022</dd> 1172</dd>
1023<p></p> 1173<p></p>
1024<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1174<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1025</dt> 1175</dt>
1026<dd> 1176<dd>
… …
1092</dt> 1242</dt>
1093<dd> 1243<dd>
1094Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1244Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1095echo arbitrary strings like the icon name or the locale. This could be 1245echo arbitrary strings like the icon name or the locale. This could be
1096abused if somebody gets 8-bit-clean access to your display, whether 1246abused if somebody gets 8-bit-clean access to your display, whether
1097throuh a mail client displaying mail bodies unfiltered or though 1247through a mail client displaying mail bodies unfiltered or through
1098write(1). Therefore, these sequences are disabled by default. (Note 1248<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1099that other terminals, including xterm, have these sequences 1249default. (Note that many other terminals, including xterm, have these
1100enabled by default). You can enable them by setting this boolean 1250sequences enabled by default, which doesn't make it safer, though).
1101resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1251</dd>
1102enabled display-answer, locale, findfont, icon label and window title 1252<dd>
1103requests as well as dynamic menubar dispatch. 1253<p>You can enable them by setting this boolean resource or specifying
1254<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1255locale, findfont, icon label and window title requests as well as dynamic
1256menubar dispatch.</p>
1104</dd> 1257</dd>
1105<p></p> 1258<p></p>
1106<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1259<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1107</dt> 1260</dt>
1108<dd> 1261<dd>
… …
1130<dd> 1283<dd>
1131Turn on/off secondary screen scroll (default enabled). If the this 1284Turn on/off secondary screen scroll (default enabled). If the this
1132option is enabled, scrolls on the secondary screen will change the 1285option is enabled, scrolls on the secondary screen will change the
1133scrollback buffer and switching to/from the secondary screen will 1286scrollback buffer and switching to/from the secondary screen will
1134instead scroll the screen up. 1287instead scroll the screen up.
1288</dd>
1289<p></p>
1290<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1291</dt>
1292<dd>
1293Turn on/off hold window after exit support. If enabled, rxvt
1294will not immediately destroy its window when the program executed within
1295it exits. Instead, it will wait till it is being killed or closed by the
1296user.
1135</dd> 1297</dd>
1136<p></p> 1298<p></p>
1137<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1299<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1138</dt> 1300</dt>
1139<dd> 1301<dd>
… …
1166<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1328<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 1329<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1168can start or end with whitespace.</p> 1330can start or end with whitespace.</p>
1169</dd> 1331</dd>
1170<dd> 1332<dd>
1333<p>Please note that you need to double the <code>\</code> when using
1334<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
1335use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
1336rxvt's own processing).</p>
1337</dd>
1338<dd>
1171<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1339<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 `/' 1340with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1173should be a character not used by the strings.</p> 1341should be a character not used by the strings.</p>
1174</dd> 1342</dd>
1175<dd> 1343<dd>
1176<p>Its usage can be demonstrated by an example:</p> 1344<p>Its usage can be demonstrated by an example:</p>
1177</dd> 1345</dd>
1178<dd> 1346<dd>
1179<pre> 1347<pre>
1180 URxvt.keysym.M-C-0x61: list|\e&lt;M-C-|abc|&gt;</pre> 1348 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1181</dd> 1349</dd>
1182<dd> 1350<dd>
1183<p>The above line is equivalent to the following three lines:</p> 1351<p>The above line is equivalent to the following three lines:</p>
1184</dd> 1352</dd>
1185<dd> 1353<dd>
1186<pre> 1354<pre>
1187 URxvt.keysym.Meta-Control-0x61: \e&lt;M-C-a&gt; 1355 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1188 URxvt.keysym.Meta-Control-0x62: \e&lt;M-C-b&gt; 1356 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1189 URxvt.keysym.Meta-Control-0x63: \e&lt;M-C-c&gt;</pre> 1357 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1190</dd>
1191<dd> 1358</dd>
1359<dd>
1192<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong> 1360<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 1361is interpreted and executed as rxvt's control sequence. For
1194example the following means ``change the current locale to <code>zh_CN.GBK</code> 1362example the following means ``change the current locale to <code>zh_CN.GBK</code>
1195when Control-Meta-c is being pressed'':</p> 1363when Control-Meta-c is being pressed'':</p>
1196</dd> 1364</dd>
1197<dd> 1365<dd>
1198<pre> 1366<pre>
1199 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007</pre> 1367 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1368</dd>
1369<dd>
1370<p>Due the the large number of modifier combinations, a defined key mapping
1371will match if at <em>at least</em> the specified identifiers are being set, and
1372no other key mappings with those and more bits are being defined. That
1373means that defining a key map for <code>a</code> will automatically provide
1374definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1375mappings themselves.</p>
1376</dd>
1377<dd>
1378<p>Unfortunately, this will override built-in key mappings. For example
1379if you overwrite the <code>Insert</code> key you will disable rxvt's
1380<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1381user-defined keymap using the <code>builtin:</code> replacement:</p>
1382</dd>
1383<dd>
1384<pre>
1385 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1386 URxvt.keysym.S-Insert: builtin:</pre>
1387</dd>
1388<dd>
1389<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1390of modifiers. The second line re-establishes the default mapping for
1391<code>Shift-Insert</code>.</p>
1200</dd> 1392</dd>
1201<dd> 1393<dd>
1202<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1394<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 1395the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1204font-switching at runtime:</p> 1396font-switching at runtime:</p>
1205</dd> 1397</dd>
1206<dd> 1398<dd>
1207<pre> 1399<pre>
1208 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 1400 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1209 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007</pre> 1401 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1210</dd>
1211<dd> 1402</dd>
1212<p><code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to 1403<dd>
1213<code>zh_CN.GBK</code>.</p> 1404<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1405info):</p>
1406</dd>
1407<dd>
1408<pre>
1409 URxvt.keysym.M-C-3: command:\033[8;25;80t
1410 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1214</dd> 1411</dd>
1215<p></p></dl> 1412<p></p></dl>
1216<p> 1413<p>
1217</p> 1414</p>
1218<hr /> 1415<hr />
… …
1232<p>To temporarily override mouse reporting, for either the scrollbar or 1429<p>To temporarily override mouse reporting, for either the scrollbar or
1233the normal text selection/insertion, hold either the Shift or the Meta 1430the normal text selection/insertion, hold either the Shift or the Meta
1234(Alt) key while performing the desired mouse action.</p> 1431(Alt) key while performing the desired mouse action.</p>
1235<p>If mouse reporting mode is active, the normal scrollbar actions are 1432<p>If mouse reporting mode is active, the normal scrollbar actions are
1236disabled -- on the assumption that we are using a fullscreen 1433disabled -- on the assumption that we are using a fullscreen
1237application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1434application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1238(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1435(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), 1436up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1240respectively.</p> 1437respectively.</p>
1241<p> 1438<p>
1242</p> 1439</p>
1243<hr /> 1440<hr />
1244<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1441<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
… …
1254(which can span multiple screen lines), unless modified by resource 1451(which can span multiple screen lines), unless modified by resource
1255<strong>tripleclickwords</strong>. 1452<strong>tripleclickwords</strong>.
1256</dd> 1453</dd>
1257<dd> 1454<dd>
1258<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1455<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 1456(Compile: <em>frills</em>) will create a rectangular selection instead of a
1260one.</p> 1457normal one. In this mode, every selected row becomes its own line in the
1458selection, and trailing whitespace is visually underlined and removed from
1459the selection.</p>
1261</dd> 1460</dd>
1262<p></p> 1461<p></p>
1263<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1462<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1264</dt> 1463</dt>
1265<dd> 1464<dd>
… …
1275<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1474<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1276supported in rxvt-unicode. Bug me if you need this.</p> 1475supported in rxvt-unicode. Bug me if you need this.</p>
1277<p>You can, however, switch fonts at runtime using escape sequences (and 1476<p>You can, however, switch fonts at runtime using escape sequences (and
1278therefore using the menubar), e.g.:</p> 1477therefore using the menubar), e.g.:</p>
1279<pre> 1478<pre>
1280 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1479 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1281<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1480<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1282<p> 1481<p>
1283</p> 1482</p>
1284<hr /> 1483<hr />
1285<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1484<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
… …
1389<p></p></dl> 1588<p></p></dl>
1390<p> 1589<p>
1391</p> 1590</p>
1392<hr /> 1591<hr />
1393<h1><a name="environment">ENVIRONMENT</a></h1> 1592<h1><a name="environment">ENVIRONMENT</a></h1>
1394<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1593<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 1594<dl>
1396window id number of the <strong>rxvt</strong> window and it also uses and 1595<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1397sets the environment variable <strong>DISPLAY</strong> to specify which display 1596</dt>
1398terminal to use. <strong>rxvt</strong> uses the environment variables 1597<dd>
1399<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1598Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1599resources or on the commandline.
1600</dd>
1601<p></p>
1602<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1603</dt>
1604<dd>
1605Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1606compiled with XPM support, and optionally with the added extension
1607<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1608</dd>
1609<p></p>
1610<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1611</dt>
1612<dd>
1613Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1614the colour code used as default foreground/text colour (or the string
1615<code>default</code> to indicate that the default-colour escape sequence is to be
1616used), <code>bg</code> is the colour code used as default background colour (or the
1617string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1618was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1619(and do) use this information to optimize screen output.
1620</dd>
1621<p></p>
1622<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1623</dt>
1624<dd>
1625Set to the (decimal) X Window ID of the rxvt window (the toplevel
1626window, which usually has subwindows for the scrollbar, the terminal
1627window and so on).
1628</dd>
1629<p></p>
1630<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1631</dt>
1632<dd>
1633Set to the terminfo directory iff rxvt was configured with
1634<code>--with-terminfo=PATH</code>.
1635</dd>
1636<p></p>
1637<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1638</dt>
1639<dd>
1640Used by rxvt to connect to the display and set to the correct
1641display in it's child processes.
1642</dd>
1643<p></p>
1644<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1645</dt>
1646<dd>
1647The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1648</dd>
1649<p></p>
1650<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1651</dt>
1652<dd>
1653The path where rxvt looks for support files such as menu and xpm
1654files.
1655</dd>
1656<p></p>
1657<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1658</dt>
1659<dd>
1660Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1661</dd>
1662<p></p>
1663<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1664</dt>
1665<dd>
1666The unix domain socket path used by <code>rxvtc(1)</code> and
1667rxvtd(1).
1668</dd>
1669<dd>
1670<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1671</dd>
1672<p></p>
1673<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1674</dt>
1675<dd>
1676Used to locate the default directory for the unix domain socket for
1677daemon communications and to locate various resource files (such as
1678<code>.Xdefaults</code>)
1679</dd>
1680<p></p>
1681<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1682</dt>
1683<dd>
1684Directory where various X resource files are being located.
1685</dd>
1686<p></p>
1687<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1688</dt>
1689<dd>
1690If set and accessible, gives the name of a X resource file to be loaded by
1691rxvt.
1692</dd>
1693<p></p></dl>
1400<p> 1694<p>
1401</p> 1695</p>
1402<hr /> 1696<hr />
1403<h1><a name="files">FILES</a></h1> 1697<h1><a name="files">FILES</a></h1>
1404<dl> 1698<dl>
… …
1410<p></p></dl> 1704<p></p></dl>
1411<p> 1705<p>
1412</p> 1706</p>
1413<hr /> 1707<hr />
1414<h1><a name="see_also">SEE ALSO</a></h1> 1708<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> 1709<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> 1710<p>
1424</p> 1711</p>
1425<hr /> 1712<hr />
1426<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1713<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1427<dl> 1714<dl>
1428<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1715<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1429</dt> 1716</dt>
1430<dd> 1717<dd>
1431Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1718Marc 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> 1719</dd>
1437Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1438</dd> 1720<dd>
1439<dd>
1440<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1721<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1441</dd> 1722</dd>
1442<p></p></dl> 1723<p></p></dl>
1443<p> 1724<p>
1444</p> 1725</p>
1445<hr /> 1726<hr />
… …
1483<dd> 1764<dd>
1484Rewrote screen display and text selection routines. Project Coordinator 1765Rewrote screen display and text selection routines. Project Coordinator
1485(changes.txt 2.4.6 - rxvt-unicode) 1766(changes.txt 2.4.6 - rxvt-unicode)
1486</dd> 1767</dd>
1487<p></p> 1768<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 /> 1769<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> 1770</dt>
1490<dd> 1771<dd>
1491Forked rxvt-unicode, rewrote most of the display code and internal 1772Forked rxvt-unicode, rewrote most of the display code and internal
1492character handling to store text in unicode, improve xterm 1773character handling to store text in unicode, improve xterm
1493compatibility and apply numerous other bugfixes and extensions. 1774compatibility and apply numerous other bugfixes and extensions.

Diff Legend

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