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.31 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.44 by root, Thu Jan 12 12:15:10 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>6.2</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>7.0</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.
287</dd> 288</dd>
288<p></p> 289<p></p>
289<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br /> 290<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br />
290</dt> 291</dt>
291<dd> 292<dd>
292Compile font-styles: Bold/Italic font styles imply high intensity 293Compile <em>font-styles</em>: Bold/Italic font styles imply high intensity
293foreground/background (default). See resource <strong>intensityStyles</strong> for 294foreground/background (default). See resource <strong>intensityStyles</strong> for
294details. 295details.
295</dd> 296</dd>
296<p></p> 297<p></p>
297<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 />
… …
412</dt> 413</dt>
413<dd> 414<dd>
414Compile <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.
415if 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
416decorations; 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>.
417</dd> 427</dd>
418<p></p> 428<p></p>
419<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 />
420</dt> 430</dt>
421<dd> 431<dd>
… …
590 my $xid = $_[0]-&gt;window-&gt;get_xid; 600 my $xid = $_[0]-&gt;window-&gt;get_xid;
591 system &quot;rxvt -embed $xid &amp;&quot;; 601 system &quot;rxvt -embed $xid &amp;&quot;;
592 });</pre> 602 });</pre>
593</dd> 603</dd>
594<p></p> 604<p></p>
595<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 />
596</dt> 606</dt>
597<dd> 607<dd>
598Tells 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
599pair 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
600useful if you want to drive rxvt as a generic terminal emulator 610useful if you want to drive rxvt as a generic terminal emulator
… …
602</dd> 612</dd>
603<dd> 613<dd>
604<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
605entries 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
606yourself 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>
607</dd> 621</dd>
608<dd> 622<dd>
609<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
610longer example is in <em>doc/pty-fd</em>):</p> 624longer example is in <em>doc/pty-fd</em>):</p>
611</dd> 625</dd>
… …
629</dd> 643</dd>
630<p></p> 644<p></p>
631<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br /> 645<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br />
632</dt> 646</dt>
633<dd> 647<dd>
634Colon-separated list of perl extension scripts to use in this terminal instance. See resource <strong>perl-ext</strong>. 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.
635</dd> 650</dd>
636<p></p></dl> 651<p></p></dl>
637<p> 652<p>
638</p> 653</p>
639<hr /> 654<hr />
640<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1> 655<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1>
641<p>Note: `rxvt --help' gives a list of all resources (long 656<p>Note: `rxvt --help' gives a list of all resources (long
642options) compiled into your version.</p> 657options) compiled into your version.</p>
643<p>There are two different methods that rxvt can use to get the 658<p>You can set and change the resources using X11 tools like <strong>xrdb</strong>. Many
644Xresource data: using the X libraries (Xrm*-functions) or internal
645Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
646<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
647resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
648settings from the <strong>~/.Xresources</strong> file when X starts. rxvt 659distribution do also load settings from the <strong>~/.Xresources</strong> file when X
649will consult the following files/resources in order, with later settings 660starts. rxvt will consult the following files/resources in order,
650overwriting earlier ones:</p> 661with later settings overwriting earlier ones:</p>
651<pre> 662<pre>
652 1. system-wide app-defaults file, either locale-dependent OR global 663 1. system-wide app-defaults file, either locale-dependent OR global
653 2. app-defaults file in $XAPPLRESDIR 664 2. app-defaults file in $XAPPLRESDIR
654 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 665 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
655 4. SCREEN_RESOURCES for the current screen 666 4. SCREEN_RESOURCES for the current screen
656 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre> 667 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
657<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
658lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
659set in XAPPLOADDIR/URxvt (compile-time defined: usually
660<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
661<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
662Note that when reading X resources, <strong>rxvt</strong> recognizes two 668<p>Note that when reading X resources, <strong>rxvt</strong> recognizes two class
663class names: <strong>XTerm</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows 669names: <strong>Rxvt</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows resources
664resources common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be 670common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be easily
665easily configured, while the class name <strong>URxvt</strong> allows resources 671configured, while the class name <strong>URxvt</strong> allows resources unique to
666unique to <strong>rxvt</strong>, notably colours and key-handling, to be 672<strong>rxvt</strong>, to be shared between different <strong>rxvt</strong>
667shared between different <strong>rxvt</strong> configurations. If no 673configurations. If no resources are specified, suitable defaults will
668resources are specified, suitable defaults will be used. Command-line 674be used. Command-line arguments can be used to override resource
669arguments can be used to override resource settings. The following 675settings. The following resources are supported (you might want to
670resources are allowed:</p> 676check the <code>rxvtperl(3)</code> manpage for additional settings by perl
677extensions not documented here):</p>
671<dl> 678<dl>
672<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br /> 679<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br />
673</dt> 680</dt>
674<dd> 681<dd>
675Create the window with the specified X window geometry [default 80x24]; 682Create the window with the specified X window geometry [default 80x24];
… …
1106<dd> 1113<dd>
1107Set MWM hints to request a borderless window, i.e. if honoured by the 1114Set MWM hints to request a borderless window, i.e. if honoured by the
1108WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>. 1115WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
1109</dd> 1116</dd>
1110<p></p> 1117<p></p>
1118<dt><strong><a name="item_skipbuiltinglyphs_3a_boolean"><strong>skipBuiltinGlyphs:</strong> <em>boolean</em></a></strong><br />
1119</dt>
1120<dd>
1121Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
1122drawing characters and just rely on what the specified fonts provide. Use
1123this if you have a good font and want to use its block graphic glyphs;
1124option <strong>-sbg</strong>.
1125</dd>
1126<p></p>
1111<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br /> 1127<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
1112</dt> 1128</dt>
1113<dd> 1129<dd>
1114Specifies the terminal type name to be set in the <strong>TERM</strong> environment 1130Specifies the terminal type name to be set in the <strong>TERM</strong> environment
1115variable; option <strong>-tn</strong>. 1131variable; option <strong>-tn</strong>.
… …
1334<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1350<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1335<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it 1351<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1336can start or end with whitespace.</p> 1352can start or end with whitespace.</p>
1337</dd> 1353</dd>
1338<dd> 1354<dd>
1339<p>Please note that you need to double the <code>\</code> when using 1355<p>Please note that you need to double the <code>\</code> in resource files, as
1340<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can 1356Xlib itself does it's own de-escaping (you can use <code>\033</code> instead of
1341use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and 1357<code>\e</code> (and so on), which will work with both Xt and rxvt's own
1342rxvt's own processing).</p> 1358processing).</p>
1343</dd> 1359</dd>
1344<dd> 1360<dd>
1345<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1361<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1346with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' 1362with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1347should be a character not used by the strings.</p> 1363should be a character not used by the strings.</p>
… …
1369when Control-Meta-c is being pressed'':</p> 1385when Control-Meta-c is being pressed'':</p>
1370</dd> 1386</dd>
1371<dd> 1387<dd>
1372<pre> 1388<pre>
1373 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1389 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1390</dd>
1391<dd>
1392<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1393is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1394manpage. For example, the <em>selection</em> extension (activated via
1395<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1396</dd>
1397<dd>
1398<pre>
1399 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1374</dd> 1400</dd>
1375<dd> 1401<dd>
1376<p>Due the the large number of modifier combinations, a defined key mapping 1402<p>Due the the large number of modifier combinations, a defined key mapping
1377will match if at <em>at least</em> the specified identifiers are being set, and 1403will match if at <em>at least</em> the specified identifiers are being set, and
1378no other key mappings with those and more bits are being defined. That 1404no other key mappings with those and more bits are being defined. That
… …
1414<pre> 1440<pre>
1415 URxvt.keysym.M-C-3: command:\033[8;25;80t 1441 URxvt.keysym.M-C-3: command:\033[8;25;80t
1416 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre> 1442 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1417</dd> 1443</dd>
1418<p></p> 1444<p></p>
1445<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1446</dt>
1419<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br /> 1447<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1420</dt> 1448</dt>
1421<dd> 1449<dd>
1422Colon-separated list of perl extension scripts to use in this terminal 1450Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1451use in this terminal instance; option <strong>-pe</strong>.
1452</dd>
1453<dd>
1454<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1455them. This can be useful to selectively disable some extensions loaded
1456by default, or specified via the <code>perl-ext-common</code> resource. For
1457example, <code>default,-selection</code> will use all the default extension except
1458<code>selection</code>.</p>
1459</dd>
1460<dd>
1461<p>Extension names can also be followed by an argument in angle brackets
1462(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for
1463searchable scorllback to Alt/Meta-s). Mentioning the same extension
1464multiple times with different arguments will pass multiple arguments to
1465the extension.</p>
1466</dd>
1467<dd>
1423instance. Each extension is looked up in the library directories, loaded 1468<p>Each extension is looked up in the library directories, loaded if
1424if necessary, and bound to the current terminal instance; option <strong>-pe</strong>. 1469necessary, and bound to the current terminal instance.</p>
1470</dd>
1471<dd>
1472<p>If both of these resources are the empty string, then the perl
1473interpreter will not be initialized. The idea behind two options is that
1474<strong>perl-ext-common</strong> will be used for extensions that should be available to
1475all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1425</dd> 1476</dd>
1426<p></p> 1477<p></p>
1427<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br /> 1478<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1428</dt> 1479</dt>
1429<dd> 1480<dd>
1430Perl code to be evaluated when all extensions have been registered. See the 1481Perl code to be evaluated when all extensions have been registered. See
1431<code>rxvtperl(3)</code> manpage. 1482the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1483will be ignored when running setuid/setgid.
1432</dd> 1484</dd>
1433<p></p> 1485<p></p>
1434<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br /> 1486<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1435</dt> 1487</dt>
1436<dd> 1488<dd>
1437Colon-separated list of additional directories that hold extension 1489Colon-separated list of additional directories that hold extension
1438scripts. When looking for extensions specified by the <code>perl</code> resource, 1490scripts. When looking for extensions specified by the <code>perl</code> resource,
1439rxvt will first look in these directories and then in 1491rxvt will first look in these directories and then in
1440<em>/opt/rxvt/lib/urxvt/perl-ext/</em>. 1492<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1493will be ignored when running setuid/setgid.
1441</dd> 1494</dd>
1442<dd> 1495<dd>
1443<p>See the <code>rxvtperl(3)</code> manpage.</p> 1496<p>See the <code>rxvtperl(3)</code> manpage.</p>
1497</dd>
1498<p></p>
1499<dt><strong><a name="item_selection_2epattern_2didx_3a_perl_2dregex"><strong>selection.pattern-<em>idx</em> </strong>&gt;: <em>perl-regex</em></a></strong><br />
1500</dt>
1501<dd>
1502Additional selection patterns, see the <code>rxvtperl(3)</code> manpage for
1503details.
1504</dd>
1505<p></p>
1506<dt><strong><a name="item_selection_2dautotransform_2eidx_3a_perl_2dtransfor"><strong>selection-autotransform.<em>idx</em> </strong>&gt;: <em>perl-transform</em></a></strong><br />
1507</dt>
1508<dd>
1509Selection auto-transform patterns, see the <code>rxvtperl(3)</code> manpage
1510for details.
1511</dd>
1512<p></p>
1513<dt><strong><a name="item_searchable_2dscrollback_3a_keysym"><strong>searchable-scrollback:</strong> <em>keysym</em></a></strong><br />
1514</dt>
1515<dd>
1516Sets the hotkey that starts the incremental scrollback buffer search
1517(default: <code>M-s</code>).
1518</dd>
1519<p></p>
1520<dt><strong><a name="item_urllauncher_3a_string"><strong>urlLauncher</strong>: <em>string</em></a></strong><br />
1521</dt>
1522<dd>
1523Specifies the program to be started with a URL argument. Used by the
1524<code>selection-popup</code> and <code>mark-urls</code> perl extensions.
1525</dd>
1526<p></p>
1527<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1528</dt>
1529<dd>
1530Sets the WM_TRANSIENT_FOR property to the given window iw.
1444</dd> 1531</dd>
1445<p></p></dl> 1532<p></p></dl>
1446<p> 1533<p>
1447</p> 1534</p>
1448<hr /> 1535<hr />

Diff Legend

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