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.14 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.24 by root, Tue Oct 25 20:04:58 2005 UTC

… …
47<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 47<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
48<p> 48<p>
49</p> 49</p>
50<hr /> 50<hr />
51<h1><a name="description">DESCRIPTION</a></h1> 51<h1><a name="description">DESCRIPTION</a></h1>
52<p><strong>rxvt-unicode</strong>, version <strong>5.1</strong>, is a colour vt102 terminal 52<p><strong>rxvt-unicode</strong>, version <strong>5.8</strong>, is a colour vt102 terminal
53emulator intended as an <em>xterm</em>(1) replacement for users who do not 53emulator intended as an <em>xterm</em>(1) replacement for users who do not
54require features such as Tektronix 4014 emulation and toolkit-style 54require features such as Tektronix 4014 emulation and toolkit-style
55configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- 55configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
56a significant advantage on a machine serving many X sessions.</p> 56a significant advantage on a machine serving many X sessions.</p>
57<p> 57<p>
… …
150</dt> 150</dt>
151<dd> 151<dd>
152Turn on/off jump scrolling; resource <strong>jumpScroll</strong>. 152Turn on/off jump scrolling; resource <strong>jumpScroll</strong>.
153</dd> 153</dd>
154<p></p> 154<p></p>
155<dt><strong><a name="item__2dip_7c_2bip"><strong>-ip</strong>|<strong>+ip</strong></a></strong><br /> 155<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> 156</dt>
157<dd> 157<dd>
158Turn on/off inheriting parent window's pixmap. Alternative form is 158Turn on/off inheriting parent window's pixmap. Alternative form is
159<strong>-tr</strong>; resource <strong>inheritPixmap</strong>. 159<strong>-tr</strong>; resource <strong>inheritPixmap</strong>.
160</dd> 160</dd>
161<p></p> 161<p></p>
162<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br /> 162<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br />
163</dt> 163</dt>
164<dd> 164<dd>
165Fade the text by the given percentage when focus is lost. resource <strong>fading</strong>. 165Fade the text by the given percentage when focus is lost. Small values
166fade a little only, 100 completely replaces all colours by the fade
167colour; resource <strong>fading</strong>.
168</dd>
169<p></p>
170<dt><strong><a name="item__2dfadecolor_colour"><strong>-fadecolor</strong> <em>colour</em></a></strong><br />
171</dt>
172<dd>
173Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour
174is black. resource <strong>fadeColor</strong>.
166</dd> 175</dd>
167<p></p> 176<p></p>
168<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br /> 177<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br />
169</dt> 178</dt>
170<dd> 179<dd>
171Tint the transparent background pixmap with the given colour when 180Tint 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> 181transparency 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 182non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be
174tinting it. 183used to brighten or darken the image in addition to tinting it; resource
184<em>tintColor</em>. Example:
185</dd>
186<dd>
187<pre>
188 rxvt -tr -tint blue -sh 40</pre>
175</dd> 189</dd>
176<p></p> 190<p></p>
177<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br /> 191<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br />
178</dt> 192</dt>
179<dd> 193<dd>
… …
336</dd> 350</dd>
337<p></p> 351<p></p>
338<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 352<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
339</dt> 353</dt>
340<dd> 354<dd>
341Display normal (non XTerm/NeXT) scrollbar without/with a trough; 355Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
342resource <strong>scrollBar_floating</strong>. 356resource <strong>scrollBar_floating</strong>.
343</dd> 357</dd>
344<p></p> 358<p></p>
345<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 359<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
346</dt> 360</dt>
… …
511<dd> 525<dd>
512Turn on/off secondary screen scroll (default enabled); resource 526Turn on/off secondary screen scroll (default enabled); resource
513<strong>secondaryScroll</strong>. 527<strong>secondaryScroll</strong>.
514</dd> 528</dd>
515<p></p> 529<p></p>
516<dt><strong><a name="item__2dkeysym_2esym_3a_string"><strong>-keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 530<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
517</dt> 531</dt>
518<dd> 532<dd>
519Remap a key symbol. See resource <strong>keysym</strong>. 533Remap a key symbol. See resource <strong>keysym</strong>.
520</dd> 534</dd>
521<p></p> 535<p></p>
522<dt><strong><a name="item__2dembed_3a_windowid"><strong>-embed</strong>: <em>windowid</em></a></strong><br /> 536<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
523</dt> 537</dt>
524<dd> 538<dd>
525Tells rxvt to embed it's windows into an already-existing window, 539Tells rxvt to embed it's windows into an already-existing window,
526which enables applications to easily embed a terminal. 540which enables applications to easily embed a terminal.
527</dd> 541</dd>
528<dd> 542<dd>
529<p>Right now, rxvt will first unmap/map the specified window, so it 543<p>Right now, rxvt will first unmap/map the specified window, so it
530shouldn't be a top-level window. rxvt will also reconfigure it 544shouldn't be a top-level window. rxvt will also reconfigure it
531quite a bit, so don't expect it to keep some specific state. It's best to 545quite a bit, so don't expect it to keep some specific state. It's best to
532create an extra subwindow for rxvt and leave it alone.</p> 546create an extra subwindow for rxvt and leave it alone.</p>
547</dd>
548<dd>
549<p>The window will not be destroyed when rxvt exits.</p>
533</dd> 550</dd>
534<dd> 551<dd>
535<p>It might be useful to know that rxvt will not close file 552<p>It might be useful to know that rxvt will not close file
536descriptors passed to it (except for stdin/out/err, of course), so you 553descriptors passed to it (except for stdin/out/err, of course), so you
537can use file descriptors to communicate with the programs within the 554can use file descriptors to communicate with the programs within the
538terminal. This works regardless of wether the <code>-embed</code> option was used or 555terminal. This works regardless of wether the <code>-embed</code> option was used or
539not.</p> 556not.</p>
557</dd>
558<dd>
559<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
560used (a longer example is in <em>doc/embed</em>):</p>
561</dd>
562<dd>
563<pre>
564 my $rxvt = new Gtk2::Socket;
565 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
566 my $xid = $_[0]-&gt;window-&gt;get_xid;
567 system &quot;rxvt -embed $xid &amp;&quot;;
568 });</pre>
569</dd>
570<p></p>
571<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br />
572</dt>
573<dd>
574Tells rxvt NOT to execute any commands or create a new pty/tty
575pair but instead use the given filehandle as the tty master. This is
576useful if you want to drive rxvt as a generic terminal emulator
577without having to run a program within it.
578</dd>
579<dd>
580<p>If this switch is given, rxvt will not create any utmp/wtmp
581entries and will not tinker with pty/tty permissions - you have to do that
582yourself if you want that.</p>
583</dd>
584<dd>
585<p>Here is a example in perl that illustrates how this option can be used (a
586longer example is in <em>doc/pty-fd</em>):</p>
587</dd>
588<dd>
589<pre>
590 use IO::Pty;
591 use Fcntl;</pre>
592</dd>
593<dd>
594<pre>
595 my $pty = new IO::Pty;
596 fcntl $pty, F_SETFD, 0; # clear close-on-exec
597 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
598 close $pty;</pre>
599</dd>
600<dd>
601<pre>
602 # now communicate with rxvt
603 my $slave = $pty-&gt;slave;
604 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
540</dd> 605</dd>
541<p></p></dl> 606<p></p></dl>
542<p> 607<p>
543</p> 608</p>
544<hr /> 609<hr />
… …
685</dd> 750</dd>
686<p></p> 751<p></p>
687<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 752<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
688</dt> 753</dt>
689<dd> 754<dd>
690Fade the text by the given percentage when focus is lost. 755Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
756</dd>
757<p></p>
758<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
759</dt>
760<dd>
761Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
762colour is black; option <strong>-fadecolor</strong>.
691</dd> 763</dd>
692<p></p> 764<p></p>
693<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 765<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
694</dt> 766</dt>
695<dd> 767<dd>
696Tint the transparent background pixmap with the given colour. 768Tint the transparent background pixmap with the given colour; option
769<strong>-tint</strong>.
697</dd> 770</dd>
698<p></p> 771<p></p>
699<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 772<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
700</dt> 773</dt>
701<dd> 774<dd>
… …
711<p></p> 784<p></p>
712<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 785<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
713</dt> 786</dt>
714<dd> 787<dd>
715Use the specified colour for the scrollbar's trough area [default 788Use the specified colour for the scrollbar's trough area [default
716#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 789#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
717</dd> 790</dd>
718<p></p> 791<p></p>
719<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 792<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
720</dt> 793</dt>
721<dd> 794<dd>
… …
841<p></p> 914<p></p>
842<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 915<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
843</dt> 916</dt>
844<dd> 917<dd>
845Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 918Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
846the author's favourite.. 919the author's favourite.
847</dd> 920</dd>
848<p></p> 921<p></p>
849<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 922<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
850</dt> 923</dt>
851<dd> 924<dd>
… …
897<dd> 970<dd>
898Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 971Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use
899<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or 972<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or
900<strong>Shift-Print</strong> to include the scrollback as well. 973<strong>Shift-Print</strong> to include the scrollback as well.
901</dd> 974</dd>
975<dd>
976<p>The string will be interpreted as if typed into the shell as-is.</p>
977</dd>
978<dd>
979<p>Example:</p>
980</dd>
981<dd>
982<pre>
983 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
984</dd>
985<dd>
986<p>This creates a new file in your home directory with the screen contents
987everytime you hit <code>Print</code>.</p>
988</dd>
902<p></p> 989<p></p>
903<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 990<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
904</dt> 991</dt>
905<dd> 992<dd>
906<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 993<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
… …
938<p></p> 1025<p></p>
939<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1026<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
940</dt> 1027</dt>
941<dd> 1028<dd>
942<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1029<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
943<strong>scrollTtyOutput</strong> is False); option <strong>+sw</strong>. <strong>False</strong>: do not scroll 1030<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll
944with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>. 1031with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
945</dd> 1032</dd>
946<p></p> 1033<p></p>
947<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1034<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
948</dt> 1035</dt>
949<dd> 1036<dd>
… …
1044</dd> 1131</dd>
1045<p></p> 1132<p></p>
1046<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1133<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1047</dt> 1134</dt>
1048<dd> 1135<dd>
1049Specifies number of seconds before blanking the pointer [default 2]. 1136Specifies number of seconds before blanking the pointer [default 2]. Use a
1137large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1050</dd> 1138</dd>
1051<p></p> 1139<p></p>
1052<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1140<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1053</dt> 1141</dt>
1054<dd> 1142<dd>
… …
1229when Control-Meta-c is being pressed'':</p> 1317when Control-Meta-c is being pressed'':</p>
1230</dd> 1318</dd>
1231<dd> 1319<dd>
1232<pre> 1320<pre>
1233 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1321 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1322</dd>
1323<dd>
1324<p>Due the the large number of modifier combinations, a defined key mapping
1325will match if at <em>at least</em> the specified identifiers are being set, and
1326no other key mappings with those and more bits are being defined. That
1327means that defining a key map for <code>a</code> will automatically provide
1328definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1329mappings themselves.</p>
1330</dd>
1331<dd>
1332<p>Unfortunately, this will override built-in key mappings. For example
1333if you overwrite the <code>Insert</code> key you will disable rxvt's
1334<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1335user-defined keymap using the <code>builtin:</code> replacement:</p>
1336</dd>
1337<dd>
1338<pre>
1339 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1340 URxvt.keysym.S-Insert: builtin:</pre>
1341</dd>
1342<dd>
1343<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1344of modifiers. The second line re-establishes the default mapping for
1345<code>Shift-Insert</code>.</p>
1234</dd> 1346</dd>
1235<dd> 1347<dd>
1236<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1348<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1237the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited 1349the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1238font-switching at runtime:</p> 1350font-switching at runtime:</p>
… …
1505<dd> 1617<dd>
1506The unix domain socket path used by <code>rxvtc(1)</code> and 1618The unix domain socket path used by <code>rxvtc(1)</code> and
1507rxvtd(1). 1619rxvtd(1).
1508</dd> 1620</dd>
1509<dd> 1621<dd>
1510<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p> 1622<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1511</dd> 1623</dd>
1512<p></p> 1624<p></p>
1513<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br /> 1625<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1514</dt> 1626</dt>
1515<dd> 1627<dd>
… …
1544<p></p></dl> 1656<p></p></dl>
1545<p> 1657<p>
1546</p> 1658</p>
1547<hr /> 1659<hr />
1548<h1><a name="see_also">SEE ALSO</a></h1> 1660<h1><a name="see_also">SEE ALSO</a></h1>
1549<p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1661<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1550<p> 1662<p>
1551</p> 1663</p>
1552<hr /> 1664<hr />
1553<h1><a name="bugs">BUGS</a></h1> 1665<h1><a name="bugs">BUGS</a></h1>
1554<p>Check the BUGS file for an up-to-date list.</p> 1666<p>Check the BUGS file for an up-to-date list.</p>

Diff Legend

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