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.23 by root, Thu Jul 7 19:37:46 2005 UTC vs.
Revision 1.43 by root, Thu Jan 12 05:37:34 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.6</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>7.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>
… …
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>
… …
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
… …
509<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br /> 548<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br />
510</dt> 549</dt>
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>.
553</dd>
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>.
514</dd> 562</dd>
515<p></p> 563<p></p>
516<dt><strong><a name="item__2dkeysym_2esym_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>
… …
552 my $xid = $_[0]-&gt;window-&gt;get_xid; 600 my $xid = $_[0]-&gt;window-&gt;get_xid;
553 system &quot;rxvt -embed $xid &amp;&quot;; 601 system &quot;rxvt -embed $xid &amp;&quot;;
554 });</pre> 602 });</pre>
555</dd> 603</dd>
556<p></p> 604<p></p>
557<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br /> 605<dt><strong><a name="item__2dpty_2dfd_file_descriptor"><strong>-pty-fd</strong> <em>file descriptor</em></a></strong><br />
558</dt> 606</dt>
559<dd> 607<dd>
560Tells rxvt NOT to execute any commands or create a new pty/tty 608Tells rxvt NOT to execute any commands or create a new pty/tty
561pair but instead use the given filehandle as the tty master. This is 609pair but instead use the given filehandle as the tty master. This is
562useful if you want to drive rxvt as a generic terminal emulator 610useful if you want to drive rxvt as a generic terminal emulator
… …
564</dd> 612</dd>
565<dd> 613<dd>
566<p>If this switch is given, rxvt will not create any utmp/wtmp 614<p>If this switch is given, rxvt will not create any utmp/wtmp
567entries and will not tinker with pty/tty permissions - you have to do that 615entries and will not tinker with pty/tty permissions - you have to do that
568yourself if you want that.</p> 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>
569</dd> 621</dd>
570<dd> 622<dd>
571<p>Here is a example in perl that illustrates how this option can be used (a 623<p>Here is a example in perl that illustrates how this option can be used (a
572longer example is in <em>doc/pty-fd</em>):</p> 624longer example is in <em>doc/pty-fd</em>):</p>
573</dd> 625</dd>
… …
586<dd> 638<dd>
587<pre> 639<pre>
588 # now communicate with rxvt 640 # now communicate with rxvt
589 my $slave = $pty-&gt;slave; 641 my $slave = $pty-&gt;slave;
590 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre> 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.
591</dd> 650</dd>
592<p></p></dl> 651<p></p></dl>
593<p> 652<p>
594</p> 653</p>
595<hr /> 654<hr />
596<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1> 655<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1>
597<p>Note: `rxvt --help' gives a list of all resources (long 656<p>Note: `rxvt --help' gives a list of all resources (long
598options) compiled into your version.</p> 657options) compiled into your version.</p>
599<p>There are two different methods that rxvt can use to get the 658<p>You can set and change the resources using X11 tools like <strong>xrdb</strong>. Many
600Xresource data: using the X libraries (Xrm*-functions) or internal
601Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
602<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
603resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
604settings from the <strong>~/.Xresources</strong> file when X starts. rxvt 659distribution do also load settings from the <strong>~/.Xresources</strong> file when X
605will consult the following files/resources in order, with later settings 660starts. rxvt will consult the following files/resources in order,
606overwriting earlier ones:</p> 661with later settings overwriting earlier ones:</p>
607<pre> 662<pre>
608 1. system-wide app-defaults file, either locale-dependent OR global 663 1. system-wide app-defaults file, either locale-dependent OR global
609 2. app-defaults file in $XAPPLRESDIR 664 2. app-defaults file in $XAPPLRESDIR
610 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 665 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
611 4. SCREEN_RESOURCES for the current screen 666 4. SCREEN_RESOURCES for the current screen
612 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre> 667 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
613<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
614lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
615set in XAPPLOADDIR/URxvt (compile-time defined: usually
616<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
617<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
618Note that when reading X resources, <strong>rxvt</strong> recognizes two 668<p>Note that when reading X resources, <strong>rxvt</strong> recognizes two class
619class names: <strong>XTerm</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows 669names: <strong>Rxvt</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows resources
620resources common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be 670common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be easily
621easily configured, while the class name <strong>URxvt</strong> allows resources 671configured, while the class name <strong>URxvt</strong> allows resources unique to
622unique to <strong>rxvt</strong>, notably colours and key-handling, to be 672<strong>rxvt</strong>, to be shared between different <strong>rxvt</strong>
623shared between different <strong>rxvt</strong> configurations. If no 673configurations. If no resources are specified, suitable defaults will
624resources are specified, suitable defaults will be used. Command-line 674be used. Command-line arguments can be used to override resource
625arguments can be used to override resource settings. The following 675settings. The following resources are supported (you might want to
626resources are allowed:</p> 676check the <code>rxvtperl(3)</code> manpage for additional settings by perl
677extensions not documented here):</p>
627<dl> 678<dl>
628<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br /> 679<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br />
629</dt> 680</dt>
630<dd> 681<dd>
631Create the window with the specified X window geometry [default 80x24]; 682Create the window with the specified X window geometry [default 80x24];
… …
736</dd> 787</dd>
737<p></p> 788<p></p>
738<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 789<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
739</dt> 790</dt>
740<dd> 791<dd>
741Fade the text by the given percentage when focus is lost. 792Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
793</dd>
794<p></p>
795<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
796</dt>
797<dd>
798Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
799colour is black; option <strong>-fadecolor</strong>.
742</dd> 800</dd>
743<p></p> 801<p></p>
744<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 802<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
745</dt> 803</dt>
746<dd> 804<dd>
747Tint the transparent background pixmap with the given colour. 805Tint the transparent background pixmap with the given colour; option
806<strong>-tint</strong>.
748</dd> 807</dd>
749<p></p> 808<p></p>
750<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 809<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
751</dt> 810</dt>
752<dd> 811<dd>
… …
809<dd> 868<dd>
810Select the fonts to be used. This is a comma separated list of font 869Select the fonts to be used. This is a comma separated list of font
811names that are used in turn when trying to display Unicode characters. 870names that are used in turn when trying to display Unicode characters.
812The first font defines the cell size for characters; other fonts might 871The first font defines the cell size for characters; other fonts might
813be smaller, but not larger. A reasonable default font list is always 872be smaller, but not larger. A reasonable default font list is always
814appended to it. option <strong>-fn</strong>. 873appended to it; option <strong>-fn</strong>.
815</dd> 874</dd>
816<dd> 875<dd>
817<p>Each font can either be a standard X11 core font (XLFD) name, with 876<p>Each font can either be a standard X11 core font (XLFD) name, with
818optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p> 877optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
819</dd> 878</dd>
… …
880<dd> 939<dd>
881<p>If set, but empty, then this specific style is disabled and the normal 940<p>If set, but empty, then this specific style is disabled and the normal
882text font will being used for the given style.</p> 941text font will being used for the given style.</p>
883</dd> 942</dd>
884<p></p> 943<p></p>
944<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
945</dt>
946<dd>
947When font styles are not enabled, or this option is enabled (<strong>True</strong>,
948option <strong>-is</strong>, the default), bold and italic font styles imply high
949intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
950option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
951reachable.
952</dd>
953<p></p>
885<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 954<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
886</dt> 955</dt>
887<dd> 956<dd>
888Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 957Set 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 958xterm style with 2.20 old word selection, or anything else which gives
… …
1044<dd> 1113<dd>
1045Set MWM hints to request a borderless window, i.e. if honoured by the 1114Set MWM hints to request a borderless window, i.e. if honoured by the
1046WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>. 1115WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
1047</dd> 1116</dd>
1048<p></p> 1117<p></p>
1118<dt><strong><a name="item_skipbuiltinglyphs_3a_boolean"><strong>skipBuiltinGlyphs:</strong> <em>boolean</em></a></strong><br />
1119</dt>
1120<dd>
1121Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
1122drawing characters and just rely on what the specified fonts provide. Use
1123this if you have a good font and want to use its block graphic glyphs;
1124option <strong>-sbg</strong>.
1125</dd>
1126<p></p>
1049<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br /> 1127<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
1050</dt> 1128</dt>
1051<dd> 1129<dd>
1052Specifies the terminal type name to be set in the <strong>TERM</strong> environment 1130Specifies the terminal type name to be set in the <strong>TERM</strong> environment
1053variable; option <strong>-tn</strong>. 1131variable; option <strong>-tn</strong>.
… …
1158</dt> 1236</dt>
1159<dd> 1237<dd>
1160The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g. 1238The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1161<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the 1239<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1162input extension to be able to input japanese characters while staying in 1240input extension to be able to input japanese characters while staying in
1163another locale. option <strong>-imlocale</strong>. 1241another locale; option <strong>-imlocale</strong>.
1164</dd> 1242</dd>
1165<p></p> 1243<p></p>
1166<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br /> 1244<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1167</dt> 1245</dt>
1168<dd> 1246<dd>
… …
1177<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br /> 1255<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1178</dt> 1256</dt>
1179<dd> 1257<dd>
1180Change the meaning of triple-click selection with the left mouse 1258Change the meaning of triple-click selection with the left mouse
1181button. Instead of selecting a full line it will extend the selection to 1259button. Instead of selecting a full line it will extend the selection to
1182the end of the logical line only. option <strong>-tcw</strong>. 1260the end of the logical line only; option <strong>-tcw</strong>.
1183</dd> 1261</dd>
1184<p></p> 1262<p></p>
1185<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1263<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1186</dt> 1264</dt>
1187<dd> 1265<dd>
1188Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1266Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1189echo arbitrary strings like the icon name or the locale. This could be 1267echo arbitrary strings like the icon name or the locale. This could be
1190abused if somebody gets 8-bit-clean access to your display, whether 1268abused if somebody gets 8-bit-clean access to your display, whether
1191throuh a mail client displaying mail bodies unfiltered or though 1269through a mail client displaying mail bodies unfiltered or through
1192write(1). Therefore, these sequences are disabled by default. (Note 1270<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1193that other terminals, including xterm, have these sequences 1271default. (Note that many other terminals, including xterm, have these
1194enabled by default). You can enable them by setting this boolean 1272sequences enabled by default, which doesn't make it safer, though).
1195resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1273</dd>
1196enabled display-answer, locale, findfont, icon label and window title 1274<dd>
1197requests as well as dynamic menubar dispatch. 1275<p>You can enable them by setting this boolean resource or specifying
1276<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1277locale, findfont, icon label and window title requests as well as dynamic
1278menubar dispatch.</p>
1198</dd> 1279</dd>
1199<p></p> 1280<p></p>
1200<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1281<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1201</dt> 1282</dt>
1202<dd> 1283<dd>
… …
1224<dd> 1305<dd>
1225Turn on/off secondary screen scroll (default enabled). If the this 1306Turn on/off secondary screen scroll (default enabled). If the this
1226option is enabled, scrolls on the secondary screen will change the 1307option is enabled, scrolls on the secondary screen will change the
1227scrollback buffer and switching to/from the secondary screen will 1308scrollback buffer and switching to/from the secondary screen will
1228instead scroll the screen up. 1309instead scroll the screen up.
1310</dd>
1311<p></p>
1312<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br />
1313</dt>
1314<dd>
1315Turn on/off hold window after exit support. If enabled, rxvt
1316will not immediately destroy its window when the program executed within
1317it exits. Instead, it will wait till it is being killed or closed by the
1318user.
1229</dd> 1319</dd>
1230<p></p> 1320<p></p>
1231<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1321<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1232</dt> 1322</dt>
1233<dd> 1323<dd>
… …
1260<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1350<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1261<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it 1351<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1262can start or end with whitespace.</p> 1352can start or end with whitespace.</p>
1263</dd> 1353</dd>
1264<dd> 1354<dd>
1265<p>Please note that you need to double the <code>\</code> when using 1355<p>Please note that you need to double the <code>\</code> in resource files, as
1266<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can 1356Xlib itself does it's own de-escaping (you can use <code>\033</code> instead of
1267use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and 1357<code>\e</code> (and so on), which will work with both Xt and rxvt's own
1268rxvt's own processing).</p> 1358processing).</p>
1269</dd> 1359</dd>
1270<dd> 1360<dd>
1271<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1361<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1272with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' 1362with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1273should be a character not used by the strings.</p> 1363should be a character not used by the strings.</p>
… …
1295when Control-Meta-c is being pressed'':</p> 1385when Control-Meta-c is being pressed'':</p>
1296</dd> 1386</dd>
1297<dd> 1387<dd>
1298<pre> 1388<pre>
1299 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1389 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1390</dd>
1391<dd>
1392<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1393is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1394manpage. For example, the <em>selection</em> extension (activated via
1395<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1396</dd>
1397<dd>
1398<pre>
1399 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1300</dd> 1400</dd>
1301<dd> 1401<dd>
1302<p>Due the the large number of modifier combinations, a defined key mapping 1402<p>Due the the large number of modifier combinations, a defined key mapping
1303will match if at <em>at least</em> the specified identifiers are being set, and 1403will match if at <em>at least</em> the specified identifiers are being set, and
1304no other key mappings with those and more bits are being defined. That 1404no other key mappings with those and more bits are being defined. That
… …
1338</dd> 1438</dd>
1339<dd> 1439<dd>
1340<pre> 1440<pre>
1341 URxvt.keysym.M-C-3: command:\033[8;25;80t 1441 URxvt.keysym.M-C-3: command:\033[8;25;80t
1342 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre> 1442 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1443</dd>
1444<p></p>
1445<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1446</dt>
1447<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1448</dt>
1449<dd>
1450Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1451use in this terminal instance; option <strong>-pe</strong>.
1452</dd>
1453<dd>
1454<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1455them. This can be useful to selectively disable some extensions loaded
1456by default, or specified via the <code>perl-ext-common</code> resource. For
1457example, <code>default,-selection</code> will use all the default extension except
1458<code>selection</code>.</p>
1459</dd>
1460<dd>
1461<p>Extension names can also be followed by an argument in angle brackets
1462(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for
1463searchable scorllback to Alt/Meta-s). Mentioning the same extension
1464multiple times with different arguments will pass multiple arguments to
1465the extension.</p>
1466</dd>
1467<dd>
1468<p>Each extension is looked up in the library directories, loaded if
1469necessary, and bound to the current terminal instance.</p>
1470</dd>
1471<dd>
1472<p>If both of these resources are the empty string, then the perl
1473interpreter will not be initialized. The idea behind two options is that
1474<strong>perl-ext-common</strong> will be used for extensions that should be available to
1475all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1476</dd>
1477<p></p>
1478<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1479</dt>
1480<dd>
1481Perl code to be evaluated when all extensions have been registered. See
1482the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1483will be ignored when running setuid/setgid.
1484</dd>
1485<p></p>
1486<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1487</dt>
1488<dd>
1489Colon-separated list of additional directories that hold extension
1490scripts. When looking for extensions specified by the <code>perl</code> resource,
1491rxvt will first look in these directories and then in
1492<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1493will be ignored when running setuid/setgid.
1494</dd>
1495<dd>
1496<p>See the <code>rxvtperl(3)</code> manpage.</p>
1497</dd>
1498<p></p>
1499<dt><strong><a name="item_searchable_2dscrollback_3a_keysym"><strong>searchable-scrollback:</strong> <em>keysym</em></a></strong><br />
1500</dt>
1501<dd>
1502Sets the hotkey that starts the incremental scrollback buffer search
1503(default: <code>M-s</code>).
1504</dd>
1505<p></p>
1506<dt><strong><a name="item_urllauncher_3a_string"><strong>urlLauncher</strong>: <em>string</em></a></strong><br />
1507</dt>
1508<dd>
1509Specifies the program to be started with a URL argument. Used by the
1510<code>selection-popup</code> and <code>mark-urls</code> perl extensions.
1511</dd>
1512<p></p>
1513<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1514</dt>
1515<dd>
1516Sets the WM_TRANSIENT_FOR property to the given window iw.
1343</dd> 1517</dd>
1344<p></p></dl> 1518<p></p></dl>
1345<p> 1519<p>
1346</p> 1520</p>
1347<hr /> 1521<hr />
… …
1383(which can span multiple screen lines), unless modified by resource 1557(which can span multiple screen lines), unless modified by resource
1384<strong>tripleclickwords</strong>. 1558<strong>tripleclickwords</strong>.
1385</dd> 1559</dd>
1386<dd> 1560<dd>
1387<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1561<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1388(Compile: <em>frills</em>) will create a rectangular selection instead of a normal 1562(Compile: <em>frills</em>) will create a rectangular selection instead of a
1389one.</p> 1563normal one. In this mode, every selected row becomes its own line in the
1564selection, and trailing whitespace is visually underlined and removed from
1565the selection.</p>
1390</dd> 1566</dd>
1391<p></p> 1567<p></p>
1392<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1568<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1393</dt> 1569</dt>
1394<dd> 1570<dd>
… …
1404<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1580<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1405supported in rxvt-unicode. Bug me if you need this.</p> 1581supported in rxvt-unicode. Bug me if you need this.</p>
1406<p>You can, however, switch fonts at runtime using escape sequences (and 1582<p>You can, however, switch fonts at runtime using escape sequences (and
1407therefore using the menubar), e.g.:</p> 1583therefore using the menubar), e.g.:</p>
1408<pre> 1584<pre>
1409 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1585 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1410<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1586<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1411<p> 1587<p>
1412</p> 1588</p>
1413<hr /> 1589<hr />
1414<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1590<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
… …
1638<h1><a name="see_also">SEE ALSO</a></h1> 1814<h1><a name="see_also">SEE ALSO</a></h1>
1639<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1815<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1640<p> 1816<p>
1641</p> 1817</p>
1642<hr /> 1818<hr />
1643<h1><a name="bugs">BUGS</a></h1>
1644<p>Check the BUGS file for an up-to-date list.</p>
1645<p>Cursor change support is not yet implemented.</p>
1646<p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1647<p>
1648</p>
1649<hr />
1650<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1819<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1651<dl> 1820<dl>
1652<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1821<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1653</dt> 1822</dt>
1654<dd> 1823<dd>

Diff Legend

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