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.63 by root, Mon Aug 7 16:17:30 2006 UTC vs.
Revision 1.71 by root, Sat Oct 27 12:09:02 2007 UTC

1.\" Automatically generated by Pod::Man 2.09 (Pod::Simple 3.04) 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "@@RXVT_NAME@@ 1" 131.IX Title "@@RXVT_NAME@@ 1"
132.TH @@RXVT_NAME@@ 1 "2006-08-07" "7.9" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 1 "2007-10-27" "8.4" "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 ]]
145.SH "FREQUENTLY ASKED QUESTIONS" 145.SH "FREQUENTLY ASKED QUESTIONS"
146.IX Header "FREQUENTLY ASKED QUESTIONS" 146.IX Header "FREQUENTLY ASKED QUESTIONS"
147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of 147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148frequently asked questions and answer to them and some common 148frequently asked questions and answer to them and some common
149problems. That document is also accessible on the World-Wide-Web at 149problems. That document is also accessible on the World-Wide-Web at
150<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>. 150<http://cvs.schmorp.de/browse/rxvt\-unicode/doc/rxvt.7.html>.
151.SH "RXVT-UNICODE VS. RXVT" 151.SH "RXVT-UNICODE VS. RXVT"
152.IX Header "RXVT-UNICODE VS. RXVT" 152.IX Header "RXVT-UNICODE VS. RXVT"
153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
154internally. That means it can store and display most scripts in the 154internally. That means it can store and display most scripts in the
155world. Being a terminal emulator, however, some things are very difficult, 155world. Being a terminal emulator, however, some things are very difficult,
156especially cursive scripts such as arabic, vertically written scripts 156especially cursive scripts such as arabic, vertically written scripts
157like mongolian or scripts requiring extremely complex combining rules, 157like mongolian or scripts requiring extremely complex combining rules,
158like tibetan or devenagari. Don't expect pretty output when using these 158like tibetan or devanagari. Don't expect pretty output when using these
159scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 159scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
160fine, though. A somewhat difficult case are right-to-left scripts, such 160fine, though. A somewhat difficult case are right-to-left scripts, such
161as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms 161as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
162belong into the application, not the terminal emulator (too many things \*(-- 162belong into the application, not the terminal emulator (too many things \*(--
163such as cursor-movement while editing \*(-- break otherwise), but that might 163such as cursor-movement while editing \*(-- break otherwise), but that might
226.IP "\fB\-rv\fR|\fB+rv\fR" 4 226.IP "\fB\-rv\fR|\fB+rv\fR" 4
227.IX Item "-rv|+rv" 227.IX Item "-rv|+rv"
228Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 228Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
229.IP "\fB\-j\fR|\fB+j\fR" 4 229.IP "\fB\-j\fR|\fB+j\fR" 4
230.IX Item "-j|+j" 230.IX Item "-j|+j"
231Turn on/off jump scrolling; resource \fBjumpScroll\fR. 231Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4 232.IP "\fB\-ss\fR|\fB+ss\fR" 4
233.IX Item "-ss|+ss"
234Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR.
235.IP "\fB\-tr\fR|\fB+tr\fR" 4
233.IX Item "-ip|+ip | -tr|+tr" 236.IX Item "-tr|+tr"
234Turn on/off inheriting parent window's pixmap. Alternative form is 237Turn on/off illusion of a transparent window background. Obsolete form of it is
235\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 238\&\fB\-ip\fR and it should not be used anymore; resource \fBtransparent\fR.
236.Sp 239.Sp
237\&\fIPlease note that transparency of any kind if completely unsupported by 240\&\fIPlease note that old resource name of \f(BIinheritPixmap\fI is obsolete and should be
238the author. Don't bug him with installation questions! Read the \s-1FAQ\s0 (man 7 241changed to \f(BItransparent\fI. Backwards compatibility support for \f(BIinheritPixmap\fI will
239@@RXVT_NAME@@)!\fR 242be phased out in future versions of rxvt!\fR
243.Sp
244\&\fIPlease address all transparency related issues to Sasha Vasko at
245sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR
240.IP "\fB\-fade\fR \fInumber\fR" 4 246.IP "\fB\-fade\fR \fInumber\fR" 4
241.IX Item "-fade number" 247.IX Item "-fade number"
242Fade the text by the given percentage when focus is lost. Small values 248Fade the text by the given percentage when focus is lost. Small values
243fade a little only, 100 completely replaces all colours by the fade 249fade a little only, 100 completely replaces all colours by the fade
244colour; resource \fBfading\fR. 250colour; resource \fBfading\fR.
247Fade to this colour when fading is used (see \fB\-fade\fR). The default colour 253Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
248is opaque black. resource \fBfadeColor\fR. 254is opaque black. resource \fBfadeColor\fR.
249.IP "\fB\-tint\fR \fIcolour\fR" 4 255.IP "\fB\-tint\fR \fIcolour\fR" 4
250.IX Item "-tint colour" 256.IX Item "-tint colour"
251Tint the transparent background pixmap with the given colour when 257Tint the transparent background pixmap with the given colour when
252transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for 258transparency is enabled with \fB\-tr\fR. This only works for
253non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be 259non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
254used to brighten or darken the image in addition to tinting it; resource 260used to brighten or darken the image in addition to tinting it.
261Please note that certain tint colours can be applied on the server\-side,
262thus yielding performance gain of two orders of magnitude. These colours are:
263blue, red, green, cyan, magenta, yellow, and those close to them; resource
255\&\fItintColor\fR. Example: 264\&\fItintColor\fR. Example:
256.Sp 265.Sp
257.Vb 1 266.Vb 1
258\& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40 267\& @@RXVT_NAME@@ -tr -tint blue -sh 40
259.Ve 268.Ve
260.IP "\fB\-sh\fR" 4 269.IP "\fB\-sh\fR \fInumber\fR" 4
261.IX Item "-sh" 270.IX Item "-sh number"
262\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 271Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
263background image in addition to tinting it (i.e. \fB\-tint\fR must be 272background image in addition to (or instead of) tinting it;
264specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). 273resource \fIshading\fR.
274.IP "\fB\-blt\fR \fIstring\fR" 4
275.IX Item "-blt string"
276Specify background blending type. If background pixmap is specified
277at the same time as transparency \- such pixmap will be blended over
278transparency image, using method specified. Supported values are :
279\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR,
280\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR,
281\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is
282alpha\-blending. Compile \fIafterimage\fR; resource \fIblendType\fR.
283.IP "\fB\-blr\fR \fIHxV\fR" 4
284.IX Item "-blr HxV"
285Apply Gaussian Blur with the specified radii to the transparent
286background image. If single number is specified \- both vertical and
287horizontal radii are considered to be the same. Setting one of the
288radii to 1 and another to a large number creates interesting effects
289on some backgrounds. Maximum radius value is 128. Compile \fIafterimage\fR;
290resource \fIblurRadius\fR.
265.IP "\fB\-bg\fR \fIcolour\fR" 4 291.IP "\fB\-bg\fR \fIcolour\fR" 4
266.IX Item "-bg colour" 292.IX Item "-bg colour"
267Window background colour; resource \fBbackground\fR. 293Window background colour; resource \fBbackground\fR.
268.IP "\fB\-fg\fR \fIcolour\fR" 4 294.IP "\fB\-fg\fR \fIcolour\fR" 4
269.IX Item "-fg colour" 295.IX Item "-fg colour"
270Window foreground colour; resource \fBforeground\fR. 296Window foreground colour; resource \fBforeground\fR.
271.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 297.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4
272.IX Item "-pixmap file[;geom]" 298.IX Item "-pixmap file[;geom]"
273Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally 299Compile \fIafterimage\fR: Specify image file for the background and also
274specify its scaling with a geometry string. Note you may need to 300optionally specify its scaling with a geometry string. Note you may need to
275add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the 301add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
276command\-line; resource \fBbackgroundPixmap\fR. 302command\-line; for more details see resource \fBbackgroundPixmap\fR.
277.IP "\fB\-cr\fR \fIcolour\fR" 4 303.IP "\fB\-cr\fR \fIcolour\fR" 4
278.IX Item "-cr colour" 304.IX Item "-cr colour"
279The cursor colour; resource \fBcursorColor\fR. 305The cursor colour; resource \fBcursorColor\fR.
280.IP "\fB\-pr\fR \fIcolour\fR" 4 306.IP "\fB\-pr\fR \fIcolour\fR" 4
281.IX Item "-pr colour" 307.IX Item "-pr colour"
298In short, to specify an X11 core font, just specify its name or prefix it 324In short, to specify an X11 core font, just specify its name or prefix it
299with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, 325with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR,
300e.g.: 326e.g.:
301.Sp 327.Sp
302.Vb 2 328.Vb 2
303\& @@RXVT_NAME@@ \-fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 329\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
304\& @@RXVT_NAME@@ \-fn "9x15bold,xft:Bitstream Vera Sans Mono" 330\& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
305.Ve 331.Ve
306.Sp 332.Sp
307See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 333See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
308section of @@RXVT_NAME@@(7). 334section of @@RXVT_NAME@@(7).
309.IP "\fB\-fb\fR \fIfontlist\fR" 4 335.IP "\fB\-fb\fR \fIfontlist\fR" 4
407resource \fBskipBuiltinGlyphs\fR. 433resource \fBskipBuiltinGlyphs\fR.
408.IP "\fB\-lsp\fR \fInumber\fR" 4 434.IP "\fB\-lsp\fR \fInumber\fR" 4
409.IX Item "-lsp number" 435.IX Item "-lsp number"
410Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 436Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
411the display. Useful to work around font rendering problems; resource 437the display. Useful to work around font rendering problems; resource
412\&\fBlinespace\fR. 438\&\fBlineSpace\fR.
413.IP "\fB\-tn\fR \fItermname\fR" 4 439.IP "\fB\-tn\fR \fItermname\fR" 4
414.IX Item "-tn termname" 440.IX Item "-tn termname"
415This option specifies the name of the terminal type to be set in the 441This option specifies the name of the terminal type to be set in the
416\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the 442\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the
417\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries; 443\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries;
428.Sp 454.Sp
429Please note that you must specify a program with arguments. If you want to 455Please note that you must specify a program with arguments. If you want to
430run shell commands, you have to specify the shell, like this: 456run shell commands, you have to specify the shell, like this:
431.Sp 457.Sp
432.Vb 1 458.Vb 1
433\& @@RXVT_NAME@@ \-e sh \-c "shell commands" 459\& @@RXVT_NAME@@ -e sh -c "shell commands"
434.Ve 460.Ve
435.IP "\fB\-title\fR \fItext\fR" 4 461.IP "\fB\-title\fR \fItext\fR" 4
436.IX Item "-title text" 462.IX Item "-title text"
437Window title (\fB\-T\fR still respected); the default title is the basename 463Window title (\fB\-T\fR still respected); the default title is the basename
438of the program specified after the \fB\-e\fR option, if any, otherwise the 464of the program specified after the \fB\-e\fR option, if any, otherwise the
463Set the font set to use for the X Input Method, see resource \fBimFont\fR 489Set the font set to use for the X Input Method, see resource \fBimFont\fR
464for more info. 490for more info.
465.IP "\fB\-tcw\fR" 4 491.IP "\fB\-tcw\fR" 4
466.IX Item "-tcw" 492.IX Item "-tcw"
467Change the meaning of triple-click selection with the left mouse 493Change the meaning of triple-click selection with the left mouse
494button. Only effective when the original (non\-perl) selection code is
468button. Instead of selecting a full line it will extend the selection the 495in\-use. Instead of selecting a full line it will extend the selection the
469end of the logical line only. resource \fBtripleclickwords\fR. 496end of the logical line only. resource \fBtripleclickwords\fR.
470.IP "\fB\-insecure\fR" 4 497.IP "\fB\-insecure\fR" 4
471.IX Item "-insecure" 498.IX Item "-insecure"
472Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 499Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
473sequences that echo strings. See the resource \fBinsecure\fR for more 500sequences that echo strings. See the resource \fBinsecure\fR for more
515Here is a short Gtk2\-perl snippet that illustrates how this option can be 542Here is a short Gtk2\-perl snippet that illustrates how this option can be
516used (a longer example is in \fIdoc/embed\fR): 543used (a longer example is in \fIdoc/embed\fR):
517.Sp 544.Sp
518.Vb 5 545.Vb 5
519\& my $rxvt = new Gtk2::Socket; 546\& my $rxvt = new Gtk2::Socket;
520\& $rxvt\->signal_connect_after (realize => sub { 547\& $rxvt->signal_connect_after (realize => sub {
521\& my $xid = $_[0]\->window\->get_xid; 548\& my $xid = $_[0]->window->get_xid;
522\& system "@@RXVT_NAME@@ \-embed $xid &"; 549\& system "@@RXVT_NAME@@ -embed $xid &";
523\& }); 550\& });
524.Ve 551.Ve
525.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 552.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
526.IX Item "-pty-fd file descriptor" 553.IX Item "-pty-fd file descriptor"
527Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty 554Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
540longer example is in \fIdoc/pty\-fd\fR): 567longer example is in \fIdoc/pty\-fd\fR):
541.Sp 568.Sp
542.Vb 2 569.Vb 2
543\& use IO::Pty; 570\& use IO::Pty;
544\& use Fcntl; 571\& use Fcntl;
545\& 572.Ve
573.Sp
574.Vb 4
546\& my $pty = new IO::Pty; 575\& my $pty = new IO::Pty;
547\& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec 576\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
548\& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&"; 577\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
549\& close $pty; 578\& close $pty;
550\& 579.Ve
580.Sp
581.Vb 3
551\& # now communicate with rxvt 582\& # now communicate with rxvt
552\& my $slave = $pty\->slave; 583\& my $slave = $pty->slave;
553\& while (<$slave>) { print $slave "got <$_>\en" } 584\& while (<$slave>) { print $slave "got <$_>\en" }
554.Ve 585.Ve
555.IP "\fB\-pe\fR \fIstring\fR" 4 586.IP "\fB\-pe\fR \fIstring\fR" 4
556.IX Item "-pe string" 587.IX Item "-pe string"
557Comma-separated list of perl extension scripts to use (or not to use) in 588Comma-separated list of perl extension scripts to use (or not to use) in
565distribution do also load settings from the \fB~/.Xresources\fR file when X 596distribution do also load settings from the \fB~/.Xresources\fR file when X
566starts. @@RXVT_NAME@@ will consult the following files/resources in order, 597starts. @@RXVT_NAME@@ will consult the following files/resources in order,
567with later settings overwriting earlier ones: 598with later settings overwriting earlier ones:
568.PP 599.PP
569.Vb 5 600.Vb 5
570\& 1. system\-wide app\-defaults file, either locale\-dependent OR global 601\& 1. system-wide app-defaults file, either locale-dependent OR global
571\& 2. app\-defaults file in $XAPPLRESDIR 602\& 2. app-defaults file in $XAPPLRESDIR
572\& 3. RESOURCE_MANAGER property on root\-window OR $HOME/.Xdefaults 603\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
573\& 4. SCREEN_RESOURCES for the current screen 604\& 4. SCREEN_RESOURCES for the current screen
574\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\-<nodename> 605\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
575.Ve 606.Ve
576.PP 607.PP
577Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class 608Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
578names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources 609names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
579common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily 610common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
627.IX Item "colorUL: colour" 658.IX Item "colorUL: colour"
628Use the specified colour to display underlined characters when the 659Use the specified colour to display underlined characters when the
629foreground colour is the default. 660foreground colour is the default.
630.IP "\fBcolorRV:\fR \fIcolour\fR" 4 661.IP "\fBcolorRV:\fR \fIcolour\fR" 4
631.IX Item "colorRV: colour" 662.IX Item "colorRV: colour"
632Use the specified colour as the background for reverse video 663Use the specified colour as the background for reverse video characters
633characters. 664when \s-1OPTION_HC\s0 is disabled (\-\-disable\-frills).
634.IP "\fBunderlineColor:\fR \fIcolour\fR" 4 665.IP "\fBunderlineColor:\fR \fIcolour\fR" 4
635.IX Item "underlineColor: colour" 666.IX Item "underlineColor: colour"
636If set, use the specified colour as the colour for the underline 667If set, use the specified colour as the colour for the underline
637itself. If unset, use the foreground colour. 668itself. If unset, use the foreground colour.
638.IP "\fBcursorColor:\fR \fIcolour\fR" 4 669.IP "\fBcursorColor:\fR \fIcolour\fR" 4
649\&\fBTrue\fR: simulate reverse video by foreground and background colours; 680\&\fBTrue\fR: simulate reverse video by foreground and background colours;
650option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option 681option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
651\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. 682\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
652.IP "\fBjumpScroll:\fR \fIboolean\fR" 4 683.IP "\fBjumpScroll:\fR \fIboolean\fR" 4
653.IX Item "jumpScroll: boolean" 684.IX Item "jumpScroll: boolean"
654\&\fBTrue\fR: specify that jump scrolling should be used. When scrolling 685\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots
655quickly, fewer screen updates are performed [default]; option \fB\-j\fR. 686of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
687has been read, resulting in fewer updates while still displaying every
688received line; option \fB\-j\fR.
689.Sp
656\&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR. 690\&\fBFalse\fR: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
691force a screen refresh on each new line it received; option \fB+j\fR.
692.IP "\fBskipScroll:\fR \fIboolean\fR" 4
693.IX Item "skipScroll: boolean"
694\&\fBTrue\fR: (the default) specify that skip scrolling should be used. When
695receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
696(around 60 times per second), resulting in far fewer updates. This can
697result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
698option \fB\-ss\fR.
699.Sp
700\&\fBFalse\fR: specify that everything is to be displayed, even
701if the refresh is too fast for the human eye to read anything (or the
702monitor to display anything); option \fB+ss\fR.
657.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 703.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
658.IX Item "inheritPixmap: boolean" 704.IX Item "inheritPixmap: boolean"
659\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 705\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
660artificial transparency. \fBFalse\fR: do not inherit the parent windows' 706artificial transparency. \fBFalse\fR: do not inherit the parent windows'
661pixmap. 707pixmap.
673.IX Item "tintColor: colour" 719.IX Item "tintColor: colour"
674Tint the transparent background pixmap with the given colour; option 720Tint the transparent background pixmap with the given colour; option
675\&\fB\-tint\fR. 721\&\fB\-tint\fR.
676.IP "\fBshading:\fR \fInumber\fR" 4 722.IP "\fBshading:\fR \fInumber\fR" 4
677.IX Item "shading: number" 723.IX Item "shading: number"
678Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 724Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image
679image in addition to tinting it. 725in addition to tinting it; option \fB\-sh\fR.
726.IP "\fBblendType:\fR \fIstring\fR" 4
727.IX Item "blendType: string"
728Specify background blending type; option \fB\-blt\fR.
729.IP "\fBblurRadius:\fR \fInumber\fR" 4
730.IX Item "blurRadius: number"
731Apply Gaussian Blurr with the specified radius to the transparent
732background image; option \fB\-blr\fR.
680.IP "\fBscrollColor:\fR \fIcolour\fR" 4 733.IP "\fBscrollColor:\fR \fIcolour\fR" 4
681.IX Item "scrollColor: colour" 734.IX Item "scrollColor: colour"
682Use the specified colour for the scrollbar [default #B2B2B2]. 735Use the specified colour for the scrollbar [default #B2B2B2].
683.IP "\fBtroughColor:\fR \fIcolour\fR" 4 736.IP "\fBtroughColor:\fR \fIcolour\fR" 4
684.IX Item "troughColor: colour" 737.IX Item "troughColor: colour"
688.IX Item "borderColor: colour" 741.IX Item "borderColor: colour"
689The colour of the border around the text area and between the scrollbar 742The colour of the border around the text area and between the scrollbar
690and the text. 743and the text.
691.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 744.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
692.IX Item "backgroundPixmap: file[;geom]" 745.IX Item "backgroundPixmap: file[;geom]"
693Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for 746Use the specified image file for the background and also optionally
694the background and also optionally specify its scaling with a geometry 747specify its scaling with a geometry string \fBWxH+X+Y\fR,
695string \fBWxH+X+Y\fR, in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the 748in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the horizontal/vertical scale (percent),
696horizontal/vertical scale (percent) and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image 749and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image centre (percent).
697centre (percent). A scale of 0 displays the image with tiling. A scale 750A scale of 0 displays the image with tiling. A scale of 1 displays the
698of 1 displays the image without any scaling. A scale of 2 to 9 751image without any scaling. A scale of 2 to 9 specifies an integer
699specifies an integer number of images in that direction. No image will 752number of images in that direction. No image will be magnified beyond
700be magnified beyond 10 times its original size. The maximum permitted 75310 times its original size. The maximum permitted scale is 1000.
701scale is 1000. [default 0x0+50+50] 754Special string of \fB\*(L"auto\*(R"\fR used as a geometry will cause image to be
755automatically scaled to match window size.
756If used in conjunction with \fB\-tr\fR option \- specified pixmap will be
757blended over transparency image using either alpha\-blending, or any
758other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option.
759[default 0x0+50+50]
702.IP "\fBpath:\fR \fIpath\fR" 4 760.IP "\fBpath:\fR \fIpath\fR" 4
703.IX Item "path: path" 761.IX Item "path: path"
704Specify the colon-delimited search path for finding \s-1XPM\s0 files. 762Specify the colon-delimited search path for finding background image files.
705.IP "\fBfont:\fR \fIfontlist\fR" 4 763.IP "\fBfont:\fR \fIfontlist\fR" 4
706.IX Item "font: fontlist" 764.IX Item "font: fontlist"
707Select the fonts to be used. This is a comma separated list of font names 765Select the fonts to be used. This is a comma separated list of font names
708that are checked in order when trying to find glyphs for characters. The 766that are checked in order when trying to find glyphs for characters. The
709first font defines the cell size for characters; other fonts might be 767first font defines the cell size for characters; other fonts might be
720.Sp 778.Sp
721For example, this font resource 779For example, this font resource
722.Sp 780.Sp
723.Vb 5 781.Vb 5
724\& URxvt.font: 9x15bold,\e 782\& URxvt.font: 9x15bold,\e
725\& \-misc\-fixed\-bold\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1,\e 783\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e
726\& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e 784\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
727\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 785\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
728\& xft:Code2000:antialias=false 786\& xft:Code2000:antialias=false
729.Ve 787.Ve
730.Sp 788.Sp
731specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually 789specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually
773intensity foreground/background colours. Disabling this option (\fBFalse\fR, 831intensity foreground/background colours. Disabling this option (\fBFalse\fR,
774option \fB+is\fR) disables this behaviour, the high intensity colours are not 832option \fB+is\fR) disables this behaviour, the high intensity colours are not
775reachable. 833reachable.
776.IP "\fBselectstyle:\fR \fImode\fR" 4 834.IP "\fBselectstyle:\fR \fImode\fR" 4
777.IX Item "selectstyle: mode" 835.IX Item "selectstyle: mode"
778Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 836Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which
779xterm style with 2.20 old word selection, or anything else which gives 837is xterm style with 2.20 old word selection, or anything else which
780xterm style selection. 838gives xterm style selection. Only effective when the original (non\-perl)
839selection code is in use.
781.IP "\fBscrollstyle:\fR \fImode\fR" 4 840.IP "\fBscrollstyle:\fR \fImode\fR" 4
782.IX Item "scrollstyle: mode" 841.IX Item "scrollstyle: mode"
783Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 842Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
784the author's favourite. 843the author's favourite.
785.IP "\fBtitle:\fR \fIstring\fR" 4 844.IP "\fBtitle:\fR \fIstring\fR" 4
794set; option \fB\-n\fR. 853set; option \fB\-n\fR.
795.IP "\fBmapAlert:\fR \fIboolean\fR" 4 854.IP "\fBmapAlert:\fR \fIboolean\fR" 4
796.IX Item "mapAlert: boolean" 855.IX Item "mapAlert: boolean"
797\&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no 856\&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no
798de-iconify (map) on receipt of a bell character [default]. 857de-iconify (map) on receipt of a bell character [default].
858.IP "\fBurgentOnBell:\fR \fIboolean\fR" 4
859.IX Item "urgentOnBell: boolean"
860\&\fBTrue\fR: set the urgency hint for the wm on receipt of a bell character.
861\&\fBFalse\fR: do not set the urgency hint [default].
799.IP "\fBvisualBell:\fR \fIboolean\fR" 4 862.IP "\fBvisualBell:\fR \fIboolean\fR" 4
800.IX Item "visualBell: boolean" 863.IX Item "visualBell: boolean"
801\&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR. 864\&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR.
802\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR. 865\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR.
803.IP "\fBloginShell:\fR \fIboolean\fR" 4 866.IP "\fBloginShell:\fR \fIboolean\fR" 4
819The string will be interpreted as if typed into the shell as\-is. 882The string will be interpreted as if typed into the shell as\-is.
820.Sp 883.Sp
821Example: 884Example:
822.Sp 885.Sp
823.Vb 1 886.Vb 1
824\& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 887\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
825.Ve 888.Ve
826.Sp 889.Sp
827This creates a new file in your home directory with the screen contents 890This creates a new file in your home directory with the screen contents
828every time you hit \f(CW\*(C`Print\*(C'\fR. 891every time you hit \f(CW\*(C`Print\*(C'\fR.
829.IP "\fBscrollBar:\fR \fIboolean\fR" 4 892.IP "\fBscrollBar:\fR \fIboolean\fR" 4
882option \fB\-sbg\fR. 945option \fB\-sbg\fR.
883.IP "\fBtermName:\fR \fItermname\fR" 4 946.IP "\fBtermName:\fR \fItermname\fR" 4
884.IX Item "termName: termname" 947.IX Item "termName: termname"
885Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 948Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
886variable; option \fB\-tn\fR. 949variable; option \fB\-tn\fR.
887.IP "\fBlinespace:\fR \fInumber\fR" 4 950.IP "\fBlineSpace:\fR \fInumber\fR" 4
888.IX Item "linespace: number" 951.IX Item "lineSpace: number"
889Specifies number of lines (pixel height) to insert between each row of 952Specifies number of lines (pixel height) to insert between each row of
890the display [default 0]; option \fB\-lsp\fR. 953the display [default 0]; option \fB\-lsp\fR.
891.IP "\fBmeta8:\fR \fIboolean\fR" 4 954.IP "\fBmeta8:\fR \fIboolean\fR" 4
892.IX Item "meta8: boolean" 955.IX Item "meta8: boolean"
893\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR: 956\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
933.IP "\fBcutchars:\fR \fIstring\fR" 4 996.IP "\fBcutchars:\fR \fIstring\fR" 4
934.IX Item "cutchars: string" 997.IX Item "cutchars: string"
935The characters used as delimiters for double-click word selection 998The characters used as delimiters for double-click word selection
936(whitespace delimiting is added automatically if resource is given). 999(whitespace delimiting is added automatically if resource is given).
937.Sp 1000.Sp
938When the selection extension is in use (the default if compiled in, see 1001When the perl selection extension is in use (the default if compiled
939the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these characters 1002in, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these
940will be created (if the resource exists, otherwise, no regex will be 1003characters will be created (if the resource exists, otherwise, no regex
941created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used. 1004will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
942.Sp 1005.Sp
943When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can 1006When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
944be used. If not specified, the built-in default is used: 1007be used. If not specified, the built-in default is used:
945.Sp 1008.Sp
946\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 1009\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
995.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4 1058.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
996.IX Item "secondaryScreen: boolean" 1059.IX Item "secondaryScreen: boolean"
997Turn on/off secondary screen (default enabled). 1060Turn on/off secondary screen (default enabled).
998.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4 1061.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
999.IX Item "secondaryScroll: boolean" 1062.IX Item "secondaryScroll: boolean"
1000Turn on/off secondary screen scroll (default enabled). If the this 1063Turn on/off secondary screen scroll (default enabled). If this
1001option is enabled, scrolls on the secondary screen will change the 1064option is enabled, scrolls on the secondary screen will change the
1002scrollback buffer and switching to/from the secondary screen will 1065scrollback buffer and switching to/from the secondary screen will
1003instead scroll the screen up. 1066instead scroll the screen up.
1004.IP "\fBhold\fR: \fIboolean\fR" 4 1067.IP "\fBhold\fR: \fIboolean\fR" 4
1005.IX Item "hold: boolean" 1068.IX Item "hold: boolean"
1027searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and 1090searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
1028omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex 1091omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
1029keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not 1092keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
1030performed in an exact manner; however, the closest match is assured. 1093performed in an exact manner; however, the closest match is assured.
1031.Sp 1094.Sp
1032\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace, 1095\&\fIstring\fR may contain escape values (\f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\e000\*(C'\fR: octal
1033\&\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, 1096number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for futher details.
1034\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
1035\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
1036can start or end with whitespace.
1037.Sp
1038Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1039Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1040\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1041processing).
1042.Sp 1097.Sp
1043You can define a range of keysyms in one shot by providing a \fIstring\fR 1098You can define a range of keysyms in one shot by providing a \fIstring\fR
1044with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/' 1099with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
1045should be a character not used by the strings. 1100should be a character not used by the strings.
1046.Sp 1101.Sp
1047Its usage can be demonstrated by an example: 1102Its usage can be demonstrated by an example:
1048.Sp 1103.Sp
1049.Vb 1 1104.Vb 1
1050\& URxvt.keysym.M\-C\-0x61: list|\e033<M\-C\-|abc|> 1105\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
1051.Ve 1106.Ve
1052.Sp 1107.Sp
1053The above line is equivalent to the following three lines: 1108The above line is equivalent to the following three lines:
1054.Sp 1109.Sp
1055.Vb 3 1110.Vb 3
1056\& URxvt.keysym.Meta\-Control\-0x61: \e033<M\-C\-a> 1111\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
1057\& URxvt.keysym.Meta\-Control\-0x62: \e033<M\-C\-b> 1112\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
1058\& URxvt.keysym.Meta\-Control\-0x63: \e033<M\-C\-c> 1113\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
1059.Ve 1114.Ve
1060.Sp 1115.Sp
1061If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR 1116If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
1062is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1117is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1063example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR 1118example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
1064when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1065.Sp 1120.Sp
1066.Vb 1 1121.Vb 1
1067\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007 1122\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
1068.Ve 1123.Ve
1069.Sp 1124.Sp
1070If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR 1125If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1071is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3) 1126is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1072manpage. For example, the \fIselection\fR extension (activated via 1127manpage. For example, the \fIselection\fR extension (activated via
1073\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events: 1128\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1074.Sp 1129.Sp
1075.Vb 1 1130.Vb 1
1076\& URxvt.keysym.M\-C\-c: perl:selection:rot13 1131\& URxvt.keysym.M-C-c: perl:selection:rot13
1077.Ve 1132.Ve
1078.Sp 1133.Sp
1079Due the the large number of modifier combinations, a defined key mapping 1134Due the the large number of modifier combinations, a defined key mapping
1080will match if at \fIat least\fR the specified identifiers are being set, and 1135will match if at \fIat least\fR the specified identifiers are being set, and
1081no other key mappings with those and more bits are being defined. That 1136no other key mappings with those and more bits are being defined. That
1088\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the 1143\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1089user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: 1144user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1090.Sp 1145.Sp
1091.Vb 2 1146.Vb 2
1092\& URxvt.keysym.Insert: <my insert key sequence> 1147\& URxvt.keysym.Insert: <my insert key sequence>
1093\& URxvt.keysym.S\-Insert: builtin: 1148\& URxvt.keysym.S-Insert: builtin:
1094.Ve 1149.Ve
1095.Sp 1150.Sp
1096The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination 1151The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1097of modifiers. The second line re-establishes the default mapping for 1152of modifiers. The second line re-establishes the default mapping for
1098\&\f(CW\*(C`Shift\-Insert\*(C'\fR. 1153\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1100The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1155The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1101the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1156the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1102font-switching at runtime: 1157font-switching at runtime:
1103.Sp 1158.Sp
1104.Vb 2 1159.Vb 2
1105\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007 1160\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
1106\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007 1161\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
1107.Ve 1162.Ve
1108.Sp 1163.Sp
1109Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1164Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1110info): 1165info):
1111.Sp 1166.Sp
1112.Vb 2 1167.Vb 2
1113\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t 1168\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
1114\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t 1169\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
1115.Ve 1170.Ve
1116.IP "\fBperl-ext-common\fR: \fIstring\fR" 4 1171.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1117.IX Item "perl-ext-common: string" 1172.IX Item "perl-ext-common: string"
1118.PD 0 1173.PD 0
1119.IP "\fBperl-ext\fR: \fIstring\fR" 4 1174.IP "\fBperl-ext\fR: \fIstring\fR" 4
1168Sets the hotkey that starts the incremental scrollback buffer search 1223Sets the hotkey that starts the incremental scrollback buffer search
1169(default: \f(CW\*(C`M\-s\*(C'\fR). 1224(default: \f(CW\*(C`M\-s\*(C'\fR).
1170.IP "\fBurlLauncher\fR: \fIstring\fR" 4 1225.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1171.IX Item "urlLauncher: string" 1226.IX Item "urlLauncher: string"
1172Specifies the program to be started with a \s-1URL\s0 argument. Used by the 1227Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1173\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions. 1228\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions.
1174.IP "\fBtransient-for\fR: \fIwindowid\fR" 4 1229.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1175.IX Item "transient-for: windowid" 1230.IX Item "transient-for: windowid"
1176Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id. 1231Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1177.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4 1232.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1178.IX Item "override-redirect: boolean" 1233.IX Item "override-redirect: boolean"
1179Compile \fIfrills\fR: Sets override-redirect for the terminal window, making 1234Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1180it almost invisible to window managers; option \fB\-override\-redirect\fR. 1235it almost invisible to window managers; option \fB\-override\-redirect\fR.
1236.IP "\fBiso14755_52:\fR \fIboolean\fR" 4
1237.IX Item "iso14755_52: boolean"
1238Turn on/off \s-1ISO\s0 14755 5.2 mode (default enabled).
1181.SH "THE SCROLLBAR" 1239.SH "THE SCROLLBAR"
1182.IX Header "THE SCROLLBAR" 1240.IX Header "THE SCROLLBAR"
1183Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1241Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1184(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1242(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1185or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1243or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
1199disabled \*(-- on the assumption that we are using a fullscreen 1257disabled \*(-- on the assumption that we are using a fullscreen
1200application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR 1258application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
1201(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the 1259(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
1202up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down), 1260up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
1203respectively. 1261respectively.
1204.SH "TEXT SELECTION AND INSERTION" 1262.SH "THE SELECTION: SELECTING AND PASTING TEXT"
1205.IX Header "TEXT SELECTION AND INSERTION" 1263.IX Header "THE SELECTION: SELECTING AND PASTING TEXT"
1206The behaviour of text selection and insertion mechanism is similar to 1264The behaviour of text selection and insertion/pasting mechanism is similar
1207\&\fIxterm\fR(1). 1265to \fIxterm\fR(1).
1208.IP "\fBSelection\fR:" 4 1266.IP "\fBSelecting\fR:" 4
1209.IX Item "Selection:" 1267.IX Item "Selecting:"
1210Left click at the beginning of the region, drag to the end of the region 1268Left click at the beginning of the region, drag to the end of the region
1211and release; Right click to extend the marked region; Left double-click 1269and release; Right click to extend the marked region; Left double-click
1212to select a word; Left triple-click to select the entire logical line 1270to select a word; Left triple-click to select the entire logical line
1213(which can span multiple screen lines), unless modified by resource 1271(which can span multiple screen lines), unless modified by resource
1214\&\fBtripleclickwords\fR. 1272\&\fBtripleclickwords\fR.
1216Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1274Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
1217(Compile: \fIfrills\fR) will create a rectangular selection instead of a 1275(Compile: \fIfrills\fR) will create a rectangular selection instead of a
1218normal one. In this mode, every selected row becomes its own line in the 1276normal one. In this mode, every selected row becomes its own line in the
1219selection, and trailing whitespace is visually underlined and removed from 1277selection, and trailing whitespace is visually underlined and removed from
1220the selection. 1278the selection.
1221.IP "\fBInsertion\fR:" 4 1279.IP "\fBPasting\fR:" 4
1222.IX Item "Insertion:" 1280.IX Item "Pasting:"
1223Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR 1281Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
1224window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the 1282window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the
1225Meta modifier) to be inserted as if it had been typed on the keyboard. 1283\&\fBMeta\fR modifier) to be inserted as if it had been typed on the keyboard.
1226.Sp 1284.Sp
1227Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be 1285Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1228inserted too. 1286inserted too.
1229.SH "CHANGING FONTS" 1287.SH "CHANGING FONTS"
1230.IX Header "CHANGING FONTS" 1288.IX Header "CHANGING FONTS"
1238.Ve 1296.Ve
1239.PP 1297.PP
1240You can use keyboard shortcuts, too: 1298You can use keyboard shortcuts, too:
1241.PP 1299.PP
1242.Vb 2 1300.Vb 2
1243\& URxvt.keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007 1301\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1244\& URxvt.keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 1302\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
1245.Ve 1303.Ve
1246.PP 1304.PP
1247rxvt-unicode will automatically re-apply these fonts to the output so far. 1305rxvt-unicode will automatically re-apply these fonts to the output so far.
1248.SH "ISO 14755 SUPPORT" 1306.SH "ISO 14755 SUPPORT"
1249.IX Header "ISO 14755 SUPPORT" 1307.IX Header "ISO 14755 SUPPORT"
1250\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1308\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1251and character codes using the keyboard. It consists of 4 parts. The 1309and character codes using the keyboard. It consists of 4 parts. The
1252first part is available rxvt-unicode has been compiled with 1310first part is available if rxvt-unicode has been compiled with
1253\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1311\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1254with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1312with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1255.IP "\(bu" 4
12565.1: Basic method 1313.IP "* 5.1: Basic method" 4
1257.Sp 1314.IX Item "5.1: Basic method"
1258This allows you to enter unicode characters using their hexcode. 1315This allows you to enter unicode characters using their hexcode.
1259.Sp 1316.Sp
1260Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1317Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
1261hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will 1318hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
1262commit the character as if it were typed directly. While holding down 1319commit the character as if it were typed directly. While holding down
1267As an example of use, imagine a business card with a japanese e\-mail 1324As an example of use, imagine a business card with a japanese e\-mail
1268address, which you cannot type. Fortunately, the card has the e\-mail 1325address, which you cannot type. Fortunately, the card has the e\-mail
1269address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily 1326address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
1270by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR, 1327by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR,
1271followed by releasing the modifier keys. 1328followed by releasing the modifier keys.
1272.IP "\(bu" 4
12735.2: Keyboard symbols entry method 1329.IP "* 5.2: Keyboard symbols entry method" 4
1274.Sp 1330.IX Item "5.2: Keyboard symbols entry method"
1275This mode lets you input characters representing the keycap symbols of 1331This mode lets you input characters representing the keycap symbols of
1276your keyboard, if representable in the current locale encoding. 1332your keyboard, if representable in the current locale encoding.
1277.Sp 1333.Sp
1278Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1334Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1279them. The next special key (cursor keys, home etc.) you enter will not 1335them. The next special key (cursor keys, home etc.) you enter will not
1280invoke its usual function but instead will insert the corresponding 1336invoke its usual function but instead will insert the corresponding
1281keycap symbol. The symbol will only be entered when the key has been 1337keycap symbol. The symbol will only be entered when the key has been
1282released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1338released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1283\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1339\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1284reverse tab (Shift\-Tab). 1340reverse tab (Shift\-Tab).
1285.IP "\(bu" 4
12865.3: Screen-selection entry method 1341.IP "* 5.3: Screen-selection entry method" 4
1287.Sp 1342.IX Item "5.3: Screen-selection entry method"
1288While this is implemented already (it's basically the selection 1343While this is implemented already (it's basically the selection
1289mechanism), it could be extended by displaying a unicode character map. 1344mechanism), it could be extended by displaying a unicode character map.
1290.IP "\(bu" 4
12915.4: Feedback method for identifying displayed characters for later input 1345.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4
1292.Sp 1346.IX Item "5.4: Feedback method for identifying displayed characters for later input"
1293This method lets you display the unicode character code associated with 1347This method lets you display the unicode character code associated with
1294characters already displayed. 1348characters already displayed.
1295.Sp 1349.Sp
1296You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1350You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
1297pressing and holding the left mouse button and moving around. The unicode 1351pressing and holding the left mouse button and moving around. The unicode
1336color14 (bright cyan) = Cyan 1390color14 (bright cyan) = Cyan
1337color15 (bright white) = White 1391color15 (bright white) = White
1338foreground = Black 1392foreground = Black
1339background = White 1393background = White
1340.TE 1394.TE
1395
1341.PP 1396.PP
1342It is also possible to specify the colour values of \fBforeground\fR, 1397It is also possible to specify the colour values of \fBforeground\fR,
1343\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1398\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1344a number 0\-15, as a convenient shorthand to reference the colour name of 1399a number 0\-15, as a convenient shorthand to reference the colour name of
1345color0\-color15. 1400color0\-color15.
1366If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1421If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1367their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR 1422their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1368(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications, 1423(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1369in addition to the ones provided by X, where the additional A component 1424in addition to the ones provided by X, where the additional A component
1370specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely 1425specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1371transparent). You can also prefix any color with \f(CW\*(C`[a]\*(C'\fR, where \f(CW\*(C`a\*(C'\fR is on 1426transparent). You can also prefix any color with \f(CW\*(C`[percent]\*(C'\fR, where
1372to four hex digits specifiying the opacity value. 1427\&\f(CW\*(C`percent\*(C'\fR is a decimal percentage (0\-100) that specifies the opacity of
1428the color, where \f(CW0\fR is completely transparent and \f(CW100\fR is completelxy
1429opaque.
1373.PP 1430.PP
1374You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that 1431You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1375your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting 1432your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1376\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around. 1433\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1377.PP 1434.PP
1378For example, the following selects an almost completely transparent red 1435For example, the following selects an almost completely transparent red
1379background, and an almost opaque pink foreground: 1436background, and an almost opaque pink foreground:
1380.PP 1437.PP
1381.Vb 1 1438.Vb 1
1382\& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/2222 \-fg "[e]pink" 1439\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1383.Ve 1440.Ve
1384.PP 1441.PP
1385\&\fIPlease note that transparency of any kind if completely unsupported by 1442\&\fIPlease note that transparency of any kind if completely unsupported by
1386the author. Don't bug him with installation questions!\fR 1443the author. Don't bug him with installation questions!\fR
1387.SH "ENVIRONMENT" 1444.SH "ENVIRONMENT"
1392Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via 1449Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1393resources or on the command line. 1450resources or on the command line.
1394.IP "\fB\s-1COLORTERM\s0\fR" 4 1451.IP "\fB\s-1COLORTERM\s0\fR" 4
1395.IX Item "COLORTERM" 1452.IX Item "COLORTERM"
1396Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was 1453Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1397compiled with \s-1XPM\s0 support, and optionally with the added extension 1454compiled with background image support, and optionally with the added
1398\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. 1455extension \f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome
1456screen.
1399.IP "\fB\s-1COLORFGBG\s0\fR" 4 1457.IP "\fB\s-1COLORFGBG\s0\fR" 4
1400.IX Item "COLORFGBG" 1458.IX Item "COLORFGBG"
1401Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is 1459Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is
1402the colour code used as default foreground/text colour (or the string 1460the colour code used as default foreground/text colour (or the string
1403\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be 1461\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1404used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the 1462used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1405string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@ 1463string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@
1406was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can 1464was compiled with background image support. Libraries like \f(CW\*(C`ncurses\*(C'\fR
1407(and do) use this information to optimize screen output. 1465and \f(CW\*(C`slang\*(C'\fR can (and do) use this information to optimize screen output.
1408.IP "\fB\s-1WINDOWID\s0\fR" 4 1466.IP "\fB\s-1WINDOWID\s0\fR" 4
1409.IX Item "WINDOWID" 1467.IX Item "WINDOWID"
1410Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel 1468Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1411window, which usually has subwindows for the scrollbar, the terminal 1469window, which usually has subwindows for the scrollbar, the terminal
1412window and so on). 1470window and so on).
1424.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1482.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1425.IX Item "RXVT_SOCKET" 1483.IX Item "RXVT_SOCKET"
1426The unix domain socket path used by @@RXVT_NAME@@c(1) and 1484The unix domain socket path used by @@RXVT_NAME@@c(1) and
1427@@RXVT_NAME@@d(1). 1485@@RXVT_NAME@@d(1).
1428.Sp 1486.Sp
1429Default \fI\f(CI$HOME\fI/.rxvt\-unicode\-\fI<nodename\fI\fR. 1487Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1430.IP "\fB\s-1HOME\s0\fR" 4 1488.IP "\fB\s-1HOME\s0\fR" 4
1431.IX Item "HOME" 1489.IX Item "HOME"
1432Used to locate the default directory for the unix domain socket for 1490Used to locate the default directory for the unix domain socket for
1433daemon communications and to locate various resource files (such as 1491daemon communications and to locate various resource files (such as
1434\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1492\&\f(CW\*(C`.Xdefaults\*(C'\fR)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines