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.39 by root, Mon Jan 9 01:36:56 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.1</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>6.3</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>
253</dd> 266</dd>
254<p></p> 267<p></p>
255<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br /> 268<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br />
256</dt> 269</dt>
257<dd> 270<dd>
258Compile font-styles: The bold font list to use when bold characters are to 271Compile <em>font-styles</em>: The bold font list to use when <strong>bold</strong> characters
259be printed. See resource <strong>boldFont</strong> for details. 272are to be printed. See resource <strong>boldFont</strong> for details.
260</dd> 273</dd>
261<p></p> 274<p></p>
262<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br /> 275<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br />
263</dt> 276</dt>
264<dd> 277<dd>
265Compile font-styles: The italic font list to use when bold characters are to 278Compile <em>font-styles</em>: The italic font list to use when <em>italic</em>
266be printed. See resource <strong>italicFont</strong> for details. 279characters are to be printed. See resource <strong>italicFont</strong> for details.
267</dd> 280</dd>
268<p></p> 281<p></p>
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 <em>font-styles</em>: The bold italic font list to use when <strong><em>bold
273be printed. See resource <strong>boldItalicFont</strong> for details. 286italic</em> </strong>&gt; characters are to be printed. See resource <strong>boldItalicFont</strong>
287for details.
288</dd>
289<p></p>
290<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br />
291</dt>
292<dd>
293Compile <em>font-styles</em>: Bold/Italic font styles imply high intensity
294foreground/background (default). See resource <strong>intensityStyles</strong> for
295details.
274</dd> 296</dd>
275<p></p> 297<p></p>
276<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br /> 298<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br />
277</dt> 299</dt>
278<dd> 300<dd>
336</dd> 358</dd>
337<p></p> 359<p></p>
338<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 360<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
339</dt> 361</dt>
340<dd> 362<dd>
341Display normal (non XTerm/NeXT) scrollbar without/with a trough; 363Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
342resource <strong>scrollBar_floating</strong>. 364resource <strong>scrollBar_floating</strong>.
343</dd> 365</dd>
344<p></p> 366<p></p>
345<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 367<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
346</dt> 368</dt>
391</dt> 413</dt>
392<dd> 414<dd>
393Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e. 415Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e.
394if honoured by the WM, the rxvt-unicode window will not have window 416if honoured by the WM, the rxvt-unicode window will not have window
395decorations; resource <strong>borderLess</strong>. 417decorations; resource <strong>borderLess</strong>.
418</dd>
419<p></p>
420<dt><strong><a name="item__2dsbg"><strong>-sbg</strong></a></strong><br />
421</dt>
422<dd>
423Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
424drawing characters and just rely on what the specified fonts provide. Use
425this if you have a good font and want to use its block graphic glyphs;
426resource <strong>skipBuiltinGlyphs</strong>.
396</dd> 427</dd>
397<p></p> 428<p></p>
398<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br /> 429<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br />
399</dt> 430</dt>
400<dd> 431<dd>
421given on the command line. If this option is used, it must be the last 452given 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 453on 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, 454run the program specified by the <strong>SHELL</strong> environment variable or,
424failing that, <em>sh(1)</em>. 455failing that, <em>sh(1)</em>.
425</dd> 456</dd>
457<dd>
458<p>Please note that you must specify a program with arguments. If you want to
459run shell commands, you have to specify the shell, like this:</p>
460</dd>
461<dd>
462<pre>
463 rxvt -e sh -c &quot;shell commands&quot;</pre>
464</dd>
426<p></p> 465<p></p>
427<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 466<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
428</dt> 467</dt>
429<dd> 468<dd>
430Window title (<strong>-T</strong> still respected); the default title is the basename 469Window title (<strong>-T</strong> still respected); the default title is the basename
511<dd> 550<dd>
512Turn on/off secondary screen scroll (default enabled); resource 551Turn on/off secondary screen scroll (default enabled); resource
513<strong>secondaryScroll</strong>. 552<strong>secondaryScroll</strong>.
514</dd> 553</dd>
515<p></p> 554<p></p>
555<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
556</dt>
557<dd>
558Turn on/off hold window after exit support. If enabled, rxvt
559will not immediately destroy its window when the program executed within
560it exits. Instead, it will wait till it is being killed or closed by the
561user; resource <strong>hold</strong>.
562</dd>
563<p></p>
516<dt><strong><a name="item__2dkeysym_2esym_3a_string"><strong>-keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 564<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
517</dt> 565</dt>
518<dd> 566<dd>
519Remap a key symbol. See resource <strong>keysym</strong>. 567Remap a key symbol. See resource <strong>keysym</strong>.
520</dd> 568</dd>
521<p></p> 569<p></p>
522<dt><strong><a name="item__2dembed_3a_windowid"><strong>-embed</strong>: <em>windowid</em></a></strong><br /> 570<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
523</dt> 571</dt>
524<dd> 572<dd>
525Tells rxvt to embed it's windows into an already-existing window, 573Tells rxvt to embed it's windows into an already-existing window,
526which enables applications to easily embed a terminal. 574which enables applications to easily embed a terminal.
527</dd> 575</dd>
528<dd> 576<dd>
529<p>Right now, rxvt will first unmap/map the specified window, so it 577<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 578shouldn'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 579quite 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> 580create an extra subwindow for rxvt and leave it alone.</p>
581</dd>
582<dd>
583<p>The window will not be destroyed when rxvt exits.</p>
533</dd> 584</dd>
534<dd> 585<dd>
535<p>It might be useful to know that rxvt will not close file 586<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 587descriptors passed to it (except for stdin/out/err, of course), so you
537can use file descriptors to communicate with the programs within the 588can use file descriptors to communicate with the programs within the
538terminal. This works regardless of wether the <code>-embed</code> option was used or 589terminal. This works regardless of wether the <code>-embed</code> option was used or
539not.</p> 590not.</p>
591</dd>
592<dd>
593<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
594used (a longer example is in <em>doc/embed</em>):</p>
595</dd>
596<dd>
597<pre>
598 my $rxvt = new Gtk2::Socket;
599 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
600 my $xid = $_[0]-&gt;window-&gt;get_xid;
601 system &quot;rxvt -embed $xid &amp;&quot;;
602 });</pre>
603</dd>
604<p></p>
605<dt><strong><a name="item__2dpty_2dfd_file_descriptor"><strong>-pty-fd</strong> <em>file descriptor</em></a></strong><br />
606</dt>
607<dd>
608Tells rxvt NOT to execute any commands or create a new pty/tty
609pair but instead use the given filehandle as the tty master. This is
610useful if you want to drive rxvt as a generic terminal emulator
611without having to run a program within it.
612</dd>
613<dd>
614<p>If this switch is given, rxvt will not create any utmp/wtmp
615entries and will not tinker with pty/tty permissions - you have to do that
616yourself if you want that.</p>
617</dd>
618<dd>
619<p>As an extremely special case, specifying <code>-1</code> will completely suppress
620pty/tty operations.</p>
621</dd>
622<dd>
623<p>Here is a example in perl that illustrates how this option can be used (a
624longer example is in <em>doc/pty-fd</em>):</p>
625</dd>
626<dd>
627<pre>
628 use IO::Pty;
629 use Fcntl;</pre>
630</dd>
631<dd>
632<pre>
633 my $pty = new IO::Pty;
634 fcntl $pty, F_SETFD, 0; # clear close-on-exec
635 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
636 close $pty;</pre>
637</dd>
638<dd>
639<pre>
640 # now communicate with rxvt
641 my $slave = $pty-&gt;slave;
642 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
643</dd>
644<p></p>
645<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br />
646</dt>
647<dd>
648Comma-separated list of perl extension scripts to use (or not to use) in
649this terminal instance. See resource <strong>perl-ext</strong> for details.
540</dd> 650</dd>
541<p></p></dl> 651<p></p></dl>
542<p> 652<p>
543</p> 653</p>
544<hr /> 654<hr />
685</dd> 795</dd>
686<p></p> 796<p></p>
687<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 797<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
688</dt> 798</dt>
689<dd> 799<dd>
690Fade the text by the given percentage when focus is lost. 800Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
801</dd>
802<p></p>
803<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
804</dt>
805<dd>
806Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
807colour is black; option <strong>-fadecolor</strong>.
691</dd> 808</dd>
692<p></p> 809<p></p>
693<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 810<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
694</dt> 811</dt>
695<dd> 812<dd>
696Tint the transparent background pixmap with the given colour. 813Tint the transparent background pixmap with the given colour; option
814<strong>-tint</strong>.
697</dd> 815</dd>
698<p></p> 816<p></p>
699<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 817<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
700</dt> 818</dt>
701<dd> 819<dd>
711<p></p> 829<p></p>
712<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 830<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
713</dt> 831</dt>
714<dd> 832<dd>
715Use the specified colour for the scrollbar's trough area [default 833Use the specified colour for the scrollbar's trough area [default
716#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 834#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
717</dd> 835</dd>
718<p></p> 836<p></p>
719<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 837<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
720</dt> 838</dt>
721<dd> 839<dd>
758<dd> 876<dd>
759Select the fonts to be used. This is a comma separated list of font 877Select the fonts to be used. This is a comma separated list of font
760names that are used in turn when trying to display Unicode characters. 878names that are used in turn when trying to display Unicode characters.
761The first font defines the cell size for characters; other fonts might 879The first font defines the cell size for characters; other fonts might
762be smaller, but not larger. A reasonable default font list is always 880be smaller, but not larger. A reasonable default font list is always
763appended to it. option <strong>-fn</strong>. 881appended to it; option <strong>-fn</strong>.
764</dd> 882</dd>
765<dd> 883<dd>
766<p>Each font can either be a standard X11 core font (XLFD) name, with 884<p>Each font can either be a standard X11 core font (XLFD) name, with
767optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p> 885optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
768</dd> 886</dd>
829<dd> 947<dd>
830<p>If set, but empty, then this specific style is disabled and the normal 948<p>If set, but empty, then this specific style is disabled and the normal
831text font will being used for the given style.</p> 949text font will being used for the given style.</p>
832</dd> 950</dd>
833<p></p> 951<p></p>
952<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
953</dt>
954<dd>
955When font styles are not enabled, or this option is enabled (<strong>True</strong>,
956option <strong>-is</strong>, the default), bold and italic font styles imply high
957intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
958option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
959reachable.
960</dd>
961<p></p>
834<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 962<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
835</dt> 963</dt>
836<dd> 964<dd>
837Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 965Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is
838xterm style with 2.20 old word selection, or anything else which gives 966xterm style with 2.20 old word selection, or anything else which gives
841<p></p> 969<p></p>
842<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 970<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
843</dt> 971</dt>
844<dd> 972<dd>
845Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 973Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
846the author's favourite.. 974the author's favourite.
847</dd> 975</dd>
848<p></p> 976<p></p>
849<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 977<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
850</dt> 978</dt>
851<dd> 979<dd>
897<dd> 1025<dd>
898Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 1026Specify 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 1027<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. 1028<strong>Shift-Print</strong> to include the scrollback as well.
901</dd> 1029</dd>
1030<dd>
1031<p>The string will be interpreted as if typed into the shell as-is.</p>
1032</dd>
1033<dd>
1034<p>Example:</p>
1035</dd>
1036<dd>
1037<pre>
1038 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1039</dd>
1040<dd>
1041<p>This creates a new file in your home directory with the screen contents
1042everytime you hit <code>Print</code>.</p>
1043</dd>
902<p></p> 1044<p></p>
903<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 1045<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
904</dt> 1046</dt>
905<dd> 1047<dd>
906<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 1048<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
938<p></p> 1080<p></p>
939<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1081<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
940</dt> 1082</dt>
941<dd> 1083<dd>
942<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1084<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 1085<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>. 1086with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
945</dd> 1087</dd>
946<p></p> 1088<p></p>
947<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1089<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
948</dt> 1090</dt>
949<dd> 1091<dd>
979<dd> 1121<dd>
980Set MWM hints to request a borderless window, i.e. if honoured by the 1122Set MWM hints to request a borderless window, i.e. if honoured by the
981WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>. 1123WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
982</dd> 1124</dd>
983<p></p> 1125<p></p>
1126<dt><strong><a name="item_skipbuiltinglyphs_3a_boolean"><strong>skipBuiltinGlyphs:</strong> <em>boolean</em></a></strong><br />
1127</dt>
1128<dd>
1129Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
1130drawing characters and just rely on what the specified fonts provide. Use
1131this if you have a good font and want to use its block graphic glyphs;
1132option <strong>-sbg</strong>.
1133</dd>
1134<p></p>
984<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br /> 1135<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
985</dt> 1136</dt>
986<dd> 1137<dd>
987Specifies the terminal type name to be set in the <strong>TERM</strong> environment 1138Specifies the terminal type name to be set in the <strong>TERM</strong> environment
988variable; option <strong>-tn</strong>. 1139variable; option <strong>-tn</strong>.
1044</dd> 1195</dd>
1045<p></p> 1196<p></p>
1046<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1197<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1047</dt> 1198</dt>
1048<dd> 1199<dd>
1049Specifies number of seconds before blanking the pointer [default 2]. 1200Specifies number of seconds before blanking the pointer [default 2]. Use a
1201large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1050</dd> 1202</dd>
1051<p></p> 1203<p></p>
1052<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1204<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1053</dt> 1205</dt>
1054<dd> 1206<dd>
1092</dt> 1244</dt>
1093<dd> 1245<dd>
1094The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g. 1246The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1095<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the 1247<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1096input extension to be able to input japanese characters while staying in 1248input extension to be able to input japanese characters while staying in
1097another locale. option <strong>-imlocale</strong>. 1249another locale; option <strong>-imlocale</strong>.
1098</dd> 1250</dd>
1099<p></p> 1251<p></p>
1100<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br /> 1252<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1101</dt> 1253</dt>
1102<dd> 1254<dd>
1111<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br /> 1263<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1112</dt> 1264</dt>
1113<dd> 1265<dd>
1114Change the meaning of triple-click selection with the left mouse 1266Change the meaning of triple-click selection with the left mouse
1115button. Instead of selecting a full line it will extend the selection to 1267button. Instead of selecting a full line it will extend the selection to
1116the end of the logical line only. option <strong>-tcw</strong>. 1268the end of the logical line only; option <strong>-tcw</strong>.
1117</dd> 1269</dd>
1118<p></p> 1270<p></p>
1119<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1271<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1120</dt> 1272</dt>
1121<dd> 1273<dd>
1122Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1274Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1123echo arbitrary strings like the icon name or the locale. This could be 1275echo arbitrary strings like the icon name or the locale. This could be
1124abused if somebody gets 8-bit-clean access to your display, whether 1276abused if somebody gets 8-bit-clean access to your display, whether
1125throuh a mail client displaying mail bodies unfiltered or though 1277through a mail client displaying mail bodies unfiltered or through
1126write(1). Therefore, these sequences are disabled by default. (Note 1278<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1127that other terminals, including xterm, have these sequences 1279default. (Note that many other terminals, including xterm, have these
1128enabled by default). You can enable them by setting this boolean 1280sequences enabled by default, which doesn't make it safer, though).
1129resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1281</dd>
1130enabled display-answer, locale, findfont, icon label and window title 1282<dd>
1131requests as well as dynamic menubar dispatch. 1283<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,
1285locale, findfont, icon label and window title requests as well as dynamic
1286menubar dispatch.</p>
1132</dd> 1287</dd>
1133<p></p> 1288<p></p>
1134<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1289<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1135</dt> 1290</dt>
1136<dd> 1291<dd>
1158<dd> 1313<dd>
1159Turn on/off secondary screen scroll (default enabled). If the this 1314Turn on/off secondary screen scroll (default enabled). If the this
1160option is enabled, scrolls on the secondary screen will change the 1315option is enabled, scrolls on the secondary screen will change the
1161scrollback buffer and switching to/from the secondary screen will 1316scrollback buffer and switching to/from the secondary screen will
1162instead scroll the screen up. 1317instead scroll the screen up.
1318</dd>
1319<p></p>
1320<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1321</dt>
1322<dd>
1323Turn on/off hold window after exit support. If enabled, rxvt
1324will not immediately destroy its window when the program executed within
1325it exits. Instead, it will wait till it is being killed or closed by the
1326user.
1163</dd> 1327</dd>
1164<p></p> 1328<p></p>
1165<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1329<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1166</dt> 1330</dt>
1167<dd> 1331<dd>
1231<dd> 1395<dd>
1232<pre> 1396<pre>
1233 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1397 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1234</dd> 1398</dd>
1235<dd> 1399<dd>
1400<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1401is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1402manpage. For example, the <em>selection</em> extension (activated via
1403<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1404</dd>
1405<dd>
1406<pre>
1407 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1408</dd>
1409<dd>
1410<p>Due the the large number of modifier combinations, a defined key mapping
1411will match if at <em>at least</em> the specified identifiers are being set, and
1412no other key mappings with those and more bits are being defined. That
1413means that defining a key map for <code>a</code> will automatically provide
1414definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1415mappings themselves.</p>
1416</dd>
1417<dd>
1418<p>Unfortunately, this will override built-in key mappings. For example
1419if you overwrite the <code>Insert</code> key you will disable rxvt's
1420<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1421user-defined keymap using the <code>builtin:</code> replacement:</p>
1422</dd>
1423<dd>
1424<pre>
1425 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1426 URxvt.keysym.S-Insert: builtin:</pre>
1427</dd>
1428<dd>
1429<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1430of modifiers. The second line re-establishes the default mapping for
1431<code>Shift-Insert</code>.</p>
1432</dd>
1433<dd>
1236<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1434<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 1435the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1238font-switching at runtime:</p> 1436font-switching at runtime:</p>
1239</dd> 1437</dd>
1240<dd> 1438<dd>
1248</dd> 1446</dd>
1249<dd> 1447<dd>
1250<pre> 1448<pre>
1251 URxvt.keysym.M-C-3: command:\033[8;25;80t 1449 URxvt.keysym.M-C-3: command:\033[8;25;80t
1252 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre> 1450 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1451</dd>
1452<p></p>
1453<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1454</dt>
1455<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1456</dt>
1457<dd>
1458Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1459use in this terminal instance; option <strong>-pe</strong>.
1460</dd>
1461<dd>
1462<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1463it. This can be useful to selectively disable some extensions loaded
1464by default, or specified via the <code>perl-ext-common</code> resource. For
1465example, <code>default,-selection</code> will use all the default extension except
1466<code>selection</code>.</p>
1467</dd>
1468<dd>
1469<p>Each extension is looked up in the library directories, loaded if
1470necessary, and bound to the current terminal instance.</p>
1471</dd>
1472<dd>
1473<p>If both of these resources are the empty string, then the perl
1474interpreter will not be initialized. The idea behind two options is that
1475<strong>perl-ext-common</strong> will be used for extensions that should be available to
1476all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1477</dd>
1478<p></p>
1479<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1480</dt>
1481<dd>
1482Perl code to be evaluated when all extensions have been registered. See
1483the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1484will be ignored when running setuid/setgid.
1485</dd>
1486<p></p>
1487<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1488</dt>
1489<dd>
1490Colon-separated list of additional directories that hold extension
1491scripts. When looking for extensions specified by the <code>perl</code> resource,
1492rxvt will first look in these directories and then in
1493<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1494will be ignored when running setuid/setgid.
1495</dd>
1496<dd>
1497<p>See the <code>rxvtperl(3)</code> manpage.</p>
1498</dd>
1499<p></p>
1500<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1501</dt>
1502<dd>
1503Sets the WM_TRANSIENT_FOR property to the given window iw.
1253</dd> 1504</dd>
1254<p></p></dl> 1505<p></p></dl>
1255<p> 1506<p>
1256</p> 1507</p>
1257<hr /> 1508<hr />
1293(which can span multiple screen lines), unless modified by resource 1544(which can span multiple screen lines), unless modified by resource
1294<strong>tripleclickwords</strong>. 1545<strong>tripleclickwords</strong>.
1295</dd> 1546</dd>
1296<dd> 1547<dd>
1297<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1548<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1298(Compile: <em>frills</em>) will create a rectangular selection instead of a normal 1549(Compile: <em>frills</em>) will create a rectangular selection instead of a
1299one.</p> 1550normal one. In this mode, every selected row becomes its own line in the
1551selection, and trailing whitespace is visually underlined and removed from
1552the selection.</p>
1300</dd> 1553</dd>
1301<p></p> 1554<p></p>
1302<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1555<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1303</dt> 1556</dt>
1304<dd> 1557<dd>
1314<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1567<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1315supported in rxvt-unicode. Bug me if you need this.</p> 1568supported in rxvt-unicode. Bug me if you need this.</p>
1316<p>You can, however, switch fonts at runtime using escape sequences (and 1569<p>You can, however, switch fonts at runtime using escape sequences (and
1317therefore using the menubar), e.g.:</p> 1570therefore using the menubar), e.g.:</p>
1318<pre> 1571<pre>
1319 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1572 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1320<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1573<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1321<p> 1574<p>
1322</p> 1575</p>
1323<hr /> 1576<hr />
1324<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1577<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
1505<dd> 1758<dd>
1506The unix domain socket path used by <code>rxvtc(1)</code> and 1759The unix domain socket path used by <code>rxvtc(1)</code> and
1507rxvtd(1). 1760rxvtd(1).
1508</dd> 1761</dd>
1509<dd> 1762<dd>
1510<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p> 1763<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1511</dd> 1764</dd>
1512<p></p> 1765<p></p>
1513<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br /> 1766<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1514</dt> 1767</dt>
1515<dd> 1768<dd>
1544<p></p></dl> 1797<p></p></dl>
1545<p> 1798<p>
1546</p> 1799</p>
1547<hr /> 1800<hr />
1548<h1><a name="see_also">SEE ALSO</a></h1> 1801<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> 1802<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>
1551</p>
1552<hr />
1553<h1><a name="bugs">BUGS</a></h1>
1554<p>Check the BUGS file for an up-to-date list.</p>
1555<p>Cursor change support is not yet implemented.</p>
1556<p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1557<p> 1803<p>
1558</p> 1804</p>
1559<hr /> 1805<hr />
1560<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1806<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1561<dl> 1807<dl>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines