ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.17 by root, Wed Feb 16 22:16:30 2005 UTC vs.
Revision 1.60 by root, Thu Jul 6 18:56:09 2006 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man 2.09 (Pod::Simple 3.04)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 1" 131.IX Title "rxvt 1"
132.TH rxvt 1 "2005-02-16" "5.2" "RXVT-UNICODE" 132.TH rxvt 1 "2006-07-06" "7.7" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
214.IP "\fB\-display\fR \fIdisplayname\fR" 4 214.IP "\fB\-display\fR \fIdisplayname\fR" 4
215.IX Item "-display displayname" 215.IX Item "-display displayname"
216Attempt to open a window on the named X display (\fB\-d\fR still 216Attempt to open a window on the named X display (\fB\-d\fR still
217respected). In the absence of this option, the display specified by the 217respected). In the absence of this option, the display specified by the
218\&\fB\s-1DISPLAY\s0\fR environment variable is used. 218\&\fB\s-1DISPLAY\s0\fR environment variable is used.
219.IP "\fB\-depth\fR \fIbitdepth\fR" 4
220.IX Item "-depth bitdepth"
221Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
222resource \fBdepth\fR.
219.IP "\fB\-geometry\fR \fIgeom\fR" 4 223.IP "\fB\-geometry\fR \fIgeom\fR" 4
220.IX Item "-geometry geom" 224.IX Item "-geometry geom"
221Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 225Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
222.IP "\fB\-rv\fR|\fB+rv\fR" 4 226.IP "\fB\-rv\fR|\fB+rv\fR" 4
223.IX Item "-rv|+rv" 227.IX Item "-rv|+rv"
224Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 228Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
225.IP "\fB\-j\fR|\fB+j\fR" 4 229.IP "\fB\-j\fR|\fB+j\fR" 4
226.IX Item "-j|+j" 230.IX Item "-j|+j"
227Turn on/off jump scrolling; resource \fBjumpScroll\fR. 231Turn on/off jump scrolling; resource \fBjumpScroll\fR.
228.IP "\fB\-ip\fR|\fB+ip\fR" 4 232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
229.IX Item "-ip|+ip" 233.IX Item "-ip|+ip | -tr|+tr"
230Turn on/off inheriting parent window's pixmap. Alternative form is 234Turn on/off inheriting parent window's pixmap. Alternative form is
231\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 235\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
236.Sp
237\&\fIPlease note that transparency of any kind if completely unsupported by
238the author. Don't bug him with installation questions!\fR
232.IP "\fB\-fade\fR \fInumber\fR" 4 239.IP "\fB\-fade\fR \fInumber\fR" 4
233.IX Item "-fade number" 240.IX Item "-fade number"
234Fade the text by the given percentage when focus is lost. resource \fBfading\fR. 241Fade the text by the given percentage when focus is lost. Small values
242fade a little only, 100 completely replaces all colours by the fade
243colour; resource \fBfading\fR.
244.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
245.IX Item "-fadecolor colour"
246Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
247is opaque black. resource \fBfadeColor\fR.
235.IP "\fB\-tint\fR \fIcolour\fR" 4 248.IP "\fB\-tint\fR \fIcolour\fR" 4
236.IX Item "-tint colour" 249.IX Item "-tint colour"
237Tint the transparent background pixmap with the given colour when 250Tint the transparent background pixmap with the given colour when
238transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. See also the \fB\-sh\fR 251transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for
239option that can be used to brighten or darken the image in addition to 252non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
240tinting it. 253used to brighten or darken the image in addition to tinting it; resource
254\&\fItintColor\fR. Example:
255.Sp
256.Vb 1
257\& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40
258.Ve
241.IP "\fB\-sh\fR" 4 259.IP "\fB\-sh\fR" 4
242.IX Item "-sh" 260.IX Item "-sh"
243\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 261\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
244background image in addition to tinting it (i.e. \fB\-tint\fR must be 262background image in addition to tinting it (i.e. \fB\-tint\fR must be
245specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). 263specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR).
269The colour of the border around the text area and between the scrollbar and the text; 287The colour of the border around the text area and between the scrollbar and the text;
270resource \fBborderColor\fR. 288resource \fBborderColor\fR.
271.IP "\fB\-fn\fR \fIfontlist\fR" 4 289.IP "\fB\-fn\fR \fIfontlist\fR" 4
272.IX Item "-fn fontlist" 290.IX Item "-fn fontlist"
273Select the fonts to be used. This is a comma separated list of font names 291Select the fonts to be used. This is a comma separated list of font names
274that are used in turn when trying to display Unicode characters. The 292that are checked in order when trying to find glyphs for characters. The
275first font defines the cell size for characters; other fonts might be 293first font defines the cell size for characters; other fonts might be
276smaller, but not (in general) larger. A (hopefully) reasonable default 294smaller, but not (in general) larger. A (hopefully) reasonable default
277font list is always appended to it. See resource \fBfont\fR for more details. 295font list is always appended to it. See resource \fBfont\fR for more details.
278.Sp 296.Sp
279In short, to specify an X11 core font, just specify it's name or prefix it 297In short, to specify an X11 core font, just specify it's name or prefix it
280with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, 298with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR,
281e.g.: 299e.g.:
282.Sp 300.Sp
283.Vb 2 301.Vb 2
284\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 302\& @@RXVT_NAME@@ \-fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
285\& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 303\& @@RXVT_NAME@@ \-fn "9x15bold,xft:Bitstream Vera Sans Mono"
286.Ve 304.Ve
287.Sp 305.Sp
288See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 306See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
289section of @@RXVT_NAME@@(7). 307section of @@RXVT_NAME@@(7).
290.IP "\fB\-fb\fR \fIfontlist\fR" 4 308.IP "\fB\-fb\fR \fIfontlist\fR" 4
291.IX Item "-fb fontlist" 309.IX Item "-fb fontlist"
292Compile font\-styles: The bold font list to use when bold characters are to 310Compile \fIfont-styles\fR: The bold font list to use when \fBbold\fR characters
293be printed. See resource \fBboldFont\fR for details. 311are to be printed. See resource \fBboldFont\fR for details.
294.IP "\fB\-fi\fR \fIfontlist\fR" 4 312.IP "\fB\-fi\fR \fIfontlist\fR" 4
295.IX Item "-fi fontlist" 313.IX Item "-fi fontlist"
296Compile font\-styles: The italic font list to use when bold characters are to 314Compile \fIfont-styles\fR: The italic font list to use when \fIitalic\fR
297be printed. See resource \fBitalicFont\fR for details. 315characters are to be printed. See resource \fBitalicFont\fR for details.
298.IP "\fB\-fbi\fR \fIfontlist\fR" 4 316.IP "\fB\-fbi\fR \fIfontlist\fR" 4
299.IX Item "-fbi fontlist" 317.IX Item "-fbi fontlist"
300Compile font\-styles: The bold italic font list to use when bold characters are to 318Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
301be printed. See resource \fBboldItalicFont\fR for details. 319italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
320for details.
321.IP "\fB\-is\fR|\fB+is\fR" 4
322.IX Item "-is|+is"
323Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity
324foreground/background (default). See resource \fBintensityStyles\fR for
325details.
302.IP "\fB\-name\fR \fIname\fR" 4 326.IP "\fB\-name\fR \fIname\fR" 4
303.IX Item "-name name" 327.IX Item "-name name"
304Specify the application name under which resources are to be obtained, 328Specify the application name under which resources are to be obtained,
305rather than the default executable file name. Name should not contain 329rather than the default executable file name. Name should not contain
306`.' or `*' characters. Also sets the icon and title name. 330`.' or `*' characters. Also sets the icon and title name.
334.IP "\fB\-sr\fR|\fB+sr\fR" 4 358.IP "\fB\-sr\fR|\fB+sr\fR" 4
335.IX Item "-sr|+sr" 359.IX Item "-sr|+sr"
336Put scrollbar on right/left; resource \fBscrollBar_right\fR. 360Put scrollbar on right/left; resource \fBscrollBar_right\fR.
337.IP "\fB\-st\fR|\fB+st\fR" 4 361.IP "\fB\-st\fR|\fB+st\fR" 4
338.IX Item "-st|+st" 362.IX Item "-st|+st"
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 363Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource \fBscrollBar_floating\fR. 364resource \fBscrollBar_floating\fR.
341.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 365.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
342.IX Item "-ptab|+ptab" 366.IX Item "-ptab|+ptab"
343If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 367If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
344actual wide characters in the screen buffer, which makes it possible to 368actual wide characters in the screen buffer, which makes it possible to
368.IP "\fB\-bl\fR" 4 392.IP "\fB\-bl\fR" 4
369.IX Item "-bl" 393.IX Item "-bl"
370Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e. 394Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e.
371if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window 395if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
372decorations; resource \fBborderLess\fR. 396decorations; resource \fBborderLess\fR.
397.IP "\fB\-override\-redirect\fR" 4
398.IX Item "-override-redirect"
399Compile \fIfrills\fR: Sets override-redirect on the window; resource
400\&\fBoverride-redirect\fR.
401.IP "\fB\-sbg\fR" 4
402.IX Item "-sbg"
403Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
404drawing characters and just rely on what the specified fonts provide. Use
405this if you have a good font and want to use its block graphic glyphs;
406resource \fBskipBuiltinGlyphs\fR.
373.IP "\fB\-lsp\fR \fInumber\fR" 4 407.IP "\fB\-lsp\fR \fInumber\fR" 4
374.IX Item "-lsp number" 408.IX Item "-lsp number"
375Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 409Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
376the display. Useful to work around font rendering problems; resource 410the display. Useful to work around font rendering problems; resource
377\&\fBlinespace\fR. 411\&\fBlinespace\fR.
388the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 422the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
389given on the command line. If this option is used, it must be the last 423given on the command line. If this option is used, it must be the last
390on the command\-line. If there is no \fB\-e\fR option then the default is to 424on the command\-line. If there is no \fB\-e\fR option then the default is to
391run the program specified by the \fB\s-1SHELL\s0\fR environment variable or, 425run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
392failing that, \fI\fIsh\fI\|(1)\fR. 426failing that, \fI\fIsh\fI\|(1)\fR.
427.Sp
428Please note that you must specify a program with arguments. If you want to
429run shell commands, you have to specify the shell, like this:
430.Sp
431.Vb 1
432\& @@RXVT_NAME@@ \-e sh \-c "shell commands"
433.Ve
393.IP "\fB\-title\fR \fItext\fR" 4 434.IP "\fB\-title\fR \fItext\fR" 4
394.IX Item "-title text" 435.IX Item "-title text"
395Window title (\fB\-T\fR still respected); the default title is the basename 436Window title (\fB\-T\fR still respected); the default title is the basename
396of the program specified after the \fB\-e\fR option, if any, otherwise the 437of the program specified after the \fB\-e\fR option, if any, otherwise the
397application name; resource \fBtitle\fR. 438application name; resource \fBtitle\fR.
441\&\fBsecondaryScreen\fR. 482\&\fBsecondaryScreen\fR.
442.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 483.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
443.IX Item "-ssr|+ssr" 484.IX Item "-ssr|+ssr"
444Turn on/off secondary screen scroll (default enabled); resource 485Turn on/off secondary screen scroll (default enabled); resource
445\&\fBsecondaryScroll\fR. 486\&\fBsecondaryScroll\fR.
487.IP "\fB\-hold\fR|\fB+hold\fR" 4
488.IX Item "-hold|+hold"
489Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
490will not immediately destroy its window when the program executed within
491it exits. Instead, it will wait till it is being killed or closed by the
492user; resource \fBhold\fR.
446.IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4 493.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
447.IX Item "-keysym.sym: string" 494.IX Item "-keysym.sym string"
448Remap a key symbol. See resource \fBkeysym\fR. 495Remap a key symbol. See resource \fBkeysym\fR.
449.IP "\fB\-embed\fR: \fIwindowid\fR" 4 496.IP "\fB\-embed\fR \fIwindowid\fR" 4
450.IX Item "-embed: windowid" 497.IX Item "-embed windowid"
451Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 498Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
452which enables applications to easily embed a terminal. 499which enables applications to easily embed a terminal.
453.Sp 500.Sp
454Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 501Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
455shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 502shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
461It might be useful to know that @@RXVT_NAME@@ will not close file 508It might be useful to know that @@RXVT_NAME@@ will not close file
462descriptors passed to it (except for stdin/out/err, of course), so you 509descriptors passed to it (except for stdin/out/err, of course), so you
463can use file descriptors to communicate with the programs within the 510can use file descriptors to communicate with the programs within the
464terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or 511terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
465not. 512not.
513.Sp
514Here is a short Gtk2\-perl snippet that illustrates how this option can be
515used (a longer example is in \fIdoc/embed\fR):
516.Sp
517.Vb 5
518\& my $rxvt = new Gtk2::Socket;
519\& $rxvt\->signal_connect_after (realize => sub {
520\& my $xid = $_[0]\->window\->get_xid;
521\& system "@@RXVT_NAME@@ \-embed $xid &";
522\& });
523.Ve
524.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
525.IX Item "-pty-fd file descriptor"
526Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
527pair but instead use the given filehandle as the tty master. This is
528useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
529without having to run a program within it.
530.Sp
531If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
532entries and will not tinker with pty/tty permissions \- you have to do that
533yourself if you want that.
534.Sp
535As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
536pty/tty operations.
537.Sp
538Here is a example in perl that illustrates how this option can be used (a
539longer example is in \fIdoc/pty\-fd\fR):
540.Sp
541.Vb 2
542\& use IO::Pty;
543\& use Fcntl;
544\&
545\& my $pty = new IO::Pty;
546\& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec
547\& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&";
548\& close $pty;
549\&
550\& # now communicate with rxvt
551\& my $slave = $pty\->slave;
552\& while (<$slave>) { print $slave "got <$_>\en" }
553.Ve
554.IP "\fB\-pe\fR \fIstring\fR" 4
555.IX Item "-pe string"
556Comma-separated list of perl extension scripts to use (or not to use) in
557this terminal instance. See resource \fBperl-ext\fR for details.
466.SH "RESOURCES (available also as long\-options)" 558.SH "RESOURCES (available also as long\-options)"
467.IX Header "RESOURCES (available also as long-options)" 559.IX Header "RESOURCES (available also as long-options)"
468Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 560Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
469options) compiled into your version. 561options) compiled into your version.
470.PP 562.PP
471There are two different methods that @@RXVT_NAME@@ can use to get the 563You can set and change the resources using X11 tools like \fBxrdb\fR. Many
472Xresource data: using the X libraries (Xrm*\-functions) or internal 564distribution do also load settings from the \fB~/.Xresources\fR file when X
473Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 565starts. @@RXVT_NAME@@ will consult the following files/resources in order,
474\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 566with later settings overwriting earlier ones:
475resources using X11 tools like \fBxrdb\fR. Many distribution do also load
476settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
477will consult the following files/resources in order, with later settings
478overwriting earlier ones:
479.PP 567.PP
480.Vb 5 568.Vb 5
481\& 1. system-wide app-defaults file, either locale-dependent OR global 569\& 1. system\-wide app\-defaults file, either locale\-dependent OR global
482\& 2. app-defaults file in $XAPPLRESDIR 570\& 2. app\-defaults file in $XAPPLRESDIR
483\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 571\& 3. RESOURCE_MANAGER property on root\-window OR $HOME/.Xdefaults
484\& 4. SCREEN_RESOURCES for the current screen 572\& 4. SCREEN_RESOURCES for the current screen
485\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 573\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\-<nodename>
486.Ve 574.Ve
487.PP 575.PP
488If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
489lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
490set in XAPPLOADDIR/URxvt (compile\-time defined: usually
491\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in
492\&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist.
493Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two 576Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
494class names: \fBXTerm\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows 577names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
495resources common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be 578common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
496easily configured, while the class name \fBURxvt\fR allows resources 579configured, while the class name \fBURxvt\fR allows resources unique to
497unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be 580\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
498shared between different \fB@@RXVT_NAME@@\fR configurations. If no 581configurations. If no resources are specified, suitable defaults will
499resources are specified, suitable defaults will be used. Command-line 582be used. Command-line arguments can be used to override resource
500arguments can be used to override resource settings. The following 583settings. The following resources are supported (you might want to
501resources are allowed: 584check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
585extensions not documented here):
586.IP "\fBdepth:\fR \fIbitdepth\fR" 4
587.IX Item "depth: bitdepth"
588Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
589option \fB\-depth\fR.
502.IP "\fBgeometry:\fR \fIgeom\fR" 4 590.IP "\fBgeometry:\fR \fIgeom\fR" 4
503.IX Item "geometry: geom" 591.IX Item "geometry: geom"
504Create the window with the specified X window geometry [default 80x24]; 592Create the window with the specified X window geometry [default 80x24];
505option \fB\-geometry\fR. 593option \fB\-geometry\fR.
506.IP "\fBbackground:\fR \fIcolour\fR" 4 594.IP "\fBbackground:\fR \fIcolour\fR" 4
568.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 656.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
569.IX Item "inheritPixmap: boolean" 657.IX Item "inheritPixmap: boolean"
570\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 658\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
571artificial transparency. \fBFalse\fR: do not inherit the parent windows' 659artificial transparency. \fBFalse\fR: do not inherit the parent windows'
572pixmap. 660pixmap.
661.Sp
662\&\fIPlease note that transparency of any kind if completely unsupported by
663the author. Don't bug him with installation questions!\fR
573.IP "\fBfading:\fR \fInumber\fR" 4 664.IP "\fBfading:\fR \fInumber\fR" 4
574.IX Item "fading: number" 665.IX Item "fading: number"
575Fade the text by the given percentage when focus is lost. 666Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
667.IP "\fBfadeColor:\fR \fIcolour\fR" 4
668.IX Item "fadeColor: colour"
669Fade to this colour, when fading is used (see \fBfading:\fR). The default
670colour is black; option \fB\-fadecolor\fR.
576.IP "\fBtintColor:\fR \fIcolour\fR" 4 671.IP "\fBtintColor:\fR \fIcolour\fR" 4
577.IX Item "tintColor: colour" 672.IX Item "tintColor: colour"
578Tint the transparent background pixmap with the given colour. 673Tint the transparent background pixmap with the given colour; option
674\&\fB\-tint\fR.
579.IP "\fBshading:\fR \fInumber\fR" 4 675.IP "\fBshading:\fR \fInumber\fR" 4
580.IX Item "shading: number" 676.IX Item "shading: number"
581Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 677Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
582image in addition to tinting it. 678image in addition to tinting it.
583.IP "\fBscrollColor:\fR \fIcolour\fR" 4 679.IP "\fBscrollColor:\fR \fIcolour\fR" 4
584.IX Item "scrollColor: colour" 680.IX Item "scrollColor: colour"
585Use the specified colour for the scrollbar [default #B2B2B2]. 681Use the specified colour for the scrollbar [default #B2B2B2].
586.IP "\fBtroughColor:\fR \fIcolour\fR" 4 682.IP "\fBtroughColor:\fR \fIcolour\fR" 4
587.IX Item "troughColor: colour" 683.IX Item "troughColor: colour"
588Use the specified colour for the scrollbar's trough area [default 684Use the specified colour for the scrollbar's trough area [default
589#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 685#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
590.IP "\fBborderColor:\fR \fIcolour\fR" 4 686.IP "\fBborderColor:\fR \fIcolour\fR" 4
591.IX Item "borderColor: colour" 687.IX Item "borderColor: colour"
592The colour of the border around the text area and between the scrollbar 688The colour of the border around the text area and between the scrollbar
593and the text. 689and the text.
594.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 690.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
600centre (percent). A scale of 0 displays the image with tiling. A scale 696centre (percent). A scale of 0 displays the image with tiling. A scale
601of 1 displays the image without any scaling. A scale of 2 to 9 697of 1 displays the image without any scaling. A scale of 2 to 9
602specifies an integer number of images in that direction. No image will 698specifies an integer number of images in that direction. No image will
603be magnified beyond 10 times its original size. The maximum permitted 699be magnified beyond 10 times its original size. The maximum permitted
604scale is 1000. [default 0x0+50+50] 700scale is 1000. [default 0x0+50+50]
605.IP "\fBmenu:\fR \fIfile[;tag]\fR" 4
606.IX Item "menu: file[;tag]"
607Read in the specified menu file (note the `.menu' extension is
608optional) and also optionally specify a starting tag to find. See the
609reference documentation for details on the syntax for the menuBar.
610.IP "\fBpath:\fR \fIpath\fR" 4 701.IP "\fBpath:\fR \fIpath\fR" 4
611.IX Item "path: path" 702.IX Item "path: path"
612Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 703Specify the colon-delimited search path for finding \s-1XPM\s0 files.
613menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and
614\&\fB\s-1PATH\s0\fR environment variables.
615.IP "\fBfont:\fR \fIfontlist\fR" 4 704.IP "\fBfont:\fR \fIfontlist\fR" 4
616.IX Item "font: fontlist" 705.IX Item "font: fontlist"
617Select the fonts to be used. This is a comma separated list of font 706Select the fonts to be used. This is a comma separated list of font names
618names that are used in turn when trying to display Unicode characters. 707that are checked in order when trying to find glyphs for characters. The
619The first font defines the cell size for characters; other fonts might 708first font defines the cell size for characters; other fonts might be
620be smaller, but not larger. A reasonable default font list is always 709smaller, but not (in general) larger. A (hopefully) reasonable default
621appended to it. option \fB\-fn\fR. 710font list is always appended to it; option \fB\-fn\fR.
622.Sp 711.Sp
623Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 712Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
624optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR. 713optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
625.Sp 714.Sp
626In addition, each font can be prefixed with additional hints and 715In addition, each font can be prefixed with additional hints and
629fonts. 718fonts.
630.Sp 719.Sp
631For example, this font resource 720For example, this font resource
632.Sp 721.Sp
633.Vb 5 722.Vb 5
634\& URxvt*font: 9x15bold,\e 723\& URxvt.font: 9x15bold,\e
635\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 724\& \-misc\-fixed\-bold\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1,\e
636\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e 725\& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e
637\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 726\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
638\& xft:Code2000:antialias=false 727\& xft:Code2000:antialias=false
639.Ve 728.Ve
640.Sp 729.Sp
641specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually 730specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually
674\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 763\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is
675not possible, replacement fonts of the desired shape will be tried. 764not possible, replacement fonts of the desired shape will be tried.
676.Sp 765.Sp
677If set, but empty, then this specific style is disabled and the normal 766If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 767text font will being used for the given style.
768.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
769.IX Item "intensityStyles: boolean"
770When font styles are not enabled, or this option is enabled (\fBTrue\fR,
771option \fB\-is\fR, the default), bold and italic font styles imply high
772intensity foreground/backround colours. Disabling this option (\fBFalse\fR,
773option \fB+is\fR) disables this behaviour, the high intensity colours are not
774reachable.
679.IP "\fBselectstyle:\fR \fImode\fR" 4 775.IP "\fBselectstyle:\fR \fImode\fR" 4
680.IX Item "selectstyle: mode" 776.IX Item "selectstyle: mode"
681Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 777Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is
682xterm style with 2.20 old word selection, or anything else which gives 778xterm style with 2.20 old word selection, or anything else which gives
683xterm style selection. 779xterm style selection.
684.IP "\fBscrollstyle:\fR \fImode\fR" 4 780.IP "\fBscrollstyle:\fR \fImode\fR" 4
685.IX Item "scrollstyle: mode" 781.IX Item "scrollstyle: mode"
686Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 782Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
687the author's favourite.. 783the author's favourite.
688.IP "\fBtitle:\fR \fIstring\fR" 4 784.IP "\fBtitle:\fR \fIstring\fR" 4
689.IX Item "title: string" 785.IX Item "title: string"
690Set window title string, the default title is the command-line 786Set window title string, the default title is the command-line
691specified after the \fB\-e\fR option, if any, otherwise the application 787specified after the \fB\-e\fR option, if any, otherwise the application
692name; option \fB\-title\fR. 788name; option \fB\-title\fR.
716.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 812.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
717.IX Item "print-pipe: string" 813.IX Item "print-pipe: string"
718Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 814Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
719\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or 815\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
720\&\fBShift-Print\fR to include the scrollback as well. 816\&\fBShift-Print\fR to include the scrollback as well.
817.Sp
818The string will be interpreted as if typed into the shell as\-is.
819.Sp
820Example:
821.Sp
822.Vb 1
823\& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
824.Ve
825.Sp
826This creates a new file in your home directory with the screen contents
827everytime you hit \f(CW\*(C`Print\*(C'\fR.
721.IP "\fBscrollBar:\fR \fIboolean\fR" 4 828.IP "\fBscrollBar:\fR \fIboolean\fR" 4
722.IX Item "scrollBar: boolean" 829.IX Item "scrollBar: boolean"
723\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 830\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
724disable the scrollbar; option \fB+sb\fR. 831disable the scrollbar; option \fB+sb\fR.
725.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 832.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
764option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. 871option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
765.IP "\fBborderLess:\fR \fIboolean\fR" 4 872.IP "\fBborderLess:\fR \fIboolean\fR" 4
766.IX Item "borderLess: boolean" 873.IX Item "borderLess: boolean"
767Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the 874Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the
768\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR. 875\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
876.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
877.IX Item "skipBuiltinGlyphs: boolean"
878Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
879drawing characters and just rely on what the specified fonts provide. Use
880this if you have a good font and want to use its block graphic glyphs;
881option \fB\-sbg\fR.
769.IP "\fBtermName:\fR \fItermname\fR" 4 882.IP "\fBtermName:\fR \fItermname\fR" 4
770.IX Item "termName: termname" 883.IX Item "termName: termname"
771Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 884Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
772variable; option \fB\-tn\fR. 885variable; option \fB\-tn\fR.
773.IP "\fBlinespace:\fR \fInumber\fR" 4 886.IP "\fBlinespace:\fR \fInumber\fR" 4
801.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 914.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
802.IX Item "pointerColor2: colour" 915.IX Item "pointerColor2: colour"
803Mouse pointer background colour. 916Mouse pointer background colour.
804.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 917.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
805.IX Item "pointerBlankDelay: number" 918.IX Item "pointerBlankDelay: number"
806Specifies number of seconds before blanking the pointer [default 2]. 919Specifies number of seconds before blanking the pointer [default 2]. Use a
920large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
807.IP "\fBbackspacekey:\fR \fIstring\fR" 4 921.IP "\fBbackspacekey:\fR \fIstring\fR" 4
808.IX Item "backspacekey: string" 922.IX Item "backspacekey: string"
809The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 923The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
810or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR 924or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
811(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 925(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
815The string to send when the delete key (not the keypad delete key) is 929The string to send when the delete key (not the keypad delete key) is
816pressed. If unset it will send the sequence traditionally associated 930pressed. If unset it will send the sequence traditionally associated
817with the \fBExecute\fR key. 931with the \fBExecute\fR key.
818.IP "\fBcutchars:\fR \fIstring\fR" 4 932.IP "\fBcutchars:\fR \fIstring\fR" 4
819.IX Item "cutchars: string" 933.IX Item "cutchars: string"
820The characters used as delimiters for double-click word selection. The 934The characters used as delimiters for double-click word selection
821built-in default: 935(whitespace delimiting is added automatically if resource is given).
936.Sp
937When the selection extension is in use (the default if compiled in, see
938the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these characters
939will be created (if the resource exists, otherwise, no regex will be
940created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
941.Sp
942When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
943be used. If not specified, the built-in default is used:
822.Sp 944.Sp
823\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 945\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
824.IP "\fBpreeditType:\fR \fIstyle\fR" 4 946.IP "\fBpreeditType:\fR \fIstyle\fR" 4
825.IX Item "preeditType: style" 947.IX Item "preeditType: style"
826\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 948\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
830.IP "\fBimLocale:\fR \fIname\fR" 4 952.IP "\fBimLocale:\fR \fIname\fR" 4
831.IX Item "imLocale: name" 953.IX Item "imLocale: name"
832The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g. 954The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
833\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the 955\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
834input extension to be able to input japanese characters while staying in 956input extension to be able to input japanese characters while staying in
835another locale. option \fB\-imlocale\fR. 957another locale; option \fB\-imlocale\fR.
836.IP "\fBimFont:\fR \fIfontset\fR" 4 958.IP "\fBimFont:\fR \fIfontset\fR" 4
837.IX Item "imFont: fontset" 959.IX Item "imFont: fontset"
838Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or 960Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
839\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated 961\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
840by commas), i.e. it's not in the same format as the other font lists used 962by commas), i.e. it's not in the same format as the other font lists used
843option \fB\-imfont\fR. 965option \fB\-imfont\fR.
844.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4 966.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
845.IX Item "tripleclickwords: boolean" 967.IX Item "tripleclickwords: boolean"
846Change the meaning of triple-click selection with the left mouse 968Change the meaning of triple-click selection with the left mouse
847button. Instead of selecting a full line it will extend the selection to 969button. Instead of selecting a full line it will extend the selection to
848the end of the logical line only. option \fB\-tcw\fR. 970the end of the logical line only; option \fB\-tcw\fR.
849.IP "\fBinsecure:\fR \fIboolean\fR" 4 971.IP "\fBinsecure:\fR \fIboolean\fR" 4
850.IX Item "insecure: boolean" 972.IX Item "insecure: boolean"
851Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 973Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
852echo arbitrary strings like the icon name or the locale. This could be 974echo arbitrary strings like the icon name or the locale. This could be
853abused if somebody gets 8\-bit\-clean access to your display, whether 975abused if somebody gets 8\-bit\-clean access to your display, whether
854throuh a mail client displaying mail bodies unfiltered or though 976through a mail client displaying mail bodies unfiltered or through
855\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 977\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
856that other terminals, including xterm, have these sequences 978default. (Note that many other terminals, including xterm, have these
857enabled by default). You can enable them by setting this boolean 979sequences enabled by default, which doesn't make it safer, though).
858resource or specifying \fB\-insecure\fR as an option. At the moment, this 980.Sp
859enabled display\-answer, locale, findfont, icon label and window title 981You can enable them by setting this boolean resource or specifying
860requests as well as dynamic menubar dispatch. 982\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
983locale, findfont, icon label and window title requests.
861.IP "\fBmodifier:\fR \fImodifier\fR" 4 984.IP "\fBmodifier:\fR \fImodifier\fR" 4
862.IX Item "modifier: modifier" 985.IX Item "modifier: modifier"
863Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 986Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
864\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option 987\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
865\&\fB\-mod\fR. 988\&\fB\-mod\fR.
866.IP "\fBanswerbackString:\fR \fIstring\fR" 4 989.IP "\fBanswerbackString:\fR \fIstring\fR" 4
867.IX Item "answerbackString: string" 990.IX Item "answerbackString: string"
868Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 991Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E)
869character is passed through. It may contain escape values as described 992character is passed through. It may contain escape values as described
870in the entry on \fBkeysym\fR following. 993in the entry on \fBkeysym\fR following.
871.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 994.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
872.IX Item "secondaryScreen: bool" 995.IX Item "secondaryScreen: boolean"
873Turn on/off secondary screen (default enabled). 996Turn on/off secondary screen (default enabled).
874.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 997.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
875.IX Item "secondaryScroll: bool" 998.IX Item "secondaryScroll: boolean"
876Turn on/off secondary screen scroll (default enabled). If the this 999Turn on/off secondary screen scroll (default enabled). If the this
877option is enabled, scrolls on the secondary screen will change the 1000option is enabled, scrolls on the secondary screen will change the
878scrollback buffer and switching to/from the secondary screen will 1001scrollback buffer and switching to/from the secondary screen will
879instead scroll the screen up. 1002instead scroll the screen up.
1003.IP "\fBhold\fR: \fIboolean\fR" 4
1004.IX Item "hold: boolean"
1005Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1006will not immediately destroy its window when the program executed within
1007it exits. Instead, it will wait till it is being killed or closed by the
1008user.
880.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1009.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
881.IX Item "keysym.sym: string" 1010.IX Item "keysym.sym: string"
882Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1011Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
883intervening resource name \fBkeysym.\fR cannot be omitted. 1012intervening resource name \fBkeysym.\fR cannot be omitted.
884.Sp 1013.Sp
903\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab, 1032\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab,
904\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete, 1033\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
905\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it 1034\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
906can start or end with whitespace. 1035can start or end with whitespace.
907.Sp 1036.Sp
908Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using 1037Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
909\&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can 1038Xlib itself does it's own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
910use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and 1039\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
911@@RXVT_NAME@@'s own processing). 1040processing).
912.Sp 1041.Sp
913You can define a range of keysyms in one shot by providing a \fIstring\fR 1042You can define a range of keysyms in one shot by providing a \fIstring\fR
914with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1043with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
915should be a character not used by the strings. 1044should be a character not used by the strings.
916.Sp 1045.Sp
917Its usage can be demonstrated by an example: 1046Its usage can be demonstrated by an example:
918.Sp 1047.Sp
919.Vb 1 1048.Vb 1
920\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|> 1049\& URxvt.keysym.M\-C\-0x61: list|\e033<M\-C\-|abc|>
921.Ve 1050.Ve
922.Sp 1051.Sp
923The above line is equivalent to the following three lines: 1052The above line is equivalent to the following three lines:
924.Sp 1053.Sp
925.Vb 3 1054.Vb 3
926\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a> 1055\& URxvt.keysym.Meta\-Control\-0x61: \e033<M\-C\-a>
927\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b> 1056\& URxvt.keysym.Meta\-Control\-0x62: \e033<M\-C\-b>
928\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c> 1057\& URxvt.keysym.Meta\-Control\-0x63: \e033<M\-C\-c>
929.Ve 1058.Ve
930.Sp 1059.Sp
931If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR 1060If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
932is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1061is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
933example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR 1062example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
934when Control-Meta-c is being pressed": 1063when Control-Meta-c is being pressed":
935.Sp 1064.Sp
936.Vb 1 1065.Vb 1
937\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 1066\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007
938.Ve 1067.Ve
1068.Sp
1069If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1070is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1071manpage. For example, the \fIselection\fR extension (activated via
1072\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1073.Sp
1074.Vb 1
1075\& URxvt.keysym.M\-C\-c: perl:selection:rot13
1076.Ve
1077.Sp
1078Due the the large number of modifier combinations, a defined key mapping
1079will match if at \fIat least\fR the specified identifiers are being set, and
1080no other key mappings with those and more bits are being defined. That
1081means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1082definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1083mappings themselves.
1084.Sp
1085Unfortunately, this will override built-in key mappings. For example
1086if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1087\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1088user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1089.Sp
1090.Vb 2
1091\& URxvt.keysym.Insert: <my insert key sequence>
1092\& URxvt.keysym.S\-Insert: builtin:
1093.Ve
1094.Sp
1095The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1096of modifiers. The second line re-establishes the default mapping for
1097\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
939.Sp 1098.Sp
940The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1099The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
941the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1100the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
942font-switching at runtime: 1101font-switching at runtime:
943.Sp 1102.Sp
944.Vb 2 1103.Vb 2
945\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007 1104\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007
946\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007 1105\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007
947.Ve 1106.Ve
948.Sp 1107.Sp
949Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1108Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
950info): 1109info):
951.Sp 1110.Sp
952.Vb 2 1111.Vb 2
953\& URxvt.keysym.M-C-3: command:\e033[8;25;80t 1112\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t
954\& URxvt.keysym.M-C-4: command:\e033[8;48;110t 1113\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t
955.Ve 1114.Ve
1115.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1116.IX Item "perl-ext-common: string"
1117.PD 0
1118.IP "\fBperl-ext\fR: \fIstring\fR" 4
1119.IX Item "perl-ext: string"
1120.PD
1121Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1122use in this terminal instance; option \fB\-pe\fR.
1123.Sp
1124Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1125them. This can be useful to selectively disable some extensions loaded
1126by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1127example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1128\&\f(CW\*(C`selection\*(C'\fR.
1129.Sp
1130Extension names can also be followed by an argument in angle brackets
1131(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1132searchable scorllback to Alt/Meta\-s). Mentioning the same extension
1133multiple times with different arguments will pass multiple arguments to
1134the extension.
1135.Sp
1136Each extension is looked up in the library directories, loaded if
1137necessary, and bound to the current terminal instance.
1138.Sp
1139If both of these resources are the empty string, then the perl
1140interpreter will not be initialized. The idea behind two options is that
1141\&\fBperl-ext-common\fR will be used for extensions that should be available to
1142all instances, while \fBperl-ext\fR is used for specific instances.
1143.IP "\fBperl-eval\fR: \fIstring\fR" 4
1144.IX Item "perl-eval: string"
1145Perl code to be evaluated when all extensions have been registered. See
1146the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. Due to security reasons, this resource
1147will be ignored when running setuid/setgid.
1148.IP "\fBperl-lib\fR: \fIpath\fR" 4
1149.IX Item "perl-lib: path"
1150Colon-separated list of additional directories that hold extension
1151scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1152@@RXVT_NAME@@ will first look in these directories and then in
1153\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. Due to security reasons, this resource
1154will be ignored when running setuid/setgid.
1155.Sp
1156See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1157.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1158.IX Item "selection.pattern-idx: perl-regex"
1159Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1160details.
1161.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1162.IX Item "selection-autotransform.idx: perl-transform"
1163Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1164for details.
1165.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4
1166.IX Item "searchable-scrollback: keysym"
1167Sets the hotkey that starts the incremental scrollback buffer search
1168(default: \f(CW\*(C`M\-s\*(C'\fR).
1169.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1170.IX Item "urlLauncher: string"
1171Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1172\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions.
1173.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1174.IX Item "transient-for: windowid"
1175Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1176.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1177.IX Item "override-redirect: boolean"
1178Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1179it almost invisible to window managers; option \fB\-override\-redirect\fR.
956.SH "THE SCROLLBAR" 1180.SH "THE SCROLLBAR"
957.IX Header "THE SCROLLBAR" 1181.IX Header "THE SCROLLBAR"
958Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1182Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
959(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1183(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
960or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1184or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
987to select a word; Left triple-click to select the entire logical line 1211to select a word; Left triple-click to select the entire logical line
988(which can span multiple screen lines), unless modified by resource 1212(which can span multiple screen lines), unless modified by resource
989\&\fBtripleclickwords\fR. 1213\&\fBtripleclickwords\fR.
990.Sp 1214.Sp
991Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1215Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
992(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal 1216(Compile: \fIfrills\fR) will create a rectangular selection instead of a
993one. 1217normal one. In this mode, every selected row becomes its own line in the
1218selection, and trailing whitespace is visually underlined and removed from
1219the selection.
994.IP "\fBInsertion\fR:" 4 1220.IP "\fBInsertion\fR:" 4
995.IX Item "Insertion:" 1221.IX Item "Insertion:"
996Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1222Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
997an \fB@@RXVT_NAME@@\fR window causes the current text selection to be 1223window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the
998inserted as if it had been typed on the keyboard. 1224Meta modifier) to be inserted as if it had been typed on the keyboard.
1225.Sp
1226Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1227inserted too.
999.SH "CHANGING FONTS" 1228.SH "CHANGING FONTS"
1000.IX Header "CHANGING FONTS" 1229.IX Header "CHANGING FONTS"
1001Changing fonts (or font sizes, respectively) via the keypad is not yet 1230Changing fonts (or font sizes, respectively) via the keypad is not yet
1002supported in rxvt\-unicode. Bug me if you need this. 1231supported in rxvt\-unicode. Bug me if you need this.
1003.PP 1232.PP
1004You can, however, switch fonts at runtime using escape sequences (and 1233You can, however, switch fonts at runtime using escape sequences, e.g.:
1005therefore using the menubar), e.g.:
1006.PP 1234.PP
1007.Vb 1 1235.Vb 1
1008\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1236\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1237.Ve
1238.PP
1239You can use keyboard shortcuts, too:
1240.PP
1241.Vb 2
1242\& URxvt.keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1243\& URxvt.keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
1009.Ve 1244.Ve
1010.PP 1245.PP
1011rxvt-unicode will automatically re-apply these fonts to the output so far. 1246rxvt-unicode will automatically re-apply these fonts to the output so far.
1012.SH "ISO 14755 SUPPORT" 1247.SH "ISO 14755 SUPPORT"
1013.IX Header "ISO 14755 SUPPORT" 1248.IX Header "ISO 14755 SUPPORT"
1014\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1249\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1015and character codes using the keyboard. It consists of 4 parts. The 1250and character codes using the keyboard. It consists of 4 parts. The
1016first part is available rxvt-unicode has been compiled with 1251first part is available rxvt-unicode has been compiled with
1017\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1252\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1018with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1253with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1254.IP "\(bu" 4
1019.IP "* 5.1: Basic method" 4 12555.1: Basic method
1020.IX Item "5.1: Basic method" 1256.Sp
1021This allows you to enter unicode characters using their hexcode. 1257This allows you to enter unicode characters using their hexcode.
1022.Sp 1258.Sp
1023Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1259Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
1024hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will 1260hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
1025commit the character as if it were typed directly. While holding down 1261commit the character as if it were typed directly. While holding down
1030As an example of use, imagine a business card with a japanese e\-mail 1266As an example of use, imagine a business card with a japanese e\-mail
1031address, which you cannot type. Fortunately, the card has the e\-mail 1267address, which you cannot type. Fortunately, the card has the e\-mail
1032address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily 1268address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
1033by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR, 1269by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR,
1034followed by releasing the modifier keys. 1270followed by releasing the modifier keys.
1271.IP "\(bu" 4
1035.IP "* 5.2: Keyboard symbols entry method" 4 12725.2: Keyboard symbols entry method
1036.IX Item "5.2: Keyboard symbols entry method" 1273.Sp
1037This mode lets you input characters representing the keycap symbols of 1274This mode lets you input characters representing the keycap symbols of
1038your keyboard, if representable in the current locale encoding. 1275your keyboard, if representable in the current locale encoding.
1039.Sp 1276.Sp
1040Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1277Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1041them. The next special key (cursor keys, home etc.) you enter will not 1278them. The next special key (cursor keys, home etc.) you enter will not
1042invoke it's usual function but instead will insert the corresponding 1279invoke it's usual function but instead will insert the corresponding
1043keycap symbol. The symbol will only be entered when the key has been 1280keycap symbol. The symbol will only be entered when the key has been
1044released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1281released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1045\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1282\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1046reverse tab (Shift\-Tab). 1283reverse tab (Shift\-Tab).
1284.IP "\(bu" 4
1047.IP "* 5.3: Screen-selection entry method" 4 12855.3: Screen-selection entry method
1048.IX Item "5.3: Screen-selection entry method" 1286.Sp
1049While this is implemented already (it's basically the selection 1287While this is implemented already (it's basically the selection
1050mechanism), it could be extended by displaying a unicode character map. 1288mechanism), it could be extended by displaying a unicode character map.
1289.IP "\(bu" 4
1051.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4 12905.4: Feedback method for identifying displayed characters for later input
1052.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1291.Sp
1053This method lets you display the unicode character code associated with 1292This method lets you display the unicode character code associated with
1054characters already displayed. 1293characters already displayed.
1055.Sp 1294.Sp
1056You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1295You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
1057pressing and holding the left mouse button and moving around. The unicode 1296pressing and holding the left mouse button and moving around. The unicode
1074.SH "COLORS AND GRAPHICS" 1313.SH "COLORS AND GRAPHICS"
1075.IX Header "COLORS AND GRAPHICS" 1314.IX Header "COLORS AND GRAPHICS"
1076In addition to the default foreground and background colours, 1315In addition to the default foreground and background colours,
1077\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1316\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1078high-intensity bold/blink versions of the same). Here is a list of the 1317high-intensity bold/blink versions of the same). Here is a list of the
1079colours with their \fBrgb.txt\fR names. 1318colours with their names.
1080.TS 1319.TS
1081l l l . 1320l l l .
1082color0 (black) = Black 1321color0 (black) = Black
1083color1 (red) = Red3 1322color1 (red) = Red3
1084color2 (green) = Green3 1323color2 (green) = Green3
1096color14 (bright cyan) = Cyan 1335color14 (bright cyan) = Cyan
1097color15 (bright white) = White 1336color15 (bright white) = White
1098foreground = Black 1337foreground = Black
1099background = White 1338background = White
1100.TE 1339.TE
1101
1102.PP 1340.PP
1103It is also possible to specify the colour values of \fBforeground\fR, 1341It is also possible to specify the colour values of \fBforeground\fR,
1104\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1342\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1105a number 0\-15, as a convenient shorthand to reference the colour name of 1343a number 0\-15, as a convenient shorthand to reference the colour name of
1106color0\-color15. 1344color0\-color15.
1345.PP
1346In addition to the colours defined above, @@RXVT_NAME@@ offers an
1347additional 72 colours. The first 64 of those (with indices 16 to 79)
1348consist of a 4*4*4 \s-1RGB\s0 colour cube (i.e. \fIindex = r * 16 + g * 4 + b +
134916\fR), followed by 8 additional shades of gray (with indices 80 to 87).
1350.PP
1351Together, all those colours implement the 88 colour xterm colours. Only
1352the first 16 can be changed using resources currently, the rest can only
1353be changed via command sequences (\*(L"escape codes\*(R").
1107.PP 1354.PP
1108Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by 1355Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1109always swapping the foreground/background colours. This is in contrast to 1356always swapping the foreground/background colours. This is in contrast to
1110\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise 1357\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1111been specified. For example, 1358been specified. For example,
1112.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1359.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1113.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1360.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1114would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1361would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1115on White. 1362on White.
1363.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1364.IX Subsection "ALPHA CHANNEL SUPPORT"
1365If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1366their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1367(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1368in addition to the ones provided by X, where the additional A component
1369specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1370transparent). You can also prefix any color with \f(CW\*(C`[a]\*(C'\fR, where \f(CW\*(C`a\*(C'\fR is on
1371to four hex digits specifiying the opacity value.
1372.PP
1373You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1374your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1375\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1376.PP
1377For example, the following selects an almost completely transparent red
1378background, and an almost opaque pink foreground:
1379.PP
1380.Vb 1
1381\& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/2222 \-fg "[e]pink"
1382.Ve
1383.PP
1384\&\fIPlease note that transparency of any kind if completely unsupported by
1385the author. Don't bug him with installation questions!\fR
1116.SH "ENVIRONMENT" 1386.SH "ENVIRONMENT"
1117.IX Header "ENVIRONMENT" 1387.IX Header "ENVIRONMENT"
1118\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: 1388\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1119.IP "\fB\s-1TERM\s0\fR" 4 1389.IP "\fB\s-1TERM\s0\fR" 4
1120.IX Item "TERM" 1390.IX Item "TERM"
1148Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1418Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1149display in it's child processes. 1419display in it's child processes.
1150.IP "\fB\s-1SHELL\s0\fR" 4 1420.IP "\fB\s-1SHELL\s0\fR" 4
1151.IX Item "SHELL" 1421.IX Item "SHELL"
1152The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR. 1422The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1153.IP "\fB\s-1RXVTPATH\s0\fR" 4
1154.IX Item "RXVTPATH"
1155The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1156files.
1157.IP "\fB\s-1PATH\s0\fR" 4
1158.IX Item "PATH"
1159Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1160.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1423.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1161.IX Item "RXVT_SOCKET" 1424.IX Item "RXVT_SOCKET"
1162The unix domain socket path used by @@RXVT_NAME@@c(1) and 1425The unix domain socket path used by @@RXVT_NAME@@c(1) and
1163@@RXVT_NAME@@d(1). 1426@@RXVT_NAME@@d(1).
1164.Sp 1427.Sp
1165Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR. 1428Default \fI\f(CI$HOME\fI/.rxvt\-unicode\-\fI<nodename\fI\fR.
1166.IP "\fB\s-1HOME\s0\fR" 4 1429.IP "\fB\s-1HOME\s0\fR" 4
1167.IX Item "HOME" 1430.IX Item "HOME"
1168Used to locate the default directory for the unix domain socket for 1431Used to locate the default directory for the unix domain socket for
1169daemon communications and to locate various resource files (such as 1432daemon communications and to locate various resource files (such as
1170\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1433\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1180.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1443.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1181.IX Item "/usr/lib/X11/rgb.txt" 1444.IX Item "/usr/lib/X11/rgb.txt"
1182Color names. 1445Color names.
1183.SH "SEE ALSO" 1446.SH "SEE ALSO"
1184.IX Header "SEE ALSO" 1447.IX Header "SEE ALSO"
1185@@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1448@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1186.SH "BUGS"
1187.IX Header "BUGS"
1188Check the \s-1BUGS\s0 file for an up-to-date list.
1189.PP
1190Cursor change support is not yet implemented.
1191.PP
1192Click-and-drag doesn't work with X11 mouse report overriding.
1193.SH "CURRENT PROJECT COORDINATOR" 1449.SH "CURRENT PROJECT COORDINATOR"
1194.IX Header "CURRENT PROJECT COORDINATOR" 1450.IX Header "CURRENT PROJECT COORDINATOR"
1195.IP "Project Coordinator" 4 1451.IP "Project Coordinator" 4
1196.IX Item "Project Coordinator" 1452.IX Item "Project Coordinator"
1197Marc A. Lehmann <rxvt\-unicode@schmorp.de> 1453Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1198.Sp 1454.Sp
1199<http://software.schmorp.de/#rxvt\-unicode> 1455<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1200.SH "AUTHORS" 1456.SH "AUTHORS"
1201.IX Header "AUTHORS" 1457.IX Header "AUTHORS"
1202.IP "John Bovey" 4 1458.IP "John Bovey" 4
1203.IX Item "John Bovey" 1459.IX Item "John Bovey"
1204University of Kent, 1992, wrote the original Xvt. 1460University of Kent, 1992, wrote the original Xvt.
1216.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1472.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1217.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1473.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1218Project Coordinator (changes.txt 2.21a to 2.4.5) 1474Project Coordinator (changes.txt 2.21a to 2.4.5)
1219.IP "Geoff Wing <gcw@pobox.com>" 4 1475.IP "Geoff Wing <gcw@pobox.com>" 4
1220.IX Item "Geoff Wing <gcw@pobox.com>" 1476.IX Item "Geoff Wing <gcw@pobox.com>"
1221Rewrote screen display and text selection routines. Project Coordinator 1477Rewrote screen display and text selection routines.
1478.Sp
1222(changes.txt 2.4.6 \- rxvt\-unicode) 1479Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1223.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4 1480.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1224.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>" 1481.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1225Forked rxvt\-unicode, rewrote most of the display code and internal 1482Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1226character handling to store text in unicode, improve xterm 1483extension, random hacks, numerous bugfixes and extensions.
1227compatibility and apply numerous other bugfixes and extensions.
1228.Sp 1484.Sp
1229Project Coordinator (Changes 1.0 \-) 1485Project Coordinator (Changes 1.0 \-)
1486.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1487.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1488Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines