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.101 by ayin, Thu Jan 19 23:18:55 2006 UTC vs.
Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC

17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 108
104Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
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
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 143non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 144used to brighten or darken the image in addition to tinting it.
145Please note that certain tint colours can be applied on the server-side,
146thus yielding performance gain of two orders of magnitude. These colours are:
147blue, red, green, cyan, magenta, yellow, and those close to them; resource
132I<tintColor>. Example: 148I<tintColor>. Example:
133 149
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 150 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 151
136=item B<-sh> 152=item B<-sh> I<number>
137 153
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 154Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 155background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 156resource I<shading>.
157
158=item B<-blt> I<string>
159
160Specify background blending type. If background pixmap is specified
161at the same time as transparency - such pixmap will be blended over
162transparency image, using method specified. Supported values are :
163B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
164B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166alpha-blending; resource I<blendType>.
167
168=item B<-blr> I<HxV>
169
170Apply Gaussian Blur with the specified radii to the transparent
171background image. If single number is specified - both vertical and
172horizontal radii are considered to be the same. Setting one of the
173radii to 1 and another to a large number creates interesting effects
174on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
141 175
142=item B<-bg> I<colour> 176=item B<-bg> I<colour>
143 177
144Window background colour; resource B<background>. 178Window background colour; resource B<background>.
145 179
147 181
148Window foreground colour; resource B<foreground>. 182Window foreground colour; resource B<foreground>.
149 183
150=item B<-pixmap> I<file[;geom]> 184=item B<-pixmap> I<file[;geom]>
151 185
152Compile I<XPM>: Specify XPM file for the background and also optionally 186Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 187optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 188add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 189command-line; for more details see resource B<backgroundPixmap>.
156 190
157=item B<-cr> I<colour> 191=item B<-cr> I<colour>
158 192
159The cursor colour; resource B<cursorColor>. 193The cursor colour; resource B<cursorColor>.
160 194
177that are checked in order when trying to find glyphs for characters. The 211that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 212first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 213smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 214font list is always appended to it. See resource B<font> for more details.
181 215
182In short, to specify an X11 core font, just specify it's name or prefix it 216In 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:>, 217with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 218e.g.:
185 219
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 220 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 221 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
377for more info. 411for more info.
378 412
379=item B<-tcw> 413=item B<-tcw>
380 414
381Change the meaning of triple-click selection with the left mouse 415Change the meaning of triple-click selection with the left mouse
416button. Only effective when the original (non-perl) selection code is
382button. Instead of selecting a full line it will extend the selection the 417in-use. Instead of selecting a full line it will extend the selection the
383end of the logical line only. resource B<tripleclickwords>. 418end of the logical line only. resource B<tripleclickwords>.
384 419
385=item B<-insecure> 420=item B<-insecure>
386 421
387Enable "insecure" mode, which currently enables most of the escape 422Enable "insecure" mode, which currently enables most of the escape
415 450
416Remap a key symbol. See resource B<keysym>. 451Remap a key symbol. See resource B<keysym>.
417 452
418=item B<-embed> I<windowid> 453=item B<-embed> I<windowid>
419 454
420Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 455Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
421which enables applications to easily embed a terminal. 456which enables applications to easily embed a terminal.
422 457
423Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 458Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
424shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 459shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
425quite a bit, so don't expect it to keep some specific state. It's best to 460quite a bit, so don't expect it to keep some specific state. It's best to
428The window will not be destroyed when @@RXVT_NAME@@ exits. 463The window will not be destroyed when @@RXVT_NAME@@ exits.
429 464
430It might be useful to know that @@RXVT_NAME@@ will not close file 465It might be useful to know that @@RXVT_NAME@@ will not close file
431descriptors passed to it (except for stdin/out/err, of course), so you 466descriptors passed to it (except for stdin/out/err, of course), so you
432can use file descriptors to communicate with the programs within the 467can use file descriptors to communicate with the programs within the
433terminal. This works regardless of wether the C<-embed> option was used or 468terminal. This works regardless of whether the C<-embed> option was used or
434not. 469not.
435 470
436Here is a short Gtk2-perl snippet that illustrates how this option can be 471Here is a short Gtk2-perl snippet that illustrates how this option can be
437used (a longer example is in F<doc/embed>): 472used (a longer example is in F<doc/embed>):
438 473
443 }); 478 });
444 479
445=item B<-pty-fd> I<file descriptor> 480=item B<-pty-fd> I<file descriptor>
446 481
447Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 482Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
448pair but instead use the given filehandle as the tty master. This is 483pair but instead use the given file descriptor as the tty master. This is
449useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 484useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
450without having to run a program within it. 485without having to run a program within it.
451 486
452If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 487If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
453entries and will not tinker with pty/tty permissions - you have to do that 488entries and will not tinker with pty/tty permissions - you have to do that
505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 540check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here): 541extensions not documented here):
507 542
508=over 4 543=over 4
509 544
545=item B<depth:> I<bitdepth>
546
547Compile I<xft>: Attempt to find a visual with the given bit depth;
548option B<-depth>.
549
510=item B<geometry:> I<geom> 550=item B<geometry:> I<geom>
511 551
512Create the window with the specified X window geometry [default 80x24]; 552Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 553option B<-geometry>.
514 554
550Use the specified colour to display underlined characters when the 590Use the specified colour to display underlined characters when the
551foreground colour is the default. 591foreground colour is the default.
552 592
553=item B<colorRV:> I<colour> 593=item B<colorRV:> I<colour>
554 594
555Use the specified colour as the background for reverse video 595Use the specified colour as the background for reverse video characters
556characters. 596when OPTION_HC is disabled (--disable-frills).
557 597
558=item B<underlineColor:> I<colour> 598=item B<underlineColor:> I<colour>
559 599
560If set, use the specified colour as the colour for the underline 600If set, use the specified colour as the colour for the underline
561itself. If unset, use the foreground colour. 601itself. If unset, use the foreground colour.
577option B<-rv>. B<False>: regular screen colours [default]; option 617option B<-rv>. B<False>: regular screen colours [default]; option
578B<+rv>. See note in B<COLORS AND GRAPHICS> section. 618B<+rv>. See note in B<COLORS AND GRAPHICS> section.
579 619
580=item B<jumpScroll:> I<boolean> 620=item B<jumpScroll:> I<boolean>
581 621
582B<True>: specify that jump scrolling should be used. When scrolling 622B<True>: specify that jump scrolling should be used. When receiving lots
583quickly, fewer screen updates are performed [default]; option B<-j>. 623of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
624has been read, resulting in fewer updates while still displaying every
625received line; option B<-j>.
626
584B<False>: specify that smooth scrolling should be used; option B<+j>. 627B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
628force a screen refresh on each new line it received; option B<+j>.
629
630=item B<skipScroll:> I<boolean>
631
632B<True>: (the default) specify that skip scrolling should be used. When
633receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
634(around 60 times per second), resulting in far fewer updates. This can
635result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
636option B<-ss>.
637
638B<False>: specify that everything is to be displayed, even
639if the refresh is too fast for the human eye to read anything (or the
640monitor to display anything); option B<+ss>.
585 641
586=item B<inheritPixmap:> I<boolean> 642=item B<inheritPixmap:> I<boolean>
587 643
588B<True>: make the background inherit the parent windows' pixmap, giving 644B<True>: make the background inherit the parent windows' pixmap, giving
589artificial transparency. B<False>: do not inherit the parent windows' 645artificial transparency. B<False>: do not inherit the parent windows'
590pixmap. 646pixmap.
591 647
648I<Please note that transparency of any kind if completely unsupported by
649the author. Don't bug him with installation questions!>
650
592=item B<fading:> I<number> 651=item B<fading:> I<number>
593 652
594Fade the text by the given percentage when focus is lost; option B<-fade>. 653Fade the text by the given percentage when focus is lost; option B<-fade>.
595 654
596=item B<fadeColor:> I<colour> 655=item B<fadeColor:> I<colour>
603Tint the transparent background pixmap with the given colour; option 662Tint the transparent background pixmap with the given colour; option
604B<-tint>. 663B<-tint>.
605 664
606=item B<shading:> I<number> 665=item B<shading:> I<number>
607 666
608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 667Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
609image in addition to tinting it. 668in addition to tinting it; option B<-sh>.
669
670=item B<blendType:> I<string>
671
672Specify background blending type; option B<-blt>.
673
674=item B<blurRadius:> I<number>
675
676Apply Gaussian Blurr with the specified radius to the transparent
677background image; option B<-blr>.
610 678
611=item B<scrollColor:> I<colour> 679=item B<scrollColor:> I<colour>
612 680
613Use the specified colour for the scrollbar [default #B2B2B2]. 681Use the specified colour for the scrollbar [default #B2B2B2].
614 682
622The colour of the border around the text area and between the scrollbar 690The colour of the border around the text area and between the scrollbar
623and the text. 691and the text.
624 692
625=item B<backgroundPixmap:> I<file[;geom]> 693=item B<backgroundPixmap:> I<file[;geom]>
626 694
627Use the specified XPM file (note the `.xpm' extension is optional) for 695Use the specified image file for the background and also optionally
628the background and also optionally specify its scaling with a geometry 696specify its scaling with a geometry string B<WxH+X+Y>,
629string B<WxH+X+Y>, in which B<"W" / "H"> specify the 697in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
630horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 698and B<"X" / "Y"> locate the image centre (percent).
631centre (percent). A scale of 0 displays the image with tiling. A scale 699A scale of 0 displays the image with tiling. A scale of 1 displays the
632of 1 displays the image without any scaling. A scale of 2 to 9 700image without any scaling. A scale of 2 to 9 specifies an integer
633specifies an integer number of images in that direction. No image will 701number of images in that direction. No image will be magnified beyond
634be magnified beyond 10 times its original size. The maximum permitted 70210 times its original size. The maximum permitted scale is 1000.
635scale is 1000. [default 0x0+50+50] 703Special string of B<"auto"> used as a geometry will cause image to be
704automatically scaled to match window size.
705If used in conjunction with B<-tr> option - specified pixmap will be
706blended over transparency image using either alpha-blending, or any
707other blending type, specified with B<-blt "type"> option.
708[default 0x0+50+50]
636 709
637=item B<path:> I<path> 710=item B<path:> I<path>
638 711
639Specify the colon-delimited search path for finding XPM files. 712Specify the colon-delimited search path for finding XPM files.
640 713
702 775
703=item B<intensityStyles:> I<boolean> 776=item B<intensityStyles:> I<boolean>
704 777
705When font styles are not enabled, or this option is enabled (B<True>, 778When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high 779option B<-is>, the default), bold and italic font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 780intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 781option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 782reachable.
710 783
711=item B<selectstyle:> I<mode> 784=item B<selectstyle:> I<mode>
712 785
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is 786Set mouse selection style to B<old> which is 2.20, B<oldword> which
714xterm style with 2.20 old word selection, or anything else which gives 787is xterm style with 2.20 old word selection, or anything else which
715xterm style selection. 788gives xterm style selection. Only effective when the original (non-perl)
789selection code is in use.
716 790
717=item B<scrollstyle:> I<mode> 791=item B<scrollstyle:> I<mode>
718 792
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 793Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite. 794the author's favourite.
734=item B<mapAlert:> I<boolean> 808=item B<mapAlert:> I<boolean>
735 809
736B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 810B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737de-iconify (map) on receipt of a bell character [default]. 811de-iconify (map) on receipt of a bell character [default].
738 812
813=item B<urgentOnBell:> I<boolean>
814
815B<True>: set the urgency hint for the wm on receipt of a bell character.
816B<False>: do not set the urgency hint [default].
817
739=item B<visualBell:> I<boolean> 818=item B<visualBell:> I<boolean>
740 819
741B<True>: use visual bell on receipt of a bell character; option B<-vb>. 820B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742B<False>: no visual bell [default]; option B<+vb>. 821B<False>: no visual bell [default]; option B<+vb>.
743 822
764Example: 843Example:
765 844
766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 845 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 846
768This creates a new file in your home directory with the screen contents 847This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>. 848every time you hit C<Print>.
770 849
771=item B<scrollBar:> I<boolean> 850=item B<scrollBar:> I<boolean>
772 851
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 852B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 853disable the scrollbar; option B<+sb>.
796 875
797=item B<scrollWithBuffer:> I<boolean> 876=item B<scrollWithBuffer:> I<boolean>
798 877
799B<True>: scroll with scrollback buffer when tty receives new lines (and 878B<True>: scroll with scrollback buffer when tty receives new lines (and
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 879B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801with scrollback buffer when tty recieves new lines; option B<+sw>. 880with scrollback buffer when tty receives new lines; option B<+sw>.
802 881
803=item B<scrollTtyKeypress:> I<boolean> 882=item B<scrollTtyKeypress:> I<boolean>
804 883
805B<True>: scroll to bottom when a non-special key is pressed. Special keys 884B<True>: scroll to bottom when a non-special key is pressed. Special keys
806are those which are intercepted by rxvt-unicode for special handling and 885are those which are intercepted by rxvt-unicode for special handling and
896pressed. If unset it will send the sequence traditionally associated 975pressed. If unset it will send the sequence traditionally associated
897with the B<Execute> key. 976with the B<Execute> key.
898 977
899=item B<cutchars:> I<string> 978=item B<cutchars:> I<string>
900 979
901The characters used as delimiters for double-click word selection. The 980The characters used as delimiters for double-click word selection
902built-in default: 981(whitespace delimiting is added automatically if resource is given).
982
983When the perl selection extension is in use (the default if compiled
984in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
985characters will be created (if the resource exists, otherwise, no regex
986will be created). In this mode, characters outside ISO-8859-1 can be used.
987
988When the selection extension is not used, only ISO-8859-1 characters can
989be used. If not specified, the built-in default is used:
903 990
904B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 991B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
905 992
906=item B<preeditType:> I<style> 993=item B<preeditType:> I<style>
907 994
963 1050
964Turn on/off secondary screen (default enabled). 1051Turn on/off secondary screen (default enabled).
965 1052
966=item B<secondaryScroll:> I<boolean> 1053=item B<secondaryScroll:> I<boolean>
967 1054
968Turn on/off secondary screen scroll (default enabled). If the this 1055Turn on/off secondary screen scroll (default enabled). If this
969option is enabled, scrolls on the secondary screen will change the 1056option is enabled, scrolls on the secondary screen will change the
970scrollback buffer and switching to/from the secondary screen will 1057scrollback buffer and switching to/from the secondary screen will
971instead scroll the screen up. 1058instead scroll the screen up.
972 1059
973=item B<hold>: I<boolean> 1060=item B<hold>: I<boolean>
1001 1088
1002I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1089I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1003C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1090C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1004C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1091C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1005C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1092C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1006can start or end with whitespace. 1093can start or end with whitespace. B<This feature is deprecated and will
1094be removed>.
1007 1095
1008Please note that you need to double the C<\> in resource files, as 1096Please note that you need to double the C<\> in resource files, as
1009Xlib itself does it's own de-escaping (you can use C<\033> instead of 1097Xlib itself does its own de-escaping (you can use C<\033> instead of
1010C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1098C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1011processing). 1099processing).
1012 1100
1013You can define a range of keysyms in one shot by providing a I<string> 1101You can define a range of keysyms in one shot by providing a I<string>
1014with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1102with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1015should be a character not used by the strings. 1103should be a character not used by the strings.
1016 1104
1017Its usage can be demonstrated by an example: 1105Its usage can be demonstrated by an example:
1018 1106
1019 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1107 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1083example, C<default,-selection> will use all the default extension except 1171example, C<default,-selection> will use all the default extension except
1084C<selection>. 1172C<selection>.
1085 1173
1086Extension names can also be followed by an argument in angle brackets 1174Extension names can also be followed by an argument in angle brackets
1087(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1175(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1088searchable scorllback to Alt/Meta-s). Mentioning the same extension 1176searchable scrollback to Alt/Meta-s). Mentioning the same extension
1089multiple times with different arguments will pass multiple arguments to 1177multiple times with different arguments will pass multiple arguments to
1090the extension. 1178the extension.
1091 1179
1092Each extension is looked up in the library directories, loaded if 1180Each extension is looked up in the library directories, loaded if
1093necessary, and bound to the current terminal instance. 1181necessary, and bound to the current terminal instance.
1129(default: C<M-s>). 1217(default: C<M-s>).
1130 1218
1131=item B<urlLauncher>: I<string> 1219=item B<urlLauncher>: I<string>
1132 1220
1133Specifies the program to be started with a URL argument. Used by the 1221Specifies the program to be started with a URL argument. Used by the
1134C<selection-popup> and C<mark-urls> perl extensions. 1222C<selection-popup> and C<matcher> perl extensions.
1135 1223
1136=item B<transient-for>: I<windowid> 1224=item B<transient-for>: I<windowid>
1137 1225
1138Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1226Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1139 1227
1140=item B<override-redirect>: I<boolean> 1228=item B<override-redirect>: I<boolean>
1141 1229
1142Compile I<frills>: Sets override-redirect for the terminal window, making 1230Compile I<frills>: Sets override-redirect for the terminal window, making
1143it almost invisible to window managers; option B<-override-redirect>. 1231it almost invisible to window managers; option B<-override-redirect>.
1232
1233=item B<iso14755_52:> I<boolean>
1234
1235Turn on/off ISO 14755 5.2 mode (default enabled).
1144 1236
1145=back 1237=back
1146 1238
1147=head1 THE SCROLLBAR 1239=head1 THE SCROLLBAR
1148 1240
1167application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1259application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1168(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1260(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1169up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1261up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1170respectively. 1262respectively.
1171 1263
1172=head1 TEXT SELECTION AND INSERTION 1264=head1 THE SELECTION: SELECTING AND PASTING TEXT
1173 1265
1174The behaviour of text selection and insertion mechanism is similar to 1266The behaviour of text selection and insertion/pasting mechanism is similar
1175I<xterm>(1). 1267to I<xterm>(1).
1176 1268
1177=over 4 1269=over 4
1178 1270
1179=item B<Selection>: 1271=item B<Selecting>:
1180 1272
1181Left click at the beginning of the region, drag to the end of the region 1273Left click at the beginning of the region, drag to the end of the region
1182and release; Right click to extend the marked region; Left double-click 1274and release; Right click to extend the marked region; Left double-click
1183to select a word; Left triple-click to select the entire logical line 1275to select a word; Left triple-click to select the entire logical line
1184(which can span multiple screen lines), unless modified by resource 1276(which can span multiple screen lines), unless modified by resource
1188(Compile: I<frills>) will create a rectangular selection instead of a 1280(Compile: I<frills>) will create a rectangular selection instead of a
1189normal one. In this mode, every selected row becomes its own line in the 1281normal one. In this mode, every selected row becomes its own line in the
1190selection, and trailing whitespace is visually underlined and removed from 1282selection, and trailing whitespace is visually underlined and removed from
1191the selection. 1283the selection.
1192 1284
1193=item B<Insertion>: 1285=item B<Pasting>:
1194 1286
1195Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1287Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1196an B<@@RXVT_NAME@@> window causes the current text selection to be 1288window causes the value of the PRIMARY selection (or CLIPBOARD with the
1197inserted as if it had been typed on the keyboard. 1289B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1290
1291Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1292inserted too.
1198 1293
1199=back 1294=back
1200 1295
1201=head1 CHANGING FONTS 1296=head1 CHANGING FONTS
1202 1297
1216 1311
1217=head1 ISO 14755 SUPPORT 1312=head1 ISO 14755 SUPPORT
1218 1313
1219ISO 14755 is a standard for entering and viewing unicode characters 1314ISO 14755 is a standard for entering and viewing unicode characters
1220and character codes using the keyboard. It consists of 4 parts. The 1315and character codes using the keyboard. It consists of 4 parts. The
1221first part is available rxvt-unicode has been compiled with 1316first part is available if rxvt-unicode has been compiled with
1222C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1317C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1223with C<--enable-iso14755>. 1318with C<--enable-iso14755>.
1224 1319
1225=over 4 1320=over 4
1226 1321
1246This mode lets you input characters representing the keycap symbols of 1341This mode lets you input characters representing the keycap symbols of
1247your keyboard, if representable in the current locale encoding. 1342your keyboard, if representable in the current locale encoding.
1248 1343
1249Start by pressing C<Control> and C<Shift> together, then releasing 1344Start by pressing C<Control> and C<Shift> together, then releasing
1250them. The next special key (cursor keys, home etc.) you enter will not 1345them. The next special key (cursor keys, home etc.) you enter will not
1251invoke it's usual function but instead will insert the corresponding 1346invoke its usual function but instead will insert the corresponding
1252keycap symbol. The symbol will only be entered when the key has been 1347keycap symbol. The symbol will only be entered when the key has been
1253released, otherwise pressing e.g. C<Shift> would enter the symbol for 1348released, otherwise pressing e.g. C<Shift> would enter the symbol for
1254C<ISO Level 2 Switch>, although your intention might have been to enter a 1349C<ISO Level 2 Switch>, although your intention might have been to enter a
1255reverse tab (Shift-Tab). 1350reverse tab (Shift-Tab).
1256 1351
1289=head1 COLORS AND GRAPHICS 1384=head1 COLORS AND GRAPHICS
1290 1385
1291In addition to the default foreground and background colours, 1386In addition to the default foreground and background colours,
1292B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1387B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1293high-intensity bold/blink versions of the same). Here is a list of the 1388high-intensity bold/blink versions of the same). Here is a list of the
1294colours with their B<rgb.txt> names. 1389colours with their names.
1295 1390
1296=begin table 1391=begin table
1297 1392
1298 B<color0> (black) = Black 1393 B<color0> (black) = Black
1299 B<color1> (red) = Red3 1394 B<color1> (red) = Red3
1319It is also possible to specify the colour values of B<foreground>, 1414It is also possible to specify the colour values of B<foreground>,
1320B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1415B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1321a number 0-15, as a convenient shorthand to reference the colour name of 1416a number 0-15, as a convenient shorthand to reference the colour name of
1322color0-color15. 1417color0-color15.
1323 1418
1419In addition to the colours defined above, @@RXVT_NAME@@ offers an
1420additional 72 colours. The first 64 of those (with indices 16 to 79)
1421consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
142216>), followed by 8 additional shades of gray (with indices 80 to 87).
1423
1424Together, all those colours implement the 88 colour xterm colours. Only
1425the first 16 can be changed using resources currently, the rest can only
1426be changed via command sequences ("escape codes").
1427
1324Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1428Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1325always swapping the foreground/background colours. This is in contrast to 1429always swapping the foreground/background colours. This is in contrast to
1326I<xterm>(1) where the colours are only swapped if they have not otherwise 1430I<xterm>(1) where the colours are only swapped if they have not otherwise
1327been specified. For example, 1431been specified. For example,
1328 1432
1333would yield White on Black, while on I<xterm>(1) it would yield Black 1437would yield White on Black, while on I<xterm>(1) it would yield Black
1334on White. 1438on White.
1335 1439
1336=back 1440=back
1337 1441
1442=head2 ALPHA CHANNEL SUPPORT
1443
1444If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1445their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1446(recommended, but B<MUST> have 4 digits/component) colour specifications,
1447in addition to the ones provided by X, where the additional A component
1448specifies opacity (alpha) values. The minimum value of C<0> is completely
1449transparent). You can also prefix any color with C<[percent]>, where
1450C<percent> is a decimal percentage (0-100) that specifies the opacity of
1451the color, where C<0> is completely transparent and C<100> is completelxy
1452opaque.
1453
1454You probably need to specify B<"-depth 32">, too, and have the luck that
1455your X-server uses ARGB pixel layout, as X is far from just supporting
1456ARGB visuals out of the box, and rxvt-unicode just fudges around.
1457
1458For example, the following selects an almost completely transparent red
1459background, and an almost opaque pink foreground:
1460
1461 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1462
1463I<Please note that transparency of any kind if completely unsupported by
1464the author. Don't bug him with installation questions!>
1465
1338=head1 ENVIRONMENT 1466=head1 ENVIRONMENT
1339 1467
1340B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1468B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1341 1469
1342=over 4 1470=over 4
1343 1471
1344=item B<TERM> 1472=item B<TERM>
1345 1473
1346Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1474Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1347resources or on the commandline. 1475resources or on the command line.
1348 1476
1349=item B<COLORTERM> 1477=item B<COLORTERM>
1350 1478
1351Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1479Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1352compiled with XPM support, and optionally with the added extension 1480compiled with XPM support, and optionally with the added extension
1353C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1481C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1354 1482
1355=item B<COLORFGBG> 1483=item B<COLORFGBG>
1356 1484
1374C<--with-terminfo=PATH>. 1502C<--with-terminfo=PATH>.
1375 1503
1376=item B<DISPLAY> 1504=item B<DISPLAY>
1377 1505
1378Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1506Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1379display in it's child processes. 1507display in its child processes.
1380 1508
1381=item B<SHELL> 1509=item B<SHELL>
1382 1510
1383The shell to be used for command execution, defaults to C</bin/sh>. 1511The shell to be used for command execution, defaults to C</bin/sh>.
1384 1512
1426 1554
1427=item Project Coordinator 1555=item Project Coordinator
1428 1556
1429Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1557Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1430 1558
1431L<http://software.schmorp.de/#rxvt-unicode> 1559L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1432 1560
1433=back 1561=back
1434 1562
1435=head1 AUTHORS 1563=head1 AUTHORS
1436 1564

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines