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.57 by root, Tue Jan 31 00:25:16 2006 UTC

… …
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-01-31" "7.5" "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
… …
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.Ve
545.Sp
546.Vb 4
547\& my $pty = new IO::Pty;
548\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
549\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
550\& close $pty;
551.Ve
552.Sp
553.Vb 3
554\& # now communicate with rxvt
555\& my $slave = $pty->slave;
556\& while (<$slave>) { print $slave "got <$_>\en" }
557.Ve
558.IP "\fB\-pe\fR \fIstring\fR" 4
559.IX Item "-pe string"
560Comma-separated list of perl extension scripts to use (or not to use) in
561this terminal instance. See resource \fBperl-ext\fR for details.
466.SH "RESOURCES (available also as long\-options)" 562.SH "RESOURCES (available also as long\-options)"
467.IX Header "RESOURCES (available also as long-options)" 563.IX Header "RESOURCES (available also as long-options)"
468Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 564Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
469options) compiled into your version. 565options) compiled into your version.
470.PP 566.PP
471There are two different methods that @@RXVT_NAME@@ can use to get the 567You can set and change the resources using X11 tools like \fBxrdb\fR. Many
472Xresource data: using the X libraries (Xrm*\-functions) or internal 568distribution do also load settings from the \fB~/.Xresources\fR file when X
473Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 569starts. @@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 570with 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 571.PP
480.Vb 5 572.Vb 5
481\& 1. system-wide app-defaults file, either locale-dependent OR global 573\& 1. system-wide app-defaults file, either locale-dependent OR global
482\& 2. app-defaults file in $XAPPLRESDIR 574\& 2. app-defaults file in $XAPPLRESDIR
483\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 575\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
484\& 4. SCREEN_RESOURCES for the current screen 576\& 4. SCREEN_RESOURCES for the current screen
485\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 577\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
486.Ve 578.Ve
487.PP 579.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 580Note 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 581names: \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 582common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
496easily configured, while the class name \fBURxvt\fR allows resources 583configured, while the class name \fBURxvt\fR allows resources unique to
497unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be 584\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
498shared between different \fB@@RXVT_NAME@@\fR configurations. If no 585configurations. If no resources are specified, suitable defaults will
499resources are specified, suitable defaults will be used. Command-line 586be used. Command-line arguments can be used to override resource
500arguments can be used to override resource settings. The following 587settings. The following resources are supported (you might want to
501resources are allowed: 588check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
589extensions not documented here):
590.IP "\fBdepth:\fR \fIbitdepth\fR" 4
591.IX Item "depth: bitdepth"
592Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
593option \fB\-depth\fR.
502.IP "\fBgeometry:\fR \fIgeom\fR" 4 594.IP "\fBgeometry:\fR \fIgeom\fR" 4
503.IX Item "geometry: geom" 595.IX Item "geometry: geom"
504Create the window with the specified X window geometry [default 80x24]; 596Create the window with the specified X window geometry [default 80x24];
505option \fB\-geometry\fR. 597option \fB\-geometry\fR.
506.IP "\fBbackground:\fR \fIcolour\fR" 4 598.IP "\fBbackground:\fR \fIcolour\fR" 4
… …
568.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 660.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
569.IX Item "inheritPixmap: boolean" 661.IX Item "inheritPixmap: boolean"
570\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 662\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
571artificial transparency. \fBFalse\fR: do not inherit the parent windows' 663artificial transparency. \fBFalse\fR: do not inherit the parent windows'
572pixmap. 664pixmap.
665.Sp
666\&\fIPlease note that transparency of any kind if completely unsupported by
667the author. Don't bug him with installation questions!\fR
573.IP "\fBfading:\fR \fInumber\fR" 4 668.IP "\fBfading:\fR \fInumber\fR" 4
574.IX Item "fading: number" 669.IX Item "fading: number"
575Fade the text by the given percentage when focus is lost. 670Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
671.IP "\fBfadeColor:\fR \fIcolour\fR" 4
672.IX Item "fadeColor: colour"
673Fade to this colour, when fading is used (see \fBfading:\fR). The default
674colour is black; option \fB\-fadecolor\fR.
576.IP "\fBtintColor:\fR \fIcolour\fR" 4 675.IP "\fBtintColor:\fR \fIcolour\fR" 4
577.IX Item "tintColor: colour" 676.IX Item "tintColor: colour"
578Tint the transparent background pixmap with the given colour. 677Tint the transparent background pixmap with the given colour; option
678\&\fB\-tint\fR.
579.IP "\fBshading:\fR \fInumber\fR" 4 679.IP "\fBshading:\fR \fInumber\fR" 4
580.IX Item "shading: number" 680.IX Item "shading: number"
581Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 681Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
582image in addition to tinting it. 682image in addition to tinting it.
583.IP "\fBscrollColor:\fR \fIcolour\fR" 4 683.IP "\fBscrollColor:\fR \fIcolour\fR" 4
584.IX Item "scrollColor: colour" 684.IX Item "scrollColor: colour"
585Use the specified colour for the scrollbar [default #B2B2B2]. 685Use the specified colour for the scrollbar [default #B2B2B2].
586.IP "\fBtroughColor:\fR \fIcolour\fR" 4 686.IP "\fBtroughColor:\fR \fIcolour\fR" 4
587.IX Item "troughColor: colour" 687.IX Item "troughColor: colour"
588Use the specified colour for the scrollbar's trough area [default 688Use the specified colour for the scrollbar's trough area [default
589#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 689#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
590.IP "\fBborderColor:\fR \fIcolour\fR" 4 690.IP "\fBborderColor:\fR \fIcolour\fR" 4
591.IX Item "borderColor: colour" 691.IX Item "borderColor: colour"
592The colour of the border around the text area and between the scrollbar 692The colour of the border around the text area and between the scrollbar
593and the text. 693and the text.
594.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 694.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
600centre (percent). A scale of 0 displays the image with tiling. A scale 700centre (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 701of 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 702specifies an integer number of images in that direction. No image will
603be magnified beyond 10 times its original size. The maximum permitted 703be magnified beyond 10 times its original size. The maximum permitted
604scale is 1000. [default 0x0+50+50] 704scale 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 705.IP "\fBpath:\fR \fIpath\fR" 4
611.IX Item "path: path" 706.IX Item "path: path"
612Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 707Specify 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 708.IP "\fBfont:\fR \fIfontlist\fR" 4
616.IX Item "font: fontlist" 709.IX Item "font: fontlist"
617Select the fonts to be used. This is a comma separated list of font 710Select 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. 711that are checked in order when trying to find glyphs for characters. The
619The first font defines the cell size for characters; other fonts might 712first font defines the cell size for characters; other fonts might be
620be smaller, but not larger. A reasonable default font list is always 713smaller, but not (in general) larger. A (hopefully) reasonable default
621appended to it. option \fB\-fn\fR. 714font list is always appended to it; option \fB\-fn\fR.
622.Sp 715.Sp
623Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 716Each 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. 717optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
625.Sp 718.Sp
626In addition, each font can be prefixed with additional hints and 719In addition, each font can be prefixed with additional hints and
… …
629fonts. 722fonts.
630.Sp 723.Sp
631For example, this font resource 724For example, this font resource
632.Sp 725.Sp
633.Vb 5 726.Vb 5
634\& URxvt*font: 9x15bold,\e 727\& URxvt.font: 9x15bold,\e
635\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 728\& -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 729\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
637\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 730\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
638\& xft:Code2000:antialias=false 731\& xft:Code2000:antialias=false
639.Ve 732.Ve
… …
674\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 767\&\*(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. 768not possible, replacement fonts of the desired shape will be tried.
676.Sp 769.Sp
677If set, but empty, then this specific style is disabled and the normal 770If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 771text font will being used for the given style.
772.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
773.IX Item "intensityStyles: boolean"
774When font styles are not enabled, or this option is enabled (\fBTrue\fR,
775option \fB\-is\fR, the default), bold and italic font styles imply high
776intensity foreground/backround colours. Disabling this option (\fBFalse\fR,
777option \fB+is\fR) disables this behaviour, the high intensity colours are not
778reachable.
679.IP "\fBselectstyle:\fR \fImode\fR" 4 779.IP "\fBselectstyle:\fR \fImode\fR" 4
680.IX Item "selectstyle: mode" 780.IX Item "selectstyle: mode"
681Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 781Set 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 782xterm style with 2.20 old word selection, or anything else which gives
683xterm style selection. 783xterm style selection.
684.IP "\fBscrollstyle:\fR \fImode\fR" 4 784.IP "\fBscrollstyle:\fR \fImode\fR" 4
685.IX Item "scrollstyle: mode" 785.IX Item "scrollstyle: mode"
686Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 786Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
687the author's favourite.. 787the author's favourite.
688.IP "\fBtitle:\fR \fIstring\fR" 4 788.IP "\fBtitle:\fR \fIstring\fR" 4
689.IX Item "title: string" 789.IX Item "title: string"
690Set window title string, the default title is the command-line 790Set window title string, the default title is the command-line
691specified after the \fB\-e\fR option, if any, otherwise the application 791specified after the \fB\-e\fR option, if any, otherwise the application
692name; option \fB\-title\fR. 792name; option \fB\-title\fR.
… …
716.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 816.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
717.IX Item "print-pipe: string" 817.IX Item "print-pipe: string"
718Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 818Specify 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 819\&\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. 820\&\fBShift-Print\fR to include the scrollback as well.
821.Sp
822The string will be interpreted as if typed into the shell as\-is.
823.Sp
824Example:
825.Sp
826.Vb 1
827\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
828.Ve
829.Sp
830This creates a new file in your home directory with the screen contents
831everytime you hit \f(CW\*(C`Print\*(C'\fR.
721.IP "\fBscrollBar:\fR \fIboolean\fR" 4 832.IP "\fBscrollBar:\fR \fIboolean\fR" 4
722.IX Item "scrollBar: boolean" 833.IX Item "scrollBar: boolean"
723\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 834\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
724disable the scrollbar; option \fB+sb\fR. 835disable the scrollbar; option \fB+sb\fR.
725.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 836.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
764option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. 875option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
765.IP "\fBborderLess:\fR \fIboolean\fR" 4 876.IP "\fBborderLess:\fR \fIboolean\fR" 4
766.IX Item "borderLess: boolean" 877.IX Item "borderLess: boolean"
767Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the 878Set \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. 879\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
880.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
881.IX Item "skipBuiltinGlyphs: boolean"
882Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
883drawing characters and just rely on what the specified fonts provide. Use
884this if you have a good font and want to use its block graphic glyphs;
885option \fB\-sbg\fR.
769.IP "\fBtermName:\fR \fItermname\fR" 4 886.IP "\fBtermName:\fR \fItermname\fR" 4
770.IX Item "termName: termname" 887.IX Item "termName: termname"
771Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 888Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
772variable; option \fB\-tn\fR. 889variable; option \fB\-tn\fR.
773.IP "\fBlinespace:\fR \fInumber\fR" 4 890.IP "\fBlinespace:\fR \fInumber\fR" 4
… …
801.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 918.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
802.IX Item "pointerColor2: colour" 919.IX Item "pointerColor2: colour"
803Mouse pointer background colour. 920Mouse pointer background colour.
804.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 921.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
805.IX Item "pointerBlankDelay: number" 922.IX Item "pointerBlankDelay: number"
806Specifies number of seconds before blanking the pointer [default 2]. 923Specifies number of seconds before blanking the pointer [default 2]. Use a
924large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
807.IP "\fBbackspacekey:\fR \fIstring\fR" 4 925.IP "\fBbackspacekey:\fR \fIstring\fR" 4
808.IX Item "backspacekey: string" 926.IX Item "backspacekey: string"
809The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 927The 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 928or 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 929(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 933The string to send when the delete key (not the keypad delete key) is
816pressed. If unset it will send the sequence traditionally associated 934pressed. If unset it will send the sequence traditionally associated
817with the \fBExecute\fR key. 935with the \fBExecute\fR key.
818.IP "\fBcutchars:\fR \fIstring\fR" 4 936.IP "\fBcutchars:\fR \fIstring\fR" 4
819.IX Item "cutchars: string" 937.IX Item "cutchars: string"
820The characters used as delimiters for double-click word selection. The 938The characters used as delimiters for double-click word selection
821built-in default: 939(whitespace delimiting is added automatically if resource is given).
940.Sp
941When the selection extension is in use (the default if compiled in, see
942the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these characters
943will be created (if the resource exists, otherwise, no regex will be
944created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
945.Sp
946When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
947be used. If not specified, the built-in default is used:
822.Sp 948.Sp
823\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 949\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
824.IP "\fBpreeditType:\fR \fIstyle\fR" 4 950.IP "\fBpreeditType:\fR \fIstyle\fR" 4
825.IX Item "preeditType: style" 951.IX Item "preeditType: style"
826\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 952\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
… …
830.IP "\fBimLocale:\fR \fIname\fR" 4 956.IP "\fBimLocale:\fR \fIname\fR" 4
831.IX Item "imLocale: name" 957.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. 958The 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 959\&\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 960input extension to be able to input japanese characters while staying in
835another locale. option \fB\-imlocale\fR. 961another locale; option \fB\-imlocale\fR.
836.IP "\fBimFont:\fR \fIfontset\fR" 4 962.IP "\fBimFont:\fR \fIfontset\fR" 4
837.IX Item "imFont: fontset" 963.IX Item "imFont: fontset"
838Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or 964Specify 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 965\&\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 966by commas), i.e. it's not in the same format as the other font lists used
… …
843option \fB\-imfont\fR. 969option \fB\-imfont\fR.
844.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4 970.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
845.IX Item "tripleclickwords: boolean" 971.IX Item "tripleclickwords: boolean"
846Change the meaning of triple-click selection with the left mouse 972Change the meaning of triple-click selection with the left mouse
847button. Instead of selecting a full line it will extend the selection to 973button. Instead of selecting a full line it will extend the selection to
848the end of the logical line only. option \fB\-tcw\fR. 974the end of the logical line only; option \fB\-tcw\fR.
849.IP "\fBinsecure:\fR \fIboolean\fR" 4 975.IP "\fBinsecure:\fR \fIboolean\fR" 4
850.IX Item "insecure: boolean" 976.IX Item "insecure: boolean"
851Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 977Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
852echo arbitrary strings like the icon name or the locale. This could be 978echo arbitrary strings like the icon name or the locale. This could be
853abused if somebody gets 8\-bit\-clean access to your display, whether 979abused if somebody gets 8\-bit\-clean access to your display, whether
854throuh a mail client displaying mail bodies unfiltered or though 980through a mail client displaying mail bodies unfiltered or through
855\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 981\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
856that other terminals, including xterm, have these sequences 982default. (Note that many other terminals, including xterm, have these
857enabled by default). You can enable them by setting this boolean 983sequences enabled by default, which doesn't make it safer, though).
858resource or specifying \fB\-insecure\fR as an option. At the moment, this 984.Sp
859enabled display\-answer, locale, findfont, icon label and window title 985You can enable them by setting this boolean resource or specifying
860requests as well as dynamic menubar dispatch. 986\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
987locale, findfont, icon label and window title requests.
861.IP "\fBmodifier:\fR \fImodifier\fR" 4 988.IP "\fBmodifier:\fR \fImodifier\fR" 4
862.IX Item "modifier: modifier" 989.IX Item "modifier: modifier"
863Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 990Set 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 991\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
865\&\fB\-mod\fR. 992\&\fB\-mod\fR.
866.IP "\fBanswerbackString:\fR \fIstring\fR" 4 993.IP "\fBanswerbackString:\fR \fIstring\fR" 4
867.IX Item "answerbackString: string" 994.IX Item "answerbackString: string"
868Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 995Specify 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 996character is passed through. It may contain escape values as described
870in the entry on \fBkeysym\fR following. 997in the entry on \fBkeysym\fR following.
871.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 998.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
872.IX Item "secondaryScreen: bool" 999.IX Item "secondaryScreen: boolean"
873Turn on/off secondary screen (default enabled). 1000Turn on/off secondary screen (default enabled).
874.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 1001.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
875.IX Item "secondaryScroll: bool" 1002.IX Item "secondaryScroll: boolean"
876Turn on/off secondary screen scroll (default enabled). If the this 1003Turn on/off secondary screen scroll (default enabled). If the this
877option is enabled, scrolls on the secondary screen will change the 1004option is enabled, scrolls on the secondary screen will change the
878scrollback buffer and switching to/from the secondary screen will 1005scrollback buffer and switching to/from the secondary screen will
879instead scroll the screen up. 1006instead scroll the screen up.
1007.IP "\fBhold\fR: \fIboolean\fR" 4
1008.IX Item "hold: boolean"
1009Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1010will not immediately destroy its window when the program executed within
1011it exits. Instead, it will wait till it is being killed or closed by the
1012user.
880.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1013.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
881.IX Item "keysym.sym: string" 1014.IX Item "keysym.sym: string"
882Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1015Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
883intervening resource name \fBkeysym.\fR cannot be omitted. 1016intervening resource name \fBkeysym.\fR cannot be omitted.
884.Sp 1017.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, 1036\&\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, 1037\&\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 1038\&\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. 1039can start or end with whitespace.
907.Sp 1040.Sp
908Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using 1041Please 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 1042Xlib 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 1043\&\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). 1044processing).
912.Sp 1045.Sp
913You can define a range of keysyms in one shot by providing a \fIstring\fR 1046You can define a range of keysyms in one shot by providing a \fIstring\fR
914with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1047with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
915should be a character not used by the strings. 1048should be a character not used by the strings.
916.Sp 1049.Sp
… …
935.Sp 1068.Sp
936.Vb 1 1069.Vb 1
937\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 1070\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
938.Ve 1071.Ve
939.Sp 1072.Sp
1073If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1074is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1075manpage. For example, the \fIselection\fR extension (activated via
1076\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1077.Sp
1078.Vb 1
1079\& URxvt.keysym.M-C-c: perl:selection:rot13
1080.Ve
1081.Sp
1082Due the the large number of modifier combinations, a defined key mapping
1083will match if at \fIat least\fR the specified identifiers are being set, and
1084no other key mappings with those and more bits are being defined. That
1085means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1086definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1087mappings themselves.
1088.Sp
1089Unfortunately, this will override built-in key mappings. For example
1090if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1091\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1092user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1093.Sp
1094.Vb 2
1095\& URxvt.keysym.Insert: <my insert key sequence>
1096\& URxvt.keysym.S-Insert: builtin:
1097.Ve
1098.Sp
1099The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1100of modifiers. The second line re-establishes the default mapping for
1101\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1102.Sp
940The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1103The 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 1104the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
942font-switching at runtime: 1105font-switching at runtime:
943.Sp 1106.Sp
944.Vb 2 1107.Vb 2
… …
951.Sp 1114.Sp
952.Vb 2 1115.Vb 2
953\& URxvt.keysym.M-C-3: command:\e033[8;25;80t 1116\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
954\& URxvt.keysym.M-C-4: command:\e033[8;48;110t 1117\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
955.Ve 1118.Ve
1119.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1120.IX Item "perl-ext-common: string"
1121.PD 0
1122.IP "\fBperl-ext\fR: \fIstring\fR" 4
1123.IX Item "perl-ext: string"
1124.PD
1125Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1126use in this terminal instance; option \fB\-pe\fR.
1127.Sp
1128Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1129them. This can be useful to selectively disable some extensions loaded
1130by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1131example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1132\&\f(CW\*(C`selection\*(C'\fR.
1133.Sp
1134Extension names can also be followed by an argument in angle brackets
1135(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1136searchable scorllback to Alt/Meta\-s). Mentioning the same extension
1137multiple times with different arguments will pass multiple arguments to
1138the extension.
1139.Sp
1140Each extension is looked up in the library directories, loaded if
1141necessary, and bound to the current terminal instance.
1142.Sp
1143If both of these resources are the empty string, then the perl
1144interpreter will not be initialized. The idea behind two options is that
1145\&\fBperl-ext-common\fR will be used for extensions that should be available to
1146all instances, while \fBperl-ext\fR is used for specific instances.
1147.IP "\fBperl-eval\fR: \fIstring\fR" 4
1148.IX Item "perl-eval: string"
1149Perl code to be evaluated when all extensions have been registered. See
1150the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. Due to security reasons, this resource
1151will be ignored when running setuid/setgid.
1152.IP "\fBperl-lib\fR: \fIpath\fR" 4
1153.IX Item "perl-lib: path"
1154Colon-separated list of additional directories that hold extension
1155scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1156@@RXVT_NAME@@ will first look in these directories and then in
1157\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. Due to security reasons, this resource
1158will be ignored when running setuid/setgid.
1159.Sp
1160See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1161.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1162.IX Item "selection.pattern-idx: perl-regex"
1163Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1164details.
1165.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1166.IX Item "selection-autotransform.idx: perl-transform"
1167Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1168for details.
1169.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4
1170.IX Item "searchable-scrollback: keysym"
1171Sets the hotkey that starts the incremental scrollback buffer search
1172(default: \f(CW\*(C`M\-s\*(C'\fR).
1173.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1174.IX Item "urlLauncher: string"
1175Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1176\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions.
1177.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1178.IX Item "transient-for: windowid"
1179Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1180.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1181.IX Item "override-redirect: boolean"
1182Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1183it almost invisible to window managers; option \fB\-override\-redirect\fR.
956.SH "THE SCROLLBAR" 1184.SH "THE SCROLLBAR"
957.IX Header "THE SCROLLBAR" 1185.IX Header "THE SCROLLBAR"
958Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1186Lines 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 1187(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
960or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1188or 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 1215to select a word; Left triple-click to select the entire logical line
988(which can span multiple screen lines), unless modified by resource 1216(which can span multiple screen lines), unless modified by resource
989\&\fBtripleclickwords\fR. 1217\&\fBtripleclickwords\fR.
990.Sp 1218.Sp
991Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1219Starting 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 1220(Compile: \fIfrills\fR) will create a rectangular selection instead of a
993one. 1221normal one. In this mode, every selected row becomes its own line in the
1222selection, and trailing whitespace is visually underlined and removed from
1223the selection.
994.IP "\fBInsertion\fR:" 4 1224.IP "\fBInsertion\fR:" 4
995.IX Item "Insertion:" 1225.IX Item "Insertion:"
996Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1226Pressing 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 1227window 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. 1228Meta modifier) to be inserted as if it had been typed on the keyboard.
1229.Sp
1230Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1231inserted too.
999.SH "CHANGING FONTS" 1232.SH "CHANGING FONTS"
1000.IX Header "CHANGING FONTS" 1233.IX Header "CHANGING FONTS"
1001Changing fonts (or font sizes, respectively) via the keypad is not yet 1234Changing fonts (or font sizes, respectively) via the keypad is not yet
1002supported in rxvt\-unicode. Bug me if you need this. 1235supported in rxvt\-unicode. Bug me if you need this.
1003.PP 1236.PP
1004You can, however, switch fonts at runtime using escape sequences (and 1237You can, however, switch fonts at runtime using escape sequences, e.g.:
1005therefore using the menubar), e.g.:
1006.PP 1238.PP
1007.Vb 1 1239.Vb 1
1008\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1240\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1241.Ve
1242.PP
1243You can use keyboard shortcuts, too:
1244.PP
1245.Vb 2
1246\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1247\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
1009.Ve 1248.Ve
1010.PP 1249.PP
1011rxvt-unicode will automatically re-apply these fonts to the output so far. 1250rxvt-unicode will automatically re-apply these fonts to the output so far.
1012.SH "ISO 14755 SUPPORT" 1251.SH "ISO 14755 SUPPORT"
1013.IX Header "ISO 14755 SUPPORT" 1252.IX Header "ISO 14755 SUPPORT"
… …
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
… …
1111been specified. For example, 1350been specified. For example,
1112.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1351.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1113.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1352.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1114would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1353would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1115on White. 1354on White.
1355.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1356.IX Subsection "ALPHA CHANNEL SUPPORT"
1357If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1358their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1359(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1360in addition to the ones provided by X, where the additional A component
1361specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1362transparent). You can also prefix any color with \f(CW\*(C`[a]\*(C'\fR, where \f(CW\*(C`a\*(C'\fR is on
1363to four hex digits specifiying the opacity value.
1364.PP
1365You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1366your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1367\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1368.PP
1369For example, the following selects an almost completely transparent red
1370background, and an almost opaque pink foreground:
1371.PP
1372.Vb 1
1373\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1374.Ve
1375.PP
1376\&\fIPlease note that transparency of any kind if completely unsupported by
1377the author. Don't bug him with installation questions!\fR
1116.SH "ENVIRONMENT" 1378.SH "ENVIRONMENT"
1117.IX Header "ENVIRONMENT" 1379.IX Header "ENVIRONMENT"
1118\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: 1380\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1119.IP "\fB\s-1TERM\s0\fR" 4 1381.IP "\fB\s-1TERM\s0\fR" 4
1120.IX Item "TERM" 1382.IX Item "TERM"
… …
1148Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1410Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1149display in it's child processes. 1411display in it's child processes.
1150.IP "\fB\s-1SHELL\s0\fR" 4 1412.IP "\fB\s-1SHELL\s0\fR" 4
1151.IX Item "SHELL" 1413.IX Item "SHELL"
1152The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR. 1414The 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 1415.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1161.IX Item "RXVT_SOCKET" 1416.IX Item "RXVT_SOCKET"
1162The unix domain socket path used by @@RXVT_NAME@@c(1) and 1417The unix domain socket path used by @@RXVT_NAME@@c(1) and
1163@@RXVT_NAME@@d(1). 1418@@RXVT_NAME@@d(1).
1164.Sp 1419.Sp
1165Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR. 1420Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1166.IP "\fB\s-1HOME\s0\fR" 4 1421.IP "\fB\s-1HOME\s0\fR" 4
1167.IX Item "HOME" 1422.IX Item "HOME"
1168Used to locate the default directory for the unix domain socket for 1423Used to locate the default directory for the unix domain socket for
1169daemon communications and to locate various resource files (such as 1424daemon communications and to locate various resource files (such as
1170\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1425\&\f(CW\*(C`.Xdefaults\*(C'\fR)
… …
1180.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1435.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1181.IX Item "/usr/lib/X11/rgb.txt" 1436.IX Item "/usr/lib/X11/rgb.txt"
1182Color names. 1437Color names.
1183.SH "SEE ALSO" 1438.SH "SEE ALSO"
1184.IX Header "SEE ALSO" 1439.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) 1440@@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" 1441.SH "CURRENT PROJECT COORDINATOR"
1194.IX Header "CURRENT PROJECT COORDINATOR" 1442.IX Header "CURRENT PROJECT COORDINATOR"
1195.IP "Project Coordinator" 4 1443.IP "Project Coordinator" 4
1196.IX Item "Project Coordinator" 1444.IX Item "Project Coordinator"
1197Marc A. Lehmann <rxvt\-unicode@schmorp.de> 1445Marc A. Lehmann <rxvt\-unicode@schmorp.de>
… …
1216.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1464.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1217.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1465.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1218Project Coordinator (changes.txt 2.21a to 2.4.5) 1466Project Coordinator (changes.txt 2.21a to 2.4.5)
1219.IP "Geoff Wing <gcw@pobox.com>" 4 1467.IP "Geoff Wing <gcw@pobox.com>" 4
1220.IX Item "Geoff Wing <gcw@pobox.com>" 1468.IX Item "Geoff Wing <gcw@pobox.com>"
1221Rewrote screen display and text selection routines. Project Coordinator 1469Rewrote screen display and text selection routines.
1470.Sp
1222(changes.txt 2.4.6 \- rxvt\-unicode) 1471Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1223.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4 1472.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1224.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>" 1473.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1225Forked rxvt\-unicode, rewrote most of the display code and internal 1474Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1226character handling to store text in unicode, improve xterm 1475extension, random hacks, numerous bugfixes and extensions.
1227compatibility and apply numerous other bugfixes and extensions.
1228.Sp 1476.Sp
1229Project Coordinator (Changes 1.0 \-) 1477Project Coordinator (Changes 1.0 \-)
1478.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1479.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1480Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

Diff Legend

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