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.1 by root, Tue Jan 11 02:24:59 2005 UTC vs.
Revision 1.21 by root, Fri Apr 22 02:09:39 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.8</strong>, is a colour vt102 terminal 52<p><strong>rxvt-unicode</strong>, version <strong>5.5</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
194<p></p> 196<p></p>
195<dt><strong><a name="item__2dpixmap_file_5b_3bgeom_5d"><strong>-pixmap</strong> <em>file[;geom]</em></a></strong><br /> 197<dt><strong><a name="item__2dpixmap_file_5b_3bgeom_5d"><strong>-pixmap</strong> <em>file[;geom]</em></a></strong><br />
196</dt> 198</dt>
197<dd> 199<dd>
198Compile <em>XPM</em>: Specify XPM file for the background and also optionally 200Compile <em>XPM</em>: Specify XPM file for the background and also optionally
199specify its scaling with a geometry string. Note you may need to add 201specify its scaling with a geometry string. Note you may need to
200quotes to avoid special shell interpretation of the `;' in the 202add quotes to avoid special shell interpretation of the <code>;</code> in the
201command-line; resource <strong>backgroundPixmap</strong>. 203command-line; resource <strong>backgroundPixmap</strong>.
202</dd> 204</dd>
203<p></p> 205<p></p>
204<dt><strong><a name="item__2dcr_colour"><strong>-cr</strong> <em>colour</em></a></strong><br /> 206<dt><strong><a name="item__2dcr_colour"><strong>-cr</strong> <em>colour</em></a></strong><br />
205</dt> 207</dt>
458</dd> 460</dd>
459<p></p> 461<p></p>
460<dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br /> 462<dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br />
461</dt> 463</dt>
462<dd> 464<dd>
463The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 465The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
464de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 466<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
465extension to be able to input japanese characters while staying in 467input extension to be able to input japanese characters while staying in
466another locale. 468another locale. resource <strong>imLocale</strong>.
469</dd>
470<p></p>
471<dt><strong><a name="item__2dimfont_fontset"><strong>-imfont</strong> <em>fontset</em></a></strong><br />
472</dt>
473<dd>
474Set the font set to use for the X Input Method, see resource <strong>imFont</strong>
475for more info.
476</dd>
477<p></p>
478<dt><strong><a name="item__2dtcw"><strong>-tcw</strong></a></strong><br />
479</dt>
480<dd>
481Change the meaning of triple-click selection with the left mouse
482button. Instead of selecting a full line it will extend the selection the
483end of the logical line only. resource <strong>tripleclickwords</strong>.
467</dd> 484</dd>
468<p></p> 485<p></p>
469<dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br /> 486<dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br />
470</dt> 487</dt>
471<dd> 488<dd>
494<dd> 511<dd>
495Turn on/off secondary screen scroll (default enabled); resource 512Turn on/off secondary screen scroll (default enabled); resource
496<strong>secondaryScroll</strong>. 513<strong>secondaryScroll</strong>.
497</dd> 514</dd>
498<p></p> 515<p></p>
499<dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br /> 516<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
500</dt> 517</dt>
518<dd>
519Remap a key symbol. See resource <strong>keysym</strong>.
501<dd> 520</dd>
502No effect on rxvt-unicode. Simply passes through an argument to be made 521<p></p>
503available in the instance's argument list. Appears in <em>WM_COMMAND</em> in 522<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
504some window managers. 523</dt>
524<dd>
525Tells rxvt to embed it's windows into an already-existing window,
526which enables applications to easily embed a terminal.
527</dd>
528<dd>
529<p>Right now, rxvt will first unmap/map the specified window, so it
530shouldn't be a top-level window. rxvt will also reconfigure it
531quite a bit, so don't expect it to keep some specific state. It's best to
532create an extra subwindow for rxvt and leave it alone.</p>
533</dd>
534<dd>
535<p>The window will not be destroyed when rxvt exits.</p>
536</dd>
537<dd>
538<p>It might be useful to know that rxvt will not close file
539descriptors passed to it (except for stdin/out/err, of course), so you
540can use file descriptors to communicate with the programs within the
541terminal. This works regardless of wether the <code>-embed</code> option was used or
542not.</p>
543</dd>
544<dd>
545<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
546used (a longer example is in <em>doc/embed</em>):</p>
547</dd>
548<dd>
549<pre>
550 my $rxvt = new Gtk2::Socket;
551 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
552 my $xid = $_[0]-&gt;window-&gt;get_xid;
553 system &quot;rxvt -embed $xid &amp;&quot;;
554 });</pre>
555</dd>
556<p></p>
557<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br />
558</dt>
559<dd>
560Tells rxvt NOT to execute any commands or create a new pty/tty
561pair but instead use the given filehandle as the tty master. This is
562useful if you want to drive rxvt as a generic terminal emulator
563without having to run a program within it.
564</dd>
565<dd>
566<p>If this switch is given, rxvt will not create any utmp/wtmp
567entries and will not tinker with pty/tty permissions - you have to do that
568yourself if you want that.</p>
569</dd>
570<dd>
571<p>Here is a example in perl that illustrates how this option can be used (a
572longer example is in <em>doc/pty-fd</em>):</p>
573</dd>
574<dd>
575<pre>
576 use IO::Pty;
577 use Fcntl;</pre>
578</dd>
579<dd>
580<pre>
581 my $pty = new IO::Pty;
582 fcntl $pty, F_SETFD, 0; # clear close-on-exec
583 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
584 close $pty;</pre>
585</dd>
586<dd>
587<pre>
588 # now communicate with rxvt
589 my $slave = $pty-&gt;slave;
590 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
505</dd> 591</dd>
506<p></p></dl> 592<p></p></dl>
507<p> 593<p>
508</p> 594</p>
509<hr /> 595<hr />
512options) compiled into your version.</p> 598options) compiled into your version.</p>
513<p>There are two different methods that rxvt can use to get the 599<p>There are two different methods that rxvt can use to get the
514Xresource data: using the X libraries (Xrm*-functions) or internal 600Xresource data: using the X libraries (Xrm*-functions) or internal
515Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie. 601Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
516<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the 602<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
517resources using X11 tools like <strong>xset</strong>. Many distribution do also load 603resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
518settings from the <strong>~/.Xresources</strong> file when X starts.</p> 604settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
605will consult the following files/resources in order, with later settings
606overwriting earlier ones:</p>
607<pre>
608 1. system-wide app-defaults file, either locale-dependent OR global
609 2. app-defaults file in $XAPPLRESDIR
610 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
611 4. SCREEN_RESOURCES for the current screen
612 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
519<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> 613<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
520lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 614lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
521set in XAPPLOADDIR/URxvt (compile-time defined: usually 615set in XAPPLOADDIR/URxvt (compile-time defined: usually
522<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 616<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
523<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist. 617<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
576<dt><strong><a name="item_colorit_3a_colour"><strong>colorIT:</strong> <em>colour</em></a></strong><br /> 670<dt><strong><a name="item_colorit_3a_colour"><strong>colorIT:</strong> <em>colour</em></a></strong><br />
577</dt> 671</dt>
578<dd> 672<dd>
579Use the specified colour to display bold or italic characters when the 673Use the specified colour to display bold or italic characters when the
580foreground colour is the default. If font styles are not available 674foreground colour is the default. If font styles are not available
581(Compile styles) and this option is unset, reverse video is used instead. 675(Compile <em>styles</em>) and this option is unset, reverse video is used instead.
582</dd> 676</dd>
583<p></p> 677<p></p>
584<dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br /> 678<dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br />
585</dt> 679</dt>
586<dd> 680<dd>
719be smaller, but not larger. A reasonable default font list is always 813be smaller, but not larger. A reasonable default font list is always
720appended to it. option <strong>-fn</strong>. 814appended to it. option <strong>-fn</strong>.
721</dd> 815</dd>
722<dd> 816<dd>
723<p>Each font can either be a standard X11 core font (XLFD) name, with 817<p>Each font can either be a standard X11 core font (XLFD) name, with
724optional prefix <code>x:</code> or a Xft font (Compile xft), prefixed with <code>xft:</code>.</p> 818optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
725</dd> 819</dd>
726<dd> 820<dd>
727<p>In addition, each font can be prefixed with additional hints and 821<p>In addition, each font can be prefixed with additional hints and
728specifications enclosed in square brackets (<code>[]</code>). The only available 822specifications enclosed in square brackets (<code>[]</code>). The only available
729hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft 823hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft
895<p></p> 989<p></p>
896<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 990<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
897</dt> 991</dt>
898<dd> 992<dd>
899<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 993<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
900<strong>scrollTtyOutput</strong> is False); option <strong>+sw</strong>. <strong>False</strong>: do not scroll 994<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll
901with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>. 995with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
902</dd> 996</dd>
903<p></p> 997<p></p>
904<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 998<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
905</dt> 999</dt>
906<dd> 1000<dd>
1001</dd> 1095</dd>
1002<p></p> 1096<p></p>
1003<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1097<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1004</dt> 1098</dt>
1005<dd> 1099<dd>
1006Specifies number of seconds before blanking the pointer [default 2]. 1100Specifies number of seconds before blanking the pointer [default 2]. Use a
1101large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1007</dd> 1102</dd>
1008<p></p> 1103<p></p>
1009<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1104<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1010</dt> 1105</dt>
1011<dd> 1106<dd>
1046</dd> 1141</dd>
1047<p></p> 1142<p></p>
1048<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br /> 1143<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br />
1049</dt> 1144</dt>
1050<dd> 1145<dd>
1051The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 1146The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1052de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 1147<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1053extension to be able to input japanese characters while staying in 1148input extension to be able to input japanese characters while staying in
1054another locale. option <strong>-imlocale</strong>. 1149another locale. option <strong>-imlocale</strong>.
1150</dd>
1151<p></p>
1152<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1153</dt>
1154<dd>
1155Specify the font-set used for XIM styles <code>OverTheSpot</code> or
1156<code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated
1157by commas), i.e. it's not in the same format as the other font lists used
1158in rxvt. The default will be set-up to chose *any* suitable found
1159found, preferably one or two pixels differing in size to the base font.
1160option <strong>-imfont</strong>.
1161</dd>
1162<p></p>
1163<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1164</dt>
1165<dd>
1166Change the meaning of triple-click selection with the left mouse
1167button. Instead of selecting a full line it will extend the selection to
1168the end of the logical line only. option <strong>-tcw</strong>.
1055</dd> 1169</dd>
1056<p></p> 1170<p></p>
1057<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1171<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1058</dt> 1172</dt>
1059<dd> 1173<dd>
1101</dd> 1215</dd>
1102<p></p> 1216<p></p>
1103<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1217<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1104</dt> 1218</dt>
1105<dd> 1219<dd>
1106Associate <em>string</em> with keysym <em>sym</em> (<strong>0xFF00 - 0xFFFF</strong>). It may 1220Compile <em>frills</em>: Associate <em>string</em> with keysym <em>sym</em>. The
1107contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
1108newline, \r: return, \t:
1109tab, \000: octal number) or control characters (^?: delete, ^@: null,
1110^A ...) and may enclosed with double quotes so that it can start or end
1111with whitespace. The intervening resource name <strong>keysym.</strong> cannot be 1221intervening resource name <strong>keysym.</strong> cannot be omitted.
1112omitted. This resource is only available when compiled with 1222</dd>
1113KEYSYM_RESOURCE. 1223<dd>
1224<p>The format of <em>sym</em> is ``<em>(modifiers-)key</em>'', where <em>modifiers</em> can be
1225any combination of <strong>ISOLevel3</strong>, <strong>AppKeypad</strong>, <strong>Control</strong>, <strong>NumLock</strong>,
1226<strong>Shift</strong>, <strong>Meta</strong>, <strong>Lock</strong>, <strong>Mod1</strong>, <strong>Mod2</strong>, <strong>Mod3</strong>, <strong>Mod4</strong>, <strong>Mod5</strong>,
1227and the abbreviated <strong>I</strong>, <strong>K</strong>, <strong>C</strong>, <strong>N</strong>, <strong>S</strong>, <strong>M</strong>, <strong>A</strong>, <strong>L</strong>, <strong>1</strong>,
1228<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p>
1229</dd>
1230<dd>
1231<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to
1232whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1233keys are being mapped. <strong>AppKeypad</strong> is a synthetic modifier mapped to the
1234current application keymap mode state.</p>
1235</dd>
1236<dd>
1237<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or
1238searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and
1239omitting the prefix <strong>XK_</strong>. Alternatively you can specify <em>key</em> by its hex
1240keysym value (<strong>0x0000 - 0xFFFF</strong>). Note that the lookup of <em>sym</em>s is not
1241performed in an exact manner; however, the closest match is assured.</p>
1242</dd>
1243<dd>
1244<p><em>string</em> may contain escape values (<code>\a</code>: bell, <code>\b</code>: backspace,
1245<code>\e</code>, <code>\E</code>: escape, <code>\n</code>: newline, <code>\r</code>: carriage return, <code>\t</code>: tab,
1246<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1247<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1248can start or end with whitespace.</p>
1249</dd>
1250<dd>
1251<p>Please note that you need to double the <code>\</code> when using
1252<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
1253use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
1254rxvt's own processing).</p>
1255</dd>
1256<dd>
1257<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1258with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1259should be a character not used by the strings.</p>
1260</dd>
1261<dd>
1262<p>Its usage can be demonstrated by an example:</p>
1263</dd>
1264<dd>
1265<pre>
1266 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1267</dd>
1268<dd>
1269<p>The above line is equivalent to the following three lines:</p>
1270</dd>
1271<dd>
1272<pre>
1273 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1274 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1275 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1276</dd>
1277<dd>
1278<p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
1279is interpreted and executed as rxvt's control sequence. For
1280example the following means ``change the current locale to <code>zh_CN.GBK</code>
1281when Control-Meta-c is being pressed'':</p>
1282</dd>
1283<dd>
1284<pre>
1285 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1286</dd>
1287<dd>
1288<p>Due the the large number of modifier combinations, a defined key mapping
1289will match if at <em>at least</em> the specified identifiers are being set, and
1290no other key mappings with those and more bits are being defined. That
1291means that defining a key map for <code>a</code> will automatically provide
1292definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1293mappings themselves.</p>
1294</dd>
1295<dd>
1296<p>Unfortunately, this will override built-in key mappings. For example
1297if you overwrite the <code>Insert</code> key you will disable rxvt's
1298<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1299user-defined keymap using the <code>builtin:</code> replacement:</p>
1300</dd>
1301<dd>
1302<pre>
1303 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1304 URxvt.keysym.S-Insert: builtin:</pre>
1305</dd>
1306<dd>
1307<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1308of modifiers. The second line re-establishes the default mapping for
1309<code>Shift-Insert</code>.</p>
1310</dd>
1311<dd>
1312<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1313the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1314font-switching at runtime:</p>
1315</dd>
1316<dd>
1317<pre>
1318 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1319 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1320</dd>
1321<dd>
1322<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1323info):</p>
1324</dd>
1325<dd>
1326<pre>
1327 URxvt.keysym.M-C-3: command:\033[8;25;80t
1328 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1114</dd> 1329</dd>
1115<p></p></dl> 1330<p></p></dl>
1116<p> 1331<p>
1117</p> 1332</p>
1118<hr /> 1333<hr />
1132<p>To temporarily override mouse reporting, for either the scrollbar or 1347<p>To temporarily override mouse reporting, for either the scrollbar or
1133the normal text selection/insertion, hold either the Shift or the Meta 1348the normal text selection/insertion, hold either the Shift or the Meta
1134(Alt) key while performing the desired mouse action.</p> 1349(Alt) key while performing the desired mouse action.</p>
1135<p>If mouse reporting mode is active, the normal scrollbar actions are 1350<p>If mouse reporting mode is active, the normal scrollbar actions are
1136disabled -- on the assumption that we are using a fullscreen 1351disabled -- on the assumption that we are using a fullscreen
1137application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1352application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1138(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1353(Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the
1139up and down arrows sends <strong>ESC[A</strong> (Up) and <strong>ESC[B</strong> (Down), 1354up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1140respectively.</p> 1355respectively.</p>
1141<p> 1356<p>
1142</p> 1357</p>
1143<hr /> 1358<hr />
1144<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1359<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
1146<em>xterm</em>(1).</p> 1361<em>xterm</em>(1).</p>
1147<dl> 1362<dl>
1148<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br /> 1363<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br />
1149</dt> 1364</dt>
1150<dd> 1365<dd>
1151Left click at the beginning of the region, drag to the end of the 1366Left click at the beginning of the region, drag to the end of the region
1152region and release; Right click to extend the marked region; Left 1367and release; Right click to extend the marked region; Left double-click
1153double-click to select a word; Left triple-click to select the entire 1368to select a word; Left triple-click to select the entire logical line
1154line. 1369(which can span multiple screen lines), unless modified by resource
1370<strong>tripleclickwords</strong>.
1155</dd> 1371</dd>
1156<dd> 1372<dd>
1157<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1373<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1158(Compile: frills) will create a rectangular selection instead of a normal 1374(Compile: <em>frills</em>) will create a rectangular selection instead of a normal
1159one.</p> 1375one.</p>
1160</dd> 1376</dd>
1161<p></p> 1377<p></p>
1162<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1378<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1163</dt> 1379</dt>
1185<p>ISO 14755 is a standard for entering and viewing unicode characters 1401<p>ISO 14755 is a standard for entering and viewing unicode characters
1186and character codes using the keyboard. It consists of 4 parts. The 1402and character codes using the keyboard. It consists of 4 parts. The
1187first part is available rxvt-unicode has been compiled with 1403first part is available rxvt-unicode has been compiled with
1188<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled 1404<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled
1189with <code>--enable-iso14755</code>.</p> 1405with <code>--enable-iso14755</code>.</p>
1190<ol> 1406<ul>
1191<li><strong><a name="item_1_3a_basic_method">1: Basic method</a></strong><br /> 1407<li><strong><a name="item_5_2e1_3a_basic_method">5.1: Basic method</a></strong><br />
1192</li> 1408</li>
1193This allows you to enter unicode characters using their hexcode. 1409This allows you to enter unicode characters using their hexcode.
1194<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter 1410<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter
1195hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will 1411hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will
1196commit the character as if it were typed directly. While holding down 1412commit the character as if it were typed directly. While holding down
1201address, which you cannot type. Fortunately, the card has the e-mail 1417address, which you cannot type. Fortunately, the card has the e-mail
1202address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily 1418address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily
1203by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>, 1419by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>,
1204followed by releasing the modifier keys.</p> 1420followed by releasing the modifier keys.</p>
1205<p></p> 1421<p></p>
1206<li><strong><a name="item_2_3a_keyboard_symbols_entry_method">2: Keyboard symbols entry method</a></strong><br /> 1422<li><strong><a name="item_5_2e2_3a_keyboard_symbols_entry_method">5.2: Keyboard symbols entry method</a></strong><br />
1207</li> 1423</li>
1208This mode lets you input characters representing the keycap symbols of 1424This mode lets you input characters representing the keycap symbols of
1209your keyboard, if representable in the current locale encoding. 1425your keyboard, if representable in the current locale encoding.
1210<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing 1426<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing
1211them. The next special key (cursor keys, home etc.) you enter will not 1427them. The next special key (cursor keys, home etc.) you enter will not
1213keycap symbol. The symbol will only be entered when the key has been 1429keycap symbol. The symbol will only be entered when the key has been
1214released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for 1430released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for
1215<code>ISO Level 2 Switch</code>, although your intention might have been to enter a 1431<code>ISO Level 2 Switch</code>, although your intention might have been to enter a
1216reverse tab (Shift-Tab).</p> 1432reverse tab (Shift-Tab).</p>
1217<p></p> 1433<p></p>
1218<li><strong><a name="item_3_3a_screen_2dselection_entry_method">3: Screen-selection entry method</a></strong><br /> 1434<li><strong><a name="item_5_2e3_3a_screen_2dselection_entry_method">5.3: Screen-selection entry method</a></strong><br />
1219</li> 1435</li>
1220While this is implemented already (it's basically the selection 1436While this is implemented already (it's basically the selection
1221mechanism), it could be extended by displaying a unicode character map. 1437mechanism), it could be extended by displaying a unicode character map.
1222<p></p> 1438<p></p>
1223<li><strong><a name="item_4_3a_feedback_method_for_identifying_displayed_cha">4: Feedback method for identifying displayed characters for later input</a></strong><br /> 1439<li><strong><a name="item_5_2e4_3a_feedback_method_for_identifying_displayed">5.4: Feedback method for identifying displayed characters for later input</a></strong><br />
1224</li> 1440</li>
1225This method lets you display the unicode character code associated with 1441This method lets you display the unicode character code associated with
1226characters already displayed. 1442characters already displayed.
1227<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then 1443<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then
1228pressing and holding the left mouse button and moving around. The unicode 1444pressing and holding the left mouse button and moving around. The unicode
1230pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p> 1446pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p>
1231<p>In addition to the hex codes it will display the font used to draw this 1447<p>In addition to the hex codes it will display the font used to draw this
1232character - due to implementation reasons, characters combined with 1448character - due to implementation reasons, characters combined with
1233combining characters, line drawing characters and unknown characters will 1449combining characters, line drawing characters and unknown characters will
1234always be drawn using the built-in support font.</p> 1450always be drawn using the built-in support font.</p>
1235<p></p></ol> 1451<p></p></ul>
1236<p>With respect to conformance, rxvt-unicode is supposed to be compliant to 1452<p>With respect to conformance, rxvt-unicode is supposed to be compliant to
1237both scenario A and B of ISO 14755, including part 5.2.</p> 1453both scenario A and B of ISO 14755, including part 5.2.</p>
1238<p> 1454<p>
1239</p> 1455</p>
1240<hr /> 1456<hr />
1241<h1><a name="login_stamp">LOGIN STAMP</a></h1> 1457<h1><a name="login_stamp">LOGIN STAMP</a></h1>
1242<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so 1458<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so that
1243that it can be seen via the <em>who(1)</em> command, and can accept messages. 1459it can be seen via the <em>who(1)</em> command, and can accept messages. To
1244To allow this feature, <strong>rxvt</strong> must be installed setuid root on 1460allow this feature, <strong>rxvt</strong> may need to be installed setuid root
1245some systems.</p> 1461on some systems or setgid to root or to some other group on others.</p>
1246<p> 1462<p>
1247</p> 1463</p>
1248<hr /> 1464<hr />
1249<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1> 1465<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
1250<p>In addition to the default foreground and background colours, 1466<p>In addition to the default foreground and background colours,
1288<p></p></dl> 1504<p></p></dl>
1289<p> 1505<p>
1290</p> 1506</p>
1291<hr /> 1507<hr />
1292<h1><a name="environment">ENVIRONMENT</a></h1> 1508<h1><a name="environment">ENVIRONMENT</a></h1>
1293<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1509<p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
1294and <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X 1510<dl>
1295window id number of the <strong>rxvt</strong> window and it also uses and 1511<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1296sets the environment variable <strong>DISPLAY</strong> to specify which display 1512</dt>
1297terminal to use. <strong>rxvt</strong> uses the environment variables 1513<dd>
1298<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1514Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1515resources or on the commandline.
1516</dd>
1517<p></p>
1518<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1519</dt>
1520<dd>
1521Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1522compiled with XPM support, and optionally with the added extension
1523<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1524</dd>
1525<p></p>
1526<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1527</dt>
1528<dd>
1529Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1530the colour code used as default foreground/text colour (or the string
1531<code>default</code> to indicate that the default-colour escape sequence is to be
1532used), <code>bg</code> is the colour code used as default background colour (or the
1533string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1534was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1535(and do) use this information to optimize screen output.
1536</dd>
1537<p></p>
1538<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1539</dt>
1540<dd>
1541Set to the (decimal) X Window ID of the rxvt window (the toplevel
1542window, which usually has subwindows for the scrollbar, the terminal
1543window and so on).
1544</dd>
1545<p></p>
1546<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1547</dt>
1548<dd>
1549Set to the terminfo directory iff rxvt was configured with
1550<code>--with-terminfo=PATH</code>.
1551</dd>
1552<p></p>
1553<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1554</dt>
1555<dd>
1556Used by rxvt to connect to the display and set to the correct
1557display in it's child processes.
1558</dd>
1559<p></p>
1560<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1561</dt>
1562<dd>
1563The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1564</dd>
1565<p></p>
1566<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1567</dt>
1568<dd>
1569The path where rxvt looks for support files such as menu and xpm
1570files.
1571</dd>
1572<p></p>
1573<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1574</dt>
1575<dd>
1576Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1577</dd>
1578<p></p>
1579<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1580</dt>
1581<dd>
1582The unix domain socket path used by <code>rxvtc(1)</code> and
1583rxvtd(1).
1584</dd>
1585<dd>
1586<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p>
1587</dd>
1588<p></p>
1589<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1590</dt>
1591<dd>
1592Used to locate the default directory for the unix domain socket for
1593daemon communications and to locate various resource files (such as
1594<code>.Xdefaults</code>)
1595</dd>
1596<p></p>
1597<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1598</dt>
1599<dd>
1600Directory where various X resource files are being located.
1601</dd>
1602<p></p>
1603<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1604</dt>
1605<dd>
1606If set and accessible, gives the name of a X resource file to be loaded by
1607rxvt.
1608</dd>
1609<p></p></dl>
1299<p> 1610<p>
1300</p> 1611</p>
1301<hr /> 1612<hr />
1302<h1><a name="files">FILES</a></h1> 1613<h1><a name="files">FILES</a></h1>
1303<dl> 1614<dl>
1304<dt><strong><a name="item__2fetc_2futmp"><strong>/etc/utmp</strong></a></strong><br />
1305</dt>
1306<dd>
1307System file for login records.
1308</dd>
1309<p></p>
1310<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br /> 1615<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br />
1311</dt> 1616</dt>
1312<dd> 1617<dd>
1313Color names. 1618Color names.
1314</dd> 1619</dd>
1331<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1636<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1332<dl> 1637<dl>
1333<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1638<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1334</dt> 1639</dt>
1335<dd> 1640<dd>
1336Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1641Marc A. Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;
1337</dd>
1338<p></p>
1339<dt><strong><a name="item_web_page_maintainter">Web page maintainter</a></strong><br />
1340</dt>
1341<dd> 1642</dd>
1342Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1343</dd> 1643<dd>
1344<dd>
1345<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1644<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1346</dd> 1645</dd>
1347<p></p></dl> 1646<p></p></dl>
1348<p> 1647<p>
1349</p> 1648</p>
1350<hr /> 1649<hr />
1388<dd> 1687<dd>
1389Rewrote screen display and text selection routines. Project Coordinator 1688Rewrote screen display and text selection routines. Project Coordinator
1390(changes.txt 2.4.6 - rxvt-unicode) 1689(changes.txt 2.4.6 - rxvt-unicode)
1391</dd> 1690</dd>
1392<p></p> 1691<p></p>
1393<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 /> 1692<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 />
1394</dt> 1693</dt>
1395<dd> 1694<dd>
1396Forked rxvt-unicode, rewrote most of the display code and internal 1695Forked rxvt-unicode, rewrote most of the display code and internal
1397character handling to store text in unicode, improve xterm 1696character handling to store text in unicode, improve xterm
1398compatibility and apply numerous other bugfixes and extensions. 1697compatibility and apply numerous other bugfixes and extensions.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines