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.119 by root, Mon Aug 7 16:04:29 2006 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 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/*checkout*/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
… …
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>. 104resource B<depth>.
102 105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
103=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
104 112
105Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
106 114
107=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
108 116
109Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
110 118
111=item B<-j>|B<+j> 119=item B<-j>|B<+j>
112 120
113Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 122
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
116 124
117Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119 126
120I<Please note that transparency of any kind if completely unsupported by 127=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions! Read the FAQ (man 7 128
122@@RXVT_NAME@@)!> 129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123 136
124=item B<-fade> I<number> 137=item B<-fade> I<number>
125 138
126Fade the text by the given percentage when focus is lost. Small values 139Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
… …
133is opaque black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
134 147
135=item B<-tint> I<colour> 148=item B<-tint> I<colour>
136 149
137Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-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 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
141I<tintColor>. Example: 158I<tintColor>. Example:
142 159
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 161
145=item B<-sh> 162=item B<-sh> I<number>
146 163
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>). 166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
150 186
151=item B<-bg> I<colour> 187=item B<-bg> I<colour>
152 188
153Window background colour; resource B<background>. 189Window background colour; resource B<background>.
154 190
155=item B<-fg> I<colour> 191=item B<-fg> I<colour>
156 192
157Window foreground colour; resource B<foreground>. 193Window foreground colour; resource B<foreground>.
158 194
159=item B<-pixmap> I<file[;geom]> 195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160 196
161Compile I<XPM>: Specify XPM file for the background and also optionally 197Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 198optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 199add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 200command-line; for more details see resource B<backgroundPixmap>.
165 201
166=item B<-cr> I<colour> 202=item B<-cr> I<colour>
167 203
168The cursor colour; resource B<cursorColor>. 204The cursor colour; resource B<cursorColor>.
169 205
… …
214italic> >> characters are to be printed. See resource B<boldItalicFont> 250italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details. 251for details.
216 252
217=item B<-is>|B<+is> 253=item B<-is>|B<+is>
218 254
219Compile I<font-styles>: Bold/Italic font styles imply high intensity 255Compile I<font-styles>: Bold/Blink font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for 256foreground/background (default). See resource B<intensityStyles> for
221details. 257details.
222 258
223=item B<-name> I<name> 259=item B<-name> I<name>
224 260
… …
242 278
243=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
244 280
245Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
246 282
283=item B<-sr>|B<+sr>
284
285Put scrollbar on right/left; resource B<scrollBar_right>.
286
287=item B<-st>|B<+st>
288
289Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
290resource B<scrollBar_floating>.
291
247=item B<-si>|B<+si> 292=item B<-si>|B<+si>
248 293
249Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
250B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
251 296
… …
257=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
258 303
259Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
260This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
261B<scrollWithBuffer>. 306B<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 307
272=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
273 309
274If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
275actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
… …
322 358
323=item B<-lsp> I<number> 359=item B<-lsp> I<number>
324 360
325Compile I<frills>: Lines (pixel height) to insert between each row of 361Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 362the display. Useful to work around font rendering problems; resource
327B<linespace>. 363B<lineSpace>.
328 364
329=item B<-tn> I<termname> 365=item B<-tn> I<termname>
330 366
331This option specifies the name of the terminal type to be set in the 367This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 368B<TERM> environment variable. This terminal type must exist in the
… …
386for more info. 422for more info.
387 423
388=item B<-tcw> 424=item B<-tcw>
389 425
390Change the meaning of triple-click selection with the left mouse 426Change the meaning of triple-click selection with the left mouse
427button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 428in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 429the end of the logical line only. resource B<tripleclickwords>.
393 430
394=item B<-insecure> 431=item B<-insecure>
395 432
396Enable "insecure" mode, which currently enables most of the escape 433Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 434sequences that echo strings. See the resource B<insecure> for more
… …
417 454
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 456will 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 457it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 458user; resource B<hold>.
459
460=item B<-xrm> I<string>
461
462Works like the X Toolkit option of the same name, by adding the I<string>
463as if it were specified in a resource file. Resource values specified this
464way take precedence over all other resource specifications.
465
466Note that you need to use the I<same> syntax as in the .Xdefaults file,
467e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
468options can be specified as long-options on the commandline, so use
469of B<-xrm> is mostly limited to cases where you want to specify other
470resources (e.g. for input methods) or for compatibility with other
471programs.
422 472
423=item B<-keysym.>I<sym> I<string> 473=item B<-keysym.>I<sym> I<string>
424 474
425Remap a key symbol. See resource B<keysym>. 475Remap a key symbol. See resource B<keysym>.
426 476
… …
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 511If 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 512entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 513yourself if you want that.
464 514
465As an extremely special case, specifying C<-1> will completely suppress 515As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 516pty/tty operations, which is probably only useful in conjunction with some
517perl extension that manages the terminal.
467 518
468Here is a example in perl that illustrates how this option can be used (a 519Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 520longer example is in F<doc/pty-fd>):
470 521
471 use IO::Pty; 522 use IO::Pty;
… …
485Comma-separated list of perl extension scripts to use (or not to use) in 536Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 537this terminal instance. See resource B<perl-ext> for details.
487 538
488=back 539=back
489 540
490=head1 RESOURCES (available also as long-options) 541=head1 RESOURCES
491 542
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 543Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 544options) compiled into your version. All resources are also available as
545long-options.
494 546
495You can set and change the resources using X11 tools like B<xrdb>. Many 547You 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 548distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 549starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 550with later settings overwriting earlier ones:
… …
500 1. system-wide app-defaults file, either locale-dependent OR global 552 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 553 2. app-defaults file in $XAPPLRESDIR
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503 4. SCREEN_RESOURCES for the current screen 555 4. SCREEN_RESOURCES for the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline
505 558
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 560names: 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 561common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 562configured, while the class name B<URxvt> allows resources unique to
… …
564Use the specified colour to display underlined characters when the 617Use the specified colour to display underlined characters when the
565foreground colour is the default. 618foreground colour is the default.
566 619
567=item B<colorRV:> I<colour> 620=item B<colorRV:> I<colour>
568 621
569Use the specified colour as the background for reverse video 622Use the specified colour as the background for reverse video characters
570characters. 623when OPTION_HC is disabled (--disable-frills).
571 624
572=item B<underlineColor:> I<colour> 625=item B<underlineColor:> I<colour>
573 626
574If set, use the specified colour as the colour for the underline 627If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 628itself. If unset, use the foreground colour.
… …
591option B<-rv>. B<False>: regular screen colours [default]; option 644option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 645B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 646
594=item B<jumpScroll:> I<boolean> 647=item B<jumpScroll:> I<boolean>
595 648
596B<True>: specify that jump scrolling should be used. When scrolling 649B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 650of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
651has been read, resulting in fewer updates while still displaying every
652received line; option B<-j>.
653
598B<False>: specify that smooth scrolling should be used; option B<+j>. 654B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
655force a screen refresh on each new line it received; option B<+j>.
599 656
600=item B<inheritPixmap:> I<boolean> 657=item B<skipScroll:> I<boolean>
601 658
602B<True>: make the background inherit the parent windows' pixmap, giving 659B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 660receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 661(around 60 times per second), resulting in far fewer updates. This can
662result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
663option B<-ss>.
605 664
606I<Please note that transparency of any kind if completely unsupported by 665B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 666if the refresh is too fast for the human eye to read anything (or the
667monitor to display anything); option B<+ss>.
668
669=item B<transparent:> I<boolean>
670
671Turn on/off illusion of a transparent window background.
672
673B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
674future versions.
675
676I<Please address all transparency related issues to Sasha Vasko at
677sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
608 678
609=item B<fading:> I<number> 679=item B<fading:> I<number>
610 680
611Fade the text by the given percentage when focus is lost; option B<-fade>. 681Fade the text by the given percentage when focus is lost; option B<-fade>.
612 682
… …
620Tint the transparent background pixmap with the given colour; option 690Tint the transparent background pixmap with the given colour; option
621B<-tint>. 691B<-tint>.
622 692
623=item B<shading:> I<number> 693=item B<shading:> I<number>
624 694
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 695Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626image in addition to tinting it. 696in addition to tinting it; option B<-sh>.
697
698=item B<blendType:> I<string>
699
700Specify background blending type; option B<-blt>.
701
702=item B<blurRadius:> I<number>
703
704Apply Gaussian Blurr with the specified radius to the transparent
705background image; option B<-blr>.
627 706
628=item B<scrollColor:> I<colour> 707=item B<scrollColor:> I<colour>
629 708
630Use the specified colour for the scrollbar [default #B2B2B2]. 709Use the specified colour for the scrollbar [default #B2B2B2].
631 710
… …
637=item B<borderColor:> I<colour> 716=item B<borderColor:> I<colour>
638 717
639The colour of the border around the text area and between the scrollbar 718The colour of the border around the text area and between the scrollbar
640and the text. 719and the text.
641 720
642=item B<backgroundPixmap:> I<file[;geom]> 721=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643 722
644Use the specified XPM file (note the `.xpm' extension is optional) for 723Use the specified image file for the background and also
645the background and also optionally specify its scaling with a geometry 724optionally specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 725(default C<0x0+50+50>) in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 726horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale 727centre (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 728of 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 729an integer number of images in that direction. No image will be magnified
651be magnified beyond 10 times its original size. The maximum permitted 730beyond 10 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 731Additional operations can be specified after colon B<:op1:op2...>.
732Supported operations are:
733
734 tile force background image to be tiled and not scaled. Equivalent to 0x0
735 propscale will scale image keeping proportions
736 auto will scale image to match window size. Equivalent to 100x100
737 hscale will scale image horizontally to the window size
738 vscale will scale image vertically to the window size
739 scale will scale image to match window size
740 root will tile image as if it was a root window background, auto-adjusting
741 whenever terminal window moves
742
743If used in conjunction with B<-tr> option, the specified pixmap will be
744blended over transparency image using either alpha-blending, or any
745other blending type, specified with B<-blt "type"> option.
653 746
654=item B<path:> I<path> 747=item B<path:> I<path>
655 748
656Specify the colon-delimited search path for finding XPM files. 749Specify the colon-delimited search path for finding background image files.
657 750
658=item B<font:> I<fontlist> 751=item B<font:> I<fontlist>
659 752
660Select the fonts to be used. This is a comma separated list of font names 753Select 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 754that are checked in order when trying to find glyphs for characters. The
… …
718text font will being used for the given style. 811text font will being used for the given style.
719 812
720=item B<intensityStyles:> I<boolean> 813=item B<intensityStyles:> I<boolean>
721 814
722When font styles are not enabled, or this option is enabled (B<True>, 815When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 816option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 817intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 818option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 819reachable.
727 820
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> 821=item B<title:> I<string>
740 822
741Set window title string, the default title is the command-line 823Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 824specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 825name; option B<-title>.
… …
751=item B<mapAlert:> I<boolean> 833=item B<mapAlert:> I<boolean>
752 834
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 835B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 836de-iconify (map) on receipt of a bell character [default].
755 837
838=item B<urgentOnBell:> I<boolean>
839
840B<True>: set the urgency hint for the wm on receipt of a bell character.
841B<False>: do not set the urgency hint [default].
842
756=item B<visualBell:> I<boolean> 843=item B<visualBell:> I<boolean>
757 844
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 845B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 846B<False>: no visual bell [default]; option B<+vb>.
760 847
… …
782 869
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 870 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 871
785This creates a new file in your home directory with the screen contents 872This creates a new file in your home directory with the screen contents
786every time you hit C<Print>. 873every time you hit C<Print>.
874
875=item B<scrollstyle:> I<mode>
876
877Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
878the author's favourite.
787 879
788=item B<scrollBar:> I<boolean> 880=item B<scrollBar:> I<boolean>
789 881
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 882B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 883disable the scrollbar; option B<+sb>.
… …
854=item B<termName:> I<termname> 946=item B<termName:> I<termname>
855 947
856Specifies the terminal type name to be set in the B<TERM> environment 948Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 949variable; option B<-tn>.
858 950
859=item B<linespace:> I<number> 951=item B<lineSpace:> I<number>
860 952
861Specifies number of lines (pixel height) to insert between each row of 953Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 954the display [default 0]; option B<-lsp>.
863 955
864=item B<meta8:> I<boolean> 956=item B<meta8:> I<boolean>
… …
916=item B<cutchars:> I<string> 1008=item B<cutchars:> I<string>
917 1009
918The characters used as delimiters for double-click word selection 1010The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 1011(whitespace delimiting is added automatically if resource is given).
920 1012
921When the selection extension is in use (the default if compiled in, see 1013When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1014in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 1015characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 1016will be created). In this mode, characters outside ISO-8859-1 can be used.
925 1017
926When the selection extension is not used, only ISO-8859-1 characters can 1018When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 1019be used. If not specified, the built-in default is used:
928 1020
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1021B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 1022
931=item B<preeditType:> I<style> 1023=item B<preeditType:> I<style>
932 1024
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1025B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 1026
… …
988 1080
989Turn on/off secondary screen (default enabled). 1081Turn on/off secondary screen (default enabled).
990 1082
991=item B<secondaryScroll:> I<boolean> 1083=item B<secondaryScroll:> I<boolean>
992 1084
993Turn on/off secondary screen scroll (default enabled). If the this 1085Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1086option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1087scrollback buffer and switching to/from the secondary screen will
996instead scroll the screen up. 1088instead scroll the screen up.
997 1089
998=item B<hold>: I<boolean> 1090=item B<hold>: I<boolean>
… …
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1114searching 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 1115omitting 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 1116keysym 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. 1117performed in an exact manner; however, the closest match is assured.
1026 1118
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1119I<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, 1120number), 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.
1032
1033Please note that you need to double the C<\> in resource files, as
1034Xlib itself does its own de-escaping (you can use C<\033> instead of
1035C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1036processing).
1037 1121
1038You can define a range of keysyms in one shot by providing a I<string> 1122You can define a range of keysyms in one shot by providing a I<string>
1039with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1123with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040should be a character not used by the strings. 1124should be a character not used by the strings.
1041 1125
… …
1154(default: C<M-s>). 1238(default: C<M-s>).
1155 1239
1156=item B<urlLauncher>: I<string> 1240=item B<urlLauncher>: I<string>
1157 1241
1158Specifies the program to be started with a URL argument. Used by the 1242Specifies the program to be started with a URL argument. Used by the
1159C<selection-popup> and C<mark-urls> perl extensions. 1243C<selection-popup> and C<matcher> perl extensions.
1160 1244
1161=item B<transient-for>: I<windowid> 1245=item B<transient-for>: I<windowid>
1162 1246
1163Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1247Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164 1248
1165=item B<override-redirect>: I<boolean> 1249=item B<override-redirect>: I<boolean>
1166 1250
1167Compile I<frills>: Sets override-redirect for the terminal window, making 1251Compile I<frills>: Sets override-redirect for the terminal window, making
1168it almost invisible to window managers; option B<-override-redirect>. 1252it almost invisible to window managers; option B<-override-redirect>.
1253
1254=item B<iso14755_52:> I<boolean>
1255
1256Turn on/off ISO 14755 5.2 mode (default enabled).
1169 1257
1170=back 1258=back
1171 1259
1172=head1 THE SCROLLBAR 1260=head1 THE SCROLLBAR
1173 1261
… …
1192application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1280application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1281(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1194up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1282up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195respectively. 1283respectively.
1196 1284
1197=head1 TEXT SELECTION AND INSERTION 1285=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198 1286
1199The behaviour of text selection and insertion mechanism is similar to 1287The behaviour of text selection and insertion/pasting mechanism is similar
1200I<xterm>(1). 1288to I<xterm>(1).
1201 1289
1202=over 4 1290=over 4
1203 1291
1204=item B<Selection>: 1292=item B<Selecting>:
1205 1293
1206Left click at the beginning of the region, drag to the end of the region 1294Left click at the beginning of the region, drag to the end of the region
1207and release; Right click to extend the marked region; Left double-click 1295and release; Right click to extend the marked region; Left double-click
1208to select a word; Left triple-click to select the entire logical line 1296to select a word; Left triple-click to select the entire logical line
1209(which can span multiple screen lines), unless modified by resource 1297(which can span multiple screen lines), unless modified by resource
… …
1213(Compile: I<frills>) will create a rectangular selection instead of a 1301(Compile: I<frills>) will create a rectangular selection instead of a
1214normal one. In this mode, every selected row becomes its own line in the 1302normal one. In this mode, every selected row becomes its own line in the
1215selection, and trailing whitespace is visually underlined and removed from 1303selection, and trailing whitespace is visually underlined and removed from
1216the selection. 1304the selection.
1217 1305
1218=item B<Insertion>: 1306=item B<Pasting>:
1219 1307
1220Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1308Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1221window causes the value of the PRIMARY selection (or CLIPBOARD with the 1309window causes the value of the PRIMARY selection (or CLIPBOARD with the
1222Meta modifier) to be inserted as if it had been typed on the keyboard. 1310B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223 1311
1224Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1312Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225inserted too. 1313inserted too.
1226 1314
1227=back 1315=back
… …
1244 1332
1245=head1 ISO 14755 SUPPORT 1333=head1 ISO 14755 SUPPORT
1246 1334
1247ISO 14755 is a standard for entering and viewing unicode characters 1335ISO 14755 is a standard for entering and viewing unicode characters
1248and character codes using the keyboard. It consists of 4 parts. The 1336and character codes using the keyboard. It consists of 4 parts. The
1249first part is available rxvt-unicode has been compiled with 1337first part is available if rxvt-unicode has been compiled with
1250C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1338C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251with C<--enable-iso14755>. 1339with C<--enable-iso14755>.
1252 1340
1253=over 4 1341=over 4
1254 1342
… …
1373=back 1461=back
1374 1462
1375=head2 ALPHA CHANNEL SUPPORT 1463=head2 ALPHA CHANNEL SUPPORT
1376 1464
1377If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1465If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1466their act together, rxvt-unicode will do it's own alpha channel management:
1379(recommended, but B<MUST> have 4 digits/component) colour specifications, 1467
1380in addition to the ones provided by X, where the additional A component 1468You can prefix any color with an opaquenes percentage enclosed in
1469brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1470(0-100) that specifies the opacity of the color, where C<0> is completely
1471transparent and C<100> is completely opaque. For example, C<[50]red> is a
1472half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1473is the recommended format to specify transparency values, and works with
1474all ways to specify a colour.
1475
1476For complete control, rxvt-unicode also supports
1477C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1478specifications, where the additional C<aaaa> component specifies opacity
1381specifies opacity (alpha) values. The minimum value of C<0> is completely 1479(alpha) values. The minimum value of C<0000> is completely transparent,
1382transparent). You can also prefix any color with C<[a]>, where C<a> is on 1480while C<ffff> is completely opaque). The two example colours from
1383to four hex digits specifiying the opacity value. 1481earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1482C<rgba:0000/ff00/0000/f332>.
1384 1483
1385You probably need to specify B<"-depth 32">, too, and have the luck that 1484You probably need to specify B<"-depth 32">, too, to force a visual with
1386your X-server uses ARGB pixel layout, as X is far from just supporting 1485alpha channels, and have the luck that your X-server uses ARGB pixel
1387ARGB visuals out of the box, and rxvt-unicode just fudges around. 1486layout, as X is far from just supporting ARGB visuals out of the box, and
1487rxvt-unicode just fudges around.
1388 1488
1389For example, the following selects an almost completely transparent red 1489For example, the following selects an almost completely transparent black
1390background, and an almost opaque pink foreground: 1490background, and an almost opaque pink foreground:
1391 1491
1392 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1492 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1393 1493
1394I<Please note that transparency of any kind if completely unsupported by 1494When not using a background image, then the interpretation of the
1395the author. Don't bug him with installation questions!> 1495alpha channel is up to your compositing manager (most interpret it as
1496transparency of course).
1497
1498When using a background pixmap or pseudo-transparency, then the background
1499colour will always behave as if it were completely transparent (so the
1500background image shows instead), regardless of how it was specified, while
1501other colours will either be transparent as specified (the background
1502image will show through) on servers supporting the RENDER extension, or
1503fully opaque on servers not supporting the RENDER EXTENSION.
1504
1505Please note that due to bugs in Xft, specifying alpha values might result
1506in garbage being displayed when the X-server does not support the RENDER
1507extension.
1396 1508
1397=head1 ENVIRONMENT 1509=head1 ENVIRONMENT
1398 1510
1399B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1511B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1400 1512
… …
1406resources or on the command line. 1518resources or on the command line.
1407 1519
1408=item B<COLORTERM> 1520=item B<COLORTERM>
1409 1521
1410Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1522Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411compiled with XPM support, and optionally with the added extension 1523compiled with background image support, and optionally with the added
1412C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1524extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1525screen.
1413 1526
1414=item B<COLORFGBG> 1527=item B<COLORFGBG>
1415 1528
1416Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1529Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1417the colour code used as default foreground/text colour (or the string 1530the colour code used as default foreground/text colour (or the string
1418C<default> to indicate that the default-colour escape sequence is to be 1531C<default> to indicate that the default-colour escape sequence is to be
1419used), C<bg> is the colour code used as default background colour (or the 1532used), C<bg> is the colour code used as default background colour (or the
1420string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1533string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1421was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1534was compiled with background image support. Libraries like C<ncurses>
1422(and do) use this information to optimize screen output. 1535and C<slang> can (and do) use this information to optimize screen output.
1423 1536
1424=item B<WINDOWID> 1537=item B<WINDOWID>
1425 1538
1426Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1539Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1427window, which usually has subwindows for the scrollbar, the terminal 1540window, which usually has subwindows for the scrollbar, the terminal
… …
1518Project Coordinator (changes.txt 2.21a to 2.4.5) 1631Project Coordinator (changes.txt 2.21a to 2.4.5)
1519 1632
1520=item Geoff Wing L<< <gcw@pobox.com> >> 1633=item Geoff Wing L<< <gcw@pobox.com> >>
1521 1634
1522Rewrote screen display and text selection routines. 1635Rewrote screen display and text selection routines.
1523 1636
1524Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1637Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525 1638
1526=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1639=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1527 1640
1528Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1641Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines