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.97 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.132 by root, Mon Jun 18 13:38:12 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 devenagari. 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>.
114
115=item B<-ss>|B<+ss>
116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
109 118
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 119=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 120
112Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 122B<-tr>; resource B<inheritPixmap>.
123
124I<Please note that transparency of any kind if completely unsupported by
125the author. Don't bug him with installation questions! Read the FAQ (man 7
126@@RXVT_NAME@@)!>
114 127
115=item B<-fade> I<number> 128=item B<-fade> I<number>
116 129
117Fade the text by the given percentage when focus is lost. Small values 130Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 131fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 132colour; resource B<fading>.
120 133
121=item B<-fadecolor> I<colour> 134=item B<-fadecolor> I<colour>
122 135
123Fade to this colour when fading is used (see B<-fade>). The default colour 136Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 137is opaque black. resource B<fadeColor>.
125 138
126=item B<-tint> I<colour> 139=item B<-tint> I<colour>
127 140
128Tint the transparent background pixmap with the given colour when 141Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 142transparency is enabled with B<-tr> or B<-ip>. This only works for
131used to brighten or darken the image in addition to tinting it; resource 144used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example: 145I<tintColor>. Example:
133 146
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 147 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 148
136=item B<-sh> 149=item B<-sh> I<number>
137 150
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 151Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 152background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 153resource I<shading>.
154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159transparency image, using method specified. Supported values are :
160B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending; resource I<blendType>.
164
165=item B<-blr> I<number>
166
167Apply Gaussian Blur with the specified radius to the transparent
168background image; resource I<blurRadius>.
141 169
142=item B<-bg> I<colour> 170=item B<-bg> I<colour>
143 171
144Window background colour; resource B<background>. 172Window background colour; resource B<background>.
145 173
147 175
148Window foreground colour; resource B<foreground>. 176Window foreground colour; resource B<foreground>.
149 177
150=item B<-pixmap> I<file[;geom]> 178=item B<-pixmap> I<file[;geom]>
151 179
152Compile I<XPM>: Specify XPM file for the background and also optionally 180Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 181optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 182add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 183command-line; for more details see resource B<backgroundPixmap>.
156 184
157=item B<-cr> I<colour> 185=item B<-cr> I<colour>
158 186
159The cursor colour; resource B<cursorColor>. 187The cursor colour; resource B<cursorColor>.
160 188
177that are checked in order when trying to find glyphs for characters. The 205that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 206first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 207smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 208font list is always appended to it. See resource B<font> for more details.
181 209
182In short, to specify an X11 core font, just specify it's name or prefix it 210In 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:>, 211with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 212e.g.:
185 213
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 214 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 215 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
296=item B<-bl> 324=item B<-bl>
297 325
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 326Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 327if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 328decorations; resource B<borderLess>.
329
330=item B<-override-redirect>
331
332Compile I<frills>: Sets override-redirect on the window; resource
333B<override-redirect>.
301 334
302=item B<-sbg> 335=item B<-sbg>
303 336
304Compile I<frills>: Disable the usage of the built-in block graphics/line 337Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 338drawing characters and just rely on what the specified fonts provide. Use
372for more info. 405for more info.
373 406
374=item B<-tcw> 407=item B<-tcw>
375 408
376Change the meaning of triple-click selection with the left mouse 409Change the meaning of triple-click selection with the left mouse
410button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 411in-use. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>. 412end of the logical line only. resource B<tripleclickwords>.
379 413
380=item B<-insecure> 414=item B<-insecure>
381 415
382Enable "insecure" mode, which currently enables most of the escape 416Enable "insecure" mode, which currently enables most of the escape
410 444
411Remap a key symbol. See resource B<keysym>. 445Remap a key symbol. See resource B<keysym>.
412 446
413=item B<-embed> I<windowid> 447=item B<-embed> I<windowid>
414 448
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 449Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 450which enables applications to easily embed a terminal.
417 451
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 452Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 453shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to 454quite a bit, so don't expect it to keep some specific state. It's best to
423The window will not be destroyed when @@RXVT_NAME@@ exits. 457The window will not be destroyed when @@RXVT_NAME@@ exits.
424 458
425It might be useful to know that @@RXVT_NAME@@ will not close file 459It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you 460descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 461can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 462terminal. This works regardless of whether the C<-embed> option was used or
429not. 463not.
430 464
431Here is a short Gtk2-perl snippet that illustrates how this option can be 465Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 466used (a longer example is in F<doc/embed>):
433 467
438 }); 472 });
439 473
440=item B<-pty-fd> I<file descriptor> 474=item B<-pty-fd> I<file descriptor>
441 475
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 476Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is 477pair but instead use the given file descriptor as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 478useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 479without having to run a program within it.
446 480
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 481If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that 482entries and will not tinker with pty/tty permissions - you have to do that
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 534check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 535extensions not documented here):
502 536
503=over 4 537=over 4
504 538
539=item B<depth:> I<bitdepth>
540
541Compile I<xft>: Attempt to find a visual with the given bit depth;
542option B<-depth>.
543
505=item B<geometry:> I<geom> 544=item B<geometry:> I<geom>
506 545
507Create the window with the specified X window geometry [default 80x24]; 546Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 547option B<-geometry>.
509 548
545Use the specified colour to display underlined characters when the 584Use the specified colour to display underlined characters when the
546foreground colour is the default. 585foreground colour is the default.
547 586
548=item B<colorRV:> I<colour> 587=item B<colorRV:> I<colour>
549 588
550Use the specified colour as the background for reverse video 589Use the specified colour as the background for reverse video characters
551characters. 590when OPTION_HC is disabled (--disable-frills).
552 591
553=item B<underlineColor:> I<colour> 592=item B<underlineColor:> I<colour>
554 593
555If set, use the specified colour as the colour for the underline 594If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour. 595itself. If unset, use the foreground colour.
572option B<-rv>. B<False>: regular screen colours [default]; option 611option B<-rv>. B<False>: regular screen colours [default]; option
573B<+rv>. See note in B<COLORS AND GRAPHICS> section. 612B<+rv>. See note in B<COLORS AND GRAPHICS> section.
574 613
575=item B<jumpScroll:> I<boolean> 614=item B<jumpScroll:> I<boolean>
576 615
577B<True>: specify that jump scrolling should be used. When scrolling 616B<True>: specify that jump scrolling should be used. When receiving lots
578quickly, fewer screen updates are performed [default]; option B<-j>. 617of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
618has been read, resulting in fewer updates while still displaying every
619received line; option B<-j>.
620
579B<False>: specify that smooth scrolling should be used; option B<+j>. 621B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
622force a screen refresh on each new line it received; option B<+j>.
623
624=item B<skipScroll:> I<boolean>
625
626B<True>: (the default) specify that skip scrolling should be used. When
627receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
628(around 60 times per second), resulting in far fewer updates. This can
629result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
630option B<-ss>.
631
632B<False>: specify that everything is to be displayed, even
633if the refresh is too fast for the human eye to read anything (or the
634monitor to display anything); option B<+ss>.
580 635
581=item B<inheritPixmap:> I<boolean> 636=item B<inheritPixmap:> I<boolean>
582 637
583B<True>: make the background inherit the parent windows' pixmap, giving 638B<True>: make the background inherit the parent windows' pixmap, giving
584artificial transparency. B<False>: do not inherit the parent windows' 639artificial transparency. B<False>: do not inherit the parent windows'
585pixmap. 640pixmap.
586 641
642I<Please note that transparency of any kind if completely unsupported by
643the author. Don't bug him with installation questions!>
644
587=item B<fading:> I<number> 645=item B<fading:> I<number>
588 646
589Fade the text by the given percentage when focus is lost; option B<-fade>. 647Fade the text by the given percentage when focus is lost; option B<-fade>.
590 648
591=item B<fadeColor:> I<colour> 649=item B<fadeColor:> I<colour>
598Tint the transparent background pixmap with the given colour; option 656Tint the transparent background pixmap with the given colour; option
599B<-tint>. 657B<-tint>.
600 658
601=item B<shading:> I<number> 659=item B<shading:> I<number>
602 660
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 661Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604image in addition to tinting it. 662in addition to tinting it; option B<-sh>.
663
664=item B<blendType:> I<string>
665
666Specify background blending type; option B<-blt>.
667
668=item B<blurRadius:> I<number>
669
670Apply Gaussian Blurr with the specified radius to the transparent
671background image; option B<-blr>.
605 672
606=item B<scrollColor:> I<colour> 673=item B<scrollColor:> I<colour>
607 674
608Use the specified colour for the scrollbar [default #B2B2B2]. 675Use the specified colour for the scrollbar [default #B2B2B2].
609 676
617The colour of the border around the text area and between the scrollbar 684The colour of the border around the text area and between the scrollbar
618and the text. 685and the text.
619 686
620=item B<backgroundPixmap:> I<file[;geom]> 687=item B<backgroundPixmap:> I<file[;geom]>
621 688
622Use the specified XPM file (note the `.xpm' extension is optional) for 689Use the specified image file for the background and also optionally
623the background and also optionally specify its scaling with a geometry 690specify its scaling with a geometry string B<WxH+X+Y>,
624string B<WxH+X+Y>, in which B<"W" / "H"> specify the 691in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
625horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 692and B<"X" / "Y"> locate the image centre (percent).
626centre (percent). A scale of 0 displays the image with tiling. A scale 693A scale of 0 displays the image with tiling. A scale of 1 displays the
627of 1 displays the image without any scaling. A scale of 2 to 9 694image without any scaling. A scale of 2 to 9 specifies an integer
628specifies an integer number of images in that direction. No image will 695number of images in that direction. No image will be magnified beyond
629be magnified beyond 10 times its original size. The maximum permitted 69610 times its original size. The maximum permitted scale is 1000.
630scale is 1000. [default 0x0+50+50] 697Special string of B<"auto"> used as a geometry will cause image to be
698automatically scaled to match window size.
699If used in conjunction with B<-tr> option - specified pixmap will be
700blended over transparency image using either alpha-blending, or any
701other blending type, specified with B<-blt "type"> option.
702[default 0x0+50+50]
631 703
632=item B<path:> I<path> 704=item B<path:> I<path>
633 705
634Specify the colon-delimited search path for finding XPM files. 706Specify the colon-delimited search path for finding XPM files.
635 707
697 769
698=item B<intensityStyles:> I<boolean> 770=item B<intensityStyles:> I<boolean>
699 771
700When font styles are not enabled, or this option is enabled (B<True>, 772When font styles are not enabled, or this option is enabled (B<True>,
701option B<-is>, the default), bold and italic font styles imply high 773option B<-is>, the default), bold and italic font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>, 774intensity foreground/background colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not 775option B<+is>) disables this behaviour, the high intensity colours are not
704reachable. 776reachable.
705 777
706=item B<selectstyle:> I<mode> 778=item B<selectstyle:> I<mode>
707 779
708Set mouse selection style to B<old> which is 2.20, B<oldword> which is 780Set mouse selection style to B<old> which is 2.20, B<oldword> which
709xterm style with 2.20 old word selection, or anything else which gives 781is xterm style with 2.20 old word selection, or anything else which
710xterm style selection. 782gives xterm style selection. Only effective when the original (non-perl)
783selection code is in use.
711 784
712=item B<scrollstyle:> I<mode> 785=item B<scrollstyle:> I<mode>
713 786
714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 787Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715the author's favourite. 788the author's favourite.
729=item B<mapAlert:> I<boolean> 802=item B<mapAlert:> I<boolean>
730 803
731B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 804B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732de-iconify (map) on receipt of a bell character [default]. 805de-iconify (map) on receipt of a bell character [default].
733 806
807=item B<urgentOnBell:> I<boolean>
808
809B<True>: set the urgency hint for the wm on receipt of a bell character.
810B<False>: do not set the urgency hint [default].
811
734=item B<visualBell:> I<boolean> 812=item B<visualBell:> I<boolean>
735 813
736B<True>: use visual bell on receipt of a bell character; option B<-vb>. 814B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737B<False>: no visual bell [default]; option B<+vb>. 815B<False>: no visual bell [default]; option B<+vb>.
738 816
759Example: 837Example:
760 838
761 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 839 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762 840
763This creates a new file in your home directory with the screen contents 841This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>. 842every time you hit C<Print>.
765 843
766=item B<scrollBar:> I<boolean> 844=item B<scrollBar:> I<boolean>
767 845
768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 846B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769disable the scrollbar; option B<+sb>. 847disable the scrollbar; option B<+sb>.
791 869
792=item B<scrollWithBuffer:> I<boolean> 870=item B<scrollWithBuffer:> I<boolean>
793 871
794B<True>: scroll with scrollback buffer when tty receives new lines (and 872B<True>: scroll with scrollback buffer when tty receives new lines (and
795B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 873B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
796with scrollback buffer when tty recieves new lines; option B<+sw>. 874with scrollback buffer when tty receives new lines; option B<+sw>.
797 875
798=item B<scrollTtyKeypress:> I<boolean> 876=item B<scrollTtyKeypress:> I<boolean>
799 877
800B<True>: scroll to bottom when a non-special key is pressed. Special keys 878B<True>: scroll to bottom when a non-special key is pressed. Special keys
801are those which are intercepted by rxvt-unicode for special handling and 879are those which are intercepted by rxvt-unicode for special handling and
891pressed. If unset it will send the sequence traditionally associated 969pressed. If unset it will send the sequence traditionally associated
892with the B<Execute> key. 970with the B<Execute> key.
893 971
894=item B<cutchars:> I<string> 972=item B<cutchars:> I<string>
895 973
896The characters used as delimiters for double-click word selection. The 974The characters used as delimiters for double-click word selection
897built-in default: 975(whitespace delimiting is added automatically if resource is given).
976
977When the perl selection extension is in use (the default if compiled
978in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
979characters will be created (if the resource exists, otherwise, no regex
980will be created). In this mode, characters outside ISO-8859-1 can be used.
981
982When the selection extension is not used, only ISO-8859-1 characters can
983be used. If not specified, the built-in default is used:
898 984
899B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 985B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
900 986
901=item B<preeditType:> I<style> 987=item B<preeditType:> I<style>
902 988
952 1038
953Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1039Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
954character is passed through. It may contain escape values as described 1040character is passed through. It may contain escape values as described
955in the entry on B<keysym> following. 1041in the entry on B<keysym> following.
956 1042
957=item B<secondaryScreen:> I<bool> 1043=item B<secondaryScreen:> I<boolean>
958 1044
959Turn on/off secondary screen (default enabled). 1045Turn on/off secondary screen (default enabled).
960 1046
961=item B<secondaryScroll:> I<bool> 1047=item B<secondaryScroll:> I<boolean>
962 1048
963Turn on/off secondary screen scroll (default enabled). If the this 1049Turn on/off secondary screen scroll (default enabled). If this
964option is enabled, scrolls on the secondary screen will change the 1050option is enabled, scrolls on the secondary screen will change the
965scrollback buffer and switching to/from the secondary screen will 1051scrollback buffer and switching to/from the secondary screen will
966instead scroll the screen up. 1052instead scroll the screen up.
967 1053
968=item B<hold>: I<bool> 1054=item B<hold>: I<boolean>
969 1055
970Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1056Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971will not immediately destroy its window when the program executed within 1057will not immediately destroy its window when the program executed within
972it exits. Instead, it will wait till it is being killed or closed by the 1058it exits. Instead, it will wait till it is being killed or closed by the
973user. 1059user.
996 1082
997I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1083I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
998C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1084C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
999C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1085C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1000C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1086C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1001can start or end with whitespace. 1087can start or end with whitespace. B<This feature is deprecated and will
1088be removed>.
1002 1089
1003Please note that you need to double the C<\> in resource files, as 1090Please note that you need to double the C<\> in resource files, as
1004Xlib itself does it's own de-escaping (you can use C<\033> instead of 1091Xlib itself does its own de-escaping (you can use C<\033> instead of
1005C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1092C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1006processing). 1093processing).
1007 1094
1008You can define a range of keysyms in one shot by providing a I<string> 1095You can define a range of keysyms in one shot by providing a I<string>
1009with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1096with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1010should be a character not used by the strings. 1097should be a character not used by the strings.
1011 1098
1012Its usage can be demonstrated by an example: 1099Its usage can be demonstrated by an example:
1013 1100
1014 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1101 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1078example, C<default,-selection> will use all the default extension except 1165example, C<default,-selection> will use all the default extension except
1079C<selection>. 1166C<selection>.
1080 1167
1081Extension names can also be followed by an argument in angle brackets 1168Extension names can also be followed by an argument in angle brackets
1082(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1169(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1083searchable scorllback to Alt/Meta-s). Mentioning the same extension 1170searchable scrollback to Alt/Meta-s). Mentioning the same extension
1084multiple times with different arguments will pass multiple arguments to 1171multiple times with different arguments will pass multiple arguments to
1085the extension. 1172the extension.
1086 1173
1087Each extension is looked up in the library directories, loaded if 1174Each extension is looked up in the library directories, loaded if
1088necessary, and bound to the current terminal instance. 1175necessary, and bound to the current terminal instance.
1124(default: C<M-s>). 1211(default: C<M-s>).
1125 1212
1126=item B<urlLauncher>: I<string> 1213=item B<urlLauncher>: I<string>
1127 1214
1128Specifies the program to be started with a URL argument. Used by the 1215Specifies the program to be started with a URL argument. Used by the
1129C<selection-popup> and C<mark-urls> perl extensions. 1216C<selection-popup> and C<matcher> perl extensions.
1130 1217
1131=item B<transient-for>: I<windowid> 1218=item B<transient-for>: I<windowid>
1132 1219
1133Sets the WM_TRANSIENT_FOR property to the given window iw. 1220Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1221
1222=item B<override-redirect>: I<boolean>
1223
1224Compile I<frills>: Sets override-redirect for the terminal window, making
1225it almost invisible to window managers; option B<-override-redirect>.
1226
1227=item B<iso14755_52:> I<boolean>
1228
1229Turn on/off ISO 14755 5.2 mode (default enabled).
1134 1230
1135=back 1231=back
1136 1232
1137=head1 THE SCROLLBAR 1233=head1 THE SCROLLBAR
1138 1234
1157application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1253application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1158(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1254(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1159up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1255up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1160respectively. 1256respectively.
1161 1257
1162=head1 TEXT SELECTION AND INSERTION 1258=head1 THE SELECTION: SELECTING AND PASTING TEXT
1163 1259
1164The behaviour of text selection and insertion mechanism is similar to 1260The behaviour of text selection and insertion/pasting mechanism is similar
1165I<xterm>(1). 1261to I<xterm>(1).
1166 1262
1167=over 4 1263=over 4
1168 1264
1169=item B<Selection>: 1265=item B<Selecting>:
1170 1266
1171Left click at the beginning of the region, drag to the end of the region 1267Left click at the beginning of the region, drag to the end of the region
1172and release; Right click to extend the marked region; Left double-click 1268and release; Right click to extend the marked region; Left double-click
1173to select a word; Left triple-click to select the entire logical line 1269to select a word; Left triple-click to select the entire logical line
1174(which can span multiple screen lines), unless modified by resource 1270(which can span multiple screen lines), unless modified by resource
1178(Compile: I<frills>) will create a rectangular selection instead of a 1274(Compile: I<frills>) will create a rectangular selection instead of a
1179normal one. In this mode, every selected row becomes its own line in the 1275normal one. In this mode, every selected row becomes its own line in the
1180selection, and trailing whitespace is visually underlined and removed from 1276selection, and trailing whitespace is visually underlined and removed from
1181the selection. 1277the selection.
1182 1278
1183=item B<Insertion>: 1279=item B<Pasting>:
1184 1280
1185Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1281Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1186an B<@@RXVT_NAME@@> window causes the current text selection to be 1282window causes the value of the PRIMARY selection (or CLIPBOARD with the
1187inserted as if it had been typed on the keyboard. 1283B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1284
1285Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1286inserted too.
1188 1287
1189=back 1288=back
1190 1289
1191=head1 CHANGING FONTS 1290=head1 CHANGING FONTS
1192 1291
1236This mode lets you input characters representing the keycap symbols of 1335This mode lets you input characters representing the keycap symbols of
1237your keyboard, if representable in the current locale encoding. 1336your keyboard, if representable in the current locale encoding.
1238 1337
1239Start by pressing C<Control> and C<Shift> together, then releasing 1338Start by pressing C<Control> and C<Shift> together, then releasing
1240them. The next special key (cursor keys, home etc.) you enter will not 1339them. The next special key (cursor keys, home etc.) you enter will not
1241invoke it's usual function but instead will insert the corresponding 1340invoke its usual function but instead will insert the corresponding
1242keycap symbol. The symbol will only be entered when the key has been 1341keycap symbol. The symbol will only be entered when the key has been
1243released, otherwise pressing e.g. C<Shift> would enter the symbol for 1342released, otherwise pressing e.g. C<Shift> would enter the symbol for
1244C<ISO Level 2 Switch>, although your intention might have been to enter a 1343C<ISO Level 2 Switch>, although your intention might have been to enter a
1245reverse tab (Shift-Tab). 1344reverse tab (Shift-Tab).
1246 1345
1279=head1 COLORS AND GRAPHICS 1378=head1 COLORS AND GRAPHICS
1280 1379
1281In addition to the default foreground and background colours, 1380In addition to the default foreground and background colours,
1282B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1381B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1283high-intensity bold/blink versions of the same). Here is a list of the 1382high-intensity bold/blink versions of the same). Here is a list of the
1284colours with their B<rgb.txt> names. 1383colours with their names.
1285 1384
1286=begin table 1385=begin table
1287 1386
1288 B<color0> (black) = Black 1387 B<color0> (black) = Black
1289 B<color1> (red) = Red3 1388 B<color1> (red) = Red3
1309It is also possible to specify the colour values of B<foreground>, 1408It is also possible to specify the colour values of B<foreground>,
1310B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1409B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1311a number 0-15, as a convenient shorthand to reference the colour name of 1410a number 0-15, as a convenient shorthand to reference the colour name of
1312color0-color15. 1411color0-color15.
1313 1412
1413In addition to the colours defined above, @@RXVT_NAME@@ offers an
1414additional 72 colours. The first 64 of those (with indices 16 to 79)
1415consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141616>), followed by 8 additional shades of gray (with indices 80 to 87).
1417
1418Together, all those colours implement the 88 colour xterm colours. Only
1419the first 16 can be changed using resources currently, the rest can only
1420be changed via command sequences ("escape codes").
1421
1314Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1422Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1315always swapping the foreground/background colours. This is in contrast to 1423always swapping the foreground/background colours. This is in contrast to
1316I<xterm>(1) where the colours are only swapped if they have not otherwise 1424I<xterm>(1) where the colours are only swapped if they have not otherwise
1317been specified. For example, 1425been specified. For example,
1318 1426
1323would yield White on Black, while on I<xterm>(1) it would yield Black 1431would yield White on Black, while on I<xterm>(1) it would yield Black
1324on White. 1432on White.
1325 1433
1326=back 1434=back
1327 1435
1436=head2 ALPHA CHANNEL SUPPORT
1437
1438If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1439their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1440(recommended, but B<MUST> have 4 digits/component) colour specifications,
1441in addition to the ones provided by X, where the additional A component
1442specifies opacity (alpha) values. The minimum value of C<0> is completely
1443transparent). You can also prefix any color with C<[percent]>, where
1444C<percent> is a decimal percentage (0-100) that specifies the opacity of
1445the color, where C<0> is completely transparent and C<100> is completelxy
1446opaque.
1447
1448You probably need to specify B<"-depth 32">, too, and have the luck that
1449your X-server uses ARGB pixel layout, as X is far from just supporting
1450ARGB visuals out of the box, and rxvt-unicode just fudges around.
1451
1452For example, the following selects an almost completely transparent red
1453background, and an almost opaque pink foreground:
1454
1455 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1456
1457I<Please note that transparency of any kind if completely unsupported by
1458the author. Don't bug him with installation questions!>
1459
1328=head1 ENVIRONMENT 1460=head1 ENVIRONMENT
1329 1461
1330B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1462B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1331 1463
1332=over 4 1464=over 4
1333 1465
1334=item B<TERM> 1466=item B<TERM>
1335 1467
1336Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1468Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1337resources or on the commandline. 1469resources or on the command line.
1338 1470
1339=item B<COLORTERM> 1471=item B<COLORTERM>
1340 1472
1341Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1473Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1342compiled with XPM support, and optionally with the added extension 1474compiled with XPM support, and optionally with the added extension
1343C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1475C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1344 1476
1345=item B<COLORFGBG> 1477=item B<COLORFGBG>
1346 1478
1364C<--with-terminfo=PATH>. 1496C<--with-terminfo=PATH>.
1365 1497
1366=item B<DISPLAY> 1498=item B<DISPLAY>
1367 1499
1368Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1500Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1369display in it's child processes. 1501display in its child processes.
1370 1502
1371=item B<SHELL> 1503=item B<SHELL>
1372 1504
1373The shell to be used for command execution, defaults to C</bin/sh>. 1505The shell to be used for command execution, defaults to C</bin/sh>.
1374
1375=item B<RXVTPATH>
1376
1377The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1378files.
1379
1380=item B<PATH>
1381
1382Used in the same way as C<RXVTPATH>.
1383 1506
1384=item B<RXVT_SOCKET> 1507=item B<RXVT_SOCKET>
1385 1508
1386The unix domain socket path used by @@RXVT_NAME@@c(1) and 1509The unix domain socket path used by @@RXVT_NAME@@c(1) and
1387@@RXVT_NAME@@d(1). 1510@@RXVT_NAME@@d(1).
1425 1548
1426=item Project Coordinator 1549=item Project Coordinator
1427 1550
1428Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1551Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1429 1552
1430L<http://software.schmorp.de/#rxvt-unicode> 1553L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1431 1554
1432=back 1555=back
1433 1556
1434=head1 AUTHORS 1557=head1 AUTHORS
1435 1558
1457 1580
1458Project Coordinator (changes.txt 2.21a to 2.4.5) 1581Project Coordinator (changes.txt 2.21a to 2.4.5)
1459 1582
1460=item Geoff Wing L<< <gcw@pobox.com> >> 1583=item Geoff Wing L<< <gcw@pobox.com> >>
1461 1584
1462Rewrote screen display and text selection routines. Project Coordinator 1585Rewrote screen display and text selection routines.
1586
1463(changes.txt 2.4.6 - rxvt-unicode) 1587Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1464 1588
1465=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1589=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1466 1590
1467Forked rxvt-unicode, rewrote most of the display code and internal 1591Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1468character handling to store text in unicode, improve xterm 1592extension, random hacks, numerous bugfixes and extensions.
1469compatibility and apply numerous other bugfixes and extensions.
1470 1593
1471Project Coordinator (Changes 1.0 -) 1594Project Coordinator (Changes 1.0 -)
1472 1595
1596=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1597
1598Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1599
1473=back 1600=back
1474 1601

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines