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.22 by root, Sat Jun 18 11:01:41 2005 UTC vs.
Revision 1.29 by root, Mon Jan 2 15:11:05 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.5</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>
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>
269<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 />
270</dt> 283</dt>
271<dd> 284<dd>
272Compile 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
273be printed. See resource <strong>boldItalicFont</strong> for details. 286be printed. See resource <strong>boldItalicFont</strong> for details.
287</dd>
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.
274</dd> 295</dd>
275<p></p> 296<p></p>
276<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 />
277</dt> 298</dt>
278<dd> 299<dd>
421given 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
422on 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
423run the program specified by the <strong>SHELL</strong> environment variable or, 444run the program specified by the <strong>SHELL</strong> environment variable or,
424failing that, <em>sh(1)</em>. 445failing that, <em>sh(1)</em>.
425</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>
426<p></p> 455<p></p>
427<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 />
428</dt> 457</dt>
429<dd> 458<dd>
430Window 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
509<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 />
510</dt> 539</dt>
511<dd> 540<dd>
512Turn on/off secondary screen scroll (default enabled); resource 541Turn on/off secondary screen scroll (default enabled); resource
513<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>.
514</dd> 552</dd>
515<p></p> 553<p></p>
516<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 />
517</dt> 555</dt>
518<dd> 556<dd>
736</dd> 774</dd>
737<p></p> 775<p></p>
738<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 776<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
739</dt> 777</dt>
740<dd> 778<dd>
741Fade the text by the given percentage when focus is lost. 779Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
780</dd>
781<p></p>
782<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
783</dt>
784<dd>
785Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
786colour is black; option <strong>-fadecolor</strong>.
742</dd> 787</dd>
743<p></p> 788<p></p>
744<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 789<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
745</dt> 790</dt>
746<dd> 791<dd>
747Tint the transparent background pixmap with the given colour. 792Tint the transparent background pixmap with the given colour; option
793<strong>-tint</strong>.
748</dd> 794</dd>
749<p></p> 795<p></p>
750<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 796<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
751</dt> 797</dt>
752<dd> 798<dd>
880<dd> 926<dd>
881<p>If set, but empty, then this specific style is disabled and the normal 927<p>If set, but empty, then this specific style is disabled and the normal
882text font will being used for the given style.</p> 928text font will being used for the given style.</p>
883</dd> 929</dd>
884<p></p> 930<p></p>
931<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
932</dt>
933<dd>
934When font styles are not enabled, or this option is enabled (<strong>True</strong>,
935option <strong>-is</strong>, the default), bold and italic font styles imply high
936intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
937option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
938reachable.
939</dd>
940<p></p>
885<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 941<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
886</dt> 942</dt>
887<dd> 943<dd>
888Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 944Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is
889xterm style with 2.20 old word selection, or anything else which gives 945xterm style with 2.20 old word selection, or anything else which gives
947</dt> 1003</dt>
948<dd> 1004<dd>
949Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 1005Specify 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 1006<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. 1007<strong>Shift-Print</strong> to include the scrollback as well.
1008</dd>
1009<dd>
1010<p>The string will be interpreted as if typed into the shell as-is.</p>
1011</dd>
1012<dd>
1013<p>Example:</p>
1014</dd>
1015<dd>
1016<pre>
1017 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1018</dd>
1019<dd>
1020<p>This creates a new file in your home directory with the screen contents
1021everytime you hit <code>Print</code>.</p>
952</dd> 1022</dd>
953<p></p> 1023<p></p>
954<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 1024<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
955</dt> 1025</dt>
956<dd> 1026<dd>
1172</dt> 1242</dt>
1173<dd> 1243<dd>
1174Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1244Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1175echo arbitrary strings like the icon name or the locale. This could be 1245echo arbitrary strings like the icon name or the locale. This could be
1176abused if somebody gets 8-bit-clean access to your display, whether 1246abused if somebody gets 8-bit-clean access to your display, whether
1177throuh a mail client displaying mail bodies unfiltered or though 1247through a mail client displaying mail bodies unfiltered or through
1178write(1). Therefore, these sequences are disabled by default. (Note 1248<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1179that other terminals, including xterm, have these sequences 1249default. (Note that many other terminals, including xterm, have these
1180enabled by default). You can enable them by setting this boolean 1250sequences enabled by default, which doesn't make it safer, though).
1181resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1251</dd>
1182enabled display-answer, locale, findfont, icon label and window title 1252<dd>
1183requests as well as dynamic menubar dispatch. 1253<p>You can enable them by setting this boolean resource or specifying
1254<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1255locale, findfont, icon label and window title requests as well as dynamic
1256menubar dispatch.</p>
1184</dd> 1257</dd>
1185<p></p> 1258<p></p>
1186<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1259<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1187</dt> 1260</dt>
1188<dd> 1261<dd>
1210<dd> 1283<dd>
1211Turn on/off secondary screen scroll (default enabled). If the this 1284Turn on/off secondary screen scroll (default enabled). If the this
1212option is enabled, scrolls on the secondary screen will change the 1285option is enabled, scrolls on the secondary screen will change the
1213scrollback buffer and switching to/from the secondary screen will 1286scrollback buffer and switching to/from the secondary screen will
1214instead scroll the screen up. 1287instead scroll the screen up.
1288</dd>
1289<p></p>
1290<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1291</dt>
1292<dd>
1293Turn on/off hold window after exit support. If enabled, rxvt
1294will not immediately destroy its window when the program executed within
1295it exits. Instead, it will wait till it is being killed or closed by the
1296user.
1215</dd> 1297</dd>
1216<p></p> 1298<p></p>
1217<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1299<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1218</dt> 1300</dt>
1219<dd> 1301<dd>
1369(which can span multiple screen lines), unless modified by resource 1451(which can span multiple screen lines), unless modified by resource
1370<strong>tripleclickwords</strong>. 1452<strong>tripleclickwords</strong>.
1371</dd> 1453</dd>
1372<dd> 1454<dd>
1373<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1455<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1374(Compile: <em>frills</em>) will create a rectangular selection instead of a normal 1456(Compile: <em>frills</em>) will create a rectangular selection instead of a
1375one.</p> 1457normal one. In this mode, every selected row becomes its own line in the
1458selection, and trailing whitespace is visually underlined and removed from
1459the selection.</p>
1376</dd> 1460</dd>
1377<p></p> 1461<p></p>
1378<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1462<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1379</dt> 1463</dt>
1380<dd> 1464<dd>
1390<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1474<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1391supported in rxvt-unicode. Bug me if you need this.</p> 1475supported in rxvt-unicode. Bug me if you need this.</p>
1392<p>You can, however, switch fonts at runtime using escape sequences (and 1476<p>You can, however, switch fonts at runtime using escape sequences (and
1393therefore using the menubar), e.g.:</p> 1477therefore using the menubar), e.g.:</p>
1394<pre> 1478<pre>
1395 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1479 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1396<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1480<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1397<p> 1481<p>
1398</p> 1482</p>
1399<hr /> 1483<hr />
1400<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1484<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
1581<dd> 1665<dd>
1582The unix domain socket path used by <code>rxvtc(1)</code> and 1666The unix domain socket path used by <code>rxvtc(1)</code> and
1583rxvtd(1). 1667rxvtd(1).
1584</dd> 1668</dd>
1585<dd> 1669<dd>
1586<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p> 1670<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1587</dd> 1671</dd>
1588<p></p> 1672<p></p>
1589<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br /> 1673<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1590</dt> 1674</dt>
1591<dd> 1675<dd>
1620<p></p></dl> 1704<p></p></dl>
1621<p> 1705<p>
1622</p> 1706</p>
1623<hr /> 1707<hr />
1624<h1><a name="see_also">SEE ALSO</a></h1> 1708<h1><a name="see_also">SEE ALSO</a></h1>
1625<p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1709<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1626<p>
1627</p>
1628<hr />
1629<h1><a name="bugs">BUGS</a></h1>
1630<p>Check the BUGS file for an up-to-date list.</p>
1631<p>Cursor change support is not yet implemented.</p>
1632<p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1633<p> 1710<p>
1634</p> 1711</p>
1635<hr /> 1712<hr />
1636<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1713<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1637<dl> 1714<dl>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines