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.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.23 by root, Thu Jul 7 19:37:46 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.6</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
… …
334</dd> 336</dd>
335<p></p> 337<p></p>
336<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 338<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
337</dt> 339</dt>
338<dd> 340<dd>
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 341Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource <strong>scrollBar_floating</strong>. 342resource <strong>scrollBar_floating</strong>.
341</dd> 343</dd>
342<p></p> 344<p></p>
343<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 345<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
344</dt> 346</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.
… …
668<p></p> 762<p></p>
669<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 763<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
670</dt> 764</dt>
671<dd> 765<dd>
672Use the specified colour for the scrollbar's trough area [default 766Use the specified colour for the scrollbar's trough area [default
673#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 767#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
674</dd> 768</dd>
675<p></p> 769<p></p>
676<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 770<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
677</dt> 771</dt>
678<dd> 772<dd>
… …
798<p></p> 892<p></p>
799<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 893<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
800</dt> 894</dt>
801<dd> 895<dd>
802Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 896Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
803the author's favourite.. 897the author's favourite.
804</dd> 898</dd>
805<p></p> 899<p></p>
806<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 900<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
807</dt> 901</dt>
808<dd> 902<dd>
… …
854<dd> 948<dd>
855Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 949Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use
856<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or 950<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or
857<strong>Shift-Print</strong> to include the scrollback as well. 951<strong>Shift-Print</strong> to include the scrollback as well.
858</dd> 952</dd>
953<dd>
954<p>The string will be interpreted as if typed into the shell as-is.</p>
955</dd>
956<dd>
957<p>Example:</p>
958</dd>
959<dd>
960<pre>
961 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
962</dd>
963<dd>
964<p>This creates a new file in your home directory with the screen contents
965everytime you hit <code>Print</code>.</p>
966</dd>
859<p></p> 967<p></p>
860<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 968<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
861</dt> 969</dt>
862<dd> 970<dd>
863<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 971<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
… …
895<p></p> 1003<p></p>
896<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1004<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
897</dt> 1005</dt>
898<dd> 1006<dd>
899<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1007<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 1008<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>. 1009with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
902</dd> 1010</dd>
903<p></p> 1011<p></p>
904<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1012<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
905</dt> 1013</dt>
906<dd> 1014<dd>
… …
1001</dd> 1109</dd>
1002<p></p> 1110<p></p>
1003<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1111<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1004</dt> 1112</dt>
1005<dd> 1113<dd>
1006Specifies number of seconds before blanking the pointer [default 2]. 1114Specifies number of seconds before blanking the pointer [default 2]. Use a
1115large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1007</dd> 1116</dd>
1008<p></p> 1117<p></p>
1009<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1118<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1010</dt> 1119</dt>
1011<dd> 1120<dd>
… …
1046</dd> 1155</dd>
1047<p></p> 1156<p></p>
1048<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br /> 1157<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br />
1049</dt> 1158</dt>
1050<dd> 1159<dd>
1051The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 1160The 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 1161<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 1162input extension to be able to input japanese characters while staying in
1054another locale. option <strong>-imlocale</strong>. 1163another locale. option <strong>-imlocale</strong>.
1164</dd>
1165<p></p>
1166<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1167</dt>
1168<dd>
1169Specify the font-set used for XIM styles <code>OverTheSpot</code> or
1170<code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated
1171by commas), i.e. it's not in the same format as the other font lists used
1172in rxvt. The default will be set-up to chose *any* suitable found
1173found, preferably one or two pixels differing in size to the base font.
1174option <strong>-imfont</strong>.
1175</dd>
1176<p></p>
1177<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1178</dt>
1179<dd>
1180Change the meaning of triple-click selection with the left mouse
1181button. Instead of selecting a full line it will extend the selection to
1182the end of the logical line only. option <strong>-tcw</strong>.
1055</dd> 1183</dd>
1056<p></p> 1184<p></p>
1057<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1185<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1058</dt> 1186</dt>
1059<dd> 1187<dd>
… …
1114<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p> 1242<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p>
1115</dd> 1243</dd>
1116<dd> 1244<dd>
1117<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to 1245<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to
1118whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1246whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1119keys are being mapped. <strong>AppKeypad</strong> is a artificial modifier mapped to the 1247keys are being mapped. <strong>AppKeypad</strong> is a synthetic modifier mapped to the
1120current application keymap mode state.</p> 1248current application keymap mode state.</p>
1121</dd> 1249</dd>
1122<dd> 1250<dd>
1123<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or 1251<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or
1124searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and 1252searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and
… …
1132<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1260<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1133<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it 1261<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1134can start or end with whitespace.</p> 1262can start or end with whitespace.</p>
1135</dd> 1263</dd>
1136<dd> 1264<dd>
1265<p>Please note that you need to double the <code>\</code> when using
1266<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
1267use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
1268rxvt's own processing).</p>
1269</dd>
1270<dd>
1137<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1271<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1138with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' 1272with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1139should be a character not used by the strings.</p> 1273should be a character not used by the strings.</p>
1140</dd> 1274</dd>
1141<dd> 1275<dd>
1142<p>Its usage can be demonstrated by an example:</p> 1276<p>Its usage can be demonstrated by an example:</p>
1143</dd> 1277</dd>
1144<dd> 1278<dd>
1145<pre> 1279<pre>
1146 URxvt.keysym.M-C-0x61: list|\e&lt;M-C-|abc|&gt;</pre> 1280 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1147</dd> 1281</dd>
1148<dd> 1282<dd>
1149<p>The above line is equivalent to the following three lines:</p> 1283<p>The above line is equivalent to the following three lines:</p>
1150</dd> 1284</dd>
1151<dd> 1285<dd>
1152<pre> 1286<pre>
1153 URxvt.keysym.Meta-Control-0x61: \e&lt;M-C-a&gt; 1287 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1154 URxvt.keysym.Meta-Control-0x62: \e&lt;M-C-b&gt; 1288 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1155 URxvt.keysym.Meta-Control-0x63: \e&lt;M-C-c&gt;</pre> 1289 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1156</dd>
1157<dd> 1290</dd>
1291<dd>
1158<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong> is 1292<p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
1159interpreted and executed as rxvt's control sequence. For example, 1293is interpreted and executed as rxvt's control sequence. For
1160<code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to 1294example the following means ``change the current locale to <code>zh_CN.GBK</code>
1161<code>zh_CN.GBK</code>.</p> 1295when Control-Meta-c is being pressed'':</p>
1296</dd>
1297<dd>
1298<pre>
1299 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1300</dd>
1301<dd>
1302<p>Due the the large number of modifier combinations, a defined key mapping
1303will match if at <em>at least</em> the specified identifiers are being set, and
1304no other key mappings with those and more bits are being defined. That
1305means that defining a key map for <code>a</code> will automatically provide
1306definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1307mappings themselves.</p>
1308</dd>
1309<dd>
1310<p>Unfortunately, this will override built-in key mappings. For example
1311if you overwrite the <code>Insert</code> key you will disable rxvt's
1312<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1313user-defined keymap using the <code>builtin:</code> replacement:</p>
1314</dd>
1315<dd>
1316<pre>
1317 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1318 URxvt.keysym.S-Insert: builtin:</pre>
1319</dd>
1320<dd>
1321<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1322of modifiers. The second line re-establishes the default mapping for
1323<code>Shift-Insert</code>.</p>
1324</dd>
1325<dd>
1326<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1327the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1328font-switching at runtime:</p>
1329</dd>
1330<dd>
1331<pre>
1332 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1333 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1334</dd>
1335<dd>
1336<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1337info):</p>
1338</dd>
1339<dd>
1340<pre>
1341 URxvt.keysym.M-C-3: command:\033[8;25;80t
1342 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1162</dd> 1343</dd>
1163<p></p></dl> 1344<p></p></dl>
1164<p> 1345<p>
1165</p> 1346</p>
1166<hr /> 1347<hr />
… …
1180<p>To temporarily override mouse reporting, for either the scrollbar or 1361<p>To temporarily override mouse reporting, for either the scrollbar or
1181the normal text selection/insertion, hold either the Shift or the Meta 1362the normal text selection/insertion, hold either the Shift or the Meta
1182(Alt) key while performing the desired mouse action.</p> 1363(Alt) key while performing the desired mouse action.</p>
1183<p>If mouse reporting mode is active, the normal scrollbar actions are 1364<p>If mouse reporting mode is active, the normal scrollbar actions are
1184disabled -- on the assumption that we are using a fullscreen 1365disabled -- on the assumption that we are using a fullscreen
1185application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1366application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1186(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1367(Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the
1187up and down arrows sends <strong>ESC[A</strong> (Up) and <strong>ESC[B</strong> (Down), 1368up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1188respectively.</p> 1369respectively.</p>
1189<p> 1370<p>
1190</p> 1371</p>
1191<hr /> 1372<hr />
1192<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1373<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
… …
1194<em>xterm</em>(1).</p> 1375<em>xterm</em>(1).</p>
1195<dl> 1376<dl>
1196<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br /> 1377<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br />
1197</dt> 1378</dt>
1198<dd> 1379<dd>
1199Left click at the beginning of the region, drag to the end of the 1380Left click at the beginning of the region, drag to the end of the region
1200region and release; Right click to extend the marked region; Left 1381and release; Right click to extend the marked region; Left double-click
1201double-click to select a word; Left triple-click to select the entire 1382to select a word; Left triple-click to select the entire logical line
1202line. 1383(which can span multiple screen lines), unless modified by resource
1384<strong>tripleclickwords</strong>.
1203</dd> 1385</dd>
1204<dd> 1386<dd>
1205<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1387<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1206(Compile: <em>frills</em>) will create a rectangular selection instead of a normal 1388(Compile: <em>frills</em>) will create a rectangular selection instead of a normal
1207one.</p> 1389one.</p>
… …
1233<p>ISO 14755 is a standard for entering and viewing unicode characters 1415<p>ISO 14755 is a standard for entering and viewing unicode characters
1234and character codes using the keyboard. It consists of 4 parts. The 1416and character codes using the keyboard. It consists of 4 parts. The
1235first part is available rxvt-unicode has been compiled with 1417first part is available rxvt-unicode has been compiled with
1236<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled 1418<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled
1237with <code>--enable-iso14755</code>.</p> 1419with <code>--enable-iso14755</code>.</p>
1238<ol> 1420<ul>
1239<li><strong><a name="item_1_3a_basic_method">1: Basic method</a></strong><br /> 1421<li><strong><a name="item_5_2e1_3a_basic_method">5.1: Basic method</a></strong><br />
1240</li> 1422</li>
1241This allows you to enter unicode characters using their hexcode. 1423This allows you to enter unicode characters using their hexcode.
1242<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter 1424<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter
1243hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will 1425hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will
1244commit the character as if it were typed directly. While holding down 1426commit the character as if it were typed directly. While holding down
… …
1249address, which you cannot type. Fortunately, the card has the e-mail 1431address, which you cannot type. Fortunately, the card has the e-mail
1250address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily 1432address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily
1251by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>, 1433by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>,
1252followed by releasing the modifier keys.</p> 1434followed by releasing the modifier keys.</p>
1253<p></p> 1435<p></p>
1254<li><strong><a name="item_2_3a_keyboard_symbols_entry_method">2: Keyboard symbols entry method</a></strong><br /> 1436<li><strong><a name="item_5_2e2_3a_keyboard_symbols_entry_method">5.2: Keyboard symbols entry method</a></strong><br />
1255</li> 1437</li>
1256This mode lets you input characters representing the keycap symbols of 1438This mode lets you input characters representing the keycap symbols of
1257your keyboard, if representable in the current locale encoding. 1439your keyboard, if representable in the current locale encoding.
1258<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing 1440<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing
1259them. The next special key (cursor keys, home etc.) you enter will not 1441them. The next special key (cursor keys, home etc.) you enter will not
… …
1261keycap symbol. The symbol will only be entered when the key has been 1443keycap symbol. The symbol will only be entered when the key has been
1262released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for 1444released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for
1263<code>ISO Level 2 Switch</code>, although your intention might have been to enter a 1445<code>ISO Level 2 Switch</code>, although your intention might have been to enter a
1264reverse tab (Shift-Tab).</p> 1446reverse tab (Shift-Tab).</p>
1265<p></p> 1447<p></p>
1266<li><strong><a name="item_3_3a_screen_2dselection_entry_method">3: Screen-selection entry method</a></strong><br /> 1448<li><strong><a name="item_5_2e3_3a_screen_2dselection_entry_method">5.3: Screen-selection entry method</a></strong><br />
1267</li> 1449</li>
1268While this is implemented already (it's basically the selection 1450While this is implemented already (it's basically the selection
1269mechanism), it could be extended by displaying a unicode character map. 1451mechanism), it could be extended by displaying a unicode character map.
1270<p></p> 1452<p></p>
1271<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 /> 1453<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 />
1272</li> 1454</li>
1273This method lets you display the unicode character code associated with 1455This method lets you display the unicode character code associated with
1274characters already displayed. 1456characters already displayed.
1275<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then 1457<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then
1276pressing and holding the left mouse button and moving around. The unicode 1458pressing and holding the left mouse button and moving around. The unicode
… …
1278pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p> 1460pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p>
1279<p>In addition to the hex codes it will display the font used to draw this 1461<p>In addition to the hex codes it will display the font used to draw this
1280character - due to implementation reasons, characters combined with 1462character - due to implementation reasons, characters combined with
1281combining characters, line drawing characters and unknown characters will 1463combining characters, line drawing characters and unknown characters will
1282always be drawn using the built-in support font.</p> 1464always be drawn using the built-in support font.</p>
1283<p></p></ol> 1465<p></p></ul>
1284<p>With respect to conformance, rxvt-unicode is supposed to be compliant to 1466<p>With respect to conformance, rxvt-unicode is supposed to be compliant to
1285both scenario A and B of ISO 14755, including part 5.2.</p> 1467both scenario A and B of ISO 14755, including part 5.2.</p>
1286<p> 1468<p>
1287</p> 1469</p>
1288<hr /> 1470<hr />
1289<h1><a name="login_stamp">LOGIN STAMP</a></h1> 1471<h1><a name="login_stamp">LOGIN STAMP</a></h1>
1290<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so 1472<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so that
1291that it can be seen via the <em>who(1)</em> command, and can accept messages. 1473it can be seen via the <em>who(1)</em> command, and can accept messages. To
1292To allow this feature, <strong>rxvt</strong> must be installed setuid root on 1474allow this feature, <strong>rxvt</strong> may need to be installed setuid root
1293some systems.</p> 1475on some systems or setgid to root or to some other group on others.</p>
1294<p> 1476<p>
1295</p> 1477</p>
1296<hr /> 1478<hr />
1297<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1> 1479<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
1298<p>In addition to the default foreground and background colours, 1480<p>In addition to the default foreground and background colours,
… …
1336<p></p></dl> 1518<p></p></dl>
1337<p> 1519<p>
1338</p> 1520</p>
1339<hr /> 1521<hr />
1340<h1><a name="environment">ENVIRONMENT</a></h1> 1522<h1><a name="environment">ENVIRONMENT</a></h1>
1341<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1523<p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
1342and <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X 1524<dl>
1343window id number of the <strong>rxvt</strong> window and it also uses and 1525<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1344sets the environment variable <strong>DISPLAY</strong> to specify which display 1526</dt>
1345terminal to use. <strong>rxvt</strong> uses the environment variables 1527<dd>
1346<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1528Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1529resources or on the commandline.
1530</dd>
1531<p></p>
1532<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1533</dt>
1534<dd>
1535Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1536compiled with XPM support, and optionally with the added extension
1537<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1538</dd>
1539<p></p>
1540<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1541</dt>
1542<dd>
1543Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1544the colour code used as default foreground/text colour (or the string
1545<code>default</code> to indicate that the default-colour escape sequence is to be
1546used), <code>bg</code> is the colour code used as default background colour (or the
1547string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1548was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1549(and do) use this information to optimize screen output.
1550</dd>
1551<p></p>
1552<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1553</dt>
1554<dd>
1555Set to the (decimal) X Window ID of the rxvt window (the toplevel
1556window, which usually has subwindows for the scrollbar, the terminal
1557window and so on).
1558</dd>
1559<p></p>
1560<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1561</dt>
1562<dd>
1563Set to the terminfo directory iff rxvt was configured with
1564<code>--with-terminfo=PATH</code>.
1565</dd>
1566<p></p>
1567<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1568</dt>
1569<dd>
1570Used by rxvt to connect to the display and set to the correct
1571display in it's child processes.
1572</dd>
1573<p></p>
1574<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1575</dt>
1576<dd>
1577The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1578</dd>
1579<p></p>
1580<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1581</dt>
1582<dd>
1583The path where rxvt looks for support files such as menu and xpm
1584files.
1585</dd>
1586<p></p>
1587<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1588</dt>
1589<dd>
1590Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1591</dd>
1592<p></p>
1593<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1594</dt>
1595<dd>
1596The unix domain socket path used by <code>rxvtc(1)</code> and
1597rxvtd(1).
1598</dd>
1599<dd>
1600<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1601</dd>
1602<p></p>
1603<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1604</dt>
1605<dd>
1606Used to locate the default directory for the unix domain socket for
1607daemon communications and to locate various resource files (such as
1608<code>.Xdefaults</code>)
1609</dd>
1610<p></p>
1611<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1612</dt>
1613<dd>
1614Directory where various X resource files are being located.
1615</dd>
1616<p></p>
1617<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1618</dt>
1619<dd>
1620If set and accessible, gives the name of a X resource file to be loaded by
1621rxvt.
1622</dd>
1623<p></p></dl>
1347<p> 1624<p>
1348</p> 1625</p>
1349<hr /> 1626<hr />
1350<h1><a name="files">FILES</a></h1> 1627<h1><a name="files">FILES</a></h1>
1351<dl> 1628<dl>
1352<dt><strong><a name="item__2fetc_2futmp"><strong>/etc/utmp</strong></a></strong><br />
1353</dt>
1354<dd>
1355System file for login records.
1356</dd>
1357<p></p>
1358<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br /> 1629<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br />
1359</dt> 1630</dt>
1360<dd> 1631<dd>
1361Color names. 1632Color names.
1362</dd> 1633</dd>
1363<p></p></dl> 1634<p></p></dl>
1364<p> 1635<p>
1365</p> 1636</p>
1366<hr /> 1637<hr />
1367<h1><a name="see_also">SEE ALSO</a></h1> 1638<h1><a name="see_also">SEE ALSO</a></h1>
1368<p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1639<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1369<p> 1640<p>
1370</p> 1641</p>
1371<hr /> 1642<hr />
1372<h1><a name="bugs">BUGS</a></h1> 1643<h1><a name="bugs">BUGS</a></h1>
1373<p>Check the BUGS file for an up-to-date list.</p> 1644<p>Check the BUGS file for an up-to-date list.</p>
… …
1379<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1650<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1380<dl> 1651<dl>
1381<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1652<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1382</dt> 1653</dt>
1383<dd> 1654<dd>
1384Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1655Marc A. Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;
1385</dd>
1386<p></p>
1387<dt><strong><a name="item_web_page_maintainter">Web page maintainter</a></strong><br />
1388</dt>
1389<dd> 1656</dd>
1390Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1391</dd> 1657<dd>
1392<dd>
1393<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1658<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1394</dd> 1659</dd>
1395<p></p></dl> 1660<p></p></dl>
1396<p> 1661<p>
1397</p> 1662</p>
1398<hr /> 1663<hr />
… …
1436<dd> 1701<dd>
1437Rewrote screen display and text selection routines. Project Coordinator 1702Rewrote screen display and text selection routines. Project Coordinator
1438(changes.txt 2.4.6 - rxvt-unicode) 1703(changes.txt 2.4.6 - rxvt-unicode)
1439</dd> 1704</dd>
1440<p></p> 1705<p></p>
1441<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 /> 1706<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 />
1442</dt> 1707</dt>
1443<dd> 1708<dd>
1444Forked rxvt-unicode, rewrote most of the display code and internal 1709Forked rxvt-unicode, rewrote most of the display code and internal
1445character handling to store text in unicode, improve xterm 1710character handling to store text in unicode, improve xterm
1446compatibility and apply numerous other bugfixes and extensions. 1711compatibility and apply numerous other bugfixes and extensions.

Diff Legend

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