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.17 by root, Thu Feb 17 15:07:48 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.2</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::DrawingArea;
551 $...-&gt;add ($rxvt); # important to add it somewhere first
552 $rxvt-&gt;realize; # now it can be realized
553 my $xid = $rxvt-&gt;window-&gt;get_xid;</pre>
554</dd>
555<dd>
556<pre>
557 system &quot;rxvt -embed $xid &amp;&quot;;</pre>
558</dd>
559<p></p>
560<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br />
561</dt>
562<dd>
563Tells rxvt NOT to execute any commands or create a new pty/tty
564pair but instead use the given filehandle as the tty master. This is
565useful if you want to drive rxvt as a generic terminal emulator
566without having to run a program within it.
567</dd>
568<dd>
569<p>If this switch is given, rxvt will not create any utmp/wtmp
570entries and will not tinker with pty/tty permissions - you have to do that
571yourself if you want that.</p>
572</dd>
573<dd>
574<p>Here is a example in perl that illustrates how this option can be used (a
575longer example is in <em>doc/pty-fd</em>):</p>
576</dd>
577<dd>
578<pre>
579 use IO::Pty;
580 use Fcntl;</pre>
581</dd>
582<dd>
583<pre>
584 my $pty = new IO::Pty;
585 fcntl $pty, F_SETFD, 0; # clear close-on-exec</pre>
586</dd>
587<dd>
588<pre>
589 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;</pre>
590</dd>
591<dd>
592<pre>
593 # now communicate with rxvt
594 my $slave = $pty-&gt;slave;
595 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
505</dd> 596</dd>
506<p></p></dl> 597<p></p></dl>
507<p> 598<p>
508</p> 599</p>
509<hr /> 600<hr />
512options) compiled into your version.</p> 603options) compiled into your version.</p>
513<p>There are two different methods that rxvt can use to get the 604<p>There are two different methods that rxvt can use to get the
514Xresource data: using the X libraries (Xrm*-functions) or internal 605Xresource data: using the X libraries (Xrm*-functions) or internal
515Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie. 606Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
516<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the 607<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 608resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
518settings from the <strong>~/.Xresources</strong> file when X starts.</p> 609settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
610will consult the following files/resources in order, with later settings
611overwriting earlier ones:</p>
612<pre>
613 1. system-wide app-defaults file, either locale-dependent OR global
614 2. app-defaults file in $XAPPLRESDIR
615 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
616 4. SCREEN_RESOURCES for the current screen
617 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
519<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> 618<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
520lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 619lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
521set in XAPPLOADDIR/URxvt (compile-time defined: usually 620set in XAPPLOADDIR/URxvt (compile-time defined: usually
522<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 621<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. 622<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 /> 675<dt><strong><a name="item_colorit_3a_colour"><strong>colorIT:</strong> <em>colour</em></a></strong><br />
577</dt> 676</dt>
578<dd> 677<dd>
579Use the specified colour to display bold or italic characters when the 678Use the specified colour to display bold or italic characters when the
580foreground colour is the default. If font styles are not available 679foreground colour is the default. If font styles are not available
581(Compile styles) and this option is unset, reverse video is used instead. 680(Compile <em>styles</em>) and this option is unset, reverse video is used instead.
582</dd> 681</dd>
583<p></p> 682<p></p>
584<dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br /> 683<dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br />
585</dt> 684</dt>
586<dd> 685<dd>
719be smaller, but not larger. A reasonable default font list is always 818be smaller, but not larger. A reasonable default font list is always
720appended to it. option <strong>-fn</strong>. 819appended to it. option <strong>-fn</strong>.
721</dd> 820</dd>
722<dd> 821<dd>
723<p>Each font can either be a standard X11 core font (XLFD) name, with 822<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> 823optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
725</dd> 824</dd>
726<dd> 825<dd>
727<p>In addition, each font can be prefixed with additional hints and 826<p>In addition, each font can be prefixed with additional hints and
728specifications enclosed in square brackets (<code>[]</code>). The only available 827specifications enclosed in square brackets (<code>[]</code>). The only available
729hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft 828hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft
895<p></p> 994<p></p>
896<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 995<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
897</dt> 996</dt>
898<dd> 997<dd>
899<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 998<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 999<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>. 1000with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
902</dd> 1001</dd>
903<p></p> 1002<p></p>
904<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1003<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
905</dt> 1004</dt>
906<dd> 1005<dd>
1046</dd> 1145</dd>
1047<p></p> 1146<p></p>
1048<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br /> 1147<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br />
1049</dt> 1148</dt>
1050<dd> 1149<dd>
1051The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 1150The 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 1151<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 1152input extension to be able to input japanese characters while staying in
1054another locale. option <strong>-imlocale</strong>. 1153another locale. option <strong>-imlocale</strong>.
1154</dd>
1155<p></p>
1156<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1157</dt>
1158<dd>
1159Specify the font-set used for XIM styles <code>OverTheSpot</code> or
1160<code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated
1161by commas), i.e. it's not in the same format as the other font lists used
1162in rxvt. The default will be set-up to chose *any* suitable found
1163found, preferably one or two pixels differing in size to the base font.
1164option <strong>-imfont</strong>.
1165</dd>
1166<p></p>
1167<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1168</dt>
1169<dd>
1170Change the meaning of triple-click selection with the left mouse
1171button. Instead of selecting a full line it will extend the selection to
1172the end of the logical line only. option <strong>-tcw</strong>.
1055</dd> 1173</dd>
1056<p></p> 1174<p></p>
1057<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1175<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1058</dt> 1176</dt>
1059<dd> 1177<dd>
1101</dd> 1219</dd>
1102<p></p> 1220<p></p>
1103<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1221<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1104</dt> 1222</dt>
1105<dd> 1223<dd>
1106Associate <em>string</em> with keysym <em>sym</em> (<strong>0xFF00 - 0xFFFF</strong>). It may 1224Compile <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 1225intervening resource name <strong>keysym.</strong> cannot be omitted.
1112omitted. This resource is only available when compiled with 1226</dd>
1113KEYSYM_RESOURCE. 1227<dd>
1228<p>The format of <em>sym</em> is ``<em>(modifiers-)key</em>'', where <em>modifiers</em> can be
1229any combination of <strong>ISOLevel3</strong>, <strong>AppKeypad</strong>, <strong>Control</strong>, <strong>NumLock</strong>,
1230<strong>Shift</strong>, <strong>Meta</strong>, <strong>Lock</strong>, <strong>Mod1</strong>, <strong>Mod2</strong>, <strong>Mod3</strong>, <strong>Mod4</strong>, <strong>Mod5</strong>,
1231and 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>,
1232<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p>
1233</dd>
1234<dd>
1235<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to
1236whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1237keys are being mapped. <strong>AppKeypad</strong> is a synthetic modifier mapped to the
1238current application keymap mode state.</p>
1239</dd>
1240<dd>
1241<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or
1242searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and
1243omitting the prefix <strong>XK_</strong>. Alternatively you can specify <em>key</em> by its hex
1244keysym value (<strong>0x0000 - 0xFFFF</strong>). Note that the lookup of <em>sym</em>s is not
1245performed in an exact manner; however, the closest match is assured.</p>
1246</dd>
1247<dd>
1248<p><em>string</em> may contain escape values (<code>\a</code>: bell, <code>\b</code>: backspace,
1249<code>\e</code>, <code>\E</code>: escape, <code>\n</code>: newline, <code>\r</code>: carriage return, <code>\t</code>: tab,
1250<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1251<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1252can start or end with whitespace.</p>
1253</dd>
1254<dd>
1255<p>Please note that you need to double the <code>\</code> when using
1256<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
1257use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
1258rxvt's own processing).</p>
1259</dd>
1260<dd>
1261<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1262with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1263should be a character not used by the strings.</p>
1264</dd>
1265<dd>
1266<p>Its usage can be demonstrated by an example:</p>
1267</dd>
1268<dd>
1269<pre>
1270 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1271</dd>
1272<dd>
1273<p>The above line is equivalent to the following three lines:</p>
1274</dd>
1275<dd>
1276<pre>
1277 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1278 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1279 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1280</dd>
1281<dd>
1282<p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
1283is interpreted and executed as rxvt's control sequence. For
1284example the following means ``change the current locale to <code>zh_CN.GBK</code>
1285when Control-Meta-c is being pressed'':</p>
1286</dd>
1287<dd>
1288<pre>
1289 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1290</dd>
1291<dd>
1292<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1293the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1294font-switching at runtime:</p>
1295</dd>
1296<dd>
1297<pre>
1298 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1299 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1300</dd>
1301<dd>
1302<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1303info):</p>
1304</dd>
1305<dd>
1306<pre>
1307 URxvt.keysym.M-C-3: command:\033[8;25;80t
1308 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1114</dd> 1309</dd>
1115<p></p></dl> 1310<p></p></dl>
1116<p> 1311<p>
1117</p> 1312</p>
1118<hr /> 1313<hr />
1132<p>To temporarily override mouse reporting, for either the scrollbar or 1327<p>To temporarily override mouse reporting, for either the scrollbar or
1133the normal text selection/insertion, hold either the Shift or the Meta 1328the normal text selection/insertion, hold either the Shift or the Meta
1134(Alt) key while performing the desired mouse action.</p> 1329(Alt) key while performing the desired mouse action.</p>
1135<p>If mouse reporting mode is active, the normal scrollbar actions are 1330<p>If mouse reporting mode is active, the normal scrollbar actions are
1136disabled -- on the assumption that we are using a fullscreen 1331disabled -- on the assumption that we are using a fullscreen
1137application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1332application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1138(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1333(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), 1334up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1140respectively.</p> 1335respectively.</p>
1141<p> 1336<p>
1142</p> 1337</p>
1143<hr /> 1338<hr />
1144<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1339<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
1146<em>xterm</em>(1).</p> 1341<em>xterm</em>(1).</p>
1147<dl> 1342<dl>
1148<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br /> 1343<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br />
1149</dt> 1344</dt>
1150<dd> 1345<dd>
1151Left click at the beginning of the region, drag to the end of the 1346Left 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 1347and release; Right click to extend the marked region; Left double-click
1153double-click to select a word; Left triple-click to select the entire 1348to select a word; Left triple-click to select the entire logical line
1154line. 1349(which can span multiple screen lines), unless modified by resource
1350<strong>tripleclickwords</strong>.
1155</dd> 1351</dd>
1156<dd> 1352<dd>
1157<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1353<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 1354(Compile: <em>frills</em>) will create a rectangular selection instead of a normal
1159one.</p> 1355one.</p>
1160</dd> 1356</dd>
1161<p></p> 1357<p></p>
1162<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1358<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1163</dt> 1359</dt>
1185<p>ISO 14755 is a standard for entering and viewing unicode characters 1381<p>ISO 14755 is a standard for entering and viewing unicode characters
1186and character codes using the keyboard. It consists of 4 parts. The 1382and character codes using the keyboard. It consists of 4 parts. The
1187first part is available rxvt-unicode has been compiled with 1383first part is available rxvt-unicode has been compiled with
1188<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled 1384<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled
1189with <code>--enable-iso14755</code>.</p> 1385with <code>--enable-iso14755</code>.</p>
1190<ol> 1386<ul>
1191<li><strong><a name="item_1_3a_basic_method">1: Basic method</a></strong><br /> 1387<li><strong><a name="item_5_2e1_3a_basic_method">5.1: Basic method</a></strong><br />
1192</li> 1388</li>
1193This allows you to enter unicode characters using their hexcode. 1389This 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 1390<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 1391hex-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 1392commit the character as if it were typed directly. While holding down
1201address, which you cannot type. Fortunately, the card has the e-mail 1397address, 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 1398address 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>, 1399by 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> 1400followed by releasing the modifier keys.</p>
1205<p></p> 1401<p></p>
1206<li><strong><a name="item_2_3a_keyboard_symbols_entry_method">2: Keyboard symbols entry method</a></strong><br /> 1402<li><strong><a name="item_5_2e2_3a_keyboard_symbols_entry_method">5.2: Keyboard symbols entry method</a></strong><br />
1207</li> 1403</li>
1208This mode lets you input characters representing the keycap symbols of 1404This mode lets you input characters representing the keycap symbols of
1209your keyboard, if representable in the current locale encoding. 1405your keyboard, if representable in the current locale encoding.
1210<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing 1406<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 1407them. 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 1409keycap 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 1410released, 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 1411<code>ISO Level 2 Switch</code>, although your intention might have been to enter a
1216reverse tab (Shift-Tab).</p> 1412reverse tab (Shift-Tab).</p>
1217<p></p> 1413<p></p>
1218<li><strong><a name="item_3_3a_screen_2dselection_entry_method">3: Screen-selection entry method</a></strong><br /> 1414<li><strong><a name="item_5_2e3_3a_screen_2dselection_entry_method">5.3: Screen-selection entry method</a></strong><br />
1219</li> 1415</li>
1220While this is implemented already (it's basically the selection 1416While this is implemented already (it's basically the selection
1221mechanism), it could be extended by displaying a unicode character map. 1417mechanism), it could be extended by displaying a unicode character map.
1222<p></p> 1418<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 /> 1419<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> 1420</li>
1225This method lets you display the unicode character code associated with 1421This method lets you display the unicode character code associated with
1226characters already displayed. 1422characters already displayed.
1227<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then 1423<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 1424pressing 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> 1426pointer 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 1427<p>In addition to the hex codes it will display the font used to draw this
1232character - due to implementation reasons, characters combined with 1428character - due to implementation reasons, characters combined with
1233combining characters, line drawing characters and unknown characters will 1429combining characters, line drawing characters and unknown characters will
1234always be drawn using the built-in support font.</p> 1430always be drawn using the built-in support font.</p>
1235<p></p></ol> 1431<p></p></ul>
1236<p>With respect to conformance, rxvt-unicode is supposed to be compliant to 1432<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> 1433both scenario A and B of ISO 14755, including part 5.2.</p>
1238<p> 1434<p>
1239</p> 1435</p>
1240<hr /> 1436<hr />
1241<h1><a name="login_stamp">LOGIN STAMP</a></h1> 1437<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 1438<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. 1439it 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 1440allow this feature, <strong>rxvt</strong> may need to be installed setuid root
1245some systems.</p> 1441on some systems or setgid to root or to some other group on others.</p>
1246<p> 1442<p>
1247</p> 1443</p>
1248<hr /> 1444<hr />
1249<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1> 1445<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
1250<p>In addition to the default foreground and background colours, 1446<p>In addition to the default foreground and background colours,
1288<p></p></dl> 1484<p></p></dl>
1289<p> 1485<p>
1290</p> 1486</p>
1291<hr /> 1487<hr />
1292<h1><a name="environment">ENVIRONMENT</a></h1> 1488<h1><a name="environment">ENVIRONMENT</a></h1>
1293<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1489<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 1490<dl>
1295window id number of the <strong>rxvt</strong> window and it also uses and 1491<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1296sets the environment variable <strong>DISPLAY</strong> to specify which display 1492</dt>
1297terminal to use. <strong>rxvt</strong> uses the environment variables 1493<dd>
1298<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1494Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1495resources or on the commandline.
1496</dd>
1497<p></p>
1498<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1499</dt>
1500<dd>
1501Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1502compiled with XPM support, and optionally with the added extension
1503<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1504</dd>
1505<p></p>
1506<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1507</dt>
1508<dd>
1509Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1510the colour code used as default foreground/text colour (or the string
1511<code>default</code> to indicate that the default-colour escape sequence is to be
1512used), <code>bg</code> is the colour code used as default background colour (or the
1513string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1514was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1515(and do) use this information to optimize screen output.
1516</dd>
1517<p></p>
1518<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1519</dt>
1520<dd>
1521Set to the (decimal) X Window ID of the rxvt window (the toplevel
1522window, which usually has subwindows for the scrollbar, the terminal
1523window and so on).
1524</dd>
1525<p></p>
1526<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1527</dt>
1528<dd>
1529Set to the terminfo directory iff rxvt was configured with
1530<code>--with-terminfo=PATH</code>.
1531</dd>
1532<p></p>
1533<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1534</dt>
1535<dd>
1536Used by rxvt to connect to the display and set to the correct
1537display in it's child processes.
1538</dd>
1539<p></p>
1540<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1541</dt>
1542<dd>
1543The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1544</dd>
1545<p></p>
1546<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1547</dt>
1548<dd>
1549The path where rxvt looks for support files such as menu and xpm
1550files.
1551</dd>
1552<p></p>
1553<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1554</dt>
1555<dd>
1556Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1557</dd>
1558<p></p>
1559<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1560</dt>
1561<dd>
1562The unix domain socket path used by <code>rxvtc(1)</code> and
1563rxvtd(1).
1564</dd>
1565<dd>
1566<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p>
1567</dd>
1568<p></p>
1569<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1570</dt>
1571<dd>
1572Used to locate the default directory for the unix domain socket for
1573daemon communications and to locate various resource files (such as
1574<code>.Xdefaults</code>)
1575</dd>
1576<p></p>
1577<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1578</dt>
1579<dd>
1580Directory where various X resource files are being located.
1581</dd>
1582<p></p>
1583<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1584</dt>
1585<dd>
1586If set and accessible, gives the name of a X resource file to be loaded by
1587rxvt.
1588</dd>
1589<p></p></dl>
1299<p> 1590<p>
1300</p> 1591</p>
1301<hr /> 1592<hr />
1302<h1><a name="files">FILES</a></h1> 1593<h1><a name="files">FILES</a></h1>
1303<dl> 1594<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 /> 1595<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br />
1311</dt> 1596</dt>
1312<dd> 1597<dd>
1313Color names. 1598Color names.
1314</dd> 1599</dd>
1331<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1616<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1332<dl> 1617<dl>
1333<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1618<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1334</dt> 1619</dt>
1335<dd> 1620<dd>
1336Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1621Marc 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> 1622</dd>
1342Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1343</dd> 1623<dd>
1344<dd>
1345<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1624<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1346</dd> 1625</dd>
1347<p></p></dl> 1626<p></p></dl>
1348<p> 1627<p>
1349</p> 1628</p>
1350<hr /> 1629<hr />
1388<dd> 1667<dd>
1389Rewrote screen display and text selection routines. Project Coordinator 1668Rewrote screen display and text selection routines. Project Coordinator
1390(changes.txt 2.4.6 - rxvt-unicode) 1669(changes.txt 2.4.6 - rxvt-unicode)
1391</dd> 1670</dd>
1392<p></p> 1671<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 /> 1672<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> 1673</dt>
1395<dd> 1674<dd>
1396Forked rxvt-unicode, rewrote most of the display code and internal 1675Forked rxvt-unicode, rewrote most of the display code and internal
1397character handling to store text in unicode, improve xterm 1676character handling to store text in unicode, improve xterm
1398compatibility and apply numerous other bugfixes and extensions. 1677compatibility and apply numerous other bugfixes and extensions.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines