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.53 by root, Wed Jan 25 21:48:47 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-25" "7.3" "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 \fIfrills\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.
232.IP "\fB\-fade\fR \fInumber\fR" 4 236.IP "\fB\-fade\fR \fInumber\fR" 4
233.IX Item "-fade number" 237.IX Item "-fade number"
234Fade the text by the given percentage when focus is lost. resource \fBfading\fR. 238Fade the text by the given percentage when focus is lost. Small values
239fade a little only, 100 completely replaces all colours by the fade
240colour; resource \fBfading\fR.
241.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
242.IX Item "-fadecolor colour"
243Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
244is black. resource \fBfadeColor\fR.
235.IP "\fB\-tint\fR \fIcolour\fR" 4 245.IP "\fB\-tint\fR \fIcolour\fR" 4
236.IX Item "-tint colour" 246.IX Item "-tint colour"
237Tint the transparent background pixmap with the given colour when 247Tint 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 248transparency 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 249non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
240tinting it. 250used to brighten or darken the image in addition to tinting it; resource
251\&\fItintColor\fR. Example:
252.Sp
253.Vb 1
254\& @@RXVT_NAME@@ -tr -tint blue -sh 40
255.Ve
241.IP "\fB\-sh\fR" 4 256.IP "\fB\-sh\fR" 4
242.IX Item "-sh" 257.IX Item "-sh"
243\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 258\&\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 259background image in addition to tinting it (i.e. \fB\-tint\fR must be
245specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). 260specified, 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; 284The colour of the border around the text area and between the scrollbar and the text;
270resource \fBborderColor\fR. 285resource \fBborderColor\fR.
271.IP "\fB\-fn\fR \fIfontlist\fR" 4 286.IP "\fB\-fn\fR \fIfontlist\fR" 4
272.IX Item "-fn fontlist" 287.IX Item "-fn fontlist"
273Select the fonts to be used. This is a comma separated list of font names 288Select 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 289that are checked in order when trying to find glyphs for characters. The
275first font defines the cell size for characters; other fonts might be 290first font defines the cell size for characters; other fonts might be
276smaller, but not (in general) larger. A (hopefully) reasonable default 291smaller, but not (in general) larger. A (hopefully) reasonable default
277font list is always appended to it. See resource \fBfont\fR for more details. 292font list is always appended to it. See resource \fBfont\fR for more details.
278.Sp 293.Sp
279In short, to specify an X11 core font, just specify it's name or prefix it 294In short, to specify an X11 core font, just specify it's name or prefix it
… …
287.Sp 302.Sp
288See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 303See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
289section of @@RXVT_NAME@@(7). 304section of @@RXVT_NAME@@(7).
290.IP "\fB\-fb\fR \fIfontlist\fR" 4 305.IP "\fB\-fb\fR \fIfontlist\fR" 4
291.IX Item "-fb fontlist" 306.IX Item "-fb fontlist"
292Compile font\-styles: The bold font list to use when bold characters are to 307Compile \fIfont-styles\fR: The bold font list to use when \fBbold\fR characters
293be printed. See resource \fBboldFont\fR for details. 308are to be printed. See resource \fBboldFont\fR for details.
294.IP "\fB\-fi\fR \fIfontlist\fR" 4 309.IP "\fB\-fi\fR \fIfontlist\fR" 4
295.IX Item "-fi fontlist" 310.IX Item "-fi fontlist"
296Compile font\-styles: The italic font list to use when bold characters are to 311Compile \fIfont-styles\fR: The italic font list to use when \fIitalic\fR
297be printed. See resource \fBitalicFont\fR for details. 312characters are to be printed. See resource \fBitalicFont\fR for details.
298.IP "\fB\-fbi\fR \fIfontlist\fR" 4 313.IP "\fB\-fbi\fR \fIfontlist\fR" 4
299.IX Item "-fbi fontlist" 314.IX Item "-fbi fontlist"
300Compile font\-styles: The bold italic font list to use when bold characters are to 315Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
301be printed. See resource \fBboldItalicFont\fR for details. 316italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
317for details.
318.IP "\fB\-is\fR|\fB+is\fR" 4
319.IX Item "-is|+is"
320Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity
321foreground/background (default). See resource \fBintensityStyles\fR for
322details.
302.IP "\fB\-name\fR \fIname\fR" 4 323.IP "\fB\-name\fR \fIname\fR" 4
303.IX Item "-name name" 324.IX Item "-name name"
304Specify the application name under which resources are to be obtained, 325Specify the application name under which resources are to be obtained,
305rather than the default executable file name. Name should not contain 326rather than the default executable file name. Name should not contain
306`.' or `*' characters. Also sets the icon and title name. 327`.' or `*' characters. Also sets the icon and title name.
… …
334.IP "\fB\-sr\fR|\fB+sr\fR" 4 355.IP "\fB\-sr\fR|\fB+sr\fR" 4
335.IX Item "-sr|+sr" 356.IX Item "-sr|+sr"
336Put scrollbar on right/left; resource \fBscrollBar_right\fR. 357Put scrollbar on right/left; resource \fBscrollBar_right\fR.
337.IP "\fB\-st\fR|\fB+st\fR" 4 358.IP "\fB\-st\fR|\fB+st\fR" 4
338.IX Item "-st|+st" 359.IX Item "-st|+st"
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 360Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource \fBscrollBar_floating\fR. 361resource \fBscrollBar_floating\fR.
341.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 362.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
342.IX Item "-ptab|+ptab" 363.IX Item "-ptab|+ptab"
343If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 364If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
344actual wide characters in the screen buffer, which makes it possible to 365actual wide characters in the screen buffer, which makes it possible to
… …
368.IP "\fB\-bl\fR" 4 389.IP "\fB\-bl\fR" 4
369.IX Item "-bl" 390.IX Item "-bl"
370Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e. 391Compile \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 392if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
372decorations; resource \fBborderLess\fR. 393decorations; resource \fBborderLess\fR.
394.IP "\fB\-override\-redirect\fR" 4
395.IX Item "-override-redirect"
396Compile \fIfrills\fR: Sets override-redirect on the window; resource
397\&\fBoverride-redirect\fR.
398.IP "\fB\-sbg\fR" 4
399.IX Item "-sbg"
400Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
401drawing characters and just rely on what the specified fonts provide. Use
402this if you have a good font and want to use its block graphic glyphs;
403resource \fBskipBuiltinGlyphs\fR.
373.IP "\fB\-lsp\fR \fInumber\fR" 4 404.IP "\fB\-lsp\fR \fInumber\fR" 4
374.IX Item "-lsp number" 405.IX Item "-lsp number"
375Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 406Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
376the display. Useful to work around font rendering problems; resource 407the display. Useful to work around font rendering problems; resource
377\&\fBlinespace\fR. 408\&\fBlinespace\fR.
… …
388the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 419the 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 420given 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 421on 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, 422run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
392failing that, \fI\fIsh\fI\|(1)\fR. 423failing that, \fI\fIsh\fI\|(1)\fR.
424.Sp
425Please note that you must specify a program with arguments. If you want to
426run shell commands, you have to specify the shell, like this:
427.Sp
428.Vb 1
429\& @@RXVT_NAME@@ -e sh -c "shell commands"
430.Ve
393.IP "\fB\-title\fR \fItext\fR" 4 431.IP "\fB\-title\fR \fItext\fR" 4
394.IX Item "-title text" 432.IX Item "-title text"
395Window title (\fB\-T\fR still respected); the default title is the basename 433Window 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 434of the program specified after the \fB\-e\fR option, if any, otherwise the
397application name; resource \fBtitle\fR. 435application name; resource \fBtitle\fR.
… …
441\&\fBsecondaryScreen\fR. 479\&\fBsecondaryScreen\fR.
442.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 480.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
443.IX Item "-ssr|+ssr" 481.IX Item "-ssr|+ssr"
444Turn on/off secondary screen scroll (default enabled); resource 482Turn on/off secondary screen scroll (default enabled); resource
445\&\fBsecondaryScroll\fR. 483\&\fBsecondaryScroll\fR.
484.IP "\fB\-hold\fR|\fB+hold\fR" 4
485.IX Item "-hold|+hold"
486Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
487will not immediately destroy its window when the program executed within
488it exits. Instead, it will wait till it is being killed or closed by the
489user; resource \fBhold\fR.
446.IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4 490.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
447.IX Item "-keysym.sym: string" 491.IX Item "-keysym.sym string"
448Remap a key symbol. See resource \fBkeysym\fR. 492Remap a key symbol. See resource \fBkeysym\fR.
449.IP "\fB\-embed\fR: \fIwindowid\fR" 4 493.IP "\fB\-embed\fR \fIwindowid\fR" 4
450.IX Item "-embed: windowid" 494.IX Item "-embed windowid"
451Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 495Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
452which enables applications to easily embed a terminal. 496which enables applications to easily embed a terminal.
453.Sp 497.Sp
454Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 498Right 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 499shouldn'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 505It 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 506descriptors passed to it (except for stdin/out/err, of course), so you
463can use file descriptors to communicate with the programs within the 507can 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 508terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
465not. 509not.
510.Sp
511Here is a short Gtk2\-perl snippet that illustrates how this option can be
512used (a longer example is in \fIdoc/embed\fR):
513.Sp
514.Vb 5
515\& my $rxvt = new Gtk2::Socket;
516\& $rxvt->signal_connect_after (realize => sub {
517\& my $xid = $_[0]->window->get_xid;
518\& system "@@RXVT_NAME@@ -embed $xid &";
519\& });
520.Ve
521.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
522.IX Item "-pty-fd file descriptor"
523Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
524pair but instead use the given filehandle as the tty master. This is
525useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
526without having to run a program within it.
527.Sp
528If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
529entries and will not tinker with pty/tty permissions \- you have to do that
530yourself if you want that.
531.Sp
532As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
533pty/tty operations.
534.Sp
535Here is a example in perl that illustrates how this option can be used (a
536longer example is in \fIdoc/pty\-fd\fR):
537.Sp
538.Vb 2
539\& use IO::Pty;
540\& use Fcntl;
541.Ve
542.Sp
543.Vb 4
544\& my $pty = new IO::Pty;
545\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
546\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
547\& close $pty;
548.Ve
549.Sp
550.Vb 3
551\& # now communicate with rxvt
552\& my $slave = $pty->slave;
553\& while (<$slave>) { print $slave "got <$_>\en" }
554.Ve
555.IP "\fB\-pe\fR \fIstring\fR" 4
556.IX Item "-pe string"
557Comma-separated list of perl extension scripts to use (or not to use) in
558this terminal instance. See resource \fBperl-ext\fR for details.
466.SH "RESOURCES (available also as long\-options)" 559.SH "RESOURCES (available also as long\-options)"
467.IX Header "RESOURCES (available also as long-options)" 560.IX Header "RESOURCES (available also as long-options)"
468Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 561Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
469options) compiled into your version. 562options) compiled into your version.
470.PP 563.PP
471There are two different methods that @@RXVT_NAME@@ can use to get the 564You can set and change the resources using X11 tools like \fBxrdb\fR. Many
472Xresource data: using the X libraries (Xrm*\-functions) or internal 565distribution do also load settings from the \fB~/.Xresources\fR file when X
473Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 566starts. @@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 567with 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 568.PP
480.Vb 5 569.Vb 5
481\& 1. system-wide app-defaults file, either locale-dependent OR global 570\& 1. system-wide app-defaults file, either locale-dependent OR global
482\& 2. app-defaults file in $XAPPLRESDIR 571\& 2. app-defaults file in $XAPPLRESDIR
483\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 572\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
484\& 4. SCREEN_RESOURCES for the current screen 573\& 4. SCREEN_RESOURCES for the current screen
485\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 574\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
486.Ve 575.Ve
487.PP 576.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 577Note 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 578names: \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 579common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
496easily configured, while the class name \fBURxvt\fR allows resources 580configured, while the class name \fBURxvt\fR allows resources unique to
497unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be 581\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
498shared between different \fB@@RXVT_NAME@@\fR configurations. If no 582configurations. If no resources are specified, suitable defaults will
499resources are specified, suitable defaults will be used. Command-line 583be used. Command-line arguments can be used to override resource
500arguments can be used to override resource settings. The following 584settings. The following resources are supported (you might want to
501resources are allowed: 585check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
586extensions not documented here):
587.IP "\fBdepth:\fR \fIbitdepth\fR" 4
588.IX Item "depth: bitdepth"
589Compile \fIfrills\fR: Attempt to find a visual with the given bit depth;
590option \fB\-depth\fR.
502.IP "\fBgeometry:\fR \fIgeom\fR" 4 591.IP "\fBgeometry:\fR \fIgeom\fR" 4
503.IX Item "geometry: geom" 592.IX Item "geometry: geom"
504Create the window with the specified X window geometry [default 80x24]; 593Create the window with the specified X window geometry [default 80x24];
505option \fB\-geometry\fR. 594option \fB\-geometry\fR.
506.IP "\fBbackground:\fR \fIcolour\fR" 4 595.IP "\fBbackground:\fR \fIcolour\fR" 4
… …
570\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 659\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
571artificial transparency. \fBFalse\fR: do not inherit the parent windows' 660artificial transparency. \fBFalse\fR: do not inherit the parent windows'
572pixmap. 661pixmap.
573.IP "\fBfading:\fR \fInumber\fR" 4 662.IP "\fBfading:\fR \fInumber\fR" 4
574.IX Item "fading: number" 663.IX Item "fading: number"
575Fade the text by the given percentage when focus is lost. 664Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
665.IP "\fBfadeColor:\fR \fIcolour\fR" 4
666.IX Item "fadeColor: colour"
667Fade to this colour, when fading is used (see \fBfading:\fR). The default
668colour is black; option \fB\-fadecolor\fR.
576.IP "\fBtintColor:\fR \fIcolour\fR" 4 669.IP "\fBtintColor:\fR \fIcolour\fR" 4
577.IX Item "tintColor: colour" 670.IX Item "tintColor: colour"
578Tint the transparent background pixmap with the given colour. 671Tint the transparent background pixmap with the given colour; option
672\&\fB\-tint\fR.
579.IP "\fBshading:\fR \fInumber\fR" 4 673.IP "\fBshading:\fR \fInumber\fR" 4
580.IX Item "shading: number" 674.IX Item "shading: number"
581Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 675Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
582image in addition to tinting it. 676image in addition to tinting it.
583.IP "\fBscrollColor:\fR \fIcolour\fR" 4 677.IP "\fBscrollColor:\fR \fIcolour\fR" 4
584.IX Item "scrollColor: colour" 678.IX Item "scrollColor: colour"
585Use the specified colour for the scrollbar [default #B2B2B2]. 679Use the specified colour for the scrollbar [default #B2B2B2].
586.IP "\fBtroughColor:\fR \fIcolour\fR" 4 680.IP "\fBtroughColor:\fR \fIcolour\fR" 4
587.IX Item "troughColor: colour" 681.IX Item "troughColor: colour"
588Use the specified colour for the scrollbar's trough area [default 682Use the specified colour for the scrollbar's trough area [default
589#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 683#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
590.IP "\fBborderColor:\fR \fIcolour\fR" 4 684.IP "\fBborderColor:\fR \fIcolour\fR" 4
591.IX Item "borderColor: colour" 685.IX Item "borderColor: colour"
592The colour of the border around the text area and between the scrollbar 686The colour of the border around the text area and between the scrollbar
593and the text. 687and the text.
594.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 688.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
600centre (percent). A scale of 0 displays the image with tiling. A scale 694centre (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 695of 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 696specifies an integer number of images in that direction. No image will
603be magnified beyond 10 times its original size. The maximum permitted 697be magnified beyond 10 times its original size. The maximum permitted
604scale is 1000. [default 0x0+50+50] 698scale 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 699.IP "\fBpath:\fR \fIpath\fR" 4
611.IX Item "path: path" 700.IX Item "path: path"
612Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 701Specify 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 702.IP "\fBfont:\fR \fIfontlist\fR" 4
616.IX Item "font: fontlist" 703.IX Item "font: fontlist"
617Select the fonts to be used. This is a comma separated list of font 704Select 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. 705that are checked in order when trying to find glyphs for characters. The
619The first font defines the cell size for characters; other fonts might 706first font defines the cell size for characters; other fonts might be
620be smaller, but not larger. A reasonable default font list is always 707smaller, but not (in general) larger. A (hopefully) reasonable default
621appended to it. option \fB\-fn\fR. 708font list is always appended to it; option \fB\-fn\fR.
622.Sp 709.Sp
623Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 710Each 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. 711optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
625.Sp 712.Sp
626In addition, each font can be prefixed with additional hints and 713In addition, each font can be prefixed with additional hints and
… …
629fonts. 716fonts.
630.Sp 717.Sp
631For example, this font resource 718For example, this font resource
632.Sp 719.Sp
633.Vb 5 720.Vb 5
634\& URxvt*font: 9x15bold,\e 721\& URxvt.font: 9x15bold,\e
635\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 722\& -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 723\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
637\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 724\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
638\& xft:Code2000:antialias=false 725\& xft:Code2000:antialias=false
639.Ve 726.Ve
… …
674\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 761\&\*(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. 762not possible, replacement fonts of the desired shape will be tried.
676.Sp 763.Sp
677If set, but empty, then this specific style is disabled and the normal 764If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 765text font will being used for the given style.
766.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
767.IX Item "intensityStyles: boolean"
768When font styles are not enabled, or this option is enabled (\fBTrue\fR,
769option \fB\-is\fR, the default), bold and italic font styles imply high
770intensity foreground/backround colours. Disabling this option (\fBFalse\fR,
771option \fB+is\fR) disables this behaviour, the high intensity colours are not
772reachable.
679.IP "\fBselectstyle:\fR \fImode\fR" 4 773.IP "\fBselectstyle:\fR \fImode\fR" 4
680.IX Item "selectstyle: mode" 774.IX Item "selectstyle: mode"
681Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 775Set 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 776xterm style with 2.20 old word selection, or anything else which gives
683xterm style selection. 777xterm style selection.
684.IP "\fBscrollstyle:\fR \fImode\fR" 4 778.IP "\fBscrollstyle:\fR \fImode\fR" 4
685.IX Item "scrollstyle: mode" 779.IX Item "scrollstyle: mode"
686Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 780Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
687the author's favourite.. 781the author's favourite.
688.IP "\fBtitle:\fR \fIstring\fR" 4 782.IP "\fBtitle:\fR \fIstring\fR" 4
689.IX Item "title: string" 783.IX Item "title: string"
690Set window title string, the default title is the command-line 784Set window title string, the default title is the command-line
691specified after the \fB\-e\fR option, if any, otherwise the application 785specified after the \fB\-e\fR option, if any, otherwise the application
692name; option \fB\-title\fR. 786name; option \fB\-title\fR.
… …
716.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 810.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
717.IX Item "print-pipe: string" 811.IX Item "print-pipe: string"
718Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 812Specify 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 813\&\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. 814\&\fBShift-Print\fR to include the scrollback as well.
815.Sp
816The string will be interpreted as if typed into the shell as\-is.
817.Sp
818Example:
819.Sp
820.Vb 1
821\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
822.Ve
823.Sp
824This creates a new file in your home directory with the screen contents
825everytime you hit \f(CW\*(C`Print\*(C'\fR.
721.IP "\fBscrollBar:\fR \fIboolean\fR" 4 826.IP "\fBscrollBar:\fR \fIboolean\fR" 4
722.IX Item "scrollBar: boolean" 827.IX Item "scrollBar: boolean"
723\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 828\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
724disable the scrollbar; option \fB+sb\fR. 829disable the scrollbar; option \fB+sb\fR.
725.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 830.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
764option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. 869option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
765.IP "\fBborderLess:\fR \fIboolean\fR" 4 870.IP "\fBborderLess:\fR \fIboolean\fR" 4
766.IX Item "borderLess: boolean" 871.IX Item "borderLess: boolean"
767Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the 872Set \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. 873\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
874.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
875.IX Item "skipBuiltinGlyphs: boolean"
876Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
877drawing characters and just rely on what the specified fonts provide. Use
878this if you have a good font and want to use its block graphic glyphs;
879option \fB\-sbg\fR.
769.IP "\fBtermName:\fR \fItermname\fR" 4 880.IP "\fBtermName:\fR \fItermname\fR" 4
770.IX Item "termName: termname" 881.IX Item "termName: termname"
771Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 882Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
772variable; option \fB\-tn\fR. 883variable; option \fB\-tn\fR.
773.IP "\fBlinespace:\fR \fInumber\fR" 4 884.IP "\fBlinespace:\fR \fInumber\fR" 4
… …
801.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 912.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
802.IX Item "pointerColor2: colour" 913.IX Item "pointerColor2: colour"
803Mouse pointer background colour. 914Mouse pointer background colour.
804.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 915.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
805.IX Item "pointerBlankDelay: number" 916.IX Item "pointerBlankDelay: number"
806Specifies number of seconds before blanking the pointer [default 2]. 917Specifies number of seconds before blanking the pointer [default 2]. Use a
918large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
807.IP "\fBbackspacekey:\fR \fIstring\fR" 4 919.IP "\fBbackspacekey:\fR \fIstring\fR" 4
808.IX Item "backspacekey: string" 920.IX Item "backspacekey: string"
809The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 921The 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 922or 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 923(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 927The string to send when the delete key (not the keypad delete key) is
816pressed. If unset it will send the sequence traditionally associated 928pressed. If unset it will send the sequence traditionally associated
817with the \fBExecute\fR key. 929with the \fBExecute\fR key.
818.IP "\fBcutchars:\fR \fIstring\fR" 4 930.IP "\fBcutchars:\fR \fIstring\fR" 4
819.IX Item "cutchars: string" 931.IX Item "cutchars: string"
820The characters used as delimiters for double-click word selection. The 932The characters used as delimiters for double-click word selection
821built-in default: 933(whitespace delimiting is added automatically if resource is given).
934.Sp
935When the selection extension is in use (the default if compiled in, see
936the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these characters
937will be created (if the resource exists, otherwise, no regex will be
938created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
939.Sp
940When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
941be used. If not specified, the built-in default is used:
822.Sp 942.Sp
823\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 943\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
824.IP "\fBpreeditType:\fR \fIstyle\fR" 4 944.IP "\fBpreeditType:\fR \fIstyle\fR" 4
825.IX Item "preeditType: style" 945.IX Item "preeditType: style"
826\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 946\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
… …
830.IP "\fBimLocale:\fR \fIname\fR" 4 950.IP "\fBimLocale:\fR \fIname\fR" 4
831.IX Item "imLocale: name" 951.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. 952The 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 953\&\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 954input extension to be able to input japanese characters while staying in
835another locale. option \fB\-imlocale\fR. 955another locale; option \fB\-imlocale\fR.
836.IP "\fBimFont:\fR \fIfontset\fR" 4 956.IP "\fBimFont:\fR \fIfontset\fR" 4
837.IX Item "imFont: fontset" 957.IX Item "imFont: fontset"
838Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or 958Specify 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 959\&\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 960by commas), i.e. it's not in the same format as the other font lists used
… …
843option \fB\-imfont\fR. 963option \fB\-imfont\fR.
844.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4 964.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
845.IX Item "tripleclickwords: boolean" 965.IX Item "tripleclickwords: boolean"
846Change the meaning of triple-click selection with the left mouse 966Change the meaning of triple-click selection with the left mouse
847button. Instead of selecting a full line it will extend the selection to 967button. Instead of selecting a full line it will extend the selection to
848the end of the logical line only. option \fB\-tcw\fR. 968the end of the logical line only; option \fB\-tcw\fR.
849.IP "\fBinsecure:\fR \fIboolean\fR" 4 969.IP "\fBinsecure:\fR \fIboolean\fR" 4
850.IX Item "insecure: boolean" 970.IX Item "insecure: boolean"
851Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 971Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
852echo arbitrary strings like the icon name or the locale. This could be 972echo arbitrary strings like the icon name or the locale. This could be
853abused if somebody gets 8\-bit\-clean access to your display, whether 973abused if somebody gets 8\-bit\-clean access to your display, whether
854throuh a mail client displaying mail bodies unfiltered or though 974through a mail client displaying mail bodies unfiltered or through
855\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 975\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
856that other terminals, including xterm, have these sequences 976default. (Note that many other terminals, including xterm, have these
857enabled by default). You can enable them by setting this boolean 977sequences enabled by default, which doesn't make it safer, though).
858resource or specifying \fB\-insecure\fR as an option. At the moment, this 978.Sp
859enabled display\-answer, locale, findfont, icon label and window title 979You can enable them by setting this boolean resource or specifying
860requests as well as dynamic menubar dispatch. 980\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
981locale, findfont, icon label and window title requests.
861.IP "\fBmodifier:\fR \fImodifier\fR" 4 982.IP "\fBmodifier:\fR \fImodifier\fR" 4
862.IX Item "modifier: modifier" 983.IX Item "modifier: modifier"
863Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 984Set 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 985\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
865\&\fB\-mod\fR. 986\&\fB\-mod\fR.
866.IP "\fBanswerbackString:\fR \fIstring\fR" 4 987.IP "\fBanswerbackString:\fR \fIstring\fR" 4
867.IX Item "answerbackString: string" 988.IX Item "answerbackString: string"
868Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 989Specify 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 990character is passed through. It may contain escape values as described
870in the entry on \fBkeysym\fR following. 991in the entry on \fBkeysym\fR following.
871.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 992.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
872.IX Item "secondaryScreen: bool" 993.IX Item "secondaryScreen: boolean"
873Turn on/off secondary screen (default enabled). 994Turn on/off secondary screen (default enabled).
874.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 995.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
875.IX Item "secondaryScroll: bool" 996.IX Item "secondaryScroll: boolean"
876Turn on/off secondary screen scroll (default enabled). If the this 997Turn on/off secondary screen scroll (default enabled). If the this
877option is enabled, scrolls on the secondary screen will change the 998option is enabled, scrolls on the secondary screen will change the
878scrollback buffer and switching to/from the secondary screen will 999scrollback buffer and switching to/from the secondary screen will
879instead scroll the screen up. 1000instead scroll the screen up.
1001.IP "\fBhold\fR: \fIboolean\fR" 4
1002.IX Item "hold: boolean"
1003Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1004will not immediately destroy its window when the program executed within
1005it exits. Instead, it will wait till it is being killed or closed by the
1006user.
880.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1007.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
881.IX Item "keysym.sym: string" 1008.IX Item "keysym.sym: string"
882Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1009Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
883intervening resource name \fBkeysym.\fR cannot be omitted. 1010intervening resource name \fBkeysym.\fR cannot be omitted.
884.Sp 1011.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, 1030\&\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, 1031\&\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 1032\&\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. 1033can start or end with whitespace.
907.Sp 1034.Sp
908Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using 1035Please 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 1036Xlib 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 1037\&\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). 1038processing).
912.Sp 1039.Sp
913You can define a range of keysyms in one shot by providing a \fIstring\fR 1040You can define a range of keysyms in one shot by providing a \fIstring\fR
914with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1041with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
915should be a character not used by the strings. 1042should be a character not used by the strings.
916.Sp 1043.Sp
… …
935.Sp 1062.Sp
936.Vb 1 1063.Vb 1
937\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 1064\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
938.Ve 1065.Ve
939.Sp 1066.Sp
1067If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1068is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1069manpage. For example, the \fIselection\fR extension (activated via
1070\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1071.Sp
1072.Vb 1
1073\& URxvt.keysym.M-C-c: perl:selection:rot13
1074.Ve
1075.Sp
1076Due the the large number of modifier combinations, a defined key mapping
1077will match if at \fIat least\fR the specified identifiers are being set, and
1078no other key mappings with those and more bits are being defined. That
1079means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1080definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1081mappings themselves.
1082.Sp
1083Unfortunately, this will override built-in key mappings. For example
1084if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1085\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1086user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1087.Sp
1088.Vb 2
1089\& URxvt.keysym.Insert: <my insert key sequence>
1090\& URxvt.keysym.S-Insert: builtin:
1091.Ve
1092.Sp
1093The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1094of modifiers. The second line re-establishes the default mapping for
1095\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1096.Sp
940The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1097The 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 1098the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
942font-switching at runtime: 1099font-switching at runtime:
943.Sp 1100.Sp
944.Vb 2 1101.Vb 2
… …
951.Sp 1108.Sp
952.Vb 2 1109.Vb 2
953\& URxvt.keysym.M-C-3: command:\e033[8;25;80t 1110\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
954\& URxvt.keysym.M-C-4: command:\e033[8;48;110t 1111\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
955.Ve 1112.Ve
1113.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1114.IX Item "perl-ext-common: string"
1115.PD 0
1116.IP "\fBperl-ext\fR: \fIstring\fR" 4
1117.IX Item "perl-ext: string"
1118.PD
1119Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1120use in this terminal instance; option \fB\-pe\fR.
1121.Sp
1122Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1123them. This can be useful to selectively disable some extensions loaded
1124by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1125example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1126\&\f(CW\*(C`selection\*(C'\fR.
1127.Sp
1128Extension names can also be followed by an argument in angle brackets
1129(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1130searchable scorllback to Alt/Meta\-s). Mentioning the same extension
1131multiple times with different arguments will pass multiple arguments to
1132the extension.
1133.Sp
1134Each extension is looked up in the library directories, loaded if
1135necessary, and bound to the current terminal instance.
1136.Sp
1137If both of these resources are the empty string, then the perl
1138interpreter will not be initialized. The idea behind two options is that
1139\&\fBperl-ext-common\fR will be used for extensions that should be available to
1140all instances, while \fBperl-ext\fR is used for specific instances.
1141.IP "\fBperl-eval\fR: \fIstring\fR" 4
1142.IX Item "perl-eval: string"
1143Perl code to be evaluated when all extensions have been registered. See
1144the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. Due to security reasons, this resource
1145will be ignored when running setuid/setgid.
1146.IP "\fBperl-lib\fR: \fIpath\fR" 4
1147.IX Item "perl-lib: path"
1148Colon-separated list of additional directories that hold extension
1149scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1150@@RXVT_NAME@@ will first look in these directories and then in
1151\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. Due to security reasons, this resource
1152will be ignored when running setuid/setgid.
1153.Sp
1154See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1155.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1156.IX Item "selection.pattern-idx: perl-regex"
1157Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1158details.
1159.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1160.IX Item "selection-autotransform.idx: perl-transform"
1161Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1162for details.
1163.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4
1164.IX Item "searchable-scrollback: keysym"
1165Sets the hotkey that starts the incremental scrollback buffer search
1166(default: \f(CW\*(C`M\-s\*(C'\fR).
1167.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1168.IX Item "urlLauncher: string"
1169Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1170\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions.
1171.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1172.IX Item "transient-for: windowid"
1173Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1174.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1175.IX Item "override-redirect: boolean"
1176Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1177it almost invisible to window managers; option \fB\-override\-redirect\fR.
956.SH "THE SCROLLBAR" 1178.SH "THE SCROLLBAR"
957.IX Header "THE SCROLLBAR" 1179.IX Header "THE SCROLLBAR"
958Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1180Lines 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 1181(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
960or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1182or 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 1209to select a word; Left triple-click to select the entire logical line
988(which can span multiple screen lines), unless modified by resource 1210(which can span multiple screen lines), unless modified by resource
989\&\fBtripleclickwords\fR. 1211\&\fBtripleclickwords\fR.
990.Sp 1212.Sp
991Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1213Starting 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 1214(Compile: \fIfrills\fR) will create a rectangular selection instead of a
993one. 1215normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from
1217the selection.
994.IP "\fBInsertion\fR:" 4 1218.IP "\fBInsertion\fR:" 4
995.IX Item "Insertion:" 1219.IX Item "Insertion:"
996Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1220Pressing 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 1221window 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. 1222Meta modifier) to be inserted as if it had been typed on the keyboard.
1223.Sp
1224Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1225inserted too.
999.SH "CHANGING FONTS" 1226.SH "CHANGING FONTS"
1000.IX Header "CHANGING FONTS" 1227.IX Header "CHANGING FONTS"
1001Changing fonts (or font sizes, respectively) via the keypad is not yet 1228Changing fonts (or font sizes, respectively) via the keypad is not yet
1002supported in rxvt\-unicode. Bug me if you need this. 1229supported in rxvt\-unicode. Bug me if you need this.
1003.PP 1230.PP
1004You can, however, switch fonts at runtime using escape sequences (and 1231You can, however, switch fonts at runtime using escape sequences, e.g.:
1005therefore using the menubar), e.g.:
1006.PP 1232.PP
1007.Vb 1 1233.Vb 1
1008\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1234\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1235.Ve
1236.PP
1237You can use keyboard shortcuts, too:
1238.PP
1239.Vb 2
1240\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1241\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
1009.Ve 1242.Ve
1010.PP 1243.PP
1011rxvt-unicode will automatically re-apply these fonts to the output so far. 1244rxvt-unicode will automatically re-apply these fonts to the output so far.
1012.SH "ISO 14755 SUPPORT" 1245.SH "ISO 14755 SUPPORT"
1013.IX Header "ISO 14755 SUPPORT" 1246.IX Header "ISO 14755 SUPPORT"
… …
1148Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1381Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1149display in it's child processes. 1382display in it's child processes.
1150.IP "\fB\s-1SHELL\s0\fR" 4 1383.IP "\fB\s-1SHELL\s0\fR" 4
1151.IX Item "SHELL" 1384.IX Item "SHELL"
1152The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR. 1385The 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 1386.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1161.IX Item "RXVT_SOCKET" 1387.IX Item "RXVT_SOCKET"
1162The unix domain socket path used by @@RXVT_NAME@@c(1) and 1388The unix domain socket path used by @@RXVT_NAME@@c(1) and
1163@@RXVT_NAME@@d(1). 1389@@RXVT_NAME@@d(1).
1164.Sp 1390.Sp
1165Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR. 1391Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1166.IP "\fB\s-1HOME\s0\fR" 4 1392.IP "\fB\s-1HOME\s0\fR" 4
1167.IX Item "HOME" 1393.IX Item "HOME"
1168Used to locate the default directory for the unix domain socket for 1394Used to locate the default directory for the unix domain socket for
1169daemon communications and to locate various resource files (such as 1395daemon communications and to locate various resource files (such as
1170\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1396\&\f(CW\*(C`.Xdefaults\*(C'\fR)
… …
1180.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1406.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1181.IX Item "/usr/lib/X11/rgb.txt" 1407.IX Item "/usr/lib/X11/rgb.txt"
1182Color names. 1408Color names.
1183.SH "SEE ALSO" 1409.SH "SEE ALSO"
1184.IX Header "SEE ALSO" 1410.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) 1411@@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" 1412.SH "CURRENT PROJECT COORDINATOR"
1194.IX Header "CURRENT PROJECT COORDINATOR" 1413.IX Header "CURRENT PROJECT COORDINATOR"
1195.IP "Project Coordinator" 4 1414.IP "Project Coordinator" 4
1196.IX Item "Project Coordinator" 1415.IX Item "Project Coordinator"
1197Marc A. Lehmann <rxvt\-unicode@schmorp.de> 1416Marc A. Lehmann <rxvt\-unicode@schmorp.de>
… …
1216.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1435.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1217.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1436.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1218Project Coordinator (changes.txt 2.21a to 2.4.5) 1437Project Coordinator (changes.txt 2.21a to 2.4.5)
1219.IP "Geoff Wing <gcw@pobox.com>" 4 1438.IP "Geoff Wing <gcw@pobox.com>" 4
1220.IX Item "Geoff Wing <gcw@pobox.com>" 1439.IX Item "Geoff Wing <gcw@pobox.com>"
1221Rewrote screen display and text selection routines. Project Coordinator 1440Rewrote screen display and text selection routines.
1441.Sp
1222(changes.txt 2.4.6 \- rxvt\-unicode) 1442Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1223.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4 1443.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1224.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>" 1444.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1225Forked rxvt\-unicode, rewrote most of the display code and internal 1445Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1226character handling to store text in unicode, improve xterm 1446extension, random hacks, numerous bugfixes and extensions.
1227compatibility and apply numerous other bugfixes and extensions.
1228.Sp 1447.Sp
1229Project Coordinator (Changes 1.0 \-) 1448Project Coordinator (Changes 1.0 \-)
1449.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1450.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1451Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

Diff Legend

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