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.100 by root, Thu Jan 19 18:02:28 2006 UTC vs.
Revision 1.140 by sasha, Fri Oct 26 18:27:29 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; resource
132I<tintColor>. Example: 151I<tintColor>. Example:
133 152
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 153 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 154
136=item B<-sh> 155=item B<-sh> I<number>
137 156
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 157Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 158background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 159resource I<shading>.
160
161=item B<-blt> I<string>
162
163Specify background blending type. If background pixmap is specified
164at the same time as transparency - such pixmap will be blended over
165transparency image, using method specified. Supported values are :
166B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
167B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
168B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
169alpha-blending. Compile I<afterimage>; resource I<blendType>.
170
171=item B<-blr> I<HxV>
172
173Apply Gaussian Blur with the specified radii to the transparent
174background image. If single number is specified - both vertical and
175horizontal radii are considered to be the same. Setting one of the
176radii to 1 and another to a large number creates interesting effects
177on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
178resource I<blurRadius>.
141 179
142=item B<-bg> I<colour> 180=item B<-bg> I<colour>
143 181
144Window background colour; resource B<background>. 182Window background colour; resource B<background>.
145 183
147 185
148Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
149 187
150=item B<-pixmap> I<file[;geom]> 188=item B<-pixmap> I<file[;geom]>
151 189
152Compile I<XPM>: Specify XPM file for the background and also optionally 190Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 191optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
156 194
157=item B<-cr> I<colour> 195=item B<-cr> I<colour>
158 196
159The cursor colour; resource B<cursorColor>. 197The cursor colour; resource B<cursorColor>.
160 198
177that are checked in order when trying to find glyphs for characters. The 215that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 216first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 217smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 218font list is always appended to it. See resource B<font> for more details.
181 219
182In short, to specify an X11 core font, just specify it's name or prefix it 220In 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:>, 221with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 222e.g.:
185 223
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 224 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 225 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
313 351
314=item B<-lsp> I<number> 352=item B<-lsp> I<number>
315 353
316Compile I<frills>: Lines (pixel height) to insert between each row of 354Compile I<frills>: Lines (pixel height) to insert between each row of
317the display. Useful to work around font rendering problems; resource 355the display. Useful to work around font rendering problems; resource
318B<linespace>. 356B<lineSpace>.
319 357
320=item B<-tn> I<termname> 358=item B<-tn> I<termname>
321 359
322This option specifies the name of the terminal type to be set in the 360This option specifies the name of the terminal type to be set in the
323B<TERM> environment variable. This terminal type must exist in the 361B<TERM> environment variable. This terminal type must exist in the
377for more info. 415for more info.
378 416
379=item B<-tcw> 417=item B<-tcw>
380 418
381Change the meaning of triple-click selection with the left mouse 419Change the meaning of triple-click selection with the left mouse
420button. Only effective when the original (non-perl) selection code is
382button. Instead of selecting a full line it will extend the selection the 421in-use. Instead of selecting a full line it will extend the selection the
383end of the logical line only. resource B<tripleclickwords>. 422end of the logical line only. resource B<tripleclickwords>.
384 423
385=item B<-insecure> 424=item B<-insecure>
386 425
387Enable "insecure" mode, which currently enables most of the escape 426Enable "insecure" mode, which currently enables most of the escape
415 454
416Remap a key symbol. See resource B<keysym>. 455Remap a key symbol. See resource B<keysym>.
417 456
418=item B<-embed> I<windowid> 457=item B<-embed> I<windowid>
419 458
420Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 459Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
421which enables applications to easily embed a terminal. 460which enables applications to easily embed a terminal.
422 461
423Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 462Right 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 463shouldn'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 464quite 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. 467The window will not be destroyed when @@RXVT_NAME@@ exits.
429 468
430It might be useful to know that @@RXVT_NAME@@ will not close file 469It 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 470descriptors passed to it (except for stdin/out/err, of course), so you
432can use file descriptors to communicate with the programs within the 471can use file descriptors to communicate with the programs within the
433terminal. This works regardless of wether the C<-embed> option was used or 472terminal. This works regardless of whether the C<-embed> option was used or
434not. 473not.
435 474
436Here is a short Gtk2-perl snippet that illustrates how this option can be 475Here is a short Gtk2-perl snippet that illustrates how this option can be
437used (a longer example is in F<doc/embed>): 476used (a longer example is in F<doc/embed>):
438 477
443 }); 482 });
444 483
445=item B<-pty-fd> I<file descriptor> 484=item B<-pty-fd> I<file descriptor>
446 485
447Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 486Tells @@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 487pair 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 488useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
450without having to run a program within it. 489without having to run a program within it.
451 490
452If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 491If 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 492entries 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 544check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here): 545extensions not documented here):
507 546
508=over 4 547=over 4
509 548
549=item B<depth:> I<bitdepth>
550
551Compile I<xft>: Attempt to find a visual with the given bit depth;
552option B<-depth>.
553
510=item B<geometry:> I<geom> 554=item B<geometry:> I<geom>
511 555
512Create the window with the specified X window geometry [default 80x24]; 556Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 557option B<-geometry>.
514 558
550Use the specified colour to display underlined characters when the 594Use the specified colour to display underlined characters when the
551foreground colour is the default. 595foreground colour is the default.
552 596
553=item B<colorRV:> I<colour> 597=item B<colorRV:> I<colour>
554 598
555Use the specified colour as the background for reverse video 599Use the specified colour as the background for reverse video characters
556characters. 600when OPTION_HC is disabled (--disable-frills).
557 601
558=item B<underlineColor:> I<colour> 602=item B<underlineColor:> I<colour>
559 603
560If set, use the specified colour as the colour for the underline 604If set, use the specified colour as the colour for the underline
561itself. If unset, use the foreground colour. 605itself. If unset, use the foreground colour.
577option B<-rv>. B<False>: regular screen colours [default]; option 621option B<-rv>. B<False>: regular screen colours [default]; option
578B<+rv>. See note in B<COLORS AND GRAPHICS> section. 622B<+rv>. See note in B<COLORS AND GRAPHICS> section.
579 623
580=item B<jumpScroll:> I<boolean> 624=item B<jumpScroll:> I<boolean>
581 625
582B<True>: specify that jump scrolling should be used. When scrolling 626B<True>: specify that jump scrolling should be used. When receiving lots
583quickly, fewer screen updates are performed [default]; option B<-j>. 627of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
628has been read, resulting in fewer updates while still displaying every
629received line; option B<-j>.
630
584B<False>: specify that smooth scrolling should be used; option B<+j>. 631B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
632force a screen refresh on each new line it received; option B<+j>.
633
634=item B<skipScroll:> I<boolean>
635
636B<True>: (the default) specify that skip scrolling should be used. When
637receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
638(around 60 times per second), resulting in far fewer updates. This can
639result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
640option B<-ss>.
641
642B<False>: specify that everything is to be displayed, even
643if the refresh is too fast for the human eye to read anything (or the
644monitor to display anything); option B<+ss>.
585 645
586=item B<inheritPixmap:> I<boolean> 646=item B<inheritPixmap:> I<boolean>
587 647
588B<True>: make the background inherit the parent windows' pixmap, giving 648B<True>: make the background inherit the parent windows' pixmap, giving
589artificial transparency. B<False>: do not inherit the parent windows' 649artificial transparency. B<False>: do not inherit the parent windows'
590pixmap. 650pixmap.
591 651
652I<Please note that transparency of any kind if completely unsupported by
653the author. Don't bug him with installation questions!>
654
592=item B<fading:> I<number> 655=item B<fading:> I<number>
593 656
594Fade the text by the given percentage when focus is lost; option B<-fade>. 657Fade the text by the given percentage when focus is lost; option B<-fade>.
595 658
596=item B<fadeColor:> I<colour> 659=item B<fadeColor:> I<colour>
603Tint the transparent background pixmap with the given colour; option 666Tint the transparent background pixmap with the given colour; option
604B<-tint>. 667B<-tint>.
605 668
606=item B<shading:> I<number> 669=item B<shading:> I<number>
607 670
608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 671Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
609image in addition to tinting it. 672in addition to tinting it; option B<-sh>.
673
674=item B<blendType:> I<string>
675
676Specify background blending type; option B<-blt>.
677
678=item B<blurRadius:> I<number>
679
680Apply Gaussian Blurr with the specified radius to the transparent
681background image; option B<-blr>.
610 682
611=item B<scrollColor:> I<colour> 683=item B<scrollColor:> I<colour>
612 684
613Use the specified colour for the scrollbar [default #B2B2B2]. 685Use the specified colour for the scrollbar [default #B2B2B2].
614 686
622The colour of the border around the text area and between the scrollbar 694The colour of the border around the text area and between the scrollbar
623and the text. 695and the text.
624 696
625=item B<backgroundPixmap:> I<file[;geom]> 697=item B<backgroundPixmap:> I<file[;geom]>
626 698
627Use the specified XPM file (note the `.xpm' extension is optional) for 699Use the specified image file for the background and also optionally
628the background and also optionally specify its scaling with a geometry 700specify its scaling with a geometry string B<WxH+X+Y>,
629string B<WxH+X+Y>, in which B<"W" / "H"> specify the 701in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
630horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 702and B<"X" / "Y"> locate the image centre (percent).
631centre (percent). A scale of 0 displays the image with tiling. A scale 703A 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 704image without any scaling. A scale of 2 to 9 specifies an integer
633specifies an integer number of images in that direction. No image will 705number of images in that direction. No image will be magnified beyond
634be magnified beyond 10 times its original size. The maximum permitted 70610 times its original size. The maximum permitted scale is 1000.
635scale is 1000. [default 0x0+50+50] 707Special string of B<"auto"> used as a geometry will cause image to be
708automatically scaled to match window size.
709If used in conjunction with B<-tr> option - specified pixmap will be
710blended over transparency image using either alpha-blending, or any
711other blending type, specified with B<-blt "type"> option.
712[default 0x0+50+50]
636 713
637=item B<path:> I<path> 714=item B<path:> I<path>
638 715
639Specify the colon-delimited search path for finding XPM files. 716Specify the colon-delimited search path for finding background image files.
640 717
641=item B<font:> I<fontlist> 718=item B<font:> I<fontlist>
642 719
643Select the fonts to be used. This is a comma separated list of font names 720Select 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 721that are checked in order when trying to find glyphs for characters. The
702 779
703=item B<intensityStyles:> I<boolean> 780=item B<intensityStyles:> I<boolean>
704 781
705When font styles are not enabled, or this option is enabled (B<True>, 782When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high 783option B<-is>, the default), bold and italic font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 784intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 785option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 786reachable.
710 787
711=item B<selectstyle:> I<mode> 788=item B<selectstyle:> I<mode>
712 789
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is 790Set 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 791is xterm style with 2.20 old word selection, or anything else which
715xterm style selection. 792gives xterm style selection. Only effective when the original (non-perl)
793selection code is in use.
716 794
717=item B<scrollstyle:> I<mode> 795=item B<scrollstyle:> I<mode>
718 796
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 797Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite. 798the author's favourite.
734=item B<mapAlert:> I<boolean> 812=item B<mapAlert:> I<boolean>
735 813
736B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 814B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737de-iconify (map) on receipt of a bell character [default]. 815de-iconify (map) on receipt of a bell character [default].
738 816
817=item B<urgentOnBell:> I<boolean>
818
819B<True>: set the urgency hint for the wm on receipt of a bell character.
820B<False>: do not set the urgency hint [default].
821
739=item B<visualBell:> I<boolean> 822=item B<visualBell:> I<boolean>
740 823
741B<True>: use visual bell on receipt of a bell character; option B<-vb>. 824B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742B<False>: no visual bell [default]; option B<+vb>. 825B<False>: no visual bell [default]; option B<+vb>.
743 826
764Example: 847Example:
765 848
766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 849 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 850
768This creates a new file in your home directory with the screen contents 851This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>. 852every time you hit C<Print>.
770 853
771=item B<scrollBar:> I<boolean> 854=item B<scrollBar:> I<boolean>
772 855
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 856B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 857disable the scrollbar; option B<+sb>.
796 879
797=item B<scrollWithBuffer:> I<boolean> 880=item B<scrollWithBuffer:> I<boolean>
798 881
799B<True>: scroll with scrollback buffer when tty receives new lines (and 882B<True>: scroll with scrollback buffer when tty receives new lines (and
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 883B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801with scrollback buffer when tty recieves new lines; option B<+sw>. 884with scrollback buffer when tty receives new lines; option B<+sw>.
802 885
803=item B<scrollTtyKeypress:> I<boolean> 886=item B<scrollTtyKeypress:> I<boolean>
804 887
805B<True>: scroll to bottom when a non-special key is pressed. Special keys 888B<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 889are those which are intercepted by rxvt-unicode for special handling and
837=item B<termName:> I<termname> 920=item B<termName:> I<termname>
838 921
839Specifies the terminal type name to be set in the B<TERM> environment 922Specifies the terminal type name to be set in the B<TERM> environment
840variable; option B<-tn>. 923variable; option B<-tn>.
841 924
842=item B<linespace:> I<number> 925=item B<lineSpace:> I<number>
843 926
844Specifies number of lines (pixel height) to insert between each row of 927Specifies number of lines (pixel height) to insert between each row of
845the display [default 0]; option B<-lsp>. 928the display [default 0]; option B<-lsp>.
846 929
847=item B<meta8:> I<boolean> 930=item B<meta8:> I<boolean>
896pressed. If unset it will send the sequence traditionally associated 979pressed. If unset it will send the sequence traditionally associated
897with the B<Execute> key. 980with the B<Execute> key.
898 981
899=item B<cutchars:> I<string> 982=item B<cutchars:> I<string>
900 983
901The characters used as delimiters for double-click word selection. The 984The characters used as delimiters for double-click word selection
902built-in default: 985(whitespace delimiting is added automatically if resource is given).
986
987When the perl selection extension is in use (the default if compiled
988in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
989characters will be created (if the resource exists, otherwise, no regex
990will be created). In this mode, characters outside ISO-8859-1 can be used.
991
992When the selection extension is not used, only ISO-8859-1 characters can
993be used. If not specified, the built-in default is used:
903 994
904B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 995B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
905 996
906=item B<preeditType:> I<style> 997=item B<preeditType:> I<style>
907 998
963 1054
964Turn on/off secondary screen (default enabled). 1055Turn on/off secondary screen (default enabled).
965 1056
966=item B<secondaryScroll:> I<boolean> 1057=item B<secondaryScroll:> I<boolean>
967 1058
968Turn on/off secondary screen scroll (default enabled). If the this 1059Turn on/off secondary screen scroll (default enabled). If this
969option is enabled, scrolls on the secondary screen will change the 1060option is enabled, scrolls on the secondary screen will change the
970scrollback buffer and switching to/from the secondary screen will 1061scrollback buffer and switching to/from the secondary screen will
971instead scroll the screen up. 1062instead scroll the screen up.
972 1063
973=item B<hold>: I<boolean> 1064=item B<hold>: I<boolean>
997searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1088searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
998omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1089omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
999keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1090keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1000performed in an exact manner; however, the closest match is assured. 1091performed in an exact manner; however, the closest match is assured.
1001 1092
1002I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1093I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1003C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1094number), see RESOURCES in C<man 7 X> for futher details.
1004C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1005C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1006can start or end with whitespace.
1007
1008Please note that you need to double the C<\> in resource files, as
1009Xlib itself does it's own de-escaping (you can use C<\033> instead of
1010C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1011processing).
1012 1095
1013You can define a range of keysyms in one shot by providing a I<string> 1096You can define a range of keysyms in one shot by providing a I<string>
1014with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1097with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1015should be a character not used by the strings. 1098should be a character not used by the strings.
1016 1099
1017Its usage can be demonstrated by an example: 1100Its usage can be demonstrated by an example:
1018 1101
1019 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1102 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1083example, C<default,-selection> will use all the default extension except 1166example, C<default,-selection> will use all the default extension except
1084C<selection>. 1167C<selection>.
1085 1168
1086Extension names can also be followed by an argument in angle brackets 1169Extension names can also be followed by an argument in angle brackets
1087(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1170(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1088searchable scorllback to Alt/Meta-s). Mentioning the same extension 1171searchable scrollback to Alt/Meta-s). Mentioning the same extension
1089multiple times with different arguments will pass multiple arguments to 1172multiple times with different arguments will pass multiple arguments to
1090the extension. 1173the extension.
1091 1174
1092Each extension is looked up in the library directories, loaded if 1175Each extension is looked up in the library directories, loaded if
1093necessary, and bound to the current terminal instance. 1176necessary, and bound to the current terminal instance.
1129(default: C<M-s>). 1212(default: C<M-s>).
1130 1213
1131=item B<urlLauncher>: I<string> 1214=item B<urlLauncher>: I<string>
1132 1215
1133Specifies the program to be started with a URL argument. Used by the 1216Specifies the program to be started with a URL argument. Used by the
1134C<selection-popup> and C<mark-urls> perl extensions. 1217C<selection-popup> and C<matcher> perl extensions.
1135 1218
1136=item B<transient-for>: I<windowid> 1219=item B<transient-for>: I<windowid>
1137 1220
1138Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1221Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1139 1222
1140=item B<override-redirect>: I<boolean> 1223=item B<override-redirect>: I<boolean>
1141 1224
1142Compile I<frills>: Sets override-redirect for the terminal window, making 1225Compile I<frills>: Sets override-redirect for the terminal window, making
1143it almost invisible to window managers; option B<-override-redirect>. 1226it almost invisible to window managers; option B<-override-redirect>.
1227
1228=item B<iso14755_52:> I<boolean>
1229
1230Turn on/off ISO 14755 5.2 mode (default enabled).
1144 1231
1145=back 1232=back
1146 1233
1147=head1 THE SCROLLBAR 1234=head1 THE SCROLLBAR
1148 1235
1167application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1254application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1168(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1255(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1169up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1256up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1170respectively. 1257respectively.
1171 1258
1172=head1 TEXT SELECTION AND INSERTION 1259=head1 THE SELECTION: SELECTING AND PASTING TEXT
1173 1260
1174The behaviour of text selection and insertion mechanism is similar to 1261The behaviour of text selection and insertion/pasting mechanism is similar
1175I<xterm>(1). 1262to I<xterm>(1).
1176 1263
1177=over 4 1264=over 4
1178 1265
1179=item B<Selection>: 1266=item B<Selecting>:
1180 1267
1181Left 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
1182and release; Right click to extend the marked region; Left double-click 1269and release; Right click to extend the marked region; Left double-click
1183to 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
1184(which can span multiple screen lines), unless modified by resource 1271(which can span multiple screen lines), unless modified by resource
1188(Compile: I<frills>) will create a rectangular selection instead of a 1275(Compile: I<frills>) will create a rectangular selection instead of a
1189normal 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
1190selection, and trailing whitespace is visually underlined and removed from 1277selection, and trailing whitespace is visually underlined and removed from
1191the selection. 1278the selection.
1192 1279
1193=item B<Insertion>: 1280=item B<Pasting>:
1194 1281
1195Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1282Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1196an B<@@RXVT_NAME@@> window causes the current text selection to be 1283window causes the value of the PRIMARY selection (or CLIPBOARD with the
1197inserted as if it had been typed on the keyboard. 1284B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1285
1286Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1287inserted too.
1198 1288
1199=back 1289=back
1200 1290
1201=head1 CHANGING FONTS 1291=head1 CHANGING FONTS
1202 1292
1216 1306
1217=head1 ISO 14755 SUPPORT 1307=head1 ISO 14755 SUPPORT
1218 1308
1219ISO 14755 is a standard for entering and viewing unicode characters 1309ISO 14755 is a standard for entering and viewing unicode characters
1220and character codes using the keyboard. It consists of 4 parts. The 1310and character codes using the keyboard. It consists of 4 parts. The
1221first part is available rxvt-unicode has been compiled with 1311first part is available if rxvt-unicode has been compiled with
1222C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1312C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1223with C<--enable-iso14755>. 1313with C<--enable-iso14755>.
1224 1314
1225=over 4 1315=over 4
1226 1316
1246This mode lets you input characters representing the keycap symbols of 1336This mode lets you input characters representing the keycap symbols of
1247your keyboard, if representable in the current locale encoding. 1337your keyboard, if representable in the current locale encoding.
1248 1338
1249Start by pressing C<Control> and C<Shift> together, then releasing 1339Start by pressing C<Control> and C<Shift> together, then releasing
1250them. The next special key (cursor keys, home etc.) you enter will not 1340them. The next special key (cursor keys, home etc.) you enter will not
1251invoke it's usual function but instead will insert the corresponding 1341invoke its usual function but instead will insert the corresponding
1252keycap symbol. The symbol will only be entered when the key has been 1342keycap symbol. The symbol will only be entered when the key has been
1253released, otherwise pressing e.g. C<Shift> would enter the symbol for 1343released, otherwise pressing e.g. C<Shift> would enter the symbol for
1254C<ISO Level 2 Switch>, although your intention might have been to enter a 1344C<ISO Level 2 Switch>, although your intention might have been to enter a
1255reverse tab (Shift-Tab). 1345reverse tab (Shift-Tab).
1256 1346
1289=head1 COLORS AND GRAPHICS 1379=head1 COLORS AND GRAPHICS
1290 1380
1291In addition to the default foreground and background colours, 1381In addition to the default foreground and background colours,
1292B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1382B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1293high-intensity bold/blink versions of the same). Here is a list of the 1383high-intensity bold/blink versions of the same). Here is a list of the
1294colours with their B<rgb.txt> names. 1384colours with their names.
1295 1385
1296=begin table 1386=begin table
1297 1387
1298 B<color0> (black) = Black 1388 B<color0> (black) = Black
1299 B<color1> (red) = Red3 1389 B<color1> (red) = Red3
1319It is also possible to specify the colour values of B<foreground>, 1409It is also possible to specify the colour values of B<foreground>,
1320B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1410B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1321a number 0-15, as a convenient shorthand to reference the colour name of 1411a number 0-15, as a convenient shorthand to reference the colour name of
1322color0-color15. 1412color0-color15.
1323 1413
1414In addition to the colours defined above, @@RXVT_NAME@@ offers an
1415additional 72 colours. The first 64 of those (with indices 16 to 79)
1416consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141716>), followed by 8 additional shades of gray (with indices 80 to 87).
1418
1419Together, all those colours implement the 88 colour xterm colours. Only
1420the first 16 can be changed using resources currently, the rest can only
1421be changed via command sequences ("escape codes").
1422
1324Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1423Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1325always swapping the foreground/background colours. This is in contrast to 1424always swapping the foreground/background colours. This is in contrast to
1326I<xterm>(1) where the colours are only swapped if they have not otherwise 1425I<xterm>(1) where the colours are only swapped if they have not otherwise
1327been specified. For example, 1426been specified. For example,
1328 1427
1333would yield White on Black, while on I<xterm>(1) it would yield Black 1432would yield White on Black, while on I<xterm>(1) it would yield Black
1334on White. 1433on White.
1335 1434
1336=back 1435=back
1337 1436
1437=head2 ALPHA CHANNEL SUPPORT
1438
1439If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1440their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1441(recommended, but B<MUST> have 4 digits/component) colour specifications,
1442in addition to the ones provided by X, where the additional A component
1443specifies opacity (alpha) values. The minimum value of C<0> is completely
1444transparent). You can also prefix any color with C<[percent]>, where
1445C<percent> is a decimal percentage (0-100) that specifies the opacity of
1446the color, where C<0> is completely transparent and C<100> is completelxy
1447opaque.
1448
1449You probably need to specify B<"-depth 32">, too, and have the luck that
1450your X-server uses ARGB pixel layout, as X is far from just supporting
1451ARGB visuals out of the box, and rxvt-unicode just fudges around.
1452
1453For example, the following selects an almost completely transparent red
1454background, and an almost opaque pink foreground:
1455
1456 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1457
1458I<Please note that transparency of any kind if completely unsupported by
1459the author. Don't bug him with installation questions!>
1460
1338=head1 ENVIRONMENT 1461=head1 ENVIRONMENT
1339 1462
1340B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1463B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1341 1464
1342=over 4 1465=over 4
1343 1466
1344=item B<TERM> 1467=item B<TERM>
1345 1468
1346Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1469Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1347resources or on the commandline. 1470resources or on the command line.
1348 1471
1349=item B<COLORTERM> 1472=item B<COLORTERM>
1350 1473
1351Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1474Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1352compiled with XPM support, and optionally with the added extension 1475compiled with background image support, and optionally with the added
1353C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1476extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477screen.
1354 1478
1355=item B<COLORFGBG> 1479=item B<COLORFGBG>
1356 1480
1357Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1481Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1358the colour code used as default foreground/text colour (or the string 1482the colour code used as default foreground/text colour (or the string
1359C<default> to indicate that the default-colour escape sequence is to be 1483C<default> to indicate that the default-colour escape sequence is to be
1360used), C<bg> is the colour code used as default background colour (or the 1484used), C<bg> is the colour code used as default background colour (or the
1361string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1485string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1362was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1486was compiled with background image support. Libraries like C<ncurses>
1363(and do) use this information to optimize screen output. 1487and C<slang> can (and do) use this information to optimize screen output.
1364 1488
1365=item B<WINDOWID> 1489=item B<WINDOWID>
1366 1490
1367Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1491Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1368window, which usually has subwindows for the scrollbar, the terminal 1492window, which usually has subwindows for the scrollbar, the terminal
1374C<--with-terminfo=PATH>. 1498C<--with-terminfo=PATH>.
1375 1499
1376=item B<DISPLAY> 1500=item B<DISPLAY>
1377 1501
1378Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1502Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1379display in it's child processes. 1503display in its child processes.
1380 1504
1381=item B<SHELL> 1505=item B<SHELL>
1382 1506
1383The shell to be used for command execution, defaults to C</bin/sh>. 1507The shell to be used for command execution, defaults to C</bin/sh>.
1384 1508
1426 1550
1427=item Project Coordinator 1551=item Project Coordinator
1428 1552
1429Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1553Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1430 1554
1431L<http://software.schmorp.de/#rxvt-unicode> 1555L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1432 1556
1433=back 1557=back
1434 1558
1435=head1 AUTHORS 1559=head1 AUTHORS
1436 1560
1471 1595
1472Project Coordinator (Changes 1.0 -) 1596Project Coordinator (Changes 1.0 -)
1473 1597
1474=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1598=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1475 1599
1476Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugxifing. 1600Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1477 1601
1478=back 1602=back
1479 1603

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines