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.25 by root, Tue Oct 25 20:22:39 2005 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>5.8</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>
334</dd> 349</dd>
335<p></p> 350<p></p>
336<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 351<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
337</dt> 352</dt>
338<dd> 353<dd>
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 354Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource <strong>scrollBar_floating</strong>. 355resource <strong>scrollBar_floating</strong>.
341</dd> 356</dd>
342<p></p> 357<p></p>
343<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 358<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
344</dt> 359</dt>
509<dd> 524<dd>
510Turn on/off secondary screen scroll (default enabled); resource 525Turn on/off secondary screen scroll (default enabled); resource
511<strong>secondaryScroll</strong>. 526<strong>secondaryScroll</strong>.
512</dd> 527</dd>
513<p></p> 528<p></p>
514<dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br /> 529<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
515</dt> 530</dt>
531<dd>
532Remap a key symbol. See resource <strong>keysym</strong>.
516<dd> 533</dd>
517No effect on rxvt-unicode. Simply passes through an argument to be made 534<p></p>
518available in the instance's argument list. Appears in <em>WM_COMMAND</em> in 535<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
519some window managers. 536</dt>
537<dd>
538Tells rxvt to embed it's windows into an already-existing window,
539which enables applications to easily embed a terminal.
540</dd>
541<dd>
542<p>Right now, rxvt will first unmap/map the specified window, so it
543shouldn't be a top-level window. rxvt will also reconfigure it
544quite a bit, so don't expect it to keep some specific state. It's best to
545create an extra subwindow for rxvt and leave it alone.</p>
546</dd>
547<dd>
548<p>The window will not be destroyed when rxvt exits.</p>
549</dd>
550<dd>
551<p>It might be useful to know that rxvt will not close file
552descriptors passed to it (except for stdin/out/err, of course), so you
553can use file descriptors to communicate with the programs within the
554terminal. This works regardless of wether the <code>-embed</code> option was used or
555not.</p>
556</dd>
557<dd>
558<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
559used (a longer example is in <em>doc/embed</em>):</p>
560</dd>
561<dd>
562<pre>
563 my $rxvt = new Gtk2::Socket;
564 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
565 my $xid = $_[0]-&gt;window-&gt;get_xid;
566 system &quot;rxvt -embed $xid &amp;&quot;;
567 });</pre>
568</dd>
569<p></p>
570<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br />
571</dt>
572<dd>
573Tells rxvt NOT to execute any commands or create a new pty/tty
574pair but instead use the given filehandle as the tty master. This is
575useful if you want to drive rxvt as a generic terminal emulator
576without having to run a program within it.
577</dd>
578<dd>
579<p>If this switch is given, rxvt will not create any utmp/wtmp
580entries and will not tinker with pty/tty permissions - you have to do that
581yourself if you want that.</p>
582</dd>
583<dd>
584<p>Here is a example in perl that illustrates how this option can be used (a
585longer example is in <em>doc/pty-fd</em>):</p>
586</dd>
587<dd>
588<pre>
589 use IO::Pty;
590 use Fcntl;</pre>
591</dd>
592<dd>
593<pre>
594 my $pty = new IO::Pty;
595 fcntl $pty, F_SETFD, 0; # clear close-on-exec
596 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
597 close $pty;</pre>
598</dd>
599<dd>
600<pre>
601 # now communicate with rxvt
602 my $slave = $pty-&gt;slave;
603 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
520</dd> 604</dd>
521<p></p></dl> 605<p></p></dl>
522<p> 606<p>
523</p> 607</p>
524<hr /> 608<hr />
527options) compiled into your version.</p> 611options) compiled into your version.</p>
528<p>There are two different methods that rxvt can use to get the 612<p>There are two different methods that rxvt can use to get the
529Xresource data: using the X libraries (Xrm*-functions) or internal 613Xresource data: using the X libraries (Xrm*-functions) or internal
530Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie. 614Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
531<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the 615<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 616resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
533settings from the <strong>~/.Xresources</strong> file when X starts.</p> 617settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
618will consult the following files/resources in order, with later settings
619overwriting earlier ones:</p>
620<pre>
621 1. system-wide app-defaults file, either locale-dependent OR global
622 2. app-defaults file in $XAPPLRESDIR
623 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
624 4. SCREEN_RESOURCES for the current screen
625 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
534<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> 626<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
535lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 627lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
536set in XAPPLOADDIR/URxvt (compile-time defined: usually 628set in XAPPLOADDIR/URxvt (compile-time defined: usually
537<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 629<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. 630<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
657</dd> 749</dd>
658<p></p> 750<p></p>
659<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 751<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
660</dt> 752</dt>
661<dd> 753<dd>
662Fade the text by the given percentage when focus is lost. 754Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
755</dd>
756<p></p>
757<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
758</dt>
759<dd>
760Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
761colour is black; option <strong>-fadecolor</strong>.
663</dd> 762</dd>
664<p></p> 763<p></p>
665<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 764<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
666</dt> 765</dt>
667<dd> 766<dd>
668Tint the transparent background pixmap with the given colour. 767Tint the transparent background pixmap with the given colour; option
768<strong>-tint</strong>.
669</dd> 769</dd>
670<p></p> 770<p></p>
671<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 771<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
672</dt> 772</dt>
673<dd> 773<dd>
683<p></p> 783<p></p>
684<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 784<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
685</dt> 785</dt>
686<dd> 786<dd>
687Use the specified colour for the scrollbar's trough area [default 787Use the specified colour for the scrollbar's trough area [default
688#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 788#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
689</dd> 789</dd>
690<p></p> 790<p></p>
691<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 791<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
692</dt> 792</dt>
693<dd> 793<dd>
813<p></p> 913<p></p>
814<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 914<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
815</dt> 915</dt>
816<dd> 916<dd>
817Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 917Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
818the author's favourite.. 918the author's favourite.
819</dd> 919</dd>
820<p></p> 920<p></p>
821<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 921<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
822</dt> 922</dt>
823<dd> 923<dd>
869<dd> 969<dd>
870Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 970Specify 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 971<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. 972<strong>Shift-Print</strong> to include the scrollback as well.
873</dd> 973</dd>
974<dd>
975<p>The string will be interpreted as if typed into the shell as-is.</p>
976</dd>
977<dd>
978<p>Example:</p>
979</dd>
980<dd>
981<pre>
982 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
983</dd>
984<dd>
985<p>This creates a new file in your home directory with the screen contents
986everytime you hit <code>Print</code>.</p>
987</dd>
874<p></p> 988<p></p>
875<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 989<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
876</dt> 990</dt>
877<dd> 991<dd>
878<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 992<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
910<p></p> 1024<p></p>
911<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1025<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
912</dt> 1026</dt>
913<dd> 1027<dd>
914<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1028<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 1029<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>. 1030with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
917</dd> 1031</dd>
918<p></p> 1032<p></p>
919<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1033<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
920</dt> 1034</dt>
921<dd> 1035<dd>
1016</dd> 1130</dd>
1017<p></p> 1131<p></p>
1018<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1132<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1019</dt> 1133</dt>
1020<dd> 1134<dd>
1021Specifies number of seconds before blanking the pointer [default 2]. 1135Specifies number of seconds before blanking the pointer [default 2]. Use a
1136large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1022</dd> 1137</dd>
1023<p></p> 1138<p></p>
1024<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1139<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1025</dt> 1140</dt>
1026<dd> 1141<dd>
1166<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1281<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 1282<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1168can start or end with whitespace.</p> 1283can start or end with whitespace.</p>
1169</dd> 1284</dd>
1170<dd> 1285<dd>
1286<p>Please note that you need to double the <code>\</code> when using
1287<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
1288use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
1289rxvt's own processing).</p>
1290</dd>
1291<dd>
1171<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1292<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 `/' 1293with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1173should be a character not used by the strings.</p> 1294should be a character not used by the strings.</p>
1174</dd> 1295</dd>
1175<dd> 1296<dd>
1176<p>Its usage can be demonstrated by an example:</p> 1297<p>Its usage can be demonstrated by an example:</p>
1177</dd> 1298</dd>
1178<dd> 1299<dd>
1179<pre> 1300<pre>
1180 URxvt.keysym.M-C-0x61: list|\e&lt;M-C-|abc|&gt;</pre> 1301 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1181</dd> 1302</dd>
1182<dd> 1303<dd>
1183<p>The above line is equivalent to the following three lines:</p> 1304<p>The above line is equivalent to the following three lines:</p>
1184</dd> 1305</dd>
1185<dd> 1306<dd>
1186<pre> 1307<pre>
1187 URxvt.keysym.Meta-Control-0x61: \e&lt;M-C-a&gt; 1308 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1188 URxvt.keysym.Meta-Control-0x62: \e&lt;M-C-b&gt; 1309 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1189 URxvt.keysym.Meta-Control-0x63: \e&lt;M-C-c&gt;</pre> 1310 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1190</dd>
1191<dd> 1311</dd>
1312<dd>
1192<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong> 1313<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 1314is interpreted and executed as rxvt's control sequence. For
1194example the following means ``change the current locale to <code>zh_CN.GBK</code> 1315example the following means ``change the current locale to <code>zh_CN.GBK</code>
1195when Control-Meta-c is being pressed'':</p> 1316when Control-Meta-c is being pressed'':</p>
1196</dd> 1317</dd>
1197<dd> 1318<dd>
1198<pre> 1319<pre>
1199 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007</pre> 1320 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1321</dd>
1322<dd>
1323<p>Due the the large number of modifier combinations, a defined key mapping
1324will match if at <em>at least</em> the specified identifiers are being set, and
1325no other key mappings with those and more bits are being defined. That
1326means that defining a key map for <code>a</code> will automatically provide
1327definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1328mappings themselves.</p>
1329</dd>
1330<dd>
1331<p>Unfortunately, this will override built-in key mappings. For example
1332if you overwrite the <code>Insert</code> key you will disable rxvt's
1333<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1334user-defined keymap using the <code>builtin:</code> replacement:</p>
1335</dd>
1336<dd>
1337<pre>
1338 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1339 URxvt.keysym.S-Insert: builtin:</pre>
1340</dd>
1341<dd>
1342<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1343of modifiers. The second line re-establishes the default mapping for
1344<code>Shift-Insert</code>.</p>
1200</dd> 1345</dd>
1201<dd> 1346<dd>
1202<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1347<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 1348the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1204font-switching at runtime:</p> 1349font-switching at runtime:</p>
1205</dd> 1350</dd>
1206<dd> 1351<dd>
1207<pre> 1352<pre>
1208 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 1353 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1209 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007</pre> 1354 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1210</dd>
1211<dd> 1355</dd>
1212<p><code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to 1356<dd>
1213<code>zh_CN.GBK</code>.</p> 1357<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1358info):</p>
1359</dd>
1360<dd>
1361<pre>
1362 URxvt.keysym.M-C-3: command:\033[8;25;80t
1363 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1214</dd> 1364</dd>
1215<p></p></dl> 1365<p></p></dl>
1216<p> 1366<p>
1217</p> 1367</p>
1218<hr /> 1368<hr />
1232<p>To temporarily override mouse reporting, for either the scrollbar or 1382<p>To temporarily override mouse reporting, for either the scrollbar or
1233the normal text selection/insertion, hold either the Shift or the Meta 1383the normal text selection/insertion, hold either the Shift or the Meta
1234(Alt) key while performing the desired mouse action.</p> 1384(Alt) key while performing the desired mouse action.</p>
1235<p>If mouse reporting mode is active, the normal scrollbar actions are 1385<p>If mouse reporting mode is active, the normal scrollbar actions are
1236disabled -- on the assumption that we are using a fullscreen 1386disabled -- on the assumption that we are using a fullscreen
1237application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1387application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1238(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1388(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), 1389up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1240respectively.</p> 1390respectively.</p>
1241<p> 1391<p>
1242</p> 1392</p>
1243<hr /> 1393<hr />
1244<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1394<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
1389<p></p></dl> 1539<p></p></dl>
1390<p> 1540<p>
1391</p> 1541</p>
1392<hr /> 1542<hr />
1393<h1><a name="environment">ENVIRONMENT</a></h1> 1543<h1><a name="environment">ENVIRONMENT</a></h1>
1394<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1544<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 1545<dl>
1396window id number of the <strong>rxvt</strong> window and it also uses and 1546<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1397sets the environment variable <strong>DISPLAY</strong> to specify which display 1547</dt>
1398terminal to use. <strong>rxvt</strong> uses the environment variables 1548<dd>
1399<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1549Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1550resources or on the commandline.
1551</dd>
1552<p></p>
1553<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1554</dt>
1555<dd>
1556Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1557compiled with XPM support, and optionally with the added extension
1558<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1559</dd>
1560<p></p>
1561<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1562</dt>
1563<dd>
1564Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1565the colour code used as default foreground/text colour (or the string
1566<code>default</code> to indicate that the default-colour escape sequence is to be
1567used), <code>bg</code> is the colour code used as default background colour (or the
1568string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1569was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1570(and do) use this information to optimize screen output.
1571</dd>
1572<p></p>
1573<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1574</dt>
1575<dd>
1576Set to the (decimal) X Window ID of the rxvt window (the toplevel
1577window, which usually has subwindows for the scrollbar, the terminal
1578window and so on).
1579</dd>
1580<p></p>
1581<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1582</dt>
1583<dd>
1584Set to the terminfo directory iff rxvt was configured with
1585<code>--with-terminfo=PATH</code>.
1586</dd>
1587<p></p>
1588<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1589</dt>
1590<dd>
1591Used by rxvt to connect to the display and set to the correct
1592display in it's child processes.
1593</dd>
1594<p></p>
1595<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1596</dt>
1597<dd>
1598The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1599</dd>
1600<p></p>
1601<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1602</dt>
1603<dd>
1604The path where rxvt looks for support files such as menu and xpm
1605files.
1606</dd>
1607<p></p>
1608<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1609</dt>
1610<dd>
1611Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1612</dd>
1613<p></p>
1614<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1615</dt>
1616<dd>
1617The unix domain socket path used by <code>rxvtc(1)</code> and
1618rxvtd(1).
1619</dd>
1620<dd>
1621<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1622</dd>
1623<p></p>
1624<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1625</dt>
1626<dd>
1627Used to locate the default directory for the unix domain socket for
1628daemon communications and to locate various resource files (such as
1629<code>.Xdefaults</code>)
1630</dd>
1631<p></p>
1632<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1633</dt>
1634<dd>
1635Directory where various X resource files are being located.
1636</dd>
1637<p></p>
1638<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1639</dt>
1640<dd>
1641If set and accessible, gives the name of a X resource file to be loaded by
1642rxvt.
1643</dd>
1644<p></p></dl>
1400<p> 1645<p>
1401</p> 1646</p>
1402<hr /> 1647<hr />
1403<h1><a name="files">FILES</a></h1> 1648<h1><a name="files">FILES</a></h1>
1404<dl> 1649<dl>
1410<p></p></dl> 1655<p></p></dl>
1411<p> 1656<p>
1412</p> 1657</p>
1413<hr /> 1658<hr />
1414<h1><a name="see_also">SEE ALSO</a></h1> 1659<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> 1660<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> 1661<p>
1424</p> 1662</p>
1425<hr /> 1663<hr />
1426<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1664<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1427<dl> 1665<dl>
1428<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1666<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1429</dt> 1667</dt>
1430<dd> 1668<dd>
1431Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1669Marc 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> 1670</dd>
1437Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1438</dd> 1671<dd>
1439<dd>
1440<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1672<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1441</dd> 1673</dd>
1442<p></p></dl> 1674<p></p></dl>
1443<p> 1675<p>
1444</p> 1676</p>
1445<hr /> 1677<hr />
1483<dd> 1715<dd>
1484Rewrote screen display and text selection routines. Project Coordinator 1716Rewrote screen display and text selection routines. Project Coordinator
1485(changes.txt 2.4.6 - rxvt-unicode) 1717(changes.txt 2.4.6 - rxvt-unicode)
1486</dd> 1718</dd>
1487<p></p> 1719<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 /> 1720<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> 1721</dt>
1490<dd> 1722<dd>
1491Forked rxvt-unicode, rewrote most of the display code and internal 1723Forked rxvt-unicode, rewrote most of the display code and internal
1492character handling to store text in unicode, improve xterm 1724character handling to store text in unicode, improve xterm
1493compatibility and apply numerous other bugfixes and extensions. 1725compatibility and apply numerous other bugfixes and extensions.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines