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.20 by root, Sun Apr 17 22:36:13 2005 UTC vs.
Revision 1.27 by root, Thu Dec 22 16:44:10 2005 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.3</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>6.0</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>
… …
150</dt> 149</dt>
151<dd> 150<dd>
152Turn on/off jump scrolling; resource <strong>jumpScroll</strong>. 151Turn on/off jump scrolling; resource <strong>jumpScroll</strong>.
153</dd> 152</dd>
154<p></p> 153<p></p>
155<dt><strong><a name="item__2dip_7c_2bip"><strong>-ip</strong>|<strong>+ip</strong></a></strong><br /> 154<dt><strong><a name="item__2dip_7c_2bip__7c__2dtr_7c_2btr"><strong>-ip</strong>|<strong>+ip</strong> | <strong>-tr</strong>|<strong>+tr</strong></a></strong><br />
156</dt> 155</dt>
157<dd> 156<dd>
158Turn on/off inheriting parent window's pixmap. Alternative form is 157Turn on/off inheriting parent window's pixmap. Alternative form is
159<strong>-tr</strong>; resource <strong>inheritPixmap</strong>. 158<strong>-tr</strong>; resource <strong>inheritPixmap</strong>.
160</dd> 159</dd>
161<p></p> 160<p></p>
162<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br /> 161<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br />
163</dt> 162</dt>
164<dd> 163<dd>
165Fade the text by the given percentage when focus is lost. resource <strong>fading</strong>. 164Fade the text by the given percentage when focus is lost. Small values
165fade a little only, 100 completely replaces all colours by the fade
166colour; resource <strong>fading</strong>.
167</dd>
168<p></p>
169<dt><strong><a name="item__2dfadecolor_colour"><strong>-fadecolor</strong> <em>colour</em></a></strong><br />
170</dt>
171<dd>
172Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour
173is black. resource <strong>fadeColor</strong>.
166</dd> 174</dd>
167<p></p> 175<p></p>
168<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br /> 176<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br />
169</dt> 177</dt>
170<dd> 178<dd>
171Tint the transparent background pixmap with the given colour when 179Tint the transparent background pixmap with the given colour when
172transparency is enabled with <strong>-tr</strong> or <strong>-ip</strong>. See also the <strong>-sh</strong> 180transparency is enabled with <strong>-tr</strong> or <strong>-ip</strong>. This only works for
173option that can be used to brighten or darken the image in addition to 181non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be
174tinting it. 182used to brighten or darken the image in addition to tinting it; resource
183<em>tintColor</em>. Example:
184</dd>
185<dd>
186<pre>
187 rxvt -tr -tint blue -sh 40</pre>
175</dd> 188</dd>
176<p></p> 189<p></p>
177<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br /> 190<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br />
178</dt> 191</dt>
179<dd> 192<dd>
… …
336</dd> 349</dd>
337<p></p> 350<p></p>
338<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 351<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
339</dt> 352</dt>
340<dd> 353<dd>
341Display normal (non XTerm/NeXT) scrollbar without/with a trough; 354Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
342resource <strong>scrollBar_floating</strong>. 355resource <strong>scrollBar_floating</strong>.
343</dd> 356</dd>
344<p></p> 357<p></p>
345<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 358<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
346</dt> 359</dt>
… …
421given on the command line. If this option is used, it must be the last 434given on the command line. If this option is used, it must be the last
422on the command-line. If there is no <strong>-e</strong> option then the default is to 435on the command-line. If there is no <strong>-e</strong> option then the default is to
423run the program specified by the <strong>SHELL</strong> environment variable or, 436run the program specified by the <strong>SHELL</strong> environment variable or,
424failing that, <em>sh(1)</em>. 437failing that, <em>sh(1)</em>.
425</dd> 438</dd>
439<dd>
440<p>Please note that you must specify a program with arguments. If you want to
441run shell commands, you have to specify the shell, like this:</p>
442</dd>
443<dd>
444<pre>
445 rxvt -e sh -c &quot;shell commands&quot;</pre>
446</dd>
426<p></p> 447<p></p>
427<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 448<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
428</dt> 449</dt>
429<dd> 450<dd>
430Window title (<strong>-T</strong> still respected); the default title is the basename 451Window title (<strong>-T</strong> still respected); the default title is the basename
… …
509<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br /> 530<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br />
510</dt> 531</dt>
511<dd> 532<dd>
512Turn on/off secondary screen scroll (default enabled); resource 533Turn on/off secondary screen scroll (default enabled); resource
513<strong>secondaryScroll</strong>. 534<strong>secondaryScroll</strong>.
535</dd>
536<p></p>
537<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
538</dt>
539<dd>
540Turn on/off hold window after exit support. If enabled, rxvt
541will not immediately destroy its window when the program executed within
542it exits. Instead, it will wait till it is being killed or closed by the
543user; resource <strong>hold</strong>.
514</dd> 544</dd>
515<p></p> 545<p></p>
516<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br /> 546<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
517</dt> 547</dt>
518<dd> 548<dd>
… …
736</dd> 766</dd>
737<p></p> 767<p></p>
738<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 768<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
739</dt> 769</dt>
740<dd> 770<dd>
741Fade the text by the given percentage when focus is lost. 771Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
772</dd>
773<p></p>
774<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
775</dt>
776<dd>
777Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
778colour is black; option <strong>-fadecolor</strong>.
742</dd> 779</dd>
743<p></p> 780<p></p>
744<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 781<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
745</dt> 782</dt>
746<dd> 783<dd>
747Tint the transparent background pixmap with the given colour. 784Tint the transparent background pixmap with the given colour; option
785<strong>-tint</strong>.
748</dd> 786</dd>
749<p></p> 787<p></p>
750<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 788<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
751</dt> 789</dt>
752<dd> 790<dd>
… …
762<p></p> 800<p></p>
763<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 801<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
764</dt> 802</dt>
765<dd> 803<dd>
766Use the specified colour for the scrollbar's trough area [default 804Use the specified colour for the scrollbar's trough area [default
767#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 805#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
768</dd> 806</dd>
769<p></p> 807<p></p>
770<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 808<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
771</dt> 809</dt>
772<dd> 810<dd>
… …
892<p></p> 930<p></p>
893<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 931<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
894</dt> 932</dt>
895<dd> 933<dd>
896Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 934Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
897the author's favourite.. 935the author's favourite.
898</dd> 936</dd>
899<p></p> 937<p></p>
900<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 938<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
901</dt> 939</dt>
902<dd> 940<dd>
… …
947</dt> 985</dt>
948<dd> 986<dd>
949Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 987Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use
950<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or 988<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or
951<strong>Shift-Print</strong> to include the scrollback as well. 989<strong>Shift-Print</strong> to include the scrollback as well.
990</dd>
991<dd>
992<p>The string will be interpreted as if typed into the shell as-is.</p>
993</dd>
994<dd>
995<p>Example:</p>
996</dd>
997<dd>
998<pre>
999 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1000</dd>
1001<dd>
1002<p>This creates a new file in your home directory with the screen contents
1003everytime you hit <code>Print</code>.</p>
952</dd> 1004</dd>
953<p></p> 1005<p></p>
954<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 1006<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
955</dt> 1007</dt>
956<dd> 1008<dd>
… …
1172</dt> 1224</dt>
1173<dd> 1225<dd>
1174Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1226Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1175echo arbitrary strings like the icon name or the locale. This could be 1227echo arbitrary strings like the icon name or the locale. This could be
1176abused if somebody gets 8-bit-clean access to your display, whether 1228abused if somebody gets 8-bit-clean access to your display, whether
1177throuh a mail client displaying mail bodies unfiltered or though 1229through a mail client displaying mail bodies unfiltered or through
1178write(1). Therefore, these sequences are disabled by default. (Note 1230<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1179that other terminals, including xterm, have these sequences 1231default. (Note that many other terminals, including xterm, have these
1180enabled by default). You can enable them by setting this boolean 1232sequences enabled by default, which doesn't make it safer, though).
1181resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1233</dd>
1182enabled display-answer, locale, findfont, icon label and window title 1234<dd>
1183requests as well as dynamic menubar dispatch. 1235<p>You can enable them by setting this boolean resource or specifying
1236<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1237locale, findfont, icon label and window title requests as well as dynamic
1238menubar dispatch.</p>
1184</dd> 1239</dd>
1185<p></p> 1240<p></p>
1186<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1241<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1187</dt> 1242</dt>
1188<dd> 1243<dd>
… …
1210<dd> 1265<dd>
1211Turn on/off secondary screen scroll (default enabled). If the this 1266Turn on/off secondary screen scroll (default enabled). If the this
1212option is enabled, scrolls on the secondary screen will change the 1267option is enabled, scrolls on the secondary screen will change the
1213scrollback buffer and switching to/from the secondary screen will 1268scrollback buffer and switching to/from the secondary screen will
1214instead scroll the screen up. 1269instead scroll the screen up.
1270</dd>
1271<p></p>
1272<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1273</dt>
1274<dd>
1275Turn on/off hold window after exit support. If enabled, rxvt
1276will not immediately destroy its window when the program executed within
1277it exits. Instead, it will wait till it is being killed or closed by the
1278user.
1215</dd> 1279</dd>
1216<p></p> 1280<p></p>
1217<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1281<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1218</dt> 1282</dt>
1219<dd> 1283<dd>
… …
1281when Control-Meta-c is being pressed'':</p> 1345when Control-Meta-c is being pressed'':</p>
1282</dd> 1346</dd>
1283<dd> 1347<dd>
1284<pre> 1348<pre>
1285 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1349 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1350</dd>
1351<dd>
1352<p>Due the the large number of modifier combinations, a defined key mapping
1353will match if at <em>at least</em> the specified identifiers are being set, and
1354no other key mappings with those and more bits are being defined. That
1355means that defining a key map for <code>a</code> will automatically provide
1356definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1357mappings themselves.</p>
1358</dd>
1359<dd>
1360<p>Unfortunately, this will override built-in key mappings. For example
1361if you overwrite the <code>Insert</code> key you will disable rxvt's
1362<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1363user-defined keymap using the <code>builtin:</code> replacement:</p>
1364</dd>
1365<dd>
1366<pre>
1367 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1368 URxvt.keysym.S-Insert: builtin:</pre>
1369</dd>
1370<dd>
1371<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1372of modifiers. The second line re-establishes the default mapping for
1373<code>Shift-Insert</code>.</p>
1286</dd> 1374</dd>
1287<dd> 1375<dd>
1288<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1376<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1289the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited 1377the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1290font-switching at runtime:</p> 1378font-switching at runtime:</p>
… …
1366<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1454<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1367supported in rxvt-unicode. Bug me if you need this.</p> 1455supported in rxvt-unicode. Bug me if you need this.</p>
1368<p>You can, however, switch fonts at runtime using escape sequences (and 1456<p>You can, however, switch fonts at runtime using escape sequences (and
1369therefore using the menubar), e.g.:</p> 1457therefore using the menubar), e.g.:</p>
1370<pre> 1458<pre>
1371 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1459 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1372<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1460<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1373<p> 1461<p>
1374</p> 1462</p>
1375<hr /> 1463<hr />
1376<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1464<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
… …
1557<dd> 1645<dd>
1558The unix domain socket path used by <code>rxvtc(1)</code> and 1646The unix domain socket path used by <code>rxvtc(1)</code> and
1559rxvtd(1). 1647rxvtd(1).
1560</dd> 1648</dd>
1561<dd> 1649<dd>
1562<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p> 1650<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1563</dd> 1651</dd>
1564<p></p> 1652<p></p>
1565<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br /> 1653<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1566</dt> 1654</dt>
1567<dd> 1655<dd>
… …
1596<p></p></dl> 1684<p></p></dl>
1597<p> 1685<p>
1598</p> 1686</p>
1599<hr /> 1687<hr />
1600<h1><a name="see_also">SEE ALSO</a></h1> 1688<h1><a name="see_also">SEE ALSO</a></h1>
1601<p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1689<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1602<p>
1603</p>
1604<hr />
1605<h1><a name="bugs">BUGS</a></h1>
1606<p>Check the BUGS file for an up-to-date list.</p>
1607<p>Cursor change support is not yet implemented.</p>
1608<p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1609<p> 1690<p>
1610</p> 1691</p>
1611<hr /> 1692<hr />
1612<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1693<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1613<dl> 1694<dl>

Diff Legend

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