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.24 by root, Tue Oct 25 20:04:58 2005 UTC vs.
Revision 1.34 by root, Tue Jan 3 23:41:37 2006 UTC

… …
27 <li><a href="#login_stamp">LOGIN STAMP</a></li> 27 <li><a href="#login_stamp">LOGIN STAMP</a></li>
28 <li><a href="#colors_and_graphics">COLORS AND GRAPHICS</a></li> 28 <li><a href="#colors_and_graphics">COLORS AND GRAPHICS</a></li>
29 <li><a href="#environment">ENVIRONMENT</a></li> 29 <li><a href="#environment">ENVIRONMENT</a></li>
30 <li><a href="#files">FILES</a></li> 30 <li><a href="#files">FILES</a></li>
31 <li><a href="#see_also">SEE ALSO</a></li> 31 <li><a href="#see_also">SEE ALSO</a></li>
32 <li><a href="#bugs">BUGS</a></li>
33 <li><a href="#current_project_coordinator">CURRENT PROJECT COORDINATOR</a></li> 32 <li><a href="#current_project_coordinator">CURRENT PROJECT COORDINATOR</a></li>
34 <li><a href="#authors">AUTHORS</a></li> 33 <li><a href="#authors">AUTHORS</a></li>
35</ul> 34</ul>
36<!-- INDEX END --> 35<!-- INDEX END -->
37 36
… …
47<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 46<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
48<p> 47<p>
49</p> 48</p>
50<hr /> 49<hr />
51<h1><a name="description">DESCRIPTION</a></h1> 50<h1><a name="description">DESCRIPTION</a></h1>
52<p><strong>rxvt-unicode</strong>, version <strong>5.8</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>6.2</strong>, is a colour vt102 terminal
53emulator 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
54require features such as Tektronix 4014 emulation and toolkit-style 53require features such as Tektronix 4014 emulation and toolkit-style
55configurability. 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 --
56a significant advantage on a machine serving many X sessions.</p> 55a significant advantage on a machine serving many X sessions.</p>
57<p> 56<p>
… …
267</dd> 266</dd>
268<p></p> 267<p></p>
269<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 />
270</dt> 269</dt>
271<dd> 270<dd>
272Compile font-styles: The bold font list to use when bold characters are to 271Compile font-styles: The bold font list to use when <strong>bold</strong> characters are to
273be printed. See resource <strong>boldFont</strong> for details. 272be printed. See resource <strong>boldFont</strong> for details.
274</dd> 273</dd>
275<p></p> 274<p></p>
276<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 />
277</dt> 276</dt>
278<dd> 277<dd>
279Compile font-styles: The italic font list to use when bold characters are to 278Compile font-styles: The italic font list to use when <em>italic</em> characters are to
280be printed. See resource <strong>italicFont</strong> for details. 279be printed. See resource <strong>italicFont</strong> for details.
281</dd> 280</dd>
282<p></p> 281<p></p>
283<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 />
284</dt> 283</dt>
285<dd> 284<dd>
286Compile 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 <strong><em>bold
287be 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 font-styles: Bold/Italic font styles imply high intensity
294foreground/background (default). See resource <strong>intensityStyles</strong> for
295details.
288</dd> 296</dd>
289<p></p> 297<p></p>
290<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 />
291</dt> 299</dt>
292<dd> 300<dd>
… …
435given on the command line. If this option is used, it must be the last 443given on the command line. If this option is used, it must be the last
436on the command-line. If there is no <strong>-e</strong> option then the default is to 444on the command-line. If there is no <strong>-e</strong> option then the default is to
437run the program specified by the <strong>SHELL</strong> environment variable or, 445run the program specified by the <strong>SHELL</strong> environment variable or,
438failing that, <em>sh(1)</em>. 446failing that, <em>sh(1)</em>.
439</dd> 447</dd>
448<dd>
449<p>Please note that you must specify a program with arguments. If you want to
450run shell commands, you have to specify the shell, like this:</p>
451</dd>
452<dd>
453<pre>
454 rxvt -e sh -c &quot;shell commands&quot;</pre>
455</dd>
440<p></p> 456<p></p>
441<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 457<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
442</dt> 458</dt>
443<dd> 459<dd>
444Window title (<strong>-T</strong> still respected); the default title is the basename 460Window title (<strong>-T</strong> still respected); the default title is the basename
… …
523<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br /> 539<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br />
524</dt> 540</dt>
525<dd> 541<dd>
526Turn on/off secondary screen scroll (default enabled); resource 542Turn on/off secondary screen scroll (default enabled); resource
527<strong>secondaryScroll</strong>. 543<strong>secondaryScroll</strong>.
544</dd>
545<p></p>
546<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
547</dt>
548<dd>
549Turn on/off hold window after exit support. If enabled, rxvt
550will not immediately destroy its window when the program executed within
551it exits. Instead, it will wait till it is being killed or closed by the
552user; resource <strong>hold</strong>.
528</dd> 553</dd>
529<p></p> 554<p></p>
530<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br /> 555<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
531</dt> 556</dt>
532<dd> 557<dd>
… …
600<dd> 625<dd>
601<pre> 626<pre>
602 # now communicate with rxvt 627 # now communicate with rxvt
603 my $slave = $pty-&gt;slave; 628 my $slave = $pty-&gt;slave;
604 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre> 629 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
630</dd>
631<p></p>
632<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br />
633</dt>
634<dd>
635Colon-separated list of perl extension scripts to use in this terminal instance. See resource <strong>perl-ext</strong>.
605</dd> 636</dd>
606<p></p></dl> 637<p></p></dl>
607<p> 638<p>
608</p> 639</p>
609<hr /> 640<hr />
… …
831<dd> 862<dd>
832Select the fonts to be used. This is a comma separated list of font 863Select the fonts to be used. This is a comma separated list of font
833names that are used in turn when trying to display Unicode characters. 864names that are used in turn when trying to display Unicode characters.
834The first font defines the cell size for characters; other fonts might 865The first font defines the cell size for characters; other fonts might
835be smaller, but not larger. A reasonable default font list is always 866be smaller, but not larger. A reasonable default font list is always
836appended to it. option <strong>-fn</strong>. 867appended to it; option <strong>-fn</strong>.
837</dd> 868</dd>
838<dd> 869<dd>
839<p>Each font can either be a standard X11 core font (XLFD) name, with 870<p>Each font can either be a standard X11 core font (XLFD) name, with
840optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p> 871optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
841</dd> 872</dd>
… …
902<dd> 933<dd>
903<p>If set, but empty, then this specific style is disabled and the normal 934<p>If set, but empty, then this specific style is disabled and the normal
904text font will being used for the given style.</p> 935text font will being used for the given style.</p>
905</dd> 936</dd>
906<p></p> 937<p></p>
938<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
939</dt>
940<dd>
941When font styles are not enabled, or this option is enabled (<strong>True</strong>,
942option <strong>-is</strong>, the default), bold and italic font styles imply high
943intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
944option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
945reachable.
946</dd>
947<p></p>
907<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 948<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
908</dt> 949</dt>
909<dd> 950<dd>
910Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 951Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is
911xterm style with 2.20 old word selection, or anything else which gives 952xterm style with 2.20 old word selection, or anything else which gives
… …
1180</dt> 1221</dt>
1181<dd> 1222<dd>
1182The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g. 1223The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1183<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the 1224<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1184input extension to be able to input japanese characters while staying in 1225input extension to be able to input japanese characters while staying in
1185another locale. option <strong>-imlocale</strong>. 1226another locale; option <strong>-imlocale</strong>.
1186</dd> 1227</dd>
1187<p></p> 1228<p></p>
1188<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br /> 1229<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1189</dt> 1230</dt>
1190<dd> 1231<dd>
… …
1199<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br /> 1240<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1200</dt> 1241</dt>
1201<dd> 1242<dd>
1202Change the meaning of triple-click selection with the left mouse 1243Change the meaning of triple-click selection with the left mouse
1203button. Instead of selecting a full line it will extend the selection to 1244button. Instead of selecting a full line it will extend the selection to
1204the end of the logical line only. option <strong>-tcw</strong>. 1245the end of the logical line only; option <strong>-tcw</strong>.
1205</dd> 1246</dd>
1206<p></p> 1247<p></p>
1207<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1248<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1208</dt> 1249</dt>
1209<dd> 1250<dd>
1210Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1251Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1211echo arbitrary strings like the icon name or the locale. This could be 1252echo arbitrary strings like the icon name or the locale. This could be
1212abused if somebody gets 8-bit-clean access to your display, whether 1253abused if somebody gets 8-bit-clean access to your display, whether
1213throuh a mail client displaying mail bodies unfiltered or though 1254through a mail client displaying mail bodies unfiltered or through
1214write(1). Therefore, these sequences are disabled by default. (Note 1255<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1215that other terminals, including xterm, have these sequences 1256default. (Note that many other terminals, including xterm, have these
1216enabled by default). You can enable them by setting this boolean 1257sequences enabled by default, which doesn't make it safer, though).
1217resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1258</dd>
1218enabled display-answer, locale, findfont, icon label and window title 1259<dd>
1219requests as well as dynamic menubar dispatch. 1260<p>You can enable them by setting this boolean resource or specifying
1261<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1262locale, findfont, icon label and window title requests as well as dynamic
1263menubar dispatch.</p>
1220</dd> 1264</dd>
1221<p></p> 1265<p></p>
1222<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1266<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1223</dt> 1267</dt>
1224<dd> 1268<dd>
… …
1246<dd> 1290<dd>
1247Turn on/off secondary screen scroll (default enabled). If the this 1291Turn on/off secondary screen scroll (default enabled). If the this
1248option is enabled, scrolls on the secondary screen will change the 1292option is enabled, scrolls on the secondary screen will change the
1249scrollback buffer and switching to/from the secondary screen will 1293scrollback buffer and switching to/from the secondary screen will
1250instead scroll the screen up. 1294instead scroll the screen up.
1295</dd>
1296<p></p>
1297<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1298</dt>
1299<dd>
1300Turn on/off hold window after exit support. If enabled, rxvt
1301will not immediately destroy its window when the program executed within
1302it exits. Instead, it will wait till it is being killed or closed by the
1303user.
1251</dd> 1304</dd>
1252<p></p> 1305<p></p>
1253<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1306<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1254</dt> 1307</dt>
1255<dd> 1308<dd>
… …
1317when Control-Meta-c is being pressed'':</p> 1370when Control-Meta-c is being pressed'':</p>
1318</dd> 1371</dd>
1319<dd> 1372<dd>
1320<pre> 1373<pre>
1321 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1374 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1375</dd>
1376<dd>
1377<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1378is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1379manpage. For example, the <em>selection</em> extension (activated via
1380<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1381</dd>
1382<dd>
1383<pre>
1384 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1322</dd> 1385</dd>
1323<dd> 1386<dd>
1324<p>Due the the large number of modifier combinations, a defined key mapping 1387<p>Due the the large number of modifier combinations, a defined key mapping
1325will match if at <em>at least</em> the specified identifiers are being set, and 1388will match if at <em>at least</em> the specified identifiers are being set, and
1326no other key mappings with those and more bits are being defined. That 1389no other key mappings with those and more bits are being defined. That
… …
1360</dd> 1423</dd>
1361<dd> 1424<dd>
1362<pre> 1425<pre>
1363 URxvt.keysym.M-C-3: command:\033[8;25;80t 1426 URxvt.keysym.M-C-3: command:\033[8;25;80t
1364 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre> 1427 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1428</dd>
1429<p></p>
1430<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1431</dt>
1432<dd>
1433Colon-separated list of perl extension scripts to use in this terminal
1434instance. Each extension is looked up in the library directories, loaded
1435if necessary, and bound to the current terminal instance. If this resource
1436is empty or missing, then the perl interpreter will not be initialized;
1437option <strong>-pe</strong>.
1438</dd>
1439<p></p>
1440<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1441</dt>
1442<dd>
1443Perl code to be evaluated when all extensions have been registered. See the
1444<code>rxvtperl(3)</code> manpage.
1445</dd>
1446<p></p>
1447<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1448</dt>
1449<dd>
1450Colon-separated list of additional directories that hold extension
1451scripts. When looking for extensions specified by the <code>perl</code> resource,
1452rxvt will first look in these directories and then in
1453<em>/opt/rxvt/lib/urxvt/perl/</em>.
1454</dd>
1455<dd>
1456<p>See the <code>rxvtperl(3)</code> manpage.</p>
1365</dd> 1457</dd>
1366<p></p></dl> 1458<p></p></dl>
1367<p> 1459<p>
1368</p> 1460</p>
1369<hr /> 1461<hr />
… …
1405(which can span multiple screen lines), unless modified by resource 1497(which can span multiple screen lines), unless modified by resource
1406<strong>tripleclickwords</strong>. 1498<strong>tripleclickwords</strong>.
1407</dd> 1499</dd>
1408<dd> 1500<dd>
1409<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1501<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1410(Compile: <em>frills</em>) will create a rectangular selection instead of a normal 1502(Compile: <em>frills</em>) will create a rectangular selection instead of a
1411one.</p> 1503normal one. In this mode, every selected row becomes its own line in the
1504selection, and trailing whitespace is visually underlined and removed from
1505the selection.</p>
1412</dd> 1506</dd>
1413<p></p> 1507<p></p>
1414<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1508<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1415</dt> 1509</dt>
1416<dd> 1510<dd>
… …
1426<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1520<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1427supported in rxvt-unicode. Bug me if you need this.</p> 1521supported in rxvt-unicode. Bug me if you need this.</p>
1428<p>You can, however, switch fonts at runtime using escape sequences (and 1522<p>You can, however, switch fonts at runtime using escape sequences (and
1429therefore using the menubar), e.g.:</p> 1523therefore using the menubar), e.g.:</p>
1430<pre> 1524<pre>
1431 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1525 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1432<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1526<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1433<p> 1527<p>
1434</p> 1528</p>
1435<hr /> 1529<hr />
1436<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1530<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
… …
1660<h1><a name="see_also">SEE ALSO</a></h1> 1754<h1><a name="see_also">SEE ALSO</a></h1>
1661<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1755<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1662<p> 1756<p>
1663</p> 1757</p>
1664<hr /> 1758<hr />
1665<h1><a name="bugs">BUGS</a></h1>
1666<p>Check the BUGS file for an up-to-date list.</p>
1667<p>Cursor change support is not yet implemented.</p>
1668<p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1669<p>
1670</p>
1671<hr />
1672<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1759<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1673<dl> 1760<dl>
1674<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1761<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1675</dt> 1762</dt>
1676<dd> 1763<dd>

Diff Legend

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