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.109 by root, Sun Jan 29 22:27:04 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
108 108
109Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
110 110
111=item B<-j>|B<+j> 111=item B<-j>|B<+j>
112 112
113Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 114
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ss>|B<+ss>
116 116
117Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-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@@)!>
119 130
120=item B<-fade> I<number> 131=item B<-fade> I<number>
121 132
122Fade 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
123fade a little only, 100 completely replaces all colours by the fade 134fade a little only, 100 completely replaces all colours by the fade
124colour; resource B<fading>. 135colour; resource B<fading>.
125 136
126=item B<-fadecolor> I<colour> 137=item B<-fadecolor> I<colour>
127 138
128Fade 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
129is black. resource B<fadeColor>. 140is opaque black. resource B<fadeColor>.
130 141
131=item B<-tint> I<colour> 142=item B<-tint> I<colour>
132 143
133Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
134transparency is enabled with B<-tr> or B<-ip>. This only works for 145transparency is enabled with B<-tr>. This only works for
135non-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
136used 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
137I<tintColor>. Example: 152I<tintColor>. Example:
138 153
139 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
140 155
141=item B<-sh> 156=item B<-sh> I<number>
142 157
143I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
144background image in addition to tinting it (i.e. B<-tint> must be 159background image in addition to (or instead of) tinting it;
145specified, 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>.
146 180
147=item B<-bg> I<colour> 181=item B<-bg> I<colour>
148 182
149Window background colour; resource B<background>. 183Window background colour; resource B<background>.
150 184
151=item B<-fg> I<colour> 185=item B<-fg> I<colour>
152 186
153Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
154 188
155=item B<-pixmap> I<file[;geom]> 189=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
156 190
157Compile I<XPM>: Specify XPM file for the background and also optionally 191Compile I<afterimage>: Specify image file for the background and also
158specify its scaling with a geometry string. Note you may need to 192optionally specify its scaling with a geometry string. Note you may need to
159add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
160command-line; resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
161 195
162=item B<-cr> I<colour> 196=item B<-cr> I<colour>
163 197
164The cursor colour; resource B<cursorColor>. 198The cursor colour; resource B<cursorColor>.
165 199
182that 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
183first font defines the cell size for characters; other fonts might be 217first font defines the cell size for characters; other fonts might be
184smaller, but not (in general) larger. A (hopefully) reasonable default 218smaller, but not (in general) larger. A (hopefully) reasonable default
185font 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.
186 220
187In 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
188with 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:>,
189e.g.: 223e.g.:
190 224
191 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 225 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 226 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
318 352
319=item B<-lsp> I<number> 353=item B<-lsp> I<number>
320 354
321Compile I<frills>: Lines (pixel height) to insert between each row of 355Compile I<frills>: Lines (pixel height) to insert between each row of
322the display. Useful to work around font rendering problems; resource 356the display. Useful to work around font rendering problems; resource
323B<linespace>. 357B<lineSpace>.
324 358
325=item B<-tn> I<termname> 359=item B<-tn> I<termname>
326 360
327This 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
328B<TERM> environment variable. This terminal type must exist in the 362B<TERM> environment variable. This terminal type must exist in the
382for more info. 416for more info.
383 417
384=item B<-tcw> 418=item B<-tcw>
385 419
386Change 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
387button. 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
388end of the logical line only. resource B<tripleclickwords>. 423end of the logical line only. resource B<tripleclickwords>.
389 424
390=item B<-insecure> 425=item B<-insecure>
391 426
392Enable "insecure" mode, which currently enables most of the escape 427Enable "insecure" mode, which currently enables most of the escape
420 455
421Remap a key symbol. See resource B<keysym>. 456Remap a key symbol. See resource B<keysym>.
422 457
423=item B<-embed> I<windowid> 458=item B<-embed> I<windowid>
424 459
425Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 460Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426which enables applications to easily embed a terminal. 461which enables applications to easily embed a terminal.
427 462
428Right 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
429shouldn'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
430quite 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
433The window will not be destroyed when @@RXVT_NAME@@ exits. 468The window will not be destroyed when @@RXVT_NAME@@ exits.
434 469
435It 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
436descriptors 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
437can use file descriptors to communicate with the programs within the 472can use file descriptors to communicate with the programs within the
438terminal. 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
439not. 474not.
440 475
441Here 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
442used (a longer example is in F<doc/embed>): 477used (a longer example is in F<doc/embed>):
443 478
448 }); 483 });
449 484
450=item B<-pty-fd> I<file descriptor> 485=item B<-pty-fd> I<file descriptor>
451 486
452Tells @@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
453pair 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
454useful 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
455without having to run a program within it. 490without having to run a program within it.
456 491
457If 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
458entries 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
560Use the specified colour to display underlined characters when the 595Use the specified colour to display underlined characters when the
561foreground colour is the default. 596foreground colour is the default.
562 597
563=item B<colorRV:> I<colour> 598=item B<colorRV:> I<colour>
564 599
565Use the specified colour as the background for reverse video 600Use the specified colour as the background for reverse video characters
566characters. 601when OPTION_HC is disabled (--disable-frills).
567 602
568=item B<underlineColor:> I<colour> 603=item B<underlineColor:> I<colour>
569 604
570If set, use the specified colour as the colour for the underline 605If set, use the specified colour as the colour for the underline
571itself. If unset, use the foreground colour. 606itself. If unset, use the foreground colour.
587option B<-rv>. B<False>: regular screen colours [default]; option 622option B<-rv>. B<False>: regular screen colours [default]; option
588B<+rv>. See note in B<COLORS AND GRAPHICS> section. 623B<+rv>. See note in B<COLORS AND GRAPHICS> section.
589 624
590=item B<jumpScroll:> I<boolean> 625=item B<jumpScroll:> I<boolean>
591 626
592B<True>: specify that jump scrolling should be used. When scrolling 627B<True>: specify that jump scrolling should be used. When receiving lots
593quickly, 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
594B<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>.
595 646
596=item B<inheritPixmap:> I<boolean> 647=item B<inheritPixmap:> I<boolean>
597 648
598B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: make the background inherit the parent windows' pixmap, giving
599artificial transparency. B<False>: do not inherit the parent windows' 650artificial transparency. B<False>: do not inherit the parent windows'
600pixmap. 651pixmap.
601 652
653I<Please note that transparency of any kind if completely unsupported by
654the author. Don't bug him with installation questions!>
655
602=item B<fading:> I<number> 656=item B<fading:> I<number>
603 657
604Fade 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>.
605 659
606=item B<fadeColor:> I<colour> 660=item B<fadeColor:> I<colour>
613Tint the transparent background pixmap with the given colour; option 667Tint the transparent background pixmap with the given colour; option
614B<-tint>. 668B<-tint>.
615 669
616=item B<shading:> I<number> 670=item B<shading:> I<number>
617 671
618Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 672Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
619image 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>.
620 683
621=item B<scrollColor:> I<colour> 684=item B<scrollColor:> I<colour>
622 685
623Use the specified colour for the scrollbar [default #B2B2B2]. 686Use the specified colour for the scrollbar [default #B2B2B2].
624 687
630=item B<borderColor:> I<colour> 693=item B<borderColor:> I<colour>
631 694
632The 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
633and the text. 696and the text.
634 697
635=item B<backgroundPixmap:> I<file[;geom]> 698=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
636 699
637Use the specified XPM file (note the `.xpm' extension is optional) for 700Use the specified image file for the background and also optionally
638the background and also optionally specify its scaling with a geometry 701specify its scaling with a geometry string B<WxH+X+Y>,
639string B<WxH+X+Y>, in which B<"W" / "H"> specify the 702in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
640horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 703and B<"X" / "Y"> locate the image centre (percent).
641centre (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
642of 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
643specifies an integer number of images in that direction. No image will 706number of images in that direction. No image will be magnified beyond
644be magnified beyond 10 times its original size. The maximum permitted 70710 times its original size. The maximum permitted scale is 1000.
645scale 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]
646 723
647=item B<path:> I<path> 724=item B<path:> I<path>
648 725
649Specify the colon-delimited search path for finding XPM files. 726Specify the colon-delimited search path for finding background image files.
650 727
651=item B<font:> I<fontlist> 728=item B<font:> I<fontlist>
652 729
653Select 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
654that 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
712 789
713=item B<intensityStyles:> I<boolean> 790=item B<intensityStyles:> I<boolean>
714 791
715When 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>,
716option B<-is>, the default), bold and italic font styles imply high 793option B<-is>, the default), bold and italic font styles imply high
717intensity foreground/backround colours. Disabling this option (B<False>, 794intensity foreground/background colours. Disabling this option (B<False>,
718option B<+is>) disables this behaviour, the high intensity colours are not 795option B<+is>) disables this behaviour, the high intensity colours are not
719reachable. 796reachable.
720 797
721=item B<selectstyle:> I<mode> 798=item B<selectstyle:> I<mode>
722 799
723Set 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
724xterm 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
725xterm style selection. 802gives xterm style selection. Only effective when the original (non-perl)
803selection code is in use.
726 804
727=item B<scrollstyle:> I<mode> 805=item B<scrollstyle:> I<mode>
728 806
729Set 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
730the author's favourite. 808the author's favourite.
744=item B<mapAlert:> I<boolean> 822=item B<mapAlert:> I<boolean>
745 823
746B<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
747de-iconify (map) on receipt of a bell character [default]. 825de-iconify (map) on receipt of a bell character [default].
748 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
749=item B<visualBell:> I<boolean> 832=item B<visualBell:> I<boolean>
750 833
751B<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>.
752B<False>: no visual bell [default]; option B<+vb>. 835B<False>: no visual bell [default]; option B<+vb>.
753 836
774Example: 857Example:
775 858
776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 859 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777 860
778This 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
779everytime you hit C<Print>. 862every time you hit C<Print>.
780 863
781=item B<scrollBar:> I<boolean> 864=item B<scrollBar:> I<boolean>
782 865
783B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 866B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784disable the scrollbar; option B<+sb>. 867disable the scrollbar; option B<+sb>.
806 889
807=item B<scrollWithBuffer:> I<boolean> 890=item B<scrollWithBuffer:> I<boolean>
808 891
809B<True>: scroll with scrollback buffer when tty receives new lines (and 892B<True>: scroll with scrollback buffer when tty receives new lines (and
810B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 893B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
811with scrollback buffer when tty recieves new lines; option B<+sw>. 894with scrollback buffer when tty receives new lines; option B<+sw>.
812 895
813=item B<scrollTtyKeypress:> I<boolean> 896=item B<scrollTtyKeypress:> I<boolean>
814 897
815B<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
816are those which are intercepted by rxvt-unicode for special handling and 899are those which are intercepted by rxvt-unicode for special handling and
847=item B<termName:> I<termname> 930=item B<termName:> I<termname>
848 931
849Specifies 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
850variable; option B<-tn>. 933variable; option B<-tn>.
851 934
852=item B<linespace:> I<number> 935=item B<lineSpace:> I<number>
853 936
854Specifies number of lines (pixel height) to insert between each row of 937Specifies number of lines (pixel height) to insert between each row of
855the display [default 0]; option B<-lsp>. 938the display [default 0]; option B<-lsp>.
856 939
857=item B<meta8:> I<boolean> 940=item B<meta8:> I<boolean>
909=item B<cutchars:> I<string> 992=item B<cutchars:> I<string>
910 993
911The characters used as delimiters for double-click word selection 994The characters used as delimiters for double-click word selection
912(whitespace delimiting is added automatically if resource is given). 995(whitespace delimiting is added automatically if resource is given).
913 996
914When the selection extension is in use (the default if compiled in, see 997When the perl selection extension is in use (the default if compiled
915the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 998in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
916will be created (if the resource exists, otherwise, no regex will be 999characters will be created (if the resource exists, otherwise, no regex
917created). 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.
918 1001
919When 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
920be used. If not specified, the built-in default is used: 1003be used. If not specified, the built-in default is used:
921 1004
922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1005B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
981 1064
982Turn on/off secondary screen (default enabled). 1065Turn on/off secondary screen (default enabled).
983 1066
984=item B<secondaryScroll:> I<boolean> 1067=item B<secondaryScroll:> I<boolean>
985 1068
986Turn on/off secondary screen scroll (default enabled). If the this 1069Turn on/off secondary screen scroll (default enabled). If this
987option is enabled, scrolls on the secondary screen will change the 1070option is enabled, scrolls on the secondary screen will change the
988scrollback buffer and switching to/from the secondary screen will 1071scrollback buffer and switching to/from the secondary screen will
989instead scroll the screen up. 1072instead scroll the screen up.
990 1073
991=item B<hold>: I<boolean> 1074=item B<hold>: I<boolean>
1015searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1098searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1016omitting 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
1017keysym 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
1018performed in an exact manner; however, the closest match is assured. 1101performed in an exact manner; however, the closest match is assured.
1019 1102
1020I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1103I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1021C<\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.
1022C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1023C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024can start or end with whitespace.
1025
1026Please note that you need to double the C<\> in resource files, as
1027Xlib itself does it's own de-escaping (you can use C<\033> instead of
1028C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029processing).
1030 1105
1031You 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>
1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1107with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033should be a character not used by the strings. 1108should be a character not used by the strings.
1034 1109
1035Its usage can be demonstrated by an example: 1110Its usage can be demonstrated by an example:
1036 1111
1037 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1112 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1101example, C<default,-selection> will use all the default extension except 1176example, C<default,-selection> will use all the default extension except
1102C<selection>. 1177C<selection>.
1103 1178
1104Extension names can also be followed by an argument in angle brackets 1179Extension names can also be followed by an argument in angle brackets
1105(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
1106searchable scorllback to Alt/Meta-s). Mentioning the same extension 1181searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107multiple times with different arguments will pass multiple arguments to 1182multiple times with different arguments will pass multiple arguments to
1108the extension. 1183the extension.
1109 1184
1110Each extension is looked up in the library directories, loaded if 1185Each extension is looked up in the library directories, loaded if
1111necessary, and bound to the current terminal instance. 1186necessary, and bound to the current terminal instance.
1147(default: C<M-s>). 1222(default: C<M-s>).
1148 1223
1149=item B<urlLauncher>: I<string> 1224=item B<urlLauncher>: I<string>
1150 1225
1151Specifies 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
1152C<selection-popup> and C<mark-urls> perl extensions. 1227C<selection-popup> and C<matcher> perl extensions.
1153 1228
1154=item B<transient-for>: I<windowid> 1229=item B<transient-for>: I<windowid>
1155 1230
1156Compile 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.
1157 1232
1158=item B<override-redirect>: I<boolean> 1233=item B<override-redirect>: I<boolean>
1159 1234
1160Compile I<frills>: Sets override-redirect for the terminal window, making 1235Compile I<frills>: Sets override-redirect for the terminal window, making
1161it 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).
1162 1241
1163=back 1242=back
1164 1243
1165=head1 THE SCROLLBAR 1244=head1 THE SCROLLBAR
1166 1245
1185application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1264application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1265(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1187up 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),
1188respectively. 1267respectively.
1189 1268
1190=head1 TEXT SELECTION AND INSERTION 1269=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191 1270
1192The behaviour of text selection and insertion mechanism is similar to 1271The behaviour of text selection and insertion/pasting mechanism is similar
1193I<xterm>(1). 1272to I<xterm>(1).
1194 1273
1195=over 4 1274=over 4
1196 1275
1197=item B<Selection>: 1276=item B<Selecting>:
1198 1277
1199Left 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
1200and release; Right click to extend the marked region; Left double-click 1279and release; Right click to extend the marked region; Left double-click
1201to 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
1202(which can span multiple screen lines), unless modified by resource 1281(which can span multiple screen lines), unless modified by resource
1206(Compile: I<frills>) will create a rectangular selection instead of a 1285(Compile: I<frills>) will create a rectangular selection instead of a
1207normal 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
1208selection, and trailing whitespace is visually underlined and removed from 1287selection, and trailing whitespace is visually underlined and removed from
1209the selection. 1288the selection.
1210 1289
1211=item B<Insertion>: 1290=item B<Pasting>:
1212 1291
1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1292Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214window causes the value of the PRIMARY selection (or CLIPBOARD with the 1293window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215Meta 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.
1216 1295
1217Pressing 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
1218inserted too. 1297inserted too.
1219 1298
1220=back 1299=back
1237 1316
1238=head1 ISO 14755 SUPPORT 1317=head1 ISO 14755 SUPPORT
1239 1318
1240ISO 14755 is a standard for entering and viewing unicode characters 1319ISO 14755 is a standard for entering and viewing unicode characters
1241and character codes using the keyboard. It consists of 4 parts. The 1320and character codes using the keyboard. It consists of 4 parts. The
1242first part is available rxvt-unicode has been compiled with 1321first part is available if rxvt-unicode has been compiled with
1243C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1322C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244with C<--enable-iso14755>. 1323with C<--enable-iso14755>.
1245 1324
1246=over 4 1325=over 4
1247 1326
1267This mode lets you input characters representing the keycap symbols of 1346This mode lets you input characters representing the keycap symbols of
1268your keyboard, if representable in the current locale encoding. 1347your keyboard, if representable in the current locale encoding.
1269 1348
1270Start by pressing C<Control> and C<Shift> together, then releasing 1349Start by pressing C<Control> and C<Shift> together, then releasing
1271them. 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
1272invoke it's usual function but instead will insert the corresponding 1351invoke its usual function but instead will insert the corresponding
1273keycap 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
1274released, otherwise pressing e.g. C<Shift> would enter the symbol for 1353released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275C<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
1276reverse tab (Shift-Tab). 1355reverse tab (Shift-Tab).
1277 1356
1340It is also possible to specify the colour values of B<foreground>, 1419It is also possible to specify the colour values of B<foreground>,
1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1420B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342a 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
1343color0-color15. 1422color0-color15.
1344 1423
1345If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1424In addition to the colours defined above, @@RXVT_NAME@@ offers an
1346their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1425additional 72 colours. The first 64 of those (with indices 16 to 79)
1347(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB> 1426consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1348and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones 142716>), followed by 8 additional shades of gray (with indices 80 to 87).
1349provided by X, where the additional A component specifies alpha (opacity) 1428
1350values (0 is completely transparent and the maximum is opaque). You 1429Together, all those colours implement the 88 colour xterm colours. Only
1351probably need to specify B<"-depth 32">, too, and have the luck that your 1430the first 16 can be changed using resources currently, the rest can only
1352X-server uses ARGB pixel layout, as X is far from just supporting ARGB 1431be changed via command sequences ("escape codes").
1353visuals out of the box, and rxvt-unicode just fudges around.
1354 1432
1355Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1433Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1356always swapping the foreground/background colours. This is in contrast to 1434always swapping the foreground/background colours. This is in contrast to
1357I<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
1358been specified. For example, 1436been specified. For example,
1364would 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
1365on White. 1443on White.
1366 1444
1367=back 1445=back
1368 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
1369=head1 ENVIRONMENT 1471=head1 ENVIRONMENT
1370 1472
1371B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1473B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1372 1474
1373=over 4 1475=over 4
1374 1476
1375=item B<TERM> 1477=item B<TERM>
1376 1478
1377Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1479Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1378resources or on the commandline. 1480resources or on the command line.
1379 1481
1380=item B<COLORTERM> 1482=item B<COLORTERM>
1381 1483
1382Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1484Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1383compiled with XPM support, and optionally with the added extension 1485compiled with background image support, and optionally with the added
1384C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1486extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1487screen.
1385 1488
1386=item B<COLORFGBG> 1489=item B<COLORFGBG>
1387 1490
1388Set 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
1389the colour code used as default foreground/text colour (or the string 1492the colour code used as default foreground/text colour (or the string
1390C<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
1391used), 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
1392string 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@@
1393was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1496was compiled with background image support. Libraries like C<ncurses>
1394(and do) use this information to optimize screen output. 1497and C<slang> can (and do) use this information to optimize screen output.
1395 1498
1396=item B<WINDOWID> 1499=item B<WINDOWID>
1397 1500
1398Set 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
1399window, which usually has subwindows for the scrollbar, the terminal 1502window, which usually has subwindows for the scrollbar, the terminal
1405C<--with-terminfo=PATH>. 1508C<--with-terminfo=PATH>.
1406 1509
1407=item B<DISPLAY> 1510=item B<DISPLAY>
1408 1511
1409Used 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
1410display in it's child processes. 1513display in its child processes.
1411 1514
1412=item B<SHELL> 1515=item B<SHELL>
1413 1516
1414The 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>.
1415 1518
1457 1560
1458=item Project Coordinator 1561=item Project Coordinator
1459 1562
1460Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1563Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1461 1564
1462L<http://software.schmorp.de/#rxvt-unicode> 1565L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1463 1566
1464=back 1567=back
1465 1568
1466=head1 AUTHORS 1569=head1 AUTHORS
1467 1570
1490Project Coordinator (changes.txt 2.21a to 2.4.5) 1593Project Coordinator (changes.txt 2.21a to 2.4.5)
1491 1594
1492=item Geoff Wing L<< <gcw@pobox.com> >> 1595=item Geoff Wing L<< <gcw@pobox.com> >>
1493 1596
1494Rewrote screen display and text selection routines. 1597Rewrote screen display and text selection routines.
1495 1598
1496Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1599Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1497 1600
1498=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1601=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1499 1602
1500Forked 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