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.107 by root, Sun Jan 29 20:51:27 2006 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 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 left-to-right 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 userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<frills>: 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>. 126
127=item B<-tr>|B<+tr>
128
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@@)!>
119 136
120=item B<-fade> I<number> 137=item B<-fade> I<number>
121 138
122Fade 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
123fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
124colour; resource B<fading>. 141colour; resource B<fading>.
125 142
126=item B<-fadecolor> I<colour> 143=item B<-fadecolor> I<colour>
127 144
128Fade to this colour when fading is used (see B<-fade>). The default colour 145Fade to this colour when fading is used (see B<-fade>). The default colour
129is black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
130 147
131=item B<-tint> I<colour> 148=item B<-tint> I<colour>
132 149
133Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
134transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
135non-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
136used 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
137I<tintColor>. Example: 158I<tintColor>. Example:
138 159
139 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
140 161
141=item B<-sh> 162=item B<-sh> I<number>
142 163
143I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
144background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
145specified, 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>.
146 186
147=item B<-bg> I<colour> 187=item B<-bg> I<colour>
148 188
149Window background colour; resource B<background>. 189Window background colour; resource B<background>.
150 190
151=item B<-fg> I<colour> 191=item B<-fg> I<colour>
152 192
153Window foreground colour; resource B<foreground>. 193Window foreground colour; resource B<foreground>.
154 194
155=item B<-pixmap> I<file[;geom]> 195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
156 196
157Compile I<XPM>: Specify XPM file for the background and also optionally 197Compile I<afterimage>: Specify image file for the background and also
158specify its scaling with a geometry string. Note you may need to 198optionally specify its scaling with a geometry string. Note you may need to
159add quotes to avoid special shell interpretation of the C<;> in the 199add quotes to avoid special shell interpretation of the C<;> in the
160command-line; resource B<backgroundPixmap>. 200command-line; for more details see resource B<backgroundPixmap>.
161 201
162=item B<-cr> I<colour> 202=item B<-cr> I<colour>
163 203
164The cursor colour; resource B<cursorColor>. 204The cursor colour; resource B<cursorColor>.
165 205
182that are checked in order when trying to find glyphs for characters. The 222that are checked in order when trying to find glyphs for characters. The
183first font defines the cell size for characters; other fonts might be 223first font defines the cell size for characters; other fonts might be
184smaller, but not (in general) larger. A (hopefully) reasonable default 224smaller, but not (in general) larger. A (hopefully) reasonable default
185font list is always appended to it. See resource B<font> for more details. 225font list is always appended to it. See resource B<font> for more details.
186 226
187In short, to specify an X11 core font, just specify it's name or prefix it 227In short, to specify an X11 core font, just specify its name or prefix it
188with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 228with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189e.g.: 229e.g.:
190 230
191 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 231 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 232 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
210italic> >> characters are to be printed. See resource B<boldItalicFont> 250italic> >> characters are to be printed. See resource B<boldItalicFont>
211for details. 251for details.
212 252
213=item B<-is>|B<+is> 253=item B<-is>|B<+is>
214 254
215Compile I<font-styles>: Bold/Italic font styles imply high intensity 255Compile I<font-styles>: Bold/Blink font styles imply high intensity
216foreground/background (default). See resource B<intensityStyles> for 256foreground/background (default). See resource B<intensityStyles> for
217details. 257details.
218 258
219=item B<-name> I<name> 259=item B<-name> I<name>
220 260
238 278
239=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
240 280
241Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
242 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
243=item B<-si>|B<+si> 292=item B<-si>|B<+si>
244 293
245Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
246B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
247 296
253=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
254 303
255Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
256This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
257B<scrollWithBuffer>. 306B<scrollWithBuffer>.
258
259=item B<-sr>|B<+sr>
260
261Put scrollbar on right/left; resource B<scrollBar_right>.
262
263=item B<-st>|B<+st>
264
265Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
266resource B<scrollBar_floating>.
267 307
268=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
269 309
270If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
271actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
318 358
319=item B<-lsp> I<number> 359=item B<-lsp> I<number>
320 360
321Compile I<frills>: Lines (pixel height) to insert between each row of 361Compile I<frills>: Lines (pixel height) to insert between each row of
322the display. Useful to work around font rendering problems; resource 362the display. Useful to work around font rendering problems; resource
323B<linespace>. 363B<lineSpace>.
324 364
325=item B<-tn> I<termname> 365=item B<-tn> I<termname>
326 366
327This 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
328B<TERM> environment variable. This terminal type must exist in the 368B<TERM> environment variable. This terminal type must exist in the
382for more info. 422for more info.
383 423
384=item B<-tcw> 424=item B<-tcw>
385 425
386Change 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
387button. 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
388end of the logical line only. resource B<tripleclickwords>. 429the end of the logical line only. resource B<tripleclickwords>.
389 430
390=item B<-insecure> 431=item B<-insecure>
391 432
392Enable "insecure" mode, which currently enables most of the escape 433Enable "insecure" mode, which currently enables most of the escape
393sequences that echo strings. See the resource B<insecure> for more 434sequences that echo strings. See the resource B<insecure> for more
414Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415will not immediately destroy its window when the program executed within 456will not immediately destroy its window when the program executed within
416it 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
417user; resource B<hold>. 458user; resource B<hold>.
418 459
460=item B<-cd> I<path>
461
462Sets the working directory for the shell (or the command specified via
463B<-e>). The I<path> must be an absolute path and it must exist for
464@@RXVT_NAME@@ to start; resource B<chdir>.
465
466=item B<-xrm> I<string>
467
468Works like the X Toolkit option of the same name, by adding the I<string>
469as if it were specified in a resource file. Resource values specified this
470way take precedence over all other resource specifications.
471
472Note that you need to use the I<same> syntax as in the .Xdefaults file,
473e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
474options can be specified as long-options on the commandline, so use
475of B<-xrm> is mostly limited to cases where you want to specify other
476resources (e.g. for input methods) or for compatibility with other
477programs.
478
419=item B<-keysym.>I<sym> I<string> 479=item B<-keysym.>I<sym> I<string>
420 480
421Remap a key symbol. See resource B<keysym>. 481Remap a key symbol. See resource B<keysym>.
422 482
423=item B<-embed> I<windowid> 483=item B<-embed> I<windowid>
424 484
425Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 485Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426which enables applications to easily embed a terminal. 486which enables applications to easily embed a terminal.
427 487
428Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 488Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 489shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430quite a bit, so don't expect it to keep some specific state. It's best to 490quite a bit, so don't expect it to keep some specific state. It's best to
433The window will not be destroyed when @@RXVT_NAME@@ exits. 493The window will not be destroyed when @@RXVT_NAME@@ exits.
434 494
435It might be useful to know that @@RXVT_NAME@@ will not close file 495It might be useful to know that @@RXVT_NAME@@ will not close file
436descriptors passed to it (except for stdin/out/err, of course), so you 496descriptors passed to it (except for stdin/out/err, of course), so you
437can use file descriptors to communicate with the programs within the 497can use file descriptors to communicate with the programs within the
438terminal. This works regardless of wether the C<-embed> option was used or 498terminal. This works regardless of whether the C<-embed> option was used or
439not. 499not.
440 500
441Here is a short Gtk2-perl snippet that illustrates how this option can be 501Here is a short Gtk2-perl snippet that illustrates how this option can be
442used (a longer example is in F<doc/embed>): 502used (a longer example is in F<doc/embed>):
443 503
448 }); 508 });
449 509
450=item B<-pty-fd> I<file descriptor> 510=item B<-pty-fd> I<file descriptor>
451 511
452Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 512Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
453pair but instead use the given filehandle as the tty master. This is 513pair but instead use the given file descriptor as the tty master. This is
454useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 514useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455without having to run a program within it. 515without having to run a program within it.
456 516
457If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 517If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
458entries and will not tinker with pty/tty permissions - you have to do that 518entries and will not tinker with pty/tty permissions - you have to do that
459yourself if you want that. 519yourself if you want that.
460 520
461As an extremely special case, specifying C<-1> will completely suppress 521As an extremely special case, specifying C<-1> will completely suppress
462pty/tty operations. 522pty/tty operations, which is probably only useful in conjunction with some
523perl extension that manages the terminal.
463 524
464Here is a example in perl that illustrates how this option can be used (a 525Here is a example in perl that illustrates how this option can be used (a
465longer example is in F<doc/pty-fd>): 526longer example is in F<doc/pty-fd>):
466 527
467 use IO::Pty; 528 use IO::Pty;
481Comma-separated list of perl extension scripts to use (or not to use) in 542Comma-separated list of perl extension scripts to use (or not to use) in
482this terminal instance. See resource B<perl-ext> for details. 543this terminal instance. See resource B<perl-ext> for details.
483 544
484=back 545=back
485 546
486=head1 RESOURCES (available also as long-options) 547=head1 RESOURCES
487 548
488Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 549Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
489options) compiled into your version. 550options) compiled into your version. All resources are also available as
551long-options.
490 552
491You can set and change the resources using X11 tools like B<xrdb>. Many 553You can set and change the resources using X11 tools like B<xrdb>. Many
492distribution do also load settings from the B<~/.Xresources> file when X 554distribution do also load settings from the B<~/.Xresources> file when X
493starts. @@RXVT_NAME@@ will consult the following files/resources in order, 555starts. @@RXVT_NAME@@ will consult the following files/resources in order,
494with later settings overwriting earlier ones: 556with later settings overwriting earlier ones:
496 1. system-wide app-defaults file, either locale-dependent OR global 558 1. system-wide app-defaults file, either locale-dependent OR global
497 2. app-defaults file in $XAPPLRESDIR 559 2. app-defaults file in $XAPPLRESDIR
498 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 560 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
499 4. SCREEN_RESOURCES for the current screen 561 4. SCREEN_RESOURCES for the current screen
500 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 562 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
563 6. resources specified via -xrm on the commandline
501 564
502Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 565Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
503names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 566names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
504common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 567common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
505configured, while the class name B<URxvt> allows resources unique to 568configured, while the class name B<URxvt> allows resources unique to
512 575
513=over 4 576=over 4
514 577
515=item B<depth:> I<bitdepth> 578=item B<depth:> I<bitdepth>
516 579
517Compile I<frills>: Attempt to find a visual with the given bit depth; 580Compile I<xft>: Attempt to find a visual with the given bit depth;
518option B<-depth>. 581option B<-depth>.
582
583=item B<buffered:> I<boolean>
584
585Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
586On some card/driver combination enabling it slightly decreases
587performance, on most it greatly helps it. The slowdown is small, so it
588should normally be enabled.
519 589
520=item B<geometry:> I<geom> 590=item B<geometry:> I<geom>
521 591
522Create the window with the specified X window geometry [default 80x24]; 592Create the window with the specified X window geometry [default 80x24];
523option B<-geometry>. 593option B<-geometry>.
560Use the specified colour to display underlined characters when the 630Use the specified colour to display underlined characters when the
561foreground colour is the default. 631foreground colour is the default.
562 632
563=item B<colorRV:> I<colour> 633=item B<colorRV:> I<colour>
564 634
565Use the specified colour as the background for reverse video 635Use the specified colour as the background for reverse video characters
566characters. 636when OPTION_HC is disabled (--disable-frills).
567 637
568=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
569 639
570If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
571itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
587option B<-rv>. B<False>: regular screen colours [default]; option 657option B<-rv>. B<False>: regular screen colours [default]; option
588B<+rv>. See note in B<COLORS AND GRAPHICS> section. 658B<+rv>. See note in B<COLORS AND GRAPHICS> section.
589 659
590=item B<jumpScroll:> I<boolean> 660=item B<jumpScroll:> I<boolean>
591 661
592B<True>: specify that jump scrolling should be used. When scrolling 662B<True>: specify that jump scrolling should be used. When receiving lots
593quickly, fewer screen updates are performed [default]; option B<-j>. 663of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
664has been read, resulting in fewer updates while still displaying every
665received line; option B<-j>.
666
594B<False>: specify that smooth scrolling should be used; option B<+j>. 667B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
668force a screen refresh on each new line it received; option B<+j>.
595 669
596=item B<inheritPixmap:> I<boolean> 670=item B<skipScroll:> I<boolean>
597 671
598B<True>: make the background inherit the parent windows' pixmap, giving 672B<True>: (the default) specify that skip scrolling should be used. When
599artificial transparency. B<False>: do not inherit the parent windows' 673receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
600pixmap. 674(around 60 times per second), resulting in far fewer updates. This can
675result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
676option B<-ss>.
677
678B<False>: specify that everything is to be displayed, even
679if the refresh is too fast for the human eye to read anything (or the
680monitor to display anything); option B<+ss>.
681
682=item B<transparent:> I<boolean>
683
684Turn on/off illusion of a transparent window background.
685
686B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
687future versions.
688
689I<Please address all transparency related issues to Sasha Vasko at
690sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
601 691
602=item B<fading:> I<number> 692=item B<fading:> I<number>
603 693
604Fade the text by the given percentage when focus is lost; option B<-fade>. 694Fade the text by the given percentage when focus is lost; option B<-fade>.
605 695
613Tint the transparent background pixmap with the given colour; option 703Tint the transparent background pixmap with the given colour; option
614B<-tint>. 704B<-tint>.
615 705
616=item B<shading:> I<number> 706=item B<shading:> I<number>
617 707
618Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 708Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
619image in addition to tinting it. 709in addition to tinting it; option B<-sh>.
710
711=item B<blendType:> I<string>
712
713Specify background blending type; option B<-blt>.
714
715=item B<blurRadius:> I<number>
716
717Apply Gaussian Blurr with the specified radius to the transparent
718background image; option B<-blr>.
620 719
621=item B<scrollColor:> I<colour> 720=item B<scrollColor:> I<colour>
622 721
623Use the specified colour for the scrollbar [default #B2B2B2]. 722Use the specified colour for the scrollbar [default #B2B2B2].
624 723
630=item B<borderColor:> I<colour> 729=item B<borderColor:> I<colour>
631 730
632The colour of the border around the text area and between the scrollbar 731The colour of the border around the text area and between the scrollbar
633and the text. 732and the text.
634 733
635=item B<backgroundPixmap:> I<file[;geom]> 734=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
636 735
637Use the specified XPM file (note the `.xpm' extension is optional) for 736Use the specified image file for the background and also
638the background and also optionally specify its scaling with a geometry 737optionally specify its scaling with a geometry string B<WxH+X+Y>,
639string B<WxH+X+Y>, in which B<"W" / "H"> specify the 738(default C<0x0+50+50>) in which B<"W" / "H"> specify the
640horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 739horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
641centre (percent). A scale of 0 displays the image with tiling. A scale 740centre (percent). A scale of 0 displays the image with tiling. A scale
642of 1 displays the image without any scaling. A scale of 2 to 9 741of 1 displays the image without any scaling. A scale of 2 to 9 specifies
643specifies an integer number of images in that direction. No image will 742an integer number of images in that direction. No image will be magnified
644be magnified beyond 10 times its original size. The maximum permitted 743beyond 10 times its original size. The maximum permitted scale is 1000.
645scale is 1000. [default 0x0+50+50] 744Additional operations can be specified after colon B<:op1:op2...>.
745Supported operations are:
746
747 tile force background image to be tiled and not scaled. Equivalent to 0x0
748 propscale will scale image keeping proportions
749 auto will scale image to match window size. Equivalent to 100x100
750 hscale will scale image horizontally to the window size
751 vscale will scale image vertically to the window size
752 scale will scale image to match window size
753 root will tile image as if it was a root window background, auto-adjusting
754 whenever terminal window moves
755
756If used in conjunction with B<-tr> option, the specified pixmap will be
757blended over transparency image using either alpha-blending, or any
758other blending type, specified with B<-blt "type"> option.
646 759
647=item B<path:> I<path> 760=item B<path:> I<path>
648 761
649Specify the colon-delimited search path for finding XPM files. 762Specify the colon-delimited search path for finding background image files.
650 763
651=item B<font:> I<fontlist> 764=item B<font:> I<fontlist>
652 765
653Select the fonts to be used. This is a comma separated list of font names 766Select the fonts to be used. This is a comma separated list of font names
654that are checked in order when trying to find glyphs for characters. The 767that are checked in order when trying to find glyphs for characters. The
711text font will being used for the given style. 824text font will being used for the given style.
712 825
713=item B<intensityStyles:> I<boolean> 826=item B<intensityStyles:> I<boolean>
714 827
715When font styles are not enabled, or this option is enabled (B<True>, 828When font styles are not enabled, or this option is enabled (B<True>,
716option B<-is>, the default), bold and italic font styles imply high 829option B<-is>, the default), bold/blink font styles imply high
717intensity foreground/backround colours. Disabling this option (B<False>, 830intensity foreground/background colours. Disabling this option (B<False>,
718option B<+is>) disables this behaviour, the high intensity colours are not 831option B<+is>) disables this behaviour, the high intensity colours are not
719reachable. 832reachable.
720
721=item B<selectstyle:> I<mode>
722
723Set mouse selection style to B<old> which is 2.20, B<oldword> which is
724xterm style with 2.20 old word selection, or anything else which gives
725xterm style selection.
726
727=item B<scrollstyle:> I<mode>
728
729Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
730the author's favourite.
731 833
732=item B<title:> I<string> 834=item B<title:> I<string>
733 835
734Set window title string, the default title is the command-line 836Set window title string, the default title is the command-line
735specified after the B<-e> option, if any, otherwise the application 837specified after the B<-e> option, if any, otherwise the application
744=item B<mapAlert:> I<boolean> 846=item B<mapAlert:> I<boolean>
745 847
746B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 848B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
747de-iconify (map) on receipt of a bell character [default]. 849de-iconify (map) on receipt of a bell character [default].
748 850
851=item B<urgentOnBell:> I<boolean>
852
853B<True>: set the urgency hint for the wm on receipt of a bell character.
854B<False>: do not set the urgency hint [default].
855
749=item B<visualBell:> I<boolean> 856=item B<visualBell:> I<boolean>
750 857
751B<True>: use visual bell on receipt of a bell character; option B<-vb>. 858B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752B<False>: no visual bell [default]; option B<+vb>. 859B<False>: no visual bell [default]; option B<+vb>.
753 860
774Example: 881Example:
775 882
776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 883 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777 884
778This creates a new file in your home directory with the screen contents 885This creates a new file in your home directory with the screen contents
779everytime you hit C<Print>. 886every time you hit C<Print>.
887
888=item B<scrollstyle:> I<mode>
889
890Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
891the author's favourite.
780 892
781=item B<scrollBar:> I<boolean> 893=item B<scrollBar:> I<boolean>
782 894
783B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 895B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784disable the scrollbar; option B<+sb>. 896disable the scrollbar; option B<+sb>.
806 918
807=item B<scrollWithBuffer:> I<boolean> 919=item B<scrollWithBuffer:> I<boolean>
808 920
809B<True>: scroll with scrollback buffer when tty receives new lines (and 921B<True>: scroll with scrollback buffer when tty receives new lines (and
810B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 922B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
811with scrollback buffer when tty recieves new lines; option B<+sw>. 923with scrollback buffer when tty receives new lines; option B<+sw>.
812 924
813=item B<scrollTtyKeypress:> I<boolean> 925=item B<scrollTtyKeypress:> I<boolean>
814 926
815B<True>: scroll to bottom when a non-special key is pressed. Special keys 927B<True>: scroll to bottom when a non-special key is pressed. Special keys
816are those which are intercepted by rxvt-unicode for special handling and 928are those which are intercepted by rxvt-unicode for special handling and
847=item B<termName:> I<termname> 959=item B<termName:> I<termname>
848 960
849Specifies the terminal type name to be set in the B<TERM> environment 961Specifies the terminal type name to be set in the B<TERM> environment
850variable; option B<-tn>. 962variable; option B<-tn>.
851 963
852=item B<linespace:> I<number> 964=item B<lineSpace:> I<number>
853 965
854Specifies number of lines (pixel height) to insert between each row of 966Specifies number of lines (pixel height) to insert between each row of
855the display [default 0]; option B<-lsp>. 967the display [default 0]; option B<-lsp>.
856 968
857=item B<meta8:> I<boolean> 969=item B<meta8:> I<boolean>
909=item B<cutchars:> I<string> 1021=item B<cutchars:> I<string>
910 1022
911The characters used as delimiters for double-click word selection 1023The characters used as delimiters for double-click word selection
912(whitespace delimiting is added automatically if resource is given). 1024(whitespace delimiting is added automatically if resource is given).
913 1025
914When the selection extension is in use (the default if compiled in, see 1026When the perl selection extension is in use (the default if compiled
915the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1027in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
916will be created (if the resource exists, otherwise, no regex will be 1028characters will be created (if the resource exists, otherwise, no regex
917created). In this mode, characters outside ISO-8859-1 can be used. 1029will be created). In this mode, characters outside ISO-8859-1 can be used.
918 1030
919When the selection extension is not used, only ISO-8859-1 characters can 1031When the selection extension is not used, only ISO-8859-1 characters can
920be used. If not specified, the built-in default is used: 1032be used. If not specified, the built-in default is used:
921 1033
922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1034B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
923 1035
924=item B<preeditType:> I<style> 1036=item B<preeditType:> I<style>
925 1037
926B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1038B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
927 1039
981 1093
982Turn on/off secondary screen (default enabled). 1094Turn on/off secondary screen (default enabled).
983 1095
984=item B<secondaryScroll:> I<boolean> 1096=item B<secondaryScroll:> I<boolean>
985 1097
986Turn on/off secondary screen scroll (default enabled). If the this 1098Turn on/off secondary screen scroll (default enabled). If this
987option is enabled, scrolls on the secondary screen will change the 1099option is enabled, scrolls on the secondary screen will change the
988scrollback buffer and switching to/from the secondary screen will 1100scrollback buffer and, when secondaryScreen is off, switching
989instead scroll the screen up. 1101to/from the secondary screen will instead scroll the screen up.
990 1102
991=item B<hold>: I<boolean> 1103=item B<hold>: I<boolean>
992 1104
993Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1105Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
994will not immediately destroy its window when the program executed within 1106will not immediately destroy its window when the program executed within
995it exits. Instead, it will wait till it is being killed or closed by the 1107it exits. Instead, it will wait till it is being killed or closed by the
996user. 1108user.
1109
1110=item B<chdir>: I<path>
1111
1112Sets the working directory for the shell (or the command specified via
1113B<-e>). The I<path> must be an absolute path and it must exist for
1114@@RXVT_NAME@@ to start. If it isn't specified then the current working
1115directory will be used; option B<-cd>.
997 1116
998=item B<keysym.>I<sym>: I<string> 1117=item B<keysym.>I<sym>: I<string>
999 1118
1000Compile I<frills>: Associate I<string> with keysym I<sym>. The 1119Compile I<frills>: Associate I<string> with keysym I<sym>. The
1001intervening resource name B<keysym.> cannot be omitted. 1120intervening resource name B<keysym.> cannot be omitted.
1015searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1134searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1016omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1135omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1017keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1136keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1018performed in an exact manner; however, the closest match is assured. 1137performed in an exact manner; however, the closest match is assured.
1019 1138
1020I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1139I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1021C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1140number), see RESOURCES in C<man 7 X> for futher details.
1022C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1023C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024can start or end with whitespace.
1025
1026Please note that you need to double the C<\> in resource files, as
1027Xlib itself does it's own de-escaping (you can use C<\033> instead of
1028C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029processing).
1030 1141
1031You can define a range of keysyms in one shot by providing a I<string> 1142You can define a range of keysyms in one shot by providing a I<string>
1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1143with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033should be a character not used by the strings. 1144should be a character not used by the strings.
1034 1145
1035Its usage can be demonstrated by an example: 1146Its usage can be demonstrated by an example:
1036 1147
1037 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1148 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1101example, C<default,-selection> will use all the default extension except 1212example, C<default,-selection> will use all the default extension except
1102C<selection>. 1213C<selection>.
1103 1214
1104Extension names can also be followed by an argument in angle brackets 1215Extension names can also be followed by an argument in angle brackets
1105(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1216(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106searchable scorllback to Alt/Meta-s). Mentioning the same extension 1217searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107multiple times with different arguments will pass multiple arguments to 1218multiple times with different arguments will pass multiple arguments to
1108the extension. 1219the extension.
1109 1220
1110Each extension is looked up in the library directories, loaded if 1221Each extension is looked up in the library directories, loaded if
1111necessary, and bound to the current terminal instance. 1222necessary, and bound to the current terminal instance.
1147(default: C<M-s>). 1258(default: C<M-s>).
1148 1259
1149=item B<urlLauncher>: I<string> 1260=item B<urlLauncher>: I<string>
1150 1261
1151Specifies the program to be started with a URL argument. Used by the 1262Specifies the program to be started with a URL argument. Used by the
1152C<selection-popup> and C<mark-urls> perl extensions. 1263C<selection-popup> and C<matcher> perl extensions.
1153 1264
1154=item B<transient-for>: I<windowid> 1265=item B<transient-for>: I<windowid>
1155 1266
1156Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1267Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157 1268
1158=item B<override-redirect>: I<boolean> 1269=item B<override-redirect>: I<boolean>
1159 1270
1160Compile I<frills>: Sets override-redirect for the terminal window, making 1271Compile I<frills>: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option B<-override-redirect>. 1272it almost invisible to window managers; option B<-override-redirect>.
1273
1274=item B<iso14755_52:> I<boolean>
1275
1276Turn on/off ISO 14755 5.2 mode (default enabled).
1162 1277
1163=back 1278=back
1164 1279
1165=head1 THE SCROLLBAR 1280=head1 THE SCROLLBAR
1166 1281
1185application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1300application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1301(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1187up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1302up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188respectively. 1303respectively.
1189 1304
1190=head1 TEXT SELECTION AND INSERTION 1305=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191 1306
1192The behaviour of text selection and insertion mechanism is similar to 1307The behaviour of text selection and insertion/pasting mechanism is similar
1193I<xterm>(1). 1308to I<xterm>(1).
1194 1309
1195=over 4 1310=over 4
1196 1311
1197=item B<Selection>: 1312=item B<Selecting>:
1198 1313
1199Left click at the beginning of the region, drag to the end of the region 1314Left click at the beginning of the region, drag to the end of the region
1200and release; Right click to extend the marked region; Left double-click 1315and release; Right click to extend the marked region; Left double-click
1201to select a word; Left triple-click to select the entire logical line 1316to select a word; Left triple-click to select the entire logical line
1202(which can span multiple screen lines), unless modified by resource 1317(which can span multiple screen lines), unless modified by resource
1206(Compile: I<frills>) will create a rectangular selection instead of a 1321(Compile: I<frills>) will create a rectangular selection instead of a
1207normal one. In this mode, every selected row becomes its own line in the 1322normal one. In this mode, every selected row becomes its own line in the
1208selection, and trailing whitespace is visually underlined and removed from 1323selection, and trailing whitespace is visually underlined and removed from
1209the selection. 1324the selection.
1210 1325
1211=item B<Insertion>: 1326=item B<Pasting>:
1212 1327
1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1328Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214window causes the value of the PRIMARY selection (or CLIPBOARD with the 1329window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215Meta modifier) to be inserted as if it had been typed on the keyboard. 1330B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216 1331
1217Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1332Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218inserted too. 1333inserted too.
1219 1334
1220=back 1335=back
1237 1352
1238=head1 ISO 14755 SUPPORT 1353=head1 ISO 14755 SUPPORT
1239 1354
1240ISO 14755 is a standard for entering and viewing unicode characters 1355ISO 14755 is a standard for entering and viewing unicode characters
1241and character codes using the keyboard. It consists of 4 parts. The 1356and character codes using the keyboard. It consists of 4 parts. The
1242first part is available rxvt-unicode has been compiled with 1357first part is available if rxvt-unicode has been compiled with
1243C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1358C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244with C<--enable-iso14755>. 1359with C<--enable-iso14755>.
1245 1360
1246=over 4 1361=over 4
1247 1362
1267This mode lets you input characters representing the keycap symbols of 1382This mode lets you input characters representing the keycap symbols of
1268your keyboard, if representable in the current locale encoding. 1383your keyboard, if representable in the current locale encoding.
1269 1384
1270Start by pressing C<Control> and C<Shift> together, then releasing 1385Start by pressing C<Control> and C<Shift> together, then releasing
1271them. The next special key (cursor keys, home etc.) you enter will not 1386them. The next special key (cursor keys, home etc.) you enter will not
1272invoke it's usual function but instead will insert the corresponding 1387invoke its usual function but instead will insert the corresponding
1273keycap symbol. The symbol will only be entered when the key has been 1388keycap symbol. The symbol will only be entered when the key has been
1274released, otherwise pressing e.g. C<Shift> would enter the symbol for 1389released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275C<ISO Level 2 Switch>, although your intention might have been to enter a 1390C<ISO Level 2 Switch>, although your intention might have been to enter a
1276reverse tab (Shift-Tab). 1391reverse tab (Shift-Tab).
1277 1392
1340It is also possible to specify the colour values of B<foreground>, 1455It is also possible to specify the colour values of B<foreground>,
1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1456B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342a number 0-15, as a convenient shorthand to reference the colour name of 1457a number 0-15, as a convenient shorthand to reference the colour name of
1343color0-color15. 1458color0-color15.
1344 1459
1345If Xft support has been compiled in and as long as Xft/Xrender don't get 1460In addition to the colours defined above, @@RXVT_NAME@@ offers an
1346their act together, rxvt-unicode will support C<#ARGB>, C<#AARRGGBB> 1461additional 72 colours. The first 64 of those (with indices 16 to 79)
1347and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones 1462consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1348provided by X, where the additional A component specifies alpha (opacity) 146316>), followed by 8 additional shades of gray (with indices 80 to 87).
1349values (0 is completely transparent and the maximum is opaque). You 1464
1350probably need to specify B<"-depth 32">, too, as X is far from just 1465Together, all those colours implement the 88 colour xterm colours. Only
1351supporting ARGB visuals out of the box. 1466the first 16 can be changed using resources currently, the rest can only
1467be changed via command sequences ("escape codes").
1352 1468
1353Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1469Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1354always swapping the foreground/background colours. This is in contrast to 1470always swapping the foreground/background colours. This is in contrast to
1355I<xterm>(1) where the colours are only swapped if they have not otherwise 1471I<xterm>(1) where the colours are only swapped if they have not otherwise
1356been specified. For example, 1472been specified. For example,
1362would yield White on Black, while on I<xterm>(1) it would yield Black 1478would yield White on Black, while on I<xterm>(1) it would yield Black
1363on White. 1479on White.
1364 1480
1365=back 1481=back
1366 1482
1483=head2 ALPHA CHANNEL SUPPORT
1484
1485If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1486their act together, rxvt-unicode will do it's own alpha channel management:
1487
1488You can prefix any color with an opaquenes percentage enclosed in
1489brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1490(0-100) that specifies the opacity of the color, where C<0> is completely
1491transparent and C<100> is completely opaque. For example, C<[50]red> is a
1492half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1493is the recommended format to specify transparency values, and works with
1494all ways to specify a colour.
1495
1496For complete control, rxvt-unicode also supports
1497C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1498specifications, where the additional C<aaaa> component specifies opacity
1499(alpha) values. The minimum value of C<0000> is completely transparent,
1500while C<ffff> is completely opaque). The two example colours from
1501earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1502C<rgba:0000/ff00/0000/f332>.
1503
1504You probably need to specify B<"-depth 32">, too, to force a visual with
1505alpha channels, and have the luck that your X-server uses ARGB pixel
1506layout, as X is far from just supporting ARGB visuals out of the box, and
1507rxvt-unicode just fudges around.
1508
1509For example, the following selects an almost completely transparent black
1510background, and an almost opaque pink foreground:
1511
1512 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1513
1514When not using a background image, then the interpretation of the
1515alpha channel is up to your compositing manager (most interpret it as
1516transparency of course).
1517
1518When using a background pixmap or pseudo-transparency, then the background
1519colour will always behave as if it were completely transparent (so the
1520background image shows instead), regardless of how it was specified, while
1521other colours will either be transparent as specified (the background
1522image will show through) on servers supporting the RENDER extension, or
1523fully opaque on servers not supporting the RENDER EXTENSION.
1524
1525Please note that due to bugs in Xft, specifying alpha values might result
1526in garbage being displayed when the X-server does not support the RENDER
1527extension.
1528
1367=head1 ENVIRONMENT 1529=head1 ENVIRONMENT
1368 1530
1369B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1531B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1370 1532
1371=over 4 1533=over 4
1372 1534
1373=item B<TERM> 1535=item B<TERM>
1374 1536
1375Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1537Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1376resources or on the commandline. 1538resources or on the command line.
1377 1539
1378=item B<COLORTERM> 1540=item B<COLORTERM>
1379 1541
1380Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1542Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1381compiled with XPM support, and optionally with the added extension 1543compiled with background image support, and optionally with the added
1382C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1544extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1545screen.
1383 1546
1384=item B<COLORFGBG> 1547=item B<COLORFGBG>
1385 1548
1386Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1549Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1387the colour code used as default foreground/text colour (or the string 1550the colour code used as default foreground/text colour (or the string
1388C<default> to indicate that the default-colour escape sequence is to be 1551C<default> to indicate that the default-colour escape sequence is to be
1389used), C<bg> is the colour code used as default background colour (or the 1552used), C<bg> is the colour code used as default background colour (or the
1390string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1553string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1391was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1554was compiled with background image support. Libraries like C<ncurses>
1392(and do) use this information to optimize screen output. 1555and C<slang> can (and do) use this information to optimize screen output.
1393 1556
1394=item B<WINDOWID> 1557=item B<WINDOWID>
1395 1558
1396Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1559Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1397window, which usually has subwindows for the scrollbar, the terminal 1560window, which usually has subwindows for the scrollbar, the terminal
1403C<--with-terminfo=PATH>. 1566C<--with-terminfo=PATH>.
1404 1567
1405=item B<DISPLAY> 1568=item B<DISPLAY>
1406 1569
1407Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1570Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1408display in it's child processes. 1571display in its child processes if C<-display> isn't used to override. It
1572defaults to C<:0> if it doesn't exist.
1409 1573
1410=item B<SHELL> 1574=item B<SHELL>
1411 1575
1412The shell to be used for command execution, defaults to C</bin/sh>. 1576The shell to be used for command execution, defaults to C</bin/sh>.
1413 1577
1455 1619
1456=item Project Coordinator 1620=item Project Coordinator
1457 1621
1458Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1622Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1459 1623
1460L<http://software.schmorp.de/#rxvt-unicode> 1624L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1461 1625
1462=back 1626=back
1463 1627
1464=head1 AUTHORS 1628=head1 AUTHORS
1465 1629
1488Project Coordinator (changes.txt 2.21a to 2.4.5) 1652Project Coordinator (changes.txt 2.21a to 2.4.5)
1489 1653
1490=item Geoff Wing L<< <gcw@pobox.com> >> 1654=item Geoff Wing L<< <gcw@pobox.com> >>
1491 1655
1492Rewrote screen display and text selection routines. 1656Rewrote screen display and text selection routines.
1493 1657
1494Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1658Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1495 1659
1496=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1660=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1497 1661
1498Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1662Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines