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.40 by root, Tue Jan 10 04:26:54 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.3</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>
… …
266</dd> 266</dd>
267<p></p> 267<p></p>
268<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br /> 268<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br />
269</dt> 269</dt>
270<dd> 270<dd>
271Compile font-styles: The bold font list to use when bold characters are to 271Compile <em>font-styles</em>: The bold font list to use when <strong>bold</strong> characters
272be printed. See resource <strong>boldFont</strong> for details. 272are to be printed. See resource <strong>boldFont</strong> for details.
273</dd> 273</dd>
274<p></p> 274<p></p>
275<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br /> 275<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br />
276</dt> 276</dt>
277<dd> 277<dd>
278Compile font-styles: The italic font list to use when bold characters are to 278Compile <em>font-styles</em>: The italic font list to use when <em>italic</em>
279be printed. See resource <strong>italicFont</strong> for details. 279characters are to be printed. See resource <strong>italicFont</strong> for details.
280</dd> 280</dd>
281<p></p> 281<p></p>
282<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br /> 282<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br />
283</dt> 283</dt>
284<dd> 284<dd>
285Compile font-styles: The bold italic font list to use when bold characters are to 285Compile <em>font-styles</em>: The bold italic font list to use when <strong><em>bold
286be printed. See resource <strong>boldItalicFont</strong> for details. 286italic</em> </strong>&gt; characters are to be printed. See resource <strong>boldItalicFont</strong>
287for details.
288</dd>
289<p></p>
290<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br />
291</dt>
292<dd>
293Compile <em>font-styles</em>: Bold/Italic font styles imply high intensity
294foreground/background (default). See resource <strong>intensityStyles</strong> for
295details.
287</dd> 296</dd>
288<p></p> 297<p></p>
289<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br /> 298<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br />
290</dt> 299</dt>
291<dd> 300<dd>
… …
404</dt> 413</dt>
405<dd> 414<dd>
406Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e. 415Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e.
407if honoured by the WM, the rxvt-unicode window will not have window 416if honoured by the WM, the rxvt-unicode window will not have window
408decorations; resource <strong>borderLess</strong>. 417decorations; resource <strong>borderLess</strong>.
418</dd>
419<p></p>
420<dt><strong><a name="item__2dsbg"><strong>-sbg</strong></a></strong><br />
421</dt>
422<dd>
423Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
424drawing characters and just rely on what the specified fonts provide. Use
425this if you have a good font and want to use its block graphic glyphs;
426resource <strong>skipBuiltinGlyphs</strong>.
409</dd> 427</dd>
410<p></p> 428<p></p>
411<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br /> 429<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br />
412</dt> 430</dt>
413<dd> 431<dd>
… …
434given on the command line. If this option is used, it must be the last 452given 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 453on 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, 454run the program specified by the <strong>SHELL</strong> environment variable or,
437failing that, <em>sh(1)</em>. 455failing that, <em>sh(1)</em>.
438</dd> 456</dd>
457<dd>
458<p>Please note that you must specify a program with arguments. If you want to
459run shell commands, you have to specify the shell, like this:</p>
460</dd>
461<dd>
462<pre>
463 rxvt -e sh -c &quot;shell commands&quot;</pre>
464</dd>
439<p></p> 465<p></p>
440<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 466<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
441</dt> 467</dt>
442<dd> 468<dd>
443Window title (<strong>-T</strong> still respected); the default title is the basename 469Window 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 /> 548<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br />
523</dt> 549</dt>
524<dd> 550<dd>
525Turn on/off secondary screen scroll (default enabled); resource 551Turn on/off secondary screen scroll (default enabled); resource
526<strong>secondaryScroll</strong>. 552<strong>secondaryScroll</strong>.
553</dd>
554<p></p>
555<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
556</dt>
557<dd>
558Turn on/off hold window after exit support. If enabled, rxvt
559will not immediately destroy its window when the program executed within
560it exits. Instead, it will wait till it is being killed or closed by the
561user; resource <strong>hold</strong>.
527</dd> 562</dd>
528<p></p> 563<p></p>
529<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br /> 564<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
530</dt> 565</dt>
531<dd> 566<dd>
… …
565 my $xid = $_[0]-&gt;window-&gt;get_xid; 600 my $xid = $_[0]-&gt;window-&gt;get_xid;
566 system &quot;rxvt -embed $xid &amp;&quot;; 601 system &quot;rxvt -embed $xid &amp;&quot;;
567 });</pre> 602 });</pre>
568</dd> 603</dd>
569<p></p> 604<p></p>
570<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br /> 605<dt><strong><a name="item__2dpty_2dfd_file_descriptor"><strong>-pty-fd</strong> <em>file descriptor</em></a></strong><br />
571</dt> 606</dt>
572<dd> 607<dd>
573Tells rxvt NOT to execute any commands or create a new pty/tty 608Tells rxvt NOT to execute any commands or create a new pty/tty
574pair but instead use the given filehandle as the tty master. This is 609pair but instead use the given filehandle as the tty master. This is
575useful if you want to drive rxvt as a generic terminal emulator 610useful if you want to drive rxvt as a generic terminal emulator
… …
577</dd> 612</dd>
578<dd> 613<dd>
579<p>If this switch is given, rxvt will not create any utmp/wtmp 614<p>If this switch is given, rxvt will not create any utmp/wtmp
580entries and will not tinker with pty/tty permissions - you have to do that 615entries and will not tinker with pty/tty permissions - you have to do that
581yourself if you want that.</p> 616yourself if you want that.</p>
617</dd>
618<dd>
619<p>As an extremely special case, specifying <code>-1</code> will completely suppress
620pty/tty operations.</p>
582</dd> 621</dd>
583<dd> 622<dd>
584<p>Here is a example in perl that illustrates how this option can be used (a 623<p>Here is a example in perl that illustrates how this option can be used (a
585longer example is in <em>doc/pty-fd</em>):</p> 624longer example is in <em>doc/pty-fd</em>):</p>
586</dd> 625</dd>
… …
599<dd> 638<dd>
600<pre> 639<pre>
601 # now communicate with rxvt 640 # now communicate with rxvt
602 my $slave = $pty-&gt;slave; 641 my $slave = $pty-&gt;slave;
603 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre> 642 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
643</dd>
644<p></p>
645<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br />
646</dt>
647<dd>
648Comma-separated list of perl extension scripts to use (or not to use) in
649this terminal instance. See resource <strong>perl-ext</strong> for details.
604</dd> 650</dd>
605<p></p></dl> 651<p></p></dl>
606<p> 652<p>
607</p> 653</p>
608<hr /> 654<hr />
… …
830<dd> 876<dd>
831Select the fonts to be used. This is a comma separated list of font 877Select 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. 878names that are used in turn when trying to display Unicode characters.
833The first font defines the cell size for characters; other fonts might 879The first font defines the cell size for characters; other fonts might
834be smaller, but not larger. A reasonable default font list is always 880be smaller, but not larger. A reasonable default font list is always
835appended to it. option <strong>-fn</strong>. 881appended to it; option <strong>-fn</strong>.
836</dd> 882</dd>
837<dd> 883<dd>
838<p>Each font can either be a standard X11 core font (XLFD) name, with 884<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> 885optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
840</dd> 886</dd>
… …
901<dd> 947<dd>
902<p>If set, but empty, then this specific style is disabled and the normal 948<p>If set, but empty, then this specific style is disabled and the normal
903text font will being used for the given style.</p> 949text font will being used for the given style.</p>
904</dd> 950</dd>
905<p></p> 951<p></p>
952<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
953</dt>
954<dd>
955When font styles are not enabled, or this option is enabled (<strong>True</strong>,
956option <strong>-is</strong>, the default), bold and italic font styles imply high
957intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
958option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
959reachable.
960</dd>
961<p></p>
906<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 962<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
907</dt> 963</dt>
908<dd> 964<dd>
909Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 965Set 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 966xterm style with 2.20 old word selection, or anything else which gives
… …
1065<dd> 1121<dd>
1066Set MWM hints to request a borderless window, i.e. if honoured by the 1122Set MWM hints to request a borderless window, i.e. if honoured by the
1067WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>. 1123WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
1068</dd> 1124</dd>
1069<p></p> 1125<p></p>
1126<dt><strong><a name="item_skipbuiltinglyphs_3a_boolean"><strong>skipBuiltinGlyphs:</strong> <em>boolean</em></a></strong><br />
1127</dt>
1128<dd>
1129Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
1130drawing characters and just rely on what the specified fonts provide. Use
1131this if you have a good font and want to use its block graphic glyphs;
1132option <strong>-sbg</strong>.
1133</dd>
1134<p></p>
1070<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br /> 1135<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
1071</dt> 1136</dt>
1072<dd> 1137<dd>
1073Specifies the terminal type name to be set in the <strong>TERM</strong> environment 1138Specifies the terminal type name to be set in the <strong>TERM</strong> environment
1074variable; option <strong>-tn</strong>. 1139variable; option <strong>-tn</strong>.
… …
1179</dt> 1244</dt>
1180<dd> 1245<dd>
1181The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g. 1246The 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 1247<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 1248input extension to be able to input japanese characters while staying in
1184another locale. option <strong>-imlocale</strong>. 1249another locale; option <strong>-imlocale</strong>.
1185</dd> 1250</dd>
1186<p></p> 1251<p></p>
1187<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br /> 1252<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1188</dt> 1253</dt>
1189<dd> 1254<dd>
… …
1198<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br /> 1263<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1199</dt> 1264</dt>
1200<dd> 1265<dd>
1201Change the meaning of triple-click selection with the left mouse 1266Change the meaning of triple-click selection with the left mouse
1202button. Instead of selecting a full line it will extend the selection to 1267button. Instead of selecting a full line it will extend the selection to
1203the end of the logical line only. option <strong>-tcw</strong>. 1268the end of the logical line only; option <strong>-tcw</strong>.
1204</dd> 1269</dd>
1205<p></p> 1270<p></p>
1206<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1271<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1207</dt> 1272</dt>
1208<dd> 1273<dd>
… …
1250option is enabled, scrolls on the secondary screen will change the 1315option is enabled, scrolls on the secondary screen will change the
1251scrollback buffer and switching to/from the secondary screen will 1316scrollback buffer and switching to/from the secondary screen will
1252instead scroll the screen up. 1317instead scroll the screen up.
1253</dd> 1318</dd>
1254<p></p> 1319<p></p>
1320<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1321</dt>
1322<dd>
1323Turn on/off hold window after exit support. If enabled, rxvt
1324will not immediately destroy its window when the program executed within
1325it exits. Instead, it will wait till it is being killed or closed by the
1326user.
1327</dd>
1328<p></p>
1255<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1329<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1256</dt> 1330</dt>
1257<dd> 1331<dd>
1258Compile <em>frills</em>: Associate <em>string</em> with keysym <em>sym</em>. The 1332Compile <em>frills</em>: Associate <em>string</em> with keysym <em>sym</em>. The
1259intervening resource name <strong>keysym.</strong> cannot be omitted. 1333intervening resource name <strong>keysym.</strong> cannot be omitted.
… …
1319when Control-Meta-c is being pressed'':</p> 1393when Control-Meta-c is being pressed'':</p>
1320</dd> 1394</dd>
1321<dd> 1395<dd>
1322<pre> 1396<pre>
1323 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1397 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1398</dd>
1399<dd>
1400<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1401is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1402manpage. For example, the <em>selection</em> extension (activated via
1403<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1404</dd>
1405<dd>
1406<pre>
1407 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1324</dd> 1408</dd>
1325<dd> 1409<dd>
1326<p>Due the the large number of modifier combinations, a defined key mapping 1410<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 1411will 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 1412no other key mappings with those and more bits are being defined. That
… …
1362</dd> 1446</dd>
1363<dd> 1447<dd>
1364<pre> 1448<pre>
1365 URxvt.keysym.M-C-3: command:\033[8;25;80t 1449 URxvt.keysym.M-C-3: command:\033[8;25;80t
1366 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre> 1450 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1451</dd>
1452<p></p>
1453<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1454</dt>
1455<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1456</dt>
1457<dd>
1458Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1459use in this terminal instance; option <strong>-pe</strong>.
1460</dd>
1461<dd>
1462<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1463them. This can be useful to selectively disable some extensions loaded
1464by default, or specified via the <code>perl-ext-common</code> resource. For
1465example, <code>default,-selection</code> will use all the default extension except
1466<code>selection</code>.</p>
1467</dd>
1468<dd>
1469<p>Extension names can also be followed by an argument in angle brackets
1470(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for
1471searchable scorllback to Alt/Meta-s). Mentioning the same extension
1472multiple times with different arguments will pass multiple arguments to
1473the extension.</p>
1474</dd>
1475<dd>
1476<p>Each extension is looked up in the library directories, loaded if
1477necessary, and bound to the current terminal instance.</p>
1478</dd>
1479<dd>
1480<p>If both of these resources are the empty string, then the perl
1481interpreter will not be initialized. The idea behind two options is that
1482<strong>perl-ext-common</strong> will be used for extensions that should be available to
1483all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1484</dd>
1485<p></p>
1486<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1487</dt>
1488<dd>
1489Perl code to be evaluated when all extensions have been registered. See
1490the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1491will be ignored when running setuid/setgid.
1492</dd>
1493<p></p>
1494<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1495</dt>
1496<dd>
1497Colon-separated list of additional directories that hold extension
1498scripts. When looking for extensions specified by the <code>perl</code> resource,
1499rxvt will first look in these directories and then in
1500<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1501will be ignored when running setuid/setgid.
1502</dd>
1503<dd>
1504<p>See the <code>rxvtperl(3)</code> manpage.</p>
1505</dd>
1506<p></p>
1507<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1508</dt>
1509<dd>
1510Sets the WM_TRANSIENT_FOR property to the given window iw.
1367</dd> 1511</dd>
1368<p></p></dl> 1512<p></p></dl>
1369<p> 1513<p>
1370</p> 1514</p>
1371<hr /> 1515<hr />
… …
1407(which can span multiple screen lines), unless modified by resource 1551(which can span multiple screen lines), unless modified by resource
1408<strong>tripleclickwords</strong>. 1552<strong>tripleclickwords</strong>.
1409</dd> 1553</dd>
1410<dd> 1554<dd>
1411<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1555<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 1556(Compile: <em>frills</em>) will create a rectangular selection instead of a
1413one.</p> 1557normal one. In this mode, every selected row becomes its own line in the
1558selection, and trailing whitespace is visually underlined and removed from
1559the selection.</p>
1414</dd> 1560</dd>
1415<p></p> 1561<p></p>
1416<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1562<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1417</dt> 1563</dt>
1418<dd> 1564<dd>

Diff Legend

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