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.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If 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 43me recommend C<mlterm>, which is a very user friendly, lean and clean
108 111
109Turn on/off simulated reverse video; resource B<reverseVideo>. 112Turn on/off simulated reverse video; resource B<reverseVideo>.
110 113
111=item B<-j>|B<+j> 114=item B<-j>|B<+j>
112 115
113Turn on/off jump scrolling; resource B<jumpScroll>. 116Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 117
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 118=item B<-ss>|B<+ss>
116 119
117Turn on/off inheriting parent window's pixmap. Alternative form is 120Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119 121
120I<Please note that transparency of any kind if completely unsupported by 122=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions! Read the FAQ (man 7 123
122@@RXVT_NAME@@)!> 124Turn on/off illusion of a transparent window background; resource B<transparent>.
125
126B<-ip> is still accepted as an obsolete alias but will be removed in
127future versions.
128
129I<Please address all transparency related issues to Sasha Vasko at
130sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123 131
124=item B<-fade> I<number> 132=item B<-fade> I<number>
125 133
126Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
133is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
134 142
135=item B<-tint> I<colour> 143=item B<-tint> I<colour>
136 144
137Tint the transparent background pixmap with the given colour when 145Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 146transparency is enabled with B<-tr>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 147non-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 148used to brighten or darken the image in addition to tinting it.
149Please note that certain tint colours can be applied on the server-side,
150thus yielding performance gain of two orders of magnitude. These colours are:
151blue, red, green, cyan, magenta, yellow, and those close to them. Also
152pure black and pure white colors essentially mean no tinting; resource
141I<tintColor>. Example: 153I<tintColor>. Example:
142 154
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 155 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 156
145=item B<-sh> 157=item B<-sh> I<number>
146 158
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 159Darken (0 .. 100) or lighten (100 .. 200) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 160background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>); resource I<shading>. 161resource I<shading>.
162
163=item B<-blt> I<string>
164
165Specify background blending type. If background pixmap is specified
166at the same time as transparency - such pixmap will be blended over
167transparency image, using method specified. Supported values are :
168B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
169B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171alpha-blending. Compile I<afterimage>; resource I<blendType>.
172
173=item B<-blr> I<HxV>
174
175Apply Gaussian Blur with the specified radii to the transparent
176background image. If single number is specified - both vertical and
177horizontal radii are considered to be the same. Setting one of the
178radii to 1 and another to a large number creates interesting effects
179on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
180resource I<blurRadius>.
150 181
151=item B<-bg> I<colour> 182=item B<-bg> I<colour>
152 183
153Window background colour; resource B<background>. 184Window background colour; resource B<background>.
154 185
155=item B<-fg> I<colour> 186=item B<-fg> I<colour>
156 187
157Window foreground colour; resource B<foreground>. 188Window foreground colour; resource B<foreground>.
158 189
159=item B<-pixmap> I<file[;geom]> 190=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160 191
161Compile I<XPM>: Specify XPM file for the background and also optionally 192Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 193optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 194add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 195command-line; for more details see resource B<backgroundPixmap>.
165 196
166=item B<-cr> I<colour> 197=item B<-cr> I<colour>
167 198
168The cursor colour; resource B<cursorColor>. 199The cursor colour; resource B<cursorColor>.
169 200
214italic> >> characters are to be printed. See resource B<boldItalicFont> 245italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details. 246for details.
216 247
217=item B<-is>|B<+is> 248=item B<-is>|B<+is>
218 249
219Compile I<font-styles>: Bold/Italic font styles imply high intensity 250Compile I<font-styles>: Bold/Blink font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for 251foreground/background (default). See resource B<intensityStyles> for
221details. 252details.
222 253
223=item B<-name> I<name> 254=item B<-name> I<name>
224 255
242 273
243=item B<-sb>|B<+sb> 274=item B<-sb>|B<+sb>
244 275
245Turn on/off scrollbar; resource B<scrollBar>. 276Turn on/off scrollbar; resource B<scrollBar>.
246 277
278=item B<-sr>|B<+sr>
279
280Put scrollbar on right/left; resource B<scrollBar_right>.
281
282=item B<-st>|B<+st>
283
284Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
285resource B<scrollBar_floating>.
286
247=item B<-si>|B<+si> 287=item B<-si>|B<+si>
248 288
249Turn on/off scroll-to-bottom on TTY output inhibit; resource 289Turn on/off scroll-to-bottom on TTY output inhibit; resource
250B<scrollTtyOutput> has opposite effect. 290B<scrollTtyOutput> has opposite effect.
251 291
257=item B<-sw>|B<+sw> 297=item B<-sw>|B<+sw>
258 298
259Turn on/off scrolling with the scrollback buffer as new lines appear. 299Turn on/off scrolling with the scrollback buffer as new lines appear.
260This only takes effect if B<-si> is also given; resource 300This only takes effect if B<-si> is also given; resource
261B<scrollWithBuffer>. 301B<scrollWithBuffer>.
262
263=item B<-sr>|B<+sr>
264
265Put scrollbar on right/left; resource B<scrollBar_right>.
266
267=item B<-st>|B<+st>
268
269Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270resource B<scrollBar_floating>.
271 302
272=item B<-ptab>|B<+ptab> 303=item B<-ptab>|B<+ptab>
273 304
274If enabled (default), "Horizontal Tab" characters are being stored as 305If enabled (default), "Horizontal Tab" characters are being stored as
275actual wide characters in the screen buffer, which makes it possible to 306actual wide characters in the screen buffer, which makes it possible to
322 353
323=item B<-lsp> I<number> 354=item B<-lsp> I<number>
324 355
325Compile I<frills>: Lines (pixel height) to insert between each row of 356Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 357the display. Useful to work around font rendering problems; resource
327B<linespace>. 358B<lineSpace>.
328 359
329=item B<-tn> I<termname> 360=item B<-tn> I<termname>
330 361
331This option specifies the name of the terminal type to be set in the 362This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 363B<TERM> environment variable. This terminal type must exist in the
386for more info. 417for more info.
387 418
388=item B<-tcw> 419=item B<-tcw>
389 420
390Change the meaning of triple-click selection with the left mouse 421Change the meaning of triple-click selection with the left mouse
422button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 423in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 424the end of the logical line only. resource B<tripleclickwords>.
393 425
394=item B<-insecure> 426=item B<-insecure>
395 427
396Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
417 449
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 451will 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 452it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 453user; resource B<hold>.
454
455=item B<-xrm> I<string>
456
457Works like the X Toolkit option of the same name, by adding the I<string>
458as if it were specified in a resource file. Resource values specified this
459way take precedence over all other resource specifications.
460
461Note that you need to use the I<same> syntax as in the .Xdefaults file,
462e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
463options can be specified as long-options on the commandline, so use
464of B<-xrm> is mostly limited to cases where you want to specify other
465resources (e.g. for input methods) or for compatibility with other
466programs.
422 467
423=item B<-keysym.>I<sym> I<string> 468=item B<-keysym.>I<sym> I<string>
424 469
425Remap a key symbol. See resource B<keysym>. 470Remap a key symbol. See resource B<keysym>.
426 471
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 506If 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 507entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 508yourself if you want that.
464 509
465As an extremely special case, specifying C<-1> will completely suppress 510As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 511pty/tty operations, which is probably only useful in conjunction with some
512perl extension that manages the terminal.
467 513
468Here is a example in perl that illustrates how this option can be used (a 514Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 515longer example is in F<doc/pty-fd>):
470 516
471 use IO::Pty; 517 use IO::Pty;
485Comma-separated list of perl extension scripts to use (or not to use) in 531Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 532this terminal instance. See resource B<perl-ext> for details.
487 533
488=back 534=back
489 535
490=head1 RESOURCES (available also as long-options) 536=head1 RESOURCES
491 537
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 538Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 539options) compiled into your version. All resources are also available as
540long-options.
494 541
495You can set and change the resources using X11 tools like B<xrdb>. Many 542You 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 543distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 544starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 545with later settings overwriting earlier ones:
500 1. system-wide app-defaults file, either locale-dependent OR global 547 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 548 2. app-defaults file in $XAPPLRESDIR
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 549 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503 4. SCREEN_RESOURCES for the current screen 550 4. SCREEN_RESOURCES for the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 551 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552 6. resources specified via -xrm on the commandline
505 553
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 554Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 555names: 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 556common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 557configured, while the class name B<URxvt> allows resources unique to
591option B<-rv>. B<False>: regular screen colours [default]; option 639option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 640B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 641
594=item B<jumpScroll:> I<boolean> 642=item B<jumpScroll:> I<boolean>
595 643
596B<True>: specify that jump scrolling should be used. When scrolling 644B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 645of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
646has been read, resulting in fewer updates while still displaying every
647received line; option B<-j>.
648
598B<False>: specify that smooth scrolling should be used; option B<+j>. 649B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
650force a screen refresh on each new line it received; option B<+j>.
599 651
600=item B<inheritPixmap:> I<boolean> 652=item B<skipScroll:> I<boolean>
601 653
602B<True>: make the background inherit the parent windows' pixmap, giving 654B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 655receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 656(around 60 times per second), resulting in far fewer updates. This can
657result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
658option B<-ss>.
605 659
606I<Please note that transparency of any kind if completely unsupported by 660B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 661if the refresh is too fast for the human eye to read anything (or the
662monitor to display anything); option B<+ss>.
663
664=item B<transparent:> I<boolean>
665
666Turn on/off illusion of a transparent window background.
667
668B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669future versions.
670
671I<Please address all transparency related issues to Sasha Vasko at
672sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
608 673
609=item B<fading:> I<number> 674=item B<fading:> I<number>
610 675
611Fade the text by the given percentage when focus is lost; option B<-fade>. 676Fade the text by the given percentage when focus is lost; option B<-fade>.
612 677
623=item B<shading:> I<number> 688=item B<shading:> I<number>
624 689
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 690Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626in addition to tinting it; option B<-sh>. 691in addition to tinting it; option B<-sh>.
627 692
693=item B<blendType:> I<string>
694
695Specify background blending type; option B<-blt>.
696
697=item B<blurRadius:> I<number>
698
699Apply Gaussian Blurr with the specified radius to the transparent
700background image; option B<-blr>.
701
628=item B<scrollColor:> I<colour> 702=item B<scrollColor:> I<colour>
629 703
630Use the specified colour for the scrollbar [default #B2B2B2]. 704Use the specified colour for the scrollbar [default #B2B2B2].
631 705
632=item B<troughColor:> I<colour> 706=item B<troughColor:> I<colour>
637=item B<borderColor:> I<colour> 711=item B<borderColor:> I<colour>
638 712
639The colour of the border around the text area and between the scrollbar 713The colour of the border around the text area and between the scrollbar
640and the text. 714and the text.
641 715
642=item B<backgroundPixmap:> I<file[;geom]> 716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643 717
644Use the specified XPM file (note the `.xpm' extension is optional) for 718Use the specified image file for the background and also
645the background and also optionally specify its scaling with a geometry 719optionally specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 720(default C<0x0+50+50>) in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 721horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale 722centre (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 723of 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 724an integer number of images in that direction. No image will be magnified
651be magnified beyond 10 times its original size. The maximum permitted 725beyond 10 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 726Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are:
728
729 tile force background image to be tiled and not scaled. Equivalent to 0x0
730 propscale will scale image keeping proportions
731 auto will scale image to match window size. Equivalent to 100x100
732 hscale will scale image horizontally to the window size
733 vscale will scale image vertically to the window size
734 scale will scale image to match window size
735 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves
737
738If used in conjunction with B<-tr> option, the specified pixmap will be
739blended over transparency image using either alpha-blending, or any
740other blending type, specified with B<-blt "type"> option.
653 741
654=item B<path:> I<path> 742=item B<path:> I<path>
655 743
656Specify the colon-delimited search path for finding XPM files. 744Specify the colon-delimited search path for finding background image files.
657 745
658=item B<font:> I<fontlist> 746=item B<font:> I<fontlist>
659 747
660Select the fonts to be used. This is a comma separated list of font names 748Select 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 749that are checked in order when trying to find glyphs for characters. The
718text font will being used for the given style. 806text font will being used for the given style.
719 807
720=item B<intensityStyles:> I<boolean> 808=item B<intensityStyles:> I<boolean>
721 809
722When font styles are not enabled, or this option is enabled (B<True>, 810When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 811option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 812intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 813option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 814reachable.
727 815
728=item B<selectstyle:> I<mode>
729
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731xterm style with 2.20 old word selection, or anything else which gives
732xterm style selection.
733
734=item B<scrollstyle:> I<mode>
735
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite.
738
739=item B<title:> I<string> 816=item B<title:> I<string>
740 817
741Set window title string, the default title is the command-line 818Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 819specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 820name; option B<-title>.
787 864
788 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 865 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
789 866
790This creates a new file in your home directory with the screen contents 867This creates a new file in your home directory with the screen contents
791every time you hit C<Print>. 868every time you hit C<Print>.
869
870=item B<scrollstyle:> I<mode>
871
872Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
873the author's favourite.
792 874
793=item B<scrollBar:> I<boolean> 875=item B<scrollBar:> I<boolean>
794 876
795B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 877B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
796disable the scrollbar; option B<+sb>. 878disable the scrollbar; option B<+sb>.
859=item B<termName:> I<termname> 941=item B<termName:> I<termname>
860 942
861Specifies the terminal type name to be set in the B<TERM> environment 943Specifies the terminal type name to be set in the B<TERM> environment
862variable; option B<-tn>. 944variable; option B<-tn>.
863 945
864=item B<linespace:> I<number> 946=item B<lineSpace:> I<number>
865 947
866Specifies number of lines (pixel height) to insert between each row of 948Specifies number of lines (pixel height) to insert between each row of
867the display [default 0]; option B<-lsp>. 949the display [default 0]; option B<-lsp>.
868 950
869=item B<meta8:> I<boolean> 951=item B<meta8:> I<boolean>
921=item B<cutchars:> I<string> 1003=item B<cutchars:> I<string>
922 1004
923The characters used as delimiters for double-click word selection 1005The characters used as delimiters for double-click word selection
924(whitespace delimiting is added automatically if resource is given). 1006(whitespace delimiting is added automatically if resource is given).
925 1007
926When the selection extension is in use (the default if compiled in, see 1008When the perl selection extension is in use (the default if compiled
927the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1009in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
928will be created (if the resource exists, otherwise, no regex will be 1010characters will be created (if the resource exists, otherwise, no regex
929created). In this mode, characters outside ISO-8859-1 can be used. 1011will be created). In this mode, characters outside ISO-8859-1 can be used.
930 1012
931When the selection extension is not used, only ISO-8859-1 characters can 1013When the selection extension is not used, only ISO-8859-1 characters can
932be used. If not specified, the built-in default is used: 1014be used. If not specified, the built-in default is used:
933 1015
934B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1016B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
935 1017
936=item B<preeditType:> I<style> 1018=item B<preeditType:> I<style>
937 1019
938B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1020B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
939 1021
1027searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1109searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1028omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1110omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1029keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1111keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1030performed in an exact manner; however, the closest match is assured. 1112performed in an exact manner; however, the closest match is assured.
1031 1113
1032I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1114I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1033C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1115number), see RESOURCES in C<man 7 X> for futher details.
1034C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1035C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1036can start or end with whitespace. B<This feature is deprecated and will
1037be removed>.
1038
1039Please note that you need to double the C<\> in resource files, as
1040Xlib itself does its own de-escaping (you can use C<\033> instead of
1041C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1042processing).
1043 1116
1044You can define a range of keysyms in one shot by providing a I<string> 1117You can define a range of keysyms in one shot by providing a I<string>
1045with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1118with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1046should be a character not used by the strings. 1119should be a character not used by the strings.
1047 1120
1171=item B<override-redirect>: I<boolean> 1244=item B<override-redirect>: I<boolean>
1172 1245
1173Compile I<frills>: Sets override-redirect for the terminal window, making 1246Compile I<frills>: Sets override-redirect for the terminal window, making
1174it almost invisible to window managers; option B<-override-redirect>. 1247it almost invisible to window managers; option B<-override-redirect>.
1175 1248
1249=item B<iso14755_52:> I<boolean>
1250
1251Turn on/off ISO 14755 5.2 mode (default enabled).
1252
1176=back 1253=back
1177 1254
1178=head1 THE SCROLLBAR 1255=head1 THE SCROLLBAR
1179 1256
1180Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1257Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1198application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1275application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1199(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1276(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1200up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1277up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1201respectively. 1278respectively.
1202 1279
1203=head1 TEXT SELECTION AND INSERTION 1280=head1 THE SELECTION: SELECTING AND PASTING TEXT
1204 1281
1205The behaviour of text selection and insertion mechanism is similar to 1282The behaviour of text selection and insertion/pasting mechanism is similar
1206I<xterm>(1). 1283to I<xterm>(1).
1207 1284
1208=over 4 1285=over 4
1209 1286
1210=item B<Selection>: 1287=item B<Selecting>:
1211 1288
1212Left click at the beginning of the region, drag to the end of the region 1289Left click at the beginning of the region, drag to the end of the region
1213and release; Right click to extend the marked region; Left double-click 1290and release; Right click to extend the marked region; Left double-click
1214to select a word; Left triple-click to select the entire logical line 1291to select a word; Left triple-click to select the entire logical line
1215(which can span multiple screen lines), unless modified by resource 1292(which can span multiple screen lines), unless modified by resource
1219(Compile: I<frills>) will create a rectangular selection instead of a 1296(Compile: I<frills>) will create a rectangular selection instead of a
1220normal one. In this mode, every selected row becomes its own line in the 1297normal one. In this mode, every selected row becomes its own line in the
1221selection, and trailing whitespace is visually underlined and removed from 1298selection, and trailing whitespace is visually underlined and removed from
1222the selection. 1299the selection.
1223 1300
1224=item B<Insertion>: 1301=item B<Pasting>:
1225 1302
1226Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1303Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1227window causes the value of the PRIMARY selection (or CLIPBOARD with the 1304window causes the value of the PRIMARY selection (or CLIPBOARD with the
1228Meta modifier) to be inserted as if it had been typed on the keyboard. 1305B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1229 1306
1230Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1307Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1231inserted too. 1308inserted too.
1232 1309
1233=back 1310=back
1250 1327
1251=head1 ISO 14755 SUPPORT 1328=head1 ISO 14755 SUPPORT
1252 1329
1253ISO 14755 is a standard for entering and viewing unicode characters 1330ISO 14755 is a standard for entering and viewing unicode characters
1254and character codes using the keyboard. It consists of 4 parts. The 1331and character codes using the keyboard. It consists of 4 parts. The
1255first part is available rxvt-unicode has been compiled with 1332first part is available if rxvt-unicode has been compiled with
1256C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1333C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1257with C<--enable-iso14755>. 1334with C<--enable-iso14755>.
1258 1335
1259=over 4 1336=over 4
1260 1337
1414resources or on the command line. 1491resources or on the command line.
1415 1492
1416=item B<COLORTERM> 1493=item B<COLORTERM>
1417 1494
1418Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1495Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1419compiled with XPM support, and optionally with the added extension 1496compiled with background image support, and optionally with the added
1420C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1497extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1498screen.
1421 1499
1422=item B<COLORFGBG> 1500=item B<COLORFGBG>
1423 1501
1424Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1502Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1425the colour code used as default foreground/text colour (or the string 1503the colour code used as default foreground/text colour (or the string
1426C<default> to indicate that the default-colour escape sequence is to be 1504C<default> to indicate that the default-colour escape sequence is to be
1427used), C<bg> is the colour code used as default background colour (or the 1505used), C<bg> is the colour code used as default background colour (or the
1428string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1506string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1429was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1507was compiled with background image support. Libraries like C<ncurses>
1430(and do) use this information to optimize screen output. 1508and C<slang> can (and do) use this information to optimize screen output.
1431 1509
1432=item B<WINDOWID> 1510=item B<WINDOWID>
1433 1511
1434Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1512Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1435window, which usually has subwindows for the scrollbar, the terminal 1513window, which usually has subwindows for the scrollbar, the terminal
1526Project Coordinator (changes.txt 2.21a to 2.4.5) 1604Project Coordinator (changes.txt 2.21a to 2.4.5)
1527 1605
1528=item Geoff Wing L<< <gcw@pobox.com> >> 1606=item Geoff Wing L<< <gcw@pobox.com> >>
1529 1607
1530Rewrote screen display and text selection routines. 1608Rewrote screen display and text selection routines.
1531 1609
1532Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1610Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1533 1611
1534=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1612=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1535 1613
1536Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1614Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines