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.31 by root, Mon Jan 2 20:35:39 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>
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 bold characters are to
287be printed. See resource <strong>boldItalicFont</strong> for details. 286be printed. See resource <strong>boldItalicFont</strong> for details.
288</dd> 287</dd>
289<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>
290<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 />
291</dt> 298</dt>
292<dd> 299<dd>
293Specify the application name under which resources are to be obtained, 300Specify the application name under which resources are to be obtained,
294rather than the default executable file name. Name should not contain 301rather than the default executable file name. Name should not contain
435given 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
436on 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
437run the program specified by the <strong>SHELL</strong> environment variable or, 444run the program specified by the <strong>SHELL</strong> environment variable or,
438failing that, <em>sh(1)</em>. 445failing that, <em>sh(1)</em>.
439</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>
440<p></p> 455<p></p>
441<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 />
442</dt> 457</dt>
443<dd> 458<dd>
444Window 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
523<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 />
524</dt> 539</dt>
525<dd> 540<dd>
526Turn on/off secondary screen scroll (default enabled); resource 541Turn on/off secondary screen scroll (default enabled); resource
527<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>.
528</dd> 552</dd>
529<p></p> 553<p></p>
530<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 />
531</dt> 555</dt>
532<dd> 556<dd>
600<dd> 624<dd>
601<pre> 625<pre>
602 # now communicate with rxvt 626 # now communicate with rxvt
603 my $slave = $pty-&gt;slave; 627 my $slave = $pty-&gt;slave;
604 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>.
605</dd> 635</dd>
606<p></p></dl> 636<p></p></dl>
607<p> 637<p>
608</p> 638</p>
609<hr /> 639<hr />
831<dd> 861<dd>
832Select 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
833names that are used in turn when trying to display Unicode characters. 863names that are used in turn when trying to display Unicode characters.
834The first font defines the cell size for characters; other fonts might 864The first font defines the cell size for characters; other fonts might
835be smaller, but not larger. A reasonable default font list is always 865be smaller, but not larger. A reasonable default font list is always
836appended to it. option <strong>-fn</strong>. 866appended to it; option <strong>-fn</strong>.
837</dd> 867</dd>
838<dd> 868<dd>
839<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
840optional 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>
841</dd> 871</dd>
902<dd> 932<dd>
903<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
904text font will being used for the given style.</p> 934text font will being used for the given style.</p>
905</dd> 935</dd>
906<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>
907<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 />
908</dt> 948</dt>
909<dd> 949<dd>
910Set 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
911xterm 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
1180</dt> 1220</dt>
1181<dd> 1221<dd>
1182The 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.
1183<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
1184input extension to be able to input japanese characters while staying in 1224input extension to be able to input japanese characters while staying in
1185another locale. option <strong>-imlocale</strong>. 1225another locale; option <strong>-imlocale</strong>.
1186</dd> 1226</dd>
1187<p></p> 1227<p></p>
1188<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 />
1189</dt> 1229</dt>
1190<dd> 1230<dd>
1199<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 />
1200</dt> 1240</dt>
1201<dd> 1241<dd>
1202Change the meaning of triple-click selection with the left mouse 1242Change the meaning of triple-click selection with the left mouse
1203button. 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
1204the end of the logical line only. option <strong>-tcw</strong>. 1244the end of the logical line only; option <strong>-tcw</strong>.
1205</dd> 1245</dd>
1206<p></p> 1246<p></p>
1207<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 />
1208</dt> 1248</dt>
1209<dd> 1249<dd>
1210Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1250Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1211echo arbitrary strings like the icon name or the locale. This could be 1251echo arbitrary strings like the icon name or the locale. This could be
1212abused if somebody gets 8-bit-clean access to your display, whether 1252abused if somebody gets 8-bit-clean access to your display, whether
1213throuh a mail client displaying mail bodies unfiltered or though 1253through a mail client displaying mail bodies unfiltered or through
1214write(1). Therefore, these sequences are disabled by default. (Note 1254<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1215that other terminals, including xterm, have these sequences 1255default. (Note that many other terminals, including xterm, have these
1216enabled by default). You can enable them by setting this boolean 1256sequences enabled by default, which doesn't make it safer, though).
1217resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1257</dd>
1218enabled display-answer, locale, findfont, icon label and window title 1258<dd>
1219requests as well as dynamic menubar dispatch. 1259<p>You can enable them by setting this boolean resource or specifying
1260<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1261locale, findfont, icon label and window title requests as well as dynamic
1262menubar dispatch.</p>
1220</dd> 1263</dd>
1221<p></p> 1264<p></p>
1222<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1265<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1223</dt> 1266</dt>
1224<dd> 1267<dd>
1246<dd> 1289<dd>
1247Turn on/off secondary screen scroll (default enabled). If the this 1290Turn on/off secondary screen scroll (default enabled). If the this
1248option is enabled, scrolls on the secondary screen will change the 1291option is enabled, scrolls on the secondary screen will change the
1249scrollback buffer and switching to/from the secondary screen will 1292scrollback buffer and switching to/from the secondary screen will
1250instead scroll the screen up. 1293instead scroll the screen up.
1294</dd>
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.
1251</dd> 1303</dd>
1252<p></p> 1304<p></p>
1253<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 />
1254</dt> 1306</dt>
1255<dd> 1307<dd>
1360</dd> 1412</dd>
1361<dd> 1413<dd>
1362<pre> 1414<pre>
1363 URxvt.keysym.M-C-3: command:\033[8;25;80t 1415 URxvt.keysym.M-C-3: command:\033[8;25;80t
1364 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre> 1416 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1417</dd>
1418<p></p>
1419<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1420</dt>
1421<dd>
1422Colon-separated list of perl extension scripts to use in this terminal
1423instance. Each extension is looked up in the library directories, loaded
1424if necessary, and bound to the current terminal instance; option <strong>-pe</strong>.
1425</dd>
1426<p></p>
1427<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1428</dt>
1429<dd>
1430Perl code to be evaluated when all extensions have been registered. See the
1431<code>rxvtperl(3)</code> manpage.
1432</dd>
1433<p></p>
1434<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1435</dt>
1436<dd>
1437Colon-separated list of additional directories that hold extension
1438scripts. When looking for extensions specified by the <code>perl</code> resource,
1439rxvt will first look in these directories and then in
1440<em>/opt/rxvt/lib/urxvt/perl-ext/</em>.
1441</dd>
1442<dd>
1443<p>See the <code>rxvtperl(3)</code> manpage.</p>
1365</dd> 1444</dd>
1366<p></p></dl> 1445<p></p></dl>
1367<p> 1446<p>
1368</p> 1447</p>
1369<hr /> 1448<hr />
1405(which can span multiple screen lines), unless modified by resource 1484(which can span multiple screen lines), unless modified by resource
1406<strong>tripleclickwords</strong>. 1485<strong>tripleclickwords</strong>.
1407</dd> 1486</dd>
1408<dd> 1487<dd>
1409<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1488<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 1489(Compile: <em>frills</em>) will create a rectangular selection instead of a
1411one.</p> 1490normal one. In this mode, every selected row becomes its own line in the
1491selection, and trailing whitespace is visually underlined and removed from
1492the selection.</p>
1412</dd> 1493</dd>
1413<p></p> 1494<p></p>
1414<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1495<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1415</dt> 1496</dt>
1416<dd> 1497<dd>
1426<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1507<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1427supported in rxvt-unicode. Bug me if you need this.</p> 1508supported in rxvt-unicode. Bug me if you need this.</p>
1428<p>You can, however, switch fonts at runtime using escape sequences (and 1509<p>You can, however, switch fonts at runtime using escape sequences (and
1429therefore using the menubar), e.g.:</p> 1510therefore using the menubar), e.g.:</p>
1430<pre> 1511<pre>
1431 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1512 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> 1513<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1433<p> 1514<p>
1434</p> 1515</p>
1435<hr /> 1516<hr />
1436<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1517<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
1660<h1><a name="see_also">SEE ALSO</a></h1> 1741<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> 1742<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> 1743<p>
1663</p> 1744</p>
1664<hr /> 1745<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> 1746<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1673<dl> 1747<dl>
1674<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1748<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1675</dt> 1749</dt>
1676<dd> 1750<dd>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines