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.26 by root, Sat Dec 17 20:55:45 2005 UTC vs.
Revision 1.32 by root, Mon Jan 2 21:41:51 2006 UTC

… …
46<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 46<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
47<p> 47<p>
48</p> 48</p>
49<hr /> 49<hr />
50<h1><a name="description">DESCRIPTION</a></h1> 50<h1><a name="description">DESCRIPTION</a></h1>
51<p><strong>rxvt-unicode</strong>, version <strong>5.9</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>6.2</strong>, is a colour vt102 terminal
52emulator intended as an <em>xterm</em>(1) replacement for users who do not 52emulator intended as an <em>xterm</em>(1) replacement for users who do not
53require features such as Tektronix 4014 emulation and toolkit-style 53require features such as Tektronix 4014 emulation and toolkit-style
54configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- 54configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
55a significant advantage on a machine serving many X sessions.</p> 55a significant advantage on a machine serving many X sessions.</p>
56<p> 56<p>
… …
284<dd> 284<dd>
285Compile font-styles: The bold italic font list to use when bold characters are to 285Compile font-styles: The bold italic font list to use when bold characters are to
286be printed. See resource <strong>boldItalicFont</strong> for details. 286be printed. See resource <strong>boldItalicFont</strong> for details.
287</dd> 287</dd>
288<p></p> 288<p></p>
289<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br />
290</dt>
291<dd>
292Compile font-styles: Bold/Italic font styles imply high intensity
293foreground/background (default). See resource <strong>intensityStyles</strong> for
294details.
295</dd>
296<p></p>
289<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br /> 297<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br />
290</dt> 298</dt>
291<dd> 299<dd>
292Specify the application name under which resources are to be obtained, 300Specify the application name under which resources are to be obtained,
293rather than the default executable file name. Name should not contain 301rather than the default executable file name. Name should not contain
… …
434given on the command line. If this option is used, it must be the last 442given on the command line. If this option is used, it must be the last
435on the command-line. If there is no <strong>-e</strong> option then the default is to 443on the command-line. If there is no <strong>-e</strong> option then the default is to
436run the program specified by the <strong>SHELL</strong> environment variable or, 444run the program specified by the <strong>SHELL</strong> environment variable or,
437failing that, <em>sh(1)</em>. 445failing that, <em>sh(1)</em>.
438</dd> 446</dd>
447<dd>
448<p>Please note that you must specify a program with arguments. If you want to
449run shell commands, you have to specify the shell, like this:</p>
450</dd>
451<dd>
452<pre>
453 rxvt -e sh -c &quot;shell commands&quot;</pre>
454</dd>
439<p></p> 455<p></p>
440<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 456<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
441</dt> 457</dt>
442<dd> 458<dd>
443Window title (<strong>-T</strong> still respected); the default title is the basename 459Window title (<strong>-T</strong> still respected); the default title is the basename
… …
522<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br /> 538<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br />
523</dt> 539</dt>
524<dd> 540<dd>
525Turn on/off secondary screen scroll (default enabled); resource 541Turn on/off secondary screen scroll (default enabled); resource
526<strong>secondaryScroll</strong>. 542<strong>secondaryScroll</strong>.
543</dd>
544<p></p>
545<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
546</dt>
547<dd>
548Turn on/off hold window after exit support. If enabled, rxvt
549will not immediately destroy its window when the program executed within
550it exits. Instead, it will wait till it is being killed or closed by the
551user; resource <strong>hold</strong>.
527</dd> 552</dd>
528<p></p> 553<p></p>
529<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br /> 554<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
530</dt> 555</dt>
531<dd> 556<dd>
… …
599<dd> 624<dd>
600<pre> 625<pre>
601 # now communicate with rxvt 626 # now communicate with rxvt
602 my $slave = $pty-&gt;slave; 627 my $slave = $pty-&gt;slave;
603 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre> 628 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
629</dd>
630<p></p>
631<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br />
632</dt>
633<dd>
634Colon-separated list of perl extension scripts to use in this terminal instance. See resource <strong>perl-ext</strong>.
604</dd> 635</dd>
605<p></p></dl> 636<p></p></dl>
606<p> 637<p>
607</p> 638</p>
608<hr /> 639<hr />
… …
830<dd> 861<dd>
831Select the fonts to be used. This is a comma separated list of font 862Select the fonts to be used. This is a comma separated list of font
832names that are used in turn when trying to display Unicode characters. 863names that are used in turn when trying to display Unicode characters.
833The first font defines the cell size for characters; other fonts might 864The first font defines the cell size for characters; other fonts might
834be smaller, but not larger. A reasonable default font list is always 865be smaller, but not larger. A reasonable default font list is always
835appended to it. option <strong>-fn</strong>. 866appended to it; option <strong>-fn</strong>.
836</dd> 867</dd>
837<dd> 868<dd>
838<p>Each font can either be a standard X11 core font (XLFD) name, with 869<p>Each font can either be a standard X11 core font (XLFD) name, with
839optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p> 870optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
840</dd> 871</dd>
… …
901<dd> 932<dd>
902<p>If set, but empty, then this specific style is disabled and the normal 933<p>If set, but empty, then this specific style is disabled and the normal
903text font will being used for the given style.</p> 934text font will being used for the given style.</p>
904</dd> 935</dd>
905<p></p> 936<p></p>
937<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
938</dt>
939<dd>
940When font styles are not enabled, or this option is enabled (<strong>True</strong>,
941option <strong>-is</strong>, the default), bold and italic font styles imply high
942intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
943option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
944reachable.
945</dd>
946<p></p>
906<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 947<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
907</dt> 948</dt>
908<dd> 949<dd>
909Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 950Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is
910xterm style with 2.20 old word selection, or anything else which gives 951xterm style with 2.20 old word selection, or anything else which gives
… …
1179</dt> 1220</dt>
1180<dd> 1221<dd>
1181The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g. 1222The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1182<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the 1223<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1183input extension to be able to input japanese characters while staying in 1224input extension to be able to input japanese characters while staying in
1184another locale. option <strong>-imlocale</strong>. 1225another locale; option <strong>-imlocale</strong>.
1185</dd> 1226</dd>
1186<p></p> 1227<p></p>
1187<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br /> 1228<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1188</dt> 1229</dt>
1189<dd> 1230<dd>
… …
1198<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br /> 1239<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1199</dt> 1240</dt>
1200<dd> 1241<dd>
1201Change the meaning of triple-click selection with the left mouse 1242Change the meaning of triple-click selection with the left mouse
1202button. Instead of selecting a full line it will extend the selection to 1243button. Instead of selecting a full line it will extend the selection to
1203the end of the logical line only. option <strong>-tcw</strong>. 1244the end of the logical line only; option <strong>-tcw</strong>.
1204</dd> 1245</dd>
1205<p></p> 1246<p></p>
1206<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1247<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1207</dt> 1248</dt>
1208<dd> 1249<dd>
… …
1250option is enabled, scrolls on the secondary screen will change the 1291option is enabled, scrolls on the secondary screen will change the
1251scrollback buffer and switching to/from the secondary screen will 1292scrollback buffer and switching to/from the secondary screen will
1252instead scroll the screen up. 1293instead scroll the screen up.
1253</dd> 1294</dd>
1254<p></p> 1295<p></p>
1296<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1297</dt>
1298<dd>
1299Turn on/off hold window after exit support. If enabled, rxvt
1300will not immediately destroy its window when the program executed within
1301it exits. Instead, it will wait till it is being killed or closed by the
1302user.
1303</dd>
1304<p></p>
1255<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1305<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1256</dt> 1306</dt>
1257<dd> 1307<dd>
1258Compile <em>frills</em>: Associate <em>string</em> with keysym <em>sym</em>. The 1308Compile <em>frills</em>: Associate <em>string</em> with keysym <em>sym</em>. The
1259intervening resource name <strong>keysym.</strong> cannot be omitted. 1309intervening resource name <strong>keysym.</strong> cannot be omitted.
… …
1319when Control-Meta-c is being pressed'':</p> 1369when Control-Meta-c is being pressed'':</p>
1320</dd> 1370</dd>
1321<dd> 1371<dd>
1322<pre> 1372<pre>
1323 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1373 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1374</dd>
1375<dd>
1376<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1377is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1378manpage. For example, the <em>selection</em> extension (activated via
1379<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1380</dd>
1381<dd>
1382<pre>
1383 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1324</dd> 1384</dd>
1325<dd> 1385<dd>
1326<p>Due the the large number of modifier combinations, a defined key mapping 1386<p>Due the the large number of modifier combinations, a defined key mapping
1327will match if at <em>at least</em> the specified identifiers are being set, and 1387will match if at <em>at least</em> the specified identifiers are being set, and
1328no other key mappings with those and more bits are being defined. That 1388no other key mappings with those and more bits are being defined. That
… …
1362</dd> 1422</dd>
1363<dd> 1423<dd>
1364<pre> 1424<pre>
1365 URxvt.keysym.M-C-3: command:\033[8;25;80t 1425 URxvt.keysym.M-C-3: command:\033[8;25;80t
1366 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre> 1426 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1427</dd>
1428<p></p>
1429<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1430</dt>
1431<dd>
1432Colon-separated list of perl extension scripts to use in this terminal
1433instance. Each extension is looked up in the library directories, loaded
1434if necessary, and bound to the current terminal instance; option <strong>-pe</strong>.
1435</dd>
1436<p></p>
1437<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1438</dt>
1439<dd>
1440Perl code to be evaluated when all extensions have been registered. See the
1441<code>rxvtperl(3)</code> manpage.
1442</dd>
1443<p></p>
1444<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1445</dt>
1446<dd>
1447Colon-separated list of additional directories that hold extension
1448scripts. When looking for extensions specified by the <code>perl</code> resource,
1449rxvt will first look in these directories and then in
1450<em>/opt/rxvt/lib/urxvt/perl/</em>.
1451</dd>
1452<dd>
1453<p>See the <code>rxvtperl(3)</code> manpage.</p>
1367</dd> 1454</dd>
1368<p></p></dl> 1455<p></p></dl>
1369<p> 1456<p>
1370</p> 1457</p>
1371<hr /> 1458<hr />
… …
1407(which can span multiple screen lines), unless modified by resource 1494(which can span multiple screen lines), unless modified by resource
1408<strong>tripleclickwords</strong>. 1495<strong>tripleclickwords</strong>.
1409</dd> 1496</dd>
1410<dd> 1497<dd>
1411<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1498<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1412(Compile: <em>frills</em>) will create a rectangular selection instead of a normal 1499(Compile: <em>frills</em>) will create a rectangular selection instead of a
1413one.</p> 1500normal one. In this mode, every selected row becomes its own line in the
1501selection, and trailing whitespace is visually underlined and removed from
1502the selection.</p>
1414</dd> 1503</dd>
1415<p></p> 1504<p></p>
1416<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1505<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1417</dt> 1506</dt>
1418<dd> 1507<dd>

Diff Legend

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