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.37 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.42 by root, Wed Jan 11 23:08: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>6.3</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>
… …
643</dd> 643</dd>
644<p></p> 644<p></p>
645<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 />
646</dt> 646</dt>
647<dd> 647<dd>
648Comma-separated list of perl extension scripts to use in this terminal 648Comma-separated list of perl extension scripts to use (or not to use) in
649instance. See resource <strong>perl-ext</strong>. 649this terminal instance. See resource <strong>perl-ext</strong> for details.
650</dd> 650</dd>
651<p></p></dl> 651<p></p></dl>
652<p> 652<p>
653</p> 653</p>
654<hr /> 654<hr />
655<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>
656<p>Note: `rxvt --help' gives a list of all resources (long 656<p>Note: `rxvt --help' gives a list of all resources (long
657options) compiled into your version.</p> 657options) compiled into your version.</p>
658<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
659Xresource data: using the X libraries (Xrm*-functions) or internal
660Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
661<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
662resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
663settings from the <strong>~/.Xresources</strong> file when X starts. rxvt 659distribution do also load settings from the <strong>~/.Xresources</strong> file when X
664will consult the following files/resources in order, with later settings 660starts. rxvt will consult the following files/resources in order,
665overwriting earlier ones:</p> 661with later settings overwriting earlier ones:</p>
666<pre> 662<pre>
667 1. system-wide app-defaults file, either locale-dependent OR global 663 1. system-wide app-defaults file, either locale-dependent OR global
668 2. app-defaults file in $XAPPLRESDIR 664 2. app-defaults file in $XAPPLRESDIR
669 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 665 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
670 4. SCREEN_RESOURCES for the current screen 666 4. SCREEN_RESOURCES for the current screen
671 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre> 667 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
672<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
673lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
674set in XAPPLOADDIR/URxvt (compile-time defined: usually
675<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
676<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
677Note that when reading X resources, <strong>rxvt</strong> recognizes two 668<p>Note that when reading X resources, <strong>rxvt</strong> recognizes two class
678class 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
679resources 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
680easily configured, while the class name <strong>URxvt</strong> allows resources 671configured, while the class name <strong>URxvt</strong> allows resources unique to
681unique to <strong>rxvt</strong>, notably colours and key-handling, to be 672<strong>rxvt</strong>, to be shared between different <strong>rxvt</strong>
682shared between different <strong>rxvt</strong> configurations. If no 673configurations. If no resources are specified, suitable defaults will
683resources are specified, suitable defaults will be used. Command-line 674be used. Command-line arguments can be used to override resource
684arguments can be used to override resource settings. The following 675settings. The following resources are supported (you might want to
685resources are allowed:</p> 676check the <code>rxvtperl(3)</code> manpage for additional settings by perl
677extensions not documented here):</p>
686<dl> 678<dl>
687<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 />
688</dt> 680</dt>
689<dd> 681<dd>
690Create the window with the specified X window geometry [default 80x24]; 682Create the window with the specified X window geometry [default 80x24];
… …
1358<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,
1359<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
1360can start or end with whitespace.</p> 1352can start or end with whitespace.</p>
1361</dd> 1353</dd>
1362<dd> 1354<dd>
1363<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
1364<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
1365use <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
1366rxvt's own processing).</p> 1358processing).</p>
1367</dd> 1359</dd>
1368<dd> 1360<dd>
1369<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>
1370with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' 1362with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1371should be a character not used by the strings.</p> 1363should be a character not used by the strings.</p>
… …
1453<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br /> 1445<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1454</dt> 1446</dt>
1455<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 />
1456</dt> 1448</dt>
1457<dd> 1449<dd>
1458Comma-separated <code>list(s)</code> 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>
1459instance. Each extension is looked up in the library directories, loaded 1468<p>Each extension is looked up in the library directories, loaded if
1460if necessary, and bound to the current terminal instance. If this 1469necessary, and bound to the current terminal instance.</p>
1461resource is empty or missing, then the perl interpreter will not be 1470</dd>
1462initialized. The idea behind two options is that <strong>perl-ext-common</strong> will 1471<dd>
1463be used for extensions that should be available to all instances, while 1472<p>If both of these resources are the empty string, then the perl
1464<strong>perl-ext</strong> is used for specific instances; option <strong>-pe</strong>. 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>
1465</dd> 1476</dd>
1466<p></p> 1477<p></p>
1467<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 />
1468</dt> 1479</dt>
1469<dd> 1480<dd>
1470Perl code to be evaluated when all extensions have been registered. See the 1481Perl code to be evaluated when all extensions have been registered. See
1471<code>rxvtperl(3)</code> manpage. 1482the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1483will be ignored when running setuid/setgid.
1472</dd> 1484</dd>
1473<p></p> 1485<p></p>
1474<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 />
1475</dt> 1487</dt>
1476<dd> 1488<dd>
1477Colon-separated list of additional directories that hold extension 1489Colon-separated list of additional directories that hold extension
1478scripts. When looking for extensions specified by the <code>perl</code> resource, 1490scripts. When looking for extensions specified by the <code>perl</code> resource,
1479rxvt will first look in these directories and then in 1491rxvt will first look in these directories and then in
1480<em>/opt/rxvt/lib/urxvt/perl/</em>. 1492<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1493will be ignored when running setuid/setgid.
1481</dd> 1494</dd>
1482<dd> 1495<dd>
1483<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_urllauncher_3a_string"><strong>urlLauncher</strong>: <em>string</em></a></strong><br />
1500</dt>
1501<dd>
1502Specifies the program to be started with a URL argument. Used by the
1503<code>selection-popup</code> and <code>mark-urls</code> perl extensions.
1504</dd>
1505<p></p>
1506<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1507</dt>
1508<dd>
1509Sets the WM_TRANSIENT_FOR property to the given window iw.
1484</dd> 1510</dd>
1485<p></p></dl> 1511<p></p></dl>
1486<p> 1512<p>
1487</p> 1513</p>
1488<hr /> 1514<hr />

Diff Legend

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