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.25 by root, Tue Oct 25 20:22:39 2005 UTC vs.
Revision 1.53 by root, Thu Jan 26 00:09:47 2006 UTC

46<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 46<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
47<p> 47<p>
48</p> 48</p>
49<hr /> 49<hr />
50<h1><a name="description">DESCRIPTION</a></h1> 50<h1><a name="description">DESCRIPTION</a></h1>
51<p><strong>rxvt-unicode</strong>, version <strong>5.8</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>7.3a</strong>, is a colour vt102 terminal
52emulator 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
53require features such as Tektronix 4014 emulation and toolkit-style 53require features such as Tektronix 4014 emulation and toolkit-style
54configurability. 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 --
55a significant advantage on a machine serving many X sessions.</p> 55a significant advantage on a machine serving many X sessions.</p>
56<p> 56<p>
131Attempt to open a window on the named X display (<strong>-d</strong> still 131Attempt to open a window on the named X display (<strong>-d</strong> still
132respected). In the absence of this option, the display specified by the 132respected). In the absence of this option, the display specified by the
133<strong>DISPLAY</strong> environment variable is used. 133<strong>DISPLAY</strong> environment variable is used.
134</dd> 134</dd>
135<p></p> 135<p></p>
136<dt><strong><a name="item__2ddepth_bitdepth"><strong>-depth</strong> <em>bitdepth</em></a></strong><br />
137</dt>
138<dd>
139Compile <em>frills</em>: Attempt to find a visual with the given bit depth;
140resource <strong>depth</strong>.
141</dd>
142<p></p>
136<dt><strong><a name="item__2dgeometry_geom"><strong>-geometry</strong> <em>geom</em></a></strong><br /> 143<dt><strong><a name="item__2dgeometry_geom"><strong>-geometry</strong> <em>geom</em></a></strong><br />
137</dt> 144</dt>
138<dd> 145<dd>
139Window geometry (<strong>-g</strong> still respected); resource <strong>geometry</strong>. 146Window geometry (<strong>-g</strong> still respected); resource <strong>geometry</strong>.
140</dd> 147</dd>
243<p></p> 250<p></p>
244<dt><strong><a name="item__2dfn_fontlist"><strong>-fn</strong> <em>fontlist</em></a></strong><br /> 251<dt><strong><a name="item__2dfn_fontlist"><strong>-fn</strong> <em>fontlist</em></a></strong><br />
245</dt> 252</dt>
246<dd> 253<dd>
247Select the fonts to be used. This is a comma separated list of font names 254Select the fonts to be used. This is a comma separated list of font names
248that are used in turn when trying to display Unicode characters. The 255that are checked in order when trying to find glyphs for characters. The
249first font defines the cell size for characters; other fonts might be 256first font defines the cell size for characters; other fonts might be
250smaller, but not (in general) larger. A (hopefully) reasonable default 257smaller, but not (in general) larger. A (hopefully) reasonable default
251font list is always appended to it. See resource <strong>font</strong> for more details. 258font list is always appended to it. See resource <strong>font</strong> for more details.
252</dd> 259</dd>
253<dd> 260<dd>
266</dd> 273</dd>
267<p></p> 274<p></p>
268<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br /> 275<dt><strong><a name="item__2dfb_fontlist"><strong>-fb</strong> <em>fontlist</em></a></strong><br />
269</dt> 276</dt>
270<dd> 277<dd>
271Compile font-styles: The bold font list to use when bold characters are to 278Compile <em>font-styles</em>: The bold font list to use when <strong>bold</strong> characters
272be printed. See resource <strong>boldFont</strong> for details. 279are to be printed. See resource <strong>boldFont</strong> for details.
273</dd> 280</dd>
274<p></p> 281<p></p>
275<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br /> 282<dt><strong><a name="item__2dfi_fontlist"><strong>-fi</strong> <em>fontlist</em></a></strong><br />
276</dt> 283</dt>
277<dd> 284<dd>
278Compile font-styles: The italic font list to use when bold characters are to 285Compile <em>font-styles</em>: The italic font list to use when <em>italic</em>
279be printed. See resource <strong>italicFont</strong> for details. 286characters are to be printed. See resource <strong>italicFont</strong> for details.
280</dd> 287</dd>
281<p></p> 288<p></p>
282<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br /> 289<dt><strong><a name="item__2dfbi_fontlist"><strong>-fbi</strong> <em>fontlist</em></a></strong><br />
283</dt> 290</dt>
284<dd> 291<dd>
285Compile font-styles: The bold italic font list to use when bold characters are to 292Compile <em>font-styles</em>: The bold italic font list to use when <strong><em>bold
286be printed. See resource <strong>boldItalicFont</strong> for details. 293italic</em> </strong>&gt; characters are to be printed. See resource <strong>boldItalicFont</strong>
294for details.
295</dd>
296<p></p>
297<dt><strong><a name="item__2dis_7c_2bis"><strong>-is</strong>|<strong>+is</strong></a></strong><br />
298</dt>
299<dd>
300Compile <em>font-styles</em>: Bold/Italic font styles imply high intensity
301foreground/background (default). See resource <strong>intensityStyles</strong> for
302details.
287</dd> 303</dd>
288<p></p> 304<p></p>
289<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br /> 305<dt><strong><a name="item__2dname_name"><strong>-name</strong> <em>name</em></a></strong><br />
290</dt> 306</dt>
291<dd> 307<dd>
404</dt> 420</dt>
405<dd> 421<dd>
406Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e. 422Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e.
407if honoured by the WM, the rxvt-unicode window will not have window 423if honoured by the WM, the rxvt-unicode window will not have window
408decorations; resource <strong>borderLess</strong>. 424decorations; resource <strong>borderLess</strong>.
425</dd>
426<p></p>
427<dt><strong><a name="item__2doverride_2dredirect"><strong>-override-redirect</strong></a></strong><br />
428</dt>
429<dd>
430Compile <em>frills</em>: Sets override-redirect on the window; resource
431<strong>override-redirect</strong>.
432</dd>
433<p></p>
434<dt><strong><a name="item__2dsbg"><strong>-sbg</strong></a></strong><br />
435</dt>
436<dd>
437Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
438drawing characters and just rely on what the specified fonts provide. Use
439this if you have a good font and want to use its block graphic glyphs;
440resource <strong>skipBuiltinGlyphs</strong>.
409</dd> 441</dd>
410<p></p> 442<p></p>
411<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br /> 443<dt><strong><a name="item__2dlsp_number"><strong>-lsp</strong> <em>number</em></a></strong><br />
412</dt> 444</dt>
413<dd> 445<dd>
434given on the command line. If this option is used, it must be the last 466given on the command line. If this option is used, it must be the last
435on the command-line. If there is no <strong>-e</strong> option then the default is to 467on the command-line. If there is no <strong>-e</strong> option then the default is to
436run the program specified by the <strong>SHELL</strong> environment variable or, 468run the program specified by the <strong>SHELL</strong> environment variable or,
437failing that, <em>sh(1)</em>. 469failing that, <em>sh(1)</em>.
438</dd> 470</dd>
471<dd>
472<p>Please note that you must specify a program with arguments. If you want to
473run shell commands, you have to specify the shell, like this:</p>
474</dd>
475<dd>
476<pre>
477 rxvt -e sh -c &quot;shell commands&quot;</pre>
478</dd>
439<p></p> 479<p></p>
440<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br /> 480<dt><strong><a name="item__2dtitle_text"><strong>-title</strong> <em>text</em></a></strong><br />
441</dt> 481</dt>
442<dd> 482<dd>
443Window title (<strong>-T</strong> still respected); the default title is the basename 483Window title (<strong>-T</strong> still respected); the default title is the basename
522<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br /> 562<dt><strong><a name="item__2dssr_7c_2bssr"><strong>-ssr</strong>|<strong>+ssr</strong></a></strong><br />
523</dt> 563</dt>
524<dd> 564<dd>
525Turn on/off secondary screen scroll (default enabled); resource 565Turn on/off secondary screen scroll (default enabled); resource
526<strong>secondaryScroll</strong>. 566<strong>secondaryScroll</strong>.
567</dd>
568<p></p>
569<dt><strong><a name="item__2dhold_7c_2bhold"><strong>-hold</strong>|<strong>+hold</strong></a></strong><br />
570</dt>
571<dd>
572Turn on/off hold window after exit support. If enabled, rxvt
573will not immediately destroy its window when the program executed within
574it exits. Instead, it will wait till it is being killed or closed by the
575user; resource <strong>hold</strong>.
527</dd> 576</dd>
528<p></p> 577<p></p>
529<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br /> 578<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
530</dt> 579</dt>
531<dd> 580<dd>
565 my $xid = $_[0]-&gt;window-&gt;get_xid; 614 my $xid = $_[0]-&gt;window-&gt;get_xid;
566 system &quot;rxvt -embed $xid &amp;&quot;; 615 system &quot;rxvt -embed $xid &amp;&quot;;
567 });</pre> 616 });</pre>
568</dd> 617</dd>
569<p></p> 618<p></p>
570<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br /> 619<dt><strong><a name="item__2dpty_2dfd_file_descriptor"><strong>-pty-fd</strong> <em>file descriptor</em></a></strong><br />
571</dt> 620</dt>
572<dd> 621<dd>
573Tells rxvt NOT to execute any commands or create a new pty/tty 622Tells rxvt NOT to execute any commands or create a new pty/tty
574pair but instead use the given filehandle as the tty master. This is 623pair but instead use the given filehandle as the tty master. This is
575useful if you want to drive rxvt as a generic terminal emulator 624useful if you want to drive rxvt as a generic terminal emulator
577</dd> 626</dd>
578<dd> 627<dd>
579<p>If this switch is given, rxvt will not create any utmp/wtmp 628<p>If this switch is given, rxvt will not create any utmp/wtmp
580entries and will not tinker with pty/tty permissions - you have to do that 629entries and will not tinker with pty/tty permissions - you have to do that
581yourself if you want that.</p> 630yourself if you want that.</p>
631</dd>
632<dd>
633<p>As an extremely special case, specifying <code>-1</code> will completely suppress
634pty/tty operations.</p>
582</dd> 635</dd>
583<dd> 636<dd>
584<p>Here is a example in perl that illustrates how this option can be used (a 637<p>Here is a example in perl that illustrates how this option can be used (a
585longer example is in <em>doc/pty-fd</em>):</p> 638longer example is in <em>doc/pty-fd</em>):</p>
586</dd> 639</dd>
599<dd> 652<dd>
600<pre> 653<pre>
601 # now communicate with rxvt 654 # now communicate with rxvt
602 my $slave = $pty-&gt;slave; 655 my $slave = $pty-&gt;slave;
603 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre> 656 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
657</dd>
658<p></p>
659<dt><strong><a name="item__2dpe_string"><strong>-pe</strong> <em>string</em></a></strong><br />
660</dt>
661<dd>
662Comma-separated list of perl extension scripts to use (or not to use) in
663this terminal instance. See resource <strong>perl-ext</strong> for details.
604</dd> 664</dd>
605<p></p></dl> 665<p></p></dl>
606<p> 666<p>
607</p> 667</p>
608<hr /> 668<hr />
609<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1> 669<h1><a name="resources__available_also_as_longoptions_">RESOURCES (available also as long-options)</a></h1>
610<p>Note: `rxvt --help' gives a list of all resources (long 670<p>Note: `rxvt --help' gives a list of all resources (long
611options) compiled into your version.</p> 671options) compiled into your version.</p>
612<p>There are two different methods that rxvt can use to get the 672<p>You can set and change the resources using X11 tools like <strong>xrdb</strong>. Many
613Xresource data: using the X libraries (Xrm*-functions) or internal
614Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
615<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
616resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
617settings from the <strong>~/.Xresources</strong> file when X starts. rxvt 673distribution do also load settings from the <strong>~/.Xresources</strong> file when X
618will consult the following files/resources in order, with later settings 674starts. rxvt will consult the following files/resources in order,
619overwriting earlier ones:</p> 675with later settings overwriting earlier ones:</p>
620<pre> 676<pre>
621 1. system-wide app-defaults file, either locale-dependent OR global 677 1. system-wide app-defaults file, either locale-dependent OR global
622 2. app-defaults file in $XAPPLRESDIR 678 2. app-defaults file in $XAPPLRESDIR
623 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 679 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
624 4. SCREEN_RESOURCES for the current screen 680 4. SCREEN_RESOURCES for the current screen
625 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre> 681 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
626<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
627lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
628set in XAPPLOADDIR/URxvt (compile-time defined: usually
629<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
630<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
631Note that when reading X resources, <strong>rxvt</strong> recognizes two 682<p>Note that when reading X resources, <strong>rxvt</strong> recognizes two class
632class names: <strong>XTerm</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows 683names: <strong>Rxvt</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows resources
633resources common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be 684common to both <strong>rxvt</strong> and the original <em>rxvt</em> to be easily
634easily configured, while the class name <strong>URxvt</strong> allows resources 685configured, while the class name <strong>URxvt</strong> allows resources unique to
635unique to <strong>rxvt</strong>, notably colours and key-handling, to be 686<strong>rxvt</strong>, to be shared between different <strong>rxvt</strong>
636shared between different <strong>rxvt</strong> configurations. If no 687configurations. If no resources are specified, suitable defaults will
637resources are specified, suitable defaults will be used. Command-line 688be used. Command-line arguments can be used to override resource
638arguments can be used to override resource settings. The following 689settings. The following resources are supported (you might want to
639resources are allowed:</p> 690check the <code>rxvtperl(3)</code> manpage for additional settings by perl
691extensions not documented here):</p>
640<dl> 692<dl>
693<dt><strong><a name="item_depth_3a_bitdepth"><strong>depth:</strong> <em>bitdepth</em></a></strong><br />
694</dt>
695<dd>
696Compile <em>frills</em>: Attempt to find a visual with the given bit depth;
697option <strong>-depth</strong>.
698</dd>
699<p></p>
641<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br /> 700<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br />
642</dt> 701</dt>
643<dd> 702<dd>
644Create the window with the specified X window geometry [default 80x24]; 703Create the window with the specified X window geometry [default 80x24];
645option <strong>-geometry</strong>. 704option <strong>-geometry</strong>.
807specifies an integer number of images in that direction. No image will 866specifies an integer number of images in that direction. No image will
808be magnified beyond 10 times its original size. The maximum permitted 867be magnified beyond 10 times its original size. The maximum permitted
809scale is 1000. [default 0x0+50+50] 868scale is 1000. [default 0x0+50+50]
810</dd> 869</dd>
811<p></p> 870<p></p>
812<dt><strong><a name="item_menu_3a_file_5b_3btag_5d"><strong>menu:</strong> <em>file[;tag]</em></a></strong><br />
813</dt>
814<dd>
815Read in the specified menu file (note the `.menu' extension is
816optional) and also optionally specify a starting tag to find. See the
817reference documentation for details on the syntax for the menuBar.
818</dd>
819<p></p>
820<dt><strong><a name="item_path_3a_path"><strong>path:</strong> <em>path</em></a></strong><br /> 871<dt><strong><a name="item_path_3a_path"><strong>path:</strong> <em>path</em></a></strong><br />
821</dt> 872</dt>
822<dd> 873<dd>
823Specify the colon-delimited search path for finding files (XPM and 874Specify the colon-delimited search path for finding XPM files.
824menus), in addition to the paths specified by the <strong>RXVTPATH</strong> and
825<strong>PATH</strong> environment variables.
826</dd> 875</dd>
827<p></p> 876<p></p>
828<dt><strong><a name="item_font_3a_fontlist"><strong>font:</strong> <em>fontlist</em></a></strong><br /> 877<dt><strong><a name="item_font_3a_fontlist"><strong>font:</strong> <em>fontlist</em></a></strong><br />
829</dt> 878</dt>
830<dd> 879<dd>
831Select the fonts to be used. This is a comma separated list of font 880Select the fonts to be used. This is a comma separated list of font names
832names that are used in turn when trying to display Unicode characters. 881that are checked in order when trying to find glyphs for characters. The
833The first font defines the cell size for characters; other fonts might 882first font defines the cell size for characters; other fonts might be
834be smaller, but not larger. A reasonable default font list is always 883smaller, but not (in general) larger. A (hopefully) reasonable default
835appended to it. option <strong>-fn</strong>. 884font list is always appended to it; option <strong>-fn</strong>.
836</dd> 885</dd>
837<dd> 886<dd>
838<p>Each font can either be a standard X11 core font (XLFD) name, with 887<p>Each font can either be a standard X11 core font (XLFD) name, with
839optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p> 888optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
840</dd> 889</dd>
847<dd> 896<dd>
848<p>For example, this font resource</p> 897<p>For example, this font resource</p>
849</dd> 898</dd>
850<dd> 899<dd>
851<pre> 900<pre>
852 URxvt*font: 9x15bold,\ 901 URxvt.font: 9x15bold,\
853 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 902 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
854 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 903 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
855 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 904 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
856 xft:Code2000:antialias=false</pre> 905 xft:Code2000:antialias=false</pre>
857</dd> 906</dd>
901<dd> 950<dd>
902<p>If set, but empty, then this specific style is disabled and the normal 951<p>If set, but empty, then this specific style is disabled and the normal
903text font will being used for the given style.</p> 952text font will being used for the given style.</p>
904</dd> 953</dd>
905<p></p> 954<p></p>
955<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong><br />
956</dt>
957<dd>
958When font styles are not enabled, or this option is enabled (<strong>True</strong>,
959option <strong>-is</strong>, the default), bold and italic font styles imply high
960intensity foreground/backround colours. Disabling this option (<strong>False</strong>,
961option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
962reachable.
963</dd>
964<p></p>
906<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br /> 965<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong><br />
907</dt> 966</dt>
908<dd> 967<dd>
909Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is 968Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which is
910xterm style with 2.20 old word selection, or anything else which gives 969xterm style with 2.20 old word selection, or anything else which gives
977<dd> 1036<dd>
978<p>Example:</p> 1037<p>Example:</p>
979</dd> 1038</dd>
980<dd> 1039<dd>
981<pre> 1040<pre>
982 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre> 1041 URxvt.print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
983</dd> 1042</dd>
984<dd> 1043<dd>
985<p>This creates a new file in your home directory with the screen contents 1044<p>This creates a new file in your home directory with the screen contents
986everytime you hit <code>Print</code>.</p> 1045everytime you hit <code>Print</code>.</p>
987</dd> 1046</dd>
1065<dd> 1124<dd>
1066Set MWM hints to request a borderless window, i.e. if honoured by the 1125Set MWM hints to request a borderless window, i.e. if honoured by the
1067WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>. 1126WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.
1068</dd> 1127</dd>
1069<p></p> 1128<p></p>
1129<dt><strong><a name="item_skipbuiltinglyphs_3a_boolean"><strong>skipBuiltinGlyphs:</strong> <em>boolean</em></a></strong><br />
1130</dt>
1131<dd>
1132Compile <em>frills</em>: Disable the usage of the built-in block graphics/line
1133drawing characters and just rely on what the specified fonts provide. Use
1134this if you have a good font and want to use its block graphic glyphs;
1135option <strong>-sbg</strong>.
1136</dd>
1137<p></p>
1070<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br /> 1138<dt><strong><a name="item_termname_3a_termname"><strong>termName:</strong> <em>termname</em></a></strong><br />
1071</dt> 1139</dt>
1072<dd> 1140<dd>
1073Specifies the terminal type name to be set in the <strong>TERM</strong> environment 1141Specifies the terminal type name to be set in the <strong>TERM</strong> environment
1074variable; option <strong>-tn</strong>. 1142variable; option <strong>-tn</strong>.
1154</dd> 1222</dd>
1155<p></p> 1223<p></p>
1156<dt><strong><a name="item_cutchars_3a_string"><strong>cutchars:</strong> <em>string</em></a></strong><br /> 1224<dt><strong><a name="item_cutchars_3a_string"><strong>cutchars:</strong> <em>string</em></a></strong><br />
1157</dt> 1225</dt>
1158<dd> 1226<dd>
1159The characters used as delimiters for double-click word selection. The 1227The characters used as delimiters for double-click word selection
1160built-in default: 1228(whitespace delimiting is added automatically if resource is given).
1229</dd>
1230<dd>
1231<p>When the selection extension is in use (the default if compiled in, see
1232the <code>rxvtperl(3)</code> manpage), a suitable regex using these characters
1233will be created (if the resource exists, otherwise, no regex will be
1234created). In this mode, characters outside ISO-8859-1 can be used.</p>
1235</dd>
1236<dd>
1237<p>When the selection extension is not used, only ISO-8859-1 characters can
1238be used. If not specified, the built-in default is used:</p>
1161</dd> 1239</dd>
1162<dd> 1240<dd>
1163<p><strong>BACKSLASH ```'&amp;()*,;&lt;=</strong>?@[]{|} &gt;&gt;</p> 1241<p><strong>BACKSLASH ```'&amp;()*,;&lt;=</strong>?@[]{|} &gt;&gt;</p>
1164</dd> 1242</dd>
1165<p></p> 1243<p></p>
1179</dt> 1257</dt>
1180<dd> 1258<dd>
1181The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g. 1259The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1182<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the 1260<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1183input extension to be able to input japanese characters while staying in 1261input extension to be able to input japanese characters while staying in
1184another locale. option <strong>-imlocale</strong>. 1262another locale; option <strong>-imlocale</strong>.
1185</dd> 1263</dd>
1186<p></p> 1264<p></p>
1187<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br /> 1265<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1188</dt> 1266</dt>
1189<dd> 1267<dd>
1198<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br /> 1276<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1199</dt> 1277</dt>
1200<dd> 1278<dd>
1201Change the meaning of triple-click selection with the left mouse 1279Change the meaning of triple-click selection with the left mouse
1202button. Instead of selecting a full line it will extend the selection to 1280button. Instead of selecting a full line it will extend the selection to
1203the end of the logical line only. option <strong>-tcw</strong>. 1281the end of the logical line only; option <strong>-tcw</strong>.
1204</dd> 1282</dd>
1205<p></p> 1283<p></p>
1206<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1284<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1207</dt> 1285</dt>
1208<dd> 1286<dd>
1209Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that 1287Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that
1210echo arbitrary strings like the icon name or the locale. This could be 1288echo arbitrary strings like the icon name or the locale. This could be
1211abused if somebody gets 8-bit-clean access to your display, whether 1289abused if somebody gets 8-bit-clean access to your display, whether
1212throuh a mail client displaying mail bodies unfiltered or though 1290through a mail client displaying mail bodies unfiltered or through
1213write(1). Therefore, these sequences are disabled by default. (Note 1291<code>write(1)</code> or any other means. Therefore, these sequences are disabled by
1214that other terminals, including xterm, have these sequences 1292default. (Note that many other terminals, including xterm, have these
1215enabled by default). You can enable them by setting this boolean 1293sequences enabled by default, which doesn't make it safer, though).
1216resource or specifying <strong>-insecure</strong> as an option. At the moment, this 1294</dd>
1217enabled display-answer, locale, findfont, icon label and window title 1295<dd>
1218requests as well as dynamic menubar dispatch. 1296<p>You can enable them by setting this boolean resource or specifying
1297<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
1298locale, findfont, icon label and window title requests.</p>
1219</dd> 1299</dd>
1220<p></p> 1300<p></p>
1221<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br /> 1301<dt><strong><a name="item_modifier_3a_modifier"><strong>modifier:</strong> <em>modifier</em></a></strong><br />
1222</dt> 1302</dt>
1223<dd> 1303<dd>
1232Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1312Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
1233character is passed through. It may contain escape values as described 1313character is passed through. It may contain escape values as described
1234in the entry on <strong>keysym</strong> following. 1314in the entry on <strong>keysym</strong> following.
1235</dd> 1315</dd>
1236<p></p> 1316<p></p>
1237<dt><strong><a name="item_secondaryscreen_3a_bool"><strong>secondaryScreen:</strong> <em>bool</em></a></strong><br /> 1317<dt><strong><a name="item_secondaryscreen_3a_boolean"><strong>secondaryScreen:</strong> <em>boolean</em></a></strong><br />
1238</dt> 1318</dt>
1239<dd> 1319<dd>
1240Turn on/off secondary screen (default enabled). 1320Turn on/off secondary screen (default enabled).
1241</dd> 1321</dd>
1242<p></p> 1322<p></p>
1243<dt><strong><a name="item_secondaryscroll_3a_bool"><strong>secondaryScroll:</strong> <em>bool</em></a></strong><br /> 1323<dt><strong><a name="item_secondaryscroll_3a_boolean"><strong>secondaryScroll:</strong> <em>boolean</em></a></strong><br />
1244</dt> 1324</dt>
1245<dd> 1325<dd>
1246Turn on/off secondary screen scroll (default enabled). If the this 1326Turn on/off secondary screen scroll (default enabled). If the this
1247option is enabled, scrolls on the secondary screen will change the 1327option is enabled, scrolls on the secondary screen will change the
1248scrollback buffer and switching to/from the secondary screen will 1328scrollback buffer and switching to/from the secondary screen will
1249instead scroll the screen up. 1329instead scroll the screen up.
1330</dd>
1331<p></p>
1332<dt><strong><a name="item_hold_3a_boolean"><strong>hold</strong>: <em>boolean</em></a></strong><br />
1333</dt>
1334<dd>
1335Turn on/off hold window after exit support. If enabled, rxvt
1336will not immediately destroy its window when the program executed within
1337it exits. Instead, it will wait till it is being killed or closed by the
1338user.
1250</dd> 1339</dd>
1251<p></p> 1340<p></p>
1252<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1341<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1253</dt> 1342</dt>
1254<dd> 1343<dd>
1281<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1370<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1282<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it 1371<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1283can start or end with whitespace.</p> 1372can start or end with whitespace.</p>
1284</dd> 1373</dd>
1285<dd> 1374<dd>
1286<p>Please note that you need to double the <code>\</code> when using 1375<p>Please note that you need to double the <code>\</code> in resource files, as
1287<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can 1376Xlib itself does it's own de-escaping (you can use <code>\033</code> instead of
1288use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and 1377<code>\e</code> (and so on), which will work with both Xt and rxvt's own
1289rxvt's own processing).</p> 1378processing).</p>
1290</dd> 1379</dd>
1291<dd> 1380<dd>
1292<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1381<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1293with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' 1382with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1294should be a character not used by the strings.</p> 1383should be a character not used by the strings.</p>
1316when Control-Meta-c is being pressed'':</p> 1405when Control-Meta-c is being pressed'':</p>
1317</dd> 1406</dd>
1318<dd> 1407<dd>
1319<pre> 1408<pre>
1320 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1409 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1410</dd>
1411<dd>
1412<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
1413is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
1414manpage. For example, the <em>selection</em> extension (activated via
1415<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
1416</dd>
1417<dd>
1418<pre>
1419 URxvt.keysym.M-C-c: perl:selection:rot13</pre>
1321</dd> 1420</dd>
1322<dd> 1421<dd>
1323<p>Due the the large number of modifier combinations, a defined key mapping 1422<p>Due the the large number of modifier combinations, a defined key mapping
1324will match if at <em>at least</em> the specified identifiers are being set, and 1423will match if at <em>at least</em> the specified identifiers are being set, and
1325no other key mappings with those and more bits are being defined. That 1424no other key mappings with those and more bits are being defined. That
1359</dd> 1458</dd>
1360<dd> 1459<dd>
1361<pre> 1460<pre>
1362 URxvt.keysym.M-C-3: command:\033[8;25;80t 1461 URxvt.keysym.M-C-3: command:\033[8;25;80t
1363 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre> 1462 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1463</dd>
1464<p></p>
1465<dt><strong><a name="item_perl_2dext_2dcommon_3a_string"><strong>perl-ext-common</strong>: <em>string</em></a></strong><br />
1466</dt>
1467<dt><strong><a name="item_perl_2dext_3a_string"><strong>perl-ext</strong>: <em>string</em></a></strong><br />
1468</dt>
1469<dd>
1470Comma-separated <code>list(s)</code> of perl extension scripts (default: <code>default</code>) to
1471use in this terminal instance; option <strong>-pe</strong>.
1472</dd>
1473<dd>
1474<p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
1475them. This can be useful to selectively disable some extensions loaded
1476by default, or specified via the <code>perl-ext-common</code> resource. For
1477example, <code>default,-selection</code> will use all the default extension except
1478<code>selection</code>.</p>
1479</dd>
1480<dd>
1481<p>Extension names can also be followed by an argument in angle brackets
1482(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for
1483searchable scorllback to Alt/Meta-s). Mentioning the same extension
1484multiple times with different arguments will pass multiple arguments to
1485the extension.</p>
1486</dd>
1487<dd>
1488<p>Each extension is looked up in the library directories, loaded if
1489necessary, and bound to the current terminal instance.</p>
1490</dd>
1491<dd>
1492<p>If both of these resources are the empty string, then the perl
1493interpreter will not be initialized. The idea behind two options is that
1494<strong>perl-ext-common</strong> will be used for extensions that should be available to
1495all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
1496</dd>
1497<p></p>
1498<dt><strong><a name="item_perl_2deval_3a_string"><strong>perl-eval</strong>: <em>string</em></a></strong><br />
1499</dt>
1500<dd>
1501Perl code to be evaluated when all extensions have been registered. See
1502the <code>rxvtperl(3)</code> manpage. Due to security reasons, this resource
1503will be ignored when running setuid/setgid.
1504</dd>
1505<p></p>
1506<dt><strong><a name="item_perl_2dlib_3a_path"><strong>perl-lib</strong>: <em>path</em></a></strong><br />
1507</dt>
1508<dd>
1509Colon-separated list of additional directories that hold extension
1510scripts. When looking for extensions specified by the <code>perl</code> resource,
1511rxvt will first look in these directories and then in
1512<em>/opt/rxvt/lib/urxvt/perl/</em>. Due to security reasons, this resource
1513will be ignored when running setuid/setgid.
1514</dd>
1515<dd>
1516<p>See the <code>rxvtperl(3)</code> manpage.</p>
1517</dd>
1518<p></p>
1519<dt><strong><a name="item_selection_2epattern_2didx_3a_perl_2dregex"><strong>selection.pattern-<em>idx</em> </strong>&gt;: <em>perl-regex</em></a></strong><br />
1520</dt>
1521<dd>
1522Additional selection patterns, see the <code>rxvtperl(3)</code> manpage for
1523details.
1524</dd>
1525<p></p>
1526<dt><strong><a name="item_selection_2dautotransform_2eidx_3a_perl_2dtransfor"><strong>selection-autotransform.<em>idx</em> </strong>&gt;: <em>perl-transform</em></a></strong><br />
1527</dt>
1528<dd>
1529Selection auto-transform patterns, see the <code>rxvtperl(3)</code> manpage
1530for details.
1531</dd>
1532<p></p>
1533<dt><strong><a name="item_searchable_2dscrollback_3a_keysym"><strong>searchable-scrollback:</strong> <em>keysym</em></a></strong><br />
1534</dt>
1535<dd>
1536Sets the hotkey that starts the incremental scrollback buffer search
1537(default: <code>M-s</code>).
1538</dd>
1539<p></p>
1540<dt><strong><a name="item_urllauncher_3a_string"><strong>urlLauncher</strong>: <em>string</em></a></strong><br />
1541</dt>
1542<dd>
1543Specifies the program to be started with a URL argument. Used by the
1544<code>selection-popup</code> and <code>mark-urls</code> perl extensions.
1545</dd>
1546<p></p>
1547<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1548</dt>
1549<dd>
1550Compile <em>frills</em>: Sets the WM_TRANSIENT_FOR property to the given window id.
1551</dd>
1552<p></p>
1553<dt><strong><a name="item_override_2dredirect_3a_boolean"><strong>override-redirect</strong>: <em>boolean</em></a></strong><br />
1554</dt>
1555<dd>
1556Compile <em>frills</em>: Sets override-redirect for the terminal window, making
1557it almost invisible to window managers; option <strong>-override-redirect</strong>.
1364</dd> 1558</dd>
1365<p></p></dl> 1559<p></p></dl>
1366<p> 1560<p>
1367</p> 1561</p>
1368<hr /> 1562<hr />
1404(which can span multiple screen lines), unless modified by resource 1598(which can span multiple screen lines), unless modified by resource
1405<strong>tripleclickwords</strong>. 1599<strong>tripleclickwords</strong>.
1406</dd> 1600</dd>
1407<dd> 1601<dd>
1408<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1602<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1409(Compile: <em>frills</em>) will create a rectangular selection instead of a normal 1603(Compile: <em>frills</em>) will create a rectangular selection instead of a
1410one.</p> 1604normal one. In this mode, every selected row becomes its own line in the
1605selection, and trailing whitespace is visually underlined and removed from
1606the selection.</p>
1411</dd> 1607</dd>
1412<p></p> 1608<p></p>
1413<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1609<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1414</dt> 1610</dt>
1415<dd> 1611<dd>
1416Pressing and releasing the Middle mouse button (or <strong>Shift-Insert</strong>) in 1612Pressing and releasing the Middle mouse button in an <strong>rxvt</strong>
1417an <strong>rxvt</strong> window causes the current text selection to be 1613window causes the value of the PRIMARY selection (or CLIPBOARD with the
1418inserted as if it had been typed on the keyboard. 1614Meta modifier) to be inserted as if it had been typed on the keyboard.
1615</dd>
1616<dd>
1617<p>Pressing <strong>Shift-Insert</strong> causes the value of the PRIMARY selection to be
1618inserted too.</p>
1419</dd> 1619</dd>
1420<p></p></dl> 1620<p></p></dl>
1421<p> 1621<p>
1422</p> 1622</p>
1423<hr /> 1623<hr />
1424<h1><a name="changing_fonts">CHANGING FONTS</a></h1> 1624<h1><a name="changing_fonts">CHANGING FONTS</a></h1>
1425<p>Changing fonts (or font sizes, respectively) via the keypad is not yet 1625<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
1426supported in rxvt-unicode. Bug me if you need this.</p> 1626supported in rxvt-unicode. Bug me if you need this.</p>
1427<p>You can, however, switch fonts at runtime using escape sequences (and 1627<p>You can, however, switch fonts at runtime using escape sequences, e.g.:</p>
1428therefore using the menubar), e.g.:</p>
1429<pre> 1628<pre>
1430 printf '\e]701;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre> 1629 printf '\e]710;%s\007' &quot;9x15bold,xft:Kochi Gothic&quot;</pre>
1630<p>You can use keyboard shortcuts, too:</p>
1631<pre>
1632 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1633 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007</pre>
1431<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p> 1634<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
1432<p> 1635<p>
1433</p> 1636</p>
1434<hr /> 1637<hr />
1435<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1> 1638<h1><a name="iso_14755_support">ISO 14755 SUPPORT</a></h1>
1596</dt> 1799</dt>
1597<dd> 1800<dd>
1598The shell to be used for command execution, defaults to <code>/bin/sh</code>. 1801The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1599</dd> 1802</dd>
1600<p></p> 1803<p></p>
1601<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1602</dt>
1603<dd>
1604The path where rxvt looks for support files such as menu and xpm
1605files.
1606</dd>
1607<p></p>
1608<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1609</dt>
1610<dd>
1611Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1612</dd>
1613<p></p>
1614<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br /> 1804<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1615</dt> 1805</dt>
1616<dd> 1806<dd>
1617The unix domain socket path used by <code>rxvtc(1)</code> and 1807The unix domain socket path used by <code>rxvtc(1)</code> and
1618rxvtd(1). 1808rxvtd(1).
1711</dd> 1901</dd>
1712<p></p> 1902<p></p>
1713<dt><strong><a name="item_geoff_wing__3cgcw_40pobox_2ecom_3e">Geoff Wing <em><a href="mailto:<gcw@pobox.com"><gcw@pobox.com</a></em>&gt;</a></strong><br /> 1903<dt><strong><a name="item_geoff_wing__3cgcw_40pobox_2ecom_3e">Geoff Wing <em><a href="mailto:<gcw@pobox.com"><gcw@pobox.com</a></em>&gt;</a></strong><br />
1714</dt> 1904</dt>
1715<dd> 1905<dd>
1716Rewrote screen display and text selection routines. Project Coordinator 1906Rewrote screen display and text selection routines.
1717(changes.txt 2.4.6 - rxvt-unicode) 1907
1908</dd>
1909<dd>
1910<pre>
1911
1912Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)</pre>
1718</dd> 1913</dd>
1719<p></p> 1914<p></p>
1720<dt><strong><a name="item_marc_alexander_lehmann__3crxvt_2dunicode_40schmorp">Marc Alexander Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;</a></strong><br /> 1915<dt><strong><a name="item_marc_alexander_lehmann__3crxvt_2dunicode_40schmorp">Marc Alexander Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;</a></strong><br />
1721</dt> 1916</dt>
1722<dd> 1917<dd>
1723Forked rxvt-unicode, rewrote most of the display code and internal 1918Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1724character handling to store text in unicode, improve xterm 1919extension, random hacks, numerous bugfixes and extensions.
1725compatibility and apply numerous other bugfixes and extensions.
1726</dd> 1920</dd>
1727<dd> 1921<dd>
1728<p>Project Coordinator (Changes 1.0 -)</p> 1922<p>Project Coordinator (Changes 1.0 -)</p>
1923</dd>
1924<p></p>
1925<dt><strong><a name="item_emanuele_giaquinta__3ce_2egiaquinta_40glauco_2eit_">Emanuele Giaquinta <em><a href="mailto:<e.giaquinta@glauco.it"><e.giaquinta@glauco.it</a></em>&gt;</a></strong><br />
1926</dt>
1927<dd>
1928Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1729</dd> 1929</dd>
1730<p></p></dl> 1930<p></p></dl>
1731 1931
1732</body> 1932</body>
1733 1933

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines