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.120 by root, Sat Aug 12 01:37:11 2006 UTC vs.
Revision 1.151 by root, Wed Dec 12 19:55:55 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 right-to-left 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 in 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 user friendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
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>.
119 118
120I<Please note that transparency of any kind if completely unsupported by 119=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions! Read the FAQ (man 7 120
122@@RXVT_NAME@@)!> 121Turn on/off illusion of a transparent window background; resource B<transparent>.
122
123B<-ip> is still accepted as an obsolete alias but will be removed in
124future versions.
125
126I<Please address all transparency related issues to Sasha Vasko at
127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123 128
124=item B<-fade> I<number> 129=item B<-fade> I<number>
125 130
126Fade the text by the given percentage when focus is lost. Small values 131Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 132fade a little only, 100 completely replaces all colours by the fade
133is opaque black. resource B<fadeColor>. 138is opaque black. resource B<fadeColor>.
134 139
135=item B<-tint> I<colour> 140=item B<-tint> I<colour>
136 141
137Tint the transparent background pixmap with the given colour when 142Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 143transparency is enabled with B<-tr>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 144non-tiled backgrounds, currently. See also the B<-sh> option that can be
140used to brighten or darken the image in addition to tinting it; resource 145used to brighten or darken the image in addition to tinting it.
146Please note that certain tint colours can be applied on the server-side,
147thus yielding performance gain of two orders of magnitude. These colours are:
148blue, red, green, cyan, magenta, yellow, and those close to them. Also
149pure black and pure white colors essentially mean no tinting; resource
141I<tintColor>. Example: 150I<tintColor>. Example:
142 151
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 152 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 153
145=item B<-sh> 154=item B<-sh> I<number>
146 155
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 156Darken (0 .. 100) or lighten (100 .. 200) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 157background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>). 158resource I<shading>.
159
160=item B<-blt> I<string>
161
162Specify background blending type. If background pixmap is specified
163at the same time as transparency - such pixmap will be blended over
164transparency image, using method specified. Supported values are :
165B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
166B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
167B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168alpha-blending. Compile I<afterimage>; resource I<blendType>.
169
170=item B<-blr> I<HxV>
171
172Apply Gaussian Blur with the specified radii to the transparent
173background image. If single number is specified - both vertical and
174horizontal radii are considered to be the same. Setting one of the
175radii to 1 and another to a large number creates interesting effects
176on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177resource I<blurRadius>.
150 178
151=item B<-bg> I<colour> 179=item B<-bg> I<colour>
152 180
153Window background colour; resource B<background>. 181Window background colour; resource B<background>.
154 182
155=item B<-fg> I<colour> 183=item B<-fg> I<colour>
156 184
157Window foreground colour; resource B<foreground>. 185Window foreground colour; resource B<foreground>.
158 186
159=item B<-pixmap> I<file[;geom]> 187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160 188
161Compile I<XPM>: Specify XPM file for the background and also optionally 189Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 190optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 191add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 192command-line; for more details see resource B<backgroundPixmap>.
165 193
166=item B<-cr> I<colour> 194=item B<-cr> I<colour>
167 195
168The cursor colour; resource B<cursorColor>. 196The cursor colour; resource B<cursorColor>.
169 197
322 350
323=item B<-lsp> I<number> 351=item B<-lsp> I<number>
324 352
325Compile I<frills>: Lines (pixel height) to insert between each row of 353Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 354the display. Useful to work around font rendering problems; resource
327B<linespace>. 355B<lineSpace>.
328 356
329=item B<-tn> I<termname> 357=item B<-tn> I<termname>
330 358
331This option specifies the name of the terminal type to be set in the 359This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 360B<TERM> environment variable. This terminal type must exist in the
386for more info. 414for more info.
387 415
388=item B<-tcw> 416=item B<-tcw>
389 417
390Change the meaning of triple-click selection with the left mouse 418Change the meaning of triple-click selection with the left mouse
419button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 420in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 421the end of the logical line only. resource B<tripleclickwords>.
393 422
394=item B<-insecure> 423=item B<-insecure>
395 424
396Enable "insecure" mode, which currently enables most of the escape 425Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 426sequences that echo strings. See the resource B<insecure> for more
417 446
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 448will not immediately destroy its window when the program executed within
420it exits. Instead, it will wait till it is being killed or closed by the 449it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 450user; resource B<hold>.
451
452=item B<-xrm> I<string>
453
454Works like the X Toolkit option of the same name, by adding the I<string>
455as if it were specified in a resource file. Resource values specified this
456way take precedence over all other resource specifications.
457
458Note that you need to use the I<same> syntax as in the .Xdefaults file,
459e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
460options can be specified as long-options on the commandline, so use
461of B<-xrm> is mostly limited to cases where you want to specify other
462resources (e.g. for input methods) or for compatibility with other
463programs.
422 464
423=item B<-keysym.>I<sym> I<string> 465=item B<-keysym.>I<sym> I<string>
424 466
425Remap a key symbol. See resource B<keysym>. 467Remap a key symbol. See resource B<keysym>.
426 468
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 503If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462entries and will not tinker with pty/tty permissions - you have to do that 504entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 505yourself if you want that.
464 506
465As an extremely special case, specifying C<-1> will completely suppress 507As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 508pty/tty operations, which is probably only useful in conjunction with some
509perl extension that manages the terminal.
467 510
468Here is a example in perl that illustrates how this option can be used (a 511Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 512longer example is in F<doc/pty-fd>):
470 513
471 use IO::Pty; 514 use IO::Pty;
485Comma-separated list of perl extension scripts to use (or not to use) in 528Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 529this terminal instance. See resource B<perl-ext> for details.
487 530
488=back 531=back
489 532
490=head1 RESOURCES (available also as long-options) 533=head1 RESOURCES
491 534
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 535Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 536options) compiled into your version. All resources are also available as
537long-options.
494 538
495You can set and change the resources using X11 tools like B<xrdb>. Many 539You can set and change the resources using X11 tools like B<xrdb>. Many
496distribution do also load settings from the B<~/.Xresources> file when X 540distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 541starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 542with later settings overwriting earlier ones:
500 1. system-wide app-defaults file, either locale-dependent OR global 544 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 545 2. app-defaults file in $XAPPLRESDIR
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 546 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503 4. SCREEN_RESOURCES for the current screen 547 4. SCREEN_RESOURCES for the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 548 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
549 6. resources specified via -xrm on the commandline
505 550
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 551Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 552names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 553common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 554configured, while the class name B<URxvt> allows resources unique to
564Use the specified colour to display underlined characters when the 609Use the specified colour to display underlined characters when the
565foreground colour is the default. 610foreground colour is the default.
566 611
567=item B<colorRV:> I<colour> 612=item B<colorRV:> I<colour>
568 613
569Use the specified colour as the background for reverse video 614Use the specified colour as the background for reverse video characters
570characters. 615when OPTION_HC is disabled (--disable-frills).
571 616
572=item B<underlineColor:> I<colour> 617=item B<underlineColor:> I<colour>
573 618
574If set, use the specified colour as the colour for the underline 619If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 620itself. If unset, use the foreground colour.
591option B<-rv>. B<False>: regular screen colours [default]; option 636option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 637B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 638
594=item B<jumpScroll:> I<boolean> 639=item B<jumpScroll:> I<boolean>
595 640
596B<True>: specify that jump scrolling should be used. When scrolling 641B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 642of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
643has been read, resulting in fewer updates while still displaying every
644received line; option B<-j>.
645
598B<False>: specify that smooth scrolling should be used; option B<+j>. 646B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
647force a screen refresh on each new line it received; option B<+j>.
599 648
600=item B<inheritPixmap:> I<boolean> 649=item B<skipScroll:> I<boolean>
601 650
602B<True>: make the background inherit the parent windows' pixmap, giving 651B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 652receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 653(around 60 times per second), resulting in far fewer updates. This can
654result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
655option B<-ss>.
605 656
606I<Please note that transparency of any kind if completely unsupported by 657B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 658if the refresh is too fast for the human eye to read anything (or the
659monitor to display anything); option B<+ss>.
660
661=item B<transparent:> I<boolean>
662
663Turn on/off illusion of a transparent window background.
664
665B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
666future versions.
667
668I<Please address all transparency related issues to Sasha Vasko at
669sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
608 670
609=item B<fading:> I<number> 671=item B<fading:> I<number>
610 672
611Fade the text by the given percentage when focus is lost; option B<-fade>. 673Fade the text by the given percentage when focus is lost; option B<-fade>.
612 674
620Tint the transparent background pixmap with the given colour; option 682Tint the transparent background pixmap with the given colour; option
621B<-tint>. 683B<-tint>.
622 684
623=item B<shading:> I<number> 685=item B<shading:> I<number>
624 686
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 687Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626image in addition to tinting it. 688in addition to tinting it; option B<-sh>.
689
690=item B<blendType:> I<string>
691
692Specify background blending type; option B<-blt>.
693
694=item B<blurRadius:> I<number>
695
696Apply Gaussian Blurr with the specified radius to the transparent
697background image; option B<-blr>.
627 698
628=item B<scrollColor:> I<colour> 699=item B<scrollColor:> I<colour>
629 700
630Use the specified colour for the scrollbar [default #B2B2B2]. 701Use the specified colour for the scrollbar [default #B2B2B2].
631 702
637=item B<borderColor:> I<colour> 708=item B<borderColor:> I<colour>
638 709
639The colour of the border around the text area and between the scrollbar 710The colour of the border around the text area and between the scrollbar
640and the text. 711and the text.
641 712
642=item B<backgroundPixmap:> I<file[;geom]> 713=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643 714
644Use the specified XPM file (note the `.xpm' extension is optional) for 715Use the specified image file for the background and also
645the background and also optionally specify its scaling with a geometry 716optionally specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 717(default C<0x0+50+50>) in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 718horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale 719centre (percent). A scale of 0 displays the image with tiling. A scale
649of 1 displays the image without any scaling. A scale of 2 to 9 720of 1 displays the image without any scaling. A scale of 2 to 9 specifies
650specifies an integer number of images in that direction. No image will 721an integer number of images in that direction. No image will be magnified
651be magnified beyond 10 times its original size. The maximum permitted 722beyond 10 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 723Additional operations can be specified after colon B<:op1:op2...>.
724Supported operations are:
725
726 tile force background image to be tiled and not scaled. Equivalent to 0x0,
727 propscale will scale image keeping proportions,
728 auto will scale image to match window size. Equivalent to 100x100;
729 hscale will scale image horizontally to the window size;
730 vscale will scale image vertically to the window size;
731 scale will scale image to match window size;
732 root will tile image as if it was a root window background, auto-adjusting
733 whenever terminal window moves.
734
735If used in conjunction with B<-tr> option, the specified pixmap will be
736blended over transparency image using either alpha-blending, or any
737other blending type, specified with B<-blt "type"> option.
653 738
654=item B<path:> I<path> 739=item B<path:> I<path>
655 740
656Specify the colon-delimited search path for finding XPM files. 741Specify the colon-delimited search path for finding background image files.
657 742
658=item B<font:> I<fontlist> 743=item B<font:> I<fontlist>
659 744
660Select the fonts to be used. This is a comma separated list of font names 745Select the fonts to be used. This is a comma separated list of font names
661that are checked in order when trying to find glyphs for characters. The 746that are checked in order when trying to find glyphs for characters. The
725option B<+is>) disables this behaviour, the high intensity colours are not 810option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 811reachable.
727 812
728=item B<selectstyle:> I<mode> 813=item B<selectstyle:> I<mode>
729 814
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is 815Set mouse selection style to B<old> which is 2.20, B<oldword> which
731xterm style with 2.20 old word selection, or anything else which gives 816is xterm style with 2.20 old word selection, or anything else which
732xterm style selection. 817gives xterm style selection. Only effective when the original (non-perl)
818selection code is in use.
733 819
734=item B<scrollstyle:> I<mode> 820=item B<scrollstyle:> I<mode>
735 821
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 822Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite. 823the author's favourite.
750 836
751=item B<mapAlert:> I<boolean> 837=item B<mapAlert:> I<boolean>
752 838
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 839B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 840de-iconify (map) on receipt of a bell character [default].
841
842=item B<urgentOnBell:> I<boolean>
843
844B<True>: set the urgency hint for the wm on receipt of a bell character.
845B<False>: do not set the urgency hint [default].
755 846
756=item B<visualBell:> I<boolean> 847=item B<visualBell:> I<boolean>
757 848
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 849B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 850B<False>: no visual bell [default]; option B<+vb>.
854=item B<termName:> I<termname> 945=item B<termName:> I<termname>
855 946
856Specifies the terminal type name to be set in the B<TERM> environment 947Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 948variable; option B<-tn>.
858 949
859=item B<linespace:> I<number> 950=item B<lineSpace:> I<number>
860 951
861Specifies number of lines (pixel height) to insert between each row of 952Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 953the display [default 0]; option B<-lsp>.
863 954
864=item B<meta8:> I<boolean> 955=item B<meta8:> I<boolean>
916=item B<cutchars:> I<string> 1007=item B<cutchars:> I<string>
917 1008
918The characters used as delimiters for double-click word selection 1009The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 1010(whitespace delimiting is added automatically if resource is given).
920 1011
921When the selection extension is in use (the default if compiled in, see 1012When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1013in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 1014characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 1015will be created). In this mode, characters outside ISO-8859-1 can be used.
925 1016
926When the selection extension is not used, only ISO-8859-1 characters can 1017When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 1018be used. If not specified, the built-in default is used:
928 1019
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1020B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 1021
931=item B<preeditType:> I<style> 1022=item B<preeditType:> I<style>
932 1023
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1024B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 1025
988 1079
989Turn on/off secondary screen (default enabled). 1080Turn on/off secondary screen (default enabled).
990 1081
991=item B<secondaryScroll:> I<boolean> 1082=item B<secondaryScroll:> I<boolean>
992 1083
993Turn on/off secondary screen scroll (default enabled). If the this 1084Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1085option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1086scrollback buffer and switching to/from the secondary screen will
996instead scroll the screen up. 1087instead scroll the screen up.
997 1088
998=item B<hold>: I<boolean> 1089=item B<hold>: I<boolean>
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1113searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1023omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1114omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1024keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1115keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1025performed in an exact manner; however, the closest match is assured. 1116performed in an exact manner; however, the closest match is assured.
1026 1117
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1118I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1119number), see RESOURCES in C<man 7 X> for futher details.
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031can start or end with whitespace. B<This feature is deprecated and will
1032be removed>.
1033
1034Please note that you need to double the C<\> in resource files, as
1035Xlib itself does its own de-escaping (you can use C<\033> instead of
1036C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1037processing).
1038 1120
1039You can define a range of keysyms in one shot by providing a I<string> 1121You can define a range of keysyms in one shot by providing a I<string>
1040with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1122with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1041should be a character not used by the strings. 1123should be a character not used by the strings.
1042 1124
1155(default: C<M-s>). 1237(default: C<M-s>).
1156 1238
1157=item B<urlLauncher>: I<string> 1239=item B<urlLauncher>: I<string>
1158 1240
1159Specifies the program to be started with a URL argument. Used by the 1241Specifies the program to be started with a URL argument. Used by the
1160C<selection-popup> and C<mark-urls> perl extensions. 1242C<selection-popup> and C<matcher> perl extensions.
1161 1243
1162=item B<transient-for>: I<windowid> 1244=item B<transient-for>: I<windowid>
1163 1245
1164Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1246Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1165 1247
1166=item B<override-redirect>: I<boolean> 1248=item B<override-redirect>: I<boolean>
1167 1249
1168Compile I<frills>: Sets override-redirect for the terminal window, making 1250Compile I<frills>: Sets override-redirect for the terminal window, making
1169it almost invisible to window managers; option B<-override-redirect>. 1251it almost invisible to window managers; option B<-override-redirect>.
1252
1253=item B<iso14755_52:> I<boolean>
1254
1255Turn on/off ISO 14755 5.2 mode (default enabled).
1170 1256
1171=back 1257=back
1172 1258
1173=head1 THE SCROLLBAR 1259=head1 THE SCROLLBAR
1174 1260
1193application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1279application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1194(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1280(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1195up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1281up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1196respectively. 1282respectively.
1197 1283
1198=head1 TEXT SELECTION AND INSERTION 1284=head1 THE SELECTION: SELECTING AND PASTING TEXT
1199 1285
1200The behaviour of text selection and insertion mechanism is similar to 1286The behaviour of text selection and insertion/pasting mechanism is similar
1201I<xterm>(1). 1287to I<xterm>(1).
1202 1288
1203=over 4 1289=over 4
1204 1290
1205=item B<Selection>: 1291=item B<Selecting>:
1206 1292
1207Left click at the beginning of the region, drag to the end of the region 1293Left click at the beginning of the region, drag to the end of the region
1208and release; Right click to extend the marked region; Left double-click 1294and release; Right click to extend the marked region; Left double-click
1209to select a word; Left triple-click to select the entire logical line 1295to select a word; Left triple-click to select the entire logical line
1210(which can span multiple screen lines), unless modified by resource 1296(which can span multiple screen lines), unless modified by resource
1214(Compile: I<frills>) will create a rectangular selection instead of a 1300(Compile: I<frills>) will create a rectangular selection instead of a
1215normal one. In this mode, every selected row becomes its own line in the 1301normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from 1302selection, and trailing whitespace is visually underlined and removed from
1217the selection. 1303the selection.
1218 1304
1219=item B<Insertion>: 1305=item B<Pasting>:
1220 1306
1221Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1307Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1222window causes the value of the PRIMARY selection (or CLIPBOARD with the 1308window causes the value of the PRIMARY selection (or CLIPBOARD with the
1223Meta modifier) to be inserted as if it had been typed on the keyboard. 1309B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1224 1310
1225Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1311Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1226inserted too. 1312inserted too.
1227 1313
1228=back 1314=back
1245 1331
1246=head1 ISO 14755 SUPPORT 1332=head1 ISO 14755 SUPPORT
1247 1333
1248ISO 14755 is a standard for entering and viewing unicode characters 1334ISO 14755 is a standard for entering and viewing unicode characters
1249and character codes using the keyboard. It consists of 4 parts. The 1335and character codes using the keyboard. It consists of 4 parts. The
1250first part is available rxvt-unicode has been compiled with 1336first part is available if rxvt-unicode has been compiled with
1251C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1337C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1252with C<--enable-iso14755>. 1338with C<--enable-iso14755>.
1253 1339
1254=over 4 1340=over 4
1255 1341
1378If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1464If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1379their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1465their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1380(recommended, but B<MUST> have 4 digits/component) colour specifications, 1466(recommended, but B<MUST> have 4 digits/component) colour specifications,
1381in addition to the ones provided by X, where the additional A component 1467in addition to the ones provided by X, where the additional A component
1382specifies opacity (alpha) values. The minimum value of C<0> is completely 1468specifies opacity (alpha) values. The minimum value of C<0> is completely
1383transparent). You can also prefix any color with C<[a]>, where C<a> is on 1469transparent). You can also prefix any color with C<[percent]>, where
1384to four hex digits specifiying the opacity value. 1470C<percent> is a decimal percentage (0-100) that specifies the opacity of
1471the color, where C<0> is completely transparent and C<100> is completelxy
1472opaque.
1385 1473
1386You probably need to specify B<"-depth 32">, too, and have the luck that 1474You probably need to specify B<"-depth 32">, too, and have the luck that
1387your X-server uses ARGB pixel layout, as X is far from just supporting 1475your X-server uses ARGB pixel layout, as X is far from just supporting
1388ARGB visuals out of the box, and rxvt-unicode just fudges around. 1476ARGB visuals out of the box, and rxvt-unicode just fudges around.
1389 1477
1390For example, the following selects an almost completely transparent red 1478For example, the following selects an almost completely transparent red
1391background, and an almost opaque pink foreground: 1479background, and an almost opaque pink foreground:
1392 1480
1393 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1481 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1394 1482
1395I<Please note that transparency of any kind if completely unsupported by 1483I<Please note that transparency of any kind if completely unsupported by
1396the author. Don't bug him with installation questions!> 1484the author. Don't bug him with installation questions!>
1397 1485
1398=head1 ENVIRONMENT 1486=head1 ENVIRONMENT
1407resources or on the command line. 1495resources or on the command line.
1408 1496
1409=item B<COLORTERM> 1497=item B<COLORTERM>
1410 1498
1411Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1499Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1412compiled with XPM support, and optionally with the added extension 1500compiled with background image support, and optionally with the added
1413C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1501extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1502screen.
1414 1503
1415=item B<COLORFGBG> 1504=item B<COLORFGBG>
1416 1505
1417Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1506Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1418the colour code used as default foreground/text colour (or the string 1507the colour code used as default foreground/text colour (or the string
1419C<default> to indicate that the default-colour escape sequence is to be 1508C<default> to indicate that the default-colour escape sequence is to be
1420used), C<bg> is the colour code used as default background colour (or the 1509used), C<bg> is the colour code used as default background colour (or the
1421string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1510string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1422was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1511was compiled with background image support. Libraries like C<ncurses>
1423(and do) use this information to optimize screen output. 1512and C<slang> can (and do) use this information to optimize screen output.
1424 1513
1425=item B<WINDOWID> 1514=item B<WINDOWID>
1426 1515
1427Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1516Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1428window, which usually has subwindows for the scrollbar, the terminal 1517window, which usually has subwindows for the scrollbar, the terminal
1519Project Coordinator (changes.txt 2.21a to 2.4.5) 1608Project Coordinator (changes.txt 2.21a to 2.4.5)
1520 1609
1521=item Geoff Wing L<< <gcw@pobox.com> >> 1610=item Geoff Wing L<< <gcw@pobox.com> >>
1522 1611
1523Rewrote screen display and text selection routines. 1612Rewrote screen display and text selection routines.
1524 1613
1525Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1614Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1526 1615
1527=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1616=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1528 1617
1529Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1618Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines