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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC vs.
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC

17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 108
104Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ss>|B<+ss>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 118
119=item B<-tr>|B<+tr>
120
121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-ip> and it should not be used anymore; resource B<transparent>.
123
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126be phased out in future versions of rxvt!>
127
128I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 130
115=item B<-fade> I<number> 131=item B<-fade> I<number>
116 132
117Fade the text by the given percentage when focus is lost. Small values 133Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 134fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 135colour; resource B<fading>.
120 136
121=item B<-fadecolor> I<colour> 137=item B<-fadecolor> I<colour>
122 138
123Fade to this colour when fading is used (see B<-fade>). The default colour 139Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 140is opaque black. resource B<fadeColor>.
125 141
126=item B<-tint> I<colour> 142=item B<-tint> I<colour>
127 143
128Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 145transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 146non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 147used to brighten or darken the image in addition to tinting it.
148Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 152I<tintColor>. Example:
133 153
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 155
136=item B<-sh> 156=item B<-sh> I<number>
137 157
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 159background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 160resource I<shading>.
161
162=item B<-blt> I<string>
163
164Specify background blending type. If background pixmap is specified
165at the same time as transparency - such pixmap will be blended over
166transparency image, using method specified. Supported values are :
167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170alpha-blending. Compile I<afterimage>; resource I<blendType>.
171
172=item B<-blr> I<HxV>
173
174Apply Gaussian Blur with the specified radii to the transparent
175background image. If single number is specified - both vertical and
176horizontal radii are considered to be the same. Setting one of the
177radii to 1 and another to a large number creates interesting effects
178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>.
141 180
142=item B<-bg> I<colour> 181=item B<-bg> I<colour>
143 182
144Window background colour; resource B<background>. 183Window background colour; resource B<background>.
145 184
146=item B<-fg> I<colour> 185=item B<-fg> I<colour>
147 186
148Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
149 188
150=item B<-pixmap> I<file[;geom]> 189=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 190
152Compile I<XPM>: Specify XPM file for the background and also optionally 191Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 192optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
156 195
157=item B<-cr> I<colour> 196=item B<-cr> I<colour>
158 197
159The cursor colour; resource B<cursorColor>. 198The cursor colour; resource B<cursorColor>.
160 199
177that are checked in order when trying to find glyphs for characters. The 216that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 217first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 218smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 219font list is always appended to it. See resource B<font> for more details.
181 220
182In short, to specify an X11 core font, just specify it's name or prefix it 221In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 222with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 223e.g.:
185 224
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 225 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 226 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
313 352
314=item B<-lsp> I<number> 353=item B<-lsp> I<number>
315 354
316Compile I<frills>: Lines (pixel height) to insert between each row of 355Compile I<frills>: Lines (pixel height) to insert between each row of
317the display. Useful to work around font rendering problems; resource 356the display. Useful to work around font rendering problems; resource
318B<linespace>. 357B<lineSpace>.
319 358
320=item B<-tn> I<termname> 359=item B<-tn> I<termname>
321 360
322This option specifies the name of the terminal type to be set in the 361This option specifies the name of the terminal type to be set in the
323B<TERM> environment variable. This terminal type must exist in the 362B<TERM> environment variable. This terminal type must exist in the
377for more info. 416for more info.
378 417
379=item B<-tcw> 418=item B<-tcw>
380 419
381Change the meaning of triple-click selection with the left mouse 420Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is
382button. Instead of selecting a full line it will extend the selection the 422in-use. Instead of selecting a full line it will extend the selection the
383end of the logical line only. resource B<tripleclickwords>. 423end of the logical line only. resource B<tripleclickwords>.
384 424
385=item B<-insecure> 425=item B<-insecure>
386 426
387Enable "insecure" mode, which currently enables most of the escape 427Enable "insecure" mode, which currently enables most of the escape
415 455
416Remap a key symbol. See resource B<keysym>. 456Remap a key symbol. See resource B<keysym>.
417 457
418=item B<-embed> I<windowid> 458=item B<-embed> I<windowid>
419 459
420Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 460Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
421which enables applications to easily embed a terminal. 461which enables applications to easily embed a terminal.
422 462
423Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 463Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
424shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 464shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
425quite a bit, so don't expect it to keep some specific state. It's best to 465quite a bit, so don't expect it to keep some specific state. It's best to
428The window will not be destroyed when @@RXVT_NAME@@ exits. 468The window will not be destroyed when @@RXVT_NAME@@ exits.
429 469
430It might be useful to know that @@RXVT_NAME@@ will not close file 470It might be useful to know that @@RXVT_NAME@@ will not close file
431descriptors passed to it (except for stdin/out/err, of course), so you 471descriptors passed to it (except for stdin/out/err, of course), so you
432can use file descriptors to communicate with the programs within the 472can use file descriptors to communicate with the programs within the
433terminal. This works regardless of wether the C<-embed> option was used or 473terminal. This works regardless of whether the C<-embed> option was used or
434not. 474not.
435 475
436Here is a short Gtk2-perl snippet that illustrates how this option can be 476Here is a short Gtk2-perl snippet that illustrates how this option can be
437used (a longer example is in F<doc/embed>): 477used (a longer example is in F<doc/embed>):
438 478
443 }); 483 });
444 484
445=item B<-pty-fd> I<file descriptor> 485=item B<-pty-fd> I<file descriptor>
446 486
447Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 487Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
448pair but instead use the given filehandle as the tty master. This is 488pair but instead use the given file descriptor as the tty master. This is
449useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 489useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
450without having to run a program within it. 490without having to run a program within it.
451 491
452If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 492If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
453entries and will not tinker with pty/tty permissions - you have to do that 493entries and will not tinker with pty/tty permissions - you have to do that
505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 545check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here): 546extensions not documented here):
507 547
508=over 4 548=over 4
509 549
550=item B<depth:> I<bitdepth>
551
552Compile I<xft>: Attempt to find a visual with the given bit depth;
553option B<-depth>.
554
510=item B<geometry:> I<geom> 555=item B<geometry:> I<geom>
511 556
512Create the window with the specified X window geometry [default 80x24]; 557Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 558option B<-geometry>.
514 559
550Use the specified colour to display underlined characters when the 595Use the specified colour to display underlined characters when the
551foreground colour is the default. 596foreground colour is the default.
552 597
553=item B<colorRV:> I<colour> 598=item B<colorRV:> I<colour>
554 599
555Use the specified colour as the background for reverse video 600Use the specified colour as the background for reverse video characters
556characters. 601when OPTION_HC is disabled (--disable-frills).
557 602
558=item B<underlineColor:> I<colour> 603=item B<underlineColor:> I<colour>
559 604
560If set, use the specified colour as the colour for the underline 605If set, use the specified colour as the colour for the underline
561itself. If unset, use the foreground colour. 606itself. If unset, use the foreground colour.
577option B<-rv>. B<False>: regular screen colours [default]; option 622option B<-rv>. B<False>: regular screen colours [default]; option
578B<+rv>. See note in B<COLORS AND GRAPHICS> section. 623B<+rv>. See note in B<COLORS AND GRAPHICS> section.
579 624
580=item B<jumpScroll:> I<boolean> 625=item B<jumpScroll:> I<boolean>
581 626
582B<True>: specify that jump scrolling should be used. When scrolling 627B<True>: specify that jump scrolling should be used. When receiving lots
583quickly, fewer screen updates are performed [default]; option B<-j>. 628of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
629has been read, resulting in fewer updates while still displaying every
630received line; option B<-j>.
631
584B<False>: specify that smooth scrolling should be used; option B<+j>. 632B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
633force a screen refresh on each new line it received; option B<+j>.
634
635=item B<skipScroll:> I<boolean>
636
637B<True>: (the default) specify that skip scrolling should be used. When
638receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
639(around 60 times per second), resulting in far fewer updates. This can
640result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
641option B<-ss>.
642
643B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>.
585 646
586=item B<inheritPixmap:> I<boolean> 647=item B<inheritPixmap:> I<boolean>
587 648
588B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: make the background inherit the parent windows' pixmap, giving
589artificial transparency. B<False>: do not inherit the parent windows' 650artificial transparency. B<False>: do not inherit the parent windows'
590pixmap. 651pixmap.
591 652
653I<Please note that transparency of any kind if completely unsupported by
654the author. Don't bug him with installation questions!>
655
592=item B<fading:> I<number> 656=item B<fading:> I<number>
593 657
594Fade the text by the given percentage when focus is lost; option B<-fade>. 658Fade the text by the given percentage when focus is lost; option B<-fade>.
595 659
596=item B<fadeColor:> I<colour> 660=item B<fadeColor:> I<colour>
603Tint the transparent background pixmap with the given colour; option 667Tint the transparent background pixmap with the given colour; option
604B<-tint>. 668B<-tint>.
605 669
606=item B<shading:> I<number> 670=item B<shading:> I<number>
607 671
608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 672Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
609image in addition to tinting it. 673in addition to tinting it; option B<-sh>.
674
675=item B<blendType:> I<string>
676
677Specify background blending type; option B<-blt>.
678
679=item B<blurRadius:> I<number>
680
681Apply Gaussian Blurr with the specified radius to the transparent
682background image; option B<-blr>.
610 683
611=item B<scrollColor:> I<colour> 684=item B<scrollColor:> I<colour>
612 685
613Use the specified colour for the scrollbar [default #B2B2B2]. 686Use the specified colour for the scrollbar [default #B2B2B2].
614 687
620=item B<borderColor:> I<colour> 693=item B<borderColor:> I<colour>
621 694
622The colour of the border around the text area and between the scrollbar 695The colour of the border around the text area and between the scrollbar
623and the text. 696and the text.
624 697
625=item B<backgroundPixmap:> I<file[;geom]> 698=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
626 699
627Use the specified XPM file (note the `.xpm' extension is optional) for 700Use the specified image file for the background and also optionally
628the background and also optionally specify its scaling with a geometry 701specify its scaling with a geometry string B<WxH+X+Y>,
629string B<WxH+X+Y>, in which B<"W" / "H"> specify the 702in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
630horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 703and B<"X" / "Y"> locate the image centre (percent).
631centre (percent). A scale of 0 displays the image with tiling. A scale 704A scale of 0 displays the image with tiling. A scale of 1 displays the
632of 1 displays the image without any scaling. A scale of 2 to 9 705image without any scaling. A scale of 2 to 9 specifies an integer
633specifies an integer number of images in that direction. No image will 706number of images in that direction. No image will be magnified beyond
634be magnified beyond 10 times its original size. The maximum permitted 70710 times its original size. The maximum permitted scale is 1000.
635scale is 1000. [default 0x0+50+50] 708Additional operations can be specified after colon B<:op1:op2...>.
709Supported operations are:
710 B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0,
711 B<"propscale"> - will scale image keeping proportions,
712 B<"auto"> - will scale image to match window size. Equivalent to 100x100;
713 B<"hscale"> - will scale image horizontally to the window size;
714 B<"vscale"> - will scale image vertically to the window size;
715 B<"scale"> - will scale image to match window size;
716 B<"root"> - will tile image as if it was a root window background, auto-adjusting
717 whenever terminal window moves.
718
719If used in conjunction with B<-tr> option - specified pixmap will be
720blended over transparency image using either alpha-blending, or any
721other blending type, specified with B<-blt "type"> option.
722[default 0x0+50+50]
636 723
637=item B<path:> I<path> 724=item B<path:> I<path>
638 725
639Specify the colon-delimited search path for finding XPM files. 726Specify the colon-delimited search path for finding background image files.
640 727
641=item B<font:> I<fontlist> 728=item B<font:> I<fontlist>
642 729
643Select the fonts to be used. This is a comma separated list of font names 730Select the fonts to be used. This is a comma separated list of font names
644that are checked in order when trying to find glyphs for characters. The 731that are checked in order when trying to find glyphs for characters. The
702 789
703=item B<intensityStyles:> I<boolean> 790=item B<intensityStyles:> I<boolean>
704 791
705When font styles are not enabled, or this option is enabled (B<True>, 792When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high 793option B<-is>, the default), bold and italic font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 794intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 795option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 796reachable.
710 797
711=item B<selectstyle:> I<mode> 798=item B<selectstyle:> I<mode>
712 799
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is 800Set mouse selection style to B<old> which is 2.20, B<oldword> which
714xterm style with 2.20 old word selection, or anything else which gives 801is xterm style with 2.20 old word selection, or anything else which
715xterm style selection. 802gives xterm style selection. Only effective when the original (non-perl)
803selection code is in use.
716 804
717=item B<scrollstyle:> I<mode> 805=item B<scrollstyle:> I<mode>
718 806
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 807Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite. 808the author's favourite.
734=item B<mapAlert:> I<boolean> 822=item B<mapAlert:> I<boolean>
735 823
736B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 824B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737de-iconify (map) on receipt of a bell character [default]. 825de-iconify (map) on receipt of a bell character [default].
738 826
827=item B<urgentOnBell:> I<boolean>
828
829B<True>: set the urgency hint for the wm on receipt of a bell character.
830B<False>: do not set the urgency hint [default].
831
739=item B<visualBell:> I<boolean> 832=item B<visualBell:> I<boolean>
740 833
741B<True>: use visual bell on receipt of a bell character; option B<-vb>. 834B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742B<False>: no visual bell [default]; option B<+vb>. 835B<False>: no visual bell [default]; option B<+vb>.
743 836
764Example: 857Example:
765 858
766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 859 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 860
768This creates a new file in your home directory with the screen contents 861This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>. 862every time you hit C<Print>.
770 863
771=item B<scrollBar:> I<boolean> 864=item B<scrollBar:> I<boolean>
772 865
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 866B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 867disable the scrollbar; option B<+sb>.
796 889
797=item B<scrollWithBuffer:> I<boolean> 890=item B<scrollWithBuffer:> I<boolean>
798 891
799B<True>: scroll with scrollback buffer when tty receives new lines (and 892B<True>: scroll with scrollback buffer when tty receives new lines (and
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 893B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801with scrollback buffer when tty recieves new lines; option B<+sw>. 894with scrollback buffer when tty receives new lines; option B<+sw>.
802 895
803=item B<scrollTtyKeypress:> I<boolean> 896=item B<scrollTtyKeypress:> I<boolean>
804 897
805B<True>: scroll to bottom when a non-special key is pressed. Special keys 898B<True>: scroll to bottom when a non-special key is pressed. Special keys
806are those which are intercepted by rxvt-unicode for special handling and 899are those which are intercepted by rxvt-unicode for special handling and
837=item B<termName:> I<termname> 930=item B<termName:> I<termname>
838 931
839Specifies the terminal type name to be set in the B<TERM> environment 932Specifies the terminal type name to be set in the B<TERM> environment
840variable; option B<-tn>. 933variable; option B<-tn>.
841 934
842=item B<linespace:> I<number> 935=item B<lineSpace:> I<number>
843 936
844Specifies number of lines (pixel height) to insert between each row of 937Specifies number of lines (pixel height) to insert between each row of
845the display [default 0]; option B<-lsp>. 938the display [default 0]; option B<-lsp>.
846 939
847=item B<meta8:> I<boolean> 940=item B<meta8:> I<boolean>
896pressed. If unset it will send the sequence traditionally associated 989pressed. If unset it will send the sequence traditionally associated
897with the B<Execute> key. 990with the B<Execute> key.
898 991
899=item B<cutchars:> I<string> 992=item B<cutchars:> I<string>
900 993
901The characters used as delimiters for double-click word selection. 994The characters used as delimiters for double-click word selection
995(whitespace delimiting is added automatically if resource is given).
902 996
903When the selection extension is in use (the default if compiled in, see 997When the perl selection extension is in use (the default if compiled
904the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 998in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
905will be created (if the resource exists, otherwise, no regex will be 999characters will be created (if the resource exists, otherwise, no regex
906created). In this mode, characters outside ISO-8859-1 can be used. 1000will be created). In this mode, characters outside ISO-8859-1 can be used.
907 1001
908When the selection extension is not used, only ISO-8859-1 characters can 1002When the selection extension is not used, only ISO-8859-1 characters can
909be used. If not specified, the built-in default is used: 1003be used. If not specified, the built-in default is used:
910 1004
911B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1005B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
970 1064
971Turn on/off secondary screen (default enabled). 1065Turn on/off secondary screen (default enabled).
972 1066
973=item B<secondaryScroll:> I<boolean> 1067=item B<secondaryScroll:> I<boolean>
974 1068
975Turn on/off secondary screen scroll (default enabled). If the this 1069Turn on/off secondary screen scroll (default enabled). If this
976option is enabled, scrolls on the secondary screen will change the 1070option is enabled, scrolls on the secondary screen will change the
977scrollback buffer and switching to/from the secondary screen will 1071scrollback buffer and switching to/from the secondary screen will
978instead scroll the screen up. 1072instead scroll the screen up.
979 1073
980=item B<hold>: I<boolean> 1074=item B<hold>: I<boolean>
1004searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1098searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1005omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1099omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1006keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1100keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1007performed in an exact manner; however, the closest match is assured. 1101performed in an exact manner; however, the closest match is assured.
1008 1102
1009I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1103I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1010C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1104number), see RESOURCES in C<man 7 X> for futher details.
1011C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1012C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1013can start or end with whitespace.
1014
1015Please note that you need to double the C<\> in resource files, as
1016Xlib itself does it's own de-escaping (you can use C<\033> instead of
1017C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1018processing).
1019 1105
1020You can define a range of keysyms in one shot by providing a I<string> 1106You can define a range of keysyms in one shot by providing a I<string>
1021with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1107with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1022should be a character not used by the strings. 1108should be a character not used by the strings.
1023 1109
1024Its usage can be demonstrated by an example: 1110Its usage can be demonstrated by an example:
1025 1111
1026 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1112 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1090example, C<default,-selection> will use all the default extension except 1176example, C<default,-selection> will use all the default extension except
1091C<selection>. 1177C<selection>.
1092 1178
1093Extension names can also be followed by an argument in angle brackets 1179Extension names can also be followed by an argument in angle brackets
1094(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1180(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1095searchable scorllback to Alt/Meta-s). Mentioning the same extension 1181searchable scrollback to Alt/Meta-s). Mentioning the same extension
1096multiple times with different arguments will pass multiple arguments to 1182multiple times with different arguments will pass multiple arguments to
1097the extension. 1183the extension.
1098 1184
1099Each extension is looked up in the library directories, loaded if 1185Each extension is looked up in the library directories, loaded if
1100necessary, and bound to the current terminal instance. 1186necessary, and bound to the current terminal instance.
1136(default: C<M-s>). 1222(default: C<M-s>).
1137 1223
1138=item B<urlLauncher>: I<string> 1224=item B<urlLauncher>: I<string>
1139 1225
1140Specifies the program to be started with a URL argument. Used by the 1226Specifies the program to be started with a URL argument. Used by the
1141C<selection-popup> and C<mark-urls> perl extensions. 1227C<selection-popup> and C<matcher> perl extensions.
1142 1228
1143=item B<transient-for>: I<windowid> 1229=item B<transient-for>: I<windowid>
1144 1230
1145Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1231Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1146 1232
1147=item B<override-redirect>: I<boolean> 1233=item B<override-redirect>: I<boolean>
1148 1234
1149Compile I<frills>: Sets override-redirect for the terminal window, making 1235Compile I<frills>: Sets override-redirect for the terminal window, making
1150it almost invisible to window managers; option B<-override-redirect>. 1236it almost invisible to window managers; option B<-override-redirect>.
1237
1238=item B<iso14755_52:> I<boolean>
1239
1240Turn on/off ISO 14755 5.2 mode (default enabled).
1151 1241
1152=back 1242=back
1153 1243
1154=head1 THE SCROLLBAR 1244=head1 THE SCROLLBAR
1155 1245
1174application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1264application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1175(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1265(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1176up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1266up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1177respectively. 1267respectively.
1178 1268
1179=head1 TEXT SELECTION AND INSERTION 1269=head1 THE SELECTION: SELECTING AND PASTING TEXT
1180 1270
1181The behaviour of text selection and insertion mechanism is similar to 1271The behaviour of text selection and insertion/pasting mechanism is similar
1182I<xterm>(1). 1272to I<xterm>(1).
1183 1273
1184=over 4 1274=over 4
1185 1275
1186=item B<Selection>: 1276=item B<Selecting>:
1187 1277
1188Left click at the beginning of the region, drag to the end of the region 1278Left click at the beginning of the region, drag to the end of the region
1189and release; Right click to extend the marked region; Left double-click 1279and release; Right click to extend the marked region; Left double-click
1190to select a word; Left triple-click to select the entire logical line 1280to select a word; Left triple-click to select the entire logical line
1191(which can span multiple screen lines), unless modified by resource 1281(which can span multiple screen lines), unless modified by resource
1195(Compile: I<frills>) will create a rectangular selection instead of a 1285(Compile: I<frills>) will create a rectangular selection instead of a
1196normal one. In this mode, every selected row becomes its own line in the 1286normal one. In this mode, every selected row becomes its own line in the
1197selection, and trailing whitespace is visually underlined and removed from 1287selection, and trailing whitespace is visually underlined and removed from
1198the selection. 1288the selection.
1199 1289
1200=item B<Insertion>: 1290=item B<Pasting>:
1201 1291
1202Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1292Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1203window causes the value of the PRIMARY selection (or CLIPBOARD with the 1293window causes the value of the PRIMARY selection (or CLIPBOARD with the
1204Meta modifier) to be inserted as if it had been typed on the keyboard. 1294B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1205 1295
1206Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1296Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1207inserted too. 1297inserted too.
1208 1298
1209=back 1299=back
1226 1316
1227=head1 ISO 14755 SUPPORT 1317=head1 ISO 14755 SUPPORT
1228 1318
1229ISO 14755 is a standard for entering and viewing unicode characters 1319ISO 14755 is a standard for entering and viewing unicode characters
1230and character codes using the keyboard. It consists of 4 parts. The 1320and character codes using the keyboard. It consists of 4 parts. The
1231first part is available rxvt-unicode has been compiled with 1321first part is available if rxvt-unicode has been compiled with
1232C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1322C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1233with C<--enable-iso14755>. 1323with C<--enable-iso14755>.
1234 1324
1235=over 4 1325=over 4
1236 1326
1256This mode lets you input characters representing the keycap symbols of 1346This mode lets you input characters representing the keycap symbols of
1257your keyboard, if representable in the current locale encoding. 1347your keyboard, if representable in the current locale encoding.
1258 1348
1259Start by pressing C<Control> and C<Shift> together, then releasing 1349Start by pressing C<Control> and C<Shift> together, then releasing
1260them. The next special key (cursor keys, home etc.) you enter will not 1350them. The next special key (cursor keys, home etc.) you enter will not
1261invoke it's usual function but instead will insert the corresponding 1351invoke its usual function but instead will insert the corresponding
1262keycap symbol. The symbol will only be entered when the key has been 1352keycap symbol. The symbol will only be entered when the key has been
1263released, otherwise pressing e.g. C<Shift> would enter the symbol for 1353released, otherwise pressing e.g. C<Shift> would enter the symbol for
1264C<ISO Level 2 Switch>, although your intention might have been to enter a 1354C<ISO Level 2 Switch>, although your intention might have been to enter a
1265reverse tab (Shift-Tab). 1355reverse tab (Shift-Tab).
1266 1356
1299=head1 COLORS AND GRAPHICS 1389=head1 COLORS AND GRAPHICS
1300 1390
1301In addition to the default foreground and background colours, 1391In addition to the default foreground and background colours,
1302B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1392B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1303high-intensity bold/blink versions of the same). Here is a list of the 1393high-intensity bold/blink versions of the same). Here is a list of the
1304colours with their B<rgb.txt> names. 1394colours with their names.
1305 1395
1306=begin table 1396=begin table
1307 1397
1308 B<color0> (black) = Black 1398 B<color0> (black) = Black
1309 B<color1> (red) = Red3 1399 B<color1> (red) = Red3
1329It is also possible to specify the colour values of B<foreground>, 1419It is also possible to specify the colour values of B<foreground>,
1330B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1420B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1331a number 0-15, as a convenient shorthand to reference the colour name of 1421a number 0-15, as a convenient shorthand to reference the colour name of
1332color0-color15. 1422color0-color15.
1333 1423
1424In addition to the colours defined above, @@RXVT_NAME@@ offers an
1425additional 72 colours. The first 64 of those (with indices 16 to 79)
1426consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
142716>), followed by 8 additional shades of gray (with indices 80 to 87).
1428
1429Together, all those colours implement the 88 colour xterm colours. Only
1430the first 16 can be changed using resources currently, the rest can only
1431be changed via command sequences ("escape codes").
1432
1334Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1433Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1335always swapping the foreground/background colours. This is in contrast to 1434always swapping the foreground/background colours. This is in contrast to
1336I<xterm>(1) where the colours are only swapped if they have not otherwise 1435I<xterm>(1) where the colours are only swapped if they have not otherwise
1337been specified. For example, 1436been specified. For example,
1338 1437
1343would yield White on Black, while on I<xterm>(1) it would yield Black 1442would yield White on Black, while on I<xterm>(1) it would yield Black
1344on White. 1443on White.
1345 1444
1346=back 1445=back
1347 1446
1447=head2 ALPHA CHANNEL SUPPORT
1448
1449If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1450their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1451(recommended, but B<MUST> have 4 digits/component) colour specifications,
1452in addition to the ones provided by X, where the additional A component
1453specifies opacity (alpha) values. The minimum value of C<0> is completely
1454transparent). You can also prefix any color with C<[percent]>, where
1455C<percent> is a decimal percentage (0-100) that specifies the opacity of
1456the color, where C<0> is completely transparent and C<100> is completelxy
1457opaque.
1458
1459You probably need to specify B<"-depth 32">, too, and have the luck that
1460your X-server uses ARGB pixel layout, as X is far from just supporting
1461ARGB visuals out of the box, and rxvt-unicode just fudges around.
1462
1463For example, the following selects an almost completely transparent red
1464background, and an almost opaque pink foreground:
1465
1466 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1467
1468I<Please note that transparency of any kind if completely unsupported by
1469the author. Don't bug him with installation questions!>
1470
1348=head1 ENVIRONMENT 1471=head1 ENVIRONMENT
1349 1472
1350B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1473B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1351 1474
1352=over 4 1475=over 4
1353 1476
1354=item B<TERM> 1477=item B<TERM>
1355 1478
1356Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1479Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1357resources or on the commandline. 1480resources or on the command line.
1358 1481
1359=item B<COLORTERM> 1482=item B<COLORTERM>
1360 1483
1361Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1484Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1362compiled with XPM support, and optionally with the added extension 1485compiled with background image support, and optionally with the added
1363C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1486extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1487screen.
1364 1488
1365=item B<COLORFGBG> 1489=item B<COLORFGBG>
1366 1490
1367Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1491Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1368the colour code used as default foreground/text colour (or the string 1492the colour code used as default foreground/text colour (or the string
1369C<default> to indicate that the default-colour escape sequence is to be 1493C<default> to indicate that the default-colour escape sequence is to be
1370used), C<bg> is the colour code used as default background colour (or the 1494used), C<bg> is the colour code used as default background colour (or the
1371string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1495string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1372was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1496was compiled with background image support. Libraries like C<ncurses>
1373(and do) use this information to optimize screen output. 1497and C<slang> can (and do) use this information to optimize screen output.
1374 1498
1375=item B<WINDOWID> 1499=item B<WINDOWID>
1376 1500
1377Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1501Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1378window, which usually has subwindows for the scrollbar, the terminal 1502window, which usually has subwindows for the scrollbar, the terminal
1384C<--with-terminfo=PATH>. 1508C<--with-terminfo=PATH>.
1385 1509
1386=item B<DISPLAY> 1510=item B<DISPLAY>
1387 1511
1388Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1512Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1389display in it's child processes. 1513display in its child processes.
1390 1514
1391=item B<SHELL> 1515=item B<SHELL>
1392 1516
1393The shell to be used for command execution, defaults to C</bin/sh>. 1517The shell to be used for command execution, defaults to C</bin/sh>.
1394 1518
1436 1560
1437=item Project Coordinator 1561=item Project Coordinator
1438 1562
1439Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1563Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1440 1564
1441L<http://software.schmorp.de/#rxvt-unicode> 1565L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1442 1566
1443=back 1567=back
1444 1568
1445=head1 AUTHORS 1569=head1 AUTHORS
1446 1570
1469Project Coordinator (changes.txt 2.21a to 2.4.5) 1593Project Coordinator (changes.txt 2.21a to 2.4.5)
1470 1594
1471=item Geoff Wing L<< <gcw@pobox.com> >> 1595=item Geoff Wing L<< <gcw@pobox.com> >>
1472 1596
1473Rewrote screen display and text selection routines. 1597Rewrote screen display and text selection routines.
1474 1598
1475Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1599Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1476 1600
1477=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1601=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1478 1602
1479Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1603Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines