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.46 by root, Mon Jan 16 15:07:27 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>
… …
243<p></p> 243<p></p>
244<dt><strong><a name="item__2dfn_fontlist"><strong>-fn</strong> <em>fontlist</em></a></strong><br /> 244<dt><strong><a name="item__2dfn_fontlist"><strong>-fn</strong> <em>fontlist</em></a></strong><br />
245</dt> 245</dt>
246<dd> 246<dd>
247Select the fonts to be used. This is a comma separated list of font names 247Select the fonts to be used. This is a comma separated list of font names
248that are used in turn when trying to display Unicode characters. The 248that are checked in order when trying to find glyphs for characters. The
249first font defines the cell size for characters; other fonts might be 249first font defines the cell size for characters; other fonts might be
250smaller, but not (in general) larger. A (hopefully) reasonable default 250smaller, but not (in general) larger. A (hopefully) reasonable default
251font list is always appended to it. See resource <strong>font</strong> for more details. 251font list is always appended to it. See resource <strong>font</strong> for more details.
252</dd> 252</dd>
253<dd> 253<dd>
… …
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];
… …
853specifies an integer number of images in that direction. No image will 845specifies an integer number of images in that direction. No image will
854be magnified beyond 10 times its original size. The maximum permitted 846be magnified beyond 10 times its original size. The maximum permitted
855scale is 1000. [default 0x0+50+50] 847scale is 1000. [default 0x0+50+50]
856</dd> 848</dd>
857<p></p> 849<p></p>
858<dt><strong><a name="item_menu_3a_file_5b_3btag_5d"><strong>menu:</strong> <em>file[;tag]</em></a></strong><br />
859</dt>
860<dd>
861Read in the specified menu file (note the `.menu' extension is
862optional) and also optionally specify a starting tag to find. See the
863reference documentation for details on the syntax for the menuBar.
864</dd>
865<p></p>
866<dt><strong><a name="item_path_3a_path"><strong>path:</strong> <em>path</em></a></strong><br /> 850<dt><strong><a name="item_path_3a_path"><strong>path:</strong> <em>path</em></a></strong><br />
867</dt> 851</dt>
868<dd> 852<dd>
869Specify the colon-delimited search path for finding files (XPM and 853Specify the colon-delimited search path for finding XPM files.
870menus), in addition to the paths specified by the <strong>RXVTPATH</strong> and
871<strong>PATH</strong> environment variables.
872</dd> 854</dd>
873<p></p> 855<p></p>
874<dt><strong><a name="item_font_3a_fontlist"><strong>font:</strong> <em>fontlist</em></a></strong><br /> 856<dt><strong><a name="item_font_3a_fontlist"><strong>font:</strong> <em>fontlist</em></a></strong><br />
875</dt> 857</dt>
876<dd> 858<dd>
877Select the fonts to be used. This is a comma separated list of font 859Select the fonts to be used. This is a comma separated list of font names
878names that are used in turn when trying to display Unicode characters. 860that are checked in order when trying to find glyphs for characters. The
879The first font defines the cell size for characters; other fonts might 861first font defines the cell size for characters; other fonts might be
880be smaller, but not larger. A reasonable default font list is always 862smaller, but not (in general) larger. A (hopefully) reasonable default
881appended to it; option <strong>-fn</strong>. 863font list is always appended to it; option <strong>-fn</strong>.
882</dd> 864</dd>
883<dd> 865<dd>
884<p>Each font can either be a standard X11 core font (XLFD) name, with 866<p>Each font can either be a standard X11 core font (XLFD) name, with
885optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p> 867optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
886</dd> 868</dd>
… …
893<dd> 875<dd>
894<p>For example, this font resource</p> 876<p>For example, this font resource</p>
895</dd> 877</dd>
896<dd> 878<dd>
897<pre> 879<pre>
898 URxvt*font: 9x15bold,\ 880 URxvt.font: 9x15bold,\
899 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 881 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
900 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 882 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
901 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 883 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
902 xft:Code2000:antialias=false</pre> 884 xft:Code2000:antialias=false</pre>
903</dd> 885</dd>
… …
1033<dd> 1015<dd>
1034<p>Example:</p> 1016<p>Example:</p>
1035</dd> 1017</dd>
1036<dd> 1018<dd>
1037<pre> 1019<pre>
1038 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre> 1020 URxvt.print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1039</dd> 1021</dd>
1040<dd> 1022<dd>
1041<p>This creates a new file in your home directory with the screen contents 1023<p>This creates a new file in your home directory with the screen contents
1042everytime you hit <code>Print</code>.</p> 1024everytime you hit <code>Print</code>.</p>
1043</dd> 1025</dd>
… …
1280sequences enabled by default, which doesn't make it safer, though). 1262sequences enabled by default, which doesn't make it safer, though).
1281</dd> 1263</dd>
1282<dd> 1264<dd>
1283<p>You can enable them by setting this boolean resource or specifying 1265<p>You can enable them by setting this boolean resource or specifying
1284<strong>-insecure</strong> as an option. At the moment, this enables display-answer, 1266<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1285locale, findfont, icon label and window title requests as well as dynamic 1267locale, findfont, icon label and window title requests.</p>
1286menubar dispatch.</p>
1287</dd> 1268</dd>
1288<p></p> 1269<p></p>
1289<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1270<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1290</dt> 1271</dt>
1291<dd> 1272<dd>
… …
1358<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1339<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 1340<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1360can start or end with whitespace.</p> 1341can start or end with whitespace.</p>
1361</dd> 1342</dd>
1362<dd> 1343<dd>
1363<p>Please note that you need to double the <code>\</code> when using 1344<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 1345Xlib 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 1346<code>\e</code> (and so on), which will work with both Xt and rxvt's own
1366rxvt's own processing).</p> 1347processing).</p>
1367</dd> 1348</dd>
1368<dd> 1349<dd>
1369<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1350<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 `/' 1351with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1371should be a character not used by the strings.</p> 1352should 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 /> 1434<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1454</dt> 1435</dt>
1455<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br /> 1436<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1456</dt> 1437</dt>
1457<dd> 1438<dd>
1458Comma-separated <code>list(s)</code> of perl extension scripts to use in this terminal 1439Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1440use in this terminal instance; option <strong>-pe</strong>.
1441</dd>
1442<dd>
1443<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1444them. This can be useful to selectively disable some extensions loaded
1445by default, or specified via the <code>perl-ext-common</code> resource. For
1446example, <code>default,-selection</code> will use all the default extension except
1447<code>selection</code>.</p>
1448</dd>
1449<dd>
1450<p>Extension names can also be followed by an argument in angle brackets
1451(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for
1452searchable scorllback to Alt/Meta-s). Mentioning the same extension
1453multiple times with different arguments will pass multiple arguments to
1454the extension.</p>
1455</dd>
1456<dd>
1459instance. Each extension is looked up in the library directories, loaded 1457<p>Each extension is looked up in the library directories, loaded if
1460if necessary, and bound to the current terminal instance. If this 1458necessary, and bound to the current terminal instance.</p>
1461resource is empty or missing, then the perl interpreter will not be 1459</dd>
1462initialized. The idea behind two options is that <strong>perl-ext-common</strong> will 1460<dd>
1463be used for extensions that should be available to all instances, while 1461<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>. 1462interpreter will not be initialized. The idea behind two options is that
1463<strong>perl-ext-common</strong> will be used for extensions that should be available to
1464all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1465</dd> 1465</dd>
1466<p></p> 1466<p></p>
1467<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br /> 1467<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1468</dt> 1468</dt>
1469<dd> 1469<dd>
1470Perl code to be evaluated when all extensions have been registered. See the 1470Perl code to be evaluated when all extensions have been registered. See
1471<code>rxvtperl(3)</code> manpage. 1471the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1472will be ignored when running setuid/setgid.
1472</dd> 1473</dd>
1473<p></p> 1474<p></p>
1474<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br /> 1475<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1475</dt> 1476</dt>
1476<dd> 1477<dd>
1477Colon-separated list of additional directories that hold extension 1478Colon-separated list of additional directories that hold extension
1478scripts. When looking for extensions specified by the <code>perl</code> resource, 1479scripts. When looking for extensions specified by the <code>perl</code> resource,
1479rxvt will first look in these directories and then in 1480rxvt will first look in these directories and then in
1480<em>/opt/rxvt/lib/urxvt/perl/</em>. 1481<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1482will be ignored when running setuid/setgid.
1481</dd> 1483</dd>
1482<dd> 1484<dd>
1483<p>See the <code>rxvtperl(3)</code> manpage.</p> 1485<p>See the <code>rxvtperl(3)</code> manpage.</p>
1486</dd>
1487<p></p>
1488<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 />
1489</dt>
1490<dd>
1491Additional selection patterns, see the <code>rxvtperl(3)</code> manpage for
1492details.
1493</dd>
1494<p></p>
1495<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 />
1496</dt>
1497<dd>
1498Selection auto-transform patterns, see the <code>rxvtperl(3)</code> manpage
1499for details.
1500</dd>
1501<p></p>
1502<dt><strong><a name="item_searchable_2dscrollback_3a_keysym"><strong>searchable-scrollback:</strong> <em>keysym</em></a></strong><br />
1503</dt>
1504<dd>
1505Sets the hotkey that starts the incremental scrollback buffer search
1506(default: <code>M-s</code>).
1507</dd>
1508<p></p>
1509<dt><strong><a name="item_urllauncher_3a_string"><strong>urlLauncher</strong>: <em>string</em></a></strong><br />
1510</dt>
1511<dd>
1512Specifies the program to be started with a URL argument. Used by the
1513<code>selection-popup</code> and <code>mark-urls</code> perl extensions.
1514</dd>
1515<p></p>
1516<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1517</dt>
1518<dd>
1519Sets the WM_TRANSIENT_FOR property to the given window iw.
1484</dd> 1520</dd>
1485<p></p></dl> 1521<p></p></dl>
1486<p> 1522<p>
1487</p> 1523</p>
1488<hr /> 1524<hr />
… …
1544</p> 1580</p>
1545<hr /> 1581<hr />
1546<h1><a name="changing_fonts">CHANGING FONTS</a></h1> 1582<h1><a name="changing_fonts">CHANGING FONTS</a></h1>
1547<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1583<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1548supported in rxvt-unicode. Bug me if you need this.</p> 1584supported in rxvt-unicode. Bug me if you need this.</p>
1549<p>You can, however, switch fonts at runtime using escape sequences (and 1585<p>You can, however, switch fonts at runtime using escape sequences, e.g.:</p>
1550therefore using the menubar), e.g.:</p>
1551<pre> 1586<pre>
1552 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1587 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1588<p>You can use keyboard shortcuts, too:</p>
1589<pre>
1590 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1591 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007</pre>
1553<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1592<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1554<p> 1593<p>
1555</p> 1594</p>
1556<hr /> 1595<hr />
1557<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1596<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>

Diff Legend

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