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.24 by root, Tue Oct 25 20:04:58 2005 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines